CONTENIDO_4.9.0 beta1
Back to top  

CONTENIDO API - Article Object

This object represents a CONTENIDO article

Create object with $obj = new cApiArticleLanguage(idartlang); or with $obj = new cApiArticleLanguage(); $obj->loadByArticleAndLanguageId(idart, lang);

You can now read the article properties with $obj->getField(property);

List of article properties:

idartlang - Language dependant article id idart - Language indepenant article id idclient - Id of the client idtplcfg - Template configuration id title - Internal Title pagetitle - HTML Title summary - Article summary created - Date created lastmodified - Date lastmodiefied author - Article author (username) online - On-/offline redirect - Redirect redirect_url - Redirect URL artsort - Article sort key timemgmt - Time management datestart - Time management start date dateend - Time management end date status - Article status free_use_01 - Free to use free_use_02 - Free to use free_use_03 - Free to use time_move_cat - Move category after time management time_target_cat - Move category to this cat after time management time_online_move - Set article online after move external_redirect - Open article in new window locked - Article is locked for editing searchable - Whether article should be found via search sitemapprio - The priority for the sitemap

You can extract article content with the $obj->getContent(contype [, number]) method.

To extract the first headline you can use:

$headline = $obj->getContent("htmlhead", 1);

If the second parameter is ommitted the method returns an array with all available content of this type. The array has the following schema:

array( number => content );

$headlines = $obj->getContent("htmlhead");

$headlines[1] First headline $headlines[2] Second headline $headlines[6] Sixth headline

Legal content type string are defined in the CONTENIDO system table 'con_type'. Default content types are:

NOTE: This parameter is case insesitive, you can use html or cms_HTML or CmS_HtMl. Your don't need start with cms, but it won't crash if you do so.

htmlhead - HTML Headline html - HTML Text headline - Headline (no HTML) text - Text (no HTML) img - Upload id of the element imgdescr - Image description link - Link (URL) linktarget - Linktarget (_self, _blank, _top ...) linkdescr - Linkdescription swf - Upload id of the element

deprecated [2011-10-19] Use cApiArticleLanguage class in classes/contenido/class.articlelanguage.php as follows: 
// create with article language id
$obj = new cApiArticleLanguage($idartlang);
// create with article id and language id
$obj = new cApiArticleLanguage();
$obj->loadByArticleAndLanguageId($idart, $lang);
package CONTENIDO API
copyright four for business AG

 Methods

Article() 

Article($idart, $client, $lang, $idartlang) 

Parameters

$idart

$client

$lang

$idartlang

Constructor function for downwards compatibility

Item($sTable, $sPrimaryKey, $iLifetime) 
Inherited
inherited_from \Item::Item()
inherited_from \cApiArticleLanguage::Item()

Parameters

$sTable

$sPrimaryKey

$iLifetime

Constructor.

__construct(int $idart, int $client, int $lang, int $idartlang) : void

Wrapper for parent class, provides thee downwards compatible interface for creation of the article object.

Parameters

$idart

int

Article id

$client

int

Client id (not used)

$lang

int

Language id

$idartlang

int

Article language id

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()
inherited_from \cApiArticleLanguage::_inFilter()

Parameters

$mData

mixed

Data to filter

Returns

mixedFiltered data

cApiArticleLanguage() 

cApiArticleLanguage($mId) 
Inherited
inherited_from \cApiArticleLanguage::cApiArticleLanguage()

Parameters

$mId

Deletes a custom property.

deleteProperty(string $sType, string $sName) : bool
Inherited
inherited_from \Item::deleteProperty()
inherited_from \cApiArticleLanguage::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 \cApiArticleLanguage::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 \cApiArticleLanguage::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()
inherited_from \cApiArticleLanguage::get()

Parameters

$sField

string

Specifies the field to retrieve

Returns

mixedValue of the field

Get content(s) from an article.

getContent(string $type, int | null $id) : string
Inherited

Returns the specified content element or an array("id"=>"value") if the second parameter is omitted.

Legal content type string are defined in the CONTENIDO system table 'con_type'. Default content types are:

NOTE: Parameter is case insesitive, you can use html or cms_HTML or CmS_HtMl. Your don't need start with cms, but it won't crash if you do so.

htmlhead - HTML Headline html - HTML Text headline - Headline (no HTML) text - Text (no HTML) img - Upload id of the element imgdescr - Image description link - Link (URL) linktarget - Linktarget (_self, _blank, _top ...) linkdescr - Linkdescription swf - Upload id of the element

inherited_from \cApiArticleLanguage::getContent()

Parameters

$type

string

CMS_TYPE - Legal cms type string

$id

intnull

Id of the content

Returns

stringarray data

Returns all available content types

