CONTENIDO_4.9.0 beta1 » \Newsletter

» Private
- ```
$_callbacks
```
Constants

Single Newsletter Item

Base class with common features for database based items and item collections.

copyright	four for business AG

Methods

Constructor function for downwards compatibility

Item($sTable, $sPrimaryKey, $iLifetime)

Inherited

inherited_from	\Item::Item()

Parameters

$sTable

$sPrimaryKey

$iLifetime

Newsletter()

Newsletter($mId)

deprecated	[2011-03-15] Old constructor function for downwards compatibility

Parameters

$mId

Constructor Function

__construct(mixed $mId) : void

Parameters

$mId

mixed

Specifies the ID of item to load

Exceptions

`\cInvalidArgumentException`	If table name or primary key is not set

Filters the passed data using the functions defines in the _arrInFilters array.

_inFilter(mixed $mData) : mixed

Inherited

see	\setFilters
inherited_from	\Item::_inFilter()

Parameters

$mData

mixed

Data to filter

Returns

mixedFiltered data

Replaces newsletter tag (e.g.

_replaceTag(string $sCode, bool $bIsHTML, string $sField, string $sData)

MAIL_NAME) with data. If code is just text using str_replace; if it is HTML by using regular expressions

access	private

Parameters

$sCode

string

sCode Code, where the tags will be replaced (by reference)

$bIsHTML

bool

bIsHTML Is code HTML?

$sField

string

sField Field name, without MAIL_ (e.g. just "name")

$sData

string

sData Data

Deletes a custom property.

deleteProperty(string $sType, string $sName) : bool

Inherited

inherited_from	\Item::deleteProperty()

Parameters

$sType

string

Specifies the type

$sName

string

Specifies the name

Returns

bool

Deletes a custom property by its id.

deletePropertyById(int $idprop) : bool

Inherited

inherited_from	\Item::deletePropertyById()

Parameters

$idprop

int

Id of property

Returns

bool

Escape string for using in SQL-Statement.

escape(string $sString) : string

Inherited

inherited_from	\cItemBaseAbstract::escape()
inherited_from	\Item::escape()

Parameters

$sString

string

The string to escape

Returns

stringEscaped string

Wrapper for getField (less to type).

get(string $sField) : mixed

Inherited

inherited_from	\Item::get()

Parameters

$sField

string

Specifies the field to retrieve

Returns

mixedValue of the field

Gets the value of a specific field.

getField(string $sField) : mixed

Inherited

inherited_from	\Item::getField()

Parameters

$sField

string

Specifies the field to retrieve

Returns

mixedValue of the field

If newsletter is HTML newsletter and necessary data available returns final HTML message

getHTMLMessage() : string

Returns

stringHTML message

getMetaObject()

getMetaObject()

Inherited

inherited_from	\Item::getMetaObject()

Returns a custom property.

getProperty(string $sType, string $sName) : mixed

Inherited

inherited_from	\Item::getProperty()

Parameters

$sType

string

Specifies the type

$sName

string

Specifies the name

Returns

mixedValue of the given property or false

Checks, if html newsletter article still exists

htmlArticleExists() : bool

Returns

bool

Checks if a the item is already loaded.

isLoaded() : bool

Inherited

inherited_from	\Item::isLoaded()

Returns

bool

Loads an item by colum/field from the database.

loadBy(string $sField, mixed $mValue, bool $bSafe) : bool

Inherited

inherited_from	\Item::loadBy()

Parameters

$sField

string

Specifies the field

$mValue

mixed

Specifies the value

$bSafe

bool

Use inFilter or not

Exceptions

`\cException`	if more than one item has been found matching the given arguments

Returns

boolTrue if the load was successful

Loads an item by colums/fields from the database.

loadByMany(array $aAttributes, bool $bSafe) : bool

Inherited

inherited_from	\Item::loadByMany()

Parameters

$aAttributes

array

associative array with field / value pairs

$bSafe

bool

Use inFilter or not

Exceptions

`\cException`	if more than one item could be found matching the given arguments

Returns

boolTrue if the load was successful

Loads an item by ID from the database.

loadByPrimaryKey(string $mValue) : bool

Inherited

inherited_from	\Item::loadByPrimaryKey()

Parameters

$mValue

string

Specifies the primary key value

Returns

boolTrue if the load was successful

Loads an item by it's recordset.

