tx_rtehtmlarea_select_image Class Reference

Inheritance diagram for tx_rtehtmlarea_select_image:

[legend]Collaboration diagram for tx_rtehtmlarea_select_image:

[legend]List of all members.

Public Member Functions
	init ()
	initVariables ()
	getBodyTagAdditions ()
	getImageInfo ($filepath)
	insertMagicImage ($filepath, $imgInfo, $altText='', $titleText='', $additionalParams='')
	insertPlainImage ($imgInfo, $altText='', $titleText='', $additionalParams='')
	getJSCode ($act, $editorNo, $sys_language_content)
	processSessionData ($data)
	main_rte ()
	expandFolder ($expandFolder=0, $plainFlag=0, $noThumbs=0)
	TBE_dragNDrop ($expandFolder=0, $extensionList='')
	initConfiguration ()
	getAllowedItems ($items)
	getHelpMessage ($act)
Public Attributes
	$extKey = 'rtehtmlarea'
	$content
	$allowedItems
	$allowedFileTypes = array()
	$editorNo
	$sys_language_content
	$thisConfig
	$buttonConfig
Protected Member Functions
	initHookObjects ()
	getRTEImageStorageDir ()
	insertImage ()
	imageInsertJS ($url, $width, $height, $altText='', $titleText='', $additionalParams='')
	insertUploadForm ($folderPath)
	getRTEConfig ()
	getImgPath ()
	getButtonConfig ()
	getDefaultClass ()
	setMaximumImageDimensions ()
Protected Attributes
	$defaultClass
	$plainMaxWidth
	$plainMaxHeight
	$magicMaxWidth
	$magicMaxHeight
	$imgPath
	$RTEImageStorageDir
	$imgObj

---

Detailed Description

Definition at line 135 of file class.tx_rtehtmlarea_select_image.php.

---

Member Function Documentation

tx_rtehtmlarea_select_image::expandFolder	(	$	expandFolder = 0,
		$	plainFlag = 0,
		$	noThumbs = 0
	)

Parameters:

	[type]	$expandFolder: ...
	[type]	$plainFlag: ...

Returns:

[type] ...

Definition at line 907 of file class.tx_rtehtmlarea_select_image.php.

References $BACK_PATH, $GLOBALS, $lines, t3lib_div::_GP(), t3lib_div::fixed_lgd(), t3lib_BEfunc::getFileIcon(), t3lib_div::getFilesInDir(), t3lib_div::makeInstance(), nbsp, and t3lib_div::rawUrlEncodeFP().

Referenced by initVariables().

tx_rtehtmlarea_select_image::getAllowedItems

(

$

items

)

Get the allowed items or tabs

Parameters:

string

$items: initial list of possible items

Returns:

array the allowed items

Definition at line 1133 of file class.tx_rtehtmlarea_select_image.php.

References t3lib_div::clientInfo(), and t3lib_div::trimExplode().

Referenced by init().

tx_rtehtmlarea_select_image::getBodyTagAdditions

(

)

Provide the additional parameters to be included in the template body tag

Returns:

string the body tag additions

Definition at line 264 of file class.tx_rtehtmlarea_select_image.php.

Referenced by init().

tx_rtehtmlarea_select_image::getButtonConfig

(

)

[protected]

Get the configuration of the image button

Returns:

array the configuration array of the image button

Definition at line 1123 of file class.tx_rtehtmlarea_select_image.php.

tx_rtehtmlarea_select_image::getDefaultClass

(

)

[protected]

Get the default image class

Returns:

string the default class, if any

Definition at line 1157 of file class.tx_rtehtmlarea_select_image.php.

tx_rtehtmlarea_select_image::getHelpMessage

(

$

act

)

Get the help message to be displayed on a given tab

Parameters:

string

$act: the identifier of the tab

Returns:

string the text of the message

Definition at line 1194 of file class.tx_rtehtmlarea_select_image.php.

tx_rtehtmlarea_select_image::getImageInfo

(

$

filepath

)

Get the information on the image file identified its path

Parameters:

string

$filepath: the path to the image file

Returns:

array a 4-elements information array about the file

Definition at line 314 of file class.tx_rtehtmlarea_select_image.php.

References t3lib_div::makeInstance().

Referenced by insertImage().

tx_rtehtmlarea_select_image::getImgPath

(

)

[protected]

Get the path of the image to be inserted or modified

Returns:

string path to the image

Definition at line 1113 of file class.tx_rtehtmlarea_select_image.php.

tx_rtehtmlarea_select_image::getJSCode	(	$	act,
		$	editorNo,
		$	sys_language_content
	)

Generate JS code to be used on the image insert/modify dialogue

