Documentation

CRequest

in package

• dressapi
• core
• request

implements IHttpStatus

It handles all input requests and provides facilities for their use.

Table of Contents

Interfaces

IHttpStatus

Interface defining HTTP status code constants.

Properties

$action  : string

$attributes  : array<int, string>

$cache  : ICache|null

$charset  : string

$connection_manager  : IConnectionManager|null

$data_for_edit  : bool

$filters  : array<string|int, array<string|int, mixed>>

$format  : string

$full_info  : bool

$http_authorization  : string

$http_method  : string

$is_api_request  : bool

$items_per_page  : int

$logger  : ILogger|null

$module_info  : array<string|int, mixed>

$module_name  : string

$order_by  : array<string|int, mixed>

$origin_path_request  : string

$page  : int

$params  : array<string|int, mixed>

$path_request  : string

$permission  : string

$redirect_url  : string

$routes  : CRoutes

$section_name  : string

$table_name  : string

$upload_path  : string

$view  : string

$with_header_and_footer  : bool

Methods

__construct()  : mixed

Constructor for CRequest.

CreateInstance()  : CRequest

Factory method to create a new CRequest instance.

GetAction()  : string

Get the HTML Frame required (only for HTML response)

GetAttribute()  : string|array<string|int, mixed>|null

Get a single attribute

GetAttributes()  : array<string|int, mixed>

Get the attributes

GetCharset()  : string

Get the Charset

GetConnectionManager()  : IConnectionManager|null

GetConnectionManager( )

GetCurrentPage()  : int

Get the current page requested

GetDataForEdit()  : string

Get full info (without a resolved indexes if is true)

GetFilter()  : array<string|int, string>|null

Get a single filter

GetFilters()  : array<string|int, array<string|int, mixed>>

Get the filters

GetFormat()  : string

Get the format

GetFullInfo()  : string

Get full info (get a resolved indexes on a GET)

GetHttpAuthorization()  : string

Get the token

GetHttpMethod()  : string

Get the method (POST, GET, PATCH, DELETE, ...)

GetItemsPerPage()  : int

Get the maximum of elements per page

GetModuleInfo()  : array<string|int, mixed>

Get the module name

GetModuleName()  : string

Get the module name

GetOrderBy()  : array<string|int, mixed>

Get the order of output data

GetOriginPathRequest()  : string

Get the type of original request

GetPalette()  : string

Get the requested component palette name.

GetParameter()  : string|array<string|int, mixed>|null

Get a single parameter

GetParameters()  : array<string|int, mixed>

Get the parameters

GetPathRequest()  : string

Get the type of final Request

GetPermission()  : string

Get the current action

GetRedirectUrl()  : string

Get the Redirect uri at the end of all

GetRoutes()  : the

Return the CRoutes object

GetSectionName()  : string

Get the section name (if exists else is a empty string) The section is the first name with starts any urls (/s/section/module/....)

GetTableName()  : string

Get the module name

GetUploadFolder()  : string

Return the current Upload folder (private or public)

GetView()  : string

Get the view variation (normally is not necessary because is included in GetAction()) but it can use i.e. for download a document in a different format

GetWithHeaderAndFooter()  : bool

Returns true if the header and footer must be present in the view

GoRedirect()  : void

If there has been a redirect request via redirect it executes it when called

InputFile()  : void

Import one or more files to upload

IsApiRequest()  : bool

Get true if is an API Request

RemoveUploadedFile()  : void

Remove newly uploaded files in case of any other errors

SetAction()  : void

Set the HTML Frame required (only for HTML response) The central HTML frame can be changed here

SetRedirectUrl()  : void

Set the Redirect uri at the end of all

SetSectionName()  : void

Set the section_name (if exists else is a empty string)

SetUploadFolder()  : void

Set the upload folder to private (private-files) or public area (public-files)

SetView()  : void

Set the view variation

SetWithHeaderAndFooter()  : bool

Set if the header and footer must be present in the view

SetFilters()  : void

Determine which filters were requested

SetFormat()  : void

Set format type of output

SetHttpAuthorization()  : void

Look for the token sent in the request or from the session if one exists

SetHttpMethod()  : void

Determine which HTTP method was requested

SetParameters()  : void

Determine which parameters were requested

SetModuleName()  : void

Set the module name and if not declared set the ITEM_ID value when the id of each table contains the name of table like: id_[table], [table]_id, [table]ID