\Luxor

Summary

Methods
Properties
Constants
initialize()
url()
sources()
fixPaths()
outfun()
dirExpand()
dirDesc()
markupString()
whereMenu()
fileRef()
incRef()
isRestricted()
isDirParsed()
isFileParsed()
fixString()
markupfile()
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

initialize()

initialize() 

Initial app setup code.

url()

url(string  $uri = '', array  $args = array(), string  $anchor = '') 

Generate a URL that links into Luxor.

Parameters

string $uri

The path being browsed.

array $args

Key/value pair of any GET parameters to append

string $anchor

Anchor entity name

sources()

sources() : \XHTML

Generate a list of sources available from this installation of Luxor.

Returns

\XHTML —

code representing links to the repositories

fixPaths()

fixPaths(string  $node) : string

Sanitizes path names passed by the user.

Parameters

string $node

The path name to clean up.

Returns

string —

The cleaned up path.

outfun()

outfun(  $str,   $arr) 

Parameters

$str
$arr

dirExpand()

dirExpand(  $dir) 

Parameters

$dir

dirDesc()

dirDesc(\Luxor_File  $files, string  $path) 

Prints a descriptive blurb at the end of directory listings.

Parameters

\Luxor_File $files

An instance of Luxor_File.

string $path

The directory where to look for a README file.

markupString()

markupString(  $string,   $virtp) 

Smaller version of the markupFile() function meant for marking up the descriptions in source directory listings.

Parameters

$string
$virtp

whereMenu()

whereMenu() 

fileRef()

fileRef(  $desc,   $css,   $path,   $line,   $args = array()) 

Parameters

$desc
$css
$path
$line
$args

incRef()

incRef(  $name,   $css,   $file,   $paths = array()) 

Parameters

$name
$css
$file
$paths

isRestricted()

isRestricted(string  $filename) : boolean

Check if the given item is restricted from being shown.

Parameters

string $filename

The filename to check

Returns

boolean —

Whether or not the item is allowed to be displayed

isDirParsed()

isDirParsed(string  $dir) : boolean

Check if the given directory is filtered out.

Parameters

string $dir

The path to check.

Returns

boolean —

True if the directory should be shown/parsed, false otherwise.

isFileParsed()

isFileParsed(string  $file) : boolean

Check if the given file should be parsed an/or displayed.

Parameters

string $file

The filename to check.

Returns

boolean —

True if the file should be shown/parsed, false otherwise.

fixString()

fixString(  $string,   $pre = '',   $post = '') 

Pre- and post-fix every line of a string with strings.

Parameters

$string
$pre
$post

markupfile()

markupfile(  $pathname,   $fileh,   $ann = array()) 

Parameters

$pathname
$fileh
$ann