Documentation

ApiResponse extends EntityBase
in package

cloudrexx

core

modules

dataaccess

implements JsonSerializable

Response for a request to API

Interfaces

JsonSerializable

Constants

MESSAGE_TYPE_ERROR = 'error'
MESSAGE_TYPE_INFO = 'info'
MESSAGE_TYPE_SUCCESS = 'success'
STATUS_ERROR = 'error'
STATUS_OK = 'ok'

Properties

$data : array<string|int, mixed>
$localeCodes : array<string|int, mixed>: List of locale codes ordered by translation fallback order per Cx instance
$messages : two
$metaData : array<string|int, mixed>
$nestingCount : int: Counts the nesting level of __call()
$request : Request
$status : string
$statusCode : int
$stringRepresentationBlank : bool: Whether blank string representations are valid
$stringRepresentationFields : array<string|int, mixed>: List of fields that should be available in the string representation
$stringRepresentationFormat : string: Sprintf format for the string representation
$validators : array<string|int, mixed>: Initialize this array as follows: array( 'columName' => Zend_Validate )
$virtual : bool: Defines if an entity is virtual and therefore not persistable.

Methods

__call() : mixed: Route methods like getName(), getType(), getDirectory(), etc.
__construct() : mixed: Creates an ApiResponse
__get() : mixed: This is an ugly solution to allow $this->cx to be available in all entity classes Since the entity's constructor is not called when an entity is loaded from DB this cannot be assigned there.
__toString() : string: Returns this entity's identifying value
addMessage() : mixed: Adds a message
getComponentController() : SystemComponent: Returns the component controller for this component
getData() : array<string|int, mixed>: Returns data of this response
getKeyAsString() : string: Returns this entity's key
getMessages() : array<string|int, mixed>: Returns a list of messages for this request
getMetadata() : array<string|int, mixed>: Get the array with the metadata
getStatus() : string: Returns the status for this response
getStatusCode() : int: Returns the HTTP status code for this response
getTranslatedFieldValue() : mixed: Returns the value of a translatable field using fallback mechanisms
initializeValidators() : mixed: Set $this->validators
isVirtual() : bool: Returns the virtuality of the entity
jsonSerialize() : array<string|int, mixed>: Serializes this object for JSON, we use it for all output modules This is used in order to avoid public member variables
removeMessage() : bool: Removes a message
send() : mixed: Sets HTTP status code and writes this object to output buffer
setData() : mixed: Sets response data
setMetadata() : mixed: Set a array with metadata for the API
setStatus() : mixed: Sets response status
setStatusCode() : mixed: Sets the HTTP status code
setVirtual() : mixed: Set the virtuality of the entity
validate() : mixed
getFallbackLocaleCodes() : array<string|int, mixed>: Returns a list of all locale codes ordered by fallback order
getStringRepresentationBlank() : bool: Whether blank string representations are valid
getStringRepresentationFields() : array<string|int, mixed>: Returns a list of fields available in the string representation
getStringRepresentationFormat() : string: Returns the sprintf() format for the string representation

MESSAGE_TYPE_ERROR


    public
        string
    MESSAGE_TYPE_ERROR
    = 'error'

Message type error

MESSAGE_TYPE_INFO


    public
        string
    MESSAGE_TYPE_INFO
    = 'info'

Message type info

MESSAGE_TYPE_SUCCESS


    public
        string
    MESSAGE_TYPE_SUCCESS
    = 'success'

Message type success

STATUS_ERROR


    public
        string
    STATUS_ERROR
    = 'error'

Error status

STATUS_OK


    public
        string
    STATUS_OK
    = 'ok'

Success status

$data


        protected
            array<string|int, mixed>
    $data
     = array()

of data

$localeCodes

List of locale codes ordered by translation fallback order per Cx instance


        protected
        static    array<string|int, mixed>
    $localeCodes
     = array()

Array in the form: array(<instanceId> => array(<localeCode>, ...))

$messages


        protected
            two
    $messages
     = array()

dimensional array: $messages[][] = <messageText>

$metaData


        protected
            array<string|int, mixed>
    $metaData
     = array()

Additional MetaData to add to API

$nestingCount

Counts the nesting level of __call()


        protected
        static    int
    $nestingCount
     = 0

