eZPublishCommunityProject(LegacyStack)  2013.9
eZGeneralDigestUserSettings Class Reference

The class eZGeneralDigestUserSettings does. More...

+ Inheritance diagram for eZGeneralDigestUserSettings:
+ Collaboration diagram for eZGeneralDigestUserSettings:

Public Member Functions

 eZGeneralDigestUserSettings ($row)
 
- Public Member Functions inherited from eZPersistentObject
 attribute ($attr, $noFunction=false)
 Returns the attribute data for $attr, this is either returned from the member variables or a member function depending on whether the definition field or function attributes matched. More...
 
 attributes ()
 Returns the attributes for this object, taken from the definition fields and function attributes. More...
 
 eZPersistentObject ($row)
 Initializes the object with the $row. More...
 
 fill ($row)
 Tries to fill in the data in the object by using the object definition which is returned by the function definition() and the database row data $row. More...
 
 hasAttribute ($attr)
 Checks if $attr is part of the definition fields or function attributes. More...
 
 hasDirtyData ()
 Returns true if the data is considered dirty and needs to be stored. More...
 
 remove ($conditions=null, $extraConditions=null)
 Removes the object from the database, it will use the keys in the object definition to figure out which table row should be removed unless $conditions is defined as an array with fieldnames. More...
 
 setAttribute ($attr, $val)
 Sets the attribute $attr to the value $val. More...
 
 setHasDirtyData ($hasDirtyData)
 Sets whether the object has dirty data or not. More...
 
 store ($fieldFilters=null)
 Stores the object in the database, uses storeObject() to do the actual job and passes $fieldFilters to it. More...
 
 sync ($fieldFilters=null)
 Makes sure data is stored if the data is considered dirty. More...
 

Static Public Member Functions

static cleanup ()
 
static create ($userID, $receiveDigest=0, $digestType=self::TYPE_NONE, $day= '', $time= '')
 
static definition ()
 
static fetchByUserId ($userId, $asObject=true)
 Returns the digest settings object for the user. More...
 
static fetchForUser ($address, $asObject=true)
 
static removeByAddress ($address)
 
static removeByUserId ($id)
 Removes the digest settings for a user. More...
 
- Static Public Member Functions inherited from eZPersistentObject
static conditionText ($conditions)
 Calls conditionTextByRow with an empty row and $conditions. More...
 
static conditionTextByRow ($conditions, $row)
 Generates an SQL sentence from the conditions $conditions and row data $row. More...
 
static count ($def, $conds=null, $field=null)
 Fetches the number of rows by using the object definition. More...
 
static definition ()
 Returns the definition for the object, the default implementation is to return an empty array. More...
 
static escapeArray ($array)
 Escapes strings in an array with the help of eZDBInterface::escapeString(). More...
 
static fetchObject ($def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 Fetches and returns an object based on the given parameters and returns is either as an object or as an array. More...
 
static fetchObjectList ($def, $field_filters=null, $conds=null, $sorts=null, $limit=null, $asObject=true, $grouping=false, $custom_fields=null, $custom_tables=null, $custom_conds=null)
 Creates an SQL query out of the different parameters and returns an array with the result. More...
 
static getShortAttributeName ($db, $def, $attrName)
 Returns the short attribute name (alias) if it's defined, given attribute name otherwise. More...
 
static handleRows ($rows, $class_name, $asObject)
 Creates PHP objects out of the database rows $rows. More...
 
static newObjectOrder ($def, $orderField, $conditions)
 Returns an order value which can be used for new items in table, for instance placement. More...
 
static removeObject ($def, $conditions=null, $extraConditions=null)
 Deletes the object from the table defined in $def with conditions $conditions and extra conditions $extraConditions. More...
 
static reorderObject ($def, $orderField, $conditions, $down=true)
 Moves a row in a database table. More...
 
static replaceFieldsWithShortNames ($db, $fieldDefs, &$fields)
 For the given array $fields treats its keys (for associative array) or values (for non-associative array) as table fields names and replaces them with short names (aliases) found in $fieldDefs. More...
 
static storeObject ($obj, $fieldFilters=null)
 Stores the data in $obj to database. More...
 
static swapRow ($table, $keys, $order_id, $rows, $id1, $id2)
 Sets row id $id2 to have the placement of row id $id1. More...
 
static updateObjectList ($parameters)
 Updates rows matching the given parameters. More...
 

Public Attributes

const TYPE_DAILY = 3
 
const TYPE_MONTHLY = 2
 
const TYPE_NONE = 0
 
const TYPE_WEEKLY = 1
 
- Public Attributes inherited from eZPersistentObject
 $PersistentDataDirty
 

Protected Member Functions

 address ()
 Returns the email address of the user associated with the digest settings. More...
 

Detailed Description

Member Function Documentation

eZGeneralDigestUserSettings::address ( )
protected

Returns the email address of the user associated with the digest settings.

Returns
string
static eZGeneralDigestUserSettings::cleanup ( )
static

Removes all general digest settings for all users.

Referenced by eZGeneralDigestHandler\cleanup().

static eZGeneralDigestUserSettings::create (   $userID,
  $receiveDigest = 0,
  $digestType = self::TYPE_NONE,
  $day = '',
  $time = '' 
)
static
static eZGeneralDigestUserSettings::definition ( )
static
eZGeneralDigestUserSettings::eZGeneralDigestUserSettings (   $row)

Constructor

Referenced by create().

static eZGeneralDigestUserSettings::fetchByUserId (   $userId,
  $asObject = true 
)
static

Returns the digest settings object for the user.

Since
5.0
Parameters
int$userIdthe user id
bool$asObject
Returns
eZGeneralDigestUserSettings

Referenced by eZSubTreeHandler\handlePublishEvent(), eZGeneralDigestHandler\settings(), and eZGeneralDigestHandler\storeSettings().

static eZGeneralDigestUserSettings::fetchForUser (   $address,
  $asObject = true 
)
static
Deprecated:
Since 5.0, please use fetchByUserId()
Parameters
$address
bool$asObject
Returns
array|eZPersistentObject|null
static eZGeneralDigestUserSettings::removeByAddress (   $address)
static
Deprecated:
Since 5.0, please use removeByUserID()
Parameters
string$address
static eZGeneralDigestUserSettings::removeByUserId (   $id)
static

Removes the digest settings for a user.

Since
5.0
Parameters
int$idthe user id

Referenced by eZUser\removeUser().

Member Data Documentation

const eZGeneralDigestUserSettings::TYPE_DAILY = 3
const eZGeneralDigestUserSettings::TYPE_MONTHLY = 2
const eZGeneralDigestUserSettings::TYPE_NONE = 0
const eZGeneralDigestUserSettings::TYPE_WEEKLY = 1

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