getContentTypes() : array
Inherited
inherited_from \cApiArticleLanguage::getContentTypes()

Exceptions

\cException if no content has been loaded

Returns

array

Get the value of an article property

getField(string $name) : string
Inherited

List of article properties:

idartlang - Language dependant article id idart - Language indepenant article id idclient - Id of the client idtplcfg - Template configuration id title - Internal Title pagetitle - HTML Title summary - Article summary created - Date created lastmodified - Date lastmodiefied author - Article author (username) online - On-/offline redirect - Redirect redirect_url - Redirect URL artsort - Article sort key timemgmt - Time management datestart - Time management start date dateend - Time management end date status - Article status free_use_01 - Free to use free_use_02 - Free to use free_use_03 - Free to use time_move_cat - Move category after time management time_target_cat - Move category to this cat after time management time_online_move - Set article online after move external_redirect - Open article in new window locked - Article is locked for editing searchable - Whether article should be found via search sitemapprio - The priority for the sitemap

inherited_from \cApiArticleLanguage::getField()

Parameters

$name

string

Returns

stringValue of property

Returns the link to the current object.

getLink() : string
Inherited
inherited_from \cApiArticleLanguage::getLink()

Returns

stringlink

getMetaObject() 

getMetaObject() 
Inherited
inherited_from \Item::getMetaObject()
inherited_from \cApiArticleLanguage::getMetaObject()

Returns a custom property.

getProperty(string $sType, string $sName) : mixed
Inherited
inherited_from \Item::getProperty()
inherited_from \cApiArticleLanguage::getProperty()

Parameters

$sType

string

Specifies the type

$sName

string

Specifies the name

Returns

mixedValue of the given property or false

Checks if a the item is already loaded.

isLoaded() : bool
Inherited
inherited_from \Item::isLoaded()
inherited_from \cApiArticleLanguage::isLoaded()

Returns

bool

Load the articles content and stores it in the 'content' property of the article object.

loadArticleContent() 
Inherited

$article->content[type][number] = value;

inherited_from \cApiArticleLanguage::loadArticleContent()

Loads an item by colum/field from the database.

loadBy(string $sField, mixed $mValue, bool $bSafe) : bool
Inherited
inherited_from \Item::loadBy()
inherited_from \cApiArticleLanguage::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

Load data by article and language id

loadByArticleAndLanguageId(int $idart, int $idlang, bool $fetchContent) : bool
Inherited
inherited_from \cApiArticleLanguage::loadByArticleAndLanguageId()

Parameters

$idart

int

Article id

$idlang

int

Language id

$fetchContent

bool

Flag to fetch content

Returns

booltrue on success, otherwhise false

Loads an item by colums/fields from the database.

loadByMany(array $aAttributes, bool $bSafe) : bool
Inherited
inherited_from \Item::loadByMany()
inherited_from \cApiArticleLanguage::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()
inherited_from \cApiArticleLanguage::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()
inherited_from \cApiArticleLanguage::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 \cApiArticleLanguage::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

Shortcut to setField.

set(string $sField, string $mValue, bool $bSafe) 
Inherited
inherited_from \Item::set()
inherited_from \cApiArticleLanguage::set()

Parameters

$sField

string

Field name

$mValue

string

Value to set

$bSafe

bool

Flag to run defined inFilter on passed value

Userdefined setter for article language fields.

setField(string $name, mixed $value, bool $bSafe) 
Inherited
inherited_from \cApiArticleLanguage::setField()

Parameters

$name

string

$value

mixed

$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 \cApiArticleLanguage::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 \cApiArticleLanguage::setProperty()

Parameters

$sType

string

Specifies the type

$sName

string

Specifies the name

$mValue

mixed

Specifies the value

Returns

bool

Stores the loaded and modified item to the database.

store() : bool
Inherited
inherited_from \Item::store()
inherited_from \cApiArticleLanguage::store()

Returns

bool

Returns current item data as an assoziative array.

toArray() : array | false
Inherited
inherited_from \Item::toArray()
inherited_from \cApiArticleLanguage::toArray()

Returns

arrayfalse

Returns current item data as an object.

toObject() : \stdClass | false
Inherited
inherited_from \Item::toObject()
inherited_from \cApiArticleLanguage::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()
inherited_from \cApiArticleLanguage::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

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 \cApiArticleLanguage::_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

Load the articles content and stores it in the 'content' property of the article object.

_getArticleContent() : void
Inherited

$article->content[type][number] = value;

inherited_from \cApiArticleLanguage::_getArticleContent()

Extract 'idartlang' for a specified 'idart' and 'idlang'

_getIdArtLang(int $idart, int $idlang) : int
Inherited
inherited_from \cApiArticleLanguage::_getIdArtLang()

Parameters

$idart

int

Article id

$idlang

int

