vBulletin v6.0.4

vB_Api_Blog extends vB_Api
in package

vB_Api_Blog

Table of Contents

Methods

__serialize()  : array<string|int, mixed>
__sleep()  : array<string|int, mixed>
__unserialize()  : void
__wakeup()  : void
callNamed()  : The
Call the given api function by name with a named arguments list.
cancelChannelTransfer()  : bool
Cancels a channel transfer request
canCreateBlog()  : bool
Checks if the user can create a new Blog
checkApiState()  : mixed
This method checks whether the API method is enabled.
clearCache()  : mixed
Clears all previously loaded API objects.
createBlog()  : array<string|int, mixed>
Creates a blog channel
fetchContributors()  : array<string|int, mixed>
Returns the userids of the channel contributors (moderators)
fetchOwner()  : int
Returns the userid of the channel owner
fetchSubscribers()  : mixed
Fetches information about members (subscribers) for a blog.
getApiClassName()  : mixed
getBlogChannel()  : int
getBlogInfo()  : mixed
getBlogSidebarModules()  : array<string|int, mixed>
Returns the widget instances that are used for blog sidebar.
getChannelAdminPerms()  : array<string|int, mixed>
Returns a list of channel owner permissions and their values
getMembersCount()  : int
Gets the number of members for the given blog channel
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
isBlogNode()  : bool
Determines if the given node is a blog-related node (blog entry).
isChannelMember()  : int
Indicates if the current user is member of a given channelid
isChannelModerator()  : bool
Indicates if the given user or current user is owner or mod from given channel.
leaveChannel()  : bool
Handles leave in special channels for the current or specified user.
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.
removeChannelMember()  : bool
Handles removing a channel member
removeChannelModerator()  : bool
Handles removing a channel moderator
saveBlogSidebarModules()  : mixed
Saves channel configuration for blog sidebar
subscribeChannel()  : bool
Handles subscription in special channels for the current user.
userCanComment()  : array<string|int, mixed>
Returns whether current user can comment in the blog or not

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>

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.

cancelChannelTransfer()

Cancels a channel transfer request

public cancelChannelTransfer(int $channelId, int $userId) : bool
Parameters
$channelId : int
$userId : int
Return values
bool —

Indicates if the action succeeded

canCreateBlog()

Checks if the user can create a new Blog

public canCreateBlog(mixed $parentid) : bool
Parameters
$parentid : mixed
Tags
throws
vB_Exception_Api

invalid_blog_parent

throws
vB_Exception_Api

you_can_only_create_x_blogs

Return values
bool

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.

createBlog()

Creates a blog channel

public createBlog(mixed $input) : array<string|int, mixed>
Parameters
$input : mixed
Return values
array<string|int, mixed>

fetchContributors()

Returns the userids of the channel contributors (moderators)

public fetchContributors(mixed $nodeid[, mixed $count = false ]) : array<string|int, mixed>
Parameters
$nodeid : mixed
$count : mixed = false
Return values
array<string|int, mixed> —

Array of channel contributor user IDs

fetchOwner()

Returns the userid of the channel owner

public fetchOwner(mixed $nodeid) : int
Parameters
$nodeid : mixed
Return values
int —

Channel owner user ID

fetchSubscribers()

Fetches information about members (subscribers) for a blog.

public fetchSubscribers(int $nodeid[, int $pageno = 1 ][, int $perpage = 20 ][, bool $thumb = false ]) : mixed

For actual node subscription information

Parameters
$nodeid : int

the nodeid

$pageno : int = 1

page for which we want data

$perpage : int = 20

items per page

$thumb : bool = false

whether to get the thumbnail avatar

Tags
see
vB_Api_Follow::fetchNodeSubscribers()
Return values
mixed —

array with 'count'=> total subscriber count 'pagecount' => total number of pages 'groupid' => id for the channel member group 'members'=> array of users:

  • avatarUrl
  • username
  • userid

getApiClassName()

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

getBlogChannel()

public getBlogChannel() : int
Tags
uses
fetch

the id of the global Blog Channel

Return values
int —

nodeid of actual Main Blog Channel

getBlogInfo()

public getBlogInfo([mixed $from = 1 ][, mixed $perpage = 20 ][, mixed $authorid = 0 ][, mixed $sort_field = 'title' ][, mixed $sort_order = 'asc' ]) : mixed
Parameters
$from : mixed = 1
$perpage : mixed = 20
$authorid : mixed = 0
$sort_field : mixed = 'title'
$sort_order : mixed = 'asc'
Tags
uses
Get

