eZTipafriendCounter Class Reference

Inheritance diagram for eZTipafriendCounter:
eZPersistentObject

List of all members.

Public Member Functions

 clear ($node_id)
 create ($node_id)
 definition ()
 eZTipafriendCounter ($row)
 fetch ($node_id, $asObject=true)
 increase ()
 removeForNode ($node_id)

Static Public Member Functions

 cleanup ()

Private Attributes

 $Count
 $NodeID

Detailed Description

! eZKernel The class eZTipafriendCounter

Definition at line 40 of file eztipafriendcounter.php.


Member Function Documentation

eZTipafriendCounter::cleanup (  )  [static]

Removes all counters for tipafriend functionality.

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 121 of file eztipafriendcounter.php.

eZTipafriendCounter::clear ( node_id  ) 
Deprecated:
Use removeForNode instead
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 93 of file eztipafriendcounter.php.

eZTipafriendCounter::create ( node_id  ) 

Definition at line 69 of file eztipafriendcounter.php.

eZTipafriendCounter::definition (  ) 
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:

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 47 of file eztipafriendcounter.php.

Referenced by fetch(), and removeForNode().

eZTipafriendCounter::eZTipafriendCounter ( row  ) 

Definition at line 42 of file eztipafriendcounter.php.

Referenced by create().

eZTipafriendCounter::fetch ( node_id,
asObject = true 
)

Definition at line 107 of file eztipafriendcounter.php.

eZTipafriendCounter::increase (  ) 
Deprecated:
, will be removed in future versions of eZP
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 103 of file eztipafriendcounter.php.

eZTipafriendCounter::removeForNode ( node_id  ) 
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 81 of file eztipafriendcounter.php.

Referenced by clear(), and eZContentObjectTreeNode::remove().


Member Data Documentation

eZTipafriendCounter::$Count [private]

Definition at line 129 of file eztipafriendcounter.php.

eZTipafriendCounter::$NodeID [private]

Definition at line 128 of file eztipafriendcounter.php.


The documentation for this class was generated from the following file:
Generated on Mon Jul 12 07:10:32 2010 for eZ publish by  doxygen 1.6.3