vB_Api_Tags
extends vB_Api
in package
vB_Api_Tags
Table of Contents
Methods
- __construct() : mixed
- __serialize() : array<string|int, mixed>
- __sleep() : array<string|int, mixed>
- __unserialize() : void
- __wakeup() : void
- addTags() : array<string|int, mixed>
- Add tags to the current item
- 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() : array<string|int, mixed>
- Get tags with full info (userid, tagid, tagtext) from node.
- getSuggestedTagsForNode() : mixed
- getSuggestedTagsForNodeText() : mixed
- 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() : array<string|int, mixed>
- Inserts new tags to database
- 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.
- 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() : array<string|int, mixed>
- Remove tags from an item
- 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
__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>
__wakeup()
public
__wakeup() : void
addTags()
Add tags to the current item
public
addTags(int $nodeid, string|array<string|int, mixed> $taglist) : array<string|int, mixed>
Parameters
- $nodeid : int
- $taglist : string|array<string|int, mixed>
Return values
array<string|int, mixed> —-- tag information for the tags on the node. See getNodeTags
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
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.
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(mixed $userid) : mixed
Parameters
- $userid : 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' ][, mixed $tagsonly = false ]) : 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
- $tagsonly : mixed = false
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
getAutocomplete()
public
getAutocomplete(mixed $searchStr[, mixed $limitstart = 0 ][, mixed $limitnumber = 25 ]) : mixed
Parameters
- $searchStr : mixed
- $limitstart : mixed = 0
- $limitnumber : mixed = 25
getNodeTags()
Get tags with full info (userid, tagid, tagtext) from node.
public
getNodeTags(int $nodeid) : array<string|int, mixed>
Parameters
- $nodeid : int
Return values
array<string|int, mixed> —'tags' -- tags on the node 'displaytags' -- list of tag text for the tags 'userid' -- current user 'maxtags' -- max tags for the node 'maxusertags' -- max tags for the current user on this node 'canmanagetags' -- can the current user manage tags on this node
getSuggestedTagsForNode()
public
getSuggestedTagsForNode(mixed $nodeid) : mixed
Parameters
- $nodeid : mixed
getSuggestedTagsForNodeText()
public
getSuggestedTagsForNodeText(mixed $text) : mixed
Parameters
- $text : mixed
getTags()
Get the tags
public
getTags(mixed $tagids) : mixed
Parameters
- $tagids : 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()
Inserts new tags to database
public
insertTags(mixed $tagtext) : array<string|int, mixed>
Parameters
- $tagtext : mixed
Return values
array<string|int, 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_ApiinstanceInternal()
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_ApikillTags()
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
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
stringmap_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
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
promoteTags()
public
promoteTags(mixed $taglist) : true
Parameters
- $taglist : mixed
Tags
Return values
true —if success
removeTags()
Remove tags from an item
public
removeTags(int $nodeid[, string|array<string|int, mixed> $tags = [] ]) : array<string|int, mixed>
Parameters
- $nodeid : int
- $tags : string|array<string|int, mixed> = []
-
-- Tags to delete (if not specified it will delete all tags from node).
Return values
array<string|int, mixed> —-- 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<string|int, mixed>
Parameters
- $nodeid : mixed
- $taglist : array<string|int, mixed> = []
Return values
array<string|int, mixed> —-- tag information for the tags on the node. See getNodeTags
validTags()
Checks if the taglist contains invalid tags
public
validTags(mixed $taglist[, int $nodeid = 0 ]) : bool
Parameters
- $taglist : mixed
- $nodeid : int = 0
-
[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.