Load the articles content and stores it in the 'content' property of the article object.
loadArticleContent()
$article->content[type][number] = value;
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
| package | CONTENIDO API |
|---|---|
| subpackage | Model |
| copyright | four for business AG |
Item($sTable, $sPrimaryKey, $iLifetime)
| inherited_from | \Item::Item() |
|---|
__construct(mixed $mId, bool $fetchContent) : void
mixedSpecifies the ID of item to load
boolFlag to fetch content
\cInvalidArgumentException |
If table name or primary key is not set |
|---|
_inFilter(mixed $mData) : mixed
| see | \setFilters |
|---|---|
| inherited_from | \Item::_inFilter() |
mixedData to filter
mixedFiltered datacApiArticleLanguage($mId)
| deprecated | [2011-03-15] Old constructor function for downwards compatibility |
|---|
deleteProperty(string $sType, string $sName) : bool
| inherited_from | \Item::deleteProperty() |
|---|
stringSpecifies the type
stringSpecifies the name
booldeletePropertyById(int $idprop) : bool
| inherited_from | \Item::deletePropertyById() |
|---|
intId of property
boolescape(string $sString) : string
| inherited_from | \cItemBaseAbstract::escape() |
|---|---|
| inherited_from | \Item::escape() |
stringThe string to escape
stringEscaped stringget(string $sField) : mixed
| inherited_from | \Item::get() |
|---|
stringSpecifies the field to retrieve
mixedValue of the fieldgetContent(string $type, int | null $id) : string
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
stringCMS_TYPE - Legal cms type string
intnullId of the content
stringarray datagetContentTypes() : array
getField(string $name) : string
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
string
stringValue of propertygetLink() : string
stringlinkgetMetaObject()
| inherited_from | \Item::getMetaObject() |
|---|
getProperty(string $sType, string $sName) : mixed
| inherited_from | \Item::getProperty() |
|---|
stringSpecifies the type
stringSpecifies the name
mixedValue of the given property or falseisLoaded() : bool
| inherited_from | \Item::isLoaded() |
|---|
boolloadArticleContent()
$article->content[type][number] = value;
loadBy(string $sField, mixed $mValue, bool $bSafe) : bool
| inherited_from | \Item::loadBy() |
|---|
stringSpecifies the field
mixedSpecifies the value
boolUse inFilter or not
\cException |
if more than one item has been found matching the given arguments |
|---|
boolTrue if the load was successfulloadByArticleAndLanguageId(int $idart, int $idlang, bool $fetchContent) : bool
intArticle id
intLanguage id
boolFlag to fetch content
booltrue on success, otherwhise falseloadByMany(array $aAttributes, bool $bSafe) : bool
| inherited_from | \Item::loadByMany() |
|---|
arrayassociative array with field / value pairs
boolUse inFilter or not
\cException |
if more than one item could be found matching the given arguments |
|---|
boolTrue if the load was successfulloadByPrimaryKey(string $mValue) : bool
| inherited_from | \Item::loadByPrimaryKey() |
|---|
stringSpecifies the primary key value
boolTrue if the load was successfulloadByRecordSet(array $aRecordSet)
| inherited_from | \Item::loadByRecordSet() |
|---|
arrayThe recordset of the item
register(string $event, mixed $callback, mixed $class) : void
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() |
stringCallback event, must be a valid value of a cGenericDb event constant
mixedCallback to register
mixedClass name for registering callback (can be string of array with names of the concrete Item classes)
\cInvalidArgumentException |
if event or class are not set or the callback is not callable |
|---|
set(string $sField, string $mValue, bool $bSafe)
| inherited_from | \Item::set() |
|---|
stringField name
stringValue to set
boolFlag to run defined inFilter on passed value
setField(string $name, mixed $value, bool $bSafe)
string
mixed
boolFlag to run defined inFilter on passed value
setFilters(array $aInFilters, array $aOutFilters) : void
Examples:
$obj->setFilters(array('addslashes'), array('stripslashes'));
$obj->setFilters(array('htmlencode', 'addslashes'), array('stripslashes', 'htmlencode'));
| inherited_from | \Item::setFilters() |
|---|
arrayArray with function names
arrayArray with function names
setProperty(string $sType, string $sName, mixed $mValue) : bool
| inherited_from | \Item::setProperty() |
|---|
stringSpecifies the type
stringSpecifies the name
mixedSpecifies the value
boolstore() : bool
| inherited_from | \Item::store() |
|---|
booltoArray() : array | false
| inherited_from | \Item::toArray() |
|---|
arrayfalse
unregister(string $event, mixed $class) : void
Example: cGenericDb::unregister(cGenericDb::CREATE_SUCCESS, 'cApiArticle');
| inherited_from | \cGenericDb::unregister() |
|---|---|
| inherited_from | \cItemBaseAbstract::unregister() |
| inherited_from | \Item::unregister() |
stringCallback event, must be a valid value of a cGenericDb event constant
mixedClass name for unregistering callback (can be string of array with names of the concrete Item classes)
\cInvalidArgumentException |
if the event or the class are not set |
|---|
_executeCallbacks(string $event, string $class, array $arguments) : void
| inherited_from | \cGenericDb::_executeCallbacks() |
|---|---|
| inherited_from | \cItemBaseAbstract::_executeCallbacks() |
| inherited_from | \Item::_executeCallbacks() |
stringCallback event, must be a valid value of a cGenericDb event constant
stringClass name for executing callback
arrayArguments to pass to the callback function
\cInvalidArgumentException |
if the event or class is not set |
|---|
_getArticleContent() : void
$article->content[type][number] = value;
_getIdArtLang(int $idart, int $idlang) : int
intArticle id
intLanguage id
intLanguage dependant article id_getPropertiesCollectionInstance() : \cApiPropertyCollection
| inherited_from | \cItemBaseAbstract::_getPropertiesCollectionInstance() |
|---|---|
| inherited_from | \Item::_getPropertiesCollectionInstance() |
_getSecondDBInstance() : \cDb
| inherited_from | \cItemBaseAbstract::_getSecondDBInstance() |
|---|---|
| inherited_from | \Item::_getSecondDBInstance() |
_loadByWhereClause(string $sWhere) : bool
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() |
|---|
stringThe where clause like 'idart = 123 AND idlang = 1'
\cException |
if more than one item could be found matching the given where clause |
|---|
boolTrue if the load was successful_onLoad() : void
Inherited classes should override this function if desired.
| inherited_from | \Item::_onLoad() |
|---|
_outFilter(mixed $mData) : mixed
| see | \setFilters |
|---|---|
| inherited_from | \Item::_outFilter() |
mixedData to filter
mixedFiltered data_setMetaObject($sObjectName)
| inherited_from | \Item::_setMetaObject() |
|---|
$content : array
$primaryKey : string
| inherited_from | \cItemBaseAbstract::$$primaryKey |
|---|---|
| inherited_from | \Item::$$primaryKey |
$tab : array
$values : array
| inherited_from | \Item::$$values |
|---|
$virgin : bool
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_from | \Item::$$_arrInFilters |
|---|
$_arrOutFilters : array
| inherited_from | \Item::$$_arrOutFilters |
|---|
$_className : string
| inherited_from | \cItemBaseAbstract::$$_className |
|---|---|
| inherited_from | \Item::$$_className |
$_oCache : \cItemCache
| inherited_from | \cItemBaseAbstract::$$_oCache |
|---|---|
| inherited_from | \Item::$$_oCache |
$_settings : array
| inherited_from | \cItemBaseAbstract::$$_settings |
|---|---|
| inherited_from | \Item::$$_settings |
$cache : array
| inherited_from | \cItemBaseAbstract::$$cache |
|---|---|
| inherited_from | \Item::$$cache |
$lasterror : string
| inherited_from | \cItemBaseAbstract::$$lasterror |
|---|---|
| inherited_from | \Item::$$lasterror |
$lifetime : int
| inherited_from | \cItemBaseAbstract::$$lifetime |
|---|---|
| inherited_from | \Item::$$lifetime |
$modifiedValues : array
| inherited_from | \Item::$$modifiedValues |
|---|
$oldPrimaryKey : string
| inherited_from | \Item::$$oldPrimaryKey |
|---|
$properties : \cApiPropertyCollection
| inherited_from | \cItemBaseAbstract::$$properties |
|---|---|
| inherited_from | \Item::$$properties |
$secondDb : \cDb
| inherited_from | \cItemBaseAbstract::$$secondDb |
|---|---|
| inherited_from | \Item::$$secondDb |
$table : string
| inherited_from | \cItemBaseAbstract::$$table |
|---|---|
| inherited_from | \Item::$$table |
$_callbacks : array
| inherited_from | \cGenericDb::$$_callbacks |
|---|---|
| inherited_from | \cItemBaseAbstract::$$_callbacks |
| inherited_from | \Item::$$_callbacks |
CREATE_BEFORE
Expected parameters for callback: none
| inherited_from | \cGenericDb::CREATE_BEFORE |
|---|---|
| inherited_from | \cItemBaseAbstract::CREATE_BEFORE |
| inherited_from | \Item::CREATE_BEFORE |
CREATE_FAILURE
Expected parameters for callback: none
| inherited_from | \cGenericDb::CREATE_FAILURE |
|---|---|
| inherited_from | \cItemBaseAbstract::CREATE_FAILURE |
| inherited_from | \Item::CREATE_FAILURE |
CREATE_SUCCESS
Expected parameters for callback: ID of created item
| inherited_from | \cGenericDb::CREATE_SUCCESS |
|---|---|
| inherited_from | \cItemBaseAbstract::CREATE_SUCCESS |
| inherited_from | \Item::CREATE_SUCCESS |
DELETE_BEFORE
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 |
DELETE_FAILURE
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 |
DELETE_SUCCESS
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 |
STORE_BEFORE
Expected parameters for callback: Item instance
| inherited_from | \cGenericDb::STORE_BEFORE |
|---|---|
| inherited_from | \cItemBaseAbstract::STORE_BEFORE |
| inherited_from | \Item::STORE_BEFORE |
STORE_FAILURE
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 |
STORE_SUCCESS
Expected parameters for callback: Item instance
| inherited_from | \cGenericDb::STORE_SUCCESS |
|---|---|
| inherited_from | \cItemBaseAbstract::STORE_SUCCESS |
| inherited_from | \Item::STORE_SUCCESS |