Docs For Class Loader

[line 108]
Loader is a class that creates more of a Java-like 'import' mechanism for including libraries and files. That way you can specify include files not by their location but by which library they correspond to (ie. org.sitellite.XML.XSLT).

New in 1.2:

Added a 'return' option to the import() method's $method parameter. Also created three new methods which act as aliases to import() with the $method already specified. These are inc(), req(), and ret(). They are abbreviated not for brevity's sake, but because include, require, and return are all reserved words in PHP.
Separated the path translation logic into its own methods, translatePath() and translateRealPath(), which cleaned up the code a lot and made the import() method nice and small.

New in 1.4:

Fixed a regex bug in translateRealPath().

New in 1.6:

Added an $extension parameter to translatePath(), translateRealPath(), import(), inc(), req(), and ret().

New in 1.8:

Fixed a bug in the loading order in translatePath(), where the file foo/bar.php should be chosen before foo/bar/bar.php, which it wasn't before.

New in 2.0:

Added box(), form(), getBoxSettings(), getFormSettings(), boxAllowed(), and formAllowed() methods.
Added global functions that alias methods of a global $loader object. These include: loader_import(), loader_include(), loader_require(), loader_return(), loader_box(), loader_form(), loader_box_get_settings(), loader_box_allowed(), loader_form_get_fields(), and loader_form_allowed().
Added conf() function which aliases the values from a global $conf 2D array.

New in 2.2:

Added a 'dl' $method to import(), which calls dl() on the specified $lib in one of the following directories: saf/dl/dll, saf/dl/dylib, or saf/dl/so. Note that the suffix (.dl, .dylib, or .so) is provided by the PHP_SHLIB_SUFFIX constant, which is also used to determine which directory to find the extension in.
Added loader_dl() as an alias to the new import() $method.
Removed the html_marker() calls from box() and form() -- they now reside in saf.XML.XT, so as not to interfere with the creation of web services, command-line utilities, and reusable components, with predictable output based on actions.

New in 2.4:

Box/form changes: added new access.php parameters.
Added $app property and getApp() method. This introduces a new SCS directory layout, being inc/app/$app/(boxes|forms|etc.)/$request.
Added the ability in translatePath() to call paths within custom apps by specifying the app name instead of a defined path name.


1     <?php
2     
3      $loader = new Loader (
4          array (
5              'sitellite' => 'J:/devel/inc/lib',
6              'pear' => 'D:/PHP/pear'
7          )
8      );
9     
10     $loader->import ('sitellite.Cookie');
11     $loader->import ('pear.Date.Human');
12    
13     $cookie = new Cookie;
14     $cookie->set ('icamehereat', serialize (Date_Human::gregorianToHuman (29, 10, 2001)));
15    
16     ? >

Tags:

access:	public
version:	2.4, 2003-08-08, $Id: Loader.php,v 1.4 2005/12/24 09:15:40 lux Exp $
license:	http://www.sitellite.org/index/license
copyright:	Copyright (C) 2001-2003, Simian Systems Inc.
author:	John Luxford <mailto:lux@simian.ca>

constructor Loader [line 170]

Loader Loader(
[mixed
$path = '.'])

Constructor method. If $path is a string, it specifies the 'default' path location. If $path is an associative array, it specifies a list of libraries and their locations, and 'default' is set to the current directory (unless overridden by being specified in $path).

method addPath [line 269]

void addPath(
associative
$new)

This method controls your access to the $paths associative array, allowing you to add new libraries to it. $new must be an associative array.

method app [line 1129]

string app(
)

Gets the current running app -- used by appconf() and appconf_set() or inside a box or form that needs to know. Basically returns the top item on the $apps stack.

Tags:

access:

public

[ Top ]

method box [line 510]

string box(
string
$name, [associative
$parameters = array ()], [string
$context = 'normal'])

Executes the specified box using the Sitellite box API, which is essentially just an include.

Tags:

access:

public

Parameters:

string	$name
string	$context
associative	$parameters	array $parameters

[ Top ]

method boxAllowed [line 844]

mixed boxAllowed(
string
$name, [string
$context = 'normal'])

Checks recursively in the box directory and parent directories

until it checks $boxPath finally for an access.php file. It then parses that file as an INI file and determines whether the box is accessible by the current user. If a template is specified in the access.php file, that template name is returned on success, otherwise a boolean true value is returned on success. False is always returned if the user is not allowed. Allowed access values are:

sitellite_access - string - the access level of the box
sitellite_status - string - the status of the box
sitellite_action - boolean - whether the box can be called as an action
sitellite_inline - boolean - whether the box can be called inline within a page
sitellite_goto - string - the location to redirect to if the box permissions fail
sitellite_template - string - template to use for this box, applies only to boxes called as actions
sitellite_template_set - string - template set to use for this box, applies only to boxes called as actions
sitellite_chdir - boolean - whether to change the base directory during the execution of the box, to more easily resolve includes in ported apps

-- note that Loader resolves the latter first, if available)

sitellite_rewrite_pattern - string - a pattern within the box output (usually urls from ported apps) to rewrite
sitellite_rewrite_replace - string - the replacement for the rewrite pattern
sitellite_exit - boolean - calls exit() at the end of the box, bypassing all post-output processing.

Tags:

access:

public

Parameters:

string	$name
string	$context

[ Top ]

method boxRewrite [line 644]

void boxRewrite(
mixed
$data)

[ Top ]

method form [line 667]

string form(
string
$name, [string
$context = 'normal'])

Executes the specified form using the Sitellite form API, which is essentially just an include of a file that defines a subclass of saf.MailForm.

Tags:

access:

public

Parameters:

string	$name
string	$context

[ Top ]

method formAllowed [line 985]

mixed formAllowed(
string
$name, [string
$context = 'normal'])

Checks recursively in the form directory and parent directories

until it checks $formPath finally for an access.php file. It then parses that file as an INI file and determines whether the form is accessible by the current user. If a template is specified in the access.php file, that template name is returned on success, otherwise a boolean true value is returned on success. False is always returned if the user is not allowed.

Tags:

access:

public

Parameters:

string	$name
string	$context

[ Top ]

method getApp [line 1090]

string getApp(
string
$request, string
$default)

Determines which SCS app to run, based on the request path and the default provided.

Tags:

access:

public

Parameters:

string	$request
string	$default

[ Top ]

method getBoxAccess [line 775]

void getBoxAccess(
mixed
$name, mixed
$app)

[ Top ]

method getBoxSettings [line 767]

void getBoxSettings(
mixed
$name, mixed
$app)

[ Top ]

method getFormAccess [line 794]

void getFormAccess(
mixed
$name, mixed
$app)

[ Top ]

method getFormFields [line 949]

void getFormFields(
mixed
$name)

[ Top ]

method getFormSettings [line 939]

void getFormSettings(
mixed
$name)

[ Top ]

method import [line 202]

void import(
string
$lib, [string
$method = 'include'], [string
$extension = 'php'])

This is the method that translates the library name, etc. and makes the

PHP '(include|require)_once' call. $lib is the class to include (adds .php for you), and $method is the method to import the file with (either 'include', 'require', or 'return', which returns the contents of the specified package as opposed to simply including it and returning true if it succeeded). If the $lib specified points to a directory, import () will look for a file with the same file name as that directory with a .php extension inside the directory (ie. ('sitellite.Database' would import 'sitellite/Database/Database.php'). You can optionally use a '.*' to tell Loader to load each file in a particular directory as well. It will then proceed to load the entire directory, starting with the file of the same name as the directory, then in the order that readdir() reads them on your system. Please Note: import() always calls include_once() or require_once(). If you need to call just include() or require(), you will have to do so manually.

Tags:

access:

public

Parameters:

string	$lib
string	$method
string	$extension

[ Top ]

method inc [line 469]

boolean inc(
string
$lib, [string
$extension = 'php'])

Alias for import(), with the $method always specified as 'include'.

Tags:

access:

public

Parameters:

string	$lib
string	$extension

[ Top ]

method path [line 290]

string path(
[string
$lib = 'default'])

Returns the path to the library specified (which it gets from the $paths associative array). This makes Loader potentially useful for directory-related tasks other than as an (include|require)_once replacement. If $lib is not specified, it uses the 'default' path.

method removeApp [line 1110]

string removeApp(
string
$request, [string
$app = false])

Removes the $app name from the $request path.

Tags:

access:

public

Parameters:

string	$request
string	$app

[ Top ]

method req [line 482]

boolean req(
string
$lib, [string
$extension = 'php'])

Alias for import(), with the $method always specified as 'require'.

Tags:

access:

public

Parameters:

string	$lib
string	$extension

[ Top ]

method ret [line 495]

string ret(
string
$lib, [string
$extension = 'php'])

Alias for import(), with the $method always specified as 'return'.

Tags:

access:

public

Parameters:

string	$lib
string	$extension

[ Top ]

method translatePath [line 391]

void translatePath(
string
$lib, [string
$extension = 'php'])

Translates a Loader-style path (ie. saf.MailForm.Widget.File) into

the actual file name or names (for paths ending in .*), which can then be used by the import() method. This can also be useful if you want to find out the actual file name that corresponds to the Loader path (since for instance saf.MailForm could mean either saf/lib/MailForm.php or saf/lib/MailForm/MailForm.php). Returns the file name and path on success, an array of file names if the path ends in .* and it is successful, or false on failure. Note that the first component to a path, which is considered the root of the path, must be either defined in the $paths property or else exist as an SCS app in inc/app.

Tags:

access:

public

Parameters:

string	$lib
string	$extension

[ Top ]

method translateRealPath [line 447]

void translateRealPath(
string
$lib, [string
$extension = 'php'])

Translates an actual path into a Loader-style path.

Tags:

access:

public

Parameters:

string	$lib
string	$extension

[ Top ]

Packages

Classes

Files

Class: Loader

Class Overview

Author(s)

Version

Copyright

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Tags:

Class Variables

$app =

Tags:

$boxPath = 'boxes'

Tags:

$formPath = 'forms'

Tags:

$included = array ()

Tags:

$paths = array ()

Tags:

$prefix = 'inc/app'

Tags:

Class Methods

constructor Loader [line 170]

Tags:

Parameters:

method addPath [line 269]

Tags:

Parameters:

method app [line 1129]

Tags:

method box [line 510]

Tags:

Parameters:

method boxAllowed [line 844]

Tags:

Parameters:

method boxRewrite [line 644]

method form [line 667]

Tags:

Parameters:

method formAllowed [line 985]

Tags:

Parameters:

method getApp [line 1090]

Tags:

Parameters:

method getBoxAccess [line 775]

method getBoxSettings [line 767]

method getFormAccess [line 794]

method getFormFields [line 949]

method getFormSettings [line 939]

method import [line 202]

Tags:

Parameters:

method inc [line 469]

Tags:

Parameters:

method path [line 290]

Tags:

Parameters:

method removeApp [line 1110]

Tags:

Parameters:

method req [line 482]

Tags:

Parameters:

method ret [line 495]

Tags:

Parameters:

method translatePath [line 391]

Tags:

Parameters:

method translateRealPath [line 447]

Tags: