Class cContentTypeLinkeditor

Content type CMS_LINKEDITOR which lets the editor select a link.

cContentTypeLinkeditor

Direct known subclasses

cContentTypeLink, cContentTypeLinkdescr, cContentTypeLinktarget

Package: Core\ContentType
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Fulai Zhang
Author: Simon Sprankel
Located at classes/content_types/class.content.type.linkeditor.php

Methods summary
`public`	# `__construct( string $rawSettings, integer $id, array $contentTypes )` Constructor to create an instance of this class. Constructor to create an instance of this class. Initialises class attributes and handles store events. Parameters `$rawSettings` `string` $rawSettings the raw settings in an XML structure or as plaintext `$id` `integer` $id ID of the content type, e.g. 3 if CMS_DATE[3] is used `$contentTypes` `array` $contentTypes array containing the values of all content types Throws `cDbException` Overrides `cContentTypeAbstract::__construct()`
`public string`	# `getLinkType( )` Returns the link type ('external', 'internal' or 'file') Returns the link type ('external', 'internal' or 'file') Returns `string`
`public string`	# `getTitle( )` Returns the link title Returns the link title Returns `string`
`public string`	# `getTarget( )` Returns the link target (e.g. "_blank") Returns the link target (e.g. "_blank") Returns `string`
`public string`	# `getLink( )` Returns the href of the link Returns the href of the link Returns `string` Throws `cInvalidArgumentException`
`public string`	# `getFilename( )` Returns `string`
`public array`	# `getConfiguredData( )` Returns array with configured data (keys: type, externallink, title, newwindow, idart, filename). Additionally the key href contains the actual hyperreference. Returns array with configured data (keys: type, externallink, title, newwindow, idart, filename). Additionally the key href contains the actual hyperreference. Returns `array` Throws `cInvalidArgumentException`
`public string`	# `generateViewCode( )` Generates the code which should be shown if this content type is shown in the frontend. Generates the code which should be shown if this content type is shown in the frontend. Returns `string` escaped HTML code which sould be shown if content type is shown in frontend Throws `cInvalidArgumentException`
`protected string`	# `_generateHref( )` Generates the actual link depending on the link type. Generates the actual link depending on the link type. Returns `string` the generated link Throws `cInvalidArgumentException`
`public string`	# `generateEditCode( )` Generates the code which should be shown if this content type is edited. Generates the code which should be shown if this content type is edited. * Returns `string` escaped HTML code which should be shown if content type is edited Throws `cDbException` `cInvalidArgumentException`
`private string`	# `_generateTabExternal( )` Generates code for the external link tab in which links to external sites can be specified. Generates code for the external link tab in which links to external sites can be specified. Returns `string` the code for the external link tab
`private string`	# `_generateBasicSettings( )` Generates code for the basic settings "tab" in which the link title and target can be specified. Generates code for the basic settings "tab" in which the link title and target can be specified. This tab is always shown. Returns `string` the code for the basic settings tab
`private string`	# `_generateTabInternal( )` Generates code for the internal link tab in which links to internal sites can be specified. Generates code for the internal link tab in which links to internal sites can be specified. Returns `string` the code for the internal link tab Throws `cDbException`
`public array`	# `buildCategoryArray( integer $level = 0, integer $parentid = 0 )` Builds an array with category information. Builds an array with category information. Parameters `$level` `integer` $level [optional] `$parentid` `integer` $parentid [optional] Returns `array` with directory information Throws `cDbException`
`public string`	# `getCategoryList( array $categories )` Generates a category list from the given category information (which is typically built by `cContentTypeLinkeditor::buildCategoryArray()`). Generates a category list from the given category information (which is typically built by `cContentTypeLinkeditor::buildCategoryArray()`). Parameters `$categories` `array` $categories directory information Returns `string` HTML code showing a directory list Throws `cDbException` `cInvalidArgumentException`
`public array`	# `getActiveIdcats( )` Computes all active idcats. Computes all active idcats. Returns `array` containing all active idcats Throws `cDbException`
`private array`	# `_getParentIdcats( integer $idcat, array $idcats = array() )` Computes all parent idcats of the given idcat and returns them. Computes all parent idcats of the given idcat and returns them. Parameters `$idcat` `integer` $idcat the current idcat `$idcats` `array` $idcats [optional] the array of idcats to which all idcats should be added Returns `array` the given idcats array with the given idcat and all parent idcats
`public string`	# `generateArticleSelect( integer $idCat = 0 )` Generate a select box for all articles of the given idcat. Generate a select box for all articles of the given idcat. Parameters `$idCat` `integer` $idCat [optional] idcat of the category from which all articles should be shown Returns `string` rendered cHTMLSelectElement Throws `cDbException`
`private string`	# `_generateTabFile( )` Generates code for the link to file tab in which links to files can be specified. Generates code for the link to file tab in which links to files can be specified. Returns `string` the code for the link to file tab Throws `cInvalidArgumentException`
`public string\|integer`	# `getUploadFileSelect( string $directoryPath = '', boolean $isEmptySelect = false )` Generates a select box for the manual files. Generates a select box for the manual files. Parameters `$directoryPath` `string` $directoryPath [optional] to directory of the files `$isEmptySelect` `boolean` $isEmptySelect Returns `string\|integer` SuppressWarnings docBlocks
`protected boolean`	# `_isActiveDirectory( array $dirData )` Checks whether the directory defined by the given directory information is the currently active directory. Checks whether the directory defined by the given directory information is the currently active directory. Overwrite in subclasses if you use getDirectoryList! Parameters `$dirData` `array` $dirData directory information Returns `boolean` whether the directory is the currently active directory Overrides `cContentTypeAbstract::_isActiveDirectory()`
`protected boolean`	# `_shouldDirectoryBeExpanded( array $dirData )` Checks whether the directory defined by the given directory information should be shown expanded. Checks whether the directory defined by the given directory information should be shown expanded. Overwrite in subclasses if you use getDirectoryList! Parameters `$dirData` `array` $dirData directory information Returns `boolean` whether the directory should be shown expanded Overrides `cContentTypeAbstract::_shouldDirectoryBeExpanded()`

Methods inherited from cContentTypeAbstractTabbed
`_generateActionCode(), _generateTabMenuCode(), _getRawSettings()`

Methods inherited from cContentTypeAbstract
`__toString(), _encodeForOutput(), _isSubdirectory(), _readSettings(), _storeSettings(), buildDirectoryList(), generateDirectoryList(), getConfiguration(), isWysiwygCompatible()`

Constants inherited from cContentTypeAbstract
`SETTINGS_TYPE_PLAINTEXT, SETTINGS_TYPE_XML`

Properties summary
`protected string`	`$_dirname`	`''`	#

Properties inherited from cContentTypeAbstract
`$_cfg, $_cfgClient, $_client, $_contentTypes, $_formFields, $_id, $_idArt, $_idArtLang, $_idCat, $_lang, $_prefix, $_rawSettings, $_session, $_settings, $_settingsType, $_type, $_uploadPath, $_useXHTML`

Packages

Classes

Class cContentTypeLinkeditor

Direct known subclasses

Parameters

Throws

Overrides

Returns

Returns

Returns

Returns

Throws

Returns

Returns

Throws

Returns

Throws

Returns

Throws

Returns

Throws

Returns

Returns

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Returns

Throws

Parameters

Returns

Parameters

Returns

Throws

Returns

Throws

Parameters

Returns

SuppressWarnings

Parameters

Returns

Overrides

Parameters

Returns

Overrides