Solutions Open Source

Référence de la classe t3lib_softrefproc

Liste de tous les membres

Fonctions membres publiques

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

Attributs publics

 $fileAdminDir = 'fileadmin'
 $tokenID_basePrefix = ''

Documentation des fonctions membres

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

Main function through which all processing happens

Paramètres:
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.
Renvoie:
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.

Paramètres:
string The input content to analyse
array Parameters set for the softref parser key in TCA/columns
Renvoie:
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.

Paramètres:
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.
Renvoie:
array Result array on positive matches, see description above. Otherwise false
Voir également:
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.

Paramètres:
string The input content to analyse
array Parameters set for the softref parser key in TCA/columns
Renvoie:
array Result array on positive matches, see description above. Otherwise false
Voir également:
tslib_content::typolink(), getTypoLinkParts()

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_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.

Paramètres:
string The input content to analyse
array Parameters set for the softref parser key in TCA/columns
Renvoie:
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.

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

t3lib_softrefproc::findRef_url ( $  content,
$  spParams 
)

Finding URLs in content

Paramètres:
string The input content to analyse
array Parameters set for the softref parser key in TCA/columns
Renvoie:
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

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

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.

Paramètres:
string Input content to analyse
array Element array to be modified with new entries. Passed by reference.
Renvoie:
string Output content, possibly with tokens inserted.

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.

Paramètres:
string TypoLink value.
Renvoie:
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.
Voir également:
tslib_content::typolink(), setTypoLinkPartsElement()

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

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

Paramètres:
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
Renvoie:
string The input content, possibly containing tokens now according to the added substitution entries in $elements
Voir également:
getTypoLinkParts()

t3lib_softrefproc::getPageIdFromAlias ( $  link_param  ) 

Look up and return page uid for alias

Paramètres:
integer Page alias string value
Renvoie:
integer Page uid corresponding to alias value.

t3lib_softrefproc::makeTokenID ( $  index = ''  ) 

Make Token ID for input index.

Paramètres:
string suffix value.
Renvoie:
string Token ID

Documentation des données membres

t3lib_softrefproc::$fileAdminDir = 'fileadmin'

t3lib_softrefproc::$tokenID_basePrefix = ''

La documentation de cette classe a été générée à partir du fichier suivant :
Généré le Fri Aug 31 11:42:32 2007 pour OBLADY - Typo3 API v4.1.2 par  doxygen 1.5.3