loadByRecordSet(array $aRecordSet)

Inherited

inherited_from	\Item::loadByRecordSet()

Parameters

$aRecordSet

array

The recordset of the item

Registers a new callback.

register(string $event, mixed $callback, mixed $class) : void

InheritedStatic

Example: cGenericDb::register(cGenericDb::CREATE_SUCCESS, 'itemCreateHandler', 'cApiArticle'); cGenericDb::register(cGenericDb::CREATE_SUCCESS, array('cCallbackHandler', 'executeCreateHandle'), 'cApiArticle');

inherited_from	\cGenericDb::register()
inherited_from	\cItemBaseAbstract::register()
inherited_from	\Item::register()

Parameters

$event

string

Callback event, must be a valid value of a cGenericDb event constant

$callback

mixed

Callback to register

$class

mixed

Class name for registering callback (can be string of array with names of the concrete Item classes)

Exceptions

`\cInvalidArgumentException`	if event or class are not set or the callback is not callable

send()

send($idcatart, $destination, $to, $iChunkSize, $iChunk, $sEncoding)

deprecated	>V4.6.15 - 21.05.2007 Sends a newsletter

Parameters

$idcatart

integer specifies id of the 'BlackBox'-acrticle containing the 'BlackBox'-module for management

$destination

string specifies, who will receive the newsletter ("all", "default" = defaultgroup, "selection" = selected groups, "single" = one recepient [e.g. Welcome-Newsletter])

$to

array specifies, which group of recipients shall receive the newsletter ("all", "default" = defaultgroup, "4,5,6" = group IDs)

$iChunkSize

integer specifies size of chunks when sending in chunks, 0 = don't send in chunks

$iChunk

integer specifies current chunk number when sending in chunks result array array of recipient names/e-mails

$sEncoding

Sends test newsletter directly to specified recipients (single or group)

sendDirect(integer $iIDCatArt, integer $iIDNewsRcp, integer $iIDNewsGroup, array $aSendRcps, string $sEncoding)

Note: Sending in chunks not supported! Only usable for tests and only a few recipients.

Parameters

$iIDCatArt

integer

idcatart of newsletter handler article

$iIDNewsRcp

integer

If specified, newsletter recipient id, ignored, if group specified

$iIDNewsGroup

integer

If specified, newsletter recipient group id

$aSendRcps

array

As reference: Filled with a list of succesfull recipients

$sEncoding

string

Message (and header) encoding, e.g. iso-8859-1

Sends test newsletter directly to specified email address

sendEMail(integer $iIDCatArt, string $sEMail, string $sName, $bSimulatePlugins, string $sEncoding)

Parameters

$iIDCatArt

integer

idcatart of newsletter handler article

$sEMail

string

Recipient email address

$sName

string

Optional: Recipient name

$bSimulatePlugins

$sEncoding

string

Message (and header) encoding, e.g. iso-8859-1

Shortcut to setField.

set(string $sField, string $mValue, bool $bSafe)

Inherited

inherited_from	\Item::set()

Parameters

$sField

string

Field name

$mValue

string

Value to set

$bSafe

bool

Flag to run defined inFilter on passed value

Sets the value of a specific field.

setField(string $sField, string $mValue, bool $bSafe)

Inherited

inherited_from	\Item::setField()

Parameters

$sField

string

Field name

$mValue

string

Value to set

$bSafe

bool

Flag to run defined inFilter on passed value

Define the filter functions used when data is being stored or retrieved from the database.

setFilters(array $aInFilters, array $aOutFilters) : void

Inherited

Examples:

$obj->setFilters(array('addslashes'), array('stripslashes'));
$obj->setFilters(array('htmlencode', 'addslashes'), array('stripslashes', 'htmlencode'));

inherited_from	\Item::setFilters()

Parameters

$aInFilters

array

Array with function names

$aOutFilters

array

Array with function names

Sets a custom property.

setProperty(string $sType, string $sName, mixed $mValue) : bool

Inherited

inherited_from	\Item::setProperty()

Parameters

$sType

string

Specifies the type

$sName

string

Specifies the name

$mValue

mixed

Specifies the value

Returns

bool

Overriden store()-Method to set modified and modifiedby data and to ensure, that there is only one welcome newsletter

store() : bool

Returns

bool

Returns current item data as an assoziative array.

toArray() : array | false