$request


        protected
            Request
    $request

Request object

$status


        protected
            string
    $status

one of STATUS_ERROR, STATUS_OK

$statusCode


        protected
            int
    $statusCode
     = 0

HTTP status code

$stringRepresentationBlank

Whether blank string representations are valid


        protected
            bool
    $stringRepresentationBlank
     = false

Whether blank string representations are valid

$stringRepresentationFields

List of fields that should be available in the string representation


        protected
            array<string|int, mixed>
    $stringRepresentationFields
     = array()

List of field names

$stringRepresentationFormat

Sprintf format for the string representation


        protected
            string
    $stringRepresentationFormat
     = ''

Sprintf format string

$validators

Initialize this array as follows: array( 'columName' => Zend_Validate )


        protected
            array<string|int, mixed>
    $validators
     = array()

$virtual

Defines if an entity is virtual and therefore not persistable.


        protected
            bool
    $virtual
     = false

Defaults to FALSE - not virtual.

__call()

Route methods like getName(), getType(), getDirectory(), etc.


    public
                    __call(string $methodName, array<string|int, mixed> $arguments) : mixed

Parameters

$methodName : string: Name of method to call
$arguments : array<string|int, mixed>: List of arguments for the method to call

Return values

mixed —

Return value of the method to call

__construct()

Creates an ApiResponse


    public
                    __construct([string $status = '' ][, array<string|int, mixed> $messages = array() ][, array<string|int, mixed> $data = array() ][, mixed $metaData = array() ]) : mixed

Please note, that you need to set the status before you can send this request!

Parameters

$status : string = '': (optional) One of STATUS_ERROR, STATUS_OK
$messages : array<string|int, mixed> = array(): (optional) two dimensional array: $messages[][] = <messageText>
$data : array<string|int, mixed> = array(): (optional) Set of data
$metaData : mixed = array()

__get()

This is an ugly solution to allow $this->cx to be available in all entity classes Since the entity's constructor is not called when an entity is loaded from DB this cannot be assigned there.


    public
                    __get(mixed $name) : mixed

Parameters

$name : mixed

#[ReturnTypeWillChange]

__toString()

Returns this entity's identifying value


    public
                    __toString() : string

By default this returns the same as getKeyAsString(), but this method might get overridden by subclasses.

Return values

string —

Identifying value for this entity

addMessage()

Adds a message


    public
                    addMessage(string $type, string $text) : mixed

Parameters

$type : string: Message type, one of MESSAGE_TYPE_*
$text : string: Message

getComponentController()

Returns the component controller for this component


    public
                    getComponentController() : SystemComponent

Return values

SystemComponent

getData()

Returns data of this response


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

Return values

array<string|int, mixed> —

Set of data

getKeyAsString()

Returns this entity's key


    public
        final            getKeyAsString([string $separator = '/' ]) : string

If this entity has a composite key, the fields are separated by $separator.

Parameters

$separator : string = '/': (optional) Separator for composite key fields, default "/"

Return values

string —

Entity key as string

getMessages()

Returns a list of messages for this request


    public
                    getMessages([string $type = '' ]) : array<string|int, mixed>

Parameters

$type : string = '': (optional) Limits the result to a type of messages

Return values

array<string|int, mixed> —

List of messages (of any type, except if $type is provided)

getMetadata()

Get the array with the metadata


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

Return values

array<string|int, mixed> —

Data passed as metadata

getStatus()

Returns the status for this response


    public
                    getStatus() : string

Return values

string —

One of STATUS_ERROR, STATUS_OK

getStatusCode()

Returns the HTTP status code for this response


    public
                    getStatusCode() : int

Return values

int —

