IntermediateRegions
class IntermediateRegions extends AuthPageExtendedController
Class IntermediateRegions
Traits
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. | from AuthPageController |
string | $icon | Page icon. | from AuthPageController |
string | $description | Page description. | from AuthPageController |
array | $menu | Page menu place. | from AuthPageController |
bool | $canAccess | Can user access? | from AuthPageController |
bool | $canCreate | Can user create? | from AuthPageController |
bool | $canRead | Can user read? | from AuthPageController |
bool | $canUpdate | Can user update? | from AuthPageController |
bool | $canDelete | Can user delete? | from AuthPageController |
bool | $canPrint | Can user print? | from AuthPageController |
bool | $canExport | Can user export? | from AuthPageController |
bool | $canSendMail | Can user send mail? | from AuthPageController |
UserRole[] | $roles | The roles where user is assigned. | from AuthPageController |
string | $url | Contiene la url que se usarĂ¡ en el formulario. | from AuthPageController |
array | $postData | Contains all data received from $_POST. | from AuthPageExtendedController |
Table | $model | Main table model. | from AuthPageExtendedController |
string | $tableName | The table relate to the model. | from AuthPageExtendedController |
array | $viewData | The data view details for each data field. | from AuthPageExtendedController |
string | $encType | Type of encryption for form. | from AuthPageExtendedController |
array | $tableData | Data received or sended in post. | from AuthPageExtendedController |
string | $code | Code to table id. | from AuthPageExtendedController |
protected array | $oldData | Contains all data from table. | from AuthPageExtendedController |
protected array | $fieldsStruct | Contains the field structure. | from AuthPageExtendedController |
protected string|null | $currentId | Contains the primary key of register in use. | from AuthPageExtendedController |
protected string | $status | Can contain: listing, adding or editing. | from AuthPageExtendedController |
Methods
IntermediateRegions constructor.
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.
Default delete method for delete an individual register.
Realize the search to database table.
Returns a list of actions buttons. By default returns Read/Update/Delete actions.
Obtains an array of data from register $this->currentId.
Default delete method for delete an individual register, used as alias
Se le pasa un registro con datos de la tabla actual, y cumplimenta los que falten con los datos por defecto.
Details
at line 22
__construct()
IntermediateRegions constructor.
in
Controller
at line 135
Response
sendResponseTemplate(array $data = [])
Add new vars to render, render the template and send the Response.
in
AjaxDataTableTrait
at line 155
abstract 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
AuthPageController
at line 212
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.
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.
in
AuthController
at line 104
private bool
checkLoginAPI()
Check if user is logged-in from API.
in
AuthController
at line 127
private
adjustCookieUser(int $time = 0, int $remember = 0)
Adjust auth cookie user.
in
AuthController
at line 147
RedirectResponse
logout()
Close the user session and go to the main page
in
AuthPageController
at line 142
protected void
setPageDetails()
Set the page details.
at line 32
array
pageDetails()
Returns the page details.
in
AuthPageExtendedController
at line 366
Response
indexMethod()
The start point of the controller.
in
AuthPageExtendedController
at line 172
Response
createMethod()
Create new record.
in
AuthPageExtendedController
at line 233
Response
readMethod()
Read existing record.
in
AuthPageExtendedController
at line 257
Response
updateMethod()
Update existing record.
in
AuthPageExtendedController
at line 339
Response
deleteMethod()
Default delete method for delete an individual register.
in
AuthPageController
at line 276
private
loadPerms()
Load perms for this user.
in
AuthPageController
at line 300
private bool
canAction(string $action)
Verify if this user can do an action.
in
AuthPageController
at line 337
array
getUserMenu()
Return a list of pages for generate user menu.
in
AuthPageController
at line 364
protected array
getPageDetails()
Returns the page details as array.
in
AjaxDataTableTrait
at line 25
ajaxTableDataMethod()
Return the table data using AJAX
in
AjaxDataTableTrait
at line 55
abstract
initialize()
Initialize common properties
in
AjaxDataTableTrait
at line 64
private
searchData(array $data, int $recordsFiltered, array $requestData = [])
Realize the search to database table.
in
AjaxDataTableTrait
at line 99
array
getDefaultColumnsSearch()
Return a default list of col.
in
AjaxDataTableTrait
at line 116
private
fillActions($data)
Fill 'col-action' fields with action buttons.
in
AjaxDataTableTrait
at line 145
abstract array
getActionButtons(string $id = '')
Returns a list of actions buttons. By default returns Read/Update/Delete actions.
If some needs to be replace, replace it on final class.
in
AjaxDataTableTrait
at line 160
getTableHeader()
Returns the header for table.
in
AjaxDataTableTrait
at line 183
getTableBody()
Returns the content for the body of table.
in
AjaxDataTableTrait
at line 208
getListFields()
Returns a list of fields for the tablename.
in
AjaxDataTableTrait
at line 239
getTableFooter()
Returns a footer list of fields for the table.
in
AuthPageExtendedController
at line 144
array
getExtraActions()
Returns a list of extra actions.
in
AuthPageExtendedController
at line 154
string
getStatus()
Returns the actual status of the controller.
in
AuthPageExtendedController
at line 164
Response
addMethod()
Create new record, used as alias
in
AuthPageExtendedController
at line 206
protected array
getRecordData()
Obtains an array of data from register $this->currentId.
If register doesn't exists, returns an empty register with default data.
This method can do additional things in more complex situations.
in
AuthPageExtendedController
at line 225
Response
showMethod()
Read existing record, used as alias
in
AuthPageExtendedController
at line 247
Response
editMethod()
Update existing record, used as alias
in
AuthPageExtendedController
at line 281
protected RedirectResponse
cancel()
Cancels goes to main controller status.
in
AuthPageExtendedController
at line 295
protected
save()
Save the data.
This method can do additional things in more complex situations.
in
AuthPageExtendedController
at line 313
protected void
getDataPost()
Returns the data received from $_POST
This method can do additional things in more complex situations.
in
AuthPageExtendedController
at line 329
Response
removeMethod()
Default delete method for delete an individual register, used as alias
in
AuthPageExtendedController
at line 356
accessDenied()
Access denied page.
in
AuthPageExtendedController
at line 378
Response
listData()
List all records on model.
in
AuthPageExtendedController
at line 438
protected array
setDefaults(array $record)
Se le pasa un registro con datos de la tabla actual, y cumplimenta los que falten con los datos por defecto.