FacturaScripts

Wizard extends Controller

Description of Wizard

Table of Contents

ITEM_SELECT_LIMIT 500
NEW_DEFAULT_PAGE 'ListFacturaCliente'
$appSettings AppSettings
$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
getPageData() Returns basic page attributes array
getRegimenIva() array
getSelectValues() Returns an array with all data from selected model. array
privateCore() Runs the controller's private logic. mixed
addDefaultRoleAccess() Add/update the default role for agents, and adds to this role access to all default pages. void
addPagesToRole() Adds to received codrole, all pages that are not in admin menu and are not yet enabled. void
finalRedirect() mixed
initModels() Initialize required models. mixed
loadDefaultAccountingPlan() Loads the default accounting plan. If there is one. void
preSetAppSettings() Set default AppSettings based on codpais mixed
saveAddress() Save company default address. mixed
saveEmail() bool
saveNewPassword() Save the new password if data is admin admin bool
saveStep1() mixed
saveStep2() mixed
saveStep3() mixed
setWarehouse() void
__construct() Initialize all objects and properties. mixed
addExtension() mixed
getPageData() Return the basic data for this page. array
getTemplate() Return the template to use for this controller. string|bool
pipe() mixed
privateCore() Runs the controller's private logic. mixed
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

Constants

ITEM_SELECT_LIMIT

mixed $ITEM_SELECT_LIMIT = 500

NEW_DEFAULT_PAGE

mixed $NEW_DEFAULT_PAGE = 'ListFacturaCliente'

Properties

$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

getPageData()

Returns basic page attributes

public getPageData( ) : array
Return values
array

getRegimenIva()

public getRegimenIva( ) : array
Return values
array

getSelectValues()

Returns an array with all data from selected model.

public getSelectValues( $modelName : string [, $addEmpty : bool = false ] ) : array
Parameters
$modelName : string
$addEmpty : bool = false
Return values
array

addDefaultRoleAccess()

Add/update the default role for agents, and adds to this role access to all default pages.

private addDefaultRoleAccess( ) : void

addPagesToRole()

Adds to received codrole, all pages that are not in admin menu and are not yet enabled.

private addPagesToRole( $codrole : string ) : void
Parameters
$codrole : string

finalRedirect()

protected finalRedirect( ) : mixed
Return values
mixed

initModels()

Initialize required models.

private initModels( $names : array ) : mixed
Parameters
$names : array
Return values
mixed

loadDefaultAccountingPlan()

Loads the default accounting plan. If there is one.

private loadDefaultAccountingPlan( $codpais : string ) : void
Parameters
$codpais : string

preSetAppSettings()

Set default AppSettings based on codpais

private preSetAppSettings( $codpais : string ) : mixed
Parameters
$codpais : string
Return values
mixed

saveAddress()

Save company default address.

private saveAddress( $codpais : string ) : mixed
Parameters
$codpais : string
Return values
mixed

saveEmail()

private saveEmail( $email : string ) : bool
Parameters
$email : string
Return values
bool

saveNewPassword()

Save the new password if data is admin admin

private saveNewPassword( $pass : string ) : bool
Parameters
$pass : string
Return values
bool

Returns true if success, otherwise return false.

saveStep1()

private saveStep1( ) : mixed
Return values
mixed

saveStep2()

private saveStep2( ) : mixed
Return values
mixed

saveStep3()

protected saveStep3( ) : mixed
Return values
mixed

setWarehouse()

private setWarehouse( $almacen : Almacen , $codpais : string ) : void
Parameters
$almacen : Almacen
$codpais : string

__construct()

Initialize all objects and properties.

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

addExtension()

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

getPageData()

Return the basic data for this page.

public getPageData( ) : array
Return values
array

getTemplate()

Return the template to use for this controller.

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

pipe()

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

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