TYPO3 CMS  TYPO3_6-2
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Felogin\Controller\FrontendLoginController Class Reference
Inheritance diagram for TYPO3\CMS\Felogin\Controller\FrontendLoginController:
TYPO3\CMS\Frontend\Plugin\AbstractPlugin tx_felogin_pi1

Public Member Functions

 main ($content, $conf)
 
- Public Member Functions inherited from TYPO3\CMS\Frontend\Plugin\AbstractPlugin
 pi_setPiVarDefaults ()
 
 pi_getPageLink ($id, $target='', $urlParameters=array())
 
 pi_linkToPage ($str, $id, $target='', $urlParameters=array())
 
 pi_linkTP ($str, $urlParameters=array(), $cache=0, $altPageId=0)
 
 pi_linkTP_keepPIvars ($str, $overrulePIvars=array(), $cache=0, $clearAnyway=0, $altPageId=0)
 
 pi_linkTP_keepPIvars_url ($overrulePIvars=array(), $cache=0, $clearAnyway=0, $altPageId=0)
 
 pi_list_linkSingle ($str, $uid, $cache=FALSE, $mergeArr=array(), $urlOnly=FALSE, $altPageId=0)
 
 pi_openAtagHrefInJSwindow ($str, $winName='', $winParams='width=670, height=500, status=0, menubar=0, scrollbars=1, resizable=1')
 
 pi_list_browseresults ($showResultCount=1, $tableParams='', $wrapArr=array(), $pointerName='pointer', $hscText=TRUE, $forceOutput=FALSE)
 
 pi_list_searchBox ($tableParams='')
 
 pi_list_modeSelector ($items=array(), $tableParams='')
 
 pi_list_makelist ($res, $tableParams='')
 
 pi_list_row ($c)
 
 pi_list_header ()
 
 pi_getClassName ($class)
 
 pi_classParam ($class, $addClasses='')
 
 pi_wrapInBaseClass ($str)
 
 pi_getEditPanel ($row='', $tablename='', $label='', $conf=array())
 
 pi_getEditIcon ($content, $fields, $title='', $row='', $tablename='', $oConf=array())
 
 pi_getLL ($key, $alternativeLabel='', $hsc=FALSE)
 
 pi_loadLL ()
 
 pi_exec_query ($table, $count=0, $addWhere='', $mm_cat='', $groupBy='', $orderBy='', $query='')
 
 pi_getRecord ($table, $uid, $checkPage=0)
 
 pi_getPidList ($pid_list, $recursive=0)
 
 pi_prependFieldsWithTable ($table, $fieldList)
 
 pi_getCategoryTableContents ($table, $pid, $whereClause='', $groupBy='', $orderBy='', $limit='')
 
 pi_isOnlyFields ($fList, $lowerThan=-1)
 
 pi_autoCache ($inArray)
 
 pi_RTEcssText ($str)
 
 pi_initPIflexForm ($field='pi_flexform')
 
 pi_getFFvalue ($T3FlexForm_array, $fieldName, $sheet='sDEF', $lang='lDEF', $value='vDEF')
 
 pi_getFFvalueFromSheetArray ($sheetArray, $fieldNameArr, $value)
 

Public Attributes

 $prefixId = 'tx_felogin_pi1'
 
 $scriptRelPath = 'pi1/class.tx_felogin_pi1.php'
 
 $extKey = 'felogin'
 
 $pi_checkCHash = FALSE
 
 $pi_USER_INT_obj = TRUE
 
- Public Attributes inherited from TYPO3\CMS\Frontend\Plugin\AbstractPlugin
 $cObj
 
 $prefixId
 
 $scriptRelPath
 
 $extKey
 
 $piVars
 
 $internal = array('res_count' => 0, 'results_at_a_time' => 20, 'maxPages' => 10, 'currentRow' => array(), 'currentTable' => '')
 
 $LOCAL_LANG = array()
 
 $LOCAL_LANG_charset = array()
 
 $LOCAL_LANG_loaded = 0
 
 $LLkey = 'default'
 
 $altLLkey = ''
 
 $LLtestPrefix = ''
 
 $LLtestPrefixAlt = ''
 
 $pi_isOnlyFields = 'mode,pointer'
 
 $pi_alwaysPrev = 0
 
 $pi_lowerThan = 5
 
 $pi_moreParams = ''
 
 $pi_listFields = '*'
 
 $pi_autoCacheFields = array()
 
 $pi_autoCacheEn = 0
 
 $pi_USER_INT_obj = FALSE
 
 $pi_checkCHash = FALSE
 
 $conf = array()
 
 $pi_EPtemp_cObj
 
 $pi_tmpPageId = 0
 

