Scans HTML Purifier source code for $config tokens and records the directive being used; configdoc can use this info later. More...

Functions
foreach( $raw_files as $file)	consumeWhitespace ($tokens, &$i)
	Moves the $i cursor to the next non-whitespace token. More...

	testToken ($token, $value_or_token, $value=null)
	Tests whether or not a token is a particular type. More...

Variables
	$FS = new FSTools()

	$raw_files = $FS->globr('.', '*.php')

	$files = array()

	$counter = 0

	$full_counter = 0

	$tracker = array()

	foreach ( $files as $file) = "appid=YahooDemo"

	$xw = new XMLWriter()

Detailed Description

Scans HTML Purifier source code for $config tokens and records the directive being used; configdoc can use this info later.

Currently, this just dumps all the info onto the console. Eventually, it will create an XML file that our XSLT transform can use.

Definition in file config-scanner.php.

Function Documentation

◆ consumeWhitespace()

foreach($raw_files as $file) consumeWhitespace	(		$tokens,
		&	$i
	)

Moves the $i cursor to the next non-whitespace token.

Definition at line 37 of file config-scanner.php.

{
    do {$i++;} while (is_array($tokens[$i]) && $tokens[$i][0] === T_WHITESPACE);
}

References $i.

◆ testToken()

testToken	(	$token,
		$value_or_token,
		$value = `null`
	)

Tests whether or not a token is a particular type.

There are three run-cases:

($token, $expect_token): tests if the token is $expect_token type;
($token, $expect_value): tests if the token is the string $expect_value;
($token, $expect_token, $expect_value): tests if token is $expect_token type, and its string representation is $expect_value

Definition at line 49 of file config-scanner.php.

{
    if (is_null($value)) {
        if (is_int($value_or_token)) return is_array($token) && $token[0] === $value_or_token;
        else return $token === $value_or_token;
    } else {
        return is_array($token) && $token[0] === $value_or_token && $token[1] === $value;
    }
}
 
$counter = 0;
$full_counter = 0;
$tracker = array();
 
foreach ($files as $file) {
    $tokens = token_get_all(file_get_contents($file));
    $file = str_replace('\\', '/', $file);
    for ($i = 0, $c = count($tokens); $i < $c; $i++) {
        $ok = false;
        // Match $config
        if (!$ok && testToken($tokens[$i], T_VARIABLE, '$config')) $ok = true;
        // Match $this->config
        while (!$ok && testToken($tokens[$i], T_VARIABLE, '$this')) {
            consumeWhitespace($tokens, $i);
            if (!testToken($tokens[$i], T_OBJECT_OPERATOR)) break;
            consumeWhitespace($tokens, $i);
            if (testToken($tokens[$i], T_STRING, 'config')) $ok = true;
            break;
        }
        if (!$ok) continue;
 
        $ok = false;
        for($i++; $i < $c; $i++) {
            if ($tokens[$i] === ',' || $tokens[$i] === ')' || $tokens[$i] === ';') {
                break;
            }
            if (is_string($tokens[$i])) continue;
            if ($tokens[$i][0] === T_OBJECT_OPERATOR) {
                $ok = true;
                break;
            }
        }
        if (!$ok) continue;
 
        $line = $tokens[$i][2];
 
        consumeWhitespace($tokens, $i);
        if (!testToken($tokens[$i], T_STRING, 'get')) continue;
 
        consumeWhitespace($tokens, $i);
        if (!testToken($tokens[$i], '(')) continue;
 
        $full_counter++;
 
        $matched = false;
        do {
 
            // What we currently don't match are batch retrievals, and
            // wildcard retrievals. This data might be useful in the future,
            // which is why we have a do {} while loop that doesn't actually
            // do anything.
 
            consumeWhitespace($tokens, $i);
            if (!testToken($tokens[$i], T_CONSTANT_ENCAPSED_STRING)) continue;
            $id = substr($tokens[$i][1], 1, -1);
 
            $counter++;
            $matched = true;
 
            if (!isset($tracker[$id])) $tracker[$id] = array();
            if (!isset($tracker[$id][$file])) $tracker[$id][$file] = array();
            $tracker[$id][$file][] = $line;
 
        } while (0);
 
        //echo "$file:$line uses $namespace.$directive\n";
    }
}
 
echo "\n$counter/$full_counter instances of \$config or \$this->config found in source code.\n";
 
echo "Generating XML... ";
 
$xw = new XMLWriter();
$xw->openURI('../configdoc/usage.xml');
$xw->setIndent(true);
$xw->startDocument('1.0', 'UTF-8');
$xw->startElement('usage');
foreach ($tracker as $id => $files) {
    $xw->startElement('directive');
    $xw->writeAttribute('id', $id);
    foreach ($files as $file => $lines) {
        $xw->startElement('file');
        $xw->writeAttribute('name', $file);
        foreach ($lines as $line) {
            $xw->writeElement('line', $line);
        }
        $xw->endElement();
    }
    $xw->endElement();
}

Variable Documentation

◆ $counter

$counter = 0

Definition at line 59 of file config-scanner.php.

◆ $files

$files = array()

Definition at line 26 of file config-scanner.php.

◆ $FS

$FS = new FSTools()

Definition at line 23 of file config-scanner.php.

◆ $full_counter

$full_counter = 0

Definition at line 60 of file config-scanner.php.

◆ $raw_files

$raw_files = $FS->globr('.', '*.php')

Definition at line 25 of file config-scanner.php.

◆ $tracker

$tracker = array()

Definition at line 61 of file config-scanner.php.

Referenced by ilLPStatusQuestions\_getCompleted(), ilLPStatusQuestions\determineStatus(), ilLMPresentationGUI\filterNonAccessibleNode(), and ilLMPresentationGUI\getTracker().

◆ $xw

$xw = new XMLWriter()

Definition at line 132 of file config-scanner.php.

◆ foreach

foreach ( $files as = = 0 ) = "appid=YahooDemo"

Definition at line 63 of file config-scanner.php.

Referenced by Gettext\Languages\Exporter\Php\toStringDo().

Functions

Variables