Parameters:

	string	$act: the action to be performed
	string	$editorNo: the number of the RTE instance on the page
	string	$sys_language_content: the language of the content element

Returns:

string the generated JS code

Definition at line 425 of file class.tx_rtehtmlarea_select_image.php.

References $GLOBALS, $TYPO3_CONF_VARS, insertImage(), and t3lib_div::trimExplode().

tx_rtehtmlarea_select_image::getRTEConfig

(

)

[protected]

Get the RTE configuration from Page TSConfig

Returns:

array RTE configuration array

Definition at line 1100 of file class.tx_rtehtmlarea_select_image.php.

References t3lib_BEfunc::getPagesTSconfig(), and t3lib_BEfunc::RTEsetup().

tx_rtehtmlarea_select_image::getRTEImageStorageDir

(

)

[protected]

Get the path to the folder where RTE images are stored

Returns:

string the path to the folder where RTE images are stored

Definition at line 273 of file class.tx_rtehtmlarea_select_image.php.

References $GLOBALS.

tx_rtehtmlarea_select_image::imageInsertJS	(	$	url,
		$	width,
		$	height,
		$	altText = '',
		$	titleText = '',
		$	additionalParams = ''
	)			[protected]

Echo the HTML page and JS that will insert the image

Parameters:

	string	$url: the url of the image
	integer	$width: the width of the image
	integer	$height: the height of the image
	string	$altText: text for the alt attribute of the image
	string	$titleText: text for the title attribute of the image
	string	$additionalParams: text representing more html attributes to be added on the img tag

Returns:

void

Definition at line 389 of file class.tx_rtehtmlarea_select_image.php.

References insertImage(), and t3lib_div::quoteJSvalue().

Referenced by insertMagicImage(), and insertPlainImage().

tx_rtehtmlarea_select_image::init

(

)

Initialisation

Returns:

void

Reimplemented from browse_links.

Definition at line 161 of file class.tx_rtehtmlarea_select_image.php.

References $BACK_PATH, $GLOBALS, getAllowedItems(), getBodyTagAdditions(), initConfiguration(), initHookObjects(), initVariables(), insertImage(), and t3lib_div::makeInstance().

tx_rtehtmlarea_select_image::initConfiguration

(

)

Initializes the configuration variables

Returns:

void

Definition at line 1086 of file class.tx_rtehtmlarea_select_image.php.

Referenced by init().

tx_rtehtmlarea_select_image::initHookObjects

(

)

[protected]

Initialize hook objects implementing interface t3lib_browseLinksHook

Returns:

void

Definition at line 244 of file class.tx_rtehtmlarea_select_image.php.

References $TYPO3_CONF_VARS, and t3lib_div::getUserObj().

Referenced by init().

tx_rtehtmlarea_select_image::initVariables

(

)

Initialize class variables

Returns:

void

Definition at line 197 of file class.tx_rtehtmlarea_select_image.php.

References t3lib_div::_GP(), expandFolder(), browse_links::expandPage(), and t3lib_div::getIndpEnv().

Referenced by init().

tx_rtehtmlarea_select_image::insertImage

(

)

[protected]

Insert the image in the editing area

Returns:

void

Definition at line 282 of file class.tx_rtehtmlarea_select_image.php.

References t3lib_div::_GP(), exit, getImageInfo(), insertMagicImage(), and insertPlainImage().

Referenced by getJSCode(), imageInsertJS(), and init().

tx_rtehtmlarea_select_image::insertMagicImage	(	$	filepath,
		$	imgInfo,
		$	altText = '',
		$	titleText = '',
		$	additionalParams = ''
	)

Insert a magic image

Parameters:

	string	$filepath: the path to the image file
	array	$imgInfo: a 4-elements information array about the file
	string	$altText: text for the alt attribute of the image
	string	$titleText: text for the title attribute of the image
	string	$additionalParams: text representing more HTML attributes to be added on the img tag

Returns:

void

Definition at line 332 of file class.tx_rtehtmlarea_select_image.php.

References t3lib_div::_GP(), t3lib_div::fixPermissions(), imageInsertJS(), t3lib_div::intInRange(), and t3lib_div::makeInstance().

Referenced by insertImage().

tx_rtehtmlarea_select_image::insertPlainImage	(	$	imgInfo,
		$	altText = '',
		$	titleText = '',
		$	additionalParams = ''
	)

Insert a plain image

Parameters:

	array	$imgInfo: a 4-elements information array about the file
	string	$altText: text for the alt attribute of the image
	string	$titleText: text for the title attribute of the image
	string	$additionalParams: text representing more HTML attributes to be added on the img tag

Returns:

void

Definition at line 371 of file class.tx_rtehtmlarea_select_image.php.

References imageInsertJS().

Referenced by insertImage().

