1. class
  2. Alxarafe
  3. \
  4. Core
  5. \
  6. Base
  7. \
  8. AuthPageController

AuthPageController

abstract class AuthPageController extends AuthController

Class AuthPageController, all controllers that needs to be accessed as a page must extends from this.

Constants

COOKIE_EXPIRATION_MIN

Minimum cookie time expiration.
MENU_DELIMITER

Symbol to split menu/submenu items.

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
User $user The user logged. from AuthController
string|null $logkey User log key. from AuthController
private string $defaultRedirect Page to redirect. from AuthController
string $title Page title.
string $icon Page icon.
string $description Page description.
array $menu Page menu place.
bool $canAccess Can user access?
bool $canCreate Can user create?
bool $canRead Can user read?
bool $canUpdate Can user update?
bool $canDelete Can user delete?
bool $canPrint Can user print?
bool $canExport Can user export?
bool $canSendMail Can user send mail?
UserRole[] $roles The roles where user is assigned.
string $url Contiene la url que se usará en el formulario.

Methods

__construct()

AuthPageController constructor.

Response
sendResponseTemplate(array $data = [])

Add new vars to render, render the template and send the Response.

from Controller
Response
sendResponse(string $reply, int $status = Response::HTTP_OK)

Send the Response with data received.

from Controller
RedirectResponse
redirect(string $destiny = '')

Send a RedirectResponse to destiny receive.

from Controller
Response
runMethod(string $methodName)

No description

void
addToVar(string $name, mixed $value)

Add a new element to a value saved in the array that is passed to the template.

from Controller
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.

from Controller
void
addCSS(string $file)

addCSS includes the CSS files to template.

from Controller
void
addJS(string $file)

addJS includes the JS files to template.

from Controller
array
getArrayPost()

Return body parameters $_POST values.

from Controller
array
getArrayGet()

Return query string parameters $_GET values.

from Controller
array
getArrayServer()

Return server and execution environment parameters from $_SERVER values.

from Controller
array
getArrayHeaders()

Return headers from $_SERVER header values.

from Controller
array
getArrayFiles()

Return uploaded files from $_FILES.

from Controller
array
getArrayCookies()

Return cookies from $_COOKIES.

from Controller
checkAuth()

Check that user is logged in.

from AuthController
bool
checkLoginWeb()

Check if user is logged-in from Login.

from AuthController
bool
checkLoginAPI()

Check if user is logged-in from API.

from AuthController
adjustCookieUser(int $time = 0, int $remember = 0)

Adjust auth cookie user.

from AuthController
RedirectResponse
logout()

Close the user session and go to the main page

from AuthController
void
setPageDetails()

Set the page details.

array
pageDetails()

Returns the page details.

Response
indexMethod()

Start point and default list of registers.

Response
createMethod()

Default create method for new registers.

Response
readMethod()

Default show method for show an individual register.

Response
updateMethod()

Default update method for update an individual register.

Response
deleteMethod()

Default delete method for delete an individual register.

loadPerms()

Load perms for this user.

bool
canAction(string $action)

Verify if this user can do an action.

array
getUserMenu()

Return a list of pages for generate user menu.

array
getPageDetails()

Returns the page details as array.

Details

at line 128
__construct()

AuthPageController constructor.

in Controller at line 135
Response sendResponseTemplate(array $data = [])

Add new vars to render, render the template and send the Response.

Parameters

array $data

Return Value

Response

in Controller at line 149
Response sendResponse(string $reply, int $status = Response::HTTP_OK)

Send the Response with data received.

Parameters

string $reply
int $status

Return Value

Response

in Controller at line 163
RedirectResponse redirect(string $destiny = '')

Send a RedirectResponse to destiny receive.

Parameters

string $destiny

Return Value

RedirectResponse

at line 212
Response runMethod(string $methodName)

Parameters

string $methodName

Return Value

Response

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.

Parameters

string $name
mixed $value

Return Value

void

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).

Parameters

string $resourceName is the name of the file (with extension)
boolean $relative set to false for use an absolute path.

Return Value

string the complete path of resource.

in Controller at line 240
void addCSS(string $file)

addCSS includes the CSS files to template.

Parameters

string $file

Return Value

void

in Controller at line 252
void addJS(string $file)

addJS includes the JS files to template.

Parameters

string $file

Return Value

void

in Controller at line 262
array getArrayPost()

Return body parameters $_POST values.

Return Value

array

in Controller at line 272
array getArrayGet()

Return query string parameters $_GET values.

Return Value

array

in Controller at line 282
array getArrayServer()

Return server and execution environment parameters from $_SERVER values.

Return Value

array

in Controller at line 292
array getArrayHeaders()

Return headers from $_SERVER header values.

Return Value

array

in Controller at line 302
array getArrayFiles()

Return uploaded files from $_FILES.

Return Value

array

in Controller at line 312
array getArrayCookies()

Return cookies from $_COOKIES.

Return Value

array

in AuthController at line 67
checkAuth()

Check that user is logged in.

in AuthController at line 78
private bool checkLoginWeb()

Check if user is logged-in from Login.

Return Value

bool

in AuthController at line 104
private bool checkLoginAPI()

Check if user is logged-in from API.

Return Value

bool

in AuthController at line 127
private adjustCookieUser(int $time = 0, int $remember = 0)

Adjust auth cookie user.

Parameters

int $time
int $remember

in AuthController at line 147
RedirectResponse logout()

Close the user session and go to the main page

Return Value

RedirectResponse

at line 142
protected void setPageDetails()

Set the page details.

Return Value

void

at line 154
array pageDetails()

Returns the page details.

Return Value

array

at line 177
abstract Response indexMethod()

Start point and default list of registers.

Return Value

Response

at line 184
abstract Response createMethod()

Default create method for new registers.

Return Value

Response

at line 191
abstract Response readMethod()

Default show method for show an individual register.

Return Value

Response

at line 198
abstract Response updateMethod()

Default update method for update an individual register.

Return Value

Response

at line 205
abstract Response deleteMethod()

Default delete method for delete an individual register.

Return Value

Response

at line 276
private loadPerms()

Load perms for this user.

at line 300
private bool canAction(string $action)

Verify if this user can do an action.

Parameters

string $action

Return Value

bool

at line 337
array getUserMenu()

Return a list of pages for generate user menu.

Return Value

array

at line 364
protected array getPageDetails()

Returns the page details as array.

Return Value

array