Overview

Packages

  • CONTENIDO
  • Core
    • Authentication
    • Backend
    • Cache
    • CEC
    • Chain
    • ContentType
    • Database
    • Debug
    • Exception
    • Frontend
      • Search
      • URI
      • Util
    • GenericDB
      • Model
    • GUI
      • HTML
    • I18N
    • LayoutHandler
    • Log
    • Security
    • Session
    • Util
    • Validation
    • Versioning
    • XML
  • Module
    • ContentRssCreator
    • ContentSitemapHtml
    • ContentSitemapXml
    • ContentUserForum
    • NavigationTop
    • ScriptCookieDirective
  • mpAutoloaderClassMap
  • None
  • Plugin
    • ContentAllocation
    • CronjobOverview
    • FormAssistant
    • FrontendLogic
    • FrontendUsers
    • Linkchecker
    • ModRewrite
    • Newsletter
    • Repository
      • FrontendNavigation
      • KeywordDensity
    • SearchSolr
    • SmartyWrapper
    • UrlShortener
    • UserForum
    • Workflow
  • PluginManager
  • Setup
    • Form
    • GUI
    • Helper
      • Environment
      • Filesystem
      • MySQL
      • PHP
    • UpgradeJob

Classes

  • cAuth
  • cAuthHandlerAbstract
  • cAuthHandlerBackend
  • cAuthHandlerFrontend
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class cAuthHandlerAbstract

This class is the abstract authentication handler for CONTENIDO which may be extended differently for frontend and backend authentication.

cAuth
Extended by cAuthHandlerAbstract

Direct known subclasses

cAuthHandlerBackend, cAuthHandlerFrontend
Abstract
Package: Core\Authentication
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Dominik Ziegler
Located at classes/auth/class.auth.handler.abstract.php
Methods summary
abstract public string|false
# preAuthorize( )

Handle the pre authorization.

Handle the pre authorization.

When implementing this method let it return a valid user ID to be set before the login form is handled, otherwise false.

Returns

string|false

Todo

should be named preAuth or preAuthenticate
abstract public
# displayLoginForm( )

Display the login form.

Display the login form.

When implementing this method let this method include a file which displays the login form.

abstract public string|false
# validateCredentials( )

Validate the credentials.

Validate the credentials.

When implementing this method let this method validate the users input against source and return a valid user ID or false.

Returns

string|false
abstract public
# logSuccessfulAuth( )

Log a successful authentication. This method can be executed to log a successful login.

Log a successful authentication. This method can be executed to log a successful login.

abstract public boolean
# isLoggedIn( )

Returns true if a user is logged in

Returns true if a user is logged in

Returns

boolean
Methods inherited from cAuth
__get(), _fetchLoginForm(), _setAuthInfo(), _setExpiration(), getAuthInfo(), getPerms(), getUserId(), getUsername(), isAuthenticated(), isLoginForm(), logout(), resetAuthInfo(), restart(), start()
Constants inherited from cAuth
AUTH_UID_FORM, AUTH_UID_NOBODY
Properties inherited from cAuth
$_defaultNobody, $_lifetime, $auth
CMS CONTENIDO 4.9.11 API documentation generated by ApiGen 2.8.0