Status code (as specified in https://tools.ietf.org/html/rfc7231#section-6)

getTranslatedFieldValue()

Returns the value of a translatable field using fallback mechanisms


    public
                    getTranslatedFieldValue(string $fieldName) : mixed

If the field is not translatable its value is returned anyway. Tries to return the value in the following locales (if non-empty):

Current locale
Default locale
All other locales

Parameters

$fieldName : string: Name of a translatable field

initializeValidators()

Set $this->validators


    public
                    initializeValidators() : mixed

Validators can be found in lib/FRAMEWORK/Validator.class.php These will be executed if validate() is called

isVirtual()

Returns the virtuality of the entity


    public
                    isVirtual() : bool

Return values

bool —

TRUE if the entity is virtual, otherwise FALSE

jsonSerialize()

Serializes this object for JSON, we use it for all output modules This is used in order to avoid public member variables


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

Return values

array<string|int, mixed> —

Array representation of this object

removeMessage()

Removes a message


    public
                    removeMessage(string $type, string $text) : bool

Parameters

$type : string: Message type, one of MESSAGE_TYPE_*
$text : string: Message

Return values

bool —

True if successful, false if message could not be found

send()

Sets HTTP status code and writes this object to output buffer


    public
                    send(OutputController $outputModule[, bool $setStatusCode = true ]) : mixed

Parameters

$outputModule : OutputController: Output module to use for parsing
$setStatusCode : bool = true: (optional) Wheter to set HTTP status header (default: true)

setData()

Sets response data


    public
                    setData(array<string|int, mixed> $data) : mixed

Parameters

$data : array<string|int, mixed>: Data for this response

setMetadata()

Set a array with metadata for the API


    public
                    setMetadata(array<string|int, mixed> $metaData) : mixed

Parameters

$metaData : array<string|int, mixed>: Data to pass in metadata field

setStatus()

Sets response status


    public
                    setStatus(string $status) : mixed

If statusCode is not set yet, it sets it to 200 for OK, 400 for ERROR

Parameters

$status : string: One of STATUS_ERROR, STATUS_OK

setStatusCode()

Sets the HTTP status code


    public
                    setStatusCode(mixed $statusCode[, mixed $replace = false ]) : mixed

Parameters

$statusCode : mixed
$replace : mixed = false

setVirtual()

Set the virtuality of the entity


    public
                    setVirtual(bool $virtual) : mixed

Parameters

$virtual : bool: TRUE to set the entity as virtual or otherwise to FALSE

validate()


    public
                    validate() : mixed

getFallbackLocaleCodes()

Returns a list of all locale codes ordered by fallback order


    protected
                    getFallbackLocaleCodes() : array<string|int, mixed>

First entry is the current locale
Second entry is the default locale (if different from current, it's omitted otherwise)
Then all other locales follow (in no particular order)

Return values

array<string|int, mixed> —

List of locale codes

getStringRepresentationBlank()

Whether blank string representations are valid


    protected
                    getStringRepresentationBlank() : bool

Return values

bool —

Whether blank string representations are valid

getStringRepresentationFields()

Returns a list of fields available in the string representation


    protected
                    getStringRepresentationFields() : array<string|int, mixed>

Return values

array<string|int, mixed> —

List of field names

getStringRepresentationFormat()

Returns the sprintf() format for the string representation


    protected
                    getStringRepresentationFormat() : string

Return values

string —

sprintf() format string

ApiResponse extends EntityBase in package cloudrexx core modules dataaccess implements JsonSerializable

Tags

Table of Contents

Interfaces

Constants

Properties

Methods

Constants

MESSAGE_TYPE_ERROR

MESSAGE_TYPE_INFO

MESSAGE_TYPE_SUCCESS

STATUS_ERROR

STATUS_OK

Properties

$data

$localeCodes

Tags

$messages

$metaData

$nestingCount

$request

$status

$statusCode

$stringRepresentationBlank

Tags

$stringRepresentationFields

Tags

$stringRepresentationFormat

Tags

$validators

$virtual

Methods

__call()

Parameters

Tags

Attributes

Return values

__construct()

Parameters

__get()

Parameters

Attributes

__toString()

Return values

addMessage()

Parameters

getComponentController()

Return values

getData()

Return values

getKeyAsString()

Parameters

Return values

getMessages()

Parameters

Return values

getMetadata()

Return values

getStatus()

Return values

getStatusCode()

Return values

getTranslatedFieldValue()

Parameters

initializeValidators()

isVirtual()

Return values

jsonSerialize()

Return values

removeMessage()

Parameters

Return values

send()

Parameters

setData()

Parameters

setMetadata()

Parameters

setStatus()

Parameters

ApiResponse extends EntityBase
in package

cloudrexx

core

modules

dataaccess

implements JsonSerializable