Documentation TYPO3 par Ameos

t3lib_softrefproc Class Reference

List of all members.

Public Member Functions

 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='')

Public Attributes

 $fileAdminDir = 'fileadmin'
 $tokenID_basePrefix = ''

Detailed Description

Definition at line 116 of file class.t3lib_softrefproc.php.


Member Function Documentation

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

Main function through which all processing happens

Parameters:
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.
Returns:
array Result array on positive matches, see description above. Otherwise false

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

References findRef_email(), findRef_extension_fileref(), findRef_images(), findRef_TSconfig(), findRef_TStemplate(), findRef_typolink(), findRef_typolink_tag(), findRef_url(), and makeTokenID().

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.

Parameters:
string The input content to analyse
array Parameters set for the softref parser key in TCA/columns
Returns:
array Result array on positive matches, see description above. Otherwise false

Definition at line 213 of file class.t3lib_softrefproc.php.

References t3lib_div::getFileAbsFileName(), t3lib_div::htmlspecialchars_decode(), t3lib_div::isFirstPartOfStr(), t3lib_div::makeInstance(), and makeTokenID().

Referenced by findRef().

t3lib_softrefproc::findRef_typolink ( content,
spParams 
)

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

Parameters:
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.
Returns:
array Result array on positive matches, see description above. Otherwise false
See also:
tslib_content::typolink(), getTypoLinkParts()

Definition at line 280 of file class.t3lib_softrefproc.php.

References getTypoLinkParts(), and setTypoLinkPartsElement().

Referenced by findRef().

t3lib_softrefproc::findRef_typolink_tag ( content,
spParams 
)

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

Parameters:
string The input content to analyse
array Parameters set for the softref parser key in TCA/columns
Returns:
array Result array on positive matches, see description above. Otherwise false
See also:
tslib_content::typolink(), getTypoLinkParts()

Definition at line 317 of file class.t3lib_softrefproc.php.

References getTypoLinkParts(), and t3lib_div::makeInstance().

Referenced by findRef().

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

Definition at line 352 of file class.t3lib_softrefproc.php.

References fileadminReferences(), t3lib_div::getFileAbsFileName(), t3lib_div::htmlspecialchars_decode(), t3lib_div::isFirstPartOfStr(), t3lib_div::makeInstance(), and makeTokenID().

Referenced by findRef().

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.

Parameters:
string The input content to analyse
array Parameters set for the softref parser key in TCA/columns
Returns:
array Result array on positive matches, see description above. Otherwise false

Definition at line 434 of file class.t3lib_softrefproc.php.

References fileadminReferences().

Referenced by findRef().

t3lib_softrefproc::findRef_email ( content,
spParams 
)

Finding email addresses in content and making them substitutable.

Parameters:
string The input content to analyse
array Parameters set for the softref parser key in TCA/columns
Returns:
array Result array on positive matches, see description above. Otherwise false

Definition at line 457 of file class.t3lib_softrefproc.php.

References makeTokenID().

Referenced by findRef().

t3lib_softrefproc::findRef_url ( content,
spParams 
)

Finding URLs in content

Parameters:
string The input content to analyse
array Parameters set for the softref parser key in TCA/columns
Returns:
array Result array on positive matches, see description above. Otherwise false

Definition at line 497 of file class.t3lib_softrefproc.php.

References makeTokenID().

Referenced by findRef().

t3lib_softrefproc::findRef_extension_fileref ( content,
spParams 
)

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

Parameters:
string The input content to analyse
array Parameters set for the softref parser key in TCA/columns
Returns:
array Result array on positive matches, see description above. Otherwise false

Definition at line 539 of file class.t3lib_softrefproc.php.

References makeTokenID().

Referenced by findRef().

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.

Parameters:
string Input content to analyse
array Element array to be modified with new entries. Passed by reference.
Returns:
string Output content, possibly with tokens inserted.

Definition at line 591 of file class.t3lib_softrefproc.php.

References t3lib_div::getFileAbsFileName(), and makeTokenID().

Referenced by findRef_TSconfig(), and findRef_TStemplate().

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.

Parameters:
string TypoLink value.
Returns:
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.
See also:
tslib_content::typolink(), setTypoLinkPartsElement()

Definition at line 634 of file class.t3lib_softrefproc.php.

References getPageIdFromAlias(), t3lib_div::inList(), t3lib_div::testInt(), and t3lib_div::trimExplode().

Referenced by findRef_typolink(), and findRef_typolink_tag().

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

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

Parameters:
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
Returns:
string The input content, possibly containing tokens now according to the added substitution entries in $elements
See also:
getTypoLinkParts()

Definition at line 718 of file class.t3lib_softrefproc.php.

References t3lib_div::getFileAbsFileName(), t3lib_div::isFirstPartOfStr(), makeTokenID(), and t3lib_div::testInt().

Referenced by findRef_typolink().

t3lib_softrefproc::getPageIdFromAlias ( link_param  ) 

Look up and return page uid for alias

Parameters:
integer Page alias string value
Returns:
integer Page uid corresponding to alias value.

Definition at line 828 of file class.t3lib_softrefproc.php.

References t3lib_BEfunc::getRecordsByField().

Referenced by getTypoLinkParts().

t3lib_softrefproc::makeTokenID ( index = ''  ) 

Make Token ID for input index.

Parameters:
string suffix value.
Returns:
string Token ID

Definition at line 840 of file class.t3lib_softrefproc.php.

Referenced by fileadminReferences(), findRef(), findRef_email(), findRef_extension_fileref(), findRef_images(), findRef_TStemplate(), findRef_url(), and setTypoLinkPartsElement().


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


Généré par L'expert TYPO3 avec  doxygen 1.4.6