vBulletin v6.0.4

vB_Api_Content_Poll extends vB_Api_Content_Text
in package

vB_Api_Content_Poll

Tags
author

ebrown

copyright

Copyright (c) 2011

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 node
autoPopulatePreviewImage()  : mixed
DEPRECATED - This is now handled internally by the library, nothing is called from controllers.
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.
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.
fetchTableName()  : array<string|int, mixed>
Returns the tables used by this content type.
getApiClassName()  : mixed
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()  : mixed
Returns an array with bbcode options for the node.
getContent()  : mixed
Alias for @getFullContent
getContentApi()  : mixed
Returns a content api of the appropriate type
getConversationParent()  : array<string|int, mixed>|false
Gets the conversation starter for a node. If the node is a channel it returns the channel array.
getDataForParse()  : array<string|int, mixed>
Gets the data the presentation layer needs to have to parse the rawtext.
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
getQuotes()  : string
Returns a string with quoted strings in bbcode format.
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.
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.
update()  : bool
Updates a record
vote()  : int
Vote on a Poll (for the current user)

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 node

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

the new nodeid

autoPopulatePreviewImage()

DEPRECATED - This is now handled internally by the library, nothing is called from controllers.

public autoPopulatePreviewImage(mixed $nodeId) : mixed

NOTE: This is still used by some upgrade steps, so we can't remove it completely at this time.

Populates the previewimage field for this node. To be called after the node is saved and the attachments added.

Finds the first image in the post text that can be used as a previewimage (uploaded here), or uses the first image attachment.

Parameters
$nodeId : mixed
Tags
deprecated

Superceded by getPreviewImage in the text library.

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

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.

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

getApiClassName()

public static getApiClassName(mixed $controller) : mixed
Parameters
$controller : 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) : mixed
Parameters
$nodeId : int

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

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

getDataForParse()

Gets the data the presentation layer needs to have to parse the rawtext.

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

Array of node information for parsing the content. Each item indexed by the nodeid and contains: 'bbcodeoptions', 'rawtext', 'previewtext', 'attachments', 'title' 'channelid', 'htmlstate', 'disable_bbcode', 'avatar_userids'

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

getQuotes()

Returns a string with quoted strings in bbcode format.

public getQuotes(mixed $nodeids) : string
Parameters
$nodeids : mixed
Return values
string

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

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

update()

Updates a record

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

vote()

Vote on a Poll (for the current user)

public vote(mixed $polloptionids) : int
Parameters
$polloptionids : mixed
Return values
int —

The node ID of the poll that was voted on.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results