Inherited

inherited_from	\Item::toArray()

Returns

arrayfalse

Returns current item data as an object.

toObject() : \stdClass | false

Inherited

inherited_from	\Item::toObject()

Returns

\stdClassfalse

Unregisters all callbacks for a specific event in a class.

unregister(string $event, mixed $class) : void

InheritedStatic

Example: cGenericDb::unregister(cGenericDb::CREATE_SUCCESS, 'cApiArticle');

inherited_from	\cGenericDb::unregister()
inherited_from	\cItemBaseAbstract::unregister()
inherited_from	\Item::unregister()

Parameters

$event

string

Callback event, must be a valid value of a cGenericDb event constant

$class

mixed

Class name for unregistering callback (can be string of array with names of the concrete Item classes)

Exceptions

`\cInvalidArgumentException`	if the event or the class are not set

_deChunkHTTPBody()

_deChunkHTTPBody($sHeader, $sBody, $sEOL)

Parameters

$sHeader

$sBody

$sEOL

Executes all callbacks for a specific event in a class.

_executeCallbacks(string $event, string $class, array $arguments) : void

Inherited

inherited_from	\cGenericDb::_executeCallbacks()
inherited_from	\cItemBaseAbstract::_executeCallbacks()
inherited_from	\Item::_executeCallbacks()

Parameters

$event

string

Callback event, must be a valid value of a cGenericDb event constant

$class

string

Class name for executing callback

$arguments

array

Arguments to pass to the callback function

Exceptions

`\cInvalidArgumentException`	if the event or class is not set

_getNewsletterTagData()

_getNewsletterTagData($sHTML, $sTag)

Parameters

$sHTML

$sTag

Returns properties instance, instantiates it if not done before.

_getPropertiesCollectionInstance() : \cApiPropertyCollection

Inherited

inherited_from	\cItemBaseAbstract::_getPropertiesCollectionInstance()
inherited_from	\Item::_getPropertiesCollectionInstance()

Returns

\cApiPropertyCollection

Returns the second database instance, usable to run additional statements without losing current query results.

_getSecondDBInstance() : \cDb

Inherited

inherited_from	\cItemBaseAbstract::_getSecondDBInstance()
inherited_from	\Item::_getSecondDBInstance()

Returns

\cDb

Loads an item by passed where clause from the database.

_loadByWhereClause(string $sWhere) : bool

Inherited

This function is expensive, since it executes allways a query to the database to retrieve the primary key, even if the record set is aleady cached. NOTE: Passed value has to be escaped before. This will not be done by this function.

inherited_from	\Item::_loadByWhereClause()

Parameters

$sWhere

string

The where clause like 'idart = 123 AND idlang = 1'

Exceptions

`\cException`	if more than one item could be found matching the given where clause

Returns

boolTrue if the load was successful

Function which is called whenever an item is loaded.

_onLoad() : void

Inherited

Inherited classes should override this function if desired.

inherited_from	\Item::_onLoad()

Filters the passed data using the functions defines in the _arrOutFilters array.

_outFilter(mixed $mData) : mixed

Inherited

see	\setFilters
inherited_from	\Item::_outFilter()

Parameters

$mData

mixed

Data to filter

Returns

mixedFiltered data

_setMetaObject()

_setMetaObject($sObjectName)

Inherited

inherited_from	\Item::_setMetaObject()

Parameters

$sObjectName

Properties

$primaryKey : string

Inherited

inherited_from	\cItemBaseAbstract::$$primaryKey
inherited_from	\Item::$$primaryKey

$values : array

Inherited

inherited_from	\Item::$$values

$virgin : bool

Inherited

If true, the object is virgin and no operations on it except load-Functions are allowed.

inherited_from	\cItemBaseAbstract::$$virgin
inherited_from	\Item::$$virgin

$_arrInFilters : array

Inherited

inherited_from	\Item::$$_arrInFilters

$_arrOutFilters : array

Inherited

inherited_from	\Item::$$_arrOutFilters

$_className : string

Inherited

inherited_from	\cItemBaseAbstract::$$_className
inherited_from	\Item::$$_className

$_metaObject : string

Inherited

inherited_from	\Item::$$_metaObject

$_oCache : \cItemCache

Inherited

inherited_from	\cItemBaseAbstract::$$_oCache
inherited_from	\Item::$$_oCache

Error storage