tx_rtehtmlarea_select_image::insertUploadForm

(

$

folderPath

)

[protected]

Create upload/create folder forms, if a path is given

Parameters:

string

$folderPath: the selected path , if any

Returns:

string the html content for the upload form

Definition at line 874 of file class.tx_rtehtmlarea_select_image.php.

References $content, and $GLOBALS.

tx_rtehtmlarea_select_image::main_rte

(

)

[Describe function...]

Returns:

[type] ...

Definition at line 757 of file class.tx_rtehtmlarea_select_image.php.

References $FILEMOUNTS, $TYPO3_CONF_VARS, t3lib_div::_GP(), t3lib_BEfunc::getFuncCheck(), t3lib_BEfunc::getModuleData(), t3lib_div::makeInstance(), and nbsp.

tx_rtehtmlarea_select_image::processSessionData

(

$

data

)

Session data for this class can be set from outside with this method. Call after init()

Parameters:

array

Session data array

Returns:

array Session data and boolean which indicates that data needs to be stored in session because it's changed

Reimplemented from browse_links.

Definition at line 730 of file class.tx_rtehtmlarea_select_image.php.

tx_rtehtmlarea_select_image::setMaximumImageDimensions

(

)

[protected]

Set variables for maximum image dimensions

Returns:

void

Definition at line 1172 of file class.tx_rtehtmlarea_select_image.php.

tx_rtehtmlarea_select_image::TBE_dragNDrop	(	$	expandFolder = 0,
		$	extensionList = ''
	)

For RTE: This displays all IMAGES (gif,png,jpg) (from extensionList) from folder. Thumbnails are shown for images. This listing is of images located in the web-accessible paths ONLY - the listing is for drag-n-drop use in the RTE

Parameters:

	string	The folder path to expand
	string	List of fileextensions to show

Returns:

string HTML output

Reimplemented from browse_links.

Definition at line 976 of file class.tx_rtehtmlarea_select_image.php.

References $BACK_PATH, $GLOBALS, $lines, t3lib_div::_GP(), t3lib_div::fixed_lgd_cs(), t3lib_BEfunc::getFileIcon(), t3lib_div::getFilesInDir(), t3lib_div::inList(), and nbsp.

---

Member Data Documentation

tx_rtehtmlarea_select_image::$allowedFileTypes = array()

Definition at line 140 of file class.tx_rtehtmlarea_select_image.php.

tx_rtehtmlarea_select_image::$allowedItems

Definition at line 139 of file class.tx_rtehtmlarea_select_image.php.

tx_rtehtmlarea_select_image::$buttonConfig

Definition at line 152 of file class.tx_rtehtmlarea_select_image.php.

tx_rtehtmlarea_select_image::$content

Definition at line 137 of file class.tx_rtehtmlarea_select_image.php.

tx_rtehtmlarea_select_image::$defaultClass [protected]

Definition at line 141 of file class.tx_rtehtmlarea_select_image.php.

tx_rtehtmlarea_select_image::$editorNo

Definition at line 149 of file class.tx_rtehtmlarea_select_image.php.

tx_rtehtmlarea_select_image::$extKey = 'rtehtmlarea'

Definition at line 136 of file class.tx_rtehtmlarea_select_image.php.

tx_rtehtmlarea_select_image::$imgObj [protected]

Definition at line 154 of file class.tx_rtehtmlarea_select_image.php.

tx_rtehtmlarea_select_image::$imgPath [protected]

Definition at line 146 of file class.tx_rtehtmlarea_select_image.php.

tx_rtehtmlarea_select_image::$magicMaxHeight [protected]

Definition at line 145 of file class.tx_rtehtmlarea_select_image.php.

tx_rtehtmlarea_select_image::$magicMaxWidth [protected]

Definition at line 144 of file class.tx_rtehtmlarea_select_image.php.

tx_rtehtmlarea_select_image::$plainMaxHeight [protected]

Definition at line 143 of file class.tx_rtehtmlarea_select_image.php.

tx_rtehtmlarea_select_image::$plainMaxWidth [protected]

Definition at line 142 of file class.tx_rtehtmlarea_select_image.php.

tx_rtehtmlarea_select_image::$RTEImageStorageDir [protected]

Definition at line 147 of file class.tx_rtehtmlarea_select_image.php.

tx_rtehtmlarea_select_image::$sys_language_content

Definition at line 150 of file class.tx_rtehtmlarea_select_image.php.

tx_rtehtmlarea_select_image::$thisConfig

Reimplemented from browse_links.

Definition at line 151 of file class.tx_rtehtmlarea_select_image.php.

---

The documentation for this class was generated from the following file:

• typo3/sysext/rtehtmlarea/mod4/class.tx_rtehtmlarea_select_image.php

---