eZ Publish  [trunk]
Public Member Functions | Static Public Member Functions | Public Attributes
eZContentBrowse Class Reference

Handles browsing of content in the node tree. More...

List of all members.

Public Member Functions

 attribute ($attributeName)
 attributes ()
 eZContentBrowse ($params=array())
 hasAttribute ($attributeName)
 setStartNode ($nodeID)

Static Public Member Functions

static browse ($parameters=array(), &$module)
static nodeAliasID ($nodeName)
static result ($actionName, $asObject=false)

Public Attributes

 $Parameters = false
 The browse parameters.

Detailed Description

Handles browsing of content in the node tree.

This class makes it easy to use the browse system to search for content objects or nodes. The class will take care of storing the necessary session variables and redirect to the browse page.

Using it is simply to call the browse function with some parameters.

eZContentBrowse::browse( array( 'action_name' => 'MyActionName' ), $module );

It requires the module objects as the second parameter to redirect and the first define how the browse page should behave. Normally you just want to set action_name and define the behaviour of that action in settings/browse.ini.

Definition at line 32 of file ezcontentbrowse.php.

Member Function Documentation

eZContentBrowse::attribute ( $  attributeName)
Returns:
the attribute value of the attribute named $attributeName or null if no such attribute.

Definition at line 70 of file ezcontentbrowse.php.

eZContentBrowse::attributes ( )
Returns:
an array with attribute names.

Definition at line 54 of file ezcontentbrowse.php.

static eZContentBrowse::browse ( $  parameters = array(),
&$  module 
) [static]

Sets some session data taken from $parameters and start the browse module by redirecting to it using $module. Most data will be automatically derived from the action_name value taken from settings/browse.ini, other values will override default values.

Definition at line 87 of file ezcontentbrowse.php.

Referenced by browse(), checkNodeActions(), and checkRelationActions().

eZContentBrowse::eZContentBrowse ( $  params = array())

Initializes the object with the session data if they are found. If $params is supplied it used instead.

Definition at line 38 of file ezcontentbrowse.php.

eZContentBrowse::hasAttribute ( $  attributeName)
Returns:
true if the attribute name $attributeName is among the browse parameters.

Definition at line 62 of file ezcontentbrowse.php.

static eZContentBrowse::nodeAliasID ( $  nodeName) [static]
Returns:
the node ID for the node alias $nodeName or false if no ID could be found.

Definition at line 222 of file ezcontentbrowse.php.

Referenced by browse(), eZObjectRelationType\customObjectAttributeHTTPAction(), and eZObjectRelationListType\customObjectAttributeHTTPAction().

static eZContentBrowse::result ( $  actionName,
$  asObject = false 
) [static]
Returns:
the result of the previous browse operation or false if no result was found. It uses the action name $actionName to determine which result to look for.

Definition at line 256 of file ezcontentbrowse.php.

Referenced by checkNodeAssignments(), checkNodeMovements(), checkRelationAssignments(), chooseObjectVersionsToCopy(), chooseOptionsToCopy(), eZObjectRelationType\customClassAttributeHTTPAction(), and eZObjectRelationListType\customClassAttributeHTTPAction().

eZContentBrowse::setStartNode ( $  nodeID)

Sets the node ID where browsing starts.

Definition at line 246 of file ezcontentbrowse.php.

Member Data Documentation

eZContentBrowse::$Parameters = false

The browse parameters.

Definition at line 294 of file ezcontentbrowse.php.

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