API Documentation
\

\Luxor_Tagger

$Horde: luxor/lib/Tagger.php,v 1.9 2008/08/01 21:09:31 chuck Exp $

Summary

Methods
Properties
Constants
processFile()
processRefs()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

processFile()

processFile(\Luxor_Driver  $files, string  $pathname, \Luxor_Lang  $lang) : mixed

Indexes a file.

Parses the files contents for symbols and creates indexes in the storage backend for the file itself and the symbols it defines.

Parameters

\Luxor_Driver $files

An instance of a storage backend driver.
string $pathname

The (relative) pathname of the file to be processed.
\Luxor_Lang $lang

The language object for $pathname.

Returns

mixed —

A PEAR_Error if an error occured.

processRefs()

processRefs(\Luxor_Driver  $files, string  $pathname, \Luxor_Lang  $lang) : mixed

References a file.

Parses the files contents for symbols and creates references to the files where these symbols are defined.

Parameters

\Luxor_Driver $files

An instance of a storage backend driver.
string $pathname

The (relative) pathname of the file to be referenced.
\Luxor_Lang $lang

The language object for $pathname.

Returns

mixed —

A PEAR_Error if an error occured.