CONTENIDO_4.9.0 beta1
Back to top  

Content type CMS_LINKDESCR which displays the link description.

package Core
subpackage Content Type

 Methods

Initialises class attributes and handles store events.

__construct(string $rawSettings, integer $id, array $contentTypes) : void

Parameters

$rawSettings

string

the raw settings in an XML structure or as plaintext

$id

integer

ID of the content type, e.g. 3 if CMS_DATE[3] is used

$contentTypes

array

array containing the values of all content types

Builds an array with category information.

buildCategoryArray($level, $parentid) : array
Inherited
inherited_from \cContentTypeLinkeditor::buildCategoryArray()

Parameters

$level

$parentid

Returns

arraywith directory information

Builds an array with directory information from the given upload path.

buildDirectoryList(string $uploadPath) : array
Inherited
inherited_from \cContentTypeAbstract::buildDirectoryList()
inherited_from \cContentTypeAbstractTabbed::buildDirectoryList()
inherited_from \cContentTypeLinkeditor::buildDirectoryList()

Parameters

$uploadPath

string

path to upload directory (optional, default: root upload path of client)

Returns

arraywith directory information (keys: name, path, sub)

Generate a select box for all articles of the given idcat.

generateArticleSelect(integer $idCat) : string
Inherited
inherited_from \cContentTypeLinkeditor::generateArticleSelect()

Parameters

$idCat

integer

idcat of the category from which all articles should be shown

Returns

stringrendered cHTMLSelectElement

Generates a directory list from the given directory information (which is typically built by {@link cContentTypeAbstract::buildDirectoryList}).

generateDirectoryList(array $dirs) : string
Inherited
inherited_from \cContentTypeAbstract::generateDirectoryList()
inherited_from \cContentTypeAbstractTabbed::generateDirectoryList()
inherited_from \cContentTypeLinkeditor::generateDirectoryList()

Parameters

$dirs

array

directory information

Returns

stringHTML code showing a directory list

Generates the code which should be shown if this content type is edited.

generateEditCode() : string

Returns

stringescaped HTML code which should be shown if content type is edited

Generates the code which should be shown if this content type is shown in the frontend.

generateViewCode() : string

Returns

stringescaped HTML code which sould be shown if content type is shown in frontend

Generates a category list from the given category information (which is typically built by {@link cContentTypeLinkeditor::buildCategoryArray}).

getCategoryList(array $categories) : string
Inherited
inherited_from \cContentTypeLinkeditor::getCategoryList()

Parameters

$categories

Returns

stringHTML code showing a directory list

Generates a select box for the manual files.

getUploadFileSelect(string $directoryPath) : string
Inherited
inherited_from \cContentTypeLinkeditor::getUploadFileSelect()

Parameters

$directoryPath

string

to directory of the files

Returns

stringcHTMLSelectElement

Since the content type code is evaled by php, the code has to be encoded.

_encodeForOutput(string $code) : string
Inherited
inherited_from \cContentTypeAbstract::_encodeForOutput()
inherited_from \cContentTypeAbstractTabbed::_encodeForOutput()
inherited_from \cContentTypeLinkeditor::_encodeForOutput()

Parameters

$code

string

code to encode

Returns

stringencoded code

Generates the code for the action buttons (save and cancel).

_generateActionCode() : string
Inherited
inherited_from \cContentTypeAbstractTabbed::_generateActionCode()
inherited_from \cContentTypeLinkeditor::_generateActionCode()

Returns

string- the encoded code for the action buttons

Generates the actual link depending on the link type.

_generateHref() : string
Inherited
inherited_from \cContentTypeLinkeditor::_generateHref()

Returns

stringthe generated link

Generates the encoded code for the tab menu.

_generateTabMenuCode(array $tabs) : string
Inherited
inherited_from \cContentTypeAbstractTabbed::_generateTabMenuCode()
inherited_from \cContentTypeLinkeditor::_generateTabMenuCode()

Parameters

$tabs

array

associative array mapping the tab IDs to the tab names

Returns

string- the encoded code for the tab menu

Checks whether the directory defined by the given directory information is the currently active directory.

_isActiveDirectory(array $dirData) : boolean
Inherited

Overwrite in subclasses if you use getDirectoryList!

