vB_Api_Tags
extends vB_Api
in package
vB_Api_Tags
Tags
Table of Contents
- __construct() : mixed
- __serialize() : array<string|int, mixed>
- __sleep() : array<string|int, mixed>
- __unserialize() : void
- __wakeup() : void
- addTags() : mixed
- Add tags to the current item implements vB_Tag::addTagsToContent
- callNamed() : The
- Call the given api function by name with a named arguments list.
- checkApiState() : mixed
- This method checks whether the API method is enabled.
- clearCache() : mixed
- Clears all previously loaded API objects.
- createSynonyms() : mixed
- deleteUserTagAssociations() : mixed
- Delete the associations between nodes and tags created by a user
- fetchTagByText() : array<string|int, mixed>
- Fetch tag by label
- fetchTagsForCloud() : array<string|int, mixed>
- Get an array of tags for building tag cloud
- fetchTagsForTagNavigation() : array<string|int, mixed>
- Returns an array of tags for the tag navigation widget
- getApiClassName() : mixed
- getAutocomplete() : mixed
- getNodeTags() : Tags
- Get tags with full info (userid, tagid, tagtext) from node.
- getTags() : mixed
- Get the tags
- getTagsList() : The
- Gets the tag list from an specific node.
- getTagSynonyms() : array<string|int, mixed>
- Get synonyms of a given tag
- insertTags() : mixed
- instance() : vB_Api
- Returns an instance of the API object which translates exceptions to an array Use this method for API clients.
- instanceInternal() : vB_Api
- Returns an instance of the API object which doesn't handle exceptions This should only be used in other API objects, not for clients of the API
- killTags() : array<string|int, mixed>
- Dissociates nodes from the specified tags, reindex the affected nodes, then finally deletes the specified tags.
- logSearchTags() : mixed
- Saves the seached for tags so we can build a search tag cloud based on it
- map_vb4_input_to_vb5() : string
- Returns vb5 api method name.
- map_vb5_errors_to_vb4() : mixed
- Alters the error array in any way necessary to interface correctly with vb4.
- map_vb5_output_to_vb4() : mixed
- Alters the output array in any way necessary to interface correctly with vb4.
- promoteTags() : true
- removeTags() : standard
- Remove tags from an item Implements vB_Tag::deleteTag
- updateTags() : array<string|int, mixed>
- Sets the tag matching tag text (case insensitive) to the exact text given Used to fix letter-case when merging tags via adminCP
- updateUserTags() : array<string|int, mixed>
- Adds new tags and/or deletes tags (added by the current user) if they have removed them from the list
- validTags() : bool
- Checks if the taglist contains invalid tags
Methods
__construct()
public
__construct() : mixed
Return values
mixed —__serialize()
public
__serialize() : array<string|int, mixed>
Return values
array<string|int, mixed> —__sleep()
public
__sleep() : array<string|int, mixed>
Return values
array<string|int, mixed> —__unserialize()
public
__unserialize(array<string|int, mixed> $serialized) : void
Parameters
- $serialized : array<string|int, mixed>
Return values
void —__wakeup()
public
__wakeup() : void
Return values
void —addTags()
Add tags to the current item implements vB_Tag::addTagsToContent
public
addTags(mixed $nodeid, mixed $taglist) : mixed
Parameters
- $nodeid : mixed
- $taglist : mixed
Return values
mixed —callNamed()
Call the given api function by name with a named arguments list.
public
callNamed() : The
Used primarily to translate REST requests into API calls.
Return values
The —return of the method or an error if the method doesn't exist, or is static, a constructor or destructor, or otherwise shouldn't be callable as and API method. It is also an error if the value of a paramater is not provided and that parameter doesn't have a default value.
checkApiState()
This method checks whether the API method is enabled.
public
checkApiState(mixed $method) : mixed
For extensions check make sure $controller property is already set.
Parameters
- $method : mixed
Return values
mixed —clearCache()
Clears all previously loaded API objects.
public
static clearCache() : mixed
Intended for use in tests where the loading pattern can cause issues with objects that cache thier own data.
Return values
mixed —createSynonyms()
public
createSynonyms(mixed $tagList, mixed $targetid) : mixed
Parameters
- $tagList : mixed
- $targetid : mixed
Tags
Return values
mixed —response
deleteUserTagAssociations()
Delete the associations between nodes and tags created by a user
public
deleteUserTagAssociations( $userid) : mixed
Parameters
Return values
mixed —fetchTagByText()
Fetch tag by label
public
fetchTagByText(string $tagtext) : array<string|int, mixed>
Parameters
- $tagtext : string
Return values
array<string|int, mixed> —-- tag record
fetchTagsForCloud()
Get an array of tags for building tag cloud
public
fetchTagsForCloud([mixed $taglevels = 5 ][, int $limit = 20 ][, string $type = 'nodes' ]) : array<string|int, mixed>
Parameters
- $taglevels : mixed = 5
- $limit : int = 20
-
How many tags to be fetched
- $type : string = 'nodes'
-
The type of tag cloud
Return values
array<string|int, mixed> —fetchTagsForTagNavigation()
Returns an array of tags for the tag navigation widget
public
fetchTagsForTagNavigation(mixed $channelId[, mixed $limit = 25 ][, mixed $addCloudInfo = false ][, mixed $levels = 5 ]) : array<string|int, mixed>
Parameters
- $channelId : mixed
- $limit : mixed = 25
- $addCloudInfo : mixed = false
- $levels : mixed = 5
Return values
array<string|int, mixed> —Tag information
getApiClassName()
public
static getApiClassName(mixed $controller) : mixed
Parameters
- $controller : mixed
Return values
mixed —getAutocomplete()
public
getAutocomplete(mixed $searchStr, mixed $limitstart[, mixed $limitnumber = 25 ]) : mixed
Parameters
- $searchStr : mixed
- $limitstart : mixed
- $limitnumber : mixed = 25
Return values
mixed —getNodeTags()
Get tags with full info (userid, tagid, tagtext) from node.
public
getNodeTags(mixed $nodeid) : Tags
Implements vB_Tags::getNodeTags
Parameters
- $nodeid : mixed
Return values
Tags —from node
getTags()
Get the tags
public
getTags(mixed $tagids) : mixed
Parameters
- $tagids : mixed
Return values
mixed —getTagsList()
Gets the tag list from an specific node.
public
getTagsList(mixed $nodeid) : The
Implements vB_Tags::fetchExistingTagList
Parameters
- $nodeid : mixed
Return values
The —taglist from node
getTagSynonyms()
Get synonyms of a given tag
public
getTagSynonyms(int $tagid) : array<string|int, mixed>
Parameters
- $tagid : int
Return values
array<string|int, mixed> —'tags' => array of $tagid => $tagtext for the synonyms of $tagid
insertTags()
public
insertTags(mixed $tagtext) : mixed
Parameters
- $tagtext : mixed
Return values
mixed —instance()
Returns an instance of the API object which translates exceptions to an array Use this method for API clients.
public
static instance(string $controller[, bool $refresh_cache = false ]) : vB_Api
Parameters
- $controller : string
-
-- name of the API controller to load
- $refresh_cache : bool = false
-
-- true if we want to force the cache to update with a new api object primarily intended for testing
Return values
vB_Api —instanceInternal()
Returns an instance of the API object which doesn't handle exceptions This should only be used in other API objects, not for clients of the API
public
static instanceInternal(string $controller[, bool $refresh_cache = false ]) : vB_Api
Parameters
- $controller : string
-
-- name of the API controller to load
- $refresh_cache : bool = false
-
-- true if we want to force the cache to update with a new api object primarily intended for testing
Return values
vB_Api —killTags()
Dissociates nodes from the specified tags, reindex the affected nodes, then finally deletes the specified tags.
public
killTags(int|array<string|int, int> $killTagList[, int $perpage = 1000 ]) : array<string|int, mixed>
Node processing works in batches and tag deletion will not happen until all nodes are unlinked from the tags. Caller may need to re-call this function to finish deleting tags based on return value.
Parameters
- $killTagList : int|array<string|int, int>
-
Tag id or ids to delete
- $perpage : int = 1000
-
Nodes to process perpage
Return values
array<string|int, mixed> —bool 'success' true if done int 'remaining' remaining node count
logSearchTags()
Saves the seached for tags so we can build a search tag cloud based on it
public
logSearchTags(array<string|int, mixed> $tagIds) : mixed
Parameters
- $tagIds : array<string|int, mixed>
-
the ids of the tags that it was searched for
Return values
mixed —map_vb4_input_to_vb5()
Returns vb5 api method name.
public
static map_vb4_input_to_vb5(string $method, array<string|int, mixed> &$request) : string
May alter request array.
Parameters
- $method : string
-
-- vb4 method name
- $request : array<string|int, mixed>
-
-- $_REQUEST array for this api request
Return values
string —map_vb5_errors_to_vb4()
Alters the error array in any way necessary to interface correctly with vb4.
public
static map_vb5_errors_to_vb4(string $method, array<string|int, mixed> &$data) : mixed
Parameters
- $method : string
-
-- vb4 method name
- $data : array<string|int, mixed>
-
-- error array from vb5
Return values
mixed —map_vb5_output_to_vb4()
Alters the output array in any way necessary to interface correctly with vb4.
public
static map_vb5_output_to_vb4(string $method, array<string|int, mixed> &$data) : mixed
Parameters
- $method : string
-
-- vb4 method name
- $data : array<string|int, mixed>
-
-- output array from vb5
Return values
mixed —promoteTags()
public
promoteTags(mixed $taglist) : true
Parameters
- $taglist : mixed
Tags
Return values
true —if success
removeTags()
Remove tags from an item Implements vB_Tag::deleteTag
public
removeTags(mixed $nodeid[, mixed $tags = '' ]) : standard
Parameters
- $nodeid : mixed
- $tags : mixed = ''
Return values
standard —success array
updateTags()
Sets the tag matching tag text (case insensitive) to the exact text given Used to fix letter-case when merging tags via adminCP
public
updateTags(string $tagtext) : array<string|int, mixed>
Parameters
- $tagtext : string
Return values
array<string|int, mixed> —'result'
updateUserTags()
Adds new tags and/or deletes tags (added by the current user) if they have removed them from the list
public
updateUserTags(mixed $nodeid[, array<string|int, mixed> $taglist = array() ]) : array<string|int, mixed>
Parameters
- $nodeid : mixed
- $taglist : array<string|int, mixed> = array()
Return values
array<string|int, mixed> —List of all tags on the node
validTags()
Checks if the taglist contains invalid tags
public
validTags(mixed $taglist, int $nodeid) : bool
Parameters
- $taglist : mixed
- $nodeid : int
-
[The nodeid of the node the tags belong. If 0 this is done on node entry]
Tags
Return values
bool —-- returns true on success, otherwise throws an exception.