UserTagOperations View code

UserTags class for admin

package

CMS
license

GPL

Methods

get_instance() : \UserTagOperations

Get a reference to thie only allowed instance of this class

static

Response

\UserTagOperations 

LoadUserTags()

Load all the information about user tags

GetUserTag(string $name) : string|false

Retrieve the body of a user defined tag

Arguments

string $name

User defined tag name

Response

string|false 

UserTagExists(string $name) : string|false

Test if a user defined tag with a specific name exists

Arguments

string $name

User defined tag name

Response

string|false 

SmartyTagExists(string $name, boolean $check_functions = true)

Test if a plugin function by this name exists.

..

Arguments

string $name

The name of the plugin to test

boolean $check_functions

Test if already registered to smarty.

SetUserTag(string $name, string $text, string $description, integer $id = null) : boolean

Add or update a named user defined tag into the database

Arguments

string $name

User defined tag name

string $text

Body of user defined tag

string $description

Description for the user defined tag.

integer $id

ID of existing user tag (for updates).

Response

boolean 

RemoveUserTag(string $name) : boolean

Remove a named user defined tag from the database

Arguments

string $name

User defined tag name

Response

boolean 

ListUserTags() : array|false

Return a list (suitable for use in a pulldown) of user tags.

Response

array|false 

CallUserTag(string $name, array &$params) : string|false

Execute a user defined tag

Arguments

string $name

The name of the user defined tag

array $params

Optional parameters.

Response

string|false

Back to top