Language id

Returns

intLanguage dependant article id

Returns properties instance, instantiates it if not done before.

_getPropertiesCollectionInstance() : \cApiPropertyCollection
Inherited
inherited_from \cItemBaseAbstract::_getPropertiesCollectionInstance()
inherited_from \Item::_getPropertiesCollectionInstance()
inherited_from \cApiArticleLanguage::_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()
inherited_from \cApiArticleLanguage::_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()
inherited_from \cApiArticleLanguage::_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()
inherited_from \cApiArticleLanguage::_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 \cApiArticleLanguage::_outFilter()

Parameters

$mData

mixed

Data to filter

Returns

mixedFiltered data

_setMetaObject() 

_setMetaObject($sObjectName) 
Inherited
inherited_from \Item::_setMetaObject()
inherited_from \cApiArticleLanguage::_setMetaObject()

Parameters

$sObjectName

 Properties

 

$content : array
Inherited
inherited_from \cApiArticleLanguage::$$content
 

$primaryKey : string
Inherited
inherited_from \cItemBaseAbstract::$$primaryKey
inherited_from \Item::$$primaryKey
inherited_from \cApiArticleLanguage::$$primaryKey
 

$tab : array
Inherited
inherited_from \cApiArticleLanguage::$$tab
 

$values : array
Inherited
inherited_from \Item::$$values
inherited_from \cApiArticleLanguage::$$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 \cApiArticleLanguage::$$virgin
 

$_arrInFilters : array
Inherited
inherited_from \Item::$$_arrInFilters
inherited_from \cApiArticleLanguage::$$_arrInFilters
 

$_arrOutFilters : array
Inherited
inherited_from \Item::$$_arrOutFilters
inherited_from \cApiArticleLanguage::$$_arrOutFilters
 

$_className : string
Inherited
inherited_from \cItemBaseAbstract::$$_className
inherited_from \Item::$$_className
inherited_from \cApiArticleLanguage::$$_className
 

$_metaObject : string
Inherited
inherited_from \Item::$$_metaObject
inherited_from \cApiArticleLanguage::$$_metaObject
 

$_oCache : \cItemCache
Inherited
inherited_from \cItemBaseAbstract::$$_oCache
inherited_from \Item::$$_oCache
inherited_from \cApiArticleLanguage::$$_oCache
 

$_settings : array
Inherited
inherited_from \cItemBaseAbstract::$$_settings
inherited_from \Item::$$_settings
inherited_from \cApiArticleLanguage::$$_settings
 

$cache : array
Inherited
inherited_from \cItemBaseAbstract::$$cache
inherited_from \Item::$$cache
inherited_from \cApiArticleLanguage::$$cache
 

$db : \cDb
Inherited
inherited_from \cItemBaseAbstract::$$db
inherited_from \Item::$$db
inherited_from \cApiArticleLanguage::$$db
 

$lasterror : string
Inherited
inherited_from \cItemBaseAbstract::$$lasterror
inherited_from \Item::$$lasterror
inherited_from \cApiArticleLanguage::$$lasterror
 

$lifetime : int
Inherited
inherited_from \cItemBaseAbstract::$$lifetime
inherited_from \Item::$$lifetime
inherited_from \cApiArticleLanguage::$$lifetime
 

$modifiedValues : array
Inherited
inherited_from \Item::$$modifiedValues
inherited_from \cApiArticleLanguage::$$modifiedValues
 

$oldPrimaryKey : string
Inherited
inherited_from \Item::$$oldPrimaryKey
inherited_from \cApiArticleLanguage::$$oldPrimaryKey
 

$properties : \cApiPropertyCollection
Inherited
inherited_from \cItemBaseAbstract::$$properties
inherited_from \Item::$$properties
inherited_from \cApiArticleLanguage::$$properties
 

$secondDb : \cDb
Inherited
inherited_from \cItemBaseAbstract::$$secondDb
inherited_from \Item::$$secondDb
inherited_from \cApiArticleLanguage::$$secondDb
 

$table : string
Inherited
inherited_from \cItemBaseAbstract::$$table
inherited_from \Item::$$table
inherited_from \cApiArticleLanguage::$$table
 

$_callbacks : array
Inherited
inherited_from \cGenericDb::$$_callbacks
inherited_from \cItemBaseAbstract::$$_callbacks
inherited_from \Item::$$_callbacks
inherited_from \cApiArticleLanguage::$$_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 \cApiArticleLanguage::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 \cApiArticleLanguage::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 \cApiArticleLanguage::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 \cApiArticleLanguage::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 \cApiArticleLanguage::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 \cApiArticleLanguage::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 \cApiArticleLanguage::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 \cApiArticleLanguage::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 \cApiArticleLanguage::STORE_SUCCESS