Class NewsletterRecipientCollection

Newsletter Collection class.

cGenericDb

NewsletterRecipientCollection

Package: Plugin\Newsletter
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Bjoern Behrens
Located at plugins/newsletter/classes/class.newsletter.recipients.php

Methods summary
`public`	# `__construct( )` Constructor Function Constructor Function Throws `cInvalidArgumentException` If table name or primary key is not set Overrides `ItemCollection::__construct()`
`public`	# `create( string $sEMail, string $sName = "", integer $iConfirmed = 0, string $sJoinID = "", integer $iMessageType = 0 )` Creates a new recipient Creates a new recipient Parameters `$sEMail` `string` $sEMail Specifies the e-mail adress `$sName` `string` $sName Specifies the recipient name (optional) `$iConfirmed` `integer` $iConfirmed Specifies, if the recipient is confirmed (optional) `$sJoinID` `string` $sJoinID Specifies additional recipient group ids to join (optional, e.g. 47,12,...) `$iMessageType` `integer` $iMessageType Specifies the message type for the recipient (0 = text, 1 = html)
`public boolean`	# `delete( mixed $itemID )` Overridden delete method to remove recipient from groupmember table before deleting recipient Overridden delete method to remove recipient from groupmember table before deleting recipient Parameters `$itemID` `mixed` $itemID int specifies the recipient Returns `boolean` Overrides `ItemCollection::delete()`
`public integer`	# `purge( mixed $timeframe )` Purge method to delete recipients which hasn't been confirmed since over a month Purge method to delete recipients which hasn't been confirmed since over a month Parameters `$timeframe` `mixed` $timeframe int Days after creation a not confirmed recipient will be removed Returns `integer` Count of deleted recipients
`public NewsletterRecipient\|false`	# `emailExists( mixed $sEmail )` checkEMail returns true, if there is no recipient with the same e-mail address; otherwise false checkEMail returns true, if there is no recipient with the same e-mail address; otherwise false Parameters `$sEmail` `mixed` $sEmail string e-mail Returns `NewsletterRecipient\|false` recpient item if item with e-mail exists, false otherwise
`public`	# `updateKeys( )` Sets a key for all recipients without key or an old key (len(key) <> 30) Sets a key for all recipients without key or an old key (len(key) <> 30)

Methods inherited from ItemCollection
_buildGroupWhereStatements(), _buildWhereStatements(), _delete(), _deleteMultiple(), _fetchJoinTables(), _findReverseJoinPartner(), _initializeDriver(), _recursiveStructuredFetch(), _resolveLinks(), _setItemClass(), _setJoinPartner(), addResultField(), copyItem(), count(), createNewItem(), deleteBy(), deleteByWhereClause(), deleteWhere(), deleteWhereGroup(), exists(), fetchArray(), fetchById(), fetchObject(), fetchTable(), flexSelect(), getAllIds(), getFieldsByWhereClause(), getIdsByWhereClause(), link(), loadItem(), next(), query(), queryAndFetchStructured(), removeResultField(), resetQuery(), select(), setEncoding(), setGroupCondition(), setInnerGroupCondition(), setLimit(), setOrder(), setWhere(), setWhereGroup()

Methods inherited from cItemBaseAbstract
`__get(), __set(), _getPropertiesCollectionInstance(), _getSecondDBInstance(), _resetItem(), _setLoaded(), _setPrimaryKeyName(), escape(), getPrimaryKeyName(), isLoaded()`

Methods inherited from cGenericDb
`_executeCallbacks(), register(), unregister()`

Constants inherited from cGenericDb
`CREATE_BEFORE, CREATE_FAILURE, CREATE_SUCCESS, DELETE_BEFORE, DELETE_FAILURE, DELETE_SUCCESS, STORE_BEFORE, STORE_FAILURE, STORE_SUCCESS`

Properties inherited from ItemCollection
`$_JoinPartners, $_aOperators, $_bAllMode, $_collectionCache, $_driver, $_encoding, $_forwardJoinPartners, $_groupConditions, $_innerGroupConditions, $_itemClass, $_itemClassInstance, $_iteratorItem, $_lastSQL, $_limitCount, $_limitStart, $_links, $_order, $_resultFields, $_where, $_whereRestriction, $objects`

Properties inherited from cItemBaseAbstract
`$_className, $_loaded, $_oCache, $_primaryKeyName, $_settings, $db, $lasterror, $properties, $secondDb, $table`

Packages

Classes

Class NewsletterRecipientCollection

Throws

Overrides

Parameters

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns