UserTagOperations
in package
UserTags class for admin
Tags
Table of Contents
Methods
- CallUserTag() : mixed|false
- Execute a user defined tag
- get_instance() : UserTagOperations
- Get a reference to thie only allowed instance of this class
- GetUserTag() : string|false
- Retrieve the body of a user defined tag
- ListUserTags() : array<string|int, mixed>|false
- Return a list (suitable for use in a pulldown) of user tags.
- LoadUserTags() : mixed
- Load all the information about user tags
- RemoveUserTag() : bool
- Remove a named user defined tag from the database
- SetUserTag() : bool
- Add or update a named user defined tag into the database
- SmartyTagExists() : mixed
- Test if a plugin function by this name exists.
- UserTagExists() : string|false
- Test if a user defined tag with a specific name exists
Methods
CallUserTag()
Execute a user defined tag
public
CallUserTag(string $name, array<string|int, mixed> &$params) : mixed|false
Parameters
- $name : string
-
The name of the user defined tag
- $params : array<string|int, mixed>
-
Optional parameters.
Return values
mixed|false —The returned data from the user defined tag, or FALSE if the UDT could not be found.
get_instance()
Get a reference to thie only allowed instance of this class
public
static & get_instance() : UserTagOperations
Return values
UserTagOperationsGetUserTag()
Retrieve the body of a user defined tag
public
GetUserTag(string $name) : string|false
Parameters
- $name : string
-
User defined tag name
Return values
string|falseListUserTags()
Return a list (suitable for use in a pulldown) of user tags.
public
ListUserTags() : array<string|int, mixed>|false
Return values
array<string|int, mixed>|falseLoadUserTags()
Load all the information about user tags
public
LoadUserTags() : mixed
RemoveUserTag()
Remove a named user defined tag from the database
public
RemoveUserTag(string $name) : bool
Parameters
- $name : string
-
User defined tag name
Return values
boolSetUserTag()
Add or update a named user defined tag into the database
public
SetUserTag(string $name, string $text, string $description[, int $id = null ]) : bool
Parameters
- $name : string
-
User defined tag name
- $text : string
-
Body of user defined tag
- $description : string
-
Description for the user defined tag.
- $id : int = null
-
ID of existing user tag (for updates).
Return values
boolSmartyTagExists()
Test if a plugin function by this name exists.
public
SmartyTagExists(string $name[, bool $check_functions = true ]) : mixed
..
Parameters
- $name : string
-
The name of the plugin to test
- $check_functions : bool = true
-
Test if already registered to smarty.
UserTagExists()
Test if a user defined tag with a specific name exists
public
UserTagExists(string $name) : string|false
Parameters
- $name : string
-
User defined tag name