Class Forward

Description

Class Forward is an extended status object.

A Forward object is created by the Dispatcher to track the application success and to transfer information between application components (Services, Filters and Views)

A Forward object has four major properties:

  • success: contains a boolean success status of the whole request
  • meta: contains meta information for application runtime
  • variables: contains a ValueObject for the preparation of Views
  • output: contains a plain output string
All Methods in Forward are accessors or manipulators to one of these four major properties.

Located in /forward.php (line 25)

PHOOL
   |
   --Forward
Class Constant Summary
 RETARR = 2
 RETOBJ = 1
Variable Summary
Method Summary
Forward Forward ([boolean $success = true], [string $service = false])
void addMeta (string $key, mixed $value)
void addValue (string $key, mixed $value)
void appendContent (string $content)
void getMeta (string $key)
void getValue (string $key)
ValueObject|Array &meta ([ $type = self::RETOBJ])
string output ()
string renderer ()
string service ()
void setContent (string $content)
void setMany (array $values)
void setRenderer (string $renderer)
void setService (string $service)
void setStatus (boolean $code)
void setSuccess (boolean $success)
void setTemplate (string $tplfile)
void setView (string $viewname)
int status ()
boolean success ()
string template ()
ValueObject|Array &variables ([ $type = self::RETOBJ])
string view ()
Variables
ValueObject $meta (line 49)

private Meta information container

  • access: private
string $output (line 43)

Fixed output string (if any)

  • access: private
boolean $success = true (line 37)

Primary success indicator of the request

  • access: private
ValueObject $variables (line 55)

Variable Container for View (if any)

  • access: private

Inherited Variables

Inherited from PHOOL

PHOOL::$debug
PHOOL::$errorlabels
PHOOL::$errorlevels
PHOOL::$errors
PHOOL::$exists
PHOOL::$logdir
PHOOL::$loglevel
PHOOL::$objname
Methods
Constructor Forward (line 63)

Construct a Forward object

Forward Forward ([boolean $success = true], [string $service = false])
  • boolean $success: success of action
  • string $service: service name
addMeta (line 95)

Add a meta to the internal meta container

void addMeta (string $key, mixed $value)
  • string $key: key to register in ValueObject
  • mixed $value: value to register in ValueObject
addValue (line 79)

Add a value to the internal variable container

void addValue (string $key, mixed $value)
  • string $key: key to register in ValueObject
  • mixed $value: value to register in ValueObject
appendContent (line 179)

Append plaintext content to render

void appendContent (string $content)
  • string $content: content to append
getMeta (line 217)

Get a value from the internal meta container

void getMeta (string $key)
  • string $key: key to get from ValueObject
getValue (line 189)

Get a value from the internal variable container

void getValue (string $key)
  • string $key: key to get from ValueObject
meta (line 258)

Return the complete meta container

  • return: meta container representation
ValueObject|Array &meta ([ $type = self::RETOBJ])
  • $type
output (line 279)

Return the current output string

string output ()
renderer (line 329)

Return the current soa-renderer name

string renderer ()
service (line 302)

Return the main service name

string service ()
setContent (line 169)

Set a specific plaintext content to render

void setContent (string $content)
  • string $content: output string
setMany (line 202)

Add a collection of Values

void setMany (array $values)
  • array $values
setRenderer (line 159)

Override SOAView renderer

void setRenderer (string $renderer)
  • string $renderer: type of soa-rendering method
setService (line 129)

Update Service name property

void setService (string $service)
  • string $service: name of service
setStatus (line 119)

Override HTTP Status of the request

void setStatus (boolean $code)
  • boolean $code: success
setSuccess (line 109)

Override Success state of the request

void setSuccess (boolean $success)
  • boolean $success: success
setTemplate (line 149)

Override View to render

void setTemplate (string $tplfile)
  • string $tplfile: name of view
setView (line 139)

Override View to render

void setView (string $viewname)
  • string $viewname: name of view
status (line 289)

Return the current http response code

int status ()
success (line 227)

Return state of request

boolean success ()
template (line 343)

Return a template name

string template ()
variables (line 237)

Return the variables container

  • return: variables container representation
ValueObject|Array &variables ([ $type = self::RETOBJ])
  • $type
view (line 315)

Return the current view name

string view ()

Inherited Methods

Inherited From PHOOL

PHOOL::PHOOL()
PHOOL::debug()
PHOOL::error()
PHOOL::get_errors()
PHOOL::handle_error()
PHOOL::has_error()
PHOOL::log_error()
PHOOL::set_debug()
PHOOL::set_logdir()
PHOOL::set_loglevel()
Class Constants
RETARR = 2 (line 31)
RETOBJ = 1 (line 30)

Return value constants

Inherited Constants

Inherited from PHOOL

PHOOL::ERROR
PHOOL::UNKNOWN
PHOOL::USER
PHOOL::WARNING

Documentation generated on Tue, 12 May 2009 23:09:38 +0200 by phpDocumentor 1.4.1