t3lib_softrefproc Klassenreferenz

Aufstellung aller Elemente

Öffentliche Methoden
	findRef ($table, $field, $uid, $content, $spKey, $spParams, $structurePath='')
	findRef_images ($content, $spParams)
	findRef_typolink ($content, $spParams)
	findRef_typolink_tag ($content, $spParams)
	findRef_TStemplate ($content, $spParams)
	findRef_TSconfig ($content, $spParams)
	findRef_email ($content, $spParams)
	findRef_url ($content, $spParams)
	findRef_extension_fileref ($content, $spParams)
	fileadminReferences ($content, &$elements)
	getTypoLinkParts ($typolinkValue)
	setTypoLinkPartsElement ($tLP, &$elements, $content, $idx)
	getPageIdFromAlias ($link_param)
	makeTokenID ($index='')
Öffentliche Attribute
	$fileAdminDir = 'fileadmin'
	$tokenID_basePrefix = ''

Dokumentation der Elementfunktionen

t3lib_softrefproc::fileadminReferences	(	$	content,
		&$	elements
	)

Searches the content for a reference to a file in "fileadmin/". When a match is found it will get substituted with a token.

Parameter:

	string	Input content to analyse
	array	Element array to be modified with new entries. Passed by reference.

Rückgabe:: string Output content, possibly with tokens inserted.

t3lib_softrefproc::findRef	(	$	table,
		$	field,
		$	uid,
		$	content,
		$	spKey,
		$	spParams,
		$	structurePath = `''`
	)

Main function through which all processing happens

Parameter:

	string	Database table name
	string	Field name for which processing occurs
	integer	UID of the record
	string	The content/value of the field
	string	The softlink parser key. This is only interesting if more than one parser is grouped in the same class. That is the case with this parser.
	array	Parameters of the softlink parser. Basically this is the content inside optional []-brackets after the softref keys. Parameters are exploded by ";"
	string	If running from inside a FlexForm structure, this is the path of the tag.

Rückgabe:: array Result array on positive matches, see description above. Otherwise false

t3lib_softrefproc::findRef_email	(	$	content,
		$	spParams
	)

Finding email addresses in content and making them substitutable.

Parameter:

	string	The input content to analyse
	array	Parameters set for the softref parser key in TCA/columns

Rückgabe:: array Result array on positive matches, see description above. Otherwise false

t3lib_softrefproc::findRef_extension_fileref	(	$	content,
		$	spParams
	)

Finding reference to files from extensions in content, but only to notify about their existence. No substitution

Parameter:

	string	The input content to analyse
	array	Parameters set for the softref parser key in TCA/columns

Rückgabe:: array Result array on positive matches, see description above. Otherwise false

t3lib_softrefproc::findRef_images	(	$	content,
		$	spParams
	)

Finding image tags in the content. All images that are not from external URLs will be returned with an info text Will only return files in fileadmin/ and files in uploads/ folders which are prefixed with "RTEmagic[C|P]_" for substitution Any "clear.gif" images are ignored.

Parameter:

	string	The input content to analyse
	array	Parameters set for the softref parser key in TCA/columns

Rückgabe:: array Result array on positive matches, see description above. Otherwise false

t3lib_softrefproc::findRef_TSconfig	(	$	content,
		$	spParams
	)

Processes possible references inside of Page and User TSconfig fields. Currently this only includes file references to fileadmin/ but in fact there are currently no properties that supports such references.

Parameter:

	string	The input content to analyse
	array	Parameters set for the softref parser key in TCA/columns

Rückgabe:: array Result array on positive matches, see description above. Otherwise false

t3lib_softrefproc::findRef_TStemplate	(	$	content,
		$	spParams
	)

Processing the content expected from a TypoScript template This content includes references to files in fileadmin/ folders and file references in HTML tags like , and string The input content to analyse array Parameters set for the softref parser key in TCA/columns array Result array on positive matches, see description above. Otherwise false

t3lib_softrefproc::findRef_typolink	(	$	content,
		$	spParams
	)

TypoLink value processing. Will process input value as a TypoLink value.

Parameter:

	string	The input content to analyse
	array	Parameters set for the softref parser key in TCA/columns. value "linkList" will split the string by comma before processing.

Rückgabe:: array Result array on positive matches, see description above. Otherwise false

Siehe auch:: tslib_content::typolink(), getTypoLinkParts()

t3lib_softrefproc::findRef_typolink_tag	(	$	content,
		$	spParams
	)

TypoLink tag processing. Will search for <link ...> tags in the content string and process any found.

Parameter:

	string	The input content to analyse
	array	Parameters set for the softref parser key in TCA/columns

Rückgabe:: array Result array on positive matches, see description above. Otherwise false

Siehe auch:: tslib_content::typolink(), getTypoLinkParts()

t3lib_softrefproc::findRef_url	(	$	content,
		$	spParams
	)

Finding URLs in content

Parameter:

	string	The input content to analyse
	array	Parameters set for the softref parser key in TCA/columns

Rückgabe:: array Result array on positive matches, see description above. Otherwise false

t3lib_softrefproc::getPageIdFromAlias ( $ link_param )

Look up and return page uid for alias

Parameter:

integer

Page alias string value

Rückgabe:: integer Page uid corresponding to alias value.

t3lib_softrefproc::getTypoLinkParts ( $ typolinkValue )

Analyse content as a TypoLink value and return an array with properties. TypoLinks format is: <link [typolink] [browser target] [css class]>. See tslib_content::typolink() The syntax of the [typolink] part is: [typolink] = [page id or alias][,[type value]][#[anchor, if integer = tt_content uid]] The extraction is based on how tslib_content::typolink() behaves.

Parameter:

string

TypoLink value.

Rückgabe:: array Array with the properties of the input link specified. The key "LINK_TYPE" will reveal the type. If that is blank it could not be determined.

Siehe auch:: tslib_content::typolink(), setTypoLinkPartsElement()

t3lib_softrefproc::makeTokenID ( $ index = '' )

Make Token ID for input index.

Parameter:

string

suffix value.

Rückgabe:: string Token ID

t3lib_softrefproc::setTypoLinkPartsElement	(	$	tLP,
		&$	elements,
		$	content,
		$	idx
	)

Recompile a TypoLink value from the array of properties made with getTypoLinkParts() into an elements array

Parameter:

	array	TypoLink properties
	array	Array of elements to be modified with substitution / information entries.
	string	The content to process.
	integer	Index value of the found element - user to make unique but stable tokenID

Rückgabe:: string The input content, possibly containing tokens now according to the added substitution entries in $elements

Siehe auch:: getTypoLinkParts()

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

/srv/www/vhosts/typo3.local/typo3_src-4.2.10/t3lib/class.t3lib_softrefproc.php

t3lib_softrefproc Klassenreferenz

Öffentliche Methoden

Öffentliche Attribute

Dokumentation der Elementfunktionen