Protected Member Functions

 showForgot ()
 
 changePassword ()
 
 generateAndSendHash ($user)
 
 showLogout ()
 
 showLogin ()
 
 processRedirect ()
 
 mergeflexFormValuesIntoConf ()
 
 flexFormValue ($var, $sheet)
 
 getPageLink ($label, $piVars, $returnUrl=FALSE)
 
 getPreserveGetVars ()
 
 generatePassword ($len)
 
 getDisplayText ($label, $stdWrapArray=array())
 
 getUserFieldMarkers ()
 
 validateRedirectUrl ($url)
 
 isInCurrentDomain ($url)
 
 isInLocalDomain ($url)
 
 isRelativeUrl ($url)
 
- Protected Member Functions inherited from TYPO3\CMS\Frontend\Plugin\AbstractPlugin
 applyStdWrapRecursive (array $conf, $level=0)
 

Protected Attributes

 $userIsLoggedIn
 
 $template
 
 $uploadDir
 
 $redirectUrl
 
 $noRedirect = FALSE
 
 $logintype
 
- Protected Attributes inherited from TYPO3\CMS\Frontend\Plugin\AbstractPlugin
 $LOCAL_LANG_UNSET = array()
 

Detailed Description

Plugin 'Website User Login' for the 'felogin' extension.

Author
Steffen Kamper info@.nosp@m.sk-t.nosp@m.ypo3..nosp@m.de

Definition at line 25 of file FrontendLoginController.php.

Member Function Documentation

◆ changePassword()

TYPO3\CMS\Felogin\Controller\FrontendLoginController::changePassword ( )
protected

This function checks the hash from link and checks the validity. If it's valid it shows the form for changing the password and process the change of password after submit, if not valid it returns the error message

Returns
string The content.

Definition at line 281 of file FrontendLoginController.php.

