Documentation

BaseController
in package

Table of Contents

Properties

$_name_api_token  : mixed
$_name_session_token  : mixed
$_parent  : mixed
$_request  : mixed
$_admin_api_token  : mixed
$_cookie_duration  : mixed

Methods

__construct()  : mixed
_append_to_file()  : none
records a line of text in a log file
_append_to_file_static()  : none
records a line of text in a log file
_default_action()  : array<string|int, mixed>
Returns NOTHING except the URI, exploded.
_delete()  : array<string|int, mixed>
Perform a DELETE In this Class, DO NOTHING.
_html_retrieve_values()  : array<string|int, mixed>
Filters field values ($_REQUEST, ...) by keeping those having as prefix one of the values defined in $prefixes In this Class, DO NOTHING.
_init_html_vars()  : none
Initialize class variables containing HTML strings.
_init_model()  : mixed
_insert()  : array<string|int, mixed>
Perform an INSERT In this Class, DO NOTHING.
_is_a_token()  : bool
Check if the string given by parameter is structured as we look for (32 to 36 characters).
_set_cookie_token()  : none
send a cookie equal to the api_token. Only for TRUSTED applications
_update()  : array<string|int, mixed>
Perform an UPDATE In this Class, DO NOTHING.
admin()  : mixed
deleteAction()  : array<string|int, mixed>
Perform action on DELETE verb.
getAction()  : array<string|int, mixed>
Perform action on GET verb. If 'method' is set, redirects to <method>Action
load()  : array<string|int, mixed>
Loads a DB record.
load_by_key()  : array<string|int, mixed>
Loads a DB record.
patchAction()  : array<string|int, mixed>
Perform action on PATCH verb. Redirects ALWAYS to putAction()
postAction()  : array<string|int, mixed>
Perform action on POST verb. If 'method' is set, redirects to <method>Action
putAction()  : array<string|int, mixed>
Perform action on PUT verb.
sanitize_int_array()  : array<string|int, mixed>
Sanitize an array of numeric values, converted to pure integers
tblist()  : array<string|int, mixed>
Loads a list of records.

Properties

$_name_api_token

public static mixed $_name_api_token = 'X-MagnaRegula-Api-Token'

$_name_session_token

public static mixed $_name_session_token = 'X-MagnaRegula-Session-Token'

$_admin_api_token

protected static mixed $_admin_api_token = '{04F04C15-B0EB-483E-7056-C5B82772DB24}'

$_cookie_duration

protected static mixed $_cookie_duration = 7200

Methods

__construct()

public __construct([mixed $parent = NULL ]) : mixed
Parameters
$parent : mixed = NULL

_append_to_file()

records a line of text in a log file

public _append_to_file(string $text) : none
Parameters
$text : string

The text to log.

Tags
since

Unknown

access

public

Return values
none

_append_to_file_static()

records a line of text in a log file

public static _append_to_file_static(string $text) : none
Parameters
$text : string

The text to log.

Tags
since

Unknown

access

public

Return values
none

_default_action()

Returns NOTHING except the URI, exploded.

public static _default_action(object $request) : array<string|int, mixed>
Parameters
$request : object

The request, built by class 'Request'

Tags
since

Unknown

access

public

Return values
array<string|int, mixed> —

Array of the URI elements

_delete()

Perform a DELETE In this Class, DO NOTHING.

public _delete(mixed $_pk[, array<string|int, mixed> $fields = NULL ]) : array<string|int, mixed>

See MagnaRegulaController.

Parameters
$_pk : mixed
$fields : array<string|int, mixed> = NULL

Fields corresponding to column values

Tags
since

Unknown

access

public

usedby

BaseController::deleteAction()

Return values
array<string|int, mixed> —

An array containing error+rows

_html_retrieve_values()

Filters field values ($_REQUEST, ...) by keeping those having as prefix one of the values defined in $prefixes In this Class, DO NOTHING.

public _html_retrieve_values([array<string|int, mixed> $prefixes = array() ]) : array<string|int, mixed>

See MagnaRegulaController.

Parameters
$prefixes : array<string|int, mixed> = array()

Array of strings to isolate _REQUEST values

Tags
since

Unknown

access

public

Return values
array<string|int, mixed> —

An array of fields to keep

_init_html_vars()

Initialize class variables containing HTML strings.

public _init_html_vars() : none

Very often used on sub-classes

Tags
since

Unknown

access

public

Return values
none

_insert()

Perform an INSERT In this Class, DO NOTHING.

