Comments: on this page. Click to read or post your own.
A base class for all sapphire objects to inherit from
This class provides a number of pattern implementations, as well as methods and fixes to add extra psuedo-static and method functionality to PHP
Located in /sapphire/core/Object.php (line 11)
| 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. |
| i18nTest_Object | A base class for all sapphire objects to inherit from |
| i18nTestModule_Addition | A base class for all sapphire objects to inherit from |
| i18nTestSubModule | A base class for all sapphire objects to inherit from |
| i18nOtherModule | A base class for all sapphire objects to 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 | A base class for all sapphire objects to 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 | SilverStripe-variant of the "gettext" tool: |
| 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 | A base class for all sapphire objects to 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. |
| CMSMenu | The object manages the main CMS menu. |
| SideReport | A base class for all sapphire objects to inherit from |
| BatchProcess | Create a process in session which is incremented to calls from the client |
| CMSMenuItem | A simple CMS menu item |
| ShoppingCart | The ShoppingCart class is a 'data handler' for the Order object. |
An array of extension names and parameters to be applied to this object upon construction. For example:
Merge in a set of additional static variables
Add an extension to a specific class
Add a static variable without replacing it completely if possible, but merging in with both existing PHP statics and existing psuedo-statics
Traverse down a class ancestry and attempt to merge all the uninherited static values for a particular static into a single variable
An implementation of the factory method, allows you to create an instance of a class
This method first for strong class overloads (singletons & DB interaction), then custom class overloads. If an overload is found, an instance of this is returned rather than the original class. To overload a class, use Object::useCustomClass()
If a class has been overloaded, get the class name it has been overloaded with - otherwise return the class name
Get a static variable, taking into account SS's inbuild static caches and pseudo-statics
This method first checks for any extra values added by Object::add_static_var(), and attemps to traverse up the extra static var chain until it reaches the top, or it reaches a replacement static.
If any extra values are discovered, they are then merged with the default PHP static values, or in some cases completely replace the default PHP static when you set $replace = true, and do not define extra data on any child classes
Return TRUE if a class has a specified extension
Remove an extension from a class
Set a static variable
Similar to Object::create(), except that classes are only overloaded if you set the $strong parameter to TRUE when using Object::useCustomClass()
Get an uninherited static variable - a variable that is explicity set in this class, and not in the parent class
This class allows you to overload classes with other classes when they are constructed using the factory method Object::create()
Add all the methods from an object property (which is an Extension) to this object
Add a wrapper method - a method which points to another method with a different name. For example, Thumbnail(x) can be wrapped to generateThumbnail(x)
Return the names of all the methods available on this object
Cache the results of an instance method in this object to a file, or if it is already cache return the cached results
Clears the cache for the given cacheToFile call
Add an extra method using raw PHP code passed as a string
Return true if this object "exists" i.e. has a sensible value
This method should be overriden in subclasses to provide more context about the classes state. For example, a DataObject class could return false when it is deleted from the database
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. Only adds returns if they're not NULL, to avoid bogus results from methods just defined on the parent decorator. This is important for permission-checks through extend, as they use min() to determine if any of the returns is FALSE. As min() doesn't do type checking, an included NULL return would fail the permission checks
Get an extension instance attached to this object by name
Returns TRUE if this object has a specific extension applied
Return TRUE if a method exists on this object
This should be used rather than PHP's inbuild method_exists() as it takes into account methods added via extensions
Calls a method if available on both this object and all applied Extensions, and then attempts to merge all results into an array
Check if this class is an instance of a specific class, or has that class as one of its parents
Loads a cache from the filesystem if a valid on is present and within the specified lifetime
Strip a file name of special characters so it is suitable for use as a cache file name
Save a piece of cached data to the file system
Attemps to locate and call a method dynamically added to a class at runtime if a default cannot be located
You can add extra methods to a class using Extensions, Object::createMethod() or Object::addWrapperMethod()
Documentation generated on Mon, 23 Mar 2009 06:53:32 +1300 by phpDocumentor 1.3.2