Class cContentTypeImgeditor

Content type CMS_IMGEDITOR which lets the editor select an image.

cContentTypeImgeditor

Direct known subclasses

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

Methods summary
`public`	# `__construct( string $rawSettings, integer $id, array $contentTypes )` Initialises class attributes and handles store events. 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 Overrides `cContentTypeAbstract::__construct()`
`protected mixed`	# `_getRawSettings( string $contentTypeName, integer $id, array $contentTypes, boolean $editable = false )` Return the raw settings of a content type Return the raw settings of a content type Parameters `$contentTypeName` `string` $contentTypeName Content type name `$id` `integer` $id ID of the content type `$contentTypes` `array` $contentTypes Content type array `$editable` `boolean` $editable [optional] Returns `mixed` Overrides `cContentTypeAbstractTabbed::_getRawSettings()`
`public string`	# `getAbsolutePath( )` Return the absolute path of the image Return the absolute path of the image Returns `string`
`public string`	# `getRelativePath( )` Return the path of the image relative to the upload directory of the client Return the path of the image relative to the upload directory of the client Returns `string`
`public string`	# `getAbsoluteURL( )` Returns the absolute URL of the image Returns the absolute URL of the image Returns `string`
`public string`	# `getRelativeURL( )` Returns the URL of the image relative to the client base URL Returns the URL of the image relative to the client base URL Returns `string`
`public array`	# `getMetaData( )` Returns an associative array containing the meta information of the image Returns an associative array containing the meta information of the image The array contains the following keys: 'medianame' 'description' 'keywords' 'internalnotice' 'copyright' Returns `array`
`private string`	# `_generateImagePath( )` Generates the link to the image for use in the src attribute. Generates the link to the image for use in the src attribute. Returns `string` the link to the image
`protected`	# `_storeSettings( )` Stores all values from the $_POST array in the $_settings attribute (associative array) and saves them in the database (XML). Stores all values from the $_POST array in the $_settings attribute (associative array) and saves them in the database (XML). Overrides `cContentTypeAbstract::_storeSettings()`
`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 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
`private string`	# `_generateTabDirectories( )` Generates code for the directories tab in which various settings can be made. Generates code for the directories tab in which various settings can be made. Returns `string` the code for the directories tab
`private string`	# `_generateTabMeta( )` Generates code for the meta tab in which the images's meta data can be edited. Generates code for the meta tab in which the images's meta data can be edited. Returns `string` the code for the meta tab
`private string`	# `_generateTabUpload( )` Generates code for the upload tab in which new images can be uploaded. Generates code for the upload tab in which new images can be uploaded. Returns `string` the code for the upload tab
`public string`	# `generateFileSelect( string $directoryPath = '' )` Generate a select box containing all files in the given directory. Generate a select box containing all files in the given directory. Parameters `$directoryPath` `string` $directoryPath [optional] directory of the files Returns `string` rendered cHTMLSelectElement SuppressWarnings docBlocks
`protected boolean`	# `_isActiveDirectory( array $dirData )` Checks whether the directory defined by the given directory information is the currently active directory. Overwrite in subclasses if you use getDirectoryList! 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. Overwrite in subclasses if you use getDirectoryList! 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()`
`public string`	# `getImageMeta( string $filename, string $dirname )` Gets the meta data of the image with the given filename/dirname. Gets the meta data of the image with the given filename/dirname. Parameters `$filename` `string` $filename the filename of the image `$dirname` `string` $dirname the dirname of the image Returns `string` JSON-encoded array with meta data
`public string\|`	# `uplmkdir( string $path, string $name )` Creates an upload directory. Wrapper function for uplmkdir in functions.upl.php. Creates an upload directory. Wrapper function for uplmkdir in functions.upl.php. Parameters `$path` `string` $path Path to directory to create, either path from client upload directory or a dbfs path `$name` `string` $name Name of directory to create Returns `string\|` value of filemode as string ('0702') or nothing
`public string`	# `uplupload( string $path )` Uploads the transmitted files saved in the $_FILES array. Uploads the transmitted files saved in the $_FILES array. Parameters `$path` `string` $path the path to which the file should be uploaded Returns `string` the filename of the uploaded file

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

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

Constants inherited from cContentTypeAbstract
`SETTINGS_TYPE_PLAINTEXT, SETTINGS_TYPE_XML`

Properties summary
`private string`	`$_dirname`	# The name of the directory where the image is stored. The name of the directory where the image is stored.
`private string`	`$_filename`	# The name of the image file. The name of the image file.
`protected string`	`$_imagePath`	# The full path to the image file. The full path to the image file.
`private string`	`$_fileType`	# The file type of the image file. The file type of the image file.
`private string`	`$_fileSize`	# The size of the image file. The size of the image file.
`private string`	`$_medianame`	# The medianame of the image. The medianame of the image.
`protected string`	`$_description`	# The description of the image. The description of the image.
`private string`	`$_keywords`	# The keywords of the image. The keywords of the image.
`private string`	`$_internalNotice`	# The internal notice of the image. The internal notice of the image.
`private string`	`$_copyright`	# The copyright of the image. The copyright of the image.

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 cContentTypeImgeditor

Direct known subclasses

Parameters

Overrides

Parameters

Returns

Overrides

Returns

Returns

Returns

Returns

Returns

Returns

Overrides

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

SuppressWarnings

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns