Overview

Packages

  • Luxor
  • None

Classes

  • Luxor
  • Luxor_Driver
  • Luxor_Driver_sql
  • Luxor_Files
  • Luxor_Files_plain
  • Luxor_Lang
  • Luxor_Lang_Generic
  • Luxor_SimpleParse
  • Luxor_Tagger
  • Overview
  • Package
  • Class
  • Tree

Class Luxor

Package: Luxor
Author: Jan Schneider jan@horde.org
Since: Luxor 0.1
Located at Luxor.php
Methods summary
public static
# initialize( )

Initial app setup code.

Initial app setup code.

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

Generate a URL that links into Luxor.

Generate a URL that links into Luxor.

Parameters

$uri
The path being browsed.
$args
Key/value pair of any GET parameters to append
$anchor
Anchor entity name
public XHTML
# sources( )

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

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

Returns

XHTML
code representing links to the repositories
public string
# fixPaths( string $node )

Sanitizes path names passed by the user.

Sanitizes path names passed by the user.

Parameters

$node
The path name to clean up.

Returns

string
The cleaned up path.
public
# outfun( mixed $str, mixed $arr )
public
# dirExpand( mixed $dir )
public
# dirDesc( Luxor_File $files, string $path )

Prints a descriptive blurb at the end of directory listings.

Prints a descriptive blurb at the end of directory listings.

Parameters

$files
An instance of Luxor_File.
$path
The directory where to look for a README file.
public
# markupString( mixed $string, mixed $virtp )

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

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

See

markupFile()
public
# whereMenu( )
public
# fileRef( mixed $desc, mixed $css, mixed $path, mixed $line = 0, mixed $args = array() )
public
# incRef( mixed $name, mixed $css, mixed $file, mixed $paths = array() )
public boolean
# isRestricted( string $filename )

Check if the given item is restricted from being shown.

Check if the given item is restricted from being shown.

Parameters

$filename
The filename to check

Returns

boolean
Whether or not the item is allowed to be displayed
public boolean
# isDirParsed( string $dir )

Check if the given directory is filtered out.

Check if the given directory is filtered out.

Parameters

$dir
The path to check.

Returns

boolean
True if the directory should be shown/parsed, false otherwise.
public boolean
# isFileParsed( string $file )

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

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

Parameters

$file
The filename to check.

Returns

boolean
True if the file should be shown/parsed, false otherwise.
public
# fixString( mixed $string, mixed $pre = '', mixed $post = '' )

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

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

public
# markupfile( mixed $pathname, mixed $fileh, mixed $ann = array() )
public
# getMenu( mixed $returnType = 'object' )

Build Luxor's list of menu items.

Build Luxor's list of menu items.

API documentation generated by ApiGen