inherited_from \cContentTypeLinkeditor::_isActiveDirectory()

Parameters

$dirData

array

directory information

Returns

booleanwhether the directory is the currently active directory

Checks whether the given $subDir is a subdirectory of the given $dir.

_isSubdirectory(string $subDir, string $dir) : boolean
Inherited
inherited_from \cContentTypeAbstract::_isSubdirectory()
inherited_from \cContentTypeAbstractTabbed::_isSubdirectory()
inherited_from \cContentTypeLinkeditor::_isSubdirectory()

Parameters

$subDir

string

the potential subdirectory

$dir

string

the parent directory

Returns

booleanwhether the given $subDir is a subdirectory of $dir

Reads all settings from the $_rawSettings attribute (XML or plaintext) and stores them in the $_settings attribute (associative array or plaintext).

_readSettings() : void
Inherited
inherited_from \cContentTypeAbstract::_readSettings()
inherited_from \cContentTypeAbstractTabbed::_readSettings()
inherited_from \cContentTypeLinkeditor::_readSettings()

Checks whether the directory defined by the given directory information should be shown expanded.

_shouldDirectoryBeExpanded(array $dirData) : boolean
Inherited

Overwrite in subclasses if you use getDirectoryList!

inherited_from \cContentTypeLinkeditor::_shouldDirectoryBeExpanded()

Parameters

$dirData

array

directory information

Returns

booleanwhether the directory should be shown expanded

Stores all values from the $_POST array in the $_settings attribute (associative array) and saves them in the database (XML).

_storeSettings() : void
Inherited
inherited_from \cContentTypeAbstract::_storeSettings()
inherited_from \cContentTypeAbstractTabbed::_storeSettings()
inherited_from \cContentTypeLinkeditor::_storeSettings()

Generates code for the basic settings "tab" in which the link title and target can be specified.

_generateBasicSettings() : string
Inherited

This tab is always shown.

inherited_from \cContentTypeLinkeditor::_generateBasicSettings()

Returns

string- the code for the basic settings tab

Generates code for the external link tab in which links to external sites can be specified.

_generateTabExternal() : string
Inherited
inherited_from \cContentTypeLinkeditor::_generateTabExternal()

Returns

string- the code for the external link tab

Generates code for the link to file tab in which links to files can be specified.

_generateTabFile() : string
Inherited
inherited_from \cContentTypeLinkeditor::_generateTabFile()

Returns

string- the code for the link to file tab

Generates code for the internal link tab in which links to internal sites can be specified.

_generateTabInternal() : string
Inherited
inherited_from \cContentTypeLinkeditor::_generateTabInternal()

Returns

string- the code for the internal link tab

Computes all active idcats.

_getActiveIdcats() : array
Inherited
inherited_from \cContentTypeLinkeditor::_getActiveIdcats()

Returns

arraycontaining all active idcats

Computes all parent idcats of the given idcat and returns them.

_getParentIdcats(integer $idcat, array $idcats) : array
Inherited
inherited_from \cContentTypeLinkeditor::_getParentIdcats()

Parameters

$idcat

integer

the current idcat

$idcats

array

the array of idcats to which all idcats should be added

Returns

arraythe given idcats array with the given idcat and all parent idcats

 Properties

 

$_cfg : array
Inherited
inherited_from \cContentTypeAbstract::$$_cfg
inherited_from \cContentTypeAbstractTabbed::$$_cfg
inherited_from \cContentTypeLinkeditor::$$_cfg
 

$_cfgClient : array
Inherited
inherited_from \cContentTypeAbstract::$$_cfgClient
inherited_from \cContentTypeAbstractTabbed::$$_cfgClient
inherited_from \cContentTypeLinkeditor::$$_cfgClient
 

$_client : integer
Inherited
inherited_from \cContentTypeAbstract::$$_client
inherited_from \cContentTypeAbstractTabbed::$$_client
inherited_from \cContentTypeLinkeditor::$$_client
 

$_contentTypes : array
Inherited
inherited_from \cContentTypeAbstract::$$_contentTypes
inherited_from \cContentTypeAbstractTabbed::$$_contentTypes
inherited_from \cContentTypeLinkeditor::$$_contentTypes
 

