Docs For Class response

Description

Class response , used to defined the response of the class request and cmd.

author: Paul Langeard <paul@steek.com> http://www.steek.com

Located in /caht.php (line 206)

Method Summary

response __construct ( $command)

void addError (array[string]mixed $error)

void addMeta ( $meta, array[string]mixed $error)

void addRead ( $read, array[string]mixed $error)

string asString ()

array fromString (string $string)

string getCommand ()

boolen hasError ()

array nextError ()

array nextMeta ()

array nextRead ()

void setError (intger $code, string $method)

Methods

Constructor __construct (line 244)

access: public

response __construct ( $command)

$command

addError (line 278)

Add an error to the response

<?php
$response->addError( array( 'CODE' => 33 , 'LABEL' => 'ACCESS_DENIED' );
?>

access: public

void addError (array[string]mixed $error)

array[string]mixed $error

addMeta (line 346)

Add a meta line to the response

<?php
$response->addMeta( array( 'nb' => 12 , 'total' => 134 );
?>

access: public

void addMeta ( $meta, array[string]mixed $error)

array[string]mixed $error
$meta

addRead (line 313)

Add a read line to the response

<?php
$response->addRead( array( 'Name' => 'Paul' , 'Alias' => 'Cheal' );
?>

access: public

void addRead ( $read, array[string]mixed $error)

array[string]mixed $error
$read

asString (line 499)

return the data of this object as string.

access: public

string asString ()

fromString (line 399)

Construct this object from a string = raw response of a command.

access: public

array fromString (string $string)

string $string

getCommand (line 262)

return the name o the command

access: public

string getCommand ()

hasError (line 253)

return true if the response ha error else false

access: public

boolen hasError ()

nextError (line 291)

return the next line of error

access: public

array nextError ()

nextMeta (line 356)

return the next line of meta

access: public

array nextMeta ()

nextRead (line 323)

return the next line of read

access: public

array nextRead ()

setError (line 374)

set an error with the error code

access: public

void setError (intger $code, string $method)

intger $code
string $method