vBulletin v6.0.4

vB_Api_Content_Channel extends vB_Api_Content
in package

vB_Api_Content_Channel

Tags
access

public

Table of Contents

Methods

__serialize()  : array<string|int, mixed>
__sleep()  : array<string|int, mixed>
__unserialize()  : void
__wakeup()  : void
add()  : int
Adds a new channel.
callNamed()  : The
Call the given api function by name with a named arguments list.
canAddChannel()  : array<string|int, mixed>
Tells whether or not the current user can add a new channel for the given node
canViewReportsAndInfractions()  : array<string|int, mixed>
Returns array of data indicating user's view permissions for the report & infraction channels.
checkApiState()  : mixed
This method checks whether the API method is enabled.
cleanInput()  : mixed
Cleans the input in the $data array, directly updating $data.
cleanPreviewContent()  : mixed
Takes a node record and removes the data cannot be viewed based on public_preview.
clearCache()  : mixed
Clears all previously loaded API objects.
createQuoteText()  : string
This returns the text to quote a node. Used initially for private messaging.
delete()  : bool
Permanently deletes a node
extractMedia()  : mixed
Extracts the video and photo content from text.
fetchChannelByGUID()  : array<string|int, mixed>
Returns a channel record based on its node guid
fetchChannelById()  : array<string|int, mixed>
Returns a channel record based on its node id
fetchChannelIcon()  : mixed
Get a blog icon
fetchChannelIdByGUID()  : int
Returns a channel id based on its node guid
fetchTableName()  : array<string|int, mixed>
Returns the tables used by this content type.
fetchTopLevelChannelIds()  : array<string|int, mixed>
Fetches the top level Channels/Categories
getApiClassName()  : mixed
getAutocomplete()  : array<string|int, mixed>
Get autocomplete results for channels.
getAutoparseLinks()  : mixed
Returns the autoparselinks setting. In the public API for createcontent getPreview() use, not really meant for regular usage.
getBareContent()  : mixed
Returns the node content, channel routeid and title, and starter route and title, but no permissions or other subsidiary data
getBbcodeOptions()  : array<string|int, mixed>
Returns an array with bbcode options for the node.
getCanModerate()  : mixed
Determines if the current user can moderate the passed node
getContent()  : mixed
Alias for @getFullContent
getContentApi()  : mixed
Returns a content api of the appropriate type
getContributors()  : array<string|int, mixed>
Returs the contributors for a channel
getConversationParent()  : array<string|int, mixed>|false
Gets the conversation starter for a node. If the node is a channel it returns the channel array.
getFullContent()  : array<string|int, mixed>
Returns the node content plus the channel routeid and title, and starter route and title, and permissions and other data
getQuoteText()  : string
This returns the text to quote a node. Used initially for private messaging.
getTextCountChange()  : int
Returns textCountChange property
getTimeNow()  : int
Gives the current board time- needed to set publishdate.
getTopLevelChannel()  : int|false
Fetches the top level Channel/Category for a node/nodes
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
isPublished()  : bool
Determines if this record is in a published state
isVisitorMessage()  : bool
Determines whether a specific node is a visitor message
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.
switchForumCategory()  : bool
Converts a channel from a forum to a category or vice versa.
update()  : bool
Updates the given channel
validateIcon()  : true
Checks the permissions to upload a channel icon

Methods

__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>

add()

Adds a new channel.

public add(mixed $data[, mixed $options = array() ]) : int
Parameters
$data : mixed
$options : mixed = array()
Return values
int —

the new nodeid

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.

canAddChannel()

Tells whether or not the current user can add a new channel for the given node

public canAddChannel(mixed $nodeid) : array<string|int, mixed>
Parameters
$nodeid : mixed
Tags
throws
vB_Exception_Api

'invalid_data_w_x_y_z', 'no_permission'

Return values
array<string|int, mixed> —

Array containing checks information. It contains two keys or the standard error array: 'can' -- to indicate if user can or can not add channel to the node. 'exceeded' -- value indicating if user already reached the max channels allowed at node level.

canViewReportsAndInfractions()

Returns array of data indicating user's view permissions for the report & infraction channels.

public canViewReportsAndInfractions() : array<string|int, mixed>

Used by template widget_privatemessage_navigation

Return values
array<string|int, mixed> —
  • Array 'result' - bool 'can_view_reports' True if user can view the report channel - bool 'can_view_infractions' True if user can view the infraction channel Ex: array('result' => array('can_view_reports' => true, 'can_view_infractions' => false))

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

cleanInput()

Cleans the input in the $data array, directly updating $data.

public cleanInput(mixed $data[, mixed $nodeid = false ]) : mixed
Parameters
$data : mixed
$nodeid : mixed = false

cleanPreviewContent()

Takes a node record and removes the data cannot be viewed based on public_preview.

public cleanPreviewContent(mixed $record) : mixed

It's called from the search Api.

Parameters
$record : 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.

createQuoteText()

This returns the text to quote a node. Used initially for private messaging.

public createQuoteText(mixed $nodeid, mixed $pageText) : string
Parameters
$nodeid : mixed
$pageText : mixed
Return values
string —

Quote text.

delete()

Permanently deletes a node

public delete(mixed $nodeid) : bool
Parameters
$nodeid : mixed
Return values
bool

extractMedia()

Extracts the video and photo content from text.

public extractMedia(mixed $rawtext) : mixed
Parameters
$rawtext : mixed
Return values
mixed —

Array of "photo", "video". Each is an array of images.

fetchChannelByGUID()

Returns a channel record based on its node guid

public fetchChannelByGUID(mixed $guid) : array<string|int, mixed>
Parameters
$guid : mixed
Return values
array<string|int, mixed> —

Channel information

fetchChannelById()

Returns a channel record based on its node id

public fetchChannelById(mixed $nodeid) : array<string|int, mixed>
Parameters
$nodeid : mixed
Return values
array<string|int, mixed> —

Channel information

fetchChannelIcon()

Get a blog icon

public fetchChannelIcon(mixed $nodeid[, mixed $type = vB_Api_Filedata::SIZE_FULL ]) : mixed
Parameters
$nodeid : mixed
$type : mixed = vB_Api_Filedata::SIZE_FULL
Return values
mixed —

the raw content of the image.

fetchChannelIdByGUID()

Returns a channel id based on its node guid

public fetchChannelIdByGUID(mixed $guid) : int
Parameters
$guid : mixed
Return values
int —

Channel id

fetchTableName()

Returns the tables used by this content type.

public fetchTableName() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Array of table names

fetchTopLevelChannelIds()

Fetches the top level Channels/Categories

public fetchTopLevelChannelIds() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Array of channel information

getApiClassName()

public static getApiClassName(mixed $controller) : mixed
Parameters
$controller : mixed

getAutocomplete()

Get autocomplete results for channels.

public getAutocomplete(string $searchStr[, int $limitstart = 0 ][, int $limitnumber = 15 ]) : array<string|int, mixed>
Parameters
$searchStr : string

-- Will return channels that match this as a prefix.

$limitstart : int = 0

-- Place to start in the list.

$limitnumber : int = 15

-- Place to start in the list.

Return values
array<string|int, mixed>

getAutoparseLinks()

Returns the autoparselinks setting. In the public API for createcontent getPreview() use, not really meant for regular usage.

public getAutoparseLinks(mixed $data) : mixed
Parameters
$data : mixed

Input array similar to what would be passed into content_text::text() expected: htmlstate, disable_bbcode, parentid

Return values
mixed —

['autoparselinks' => (bool)]

getBareContent()

Returns the node content, channel routeid and title, and starter route and title, but no permissions or other subsidiary data

public getBareContent(mixed $nodeid[, mixed $permissions = false ]) : mixed
Parameters
$nodeid : mixed
$permissions : mixed = false

getBbcodeOptions()

Returns an array with bbcode options for the node.

public getBbcodeOptions(int $nodeId) : array<string|int, mixed>
Parameters
$nodeId : int
Return values
array<string|int, mixed> —

Array of Bbcodee options from the datastore

getCanModerate()

Determines if the current user can moderate the passed node

public getCanModerate(mixed $node) : mixed
Parameters
$node : mixed

getContent()

Alias for @getFullContent

public getContent(mixed $nodeid[, mixed $permissions = false ]) : mixed
Parameters
$nodeid : mixed
$permissions : mixed = false

getContentApi()

Returns a content api of the appropriate type

public static getContentApi(mixed $contenttypeid) : mixed
Parameters
$contenttypeid : mixed
Return values
mixed —

Content api object

getContributors()

Returs the contributors for a channel

public getContributors(mixed $nodeId) : array<string|int, mixed>
Parameters
$nodeId : mixed
Return values
array<string|int, mixed> —

List of channel contributors/authors.

getConversationParent()

Gets the conversation starter for a node. If the node is a channel it returns the channel array.

public getConversationParent(int $nodeid) : array<string|int, mixed>|false
Parameters
$nodeid : int
Tags
throws
vB_Exception_Api
Return values
array<string|int, mixed>|false —

The starter node array. False when the node lookup fails

getFullContent()

Returns the node content plus the channel routeid and title, and starter route and title, and permissions and other data

public getFullContent(int $nodeid[, array<string|int, mixed> $permissions = false ]) : array<string|int, mixed>
Parameters
$nodeid : int
$permissions : array<string|int, mixed> = false

(unused)

Return values
array<string|int, mixed> —

The standard array of node data

getQuoteText()

This returns the text to quote a node. Used initially for private messaging.

public getQuoteText(mixed $nodeid) : string
Parameters
$nodeid : mixed
Return values
string —

Quote text

getTextCountChange()

Returns textCountChange property

public getTextCountChange() : int
Return values
int

getTimeNow()

Gives the current board time- needed to set publishdate.

public getTimeNow() : int
Return values
int

getTopLevelChannel()

Fetches the top level Channel/Category for a node/nodes

public getTopLevelChannel(int|array<string|int, mixed> $nodeids) : int|false
Parameters
$nodeids : int|array<string|int, mixed>

An integer Node ID or an array of int Node IDs.

Tags
throws
vB_Exception_Api

'invalid_data'

Return values
int|false —

Returns false on failure or the top level channel node ID.

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

isPublished()

Determines if this record is in a published state

public isPublished(mixed $data) : bool
Parameters
$data : mixed
Return values
bool

isVisitorMessage()

Determines whether a specific node is a visitor message

public isVisitorMessage(mixed $nodeid) : bool
Parameters
$nodeid : mixed
Return values
bool

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

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

switchForumCategory()

Converts a channel from a forum to a category or vice versa.

public switchForumCategory(bool $makeCategory, int $nodeId) : bool
Parameters
$makeCategory : bool

If true it will convert the channel to a category, if false to a forum.

$nodeId : int

Channel Node ID.

Return values
bool

update()

Updates the given channel

public update(int $nodeid, int $data) : bool
Parameters
$nodeid : int
$data : int
Return values
bool

validateIcon()

Checks the permissions to upload a channel icon

public validateIcon(int $nodeid, array<string|int, mixed> $data) : true
Parameters
$nodeid : int
$data : array<string|int, mixed>
Return values
true —

Returns true if the icon is acceptible


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results