$_formFields : array
Inherited
inherited_from \cContentTypeAbstract::$$_formFields
inherited_from \cContentTypeAbstractTabbed::$$_formFields
inherited_from \cContentTypeLinkeditor::$$_formFields
 

$_id : integer
Inherited

3 if CMS_TEASER[3] is used.

inherited_from \cContentTypeAbstract::$$_id
inherited_from \cContentTypeAbstractTabbed::$$_id
inherited_from \cContentTypeLinkeditor::$$_id
 

$_idArt : integer
Inherited
inherited_from \cContentTypeAbstract::$$_idArt
inherited_from \cContentTypeAbstractTabbed::$$_idArt
inherited_from \cContentTypeLinkeditor::$$_idArt
 

$_idArtLang : integer
Inherited
inherited_from \cContentTypeAbstract::$$_idArtLang
inherited_from \cContentTypeAbstractTabbed::$$_idArtLang
inherited_from \cContentTypeLinkeditor::$$_idArtLang
 

$_idCat : integer
Inherited
inherited_from \cContentTypeAbstract::$$_idCat
inherited_from \cContentTypeAbstractTabbed::$$_idCat
inherited_from \cContentTypeLinkeditor::$$_idCat
 

$_lang : integer
Inherited
inherited_from \cContentTypeAbstract::$$_lang
inherited_from \cContentTypeAbstractTabbed::$$_lang
inherited_from \cContentTypeLinkeditor::$$_lang
 

$_prefix : string
Inherited

'teaser'.

inherited_from \cContentTypeAbstract::$$_prefix
inherited_from \cContentTypeAbstractTabbed::$$_prefix
inherited_from \cContentTypeLinkeditor::$$_prefix
 

$_rawSettings : string
Inherited
inherited_from \cContentTypeAbstract::$$_rawSettings
inherited_from \cContentTypeAbstractTabbed::$$_rawSettings
inherited_from \cContentTypeLinkeditor::$$_rawSettings
 

$_session : \Contenido_Session
Inherited
inherited_from \cContentTypeAbstract::$$_session
inherited_from \cContentTypeAbstractTabbed::$$_session
inherited_from \cContentTypeLinkeditor::$$_session
 

$_settings : array
Inherited
inherited_from \cContentTypeAbstract::$$_settings
inherited_from \cContentTypeAbstractTabbed::$$_settings
inherited_from \cContentTypeLinkeditor::$$_settings
 

$_settingsType : string
Inherited
inherited_from \cContentTypeAbstract::$$_settingsType
inherited_from \cContentTypeAbstractTabbed::$$_settingsType
inherited_from \cContentTypeLinkeditor::$$_settingsType
 

$_type : string
Inherited

'CMS_TEASER'.

inherited_from \cContentTypeAbstract::$$_type
inherited_from \cContentTypeAbstractTabbed::$$_type
inherited_from \cContentTypeLinkeditor::$$_type
 

$_uploadPath : string
Inherited
inherited_from \cContentTypeAbstract::$$_uploadPath
inherited_from \cContentTypeAbstractTabbed::$$_uploadPath
inherited_from \cContentTypeLinkeditor::$$_uploadPath
 

$_useXHTML : boolean
Inherited
inherited_from \cContentTypeAbstract::$$_useXHTML
inherited_from \cContentTypeAbstractTabbed::$$_useXHTML
inherited_from \cContentTypeLinkeditor::$$_useXHTML

 Constants

 

Constant defining that the settings should be interpreted as plaintext.

SETTINGS_TYPE_PLAINTEXT 
Inherited
inherited_from \cContentTypeAbstract::SETTINGS_TYPE_PLAINTEXT
inherited_from \cContentTypeAbstractTabbed::SETTINGS_TYPE_PLAINTEXT
inherited_from \cContentTypeLinkeditor::SETTINGS_TYPE_PLAINTEXT
 

Constant defining that the settings should be interpreted as XML.

SETTINGS_TYPE_XML 
Inherited
inherited_from \cContentTypeAbstract::SETTINGS_TYPE_XML
inherited_from \cContentTypeAbstractTabbed::SETTINGS_TYPE_XML
inherited_from \cContentTypeLinkeditor::SETTINGS_TYPE_XML