Class cApiArticleLanguageVersion

CONTENIDO API - Article Version Object

This object represents a CONTENIDO article version

Create object with $obj = new cApiArticleLanguageVersion(idartlangversion); or with $obj = new cApiArticleLanguageVersion(); $obj->loadByArticleLanguageIdAndVersion(idartlang, version);

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

List of article version 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 version - Version number iscurrentversion - 0 = false, 1 = true 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₀₁ - Free to use free_use₀₂ - Free to use free_use₀₃ - 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 version 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

cGenericDb

cItemBaseAbstract

Item

cApiArticleLanguage

cApiArticleLanguageVersion

Package: Core\GenericDB\Model
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Jann Dieckmann
Located at classes/contenido/class.articlelanguageversion.php

Methods summary
`public`	# `__construct( mixed $id = false, boolean $fetchContent = false )` Constructor to create an instance of this class. Constructor to create an instance of this class. Parameters `$id` `mixed` $id Specifies the ID of item to load `$fetchContent` `boolean` $fetchContent Flag to fetch content Throws `cDbException` `cException` Overrides `cApiArticleLanguage::__construct()`
`public`	# `markAsCurrentVersion( mixed $isCurrentVersion )` Set iscurrentversion = 0 in the current version and set iscurrentversion = 1 in this version Set iscurrentversion = 0 in the current version and set iscurrentversion = 1 in this version Parameters `$isCurrentVersion` `mixed` $isCurrentVersion Throws `cDbException` `cException` `cInvalidArgumentException`
`public`	# `markAsCurrent( string $type = '' )` Set this ArticleVersion with its ContentVersions as current: Copy data from this ArticleLanguageVersion to ArticleLanguage Update Contents in ArticleLanguage Set property iscurrentversion = 1 in this ArticleLanguageVersion and 0 in the current ArticleLanguageVersions Set this ArticleVersion with its ContentVersions as current: Copy data from this ArticleLanguageVersion to ArticleLanguage Update Contents in ArticleLanguage Set property iscurrentversion = 1 in this ArticleLanguageVersion and 0 in the current ArticleLanguageVersions Parameters `$type` `string` $type meta, content or complete Throws `cDbException` `cException` `cInvalidArgumentException`
`public`	# `markAsEditable( string $type = '' )` Create a copy of this article language version with its contents, the copy is the new editable article language version Create a copy of this article language version with its contents, the copy is the new editable article language version Parameters `$type` `string` $type meta, content or complete Throws `cDbException` `cException` Overrides `cApiArticleLanguage::markAsEditable()`
`public boolean`	# `loadByArticleLanguageIdAndVersion( integer $idArtLang, integer $version, boolean $fetchContent = false )` Load data by article language id and version Load data by article language id and version Parameters `$idArtLang` `integer` $idArtLang Article language id `$version` `integer` $version version number `$fetchContent` `boolean` $fetchContent Flag to fetch content Returns `boolean` true on success, otherwise false Throws `cDbException` `cException`
`protected integer`	# `_getIdArtLangVersion( integer $idArtLang, integer $version )` Extract 'idartlangversion' for a specified 'idartlang' and 'version' Extract 'idartlangversion' for a specified 'idartlang' and 'version' Parameters `$idArtLang` `integer` $idArtLang Article language id `$version` `integer` $version version number Returns `integer` Article language version id Throws `cDbException` `cException`
`protected`	# `_getArticleVersionContent( )` Load the articles version content and store it in the 'content' property of the article version object: $article->content[type][number] = value; Load the articles version content and store it in the 'content' property of the article version object: $article->content[type][number] = value; Throws `cDbException`
`public string\|array`	# `getContent( string $type = '', integer\|null $id = NULL )` Get content(s) from an article version. Get content(s) from an article version. 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 insensitive, you can use html or cms_HTML or CmS_HtMl. You don't need to 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 Parameters `$type` `string` $type CMS_TYPE - Legal cms type string `$id` `integer\|null` $id Id of the content Returns `string\|array` data Throws `cDbException` Overrides `cApiArticleLanguage::getContent()`

Methods inherited from cApiArticleLanguage
`_getArticleContent(), _getIdArtLang(), _loadArticleContent(), getContentObject(), getContentTypes(), getContentViewCode(), getField(), getLink(), loadArticleContent(), loadByArticleAndLanguageId(), setField()`

Methods inherited from Item
`_inFilter(), _loadByWhereClause(), _onLoad(), _resetItem(), _setMetaObject(), deleteProperty(), deletePropertyById(), get(), getMetaObject(), getProperty(), loadBy(), loadByMany(), loadByPrimaryKey(), loadByRecordSet(), outFilter(), set(), setFilters(), setProperty(), store(), toArray(), toObject()`

Methods inherited from cItemBaseAbstract
`__get(), __set(), _getPropertiesCollectionInstance(), _getSecondDBInstance(), _setLoaded(), _setPrimaryKeyName(), escape(), getPrimaryKeyName(), isLoaded()`

Methods inherited from cGenericDb
`_executeCallbacks(), register(), unregister()`

Constants inherited from cGenericDb
`CREATE_BEFORE, CREATE_FAILURE, CREATE_SUCCESS, DELETE_BEFORE, DELETE_FAILURE, DELETE_SUCCESS, STORE_BEFORE, STORE_FAILURE, STORE_SUCCESS`

Properties summary
`public array`	`$tab`		# Config array Config array
`public array`	`$content`	`NULL`	# Article Version content Article Version content

Properties inherited from Item
`$_arrInFilters, $_arrOutFilters, $_lastSQL, $_metaObject, $modifiedValues, $oldPrimaryKey, $values`

Properties inherited from cItemBaseAbstract
`$_className, $_loaded, $_oCache, $_primaryKeyName, $_settings, $db, $lasterror, $properties, $secondDb, $table`

Packages

Classes

Class cApiArticleLanguageVersion

Parameters

Throws

Overrides

Parameters

Throws

Parameters

Throws

Parameters

Throws

Overrides

Parameters

Returns

Throws

Parameters

Returns

Throws

Throws

Parameters

Returns

Throws

Overrides