info on every Blog Channel

Return values
mixed —

array containing the blog channel info we need

getBlogSidebarModules()

Returns the widget instances that are used for blog sidebar.

public getBlogSidebarModules([mixed $channelId = 0 ]) : array<string|int, mixed>

This method should be used only for owner configuration of the blog, not rendering

Parameters
$channelId : mixed = 0
Return values
array<string|int, mixed> —

An array of widget instances, keyed by widget instance ID [ widget instance ID => [ title widgetid widgetinstanceid hidden (int flag) ] ]

getChannelAdminPerms()

Returns a list of channel owner permissions and their values

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

List of permissions and their values: canmanageusers (value from moderatorpermissions:canaddowners) canmoderate (value from moderatorpermissions:canmoderateposts) canconfig (value from forumpermissions2:canconfigchannel) canmanagechannel (value from forumpermissions2:candeletechannel) canstats true

getMembersCount()

Gets the number of members for the given blog channel

public getMembersCount(mixed $nodeid) : int
Parameters
$nodeid : mixed
Tags
throws
vB_Exception_Api

invalid_node_id If it is not a blog channel

Return values
int —

number of members

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

isBlogNode()

Determines if the given node is a blog-related node (blog entry).

public isBlogNode(int $nodeId[, array<string|int, mixed> $node = false ]) : bool
Parameters
$nodeId : int
$node : array<string|int, mixed> = false

-- optionally provide the node array to save a lookup

Return values
bool

isChannelMember()

Indicates if the current user is member of a given channelid

public isChannelMember(mixed $channelId) : int
Parameters
$channelId : mixed
Return values
int —

Values of the member status. 0 = no member 1 = member 2 = request pending

isChannelModerator()

Indicates if the given user or current user is owner or mod from given channel.

public isChannelModerator(int $channelId[, int $checkUser = 0 ]) : bool

Owner can't leave the channel ditto for mods (managers or contributors).

Parameters
$channelId : int

The channel id we are checking.

$checkUser : int = 0

Optional, the user id we're checking if we're not checking the current user

Return values
bool —

Indicaticates if user is owner/mod

leaveChannel()

Handles leave in special channels for the current or specified user.

public leaveChannel(int $channelId[, int $leavingUser = 0 ]) : bool

This is used basically for social groups handling the join/subscribe logical but we are implementing here in case requirements change and join/subscribe gets into blogs too.

Parameters
$channelId : int

The channel id we are leaving

$leavingUser : int = 0

Optional, userid of the user leaving the channel. If not provided, current user will leave the channel.

Return values
bool —

Indicates if action succeeded.

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

removeChannelMember()

Handles removing a channel member

public removeChannelMember(int $channelId, int $userId) : bool
Parameters
$channelId : int

The channel id of that $userId is leaving

$userId : int

Userid of the user leaving the channel.

Return values
bool —

Indicates if the user was removed successfully

removeChannelModerator()

Handles removing a channel moderator

public removeChannelModerator(int $channelId, int $userId) : bool
Parameters
$channelId : int

The channel id of that $userId is leaving

$userId : int

Userid of the user leaving the channel.

Return values
bool —

Indicates if the moderator was removed successfully

saveBlogSidebarModules()

Saves channel configuration for blog sidebar

public saveBlogSidebarModules(int $blogId, array<string|int, mixed> $modules) : mixed
Parameters
$blogId : int
$modules : array<string|int, mixed>

An array in which each element contains:

  • widgetinstanceid (int)
  • hide (bool)
Tags
throws
vB_Exception_Api

no_permission

subscribeChannel()

Handles subscription in special channels for the current user.

public subscribeChannel(int $channelId) : bool

This is used basically for social groups subscription handling the join/subscribe logical but we are implementing here in case requirements change and join/subscribe gets into blogs too.

Parameters
$channelId : int
Return values
bool —

Indicates if subscription succeeded.

userCanComment()

Returns whether current user can comment in the blog or not

public userCanComment(mixed $blogPosts) : array<string|int, mixed>
Parameters
$blogPosts : mixed
Return values
array<string|int, mixed> —
  • Returns an array with nodeid as key and value for "user can comment"? 0 : No (Commenting is disabled for the blog post or the blog channel) -1: No (User is not logged in and Guests have no permission to comment -2: No (User is logged in but is not subscribed to the blog post - permission to comment is set for subscribers only) 1 : Yes

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results