tx_felogin_pi1 Class Reference
Public Member Functions | |
| main ($content, $conf) | |
Public Attributes | |
| $prefixId = 'tx_felogin_pi1' | |
| $scriptRelPath = 'pi1/class.tx_felogin_pi1.php' | |
| $extKey = 'felogin' | |
| $pi_checkCHash = true | |
| $userIsLoggedIn | |
| $template | |
| $uploadDir | |
| $redirectUrl | |
Protected Member Functions | |
| showForgot () | |
| showLogout () | |
| showLogin () | |
| processRedirect () | |
| mergeflexFormValuesIntoConf () | |
| flexFormValue ($var, $sheet) | |
| getPageLink ($label, $piVars, $returnUrl=false) | |
| getPreserveGetVars () | |
| generatePassword ($len) | |
| getDisplayText ($label, $stdWrapArray=array()) | |
Detailed Description
Definition at line 39 of file class.tx_felogin_pi1.php.
Member Function Documentation
| tx_felogin_pi1.main | ( | $ | content, | |
| $ | conf | |||
| ) |
The main method of the plugin
- Parameters:
-
string $content: The PlugIn content array $conf: The PlugIn configuration
- Returns:
- string The content that is displayed on the website
Definition at line 57 of file class.tx_felogin_pi1.php.
References tslib_pibase.$conf, $content, $GLOBALS, t3lib_div._GP(), exit, t3lib_div.locationHeaderUrl(), mergeflexFormValuesIntoConf(), tslib_pibase.pi_getLL(), tslib_pibase.pi_initPIflexForm(), tslib_pibase.pi_loadLL(), tslib_pibase.pi_setPiVarDefaults(), tslib_pibase.pi_wrapInBaseClass(), processRedirect(), showForgot(), showLogin(), and showLogout().
| tx_felogin_pi1.showForgot | ( | ) | [protected] |
Shows the forgot password form
- Returns:
- string content
Definition at line 138 of file class.tx_felogin_pi1.php.
References $GLOBALS, $res, $row, generatePassword(), getDisplayText(), getPageLink(), t3lib_extMgm.isLoaded(), tslib_pibase.pi_getLL(), and t3lib_div.validEmail().
Referenced by main().
| tx_felogin_pi1.showLogout | ( | ) | [protected] |
Shows logout form
- Returns:
- string The content.
Definition at line 203 of file class.tx_felogin_pi1.php.
References $GLOBALS, flexFormValue(), getDisplayText(), getPageLink(), and tslib_pibase.pi_getLL().
Referenced by main().
| tx_felogin_pi1.showLogin | ( | ) | [protected] |
Shows login form
- Returns:
- string content
Definition at line 231 of file class.tx_felogin_pi1.php.
References $GLOBALS, t3lib_div._GP(), t3lib_div.callUserFunction(), flexFormValue(), getDisplayText(), getPageLink(), and tslib_pibase.pi_getLL().
Referenced by main().
| tx_felogin_pi1.processRedirect | ( | ) | [protected] |
Process redirect methods. The function searches for a redirect url using all configured methods.
- Returns:
- string redirect url
Definition at line 335 of file class.tx_felogin_pi1.php.
References $GLOBALS, $res, $row, t3lib_div.callUserFunction(), t3lib_div.getIndpEnv(), tslib_pibase.pi_getPageLink(), and t3lib_div.trimExplode().
Referenced by main().
| tx_felogin_pi1.mergeflexFormValuesIntoConf | ( | ) | [protected] |
Reads flexform configuration and merge it with $this->conf
- Returns:
- void
Definition at line 453 of file class.tx_felogin_pi1.php.
References $pid, flexFormValue(), and tslib_pibase.pi_getPidList().
Referenced by main().
| tx_felogin_pi1.flexFormValue | ( | $ | var, | |
| $ | sheet | |||
| ) | [protected] |
Loads a variable from the flexform
- Parameters:
-
string name of variable string name of sheet
- Returns:
- string value of var
Definition at line 514 of file class.tx_felogin_pi1.php.
References tslib_pibase.pi_getFFvalue().
Referenced by getDisplayText(), mergeflexFormValuesIntoConf(), showLogin(), and showLogout().
| tx_felogin_pi1.getPageLink | ( | $ | label, | |
| $ | piVars, | |||
| $ | returnUrl = false | |||
| ) | [protected] |
Generate link with typolink function
- Parameters:
-
string linktext array link vars boolean true: returns only url false (default) returns the link)
- Returns:
- string link or url
Definition at line 527 of file class.tx_felogin_pi1.php.
References $GLOBALS, $key, tslib_pibase.$piVars, $val, and getPreserveGetVars().
Referenced by showForgot(), showLogin(), and showLogout().
| tx_felogin_pi1.getPreserveGetVars | ( | ) | [protected] |
Is used by TS-setting preserveGETvars possible values are "all" or a commaseperated list of GET-vars they are used as additionalParams for link generation
- Returns:
- string additionalParams-string
Definition at line 559 of file class.tx_felogin_pi1.php.
References $key, $val, and t3lib_div._GET().
Referenced by getPageLink().
| tx_felogin_pi1.generatePassword | ( | $ | len | ) | [protected] |
Is used by forgot password - function with md5 option.
- Parameters:
-
int length of new password
- Returns:
- string new password
Definition at line 591 of file class.tx_felogin_pi1.php.
Referenced by showForgot().
| tx_felogin_pi1.getDisplayText | ( | $ | label, | |
| $ | stdWrapArray = array() | |||
| ) | [protected] |
Returns the header / message value from flexform if present, else from locallang.xml
- Parameters:
-
string label name string TS stdWrap array
- Returns:
- string label text
Definition at line 611 of file class.tx_felogin_pi1.php.
References flexFormValue(), and tslib_pibase.pi_getLL().
Referenced by showForgot(), showLogin(), and showLogout().
Member Data Documentation
| tx_felogin_pi1.$prefixId = 'tx_felogin_pi1' |
| tx_felogin_pi1.$scriptRelPath = 'pi1/class.tx_felogin_pi1.php' |
| tx_felogin_pi1.$extKey = 'felogin' |
| tx_felogin_pi1.$pi_checkCHash = true |
| tx_felogin_pi1.$userIsLoggedIn |
Definition at line 44 of file class.tx_felogin_pi1.php.
| tx_felogin_pi1.$template |
Definition at line 45 of file class.tx_felogin_pi1.php.
| tx_felogin_pi1.$uploadDir |
Definition at line 46 of file class.tx_felogin_pi1.php.
| tx_felogin_pi1.$redirectUrl |
Definition at line 47 of file class.tx_felogin_pi1.php.
The documentation for this class was generated from the following file:
- typo3/sysext/felogin/pi1/class.tx_felogin_pi1.php
