FacturaScripts

Dashboard extends Dashboard Uses ExtensionsTrait

Class created by Core/Base/PluginManager

Table of Contents

$extensions Stores class extensions. array
$createLinks array
$lowStock array
$news array
$openLinks array
$receipts array
$sections array
$stats array
$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) string
$dataBase It provides direct access to the database. DataBase
$empresa Selected company. Empresa
$multiRequestProtection MultiRequestProtection
$permissions User permissions on this controller. ControllerPermissions
$request Request on which we can get data. Request
$response HTTP Response object. Response
$template Name of the file for the template. string|bool
$title Title of the page. string
$uri Given uri, default is empty. string
$user User logged in. User|bool
__call() Executes the first matched extension. mixed
addExtension() mixed
pipe() mixed
getPageData() Return the basic data for this page. array
privateCore() Runs the controller's private logic. mixed
getStatsMonth() Gets the name of the month for the statistics. string
getStatsWhere() Gets the where filter for calc of the statistics. \FacturaScripts\Core\Base\DataBase\DataBaseWhere[]
loadCreateLinks() Set the quick links for data creation. mixed
loadExtensions() Establish the sections to be displayed on the dashboard. mixed
loadLowStockSection() Load the data regarding the stock under minimum. mixed
loadNews() Load last news from facturascripts.com mixed
loadOpenLinks() Loads the links to the latest data created by the user. mixed
loadReceiptSection() Load the receipts pending collection. mixed
loadStats() Load statistical data. mixed
setOpenLinksForDocument() mixed
__construct() Initialize all objects and properties. mixed
getTemplate() Return the template to use for this controller. string|bool
publicCore() Execute the public part of the controller. mixed
redirect() Redirect to an url or controller. mixed
setTemplate() Set the template to use for this controller. bool
toolBox() ToolBox
url() Return the URL of the actual controller. string
checkPHPversion() mixed
getClassName() Return the name of the controller. string

Properties

$extensions

Stores class extensions.

protected static array $extensions = []

$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

$request

Request on which we can get data.

public Request $request

$response

HTTP Response object.

protected Response $response

$template

Name of the file for the template.

private string|bool $template

$uri

Given uri, default is empty.

public string $uri

Methods

__call()

Executes the first matched extension.

public __call( $name : string [, $arguments : array = [] ] ) : mixed
Parameters
$name : string
$arguments : array = []
Tags
throws
Return values
mixed

addExtension()

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

pipe()

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

getPageData()

Return the basic data for this page.

public getPageData( ) : array
Return values
array

getStatsMonth()

Gets the name of the month for the statistics.

private getStatsMonth( $previous : int ) : string
Parameters
$previous : int
Return values
string

getStatsWhere()

Gets the where filter for calc of the statistics.

private getStatsWhere( $field : string , $previous : int ) : \FacturaScripts\Core\Base\DataBase\DataBaseWhere[]
Parameters
$field : string
$previous : int
Return values
\FacturaScripts\Core\Base\DataBase\DataBaseWhere[]

loadCreateLinks()

Set the quick links for data creation.

private loadCreateLinks( ) : mixed

Example: createLinks['EditControllerName'] = 'label'

Return values
mixed

loadExtensions()

Establish the sections to be displayed on the dashboard.

private loadExtensions( ) : mixed
Return values
mixed

loadLowStockSection()

Load the data regarding the stock under minimum.

private loadLowStockSection( ) : mixed
Return values
mixed

loadNews()

Load last news from facturascripts.com

private loadNews( ) : mixed
Return values
mixed

loadOpenLinks()

Loads the links to the latest data created by the user.

private loadOpenLinks( ) : mixed
Return values
mixed

loadReceiptSection()

Load the receipts pending collection.

private loadReceiptSection( ) : mixed
Return values
mixed

loadStats()

Load statistical data.

private loadStats( ) : mixed
Return values
mixed

__construct()

Initialize all objects and properties.

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

getTemplate()

Return the template to use for this controller.

public getTemplate( ) : string|bool
Return values
string|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( $url : string , $delay : int ) : mixed
Parameters
$url : string
$delay : int
Return values
mixed

setTemplate()

Set the template to use for this controller.

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

url()

Return the URL of the actual controller.

public url( ) : string
Return values
string

checkPHPversion()

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

getClassName()

Return the name of the controller.

protected getClassName( ) : string
Return values
string

Search results