eZ Publish  [4.2]
eZViewCounter Class Reference

! eZKernel The class eZViewCounter More...

+ Inheritance diagram for eZViewCounter:
+ Collaboration diagram for eZViewCounter:

List of all members.

Public Member Functions

 eZViewCounter ($row)
 increase ()

Static Public Member Functions

static clear ($node_id)
static create ($node_id)
static definition ()
static fetch ($node_id, $asObject=true)
static fetchTopList ($classID=false, $sectionID=false, $offset=false, $limit=false)
static removeCounter ($node_id)

Public Attributes

 $Count
 $NodeID

Detailed Description

! eZKernel The class eZViewCounter

Definition at line 36 of file ezviewcounter.php.


Member Function Documentation

static eZViewCounter::clear ( node_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 85 of file ezviewcounter.php.

static eZViewCounter::create ( node_id) [static]

Definition at line 64 of file ezviewcounter.php.

static eZViewCounter::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 43 of file ezviewcounter.php.

Referenced by fetch(), fetchTopList(), and removeCounter().

eZViewCounter::eZViewCounter ( row)

Definition at line 38 of file ezviewcounter.php.

Referenced by create().

static eZViewCounter::fetch ( node_id,
asObject = true 
) [static]

Definition at line 107 of file ezviewcounter.php.

Referenced by clear().

static eZViewCounter::fetchTopList ( classID = false,
sectionID = false,
offset = false,
limit = false 
) [static]

Definition at line 115 of file ezviewcounter.php.

eZViewCounter::increase ( )
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 99 of file ezviewcounter.php.

static eZViewCounter::removeCounter ( node_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 75 of file ezviewcounter.php.

Referenced by eZContentObjectTreeNode\removeThis().


Member Data Documentation

eZViewCounter::$Count

Definition at line 167 of file ezviewcounter.php.

eZViewCounter::$NodeID

Definition at line 166 of file ezviewcounter.php.


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