Vanilla 2  2.0.18.8
 All Data Structures Namespaces Files Functions Variables Pages
Garden Namespace Reference

Namespaces

 Core
 
 Database
 

Detailed Description

Authentication Module: Local User/Password auth tokens.

Author
Mark O'Sullivan
Version
@GARDEN-VERSION@

Validating, Setting, and Retrieving session data in cookies. The HMAC Hashing method used here was inspired by Wordpress 2.5 and this document in particular: http://www.cse.msu.edu/~alexliu/publications/Cookie/cookie.pdf

Manages available applications, enabling and disabling them.

Author
Mark O'Sullivan
Version
@GARDEN-VERSION@

An abstract template for authenticator classes.

Author
Tim Gunter http://www.opensource.org/licenses/gpl-2.0.php GPL
Version
@GARDEN-VERSION@

An abstract template for authenticator classes.

Vanilla framework autoloader.

Handles indexing of class files across the entire framework, as well as bringing those classes into scope as needed.

This is a static class that hooks into the SPL autoloader.

Author
Tim Gunter
Version
@GARDEN-VERSION@
Author
Tim Gunter
Version
@GARDEN-VERSION@
Author
Todd Burry
Version
@GARDEN-VERSION@

The Configuration class can be used to load configuration arrays from files, retrieve settings from the arrays, assign new values to the arrays, and save the arrays back to the files.

Usage: $Configuration->LoadFromFile($Name, $FileName); // Loads the configuration array $GroupName['Setting'] = $Value; $Setting = $Configuration->Get('Setting'); $Configuration->Set('Setting2', 'Value'); $Configuration->Set('Setting3', $Object); $Configuration->Set('Setting4', $Array);

Author
Mark O'Sullivan
Version
@GARDEN-VERSION@

Represents, enforces integrity, and aids in the management of: configuration data. This generic model can be instantiated (with the configuration array name it is intended to represent) and used directly, or it can be extended and overridden for more complicated procedures related to different configuration arrays.

Author
Mark O'Sullivan
Version
@GARDEN-VERSION@

A base class that all controllers can inherit for common controller properties and methods.

Author
Mark O'Sullivan
Version
@GARDEN-VERSION@

Validating, Setting, and Retrieving session data in cookies.

Author
Mark O'Sullivan, Todd Burry
Version
@GARDEN-VERSION@

This is a cache implementation that caches nothing and always reports cache misses.

Author
Tim Gunter
Version
@GARDEN-VERSION@

Dispatcher handles all requests.

Author
Mark O'Sullivan
Version
@GARDEN-VERSION@

A dummy class that returns itself on all method and property calls. This class is useful for partial deliveries where parts of the page are not necessary, but you don't want to have to check for them on every use.

Author
Todd Burry
Version
@GARDEN-VERSION@

Object Representation of an email. All public methods return $this for chaining purposes. ie. $Email->Subject('Hi')->Message('Just saying hi!')- To('joe@v.nosp@m.anil.nosp@m.lafor.nosp@m.ums..nosp@m.com')->Send();

Author
Mark O'Sullivan
Version
@GARDEN-VERSION@
Todo:
This class needs to be tested on a function mail server and with SMTP

This is a cache implementation that stores its cache items in the filesystem.

Author
Tim Gunter
Version
@GARDEN-VERSION@

Load files and either return their contents or send them to the browser.

Author
Mark O'Sullivan
Version
@GARDEN-VERSION@

Helps with the rendering of form controls that link directly to a data model.

Author
Mark O'Sullivan http://www.opensource.org/licenses/gpl-2.0.php GPL

Helps with the rendering of form controls that link directly to a data model.

Todo:
change formatting of tables in documentation

Utility class that helps to format strings, objects, and arrays.

Author
Mark O'Sullivan
Version
@GARDEN-VERSION@

Handle the creation, usage, and deletion of file cache entries

Author
Tim Gunter
Version
@GARDEN-VERSION@

The Locale class is used to load, define, change, and render translations for different locales. It is a singleton class.

Author
Mark O'Sullivan
Version
@GARDEN-VERSION@

This is a cache implementation that stores its cache items in memcached.

Author
Tim Gunter
Version
@GARDEN-VERSION@

Represents, enforces integrity, and aids in the management of: data. This generic model can be instantiated (with the table name it is intended to represent) and used directly, or it can be extended and overridden for more complicated procedures related to different tables.

Author
Mark O'Sullivan
Version
@GARDEN-VERSION@

Represents, enforces integrity, and aids in the management of: data. This generic model can be instantiated (with the table name it is intended to represent) and used directly, or it can be extended and overridden for more complicated procedures related to different tables.

Base module object

Author
Mark O'Sullivan
Version
@GARDEN-VERSION@

Base module object

Handles creating and returning a pager

Author
Mark O'Sullivan
Version
@GARDEN-VERSION@

Wrapper for the Portable PHP password hashing framework.

Author
Damien Lebrun
Version
@GARDEN-VERSION@

The Pluggable class is extended by other classes to enable the plugins and the custom event model in plugins. Any class that extends this class has the ability to throw custom events at any time, which can then be handled by plugins.

