YaWK
24.1
Yet another WebKit
|
Loginbox Widget. More...
Public Member Functions | |
__construct ($db) | |
Load all widget settings from database and fill object. More... | |
drawLoginBox ($db, $username, $password) | |
returns the login box html markup More... | |
drawLogoutButton ($db) | |
returns the logout btn html markup More... | |
includeJS () | |
Load required javascript file. More... | |
init ($db) | |
Init loginbox widget and call a function for demo purpose. More... | |
setLoginProperties () | |
Prepare Loginbox form settings. More... | |
setLogoutProperties () | |
Set properties of greeting and logout button. More... | |
![]() | |
getHeading ($heading, $subtext) | |
Get widget heading and subtext, return headline. More... | |
getWidgetSettingsArray ($db) | |
Get widget settings and return it as array. More... | |
printObject () | |
Print all object data. More... | |
Additional Inherited Members | |
![]() | |
static | getAllSettingsIntoArray ($db, $widgetID) |
Returns an array with all widget settings data. More... | |
static | getAllWidgetTypes ($db) |
Return all widget types as associative array. More... | |
static | getCurrentWidgetPath ($db) |
return current widget path More... | |
static | getFacebookLikeBox () |
return the facebook likebox widget More... | |
static | getLoginBox () |
return the user login box widget More... | |
static | loadWidgetsOfPage ($db, $page) |
Returns an array of all widgets that are linked with given page->id. More... | |
Loginbox Widget.
Loginbox - draw a loginbox (or logout button)
In case you need a user login form, use this widget. If the user is not logged in, a form will be displayed, requesting username and password where users can login. In case the user is already logged in, a hello {user}! message will be displayed, followed by a logout button
Definition at line 17 of file loginbox.php.
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::__construct | ( | $db | ) |
Load all widget settings from database and fill object.
object | $db | Database Object |
Load all widget settings on object init.
Definition at line 81 of file loginbox.php.
References $db, $settings, $value, and YAWK\widget\getWidgetSettingsArray().
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::drawLoginBox | ( | $db, | |
$username, | |||
$password | |||
) |
returns the login box html markup
object | $db | database object |
string | $username | username, as option |
string | $password | password, as option |
Definition at line 280 of file loginbox.php.
References $password, $username, YAWK\widget\getHeading(), and YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox\setLoginProperties().
Referenced by YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox\init().
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::drawLogoutButton | ( | $db | ) |
returns the logout btn html markup
Definition at line 317 of file loginbox.php.
References YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox\setLogoutProperties().
Referenced by YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox\init().
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::includeJS | ( | ) |
Load required javascript file.
include required ajax js file
Definition at line 258 of file loginbox.php.
References YAWK\language\getCurrentLanguageStatic().
Referenced by YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox\setLoginProperties().
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::init | ( | $db | ) |
Init loginbox widget and call a function for demo purpose.
loginbox Widget Init
Definition at line 95 of file loginbox.php.
References $db, YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox\drawLoginBox(), YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox\drawLogoutButton(), and YAWK\user\isAnybodyThere().
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::setLoginProperties | ( | ) |
Prepare Loginbox form settings.
Evaluate loginbox settings and prepare html markup
MARGIN TOP
FORM WIDTH
FORM CLASS
FORM PROCESSING MODE
Definition at line 120 of file loginbox.php.
References YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox\includeJS().
Referenced by YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox\drawLoginBox().
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::setLogoutProperties | ( | ) |
Set properties of greeting and logout button.
set properties of greeting and logout button
GREETING TEXT MARKUP
LOGOUT BUTTON MARKUP
SET GREETING AND LOGOUT BUTTON
Definition at line 197 of file loginbox.php.
References YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox\$loginboxLogoutBtnMarkup.
Referenced by YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox\drawLogoutButton().
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::$currentUser = '' |
string | Username |
Definition at line 26 of file loginbox.php.
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::$loginboxFormClass = '' |
string | form css class |
Definition at line 46 of file loginbox.php.
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::$loginboxFormClassMarkup = '' |
string | form css class markup |
Definition at line 48 of file loginbox.php.
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::$loginboxGreeting = '' |
bool | true|false Turn greeting on or off |
Definition at line 56 of file loginbox.php.
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::$loginboxGreetingMarkup = '' |
string | Greeting html markup |
Definition at line 60 of file loginbox.php.
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::$loginboxGreetingShowName = 'true' |
bool | true|false Show name within greeting? |
Definition at line 64 of file loginbox.php.
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::$loginboxGreetingSubtext = '' |
string | Greeting Subtext |
Definition at line 62 of file loginbox.php.
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::$loginboxGreetingText = '' |
string | Greeting Text |
Definition at line 58 of file loginbox.php.
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::$loginboxGreetingTextClass = '' |
string | Greeting text class |
Definition at line 68 of file loginbox.php.
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::$loginboxGreetingTextClassMarkup = '' |
string | Greeting text class html markup |
Definition at line 70 of file loginbox.php.
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::$loginboxGreetingTextType = 'h2' |
string | Greeting text type |
Definition at line 66 of file loginbox.php.
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::$loginboxHeading = '' |
string | Title that will be shown above widget |
Definition at line 22 of file loginbox.php.
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::$loginboxLoginBtnClass = "btn btn-success" |
string | Login Button CSS Class |
Definition at line 34 of file loginbox.php.
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::$loginboxLoginBtnMarginMarkup = '' |
string | Login Button margin top css markup |
Definition at line 40 of file loginbox.php.
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::$loginboxLoginBtnMarginTop = "5px" |
string | Login Button margin-top |
Definition at line 38 of file loginbox.php.
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::$loginboxLoginBtnText = "Login" |
string | Login Button Text |
Definition at line 28 of file loginbox.php.
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::$loginboxLogoutBtnClass = "btn btn-danger" |
string | Logout Button CSS Class |
Definition at line 36 of file loginbox.php.
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::$loginboxLogoutBtnMarkup = "" |
string | Logout Button html markup |
Definition at line 32 of file loginbox.php.
Referenced by YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox\setLogoutProperties().
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::$loginboxLogoutBtnText = "Logout" |
string | Logout Button Text |
Definition at line 30 of file loginbox.php.
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::$loginboxProcessingMode = 'html' |
string | ajax|html form processing mode |
Definition at line 50 of file loginbox.php.
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::$loginboxProcessingModeFormMarkup = '' |
string | markup for html/ajax processing mode |
Definition at line 52 of file loginbox.php.
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::$loginboxProcessingModeSubmitBtnType = 'submit' |
string | submit button type, depending on processing mode |
Definition at line 54 of file loginbox.php.
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::$loginboxRedirect = '' |
string | redirect to this page after successful login |
Definition at line 72 of file loginbox.php.
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::$loginboxRedirectTime = 0 |
int | delay before redirecting |
Definition at line 74 of file loginbox.php.
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::$loginboxSubtext = '' |
string | Subtext will be displayed beside title |
Definition at line 24 of file loginbox.php.
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::$loginboxWidth = '' |
string | form width |
Definition at line 42 of file loginbox.php.
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::$loginboxWidthMarkup = '' |
string | form width css markup |
Definition at line 44 of file loginbox.php.
YAWK\WIDGETS\LOGINBOX\LOGIN\loginbox::$widget = '' |
object | global widget object data |
Definition at line 20 of file loginbox.php.