UserTagOperations View code

A compatibility class to manage simple plugins.

Formerly 'UserDefinedTags' were stored in the database. In CMSMS 2.3+ this functionality was replaced with simple plugins. This class provides backwards compatibility. This class will be removed from CMSMS at some point in the future.

package

CMS
license

GPL
deprecated

User Tags (or UDTs) are replaced with Simple plugins since v2.3

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.

deprecated

Since 2.3, his function is now an empty stub.

GetUserTag(string $name) : string|false

Retrieve the body of a user defined tag Since 2.3, his function is now an empty stub.

deprecated

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

deprecated

Arguments

string $name

User defined tag name

Response

string|false 

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

Add or update a named user defined tag into the database Since 2.3, his function is now an empty stub.

deprecated

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 Since 2.3, his function is now an empty stub.

deprecated

Arguments

string $name

User defined tag name

Response

boolean 

ListUserTags() : array|false

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

deprecated

Response

array|false 

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

Execute a user defined tag

deprecated

Arguments

string $name

The name of the user defined tag

array $params

Optional parameters.

Response

mixed|false

The returned data from the user defined tag, or FALSE if the UDT could not be found.

Back to top