Author
Mark O'Sullivan
Version
@GARDEN-VERSION@

The Pluggable class is extended by other classes to enable the plugins and the custom event model in plugins. Any class that extends this class has the ability to throw custom events at any time, which can then be handled by plugins.

A simple framework that all plugins should extend. Aside from the implementation of Gdn_IPlugin, this class provides some convenience methods to make plugin development easier and faster.

Author
Tim Gunter
Version
@GARDEN-VERSION@

Handles relating external actions to comments and discussions. Flagging, Praising, Reporting, etc

Author
Tim Gunter tim@v.nosp@m.anil.nosp@m.lafor.nosp@m.ums..nosp@m.com
Version
@GARDEN-VERSION@

Represents a Request to the application, typically from the browser but potentially generated internally, in a format that can be accessed directly by the Dispatcher.

string RequestURI($URI = NULL) Get/Set the Request URI (REQUEST_URI). string RequestScript($ScriptName = NULL) Get/Set the Request ScriptName (SCRIPT_NAME). string RequestMethod($Method = NULL) Get/Set the Request Method (REQUEST_METHOD). string RequestHost($URI = NULL) Get/Set the Request Host (HTTP_HOST). string RequestFolder($URI = NULL) Get/Set the Request script's Folder.

Author
Tim Gunter
Version
@GARDEN-VERSION@

Handles user information throughout a session. This class is a singleton.

Author
Mark O'Sullivan
Version
@GARDEN-VERSION@

Handles user information throughout a session. This class is a singleton.

Todo:
update doc to be more specific with properties type if possible.

Allows views to implement slices, small asynchronously refreshable portions of the page

Author
Tim Gunter
Version
@GARDEN-VERSION@

Allows plugns and controllers to implement slices – small asynchronously refreshable portions of the page

Author
Tim Gunter
Version
@GARDEN-VERSION@

Handles install-side analytics gathering and sending.

Author
Tim Gunter tim@v.nosp@m.anil.nosp@m.lafor.nosp@m.ums..nosp@m.com
Version
@GARDEN-VERSION@
Since
2.0.17

Utility class that helps to render theme elements.

Author
Mark O'Sullivan
Version
@GARDEN-VERSION@

Handles analyzing and returning various parts of the current url.

Author
Mark O'Sullivan
Version
@GARDEN-VERSION@

Handles analyzing and returning various parts of the current url.

Manages data integrity validation rules. Can automatically define a set of validation rules based on a @Schema with $this->GenerateBySchema($Schema);

Author
Mark O'Sullivan
Version
@GARDEN-VERSION@

Manages data integrity validation rules. Can automatically define a set of validation rules based on a @Schema with $this->GenerateBySchema($Schema);

All of these functions are used by ./class.validation.php to validate form input strings. With the exception of ValidateRegex, each function receives two parameters (the field value and the related database field properties) and is expected to return a boolean TRUE or FALSE indicating if the validation was successful.

Note: $Field will be an object of field properties as defined in @MySQLDriver->_FetchTableSchema (at the bottom of the file). Properties are: (string) Name, (bool) PrimaryKey, (string) Type, (bool) AllowNull, (string) Default, (int) Length, (array) Enum.

A template for handshake-aware authenticator classes.

Author
Tim Gunter http://www.opensource.org/licenses/gpl-2.0.php GPL
Version
@GARDEN-VERSION@

An interface for in-page modules.

Author
Mark O'Sullivan
Version
@GARDEN-VERSION@

An interface for in-page modules.

A simple interface that all plugins must follow. Aside from the Setup method, this is used more to identify plugins than to enforce structure upon them.

Author
Mark O'Sullivan
Version
@GARDEN-VERSION@

A simple interface that all singletons must follow.

Author
Mark O'Sullivan
Version
@GARDEN-VERSION@

A simple interface that all singletons must follow.

The GenericStructure class is used by any given database driver to build, modify, and create tables and views.

Author
Mark O'Sullivan
Version
@GARDEN-VERSION@

A database-independent dataset management/manipulation class.

This class is HEAVILY inspired by CodeIgniter (http://www.codeigniter.com). My hat is off to them.

Author
Mark O'Sullivan
Version
@GARDEN-VERSION@

The MySQLDriver class is a MySQL-specific class for manipulating database information.

The MySQLDriver class can be treated as an interface for all database engines. Any new database engine should have the same public and protected properties and methods as this one so that they can all be treated the same by the application.

This class is HEAVILY inspired by and, in places, flat out copied from CodeIgniter (http://www.codeigniter.com). My hat is off to them.

Author
Mark O'Sullivan
Version
@GARDEN-VERSION@

The Gdn_DatabaseDriver class (equivalent to SqlBuilder from Vanilla 1.x) is used by any given database driver to build and execute database queries.

This class is HEAVILY inspired by and, in places, flat out copied from CodeIgniter (http://www.codeigniter.com). My hat is off to them.

Author
Mark O'Sullivan
Version
@GARDEN-VERSION@