Base class with common features for database based items and item collections.
deprecated |
2012-03-01 Use NewsletterRecipientGroup instead |
copyright |
four for business AG |
Methods
Constructor function for downwards compatibility
Item($sTable, $sPrimaryKey, $iLifetime)
Inherited
inherited_from |
\Item::Item() |
inherited_from |
\NewsletterRecipientGroup::Item() |
Parameters
$sTable
$sPrimaryKey
$iLifetime
NewsletterRecipientGroup()
NewsletterRecipientGroup($mId)
Inherited
inherited_from |
\NewsletterRecipientGroup::NewsletterRecipientGroup() |
Parameters
$mId
RecipientGroup()
RecipientGroup()
deprecated |
[2011-03-15] Old constructor function for downwards compatibility |
Constructor Function
__construct() : void
deprecated |
2012-03-01 Use NewsletterRecipientGroup instead |
Exceptions
Filters the passed data using the functions defines in the _arrInFilters array.
_inFilter(mixed $mData) : mixed
Inherited
see |
\setFilters |
inherited_from |
\Item::_inFilter() |
inherited_from |
\NewsletterRecipientGroup::_inFilter() |
Parameters
$mData
mixed
Data to filter
Returns
mixed
Filtered data
Deletes a custom property.
deleteProperty(string $sType, string $sName) : bool
Inherited
inherited_from |
\Item::deleteProperty() |
inherited_from |
\NewsletterRecipientGroup::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() |
inherited_from |
\NewsletterRecipientGroup::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() |
inherited_from |
\NewsletterRecipientGroup::escape() |
Parameters
$sString
string
The string to escape
Returns
string
Escaped string
Wrapper for getField (less to type).
get(string $sField) : mixed
Inherited
inherited_from |
\Item::get() |
inherited_from |
\NewsletterRecipientGroup::get() |
Parameters
$sField
string
Specifies the field to retrieve
Returns
mixed
Value of the field
Gets the value of a specific field.
getField(string $sField) : mixed
Inherited
inherited_from |
\Item::getField() |
inherited_from |
\NewsletterRecipientGroup::getField() |
Parameters
$sField
string
Specifies the field to retrieve
Returns
mixed
Value of the field
Returns a custom property.
getProperty(string $sType, string $sName) : mixed
Inherited
inherited_from |
\Item::getProperty() |
inherited_from |
\NewsletterRecipientGroup::getProperty() |
Parameters
$sType
string
Specifies the type
$sName
string
Specifies the name
Returns
mixed
Value of the given property or false
Checks if a the item is already loaded.
isLoaded() : bool
Inherited
inherited_from |
\Item::isLoaded() |
inherited_from |
\NewsletterRecipientGroup::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() |
inherited_from |
\NewsletterRecipientGroup::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
bool
True 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() |
inherited_from |
\NewsletterRecipientGroup::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
bool
True if the load was successful
Loads an item by ID from the database.
loadByPrimaryKey(string $mValue) : bool
Inherited
inherited_from |
\Item::loadByPrimaryKey() |
inherited_from |
\NewsletterRecipientGroup::loadByPrimaryKey() |
Parameters
$mValue
string
Specifies the primary key value
Returns
bool
True if the load was successful
Loads an item by it's recordset.
loadByRecordSet(array $aRecordSet)
Inherited
inherited_from |
\Item::loadByRecordSet() |
inherited_from |
\NewsletterRecipientGroup::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() |
inherited_from |
\NewsletterRecipientGroup::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
Shortcut to setField.
set(string $sField, string $mValue, bool $bSafe)
Inherited
inherited_from |
\Item::set() |
inherited_from |
\NewsletterRecipientGroup::set() |
Parameters
$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() |
inherited_from |
\NewsletterRecipientGroup::setField() |
Parameters
$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() |
inherited_from |
\NewsletterRecipientGroup::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() |
inherited_from |
\NewsletterRecipientGroup::setProperty() |
Parameters
$sType
string
Specifies the type
$sName
string
Specifies the name
$mValue
mixed
Specifies the value
Returns
bool
Overriden store() method to ensure, that there is only one default group
store() : bool
Inherited
inherited_from |
\NewsletterRecipientGroup::store() |
Returns
bool
Returns current item data as an assoziative array.
toArray() : array | false
Inherited
inherited_from |
\Item::toArray() |
inherited_from |
\NewsletterRecipientGroup::toArray() |
Returns
array
false
Returns current item data as an object.
toObject() : \stdClass | false
Inherited
inherited_from |
\Item::toObject() |
inherited_from |
\NewsletterRecipientGroup::toObject() |
Returns
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() |
inherited_from |
\NewsletterRecipientGroup::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
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() |
inherited_from |
\NewsletterRecipientGroup::_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
Returns properties instance, instantiates it if not done before.
_getPropertiesCollectionInstance() : \cApiPropertyCollection
Inherited
inherited_from |
\cItemBaseAbstract::_getPropertiesCollectionInstance() |
inherited_from |
\Item::_getPropertiesCollectionInstance() |
inherited_from |
\NewsletterRecipientGroup::_getPropertiesCollectionInstance() |
Returns
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() |
inherited_from |
\NewsletterRecipientGroup::_getSecondDBInstance() |
Returns
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() |
inherited_from |
\NewsletterRecipientGroup::_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
bool
True 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() |
inherited_from |
\NewsletterRecipientGroup::_onLoad() |
Filters the passed data using the functions defines in the _arrOutFilters array.
_outFilter(mixed $mData) : mixed
Inherited
see |
\setFilters |
inherited_from |
\Item::_outFilter() |
inherited_from |
\NewsletterRecipientGroup::_outFilter() |
Parameters
$mData
mixed
Data to filter
Returns
mixed
Filtered data
Properties
$primaryKey : string
Inherited
inherited_from |
\cItemBaseAbstract::$$primaryKey |
inherited_from |
\Item::$$primaryKey |
inherited_from |
\NewsletterRecipientGroup::$$primaryKey |
$values : array
Inherited
inherited_from |
\Item::$$values |
inherited_from |
\NewsletterRecipientGroup::$$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 |
inherited_from |
\NewsletterRecipientGroup::$$virgin |
$_arrInFilters : array
Inherited
inherited_from |
\Item::$$_arrInFilters |
inherited_from |
\NewsletterRecipientGroup::$$_arrInFilters |
$_arrOutFilters : array
Inherited
inherited_from |
\Item::$$_arrOutFilters |
inherited_from |
\NewsletterRecipientGroup::$$_arrOutFilters |
$_className : string
Inherited
inherited_from |
\cItemBaseAbstract::$$_className |
inherited_from |
\Item::$$_className |
inherited_from |
\NewsletterRecipientGroup::$$_className |
$_oCache : \cItemCache
Inherited
inherited_from |
\cItemBaseAbstract::$$_oCache |
inherited_from |
\Item::$$_oCache |
inherited_from |
\NewsletterRecipientGroup::$$_oCache |
$_settings : array
Inherited
inherited_from |
\cItemBaseAbstract::$$_settings |
inherited_from |
\Item::$$_settings |
inherited_from |
\NewsletterRecipientGroup::$$_settings |
$cache : array
Inherited
inherited_from |
\cItemBaseAbstract::$$cache |
inherited_from |
\Item::$$cache |
inherited_from |
\NewsletterRecipientGroup::$$cache |
$db : \cDb
Inherited
inherited_from |
\cItemBaseAbstract::$$db |
inherited_from |
\Item::$$db |
inherited_from |
\NewsletterRecipientGroup::$$db |
$lasterror : string
Inherited
inherited_from |
\cItemBaseAbstract::$$lasterror |
inherited_from |
\Item::$$lasterror |
inherited_from |
\NewsletterRecipientGroup::$$lasterror |
$lifetime : int
Inherited
inherited_from |
\cItemBaseAbstract::$$lifetime |
inherited_from |
\Item::$$lifetime |
inherited_from |
\NewsletterRecipientGroup::$$lifetime |
$modifiedValues : array
Inherited
inherited_from |
\Item::$$modifiedValues |
inherited_from |
\NewsletterRecipientGroup::$$modifiedValues |
$oldPrimaryKey : string
Inherited
inherited_from |
\Item::$$oldPrimaryKey |
inherited_from |
\NewsletterRecipientGroup::$$oldPrimaryKey |
$properties : \cApiPropertyCollection
Inherited
inherited_from |
\cItemBaseAbstract::$$properties |
inherited_from |
\Item::$$properties |
inherited_from |
\NewsletterRecipientGroup::$$properties |
$secondDb : \cDb
Inherited
inherited_from |
\cItemBaseAbstract::$$secondDb |
inherited_from |
\Item::$$secondDb |
inherited_from |
\NewsletterRecipientGroup::$$secondDb |
$table : string
Inherited
inherited_from |
\cItemBaseAbstract::$$table |
inherited_from |
\Item::$$table |
inherited_from |
\NewsletterRecipientGroup::$$table |
$_callbacks : array
Inherited
inherited_from |
\cGenericDb::$$_callbacks |
inherited_from |
\cItemBaseAbstract::$$_callbacks |
inherited_from |
\Item::$$_callbacks |
inherited_from |
\NewsletterRecipientGroup::$$_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 |
inherited_from |
\NewsletterRecipientGroup::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 |
inherited_from |
\NewsletterRecipientGroup::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 |
inherited_from |
\NewsletterRecipientGroup::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 |
inherited_from |
\NewsletterRecipientGroup::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 |
inherited_from |
\NewsletterRecipientGroup::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 |
inherited_from |
\NewsletterRecipientGroup::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 |
inherited_from |
\NewsletterRecipientGroup::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 |
inherited_from |
\NewsletterRecipientGroup::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 |
inherited_from |
\NewsletterRecipientGroup::STORE_SUCCESS |