[support] element index

Package indexes

All elements
a b c d e f g h i k l m n o p r s t u v w _
_
top
Method __construct
Support_Resources::__construct() in Resources.php
Constructor -- Direct instantiation is not allowed
Method __construct
Support_InvalidResourceProviderError::__construct() in Resources.php
Method __construct
Support_Mail_Msg::__construct() in Msg.php
Constructor
Method __construct
Support_UnknownResourceProviderError::__construct() in Resources.php
Method __construct
Support_Mail_SMTPEngine::__construct() in SMTPEngine.php
Constructor
Method __construct
Support_UnknownOptionError::__construct() in UnknownOptionError.php
Constructor
Method __construct
Support_UnknownClassError::__construct() in UnknownClassError.php
Constructor
Method __construct
Support_InflectorConversion::__construct() in Inflector.php
Method __construct
Support_Inflector::__construct() in Inflector.php
Constructor
Method __construct
Support_Resources_DefaultConfigProvider::__construct() in DefaultConfigProvider.php
Constructor
Method __construct
Support_Resources_DefaultCacheProvider::__construct() in DefaultCacheProvider.php
Constructor
Method __construct
MissingRequiredConfigurationError::__construct() in Cfg.php
Constructor
Method __construct
Support_Resources_DefaultDBProvider::__construct() in DefaultDBProvider.php
Constructor
Method __construct
Support_Resources_DefaultLogger::__construct() in DefaultLoggerProvider.php
Constructor
Method __construct
Support_Resources_DefaultTemplateEngine::__construct() in DefaultTemplateProvider.php
Constructor
Method __construct
Support_Resources_DefaultLoggerProvider::__construct() in DefaultLoggerProvider.php
Constructor
Method __construct
Support_Mail_Attachment::__construct() in Attachment.php
Constructor
a
top
Variable $attachments
Support_Mail_Msg::$attachments in Msg.php
Attachments
Method add_attachment
Support_Mail_Msg::add_attachment() in Msg.php
Add an attachment
Method assemble_alternative
Support_Mail_Msg::assemble_alternative() in Msg.php
Assembles an alternative body
Method assemble_body
Support_Mail_Msg::assemble_body() in Msg.php
Assemble and return the body
Method assemble_header
Support_Mail_Msg::assemble_header() in Msg.php
Assemble and return the header
Method assemble_mixed
Support_Mail_Msg::assemble_mixed() in Msg.php
Assembles a mixed body with an alternative one inside
Method assign
Support_Resources_DefaultTemplateEngine::assign() in DefaultTemplateProvider.php
Assign a variable to be available to any template processed by this engine
Page ArrayHelper.php
ArrayHelper.php in ArrayHelper.php
Page Attachment.php
Attachment.php in Attachment.php
b
top
Variable $boundary
Support_Mail_Msg::$boundary in Msg.php
MIME boundary
c
top
Variable $cached_models
Support_Util::$cached_models in Util.php
Variable $cacheStore
Support_Resources_DefaultCacheProvider::$cacheStore in DefaultCacheProvider.php
Variable $capabilities
Support_Mail_SMTPEngine::$capabilities in SMTPEngine.php
Variable $className
Support_UnknownClassError::$className in UnknownClassError.php
Variable $connection
Support_Resources_DefaultDBProvider::$connection in DefaultDBProvider.php
Method cache
Support_Resources::cache() in Resources.php
Get a cache store
Method camelize
Support_Inflector::camelize() in Inflector.php
Convert space or underscore separated words to a single mixed case name. For example, table_name becomes TableName. If $firstWordUpper is false, the first word is not converted to upper case (table_name would become tableName).
Class Cfg
Cfg in Cfg.php
A class for accessing application-level configuration information.
Method className
Support_UnknownClassError::className() in UnknownClassError.php
Accessor for the class name
Method clean
Support_Mail_Msg::clean() in Msg.php
Strip non-printable characters from a value
Method clear
Support_Resources_DefaultCacheStore::clear() in DefaultCacheProvider.php
Remove all data from the cache.
Method config_data
Support_Resources::config_data() in Resources.php
Get the array of application configuration data
Method connect
Support_Resources_DefaultDBProvider::connect() in DefaultDBProvider.php
Connect to the database
Method connect
Support_Mail_SMTPEngine::connect() in SMTPEngine.php
Connect to the mail server
Method content_tag
Support_TagHelper::content_tag() in TagHelper.php
Output a content tag
Method create
Support_Mail_Engine::create() in Engine.php
Factory method for accessing the configured engine
Page Cfg.php
Cfg.php in Cfg.php
Page CacheProvider.php
CacheProvider.php in CacheProvider.php
Page ConfigProvider.php
ConfigProvider.php in ConfigProvider.php
d
top
Variable $data
Support_Mail_Attachment::$data in Attachment.php
The data or path/filename of the attachment data
Variable $data
Cfg::$data in Cfg.php
Variable $data_is_path
Support_Mail_Attachment::$data_is_path in Attachment.php
A flag that, when true, indicates $data contains a path and not actual data
Method data
Support_Mail_SMTPEngine::data() in SMTPEngine.php
Send message data
Method db_connection
Support_Resources::db_connection() in Resources.php
Get a database connection
Method debug
Support_Resources_DefaultLogger::debug() in DefaultLoggerProvider.php
Log a debug message.
Method default_error_handler
Support_ErrorLogger::default_error_handler() in ErrorLogger.php
Passes on the actual error to the previous handler or to the default handler
Method disconnect
Support_Mail_SMTPEngine::disconnect() in SMTPEngine.php
Close the connection
Method display
Support_Resources_DefaultTemplateEngine::display() in DefaultTemplateProvider.php
Output a template
Page DBProvider.php
DBProvider.php in DBProvider.php
Page DefaultCacheProvider.php
DefaultCacheProvider.php in DefaultCacheProvider.php
Page DefaultConfigProvider.php
DefaultConfigProvider.php in DefaultConfigProvider.php
Page DefaultDBProvider.php
DefaultDBProvider.php in DefaultDBProvider.php
Page DefaultLoggerProvider.php
DefaultLoggerProvider.php in DefaultLoggerProvider.php
Page DefaultTemplateProvider.php
DefaultTemplateProvider.php in DefaultTemplateProvider.php
e
top
Method error
Support_Resources_DefaultLogger::error() in DefaultLoggerProvider.php
Log an error message.
Method exclude_sorted
Support_ArrayHelper::exclude_sorted() in ArrayHelper.php
Returns a new array containing all elements from source except any that are also present in exclude. Both input arrays must be sorted.
Method exists
Cfg::exists() in Cfg.php
Test for the existence of a key in the configuration.
Method exists
Support_Resources_DefaultCacheStore::exists() in DefaultCacheProvider.php
Test for the existence of key in the cache.
Method expire
Support_Resources_DefaultCacheStore::expire() in DefaultCacheProvider.php
Remove key and its data from the cache.
Page ErrorLogger.php
ErrorLogger.php in ErrorLogger.php
Page Engine.php
Engine.php in Engine.php
f
top
Method fatal
Support_Resources_DefaultLogger::fatal() in DefaultLoggerProvider.php
Log a fatal error message.
Method fetch
Support_Resources_DefaultTemplateEngine::fetch() in DefaultTemplateProvider.php
Return a processed template as a string
Method find_key
Cfg::find_key() in Cfg.php
Locate the named key in the configuration.
g
top
Method get
Support_Resources_CacheProvider::get() in CacheProvider.php
Return an interface to a cache store.
Method get
Support_Resources_DefaultDBProvider::get() in DefaultDBProvider.php
Return an instance of a database connection.
Method get
Support_Resources_DefaultLoggerProvider::get() in DefaultLoggerProvider.php
Return a logger instance for the given name.
Method get
Support_Resources_DefaultTemplateProvider::get() in DefaultTemplateProvider.php
Return a template engine instance.
Method get
Support_Resources_LoggerProvider::get() in LoggerProvider.php
Return a logger instance for the given name.
Method get
Support_Resources_DefaultCacheStore::get() in DefaultCacheProvider.php
Return the value for key.
Method get
Support_Resources_DefaultConfigProvider::get() in DefaultConfigProvider.php
Return the application configuration data.
Method get
Cfg::get() in Cfg.php
Returns the value of the given key in the configuration. If they key does not exist, any default value provided is returned instead (or NULL if none is provided).
Method get
Support_Resources_TemplateProvider::get() in TemplateProvider.php
Return an instance of a template engine
Method get
Support_Resources_ConfigProvider::get() in ConfigProvider.php
Return the array of application configuration data.
Method get
Support_Resources_DefaultCacheProvider::get() in DefaultCacheProvider.php
Return a cache store instance.
Method get
Support_Resources_DBProvider::get() in DBProvider.php
Return an instance of a database connection.
Method getInstance
Support_Inflector::getInstance() in Inflector.php
Return the shared class instance
Method getLine
Support_Mail_SMTPEngine::getLine() in SMTPEngine.php
Read and return a line from the socket
Method getResponse
Support_Mail_SMTPEngine::getResponse() in SMTPEngine.php
Get a reponse from the server
Method get_new_connection
Support_Resources_DefaultDBProvider::get_new_connection() in DefaultDBProvider.php
Returns a new PDO connection
Method get_required
Cfg::get_required() in Cfg.php
Returns the value of the given key in the configuration. If they key does not exist, MissingRequiredConfigurationError is thrown instead.
Method get_resource
Support_Resources::get_resource() in Resources.php
Generic implementation of getting a resource from a provider
Method get_template_vars
Support_Resources_DefaultTemplateEngine::get_template_vars() in DefaultTemplateProvider.php
Return the value assigned to the named variable, or all assigned variables if not provided.
h
top
Variable $headers
Support_Mail_Msg::$headers in Msg.php
Additional mail headers as an associative array
Variable $html
Support_Mail_Msg::$html in Msg.php
HTML body
Method handle_error
Support_ErrorLogger::handle_error() in ErrorLogger.php
Invoked when errors occur. Respects the error_reporting setting.
Method has_alternatives
Support_Mail_Msg::has_alternatives() in Msg.php
Returns true if the message contains alternative formats
Method has_header
Support_Mail_Msg::has_header() in Msg.php
Return true if the specified header has a value
Method header
Support_Mail_Msg::header() in Msg.php
Return the value of a header field
Method humanize
Support_Inflector::humanize() in Inflector.php
Convert underscore separated words to a space separated string of words with an initial capital letter.
i
top
Variable $ignore
Support_Inflector::$ignore in Inflector.php
Matches words which are the same in both the singular and plural forms
Variable $included
Support_Resources_DefaultConfigProvider::$included in DefaultConfigProvider.php
Variable $inst
Support_Inflector::$inst in Inflector.php
Shared instance
Variable $instance
Support_Resources::$instance in Resources.php
Method ignored
Support_Inflector::ignored() in Inflector.php
Test a word to see if it matches a pattern on the ignore list
Method info
Support_Resources_DefaultLogger::info() in DefaultLoggerProvider.php
Log an info message.
Method install
Support_Hook_ProjectInstall::install() in ProjectInstall.php
Invoked when the package is installed in a project
Method instance
Support_Resources::instance() in Resources.php
Returns the shared instance. Used only internally.
Method intersect_sorted
Support_ArrayHelper::intersect_sorted() in ArrayHelper.php
Returns a new array containing only those values from source which are also present in incl. Both input arrays must be sorted.
Method is_associative
Support_ArrayHelper::is_associative() in ArrayHelper.php
Test an array to see if it is associative. Note that this resets the array pointer.
Page Inflector.php
Inflector.php in Inflector.php
k
top
Variable $key
MissingRequiredConfigurationError::$key in Cfg.php
Method kexclude_sorted
Support_ArrayHelper::kexclude_sorted() in ArrayHelper.php
Similar to exlude_sorted, only the keys in source are compared to the values in exclude and only those key/value pairs whose keys are not in exlude are returned. The source array must be sorted by keys and the exclude array must be sorted by value.
Method kintersect_sorted
Support_ArrayHelper::kintersect_sorted() in ArrayHelper.php
Similar to intersect_sorted, only the keys in source are compared to the value in incl and only those key/value pairs whose keys are in incl are returned. The source array must be sorted by keys and the incl array must be sorted by value.
l
top
Variable $level
Support_Resources_DefaultLogger::$level in DefaultLoggerProvider.php
Variable $loggers
Support_Resources_DefaultLoggerProvider::$loggers in DefaultLoggerProvider.php
Method logger
Support_Resources::logger() in Resources.php
Get a logger instance
Method log_message
Support_Resources_DefaultLogger::log_message() in DefaultLoggerProvider.php
Send a message to the error log
Page LoggerProvider.php
LoggerProvider.php in LoggerProvider.php
m
top
Method mailFrom
Support_Mail_SMTPEngine::mailFrom() in SMTPEngine.php
Mail from command
Method merge_sorted
Support_ArrayHelper::merge_sorted() in ArrayHelper.php
Perform a basic two-way merge on pre-sorted input arrays.
Method message_mime_type
Support_Mail_Msg::message_mime_type() in Msg.php
Return the underlying message mime type (irrespective of attachments)
Class MissingRequiredConfigurationError
MissingRequiredConfigurationError in Cfg.php
Thrown if a required configuration value has not been specified
Method model
Support_Util::model() in Util.php
Returns an instance of the named class. This is a convenience method
Page MailEngine.php
MailEngine.php in MailEngine.php
Page Msg.php
Msg.php in Msg.php
n
top
Variable $name
Support_Mail_Attachment::$name in Attachment.php
The name of the attachment
Variable $name
Support_Resources_DefaultLogger::$name in DefaultLoggerProvider.php
Variable $nl
Support_Mail_SMTPEngine::$nl in SMTPEngine.php
Method negotiate
Support_Mail_SMTPEngine::negotiate() in SMTPEngine.php
Negotiate the transaction
o
top
Variable $optionName
Support_UnknownOptionError::$optionName in UnknownOptionError.php
Variable $outerBoundary
Support_Mail_Msg::$outerBoundary in Msg.php
Outer MIME boundary (for attachemnts)
Method optionName
Support_UnknownOptionError::optionName() in UnknownOptionError.php
Accessor for the option name
Method options_from_argument_list
Support_Util::options_from_argument_list() in Util.php
Return the options, if any, provided in a list of arguments and
p
top
Variable $pattern
Support_InflectorConversion::$pattern in Inflector.php
Variable $plurals
Support_Inflector::$plurals in Inflector.php
Plural conversions
Variable $previousHandler
Support_ErrorLogger::$previousHandler in ErrorLogger.php
Set to the previously registered handler which will be invoked after logging the error
Variable $providers
Support_Resources::$providers in Resources.php
Method pluralize
Support_Inflector::pluralize() in Inflector.php
Return the plural form of a word
Method pluralize_impl
Support_Inflector::pluralize_impl() in Inflector.php
Implementation for pluralize
Page ProjectInstall.php
ProjectInstall.php in ProjectInstall.php
r
top
Variable $recipients
Support_Mail_Msg::$recipients in Msg.php
List of message recipients
Variable $replace
Support_InflectorConversion::$replace in Inflector.php
Method rcptTo
Support_Mail_SMTPEngine::rcptTo() in SMTPEngine.php
Recipient command
Method recipients
Support_Mail_Msg::recipients() in Msg.php
Return the message's recipients
Method redirect
Support_Util::redirect() in Util.php
Redirect to a given URL
Method register
Support_ErrorLogger::register() in ErrorLogger.php
Register the logger
Method register_cache
Support_Resources::register_cache() in Resources.php
Register a cache provider
Method register_config_data
Support_Resources::register_config_data() in Resources.php
Register a config data provider
Method register_db_connection
Support_Resources::register_db_connection() in Resources.php
Register a db connection provider
Method register_logger
Support_Resources::register_logger() in Resources.php
Register a logger provider
Method register_provider
Support_Resources::register_provider() in Resources.php
Generic implementation of registering a resource provider
Method register_template_engine
Support_Resources::register_template_engine() in Resources.php
Register a template engine provider
Page Resources.php
Resources.php in Resources.php
s
top
Variable $singulars
Support_Inflector::$singulars in Inflector.php
Singular conversions
Variable $sock
Support_Mail_SMTPEngine::$sock in SMTPEngine.php
Variable $subject
Support_Mail_Msg::$subject in Msg.php
Message subject
Method sanitizeData
Support_Mail_SMTPEngine::sanitizeData() in SMTPEngine.php
Sanitize data for sending
Method send
Support_Mail_MailEngine::send() in MailEngine.php
Send an email message
Method send
Support_Mail_SMTPEngine::send() in SMTPEngine.php
Send an email message
Method send
Support_Mail_Engine::send() in Engine.php
Send an email message
Method send
Support_Mail_Msg::send() in Msg.php
Send the mail message
Method sendLine
Support_Mail_SMTPEngine::sendLine() in SMTPEngine.php
Send a line to the remove server
Method set
Support_Resources_DefaultCacheStore::set() in DefaultCacheProvider.php
Store a value for key.
Method set_default_cache
Support_Resources::set_default_cache() in Resources.php
Set the default cache provider
Method set_default_config_data
Support_Resources::set_default_config_data() in Resources.php
Set the default config data provider
Method set_default_db_connection
Support_Resources::set_default_db_connection() in Resources.php
Set the default db connection provider
Method set_default_logger
Support_Resources::set_default_logger() in Resources.php
Set the default logger provider
Method set_default_provider
Support_Resources::set_default_provider() in Resources.php
Generic implementation of setting a default resource provider
Method set_default_template_engine
Support_Resources::set_default_template_engine() in Resources.php
Set the default template engine provider
Method set_header
Support_Mail_Msg::set_header() in Msg.php
Add a header field
Method set_html_body
Support_Mail_Msg::set_html_body() in Msg.php
Set the HTML body
Method set_text_body
Support_Mail_Msg::set_text_body() in Msg.php
Set the text body
Method singularize
Support_Inflector::singularize() in Inflector.php
Return the singlar form of a word
Method singularize_impl
Support_Inflector::singularize_impl() in Inflector.php
Implementation for singularize
Method subject
Support_Mail_Msg::subject() in Msg.php
Return the message's subject
Page SMTPEngine.php
SMTPEngine.php in SMTPEngine.php
Class Support_ArrayHelper
Support_ArrayHelper in ArrayHelper.php
Additional helper functions for working with arrays
Class Support_ErrorLogger
Support_ErrorLogger in ErrorLogger.php
Utility to log PHP errors when they occur. Requires log_error to be registered with set_error_handler.
Class Support_Hook_ProjectInstall
Support_Hook_ProjectInstall in ProjectInstall.php
Custom install tasks for the support package
Class Support_Inflector
Support_Inflector in Inflector.php
The Inflector class handles conversion of words between their singular and plural forms.
Class Support_InflectorConversion
Support_InflectorConversion in Inflector.php
Used by the Support_Inflector class to hold conversion information
Class Support_InvalidResourceProviderError
Support_InvalidResourceProviderError in Resources.php
Thrown when an attempt is made to register a provider that does not implement the correct interface.
Class Support_Mail_Attachment
Support_Mail_Attachment in Attachment.php
Represents an email attachment
Class Support_Mail_Engine
Support_Mail_Engine in Engine.php
Interface for sending email
Class Support_Mail_MailEngine
Support_Mail_MailEngine in MailEngine.php
Default mail engine uses PHP's builtin mail function
Class Support_Mail_Msg
Support_Mail_Msg in Msg.php
Simple class for constructing an HTML mail message
Class Support_Mail_SMTPEngine
Support_Mail_SMTPEngine in SMTPEngine.php
Simple SMTP-based mail engine
Class Support_Resources
Support_Resources in Resources.php
Factory class for accessing system and application-wide resources
Class Support_Resources_CacheProvider
Support_Resources_CacheProvider in CacheProvider.php
Interface for providing a cache store for Support_Resources
Class Support_Resources_ConfigProvider
Support_Resources_ConfigProvider in ConfigProvider.php
Interface for providing config data for Support_Resources
Class Support_Resources_DBProvider
Support_Resources_DBProvider in DBProvider.php
Interface for providing database connections for Support_Resources
Class Support_Resources_DefaultCacheProvider
Support_Resources_DefaultCacheProvider in DefaultCacheProvider.php
The default cache provider returns
Class Support_Resources_DefaultCacheStore
Support_Resources_DefaultCacheStore in DefaultCacheProvider.php
Support_Resources_DefaultCacheStore provides the same public interface
Class Support_Resources_DefaultConfigProvider
Support_Resources_DefaultConfigProvider in DefaultConfigProvider.php
The default config data provider includes a file named config.php (from anywhere in the include path) which is expected to populate a global array named APP_CONFIG.
Class Support_Resources_DefaultDBProvider
Support_Resources_DefaultDBProvider in DefaultDBProvider.php
Default implementation of Support_Resources_DBProvider
Class Support_Resources_DefaultLogger
Support_Resources_DefaultLogger in DefaultLoggerProvider.php
A simplistic logger that passes message to error_log and does rudimentary filtering based on the current error reporting setting.
Class Support_Resources_DefaultLoggerProvider
Support_Resources_DefaultLoggerProvider in DefaultLoggerProvider.php
The default logger provider returns uses the
Class Support_Resources_DefaultTemplateEngine
Support_Resources_DefaultTemplateEngine in DefaultTemplateProvider.php
The default template engine
Class Support_Resources_DefaultTemplateProvider
Support_Resources_DefaultTemplateProvider in DefaultTemplateProvider.php
The default template engine provider. This provider returns a simple class which uses PHP's built-in templating abilities.
Class Support_Resources_LoggerProvider
Support_Resources_LoggerProvider in LoggerProvider.php
Interface for providing loggers for Support_Resources
Class Support_Resources_TemplateProvider
Support_Resources_TemplateProvider in TemplateProvider.php
Interface for providing template engines for Support_Resources
Class Support_TagHelper
Support_TagHelper in TagHelper.php
Helper functions for creating HTML tags
Class Support_UnknownClassError
Support_UnknownClassError in UnknownClassError.php
Thrown if an unknown/undeclared class is referenced
Class Support_UnknownOptionError
Support_UnknownOptionError in UnknownOptionError.php
Thrown if an invalid option key is supplied
Class Support_UnknownResourceProviderError
Support_UnknownResourceProviderError in Resources.php
Thrown when an attempt is made to access a resource from an unknown/unregistered provider.
Class Support_Util
Support_Util in Util.php
Shared utility functions for common tasks
t
top
Variable $template_dir
Support_Resources_DefaultTemplateEngine::$template_dir in DefaultTemplateProvider.php
Variable $text
Support_Mail_Msg::$text in Msg.php
Text body
Variable $type
Support_Mail_Attachment::$type in Attachment.php
The MIME type of the attachment
Page TemplateProvider.php
TemplateProvider.php in TemplateProvider.php
Page TagHelper.php
TagHelper.php in TagHelper.php
Method tableize
Support_Inflector::tableize() in Inflector.php
Convert a class name to a table name
Method tableize_impl
Support_Inflector::tableize_impl() in Inflector.php
Implementation for tableize
Method tag
Support_TagHelper::tag() in TagHelper.php
Output a non-content tag
Method template_engine
Support_Resources::template_engine() in Resources.php
Get an instance of the template engine
Method timestamp
Support_Resources_DefaultLogger::timestamp() in DefaultLoggerProvider.php
Return a formatted timestamp
u
top
Page UnknownClassError.php
UnknownClassError.php in UnknownClassError.php
Page UnknownOptionError.php
UnknownOptionError.php in UnknownOptionError.php
Page Util.php
Util.php in Util.php
Method underscore
Support_Inflector::underscore() in Inflector.php
Essentially the reverse of camelize. Converts a mixed case string to a lowercase underscore separated string of words.
v
top
Variable $variables
Support_Resources_DefaultTemplateEngine::$variables in DefaultTemplateProvider.php
Method validate_options
Support_Util::validate_options() in Util.php
Validate an options array against a set of permitted options. The
w
top
Method warn
Support_Resources_DefaultLogger::warn() in DefaultLoggerProvider.php
Log a warning message.
a b c d e f g h i k l m n o p r s t u v w _