Single Newsletter Item
author | Timo A. Hummel <Timo.Hummel@4fb.de> |
---|---|
version | 0.1 |
copyright | four for business 2003 |
Item(string $table, string $primaryKey, $lifetime)
inherited_from | \Item::Item() |
---|
string
The table to use as information source
string
The primary key to use
Newsletter($idnews)
_deChunkHTTPBody($sHeader, $sBody, $sEOL)
_getNewsletterTagData($sHTML, $sTag)
_inFilter(mixed $data) : mixed
see | \setFilters |
---|---|
access | private |
inherited_from | \Item::_inFilter() |
mixed
Data to filter
mixed
Filtered data_onLoad() : \none
Function which is called whenever an item is loaded. Inherited classes should override this function if desired.
inherited_from | \Item::_onLoad() |
---|
\none
_outFilter(mixed $data) : mixed
see | \setFilters |
---|---|
access | private |
inherited_from | \Item::_outFilter() |
mixed
Data to filter
mixed
Filtered data_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 |
---|
string
sCode Code, where the tags will be replaced (by reference)
bool
bIsHTML Is code HTML?
string
sField Field name, without MAIL_ (e.g. just "name")
string
sData Data
_setMetaObject($objectname)
inherited_from | \Item::_setMetaObject() |
---|
deleteProperty(string $type, string $name)
inherited_from | \Item::deleteProperty() |
---|
string
Specifies the type
string
Specifies the name
get(string $field) : mixed
inherited_from | \Item::get() |
---|
string
Specifies the field to retrieve
mixed
Value of the fieldgetField(string $field) : mixed
inherited_from | \Item::getField() |
---|
string
Specifies the field to retrieve
mixed
Value of the fieldgetHTMLMessage() : string
string
HTML messagegetMetaObject()
inherited_from | \Item::getMetaObject() |
---|
getProperty(string $type, string $name) : boolean
inherited_from | \Item::getProperty() |
---|
string
Specifies the type
string
Specifies the name
boolean
Value of the given propertyhtmlArticleExists() : bool
bool
loadBy(string $field, string $value, bool $bSafe) : bool
inherited_from | \Item::loadBy() |
---|
string
Specifies the field
string
Specifies the value
bool
use inFilter or not
bool
True if the load was successfulloadByPrimaryKey(string $value) : bool
inherited_from | \Item::loadByPrimaryKey() |
---|
string
Specifies the primary key value
bool
True if the load was successfulsend($idcatart, $destination, $to, $iChunkSize, $iChunk, $sEncoding)
deprecated | >V4.6.15 - 21.05.2007 Sends a newsletter |
---|
integer specifies id of the 'BlackBox'-acrticle containing the 'BlackBox'-module for management
string specifies, who will receive the newsletter ("all", "default" = defaultgroup, "selection" = selected groups, "single" = one recepient [e.g. Welcome-Newsletter])
array specifies, which group of recipients shall receive the newsletter ("all", "default" = defaultgroup, "4,5,6" = group IDs)
integer specifies size of chunks when sending in chunks, 0 = don't send in chunks
integer specifies current chunk number when sending in chunks result array array of recipient names/e-mails
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.
integer
idcatart of newsletter handler article
integer
If specified, newsletter recipient id, ignored, if group specified
integer
If specified, newsletter recipient group id
array
As reference: Filled with a list of succesfull recipients
string
Message (and header) encoding, e.g. iso-8859-1
sendEMail(integer $iIDCatArt, string $sEMail, string $sName, $bSimulatePlugins, string $sEncoding)
integer
idcatart of newsletter handler article
string
Recipient email address
string
Optional: Recipient name
string
Message (and header) encoding, e.g. iso-8859-1
set(string $field, string $value, $safe)
inherited_from | \Item::set() |
---|
string
Specifies the field to set
string
Specifies the value to set
setField(string $field, string $value, boolean $safe)
inherited_from | \Item::setField() |
---|
string
Specifies the field to set
string
Specifies the value to set
boolean
Speficies if we should translate characters
setFilters(array $arrInFilters, array $arrOutFilters) : void
Examples:
$obj->setFilters(array('addslashes'), array('stripslashes')); $obj->setFilters(array('htmlencode', 'addslashes'), array('stripslashes', 'htmlencode'));
inherited_from | \Item::setFilters() |
---|
array
inFilters array with function names
array
outFilters array with function names
setProperty(string $type, string $name, string $value)
inherited_from | \Item::setProperty() |
---|
string
Specifies the type
string
Specifies the name
string
Specifies the value
store()
$_arrInFilters : array
access | private |
---|---|
inherited_from | \Item::$$_arrInFilters |
$_arrOutFilters : array
access | private |
---|---|
inherited_from | \Item::$$_arrOutFilters |
$_sError : string
access | private |
---|
$cache : array
access | private |
---|---|
inherited_from | \Item::$$cache |
$db : object
access | private |
---|---|
inherited_from | \Item::$$db |
$lasterror : string
access | private |
---|---|
inherited_from | \Item::$$lasterror |
$lifetime : int
access | private |
---|---|
inherited_from | \Item::$$lifetime |
$modifiedValues : array
access | private |
---|---|
inherited_from | \Item::$$modifiedValues |
$oldPrimaryKey : string
access | private |
---|---|
inherited_from | \Item::$$oldPrimaryKey |
$primaryKey : object
access | private |
---|---|
inherited_from | \Item::$$primaryKey |
$properties : object
access | private |
---|---|
inherited_from | \Item::$$properties |
$table : string
access | private |
---|---|
inherited_from | \Item::$$table |
$values : array
access | private |
---|---|
inherited_from | \Item::$$values |
$virgin : boolean
If true, the object is virgin and no operations on it except load-Functions are allowed.
access | private |
---|---|
inherited_from | \Item::$$virgin |