Login
class Login extends Controller
Class Login
Constants
| COOKIE_EXPIRATION |
Cookie time expiration. |
| COOKIE_EXPIRATION_MIN |
Minimum cookie time expiration. |
Properties
| string|null | $username | Contains the user's name or null | from Controller |
| string | $shortName | Class short name. | from Controller |
| Session | $session | To manage PHP Sessions. | from Controller |
| TemplateRender | $renderer | Manage the renderer. | from Controller |
| Request | $request | Request from client. | from Controller |
| Response | $response | Response to client. | from Controller |
| DebugTool | $debugTool | The debug tool used. | from Controller |
| Logger | $logger | The logger. | from Controller |
| protected Container|null | $container | Contains dependencies. | from Controller |
| protected Translator | $translator | The translator manager. | from Controller |
| private array | $vars | Array that contains the variables that will be passed to the template. | from Controller |
| string|null | $redirectUrl | Where to redirect if needed. | |
| string|null | $logkey | User log key. | |
| private User|null | $user | User in use. |
Methods
Add new vars to render, render the template and send the Response.
Send the Response with data received.
Send a RedirectResponse to destiny receive.
Add a new element to a value saved in the array that is passed to the template.
Check if the resource is in the application's resource folder (for example, in the css or js folders of the skin folder). It's a specific file.
Return server and execution environment parameters from $_SERVER values.
Returns the page details.
The start point of the controller.
Redirect to controller, default or selected by the user.
Returns the cookie from the user
Adjust auth cookie user.
Clear the cookie user.
Main is invoked if method is not specified.
Close the user session and go to the main page
Returns the user name if setted or null.
Set cookie's user.
Details
in
Controller
at line 110
__construct()
Controller constructor.
in
Controller
at line 135
Response
sendResponseTemplate(array $data = [])
Add new vars to render, render the template and send the Response.
in
Controller
at line 149
Response
sendResponse(string $reply, int $status = Response::HTTP_OK)
Send the Response with data received.
in
Controller
at line 163
RedirectResponse
redirect(string $destiny = '')
Send a RedirectResponse to destiny receive.
in Controller
at line 178
Response
runMethod(string $methodName)
in
Controller
at line 195
void
addToVar(string $name, mixed $value)
Add a new element to a value saved in the array that is passed to the template.
It is used when what we are saving is an array and we want to add a new element to that array. IMPORTANT: The element only is added if is not empty.
in
Controller
at line 216
string
addResource(string $resourceName, boolean $relative = true)
Check if the resource is in the application's resource folder (for example, in the css or js folders of the skin folder). It's a specific file.
If it can not be found, check if it is in the templates folder (for example in the css or js folders of the templates folder). It's a common file.
If it is not in either of the two, no route is specified (it will surely give loading error).
in
Controller
at line 240
void
addCSS(string $file)
addCSS includes the CSS files to template.
in
Controller
at line 252
void
addJS(string $file)
addJS includes the JS files to template.
in
Controller
at line 262
array
getArrayPost()
Return body parameters $_POST values.
in
Controller
at line 272
array
getArrayGet()
Return query string parameters $_GET values.
in
Controller
at line 282
array
getArrayServer()
Return server and execution environment parameters from $_SERVER values.
in
Controller
at line 292
array
getArrayHeaders()
Return headers from $_SERVER header values.
in
Controller
at line 302
array
getArrayFiles()
Return uploaded files from $_FILES.
in
Controller
at line 312
array
getArrayCookies()
Return cookies from $_COOKIES.
at line 58
array
pageDetails()
Returns the page details.
at line 74
Response
indexMethod()
The start point of the controller.
at line 114
private
RedirectResponse
redirectToController()
Redirect to controller, default or selected by the user.
at line 130
string|null
getCookieUser($remember)
Returns the cookie from the user
at line 156
private
adjustCookieUser(int $time = 0, int $remember = 0)
Adjust auth cookie user.
at line 176
private void
clearCookieUser()
Clear the cookie user.
at line 191
private Response
main()
Main is invoked if method is not specified.
Load the view of the login form, if there is no user identified.
at line 205
RedirectResponse
logoutMethod()
Close the user session and go to the main page
at line 217
string|null
getUserName()
Returns the user name if setted or null.
at line 227
User|null
getUser()
Returns the user if setted or null.
at line 241
bool
setUser(string $userName, string $password, bool $remember = false)
Set cookie's user.