$_sError : string

access	private

$_settings : array

Inherited

inherited_from	\cItemBaseAbstract::$$_settings
inherited_from	\Item::$$_settings

$cache : array

Inherited

inherited_from	\cItemBaseAbstract::$$cache
inherited_from	\Item::$$cache

$db : \cDb

Inherited

inherited_from	\cItemBaseAbstract::$$db
inherited_from	\Item::$$db

$lasterror : string

Inherited

inherited_from	\cItemBaseAbstract::$$lasterror
inherited_from	\Item::$$lasterror

$lifetime : int

Inherited

inherited_from	\cItemBaseAbstract::$$lifetime
inherited_from	\Item::$$lifetime

$modifiedValues : array

Inherited

inherited_from	\Item::$$modifiedValues

$oldPrimaryKey : string

Inherited

inherited_from	\Item::$$oldPrimaryKey

$properties : \cApiPropertyCollection

Inherited

inherited_from	\cItemBaseAbstract::$$properties
inherited_from	\Item::$$properties

$secondDb : \cDb

Inherited

inherited_from	\cItemBaseAbstract::$$secondDb
inherited_from	\Item::$$secondDb

$table : string

Inherited

inherited_from	\cItemBaseAbstract::$$table
inherited_from	\Item::$$table

$_callbacks : array

Inherited

inherited_from	\cGenericDb::$$_callbacks
inherited_from	\cItemBaseAbstract::$$_callbacks
inherited_from	\Item::$$_callbacks

Constants

Callbacks are executed before a item is created.

CREATE_BEFORE

Inherited

Expected parameters for callback: none

inherited_from	\cGenericDb::CREATE_BEFORE
inherited_from	\cItemBaseAbstract::CREATE_BEFORE
inherited_from	\Item::CREATE_BEFORE

Callbacks are executed if item could not be created.

CREATE_FAILURE

Inherited

Expected parameters for callback: none

inherited_from	\cGenericDb::CREATE_FAILURE
inherited_from	\cItemBaseAbstract::CREATE_FAILURE
inherited_from	\Item::CREATE_FAILURE

Callbacks are executed if item could be created successfully.

CREATE_SUCCESS

Inherited

Expected parameters for callback: ID of created item

inherited_from	\cGenericDb::CREATE_SUCCESS
inherited_from	\cItemBaseAbstract::CREATE_SUCCESS
inherited_from	\Item::CREATE_SUCCESS

Callbacks are executed before deleting an item.

DELETE_BEFORE

Inherited

Expected parameters for callback: ID of them item to delete

inherited_from	\cGenericDb::DELETE_BEFORE
inherited_from	\cItemBaseAbstract::DELETE_BEFORE
inherited_from	\Item::DELETE_BEFORE

Callbacks are executed if deletion of an item fails.

DELETE_FAILURE

Inherited

Expected parameters for callback: ID of them item to delete

inherited_from	\cGenericDb::DELETE_FAILURE
inherited_from	\cItemBaseAbstract::DELETE_FAILURE
inherited_from	\Item::DELETE_FAILURE

Callbacks are executed if item was deleted successfully.

DELETE_SUCCESS

Inherited

Expected parameters for callback: ID of them item to delete

inherited_from	\cGenericDb::DELETE_SUCCESS
inherited_from	\cItemBaseAbstract::DELETE_SUCCESS
inherited_from	\Item::DELETE_SUCCESS

Callbacks are executed before store process is executed.

STORE_BEFORE

Inherited

Expected parameters for callback: Item instance

inherited_from	\cGenericDb::STORE_BEFORE
inherited_from	\cItemBaseAbstract::STORE_BEFORE
inherited_from	\Item::STORE_BEFORE

Callbacks are executed if store process failed.

STORE_FAILURE

Inherited

This is also likely to happen if query would not change anything in database! Expected parameters for callback: Item instance

inherited_from	\cGenericDb::STORE_FAILURE
inherited_from	\cItemBaseAbstract::STORE_FAILURE
inherited_from	\Item::STORE_FAILURE

Callbacks are executed if store process saved the values in the database.

STORE_SUCCESS

Inherited

Expected parameters for callback: Item instance

inherited_from	\cGenericDb::STORE_SUCCESS
inherited_from	\cItemBaseAbstract::STORE_SUCCESS
inherited_from	\Item::STORE_SUCCESS