TYPO3 Core

<?php

/***************************************************************

/**

* Soft Reference processing class

* "Soft References" are references to database elements, files, email addresses, URls etc.

*

*

* 116: class t3lib_softrefproc

*

*

* TOTAL FUNCTIONS: 14

* (This index is automatically created/updated by the extension "extdeveval")

* For each token there MUST be an entry in the "elements" key which has a "subst" key defining the tokenID and the tokenValue. See below.

* "elements" is an array where the keys are insignificant, but the values are arrays with these keys:

* "matchString" => The value of the match. This is only for informational purposes to show what was found.

* "tokenID" => The tokenID string corresponding to the token in output content, {softref:[tokenID]}. This is typically an md5 hash of a string defining uniquely the position of the element.

* "tokenValue" => The value that the token substitutes in the text. Basically, if this value is inserted instead of the token the content should match what was inputted originally.

* "type" => file / db / string = the type of substitution. "file" means it is a relative file [automatically mapped], "db" means a database record reference [automatically mapped], "string" means it is manually modified string content (eg. an email address)

*/

/**

* Class for processing of the default soft reference types for CMS:

*

* @param string If running from inside a FlexForm structure, this is the path of the tag.

* @return array Result array on positive matches, see description above. Otherwise false

*/

$retVal = FALSE;

$resultArray = array(

'elements' => array(

array(

case 'substitute':

$tokenID = $this->makeTokenID();

$resultArray = array(

'elements' => array(

array(

'matchString' => $content,

* @param array Parameters set for the softref parser key in TCA/columns

* @return array Result array on positive matches, see description above. Otherwise false

*/

// Start HTML parser and split content by image tag:

$htmlParser = t3lib_div::makeInstance('t3lib_parsehtml');

$elements = array();

// Traverse splitted parts:

// Get file reference:

$attribs = $htmlParser->get_tag_attributes($v);

$pI = pathinfo($srcRef);

// If it looks like a local image, continue. Otherwise ignore it.

// Initialize the element entry with info text here:

$tokenID = $this->makeTokenID($k);

$elements[$k]['matchString'] = $v;

// If the image seems to be from fileadmin/ folder or an RTE image, then proceed to set up substitution token:

// Token and substitute value:

$elements[$k]['subst'] = array(

'type' => 'file',

'relFileName' => $srcRef,

'tokenID' => $tokenID,

'tokenValue' => $attribs[0]['src'],

);

$elements[$k]['error'] = 'File does not exist!';

}

} else {

}

// Return result:

$resultArray = array(

'content' => implode('', $splitContent),

'elements' => $elements

* @return array Result array on positive matches, see description above. Otherwise false

* @see tslib_content::typolink(), getTypoLinkParts()

*/

// First, split the input string by a comma if the "linkList" parameter is set.

// An example: the link field for images in content elements of type "textpic" or "image". This field CAN be configured to define a link per image, separated by comma.

} else {

}

// Traverse the links now:

$elements = array();

$tLP = $this->getTypoLinkParts($typolinkValue);

$linkElement[$k] = $this->setTypoLinkPartsElement($tLP, $elements, $typolinkValue, $k);

}

// Return output:

$resultArray = array(

'content' => implode(',', $linkElement),

'elements' => $elements

* @return array Result array on positive matches, see description above. Otherwise false

* @see tslib_content::typolink(), getTypoLinkParts()

*/

// Parse string for special TYPO3 <link> tag:

$htmlParser = t3lib_div::makeInstance('t3lib_parsehtml');

// Traverse result:

$elements = array();

$tLP = $this->getTypoLinkParts($typolinkValue);

}

}

// Return output:

$resultArray = array(

'content' => implode('', $linkTags),

'elements' => $elements

* @param array Parameters set for the softref parser key in TCA/columns

* @return array Result array on positive matches, see description above. Otherwise false

*/

$elements = array();

// First, try to find images and links:

$splitContent = $htmlParser->splitTags('img,a,form', $content);

// Traverse splitted parts:

$attribs = $htmlParser->get_tag_attributes($v);

$attributeName = '';

case 'img':

$attributeName = 'src';

break;

}

// Get file reference:

$srcRef = t3lib_div::htmlspecialchars_decode($attribs[0][$attributeName]);

// Set entry:

// OK, if it looks like a local file from fileadmin/, include it:

$pI = pathinfo($srcRef);

// Token and substitute value:

$elements[$k]['subst'] = array(

'type' => 'file',

'relFileName' => $srcRef,

'tokenID' => $tokenID,

'tokenValue' => $attribs[0][$attributeName],

);

$elements[$k]['error'] = 'File does not exist!';

}

} else {

}

}

}

$content = $this->fileadminReferences($content, $elements);

// Return output:

