Comments: on this page. Click to read or post your own.
Base object that all others should inherit from.
This object provides a number of helper methods that patch over PHP's deficiencies.
Located in /sapphire/core/Object.php (line 9)
| Class | Description |
|---|---|
| SearchContext | Manages searching of properties on one or more DataObject types, based on a given set of input parameters. |
| SearchFilter | |
| Filesystem | A collection of static methods for manipulating the filesystem. |
| GD | A wrapper class for GD-based images, with lots of manipulation functions. |
| Archive | Class for handling archives. |
| ObjectTest_T1A | Base object that all others should inherit from. |
| ObjectTest_T1B | Base object that all others should inherit from. |
| ObjectTest_T1C | Base object that all others should inherit from. |
| ObjectTest_T2 | Base object that all others should inherit from. |
| ObjectTest_MyObject | Base object that all others should inherit from. |
| i18nTestModule | Base object that all others should inherit from. |
| i18nTestModule_Addition | Base object that all others should inherit from. |
| i18nTestSubModule | Base object that all others should inherit from. |
| i18nOtherModule | Base object that all others should inherit from. |
| BasicAuth | Provides an interface to HTTP basic authentication. |
| PasswordValidator | This class represents a validator for member passwords. |
| Authenticator | Abstract base class for an authentication method |
| CSVParser | Class to handle parsing of CSV files, where the column headers are in the first row. |
| CSSContentParser | CSSContentParser enables parsing & assertion running of HTML content via CSS selectors. |
| SSCli | Class to facilitate command-line output. |
| BuildTask | Interface for a generic build task. Does not support dependencies. This will simply run a chunk of code when called. |
| BulkLoader_Result | Encapsulates the result of a BulkLoader import (usually through the BulkLoader->processAll() method). |
| Geoip | Routines for DNS to country resolution |
| XML | Base class for XML parsers |
| Form_FieldMap | Base object that all others should inherit from. |
| FormScaffolder | |
| FormTransformation | This class represents "transformations" of a form - such as making it printable or making it readonly. |
| Validator | This validation class handles all form and custom form validation through the use of Required fields. |
| ReportField_SimpleFilter | Assisting class. Determines whether or not a column is hidden. |
| Extension | Add extension that can be added to an object with Object::add_extension(). |
| TokenisedRegularExpression | A tokenised regular expression is a parser, similar to a regular expression, that acts on tokens rather than characters. |
| ViewableData | Generic class for all data that will be accessed from a view. |
| i18n | Base-class for storage and retrieval of translated entities. |
| i18nTextCollector | |
| ArrayLib | Library of static methods for manipulating arrays. |
| ValidationResult | A class that combined as a boolean result with an optional list of error messages. |
| HTTPResponse | Represenets an HTTPResponse returned by a controller. |
| HTTPRequest | Represents a HTTP-request, including a URL that is tokenised for parsing, and a request method (GET/POST/PUT/DELETE). |
| SSViewer | The SSViewer executes a .ss template file. |
| SQLMap | This is a class used to represent key->value pairs generated from database queries. |
| SQLMap_Iterator | Base object that all others should inherit from. |
| SQLQuery | Object representing a SQL query. |
| DataObjectLog | A DataObjectLog is a log of changes that have been made to the database in this session. |
| YamlFixture | Uses the Spyc library to parse a YAML document (see http://yaml.org). |
| Database | Abstract database connectivity class. |
| Query | Abstract query-result class. |
| Convert | Library of conversion functions, implemented as static methods. |
| Cookie | A set of static methods for manipulating cookies. |
| Notifications | The Notifications class allows you to create email notifications for various events. |
| Mailer | Mailer objects are responsible for actually sending emails. |
| SQLFormatter | Format a SQL Query for better readable output in HTML or Plaintext. |
| TextParser | Parses text in a variety of ways. |
| DataFormatter | A DataFormatter object handles transformation of data from Sapphire model objects to a particular output format, and vice versa. |
| SideReport | Base object that all others should inherit from. |
| BatchProcess | Create a process in session which is incremented to calls from the client |
| ShoppingCart | The ShoppingCart class is a 'data handler' for the Order object. |
Extensions to be used on this object. An array of extension names and parameters eg:
static $extensions = array( "Hierarchy", "Versioned('Stage', 'Live')", );
This DataObjects extensions, eg Versioned.
This method lets us extend a built-in class by adding pseudo-static variables to it.
Add an extension to the given object.
This can be used to add extensions to built-in objects, such as role decorators on Member
Create allows us to override the standard classes of sapphire with our own custom classes.
create will load strong classes firstly for singleton level and database interaction, otherwise will use the fallback custom classes. To set a strong custom class to overide an object at for say singleton use, use the syntax Object::useCustomClass('Datetime','SSDatetime',true);
Strong_create is a function to enforce a certain class replacement e.g Php5.2's latest introduction of a namespace conflict means we have to replace all instances of Datetime with SSdatetime.
this allows us to seperate those, and sapphires classes
This function allows you to overload class creation methods, so certain classes are always created correctly over your system.
Add the all methods from a given parameter to this object.
This is used for extensions.
Add a 'wrapper method'.
For example, Thumbnail($arg, $arg) can be defined to call generateImage("Thumbnail", $arg, $arg)
Return the names of all the methods on this object.
param includeCustom If set to true, then return custom methods too.
Caches the return value of a method.
Caches the return value of a method. Passes args to the method as well.
Create a new method
This constructor will be called the first time an object of this class is created.
You can overload it with methods for setting up the class - for example, extra methods.
Returns true if this object "exists", i.e., has a sensible value.
Overload this in subclasses. For example, an empty DataObject record could return false.
Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed.
Currently returns an array, with an index resulting every time the function is called.
Get an extension on this DataObject
Returns true if the given extension class is attached to this object
Returns true if the given method exists.
Invokes a method on the object itself, or proxied through a decorator.
This method breaks the normal rules of inheritance, and aggregates everything in the returned result. If the invoked methods return void, they are still recorded as empty array keys.
Loads a current cache from the filesystem, if it can.
Makes a cache name safe to use in a file system
Saves a cache to the file system
Set a static variable
Set an uninherited static variable
Get a static variable.
Get an uninherited static variable
Calls a method.
Extra methods can be hooked to a class using
Documentation generated on Sun, 19 Oct 2008 06:43:35 +1300 by phpDocumentor 1.3.2