FacturaScripts

PanelController extends PanelController
in package

Class created by Core/Base/PluginManager

Tags
author

FacturaScripts [email protected]

Table of Contents

MODEL_NAMESPACE  = '\\FacturaScripts\\Dinamic\\Model\\'
$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.
$hasData  : bool
Indicates if the main view has data or is empty.
$multiRequestProtection  : MultiRequestProtection
$permissions  : ControllerPermissions
User permissions on this controller.
$request  : Request
Request on which we can get data.
$tabsPosition  : string
Tabs position in page: left, bottom.
$title  : string
Title of the page.
$uri  : string
Given uri, default is empty.
$user  : User|false
User logged in.
$views  : array<string|int, BaseView>|array<string|int, ListView>
List of views displayed by the controller.
$dataBase  : DataBase
It provides direct access to the database.
$response  : Response
HTTP Response object.
$className  : string
Name of the class of the controller (although its in inheritance from this class, the name of the final class we will have here)
$current  : string
Indicates current view, when drawing.
$template  : string|false
Name of the file for the template.
__construct()  : mixed
Initialize all objects and properties.
addButton()  : mixed
Adds a new button to the tab.
addCustomView()  : mixed
addExtension()  : mixed
getCurrentView()  : BaseView|ListView
getImageUrl()  : string
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.
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.
setCurrentView()  : mixed
setSettings()  : void
Set value for setting of a view
setTabsPosition()  : mixed
Sets the tabs position, by default is set to 'left', also supported 'bottom', 'top' and 'left-bottom.
setTemplate()  : bool
Set the template to use for this controller.
toolBox()  : ToolBox
url()  : string
Return the URL of the actual controller.
addEditListView()  : mixed
Adds a EditList type view to the controller.
addEditView()  : mixed
Adds an Edit type view to the controller.
addHtmlView()  : mixed
Adds an HTML type view to the controller.
addListView()  : mixed
Adds a List type view to the 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.
deleteAction()  : bool
Action to delete data.
editAction()  : bool
Runs the data edit action.
execAfterAction()  : mixed
Run the controller after actions.
execPreviousAction()  : bool
Run the actions that alter data before reading it.
exportAction()  : mixed
getAutocompleteValues()  : array<string|int, mixed>
Return values from Widget Values for autocomplete action
getClassName()  : string
Return the name of the controller.
insertAction()  : bool
Runs data insert action.
loadData()  : mixed
Loads the data to display.
requestGet()  : array<string|int, mixed>
Return array with parameters values
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
checkPHPversion()  : mixed

Constants

MODEL_NAMESPACE

public mixed MODEL_NAMESPACE = '\\FacturaScripts\\Dinamic\\Model\\'

Properties

$hasData

Indicates if the main view has data or is empty.

public bool $hasData = false

$request

Request on which we can get data.

public Request $request

$tabsPosition

Tabs position in page: left, bottom.

public string $tabsPosition

$title

Title of the page.

public string $title

título de la página.

$uri

Given uri, default is empty.

public string $uri

$response

HTTP Response object.

protected Response $response

$className

Name of the class of the controller (although its in inheritance from this class, the name of the final class we will have here)

private string $className

CLASS

$current

Indicates current view, when drawing.

private string $current

$template

Name of the file for the template.

private string|false $template

nombre_archivo.html.twig

Methods

__construct()

Initialize all objects and properties.

public __construct(string $className[, string $uri = '' ]) : mixed
Parameters
$className : string
$uri : string = ''
Return values
mixed

addButton()

Adds a new button to the tab.

public addButton(string $viewName, array<string|int, mixed> $btnArray) : mixed
Parameters
$viewName : string
$btnArray : array<string|int, mixed>
Return values
mixed

addExtension()

public static addExtension(mixed $extension) : mixed
Parameters
$extension : mixed
Return values
mixed

getImageUrl()

public getImageUrl() : string
Return values
string

getMainViewName()

Returns the name assigned to the main view

public getMainViewName() : string
Return values
string

getPageData()

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
Return values
mixed

getTemplate()

Return the template to use for this controller.