$resultArray = array(

'content' => $content,

'elements' => $elements

* @param array Parameters set for the softref parser key in TCA/columns

* @return array Result array on positive matches, see description above. Otherwise false

*/

$elements = array();

// Process free fileadmin/ references from TSconfig

$content = $this->fileadminReferences($content, $elements);

// Return output:

$resultArray = array(

'content' => $content,

'elements' => $elements

* @param array Parameters set for the softref parser key in TCA/columns

* @return array Result array on positive matches, see description above. Otherwise false

*/

$resultArray = array();

// email:

$tokenID = $this->makeTokenID($idx);

$elements[$idx] = array();

$elements[$idx]['matchString'] = $value;

$elements[$idx]['subst'] = array(

'type' => 'string',

'tokenID' => $tokenID,

}

// Return output:

$resultArray = array(

'elements' => $elements

);

return $resultArray;

* @param array Parameters set for the softref parser key in TCA/columns

* @return array Result array on positive matches, see description above. Otherwise false

*/

$resultArray = array();

// Fileadmin files:

$tokenID = $this->makeTokenID($idx);

$elements[$idx] = array();

$elements[$idx]['matchString'] = $value;

$elements[$idx]['subst'] = array(

'type' => 'string',

'tokenID' => $tokenID,

}

// Return output:

$resultArray = array(

'elements' => $elements

);

return $resultArray;

* @param array Parameters set for the softref parser key in TCA/columns

* @return array Result array on positive matches, see description above. Otherwise false

*/

$resultArray = array();

// Fileadmin files:

$tokenID = $this->makeTokenID($idx);

$elements[$idx] = array();

}

// Return output:

$resultArray = array(

'elements' => $elements

);

return $resultArray;

}

/*************************

*

* Helper functions

* @param array Element array to be modified with new entries. Passed by reference.

* @return string Output content, possibly with tokens inserted.

*/

// Fileadmin files are found

// Traverse files:

// when file is found, set up an entry for the element:

'type' => 'file',

'relFileName' => $value,

'tokenID' => $tokenID,

'tokenValue' => $value,

);

// Check if the file actually exists:

}

}

}

// Implode the content again, removing prefixed and trailing white space:

}

/**

* @return 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 tslib_content::typolink(), setTypoLinkPartsElement()

*/

$finalTagParts = array();

// Split by space into link / target / class

// Parse URL:

$pU = @parse_url($link_param);

// Detecting the kind of reference:

$finalTagParts['LINK_TYPE'] = 'mailto';

$finalTagParts['url'] = trim($link_param);

$urlChar = intval(strpos($link_param, '.'));

// Detects if a file is found in site-root (or is a 'virtual' simulateStaticDocument file!) and if so it will be treated like a normal file.

$rFD_fI = pathinfo($rootFileDat);

$isLocalFile = 1;

}

$finalTagParts['LINK_TYPE'] = 'url';

$finalTagParts['url'] = $link_param;

$splitLinkParam = explode('?', $link_param);

$finalTagParts['LINK_TYPE'] = 'file';

$finalTagParts['filepath'] = rawurldecode($splitLinkParam[0]);

$finalTagParts['query'] = $splitLinkParam[1];

}

$finalTagParts['LINK_TYPE'] = 'page';

$finalTagParts['anchor'] = trim($link_params_parts[1]);

}

// Splitting the parameter by ',' and if the array counts more than 1 element it's a id/type/? pair

$link_param = $pairParts[0];

}

// Checking if the id-parameter is an alias.

$finalTagParts['alias'] = $link_param;

$link_param = $this->getPageIdFromAlias($link_param);

}

* @return string The input content, possibly containing tokens now according to the added substitution entries in $elements

* @see getTypoLinkParts()

*/

// Initialize, set basic values. In any case a link will be shown

// Based on link type, maybe do more:

case 'mailto':

case 'url':

// Mail addresses and URLs can be substituted manually:

'type' => 'string',

'tokenID' => $tokenID,

'tokenValue' => $tLP['url'],

);

// Output content will be the token instead:

break;

case 'file':

// Process files found in fileadmin directory:

// Set up the basic token and token value for the relative file:

'type' => 'file',

'relFileName' => $tLP['filepath'],

'tokenID' => $tokenID,

);

// Depending on whether the file exists or not we will set the

}

// Output content will be the token instead

break;

case 'page':

// Rebuild page reference typolink part:

$content = '';

// Set page id:

'type' => 'db',

'tokenID' => $tokenID,

);

}

// Add type if applicable

}

// Add anchor if applicable

// Initialize a new entry because we have a new relation:

'type' => 'db',

'tokenID' => $newTokenID,

'tokenValue' => $tLP['anchor'],

);

}

}

break;

default:

{

}

break;

}

// Finally, for all entries that was rebuild with tokens, add target and class in the end:

}

}

* @param integer Page alias string value

* @return integer Page uid corresponding to alias value.

*/

return $pRec[0]['uid'];

}

* @param string suffix value.

* @return string Token ID

*/

}

}

include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_softrefproc.php']);

}