Public Class Methods | |
| new (BigSWAF::AppHandler application) | |
| Create one DispEngine. | |
Public Object Methods | |
| init (BigSWAF::AppHandler application) | |
| BigSWAF::AppHandler | application (BigSWAF::AppHandler application) |
| Get/set the application this display engine is related to. | |
| hashref | globalvars (scalar name, scalar value) |
| Set the value of a "global" variable. | |
| retval | setglobal (scalar name, scalar value) |
| Similiar to globalvars(). | |
| retval | clone () |
| Returns an identical copy of the DispEngine object. | |
| retval | language (scalar language) |
| Get/set the language to be used when filling in language specific text into a template. | |
| retval | replace_vars_file (scalar skin, scalar vars, scalar template, scalar file, scalar replacer) |
| Run replace_vars() and write the results to a file. | |
| retval | replace_vars (scalar skin, scalar vars, scalar template) |
| Fill in a template and return the result as a text string. | |
| retval | get_var (scalar name, scalar skin, scalar vars, scalar localvars) |
| retval | get_skin (scalar skin, scalar what) |
| retval | find_skin (scalar name) |
| retval | bypass_skincache (scalar bypass) |
| hashref | read_skin (scalar name, hashref skinbase) |
| Given the name of a skin, slurps the files out of the corresponding skin directory into an in-memory object (hash) and returns this object. | |
| hashref | skin (scalar skinnames) |
| If called without an argument skin() returns the skin of a former skin() invocation. | |
| retval | cache_skin (scalar name, scalar skin) |
| retval | encode (scalar text) |
| retval | encode_args (scalar args) |
| retval | encode_formargs (scalar args) |
| retval | encode_tagtext (scalar arg) |
| retval | encode_text (scalar text) |
| retval | softbreak (scalar text, scalar maxchunksize) |
| Insert "soft break" positions in a string. | |
| retval | persistent (scalar attrs, scalar value) |
| retval | formargs (scalar args) |
Public Functions | |
| retval | logmsg (scalar prio, scalar msg) |
Protected Object Methods | |
| protected retval | _replace_vars (scalar skin, scalar vars, scalar template, scalar depth, scalar localvars) |
| protected retval | _one_var (scalar skin, scalar vars, scalar var, scalar depth, scalar localvars, scalar template) |
| protected retval | _loop (scalar skin, scalar vars, scalar localvars, scalar template) |
This class uses the skins in the skin directory as templates the applications can manipulate with various methods.
|
||||||||||||||||||||
|
|
|
||||||||||||||||||||||||||||
|
|
|
||||||||||||||||||||||||
|
|
|
|
Get/set the application this display engine is related to.
|
|
|
|
|
||||||||||||
|
|
|
|
Returns an identical copy of the DispEngine object.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||||||||||||
|
|
|
||||||||||||||||||||
|
|
|
||||||||||||
|
Set the value of a "global" variable. The global variables are remembered during multiple replace_vars() calls and are complementing the variables directly passed to the replace methods.
|
|
|
|
|
|
Get/set the language to be used when filling in language specific text into a template. The language specific texts are extracted from the respective .lang file within the skin, therefore the language set should correspond to one of the .lang files of the application. |
|
||||||||||||
|
|
|
|
Create one DispEngine. The default display engine for an application is automatically set up by BigSWAF::Application and is available via its BigSWAF::Application::display() method. |
|
||||||||||||
|
|
|
||||||||||||
|
Given the name of a skin, slurps the files out of the corresponding skin directory into an in-memory object (hash) and returns this object. Since skin reading is an I/O-intense operation the results are cached. If in the optional skinbase argument a former result of read_skin() is passed, then the new skin is added to this skin.
|
|
||||||||||||||||
|
Fill in a template and return the result as a text string. The skin argument is expected to be a hash ref as returned by skin(name) - if undefined replace_vars() uses the default skin (as returned by the skin() method). The vars argument is a reference to a hash containing variable names (keys) and values that should be filled into the template. The template argument must either be a template itself (e.g. skin()->{"sometemplate.proto"}) or a string containing the name of a template. In the latter case the name must be preceded by an equal sign (e.g. "=sometemplate.proto"). The vars hash is complemented by the global vars as accessible via globalvars() and setglobalvar().
|
|
||||||||||||||||||||||||
|
Run replace_vars() and write the results to a file.
|
|
||||||||||||
|
Similiar to globalvars(). Does not return the global variable hash. |
|
|
If called without an argument skin() returns the skin of a former skin() invocation. Otherwise the skinnames argument is expected to be a comma-separated list of skin names. This list is preceded by some default skins that are always read-in like "common", "default" and followed by "interface_(interface)" (where the (interface) name depends on the method BigSWAF was called - usually it is "html"). This means that the resulting skinset bases on the common and default skinsets, any additional skin names passed via skinnames complement or override settings of these skins and finally the respective interface_* skin overrides/complements the result. |
|
||||||||||||
|
Insert "soft break" positions in a string.
|
1.4.5