CONTENIDO 4.8.18 » \Newsletter

Methods

Single Newsletter Item

author	Timo A. Hummel <Timo.Hummel@4fb.de>
version	0.1
copyright	four for business 2003

Methods

Constructor Function

Item(string $table, string $primaryKey, $lifetime)

Inherited

inherited_from	\Item::Item()

Parameters

$table

string

The table to use as information source

$primaryKey

string

The primary key to use

$lifetime

Constructor Function

Newsletter($idnews)

Parameters

$idnews

_deChunkHTTPBody()

_deChunkHTTPBody($sHeader, $sBody, $sEOL)

Parameters

$sHeader

$sBody

$sEOL

_getNewsletterTagData()

_getNewsletterTagData($sHTML, $sTag)

Parameters

$sHTML

$sTag

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

_inFilter(mixed $data) : mixed

Inherited

see	\setFilters
access	private
inherited_from	\Item::_inFilter()

Parameters

$data

mixed

Data to filter

Returns

mixedFiltered data

_onLoad ()

_onLoad() : \none

Inherited

Function which is called whenever an item is loaded. Inherited classes should override this function if desired.

inherited_from	\Item::_onLoad()

Returns

\none

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

_outFilter(mixed $data) : mixed

Inherited

see	\setFilters
access	private
inherited_from	\Item::_outFilter()

Parameters

$data

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

_setMetaObject()

_setMetaObject($objectname)

Inherited

inherited_from	\Item::_setMetaObject()

Parameters

$objectname

deleteProperty ($type, $name) Deletes a custom property

deleteProperty(string $type, string $name)

Inherited

inherited_from	\Item::deleteProperty()

Parameters

$type

string

Specifies the type

$name

string

Specifies the name

get($field) Wrapper for getField (less to type)

get(string $field) : mixed

Inherited

inherited_from	\Item::get()

Parameters

$field

string

Specifies the field to retrieve

Returns

mixedValue of the field

getField($field) Gets the value of a specific field

getField(string $field) : mixed

Inherited

inherited_from	\Item::getField()

Parameters

$field

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()

getProperty ($type, $name) Sets a custom property

getProperty(string $type, string $name) : boolean

Inherited

inherited_from	\Item::getProperty()

Parameters

$type

string

Specifies the type

$name

string

Specifies the name

Returns

booleanValue of the given property

Checks, if html newsletter article still exists

htmlArticleExists() : bool

Returns

bool

loadBy ($field, $value) Loads an item by colum/field from the database

loadBy(string $field, string $value, bool $bSafe) : bool

Inherited

inherited_from	\Item::loadBy()

Parameters

$field

string

Specifies the field

$value

string

Specifies the value

$bSafe

bool

use inFilter or not

Returns

boolTrue if the load was successful

loadByPrimaryKey ($value) Loads an item by ID from the database

loadByPrimaryKey(string $value) : bool

Inherited

inherited_from	\Item::loadByPrimaryKey()

Parameters

$value

string

Specifies the primary key value

Returns

boolTrue if the load was successful

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

set($field, $value) Shortcut to setField

set(string $field, string $value, $safe)

Inherited

inherited_from	\Item::set()

Parameters

$field

string

Specifies the field to set

$value

string

Specifies the value to set

$safe

setField($field, $value) Sets the value of a specific field

setField(string $field, string $value, boolean $safe)

Inherited

inherited_from	\Item::setField()

Parameters

$field

string

Specifies the field to set

$value

string

Specifies the value to set

$safe

boolean

Speficies if we should translate characters

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

setFilters(array $arrInFilters, array $arrOutFilters) : void

Inherited

Examples:

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

inherited_from	\Item::setFilters()

Parameters

$arrInFilters

array

inFilters array with function names

$arrOutFilters

array

outFilters array with function names

setProperty ($type, $name, $value) Sets a custom property

setProperty(string $type, string $name, string $value)

Inherited

inherited_from	\Item::setProperty()

Parameters

$type

string

Specifies the type

$name

string

Specifies the name

$value

string

Specifies the value

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

store()

Properties

$_arrInFilters : array

Inherited

access	private
inherited_from	\Item::$$_arrInFilters

$_arrOutFilters : array

Inherited

access	private
inherited_from	\Item::$$_arrOutFilters

$_metaObject

Inherited

inherited_from	\Item::$$_metaObject

Error storage

$_sError : string

access	private

$cache : array

Inherited

access	private
inherited_from	\Item::$$cache

$db : object

Inherited

access	private
inherited_from	\Item::$$db

$lasterror : string

Inherited

access	private
inherited_from	\Item::$$lasterror

Lifetime in seconds

$lifetime : int

Inherited

access	private
inherited_from	\Item::$$lifetime

$modifiedValues : array

Inherited

access	private
inherited_from	\Item::$$modifiedValues

$oldPrimaryKey : string

Inherited

access	private
inherited_from	\Item::$$oldPrimaryKey

$primaryKey : object

Inherited

access	private
inherited_from	\Item::$$primaryKey

PropertyCollection object

$properties : object

Inherited

access	private
inherited_from	\Item::$$properties

$table : string

Inherited

access	private
inherited_from	\Item::$$table

$values : array

Inherited

access	private
inherited_from	\Item::$$values

$virgin : boolean

Inherited

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

access	private
inherited_from	\Item::$$virgin