Welcompose
[ class tree: Welcompose ] [ index: Welcompose ] [ all elements ]

Class: Utility_PluginUtility

Source Location: /utility_classes/pluginutility.class.php

Class Overview




Variables

Methods



Class Details

[line 39]


[ Top ]


Class Variables

static $instance =  null

[line 46]

Singleton



Tags:

access:  public

Type:   object


[ Top ]

$base =  null

[line 53]

Reference to base class



Tags:

access:  public

Type:   object


[ Top ]



Class Methods


constructor __construct [line 60]

Utility_PluginUtility __construct( )

Start instance of base class, load configuration and establish database connection. Please don't call the constructor direcly, use the singleton pattern instead.



Tags:

access:  public


[ Top ]

method getTextMacroTagArgs [line 115]

array getTextMacroTagArgs( $args, [bool $security = true], array preg_replace_callback())

Creates key=>value array from a text macro tag string. Takes array with preg_replace_callback() output as first argument. The second argument is a switch to enable/disable key/value security/sanitizing. Returns array.



Tags:

throws:  Utility_PluginUtilityException
access:  public


Parameters:

array   preg_replace_callback()   output
bool   $security   Enable/disable security
   $args  

[ Top ]

method getTextMacroTagPattern [line 88]

string getTextMacroTagPattern( string $name, [bool $dotall = false])

Returns PCRE search pattern for extraction of a text macro tag. Takes the name of the text macro tag as first argument. The second argument is a switch to enable/disable multi line tags.



Tags:

throws:  Utility_PluginUtilityException
access:  public


Parameters:

string   $name   Tag name
bool   $dotall   Multi line tags

[ Top ]


Documentation generated on Sun, 08 Jan 2012 17:51:57 +0100 by phpDocumentor 1.4.3