References $GLOBALS, $uid, TYPO3\CMS\Core\Utility\GeneralUtility\_POST(), TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\getDisplayText(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\getPageLink(), TYPO3\CMS\Frontend\Plugin\AbstractPlugin\pi_getLL(), and TYPO3\CMS\Frontend\Plugin\AbstractPlugin\pi_getRecord().

Referenced by TYPO3\CMS\Felogin\Controller\FrontendLoginController\main().

◆ flexFormValue()

TYPO3\CMS\Felogin\Controller\FrontendLoginController::flexFormValue (   $var,
  $sheet 
)
protected

Loads a variable from the flexform

Parameters
string$varName of variable
string$sheetName of sheet
Returns
string Value of var

Definition at line 812 of file FrontendLoginController.php.

References TYPO3\CMS\Frontend\Plugin\AbstractPlugin\pi_getFFvalue().

Referenced by TYPO3\CMS\Felogin\Controller\FrontendLoginController\getDisplayText(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\mergeflexFormValuesIntoConf(), and TYPO3\CMS\Felogin\Controller\FrontendLoginController\showLogout().

◆ generateAndSendHash()

TYPO3\CMS\Felogin\Controller\FrontendLoginController::generateAndSendHash (   $user)
protected

Generates a hashed link and send it with email

Parameters
array$userContains user data
Returns
string Empty string with success, error message with no success

Definition at line 386 of file FrontendLoginController.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction(), TYPO3\CMS\Core\Utility\GeneralUtility\generateRandomBytes(), TYPO3\CMS\Core\Utility\GeneralUtility\locationHeaderUrl(), TYPO3\CMS\Frontend\Plugin\AbstractPlugin\pi_getLL(), and TYPO3\CMS\Frontend\Plugin\AbstractPlugin\pi_getPageLink().

Referenced by TYPO3\CMS\Felogin\Controller\FrontendLoginController\showForgot().

◆ generatePassword()

TYPO3\CMS\Felogin\Controller\FrontendLoginController::generatePassword (   $len)
protected

Is used by forgot password - function with md5 option.

Author
Bernhard Kraft
Parameters
integer$lenLength of new password
Returns
string New password

Definition at line 882 of file FrontendLoginController.php.

Referenced by TYPO3\CMS\Felogin\Controller\FrontendLoginController\showForgot().

◆ getDisplayText()

TYPO3\CMS\Felogin\Controller\FrontendLoginController::getDisplayText (   $label,
  $stdWrapArray = array() 
)
protected

Returns the header / message value from flexform if present, else from locallang.xlf

Parameters
string$labellabel name
array$stdWrapArrayTS stdWrap array
Returns
string label text

Definition at line 902 of file FrontendLoginController.php.

References TYPO3\CMS\Felogin\Controller\FrontendLoginController\flexFormValue(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\getUserFieldMarkers(), and TYPO3\CMS\Frontend\Plugin\AbstractPlugin\pi_getLL().

Referenced by TYPO3\CMS\Felogin\Controller\FrontendLoginController\changePassword(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\showForgot(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\showLogin(), and TYPO3\CMS\Felogin\Controller\FrontendLoginController\showLogout().

◆ getPageLink()

TYPO3\CMS\Felogin\Controller\FrontendLoginController::getPageLink (   $label,
  $piVars,
  $returnUrl = FALSE 
)
protected

Generate link with typolink function

Parameters
string$labelLinktext
array$piVarsLink vars
boolean$returnUrlTRUE: returns only url FALSE (default) returns the link)
Returns
string Link or url

Definition at line 824 of file FrontendLoginController.php.

References $GLOBALS, TYPO3\CMS\Frontend\Plugin\AbstractPlugin\$piVars, and TYPO3\CMS\Felogin\Controller\FrontendLoginController\getPreserveGetVars().

Referenced by TYPO3\CMS\Felogin\Controller\FrontendLoginController\changePassword(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\showForgot(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\showLogin(), and TYPO3\CMS\Felogin\Controller\FrontendLoginController\showLogout().

◆ getPreserveGetVars()

TYPO3\CMS\Felogin\Controller\FrontendLoginController::getPreserveGetVars ( )
protected

Add additional parameters for links according to TS setting preserveGETvars. Possible values are "all" or a comma separated list of allowed GET-vars. Supports multi-dimensional GET-vars. Some hardcoded values are dropped.

Returns
string additionalParams-string

Definition at line 854 of file FrontendLoginController.php.

References $parameters, TYPO3\CMS\Core\Utility\GeneralUtility\_GET(), TYPO3\CMS\Core\Utility\GeneralUtility\explodeUrl2Array(), TYPO3\CMS\Core\Utility\GeneralUtility\implodeArrayForUrl(), TYPO3\CMS\Core\Utility\ArrayUtility\intersectRecursive(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Felogin\Controller\FrontendLoginController\getPageLink().

◆ getUserFieldMarkers()

TYPO3\CMS\Felogin\Controller\FrontendLoginController::getUserFieldMarkers ( )
protected

Returns Array of markers filled with user fields

Returns
array Marker array

Definition at line 913 of file FrontendLoginController.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\strtoupper().

Referenced by TYPO3\CMS\Felogin\Controller\FrontendLoginController\getDisplayText(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\showForgot(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\showLogin(), and TYPO3\CMS\Felogin\Controller\FrontendLoginController\showLogout().

◆ isInCurrentDomain()

TYPO3\CMS\Felogin\Controller\FrontendLoginController::isInCurrentDomain (   $url)
protected

Determines whether the URL is on the current host and belongs to the current TYPO3 installation. The scheme part is ignored in the comparison.

Parameters
string$urlURL to be checked
Returns
boolean Whether the URL belongs to the current TYPO3 installation

Definition at line 960 of file FrontendLoginController.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), and TYPO3\CMS\Core\Utility\GeneralUtility\isFirstPartOfStr().

Referenced by TYPO3\CMS\Felogin\Controller\FrontendLoginController\validateRedirectUrl().

◆ isInLocalDomain()

TYPO3\CMS\Felogin\Controller\FrontendLoginController::isInLocalDomain (   $url)
protected

Determines whether the URL matches a domain in the sys_domain database table.

Parameters
string$urlAbsolute URL which needs to be checked
Returns
boolean Whether the URL is considered to be local

Definition at line 974 of file FrontendLoginController.php.

References $GLOBALS, $host, $result, TYPO3\CMS\Core\Utility\GeneralUtility\isFirstPartOfStr(), and TYPO3\CMS\Core\Utility\GeneralUtility\isValidUrl().

Referenced by TYPO3\CMS\Felogin\Controller\FrontendLoginController\validateRedirectUrl().

◆ isRelativeUrl()

TYPO3\CMS\Felogin\Controller\FrontendLoginController::isRelativeUrl (   $url)
protected

Determines whether the URL is relative to the current TYPO3 installation.

Parameters
string$urlURL which needs to be checked
Returns
boolean Whether the URL is considered to be relative

Definition at line 1005 of file FrontendLoginController.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), and TYPO3\CMS\Core\Utility\GeneralUtility\isFirstPartOfStr().

Referenced by TYPO3\CMS\Felogin\Controller\FrontendLoginController\validateRedirectUrl().

◆ main()

TYPO3\CMS\Felogin\Controller\FrontendLoginController::main (   $content,
  $conf 
)

The main method of the plugin

Parameters
string$contentThe PlugIn content
array$confThe PlugIn configuration
Returns
string The content that is displayed on the website

Definition at line 107 of file FrontendLoginController.php.

References TYPO3\CMS\Frontend\Plugin\AbstractPlugin\$conf, $GLOBALS, TYPO3\CMS\Felogin\Controller\FrontendLoginController\$redirectUrl, TYPO3\CMS\Felogin\Controller\FrontendLoginController\$userIsLoggedIn, TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\changePassword(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\mergeflexFormValuesIntoConf(), TYPO3\CMS\Frontend\Plugin\AbstractPlugin\pi_getLL(), TYPO3\CMS\Frontend\Plugin\AbstractPlugin\pi_getPidList(), TYPO3\CMS\Frontend\Plugin\AbstractPlugin\pi_initPIflexForm(), TYPO3\CMS\Frontend\Plugin\AbstractPlugin\pi_loadLL(), TYPO3\CMS\Frontend\Plugin\AbstractPlugin\pi_setPiVarDefaults(), TYPO3\CMS\Frontend\Plugin\AbstractPlugin\pi_wrapInBaseClass(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\processRedirect(), TYPO3\CMS\Core\Utility\HttpUtility\redirect(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\showForgot(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\showLogin(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\showLogout(), and TYPO3\CMS\Felogin\Controller\FrontendLoginController\validateRedirectUrl().

◆ mergeflexFormValuesIntoConf()

TYPO3\CMS\Felogin\Controller\FrontendLoginController::mergeflexFormValuesIntoConf ( )
protected

Reads flexform configuration and merge it with $this->conf

Returns
void

Definition at line 760 of file FrontendLoginController.php.

References TYPO3\CMS\Felogin\Controller\FrontendLoginController\flexFormValue(), and TYPO3\CMS\Frontend\Plugin\AbstractPlugin\pi_getPidList().

Referenced by TYPO3\CMS\Felogin\Controller\FrontendLoginController\main().

◆ processRedirect()

TYPO3\CMS\Felogin\Controller\FrontendLoginController::processRedirect ( )
protected

Process redirect methods. The function searches for a redirect url using all configured methods.

Returns
array Redirect URLs

Definition at line 620 of file FrontendLoginController.php.

References $GLOBALS, TYPO3\CMS\Felogin\Controller\FrontendLoginController\$redirectUrl, TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction(), TYPO3\CMS\Frontend\Plugin\AbstractPlugin\pi_getPageLink(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Felogin\Controller\FrontendLoginController\main().

◆ showForgot()

TYPO3\CMS\Felogin\Controller\FrontendLoginController::showForgot ( )
protected

Shows the forgot password form

Returns
string Content

Definition at line 211 of file FrontendLoginController.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\_POST(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\generateAndSendHash(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\generatePassword(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\getDisplayText(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\getPageLink(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\getUserFieldMarkers(), and TYPO3\CMS\Frontend\Plugin\AbstractPlugin\pi_getLL().

Referenced by TYPO3\CMS\Felogin\Controller\FrontendLoginController\main().

◆ showLogin()

TYPO3\CMS\Felogin\Controller\FrontendLoginController::showLogin ( )
protected

Shows login form

Returns
string Content

Definition at line 484 of file FrontendLoginController.php.

References $GLOBALS, TYPO3\CMS\Felogin\Controller\FrontendLoginController\$prefixId, TYPO3\CMS\Felogin\Controller\FrontendLoginController\$redirectUrl, TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\getDisplayText(), TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\getPageLink(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\getUserFieldMarkers(), TYPO3\CMS\Core\Utility\GeneralUtility\inList(), TYPO3\CMS\Frontend\Plugin\AbstractPlugin\pi_getLL(), and TYPO3\CMS\Felogin\Controller\FrontendLoginController\showLogout().

Referenced by TYPO3\CMS\Felogin\Controller\FrontendLoginController\main().

◆ showLogout()

TYPO3\CMS\Felogin\Controller\FrontendLoginController::showLogout ( )
protected

Shows logout form

Returns
string The content.

Definition at line 455 of file FrontendLoginController.php.

References $GLOBALS, TYPO3\CMS\Felogin\Controller\FrontendLoginController\$prefixId, TYPO3\CMS\Felogin\Controller\FrontendLoginController\flexFormValue(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\getDisplayText(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\getPageLink(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\getUserFieldMarkers(), and TYPO3\CMS\Frontend\Plugin\AbstractPlugin\pi_getLL().

Referenced by TYPO3\CMS\Felogin\Controller\FrontendLoginController\main(), and TYPO3\CMS\Felogin\Controller\FrontendLoginController\showLogin().

◆ validateRedirectUrl()

TYPO3\CMS\Felogin\Controller\FrontendLoginController::validateRedirectUrl (   $url)
protected

Returns a valid and XSS cleaned url for redirect, checked against configuration "allowedRedirectHosts"

Parameters
string$url
Returns
string cleaned referer or empty string if not valid

Definition at line 933 of file FrontendLoginController.php.

References TYPO3\CMS\Felogin\Controller\FrontendLoginController\isInCurrentDomain(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\isInLocalDomain(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\isRelativeUrl(), TYPO3\CMS\Frontend\Plugin\AbstractPlugin\pi_getLL(), TYPO3\CMS\Core\Utility\GeneralUtility\removeXSS(), and TYPO3\CMS\Core\Utility\GeneralUtility\SYSLOG_SEVERITY_WARNING.

Referenced by TYPO3\CMS\Felogin\Controller\FrontendLoginController\main().

Member Data Documentation

◆ $extKey

TYPO3\CMS\Felogin\Controller\FrontendLoginController::$extKey = 'felogin'

The extension key.

Todo:
Define visibility

Definition at line 46 of file FrontendLoginController.php.

◆ $logintype

TYPO3\CMS\Felogin\Controller\FrontendLoginController::$logintype
protected

Definition at line 98 of file FrontendLoginController.php.

◆ $noRedirect

TYPO3\CMS\Felogin\Controller\FrontendLoginController::$noRedirect = FALSE
protected

Definition at line 91 of file FrontendLoginController.php.

◆ $pi_checkCHash

TYPO3\CMS\Felogin\Controller\FrontendLoginController::$pi_checkCHash = FALSE

Definition at line 51 of file FrontendLoginController.php.

◆ $pi_USER_INT_obj

TYPO3\CMS\Felogin\Controller\FrontendLoginController::$pi_USER_INT_obj = TRUE

Definition at line 56 of file FrontendLoginController.php.

◆ $prefixId

TYPO3\CMS\Felogin\Controller\FrontendLoginController::$prefixId = 'tx_felogin_pi1'

Same as class name

Todo:
Define visibility

Definition at line 32 of file FrontendLoginController.php.

Referenced by TYPO3\CMS\Felogin\Controller\FrontendLoginController\showLogin(), and TYPO3\CMS\Felogin\Controller\FrontendLoginController\showLogout().

◆ $redirectUrl

TYPO3\CMS\Felogin\Controller\FrontendLoginController::$redirectUrl
protected

Definition at line 84 of file FrontendLoginController.php.

Referenced by TYPO3\CMS\Felogin\Controller\FrontendLoginController\main(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\processRedirect(), and TYPO3\CMS\Felogin\Controller\FrontendLoginController\showLogin().

◆ $scriptRelPath

TYPO3\CMS\Felogin\Controller\FrontendLoginController::$scriptRelPath = 'pi1/class.tx_felogin_pi1.php'

Path to this script relative to the extension dir.

Todo:
Define visibility

Definition at line 39 of file FrontendLoginController.php.

◆ $template

TYPO3\CMS\Felogin\Controller\FrontendLoginController::$template
protected

Definition at line 70 of file FrontendLoginController.php.

◆ $uploadDir

TYPO3\CMS\Felogin\Controller\FrontendLoginController::$uploadDir
protected

Definition at line 77 of file FrontendLoginController.php.

◆ $userIsLoggedIn

TYPO3\CMS\Felogin\Controller\FrontendLoginController::$userIsLoggedIn
protected

Definition at line 63 of file FrontendLoginController.php.

Referenced by TYPO3\CMS\Felogin\Controller\FrontendLoginController\main().