BaseController
extends BaseController
in package
AbstractYes
Class created by Core/Internal/PluginsDeploy
Table of Contents
Constants
- MODEL_NAMESPACE = '\FacturaScripts\Dinamic\Model\\'
Properties
- $active : string
- Indicates the active view.
- $codeModel : CodeModel
- Model to use with select and autocomplete filters.
- $empresa : Empresa
- Selected company.
- $exportManager : ExportManager
- Object to export data.
- $multiRequestProtection : MultiRequestProtection
- $permissions : ControllerPermissions
- User permissions on this controller.
- $request : Request
- Request on which we can get data.
- $title : string
- Title of the page.
- $uri : string
- Given uri, default is empty.
- $user : User|false
- User logged in.
- $views : array<string|int, BaseView>
- List of views displayed by the controller.
- $dataBase : DataBase
- It provides direct access to the database.
- $response : Response
- HTTP Response object.
Methods
- __construct() : mixed
- Initializes all the objects and properties.
- addButton() : BaseView
- Adds a new button to the tab.
- addCustomView() : BaseView
- addExtension() : mixed
- getCurrentView() : BaseView
- getMainViewName() : string
- Returns the name assigned to the main view
- getPageData() : array<string|int, mixed>
- Return the basic data for this page.
- getSettings() : mixed
- Returns the configuration value for the indicated view.
- getTemplate() : string|false
- Return the template to use for this controller.
- getViewModelValue() : mixed
- Return the value for a field in the model of the view.
- listView() : ListView
- pipe() : mixed
- pipeFalse() : bool
- privateCore() : mixed
- Runs the controller's private logic.
- publicCore() : mixed
- Execute the public part of the controller.
- redirect() : mixed
- Redirect to an url or controller.
- request() : Request
- run() : void
- setCurrentView() : void
- setSettings() : BaseView
- Set value for setting of a view
- setTemplate() : bool
- Set the template to use for this controller.
- tab() : BaseView
- url() : string
- Return the URL of the actual controller.
- autocompleteAction() : array<string|int, mixed>
- Run the autocomplete action.
- checkOwnerData() : bool
- Returns true if the active user has permission to view the information of the active record in the informed model.
- createViews() : mixed
- Inserts the views or tabs to display.
- datalistAction() : array<string|int, mixed>
- Run the datalist action.
- db() : DataBase
- deleteAction() : bool
- Action to delete data.
- exportAction() : mixed
- getAutocompleteValues() : array<string|int, mixed>
- Return values from Widget Values for autocomplete action
- getClassName() : string
- Return the name of the controller.
- loadData() : mixed
- Loads the data to display.
- requestGet() : array<string|int, mixed>
- Return array with parameters values
- response() : Response
- selectAction() : array<string|int, mixed>
- Run the select action.
- validateFormToken() : bool
- Check request token. Returns an error if: - the token does not exist - the token is invalid - the token is duplicated
Constants
MODEL_NAMESPACE
public
mixed
MODEL_NAMESPACE
= '\FacturaScripts\Dinamic\Model\\'
Properties
$active
Indicates the active view.
public
string
$active
$codeModel
Model to use with select and autocomplete filters.
public
CodeModel
$codeModel
$empresa
Selected company.
public
Empresa
$empresa
$exportManager
Object to export data.
public
ExportManager
$exportManager
$multiRequestProtection
public
MultiRequestProtection
$multiRequestProtection
$permissions
User permissions on this controller.
public
ControllerPermissions
$permissions
$request
Request on which we can get data.
public
Request
$request
$title
Title of the page.
public
string
$title
título de la página.
$uri
Given uri, default is empty.
public
string
$uri
$user
User logged in.
public
User|false
$user
= false
$views
List of views displayed by the controller.
public
array<string|int, BaseView>
$views
= []
$dataBase
It provides direct access to the database.
protected
DataBase
$dataBase
$response
HTTP Response object.
protected
Response
$response
Methods
__construct()
Initializes all the objects and properties.
public
__construct(string $className[, string $uri = '' ]) : mixed
Parameters
- $className : string
- $uri : string = ''
addButton()
Adds a new button to the tab.
public
addButton(string $viewName, array<string|int, mixed> $btnArray) : BaseView
Parameters
- $viewName : string
- $btnArray : array<string|int, mixed>
Return values
BaseViewaddCustomView()
public
addCustomView(string $viewName, BaseView $view) : BaseView
Parameters
- $viewName : string
- $view : BaseView
Return values
BaseViewaddExtension()
public
static addExtension(mixed $extension) : mixed
Parameters
- $extension : mixed
getCurrentView()
public
getCurrentView() : BaseView
Return values
BaseViewgetMainViewName()
Returns the name assigned to the main view
public
getMainViewName() : string
Return values
stringgetPageData()
Return the basic data for this page.
public
getPageData() : array<string|int, mixed>
Return values
array<string|int, mixed>getSettings()
Returns the configuration value for the indicated view.
public
getSettings(string $viewName, string $property) : mixed
Parameters
- $viewName : string
- $property : string
getTemplate()
Return the template to use for this controller.
public
getTemplate() : string|false
Return values
string|falsegetViewModelValue()
Return the value for a field in the model of the view.
public
getViewModelValue(string $viewName, string $fieldName) : mixed
Parameters
- $viewName : string
- $fieldName : string
listView()
public
listView(string $viewName) : ListView
Parameters
- $viewName : string
Return values
ListViewpipe()
public
pipe(string $name, array<string|int, mixed> ...$arguments) : mixed
Parameters
- $name : string
- $arguments : array<string|int, mixed>
pipeFalse()
public
pipeFalse(string $name, array<string|int, mixed> ...$arguments) : bool
Parameters
- $name : string
- $arguments : array<string|int, mixed>
Return values
boolprivateCore()
Runs the controller's private logic.
public
privateCore(Response &$response, User $user, ControllerPermissions $permissions) : mixed
Parameters
- $response : Response
- $user : User
- $permissions : ControllerPermissions
publicCore()
Execute the public part of the controller.
public
publicCore(Response &$response) : mixed
Parameters
- $response : Response
redirect()
Redirect to an url or controller.
public
redirect(string $url[, int $delay = 0 ]) : mixed
Parameters
- $url : string
- $delay : int = 0
request()
public
request() : Request
Return values
Requestrun()
public
run() : void
setCurrentView()
public
setCurrentView(string $viewName) : void
Parameters
- $viewName : string
setSettings()
Set value for setting of a view
public
setSettings(string $viewName, string $property, mixed $value) : BaseView
Parameters
- $viewName : string
- $property : string
- $value : mixed
Return values
BaseViewsetTemplate()
Set the template to use for this controller.
public
setTemplate(string|false $template) : bool
Parameters
- $template : string|false
Return values
booltab()
public
tab(string $viewName) : BaseView
Parameters
- $viewName : string
Return values
BaseViewurl()
Return the URL of the actual controller.
public
url() : string
Return values
stringautocompleteAction()
Run the autocomplete action.
protected
autocompleteAction() : array<string|int, mixed>
Returns a JSON string for the searched values.
Return values
array<string|int, mixed>checkOwnerData()
Returns true if the active user has permission to view the information of the active record in the informed model.
protected
checkOwnerData(ModelClass $model) : bool
Parameters
- $model : ModelClass
Return values
boolcreateViews()
Inserts the views or tabs to display.
protected
abstract createViews() : mixed
datalistAction()
Run the datalist action.
protected
datalistAction() : array<string|int, mixed>
Returns a JSON string for the searched values.
Return values
array<string|int, mixed>db()
protected
db() : DataBase
Return values
DataBasedeleteAction()
Action to delete data.
protected
deleteAction() : bool
Return values
boolexportAction()
protected
exportAction() : mixed
getAutocompleteValues()
Return values from Widget Values for autocomplete action
protected
getAutocompleteValues(string $viewName, string $fieldName) : array<string|int, mixed>
Parameters
- $viewName : string
- $fieldName : string
Return values
array<string|int, mixed>getClassName()
Return the name of the controller.
protected
getClassName() : string
Return values
stringloadData()
Loads the data to display.
protected
abstract loadData(string $viewName, BaseView $view) : mixed
Parameters
- $viewName : string
- $view : BaseView
requestGet()
Return array with parameters values
protected
requestGet(array<string|int, mixed> $keys) : array<string|int, mixed>
Parameters
- $keys : array<string|int, mixed>
Return values
array<string|int, mixed>response()
protected
response() : Response
Return values
ResponseselectAction()
Run the select action.
protected
selectAction() : array<string|int, mixed>
Returns a JSON string for the searched values.
Return values
array<string|int, mixed>validateFormToken()
Check request token. Returns an error if: - the token does not exist - the token is invalid - the token is duplicated
protected
validateFormToken() : bool