eZPublishCommunityProject(LegacyStack)  2013.5
ezpKernelResult Class Reference

File containing the ezpKernelResult class. More...

Public Member Functions

 __construct ($content=null, array $defaultAttributes=array())
 
 getAttribute ($name, $defaultValue=null)
 
 getAttributes ()
 Returns all the attributes. More...
 
 getContent ()
 Returns the result's main content. More...
 
 hasAttribute ($name)
 Checks if $name attribute is present. More...
 
 replaceAttributes (array $attributes)
 Replaces internal attributes entirely. More...
 
 setAttribute ($name, $value)
 Sets an attribute. More...
 
 setAttributes (array $attributes)
 Sets multiple attributes at once. More...
 
 setContent ($content)
 Sets the main content. More...
 

Private Attributes

 $attributes
 
 $content
 

Detailed Description

File containing the ezpKernelResult class.

Version
2013.5 Struct containing the kernel result.

Constructor & Destructor Documentation

ezpKernelResult::__construct (   $content = null,
array  $defaultAttributes = array() 
)
Parameters
string$contentThe result's main content
array$defaultAttributes

Member Function Documentation

ezpKernelResult::getAttribute (   $name,
  $defaultValue = null 
)
Parameters
string$name
mixed$defaultValueDefault value to return if the attribute doesn't exist.
Returns
mixed
ezpKernelResult::getAttributes ( )

Returns all the attributes.

Returns
array
ezpKernelResult::getContent ( )

Returns the result's main content.

Returns
string
ezpKernelResult::hasAttribute (   $name)

Checks if $name attribute is present.

Parameters
string$name
Returns
bool
ezpKernelResult::replaceAttributes ( array  $attributes)

Replaces internal attributes entirely.

Parameters
array$attributes
ezpKernelResult::setAttribute (   $name,
  $value 
)

Sets an attribute.

Parameters
string$name
mixed$value
ezpKernelResult::setAttributes ( array  $attributes)

Sets multiple attributes at once.

Internal ones that are not inside $attributes won't be overridden.

Parameters
array$attributes
ezpKernelResult::setContent (   $content)

Sets the main content.

Parameters
string$content

Member Data Documentation

ezpKernelResult::$attributes
private
ezpKernelResult::$content
private

Referenced by __construct(), getContent(), and setContent().


The documentation for this class was generated from the following file: