Ubiquity  2.0.3
php rapid development framework
AuthController Class Reference
+ Inheritance diagram for AuthController:

Public Member Functions

 index ()
 
 isValid ()
 
 noAccess ($urlParts)
 
 connect ()
 
 badLogin ()
 
 terminate ()
 
 info ($user)
 
 message ($type, $header, $body, $icon="info")
 
- Public Member Functions inherited from ControllerBase
 initialize ()
 
 finalize ()
 
- Public Member Functions inherited from Controller
 index ()
 Default action. More...
 
 __construct ()
 Constructor initialize $view variable. More...
 
 initialize ()
 Method called before each action Can be override in derived class. More...
 
 finalize ()
 Method called after each action Can be override in derived class. More...
 
 loadView ($viewName, $pData=NULL, $asString=false)
 Loads the view $viewName possibly passing the variables $pdata. More...
 
 loadDefaultView ($pData=NULL, $asString=false)
 Loads the default view (controllerName/actionName) possibly passing the variables $pdata. More...
 
 getDefaultViewName ()
 Returns the default view name for this controller/action i.e ControllerName/actionName.html for the action actionName in ControllerName. More...
 
 isValid ($action)
 Returns True if access to the controller is allowed To be override in sub classes. More...
 
 onInvalidControl ()
 Called if isValid () returns false
To be override in sub classes. More...
 
 forward ($controller, $action="index", $params=array(), $initialize=false, $finalize=false)
 Loads the controller $controller and calls its $action method by passing the parameters $params. More...
 
 redirectToRoute ($routeName, $parameters=[], $initialize=false, $finalize=false)
 Redirect to a route by its name. More...
 
 getView ()
 

Protected Member Functions

 noAccessMessage (FlashMessage $fMessage)
 
 _connect ()
 
 onConnect ($connected)
 
 onBadCreditentials ()
 
 badLoginMessage (FlashMessage $fMessage)
 
 terminateMessage (FlashMessage $fMessage)
 
 fMessage (FlashMessage $fMessage)
 
 getOriginalURL ()
 

Additional Inherited Members

- Protected Attributes inherited from ControllerBase
 $headerView ="@framework/main/vHeader.html"
 
 $footerView ="@framework/main/vFooter.html"
 
- Protected Attributes inherited from Controller
 $view
 

Detailed Description

Definition at line 12 of file AuthController.php.

Member Function Documentation

◆ _connect()

_connect ( )
abstractprotected

◆ badLogin()

badLogin ( )

Definition at line 54 of file AuthController.php.

◆ badLoginMessage()

badLoginMessage ( FlashMessage  $fMessage)
protected

Definition at line 61 of file AuthController.php.

◆ connect()

connect ( )

Definition at line 36 of file AuthController.php.

◆ fMessage()

fMessage ( FlashMessage  $fMessage)
protected

Definition at line 81 of file AuthController.php.

◆ getOriginalURL()

getOriginalURL ( )
protected

Definition at line 89 of file AuthController.php.

◆ index()

index ( )

Definition at line 14 of file AuthController.php.

◆ info()

info (   $user)

Definition at line 77 of file AuthController.php.

◆ isValid()

isValid ( )

See also
::isValid()

Definition at line 21 of file AuthController.php.

◆ message()

message (   $type,
  $header,
  $body,
  $icon = "info" 
)

Definition at line 85 of file AuthController.php.

◆ noAccess()

noAccess (   $urlParts)

Definition at line 25 of file AuthController.php.

◆ noAccessMessage()

noAccessMessage ( FlashMessage  $fMessage)
protected

Definition at line 32 of file AuthController.php.

◆ onBadCreditentials()

onBadCreditentials ( )
protected

Definition at line 50 of file AuthController.php.

◆ onConnect()

onConnect (   $connected)
abstractprotected

◆ terminate()

terminate ( )

Definition at line 65 of file AuthController.php.

◆ terminateMessage()

terminateMessage ( FlashMessage  $fMessage)
protected

Definition at line 73 of file AuthController.php.


The documentation for this class was generated from the following file: