Class cContentTypeFilelist

Content type CMS_FILELIST which lets the editor select some folders or files. The corresponding files are then shown in the frontend.

cContentTypeAbstract

cContentTypeAbstractTabbed

cContentTypeFilelist

Package: Core\ContentType
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Dominik Ziegler
Author: Timo Trautmann
Author: Simon Sprankel
Located at classes/content_types/class.content.type.filelist.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_TEASER[3] is used `$contentTypes` `array` $contentTypes array containing the values of all content types Throws `cDbException` `cException` Overrides `cContentTypeAbstract::__construct()`
`public static array`	# `addModuleTranslations( array $translationStrings )` Returns all translation strings for mi18n. Returns all translation strings for mi18n. Parameters `$translationStrings` `array` $translationStrings translation strings Returns `array` updated translation string
`protected`	# `_readSettings( )` Reads all settings from the $_rawSettings attribute (XML or plaintext) and stores them in the $_settings attribute (associative array or plaintext). Reads all settings from the $_rawSettings attribute (XML or plaintext) and stores them in the $_settings attribute (associative array or plaintext). Overrides `cContentTypeAbstract::_readSettings()`
`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
`public array`	# `getConfiguredFiles( )` Returns a list of configured files. Returns a list of configured files. Returns `array` Throws `cDbException` `cException`
`public string`	# `generateFileListCode( )` Function is called in edit- and viewmode in order to generate code for output. Function is called in edit- and viewmode in order to generate code for output. Returns `string` generated code Throws `cDbException` `cException` `cInvalidArgumentException`
`private array`	# `_getAllSubdirectories( string $directoryPath, array $directories )` Gets all subdirectories recursively. Gets all subdirectories recursively. Parameters `$directoryPath` `string` $directoryPath path to directory `$directories` `array` $directories already found directories Returns `array` containing all subdirectories and the initial directories
`private array`	# `_applyFileFilters( array $fileList )` Removes all files not matching the filter criteria. Removes all files not matching the filter criteria. Parameters `$fileList` `array` $fileList files which should be filtered Returns `array` with filtered files
`private boolean`	# `_applyDateFilters( array $fileStats )` Checks whether the file passes the date filters. Checks whether the file passes the date filters. Parameters `$fileStats` `array` $fileStats file information Returns `boolean` whether the file passes the date filters
`private`	# `_fillFileListTemplateEntry( array $fileData, cTemplate & $template )` Method to fill single entry (file) of the file list. Method to fill single entry (file) of the file list. Parameters `$fileData` `array` $fileData information about the file `$template` `cTemplate` $template reference to the used template object
`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 `cInvalidArgumentException`
`private string`	# `_generateTabDirectories( )` Generates code for the directories tab. Generates code for the directories tab. Returns `string` the code for the directories tab Throws `cInvalidArgumentException`
`private string`	# `_generateTabGeneral( )` Generates code for the general tab. Generates code for the general tab. Returns `string` the code for the general link tab Throws `cInvalidArgumentException`
`private string`	# `_generateStyleSelect( )` Generates a select box containing the filelist styles. Generates a select box containing the filelist styles. Returns `string` rendered cHTMLSelectElement
`private string`	# `_generateSortSelect( )` Generates a select box containing the sort options. Generates a select box containing the sort options. Returns `string` rendered cHTMLSelectElement
`private string`	# `_generateSortOrderSelect( )` Generates a select box containing the sort order options (asc/desc). Generates a select box containing the sort order options (asc/desc). Returns `string` rendered cHTMLSelectElement
`private string`	# `_generateMetaDataList( )` Generates a list of meta data. Generates a list of meta data. Returns `string` HTML code showing a list of meta data Throws `cInvalidArgumentException`
`private string`	# `_generateTabFilter( )` Generates code for the filter tab. Generates code for the filter tab. Returns `string` the code for the filter link tab
`private string`	# `_generateExtensionSelect( )` Generates a select box containing the file extensions. Generates a select box containing the file extensions. Returns `string` rendered cHTMLSelectElement
`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. 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. Parameters `$dirData` `array` $dirData directory information Returns `boolean` whether the directory should be shown expanded Overrides `cContentTypeAbstract::_shouldDirectoryBeExpanded()`
`private string`	# `_generateTabManual( )` Generates code for the manual tab. Generates code for the manual tab. Returns `string` the code for the manual link tab Throws `cInvalidArgumentException`
`private string`	# `_generateExistingFileSelect( )` Generate a select box containing the already existing files in the manual tab. Generate a select box containing the already existing files in the manual tab. Returns `string` rendered cHTMLSelectElement
`public string`	# `generateFileSelect( string $directoryPath = '' )` Generate a select box containing all files for the manual tab. Generate a select box containing all files for the manual tab. Parameters `$directoryPath` `string` $directoryPath [optional] Path to directory of the files Returns `string` rendered cHTMLSelectElement SuppressWarnings docBlocks
`public string`	# `generateAjaxDirectoryList( array $dirs )` Generates a directory list from the given directory information (which is typically built by `cContentTypeAbstract::buildDirectoryList()`). Special modified for Ajax call Generates a directory list from the given directory information (which is typically built by `cContentTypeAbstract::buildDirectoryList()`). Special modified for Ajax call Parameters `$dirs` `array` $dirs directory information Returns `string` HTML code showing a directory list Throws `cInvalidArgumentException`

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

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

Constants inherited from cContentTypeAbstract
`SETTINGS_TYPE_PLAINTEXT, SETTINGS_TYPE_XML`

Properties summary
`private array`	`$_fileExtensions`	`array( 'gif', 'jpeg', 'jpg', 'png', 'doc', 'xls', 'pdf', 'txt', 'zip', 'ppt' )`	# Default file extensions. Default file extensions.
`private array`	`$_metaDataIdents`	`array( 'description' => 'Description', 'medianame' => 'Media name', 'copyright' => 'Copyright', 'keywords' => 'Keywords', 'internal_notice' => 'Internal notes' )`	# Meta data identifiers. Meta data identifiers.
`private array`	`$_dateFields`	`array( 'ctime' => 'creationdate', 'mtime' => 'modifydate' )`	# Date fields. Date fields.
`protected static array`	`$_translations`	`array( "LABEL_FILESIZE", "LABEL_UPLOAD_DATE" )`	# Placeholders for labels in frontend. Important: This must be a static array! Placeholders for labels in frontend. Important: This must be a static array!

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 cContentTypeFilelist

Parameters

Throws

Overrides

Parameters

Returns

Overrides

Returns

Returns

Throws

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Returns

Throws

Returns

Throws

Returns

Returns

Returns

Returns

Throws

Returns

Returns

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Returns

Throws

Returns

Parameters

Returns

SuppressWarnings

Parameters

Returns

Throws