public getTemplate() : string|false
Return values
string|false

getViewModelValue()

Return the value for a field in the model of the view.

public getViewModelValue(string $viewName, string $fieldName) : mixed
Parameters
$viewName : string
$fieldName : string
Return values
mixed

pipe()

public pipe(string $name, array<string|int, mixed> ...$arguments) : mixed
Parameters
$name : string
$arguments : array<string|int, mixed>
Return values
mixed

pipeFalse()

public pipeFalse(string $name, array<string|int, mixed> ...$arguments) : bool
Parameters
$name : string
$arguments : array<string|int, mixed>
Return values
bool

publicCore()

Execute the public part of the controller.

public publicCore(Response &$response) : mixed
Parameters
$response : Response
Return values
mixed

redirect()

Redirect to an url or controller.

public redirect(string $url, int $delay) : mixed
Parameters
$url : string
$delay : int
Return values
mixed

setCurrentView()

public setCurrentView(string $viewName) : mixed
Parameters
$viewName : string
Return values
mixed

setSettings()

Set value for setting of a view

public setSettings(string $viewName, string $property, mixed $value) : void
Parameters
$viewName : string
$property : string
$value : mixed
Return values
void

setTabsPosition()

Sets the tabs position, by default is set to 'left', also supported 'bottom', 'top' and 'left-bottom.

public setTabsPosition(string $position) : mixed
Parameters
$position : string
Return values
mixed

setTemplate()

Set the template to use for this controller.

public setTemplate(string|false $template) : bool
Parameters
$template : string|false
Return values
bool

url()

Return the URL of the actual controller.

public url() : string
Return values
string

addEditListView()

Adds a EditList type view to the controller.

protected addEditListView(string $viewName, string $modelName, string $viewTitle[, string $viewIcon = 'fas fa-bars' ]) : mixed
Parameters
$viewName : string
$modelName : string
$viewTitle : string
$viewIcon : string = 'fas fa-bars'
Return values
mixed

addEditView()

Adds an Edit type view to the controller.

protected addEditView(string $viewName, string $modelName, string $viewTitle[, string $viewIcon = 'fas fa-edit' ]) : mixed
Parameters
$viewName : string
$modelName : string
$viewTitle : string
$viewIcon : string = 'fas fa-edit'
Return values
mixed

addHtmlView()

Adds an HTML type view to the controller.

protected addHtmlView(string $viewName, string $fileName, string $modelName, string $viewTitle[, string $viewIcon = 'fab fa-html5' ]) : mixed
Parameters
$viewName : string
$fileName : string
$modelName : string
$viewTitle : string
$viewIcon : string = 'fab fa-html5'
Return values
mixed

addListView()

Adds a List type view to the controller.

protected addListView(string $viewName, string $modelName, string $viewTitle[, string $viewIcon = 'fas fa-list' ]) : mixed
Parameters
$viewName : string
$modelName : string
$viewTitle : string
$viewIcon : string = 'fas fa-list'
Return values
mixed

autocompleteAction()

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
bool

createViews()

Inserts the views or tabs to display.

protected abstract createViews() : mixed
Return values
mixed

deleteAction()

Action to delete data.

protected deleteAction() : bool
Return values
bool

editAction()

Runs the data edit action.

protected editAction() : bool
Return values
bool

execAfterAction()

Run the controller after actions.

protected execAfterAction(string $action) : mixed
Parameters
$action : string
Return values
mixed

execPreviousAction()

Run the actions that alter data before reading it.

protected execPreviousAction(string $action) : bool
Parameters
$action : string
Return values
bool

exportAction()

protected exportAction() : mixed
Return values
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
string

insertAction()

Runs data insert action.

protected insertAction() : bool
Return values
bool

loadData()

Loads the data to display.

protected abstract loadData(string $viewName, BaseView $view) : mixed
Parameters
$viewName : string
$view : BaseView
Return values
mixed

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>

selectAction()

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
Return values
bool

checkPHPversion()

private checkPHPversion(float $min) : mixed
Parameters
$min : float
Return values
mixed

Search results