FacturaScripts

EditPageOption extends EditPageOption
in package
uses ExtensionsTrait

Class created by Core/Internal/PluginsDeploy

Table of Contents

Properties

$backPage  : string
Contains the url to go back.
$columns  : array<string|int, mixed>
$empresa  : Empresa
Selected company.
$modals  : array<string|int, mixed>
$model  : PageOption
Details of the view configuration
$multiRequestProtection  : MultiRequestProtection
$permissions  : ControllerPermissions
User permissions on this controller.
$request  : Request
Request on which we can get data.
$rows  : array<string|int, mixed>
$selectedUser  : string
Selected user, for which the controller columns are created or modified
$selectedViewName  : string
Selected view, for which columns are created or modified
$title  : string
Title of the page.
$uri  : string
Given uri, default is empty.
$user  : User|false
User logged in.
$dataBase  : DataBase
It provides direct access to the database.
$extensionCache  : array<string|int, mixed>
Cache for extension lookups by method name.
$extensions  : array<string|int, mixed>
Stores class extensions.
$response  : Response
HTTP Response object.

Methods

__call()  : mixed
Executes the first matched extension.
__construct()  : mixed
Initialize all objects and properties.
addExtension()  : void
clearExtensions()  : void
Clears all registered extensions.
getExtensions()  : array<string|int, mixed>
Returns a list of all registered extension names.
getPageData()  : array<string|int, mixed>
Return the basic data for this page.
getTemplate()  : string|false
Return the template to use for this controller.
getUserList()  : array<string|int, mixed>
Get the list of users, excluding the user admin
hasExtension()  : bool
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.
removeExtension()  : bool
Removes all extensions with the specified name.
request()  : Request
run()  : void
setTemplate()  : bool
Set the template to use for this controller.
url()  : string
Return the URL of the actual controller.
db()  : DataBase
deleteAction()  : void
Delete configuration for view
getClassName()  : string
Return the name of the controller.
loadPageOptions()  : void
Load the display options to edit.
loadSelectedViewName()  : void
response()  : Response
saveAction()  : void
Save new configuration for view
validateFormToken()  : bool
Check request token. Returns an error if: - the token does not exist - the token is invalid - the token is duplicated
buildExtensionCache()  : void
Builds and caches sorted extensions for a method name.

Properties

$selectedUser

Selected user, for which the controller columns are created or modified

public string $selectedUser

$selectedViewName

Selected view, for which columns are created or modified

public string $selectedViewName

$title

Title of the page.

public string $title

título de la página.

$uri

Given uri, default is empty.

public string $uri

$extensionCache

Cache for extension lookups by method name.

protected static array<string|int, mixed> $extensionCache = []

$extensions

Stores class extensions.

protected static array<string|int, mixed> $extensions = []

Methods

__call()

Executes the first matched extension.

public __call(string $name[, array<string|int, mixed> $arguments = [] ]) : mixed
Parameters
$name : string
$arguments : array<string|int, mixed> = []
Tags
throws
BadMethodCallException

__construct()

Initialize all objects and properties.

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

addExtension()

public static addExtension(mixed $extension[, int $priority = 100 ]) : void
Parameters
$extension : mixed
$priority : int = 100

Priority for all methods in this extension (0-1000, default 100)

clearExtensions()

Clears all registered extensions.

public static clearExtensions() : void

getExtensions()

Returns a list of all registered extension names.

public static getExtensions() : array<string|int, mixed>
Return values
array<string|int, mixed>

getPageData()

Return the basic data for this page.

public getPageData() : array<string|int, mixed>
Return values
array<string|int, mixed>

getTemplate()

Return the template to use for this controller.

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

getUserList()

Get the list of users, excluding the user admin

public getUserList() : array<string|int, mixed>
Return values
array<string|int, mixed>

hasExtension()

public hasExtension(mixed $name) : bool
Parameters
$name : mixed
Return values
bool

pipe()

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
bool

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

removeExtension()

Removes all extensions with the specified name.

public static removeExtension(string $name) : bool
Parameters
$name : string
Return values
bool —

True if at least one extension was removed

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

deleteAction()

Delete configuration for view

protected deleteAction() : void

getClassName()

Return the name of the controller.

protected getClassName() : string
Return values
string

loadPageOptions()

Load the display options to edit.

protected loadPageOptions() : void

If it does not find them in the database, it loads the default options of the xml view.

saveAction()

Save new configuration for view

protected saveAction() : void

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

buildExtensionCache()

Builds and caches sorted extensions for a method name.

private buildExtensionCache(string $name) : void
Parameters
$name : string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results