eZ Publish  [4.2]
eZWorkflowGroup Class Reference

Handles grouping of workflows. More...

+ Inheritance diagram for eZWorkflowGroup:
+ Collaboration diagram for eZWorkflowGroup:

List of all members.

Public Member Functions

 creator ()
 eZWorkflowGroup ($row)
 modifier ()

Static Public Member Functions

static create ($user_id)
static definition ()
static fetch ($id, $asObject=true)
static fetchList ($asObject=true)
static removeSelected ($id)

Public Attributes

 $Created
 $CreatorID
 $ID
 $Modified
 $ModifierID
 $Name

Detailed Description

Handles grouping of workflows.

Definition at line 37 of file ezworkflowgroup.php.


Member Function Documentation

static eZWorkflowGroup::create ( user_id) [static]

Definition at line 86 of file ezworkflowgroup.php.

eZWorkflowGroup::creator ( )

Definition at line 124 of file ezworkflowgroup.php.

static eZWorkflowGroup::definition ( ) [static]
Returns:
the definition for the object, the default implementation is to return an empty array. It's upto each inheriting class to return a proper definition array.

The definition array is an associative array consists of these keys:

  • fields - an associative array of fields which defines which database field (the key) is to fetched and how they map to object member variables (the value).
  • keys - an array of fields which is used for uniquely identifying the object in the table.
  • function_attributes - an associative array of attributes which maps to member functions, used for fetching data with functions.
  • set_functions - an associative array of attributes which maps to member functions, used for setting data with functions.
  • increment_key - the field which is incremented on table inserts.
  • class_name - the classname which is used for instantiating new objecs when fetching from the database.
  • sort - an associative array which defines the default sorting of lists, the key is the table field while the value is the sorting method which is either asc or desc.
  • name - the name of the database table

Example:

static function definition()
{
    return array( "fields" => array( "id" => "ID",
                                     "version" => "Version",
                                     "name" => "Name" ),
                  "keys" => array( "id", "version" ),
                  "function_attributes" => array( "current" => "currentVersion",
                                                  "class_name" => "className" ),
                  "increment_key" => "id",
                  "class_name" => "eZContentClass",
                  "sort" => array( "id" => "asc" ),
                  "name" => "ezcontentclass" );
}

Reimplemented from eZPersistentObject.

Definition at line 44 of file ezworkflowgroup.php.

Referenced by fetch(), fetchList(), and removeSelected().

eZWorkflowGroup::eZWorkflowGroup ( row)

Definition at line 39 of file ezworkflowgroup.php.

Referenced by create().

static eZWorkflowGroup::fetch ( id,
asObject = true 
) [static]

Definition at line 99 of file ezworkflowgroup.php.

Referenced by creator(), and modifier().

static eZWorkflowGroup::fetchList ( asObject = true) [static]

Definition at line 107 of file ezworkflowgroup.php.

eZWorkflowGroup::modifier ( )

Definition at line 133 of file ezworkflowgroup.php.

static eZWorkflowGroup::removeSelected ( id) [static]
Note:
Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Definition at line 118 of file ezworkflowgroup.php.


Member Data Documentation

eZWorkflowGroup::$Created

Definition at line 147 of file ezworkflowgroup.php.

eZWorkflowGroup::$CreatorID

Definition at line 145 of file ezworkflowgroup.php.

eZWorkflowGroup::$ID

Definition at line 143 of file ezworkflowgroup.php.

eZWorkflowGroup::$Modified

Definition at line 148 of file ezworkflowgroup.php.

eZWorkflowGroup::$ModifierID

Definition at line 146 of file ezworkflowgroup.php.

eZWorkflowGroup::$Name

Definition at line 144 of file ezworkflowgroup.php.


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