public _insert([string $action = 'insert' ][, array<string|int, mixed> $fields = NULL ]) : array<string|int, mixed>

See MagnaRegulaController.

Parameters
$action : string = 'insert'

The action to perform ('insert' in most cases)

$fields : array<string|int, mixed> = NULL

Fields corresponding to column values

Tags
since

Unknown

access

public

usedby

BaseController::postAction()

Return values
array<string|int, mixed> —

An array containing error+rows

_is_a_token()

Check if the string given by parameter is structured as we look for (32 to 36 characters).

public static _is_a_token(string $token) : bool
Parameters
$token : string

The string to check.

Tags
since

Unknown

access

public

Return values
bool —

YES/NO, it looks like a token

_set_cookie_token()

send a cookie equal to the api_token. Only for TRUSTED applications

public static _set_cookie_token() : none
Tags
since

Unknown

access

public

Return values
none

_update()

Perform an UPDATE In this Class, DO NOTHING.

public _update(mixed $_pk[, string $action = 'update' ][, array<string|int, mixed> $fields = NULL ]) : array<string|int, mixed>

See MagnaRegulaController.

Parameters
$_pk : mixed
$action : string = 'update'

The action to perform ('update' in most cases)

$fields : array<string|int, mixed> = NULL

Fields corresponding to column values

Tags
since

Unknown

access

public

usedby

BaseController::putAction()

usedby

BaseController::patchAction()

Return values
array<string|int, mixed> —

An array containing error+rows

deleteAction()

Perform action on DELETE verb.

public deleteAction(string $request) : array<string|int, mixed>
Parameters
$request : string

"Request" object

Tags
since

Unknown

access

public

see
BaseController::_delete()
Return values
array<string|int, mixed> —

An array with 'error', 'message', 'row' or 'rows', ...

getAction()

Perform action on GET verb. If 'method' is set, redirects to <method>Action

public getAction(string $request) : array<string|int, mixed>
Parameters
$request : string

"Request" object

Tags
since

Unknown

access

public

see
BaseController::load()
see
BaseController::tb_list()
see
BaseController::admin()
see
BaseController::load_by_key()
see
BaseController::$method()
Return values
array<string|int, mixed> —

An array with 'error', 'message', 'row' or 'rows', ...

load()

Loads a DB record.

public load(int $id) : array<string|int, mixed>

In this Class, DO NOTHING. See MagnaRegulaController.

Parameters
$id : int

The primary key of the table.

Tags
since

Unknown

access

public

Return values
array<string|int, mixed> —

An array containing error+row

load_by_key()

Loads a DB record.

public load_by_key(mixed $id) : array<string|int, mixed>

In this Class, DO NOTHING. See MagnaRegulaController.

Parameters
$id : mixed

The primary key of the table. Sometimes, could be a string and not a integer

Tags
since

Unknown

access

public

Return values
array<string|int, mixed> —

An array containing error+row

patchAction()

Perform action on PATCH verb. Redirects ALWAYS to putAction()

public patchAction(string $request) : array<string|int, mixed>
Parameters
$request : string

"Request" object

Tags
since

Unknown

access

public

see
BaseController::putAction()
Return values
array<string|int, mixed> —

An array with 'error', 'message', 'row' or 'rows', ...

postAction()

Perform action on POST verb. If 'method' is set, redirects to <method>Action

public postAction(string $request) : array<string|int, mixed>
Parameters
$request : string

"Request" object

Tags
since

Unknown

access

public

see
BaseController::_insert()
Return values
array<string|int, mixed> —

An array with 'error', 'message', 'row' or 'rows', ...

putAction()

Perform action on PUT verb.

public putAction(string $request) : array<string|int, mixed>
Parameters
$request : string

"Request" object

Tags
since

Unknown

access

public

see
BaseController::_update()
Return values
array<string|int, mixed> —

An array with 'error', 'message', 'row' or 'rows', ...

sanitize_int_array()

Sanitize an array of numeric values, converted to pure integers

public static sanitize_int_array(array<string|int, mixed> $array) : array<string|int, mixed>
Parameters
$array : array<string|int, mixed>

The array (of numeric values) to sanitize.

Tags
since

Unknown

access

public

Return values
array<string|int, mixed> —

The same array, but only with integer values; non-convertible values are dropped

tblist()

Loads a list of records.

public tblist() : array<string|int, mixed>

In this Class, DO NOTHING. See MagnaRegulaController.

Tags
since

Unknown

access

public

Return values
array<string|int, mixed> —

An array containing error+rows


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results