main dwoo class, allows communication between the compiler, template and data classes
requirements : php 5.2.0 or above (might work below, it's a rough estimate) SPL and PCRE extensions (for php versions prior to 5.3.0) mbstring extension for some string manipulation plugins (especially if you intend to use UTF-8) recommended : hash extension (for Dwoo_Template_String - minor performance boost) project created : 2008-01-05
This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.
Class | Description |
---|---|
Dwoo_Smarty__Adapter | a Smarty compatibility layer for Dwoo |
stores the output buffer during template runtime
directory where the cached templates are stored
defaults to DWOO_CACHEDIR (= dwoo_dir/cache by default)
defines how long (in seconds) the cached files must remain valid
can be overriden on a per-template basis
-1 = never delete
character set of the template, used by string manipulation plugins
it must be lowercase, but setCharset() will take care of that
directory where the compiled templates are stored
defaults to DWOO_COMPILEDIR (= dwoo_dir/compiled by default)
stores the current block plugin at the top of the stack during template runtime
stores the data during template runtime
stores the filter callbacks
global variables that are accessible through $dwoo.* in the templates
default values include:
$dwoo.version - current version number $dwoo.ad - a Powered by Dwoo link pointing to dwoo.org $dwoo.now - the current time $dwoo.template - the current template filename $dwoo.charset - the character set used by the template
on top of that, foreach and other plugins can store special values in there, see their documentation for more details.
the dwoo loader object used to load plugins by this dwoo instance
stores plugin proxy
stores the custom plugins callbacks
stores the resource types and associated classes / compiler classes
stores the instances of the class plugins during template runtime
stores the current scope during template runtime
this should ideally not be accessed directly from outside template code
stores the scope tree during template runtime
security policy object
stores the block plugins stack during template runtime
currently rendered template, set to null when not-rendering
adds a filter to this Dwoo instance, it will be used to filter the output of all the templates rendered by this instance
adds a custom plugin that is not in one of the plugin directories
adds a resource or overrides a default one
[runtime function] adds a block to the block stack
[runtime function] calls a php function
[runtime function] assign the value to the given variable
[runtime function] calls the process() method of the given class-plugin name
[util function] clears the cached templates if they are older than the given time
[runtime function] removes the plugin at the top of the block stack
calls the block buffer() function, followed by a call to end() and finally a call to process()
[runtime function] finds the closest block of the given type, starting at the top of the stack
constructor, sets the cache and compile dir to the default values if not provided
returns the given template rendered using the provided data and optional compiler
returns the cache directory with a trailing DIRECTORY_SEPARATOR
returns the default cache time that is used with templates that do not have a cache time set
returns the character set used by the string manipulation plugins
the charset is automatically lowercased
returns the compile directory with a trailing DIRECTORY_SEPARATOR
returns the custom plugins loaded
used by the Dwoo_ITemplate classes to pass the custom plugins to their Dwoo_ICompiler instance
returns the default compiler factory function for the given resource name
returns the current loader object or a default one if none is currently found
[runtime function] returns a Dwoo_Plugin of the given class
this is so a single instance of every class plugin is created at each template run, allowing class plugins to have "per-template-run" static variables
[runtime function] returns the parent block of the given block
returns the current plugin proxy object or null by default
[runtime function] returns a reference to the current scope
returns the current security policy object or null by default
returns the current template being rendered, when applicable, or null
re-initializes the globals array before each template run
this method is only callede once when the Dwoo object is created
re-initializes the runtime variables before each template run
override this method to inject data in the globals array if needed, this method is called before each template execution
[util function] checks if the input is an array or an iterator object, optionally it can also check if it's empty
[util function] checks whether the given template is cached or not
outputs the template instead of returning it, this is basically a shortcut for get(*, *, *, true)
[runtime function] reads a variable into the parent scope
[runtime function] reads a variable into the current scope
[runtime function] reads a variable into the given data array
removes a filter
removes a custom plugin
removes a custom resource
sets the cache directory and automatically appends a DIRECTORY_SEPARATOR
sets the default cache time to use with templates that do not have a cache time set
sets the character set used by the string manipulation plugins
the charset will be automatically lowercased
sets the compile directory and automatically appends a DIRECTORY_SEPARATOR
sets the default compiler factory function for the given resource name
a compiler factory must return a Dwoo_ICompiler object pre-configured to fit your needs
sets the loader object to use to load plugins
sets the object that must be used as a plugin proxy when plugin can't be found by dwoo's loader
[runtime function] sets the scope to the given scope string or array
sets the security policy object to enforce some php security settings
use this if untrusted persons can modify templates
[util function] fetches a template object of the given resource
[util function] triggers a dwoo error
Redirects all calls to unexisting to plugin proxy.
resets some runtime variables to allow a cloned object to be used to render sub-templates
constants that represents all plugin types
these are bitwise-operation-safe values to allow multiple types on a single plugin
constants that represents all plugin types
these are bitwise-operation-safe values to allow multiple types on a single plugin
constants that represents all plugin types
these are bitwise-operation-safe values to allow multiple types on a single plugin
constants that represents all plugin types
these are bitwise-operation-safe values to allow multiple types on a single plugin
constants that represents all plugin types
these are bitwise-operation-safe values to allow multiple types on a single plugin
constants that represents all plugin types
these are bitwise-operation-safe values to allow multiple types on a single plugin
constants that represents all plugin types
these are bitwise-operation-safe values to allow multiple types on a single plugin
unique number of this dwoo release
this can be used by templates classes to check whether the compiled template has been compiled before this release or not, so that old templates are recompiled automatically when Dwoo is updated
constants that represents all plugin types
these are bitwise-operation-safe values to allow multiple types on a single plugin
constants that represents all plugin types
these are bitwise-operation-safe values to allow multiple types on a single plugin
constants that represents all plugin types
these are bitwise-operation-safe values to allow multiple types on a single plugin
constants that represents all plugin types
these are bitwise-operation-safe values to allow multiple types on a single plugin
current version number
Documentation generated on Sat, 18 Jul 2009 21:04:54 +0200 by phpDocumentor 1.4.0