vBulletin 5.6.5 API

vB_Api_Content_Redirect extends vB_Api_Content_Text
in package

vB_Api_Content_Redirect

Tags
access

public

Table of Contents

$assertor  : vB_dB_Assertor
$bbcode_parser  : mixed
$contenttype  : mixed
$controller  : string
API Controller
$db  : vB_Database
Database object.
$disabled  : bool
Indicates whether the API was disabled
$disableFalseReturnOnly  : array<string|int, mixed>
Contains white listed methods which return a false response when API is disabled in special scenarios like forum closed, password expiry, ip ban and others.
$disableWhiteList  : array<string|int, mixed>
Contains white listed methods which act as normal when API is disabled no matter of special scenarios like forum closed, password expiry, ip ban and others.
$doFloodCheck  : bool
$library  : vB_Library_Content
$nodeApi  : vB_Api_Node
$options  : array<string|int, mixed>
$showSignature  : mixed
$tablename  : mixed
$textRequired  : mixed
$usercontext  : vB_UserContext
$instances  : mixed
$instancesRaw  : array<string|int, mixed>
We want API subclasses to access the instances only through getters
$vb4_input_mappings  : mixed
$wrappers  : mixed
__serialize()  : mixed
__sleep()  : mixed
__unserialize()  : mixed
__wakeup()  : mixed
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.
fixAttachBBCode()  : mixed
DEPRECATED - This is now handled internally by the library, nothing is called from controllers.
getApiClassName()  : mixed
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.
removeRedirectsFromNode()  : standard
Remove redirects that point to this node
update()  : bool
Updates a record
__construct()  : mixed
Constructor, no external instantiation.
checkAttachmentPermissions()  : mixed
Checks createpermissions.vbforum_attach and forumpermissions.maxattachments to see that user can add attachments under $data['parentid'] and that attachment limit is not exceeded. Throws exceptions meant to prevent node addition/update, so this function should be called before calling Library's add() or update()
checkHasAdminPermission()  : none
Determines if the calling user has the given admin permission, and if not throws an exception
checkHasPermission()  : none
Determines if the calling user has the given bitfield permission, and if not, throws a 'no_permission' exception.
checkHtmlstateForComments()  : void
Checks 'htmlstate' and disables it if this is a comment
checkIsLoggedIn()  : mixed
Determines if the calling user has the given admin permission, and if not throws an exception
checkTextLength()  : mixed
Check that the $text length falls in the minChar/maxChar limits Checks some class properties as well as does a transform on the text to normalize things.
cleanOptions()  : mixed
Clean unallowed options from user request, only cleans 'skipFloodCheck' for now
getApiClass()  : mixed
getApiClassNameInternal()  : mixed
hasAdminPermission()  : bool
Determines if the calling user has the given admin permission
inDebugMode()  : mixed
isDisableFalseReturnOnly()  : bool
Checks if method returns false response only when API is disabled.
isWhiteListed()  : bool
Checks if method is white listed when API is disabled.
setController()  : mixed
Set controller
verify_limits()  : bool
Checks the "limit" permissions for this content item
cms_vb4_to_vb5_method_mapping()  : mixed
default_vb4_to_vb5_method_mapping()  : mixed
getCharLimits()  : array<string|int, mixed>
Gets the char limits for a node's text
hasAdminPermissionInternal()  : mixed
Internal function to power the previous cover functions
remove_nulls()  : mixed
wrapLoggerIfNeeded()  : mixed
Wrap the api object with the log wrapper class if needed.

Properties

$assertor

protected vB_dB_Assertor $assertor

$bbcode_parser

protected mixed $bbcode_parser = alse

$contenttype

protected mixed $contenttype = 'vBForum_Redirect'

$controller

API Controller

protected string $controller

$disabled

Indicates whether the API was disabled

protected bool $disabled = alse

$disableFalseReturnOnly

Contains white listed methods which return a false response when API is disabled in special scenarios like forum closed, password expiry, ip ban and others.

protected array<string|int, mixed> $disableFalseReturnOnly = array()

$disableWhiteList

Contains white listed methods which act as normal when API is disabled no matter of special scenarios like forum closed, password expiry, ip ban and others.

protected array<string|int, mixed> $disableWhiteList = array()

$doFloodCheck

protected bool $doFloodCheck = rue

$options

protected array<string|int, mixed> $options

$showSignature

protected mixed $showSignature = rue

$tablename

protected mixed $tablename = array('redirect')

$textRequired

protected mixed $textRequired = rue

$instances

private static mixed $instances

$instancesRaw

We want API subclasses to access the instances only through getters

private static array<string|int, mixed> $instancesRaw

$vb4_input_mappings

private static mixed $vb4_input_mappings = array( 'blog.post_comment' => array('method' => 'vb4_blog.post_comment'), 'blog.post_postcomment' => array('method' => 'vb4_blog.post_postcomment'), 'blog.post_updateblog' => array('method' => 'vb4_blog.post_updateblog'), 'blog.post_newblog' => array('method' => 'vb4_blog.post_newblog'), 'blog.post_editblog' => array('method' => 'vb4_blog.post_editblog'), 'blog_list' => array('method' => 'vb4_blog.bloglist'), 'api_init' => array('method' => 'api.init'), 'api_cmssectionlist' => array('method' => 'Vb4_Cms.sectionlist'), 'api_cmscategorylist' => array('method' => 'Vb4_Cms.categorylist'), /* // These can no longer be mapped directly to vB_Api_User::login/logout // due to additional processing of devicetoken that may be required // for mapi calls. 'login_login' => array( 'method' => 'user.login', 'request_mappings' => array( 'vb_login_username' => 'username', 'vb_login_password' => 'password', 'vb_login_md5password' => 'md5password', 'vb_login_md5password_utf' => 'md5passwordutf' ) ), 'login_logout' => array( 'method' => 'user.logout' ), */ 'get_vbfromfacebook' => array('method' => 'vb4_facebook.getVbfromfacebook'), )

$wrappers

private static mixed $wrappers

Methods

__serialize()

public __serialize() : mixed
Return values
mixed

__sleep()

public __sleep() : mixed
Return values
mixed

__unserialize()

public __unserialize(mixed $serialized) : mixed
Parameters
$serialized : mixed
Return values
mixed

__wakeup()

public __wakeup() : mixed
Return values
mixed

add()

Adds a new node.

public add(mixed $data[, array<string|int, mixed> $options = array() ]) : int
Parameters
$data : mixed

Array of field => value pairs which define the record.

$options : array<string|int, mixed> = array()

Array of options for the content being created. Understands skipTransaction, skipFloodCheck, floodchecktime, skipDupCheck, skipNotification, nl2br, autoparselinks.

  • nl2br: if TRUE, all \n will be converted to
    so that it's not removed by the html parser (e.g. comments).
  • wysiwyg: if true convert html to bbcode. Defaults to true if not given.
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.

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

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
Return values
mixed

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, which avoids using the content APIs

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

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

fixAttachBBCode()

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

public fixAttachBBCode(mixed $nodeId[, array<string|int, mixed> $keysToAttachid = array() ]) : mixed

This was used by the createcontent controller's handleAttachmentUploads() to fix temporary id references in the specified node's rawtext to nodeids

Parameters
$nodeId : mixed

nodeid or array of nodeids

$keysToAttachid : array<string|int, mixed> = array()

(optional) array({tempid of attachment} => {attachment's nodeid}) maps temporary-ids (array key) of newly added attachments and corresponding nodeids (array value) of said attachments. While this is optional for historical reasons, it must be provided if any temporary id references in the rawtext need to be replaced.

Tags
deprecated

Superceded by replaceAttachBbcodeTempids in the text library.

Return values
mixed

array includes bbcodeoptions, attachments, and rawtext

getApiClassName()

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

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
Return values
mixed

getBbcodeOptions()

Returns an array with bbcode options for the node.

public getBbcodeOptions(int $nodeId) : mixed
Parameters
$nodeId : int
Return values
mixed

getContent()

Alias for @getFullContent

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

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('no_permission')

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

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

removeRedirectsFromNode()

Remove redirects that point to this node

public removeRedirectsFromNode(int $nodeid) : standard

Requires admincp session.

Parameters
$nodeid : int
Return values
standard

success array

update()

Updates a record

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

__construct()

Constructor, no external instantiation.

protected __construct() : mixed
Return values
mixed

checkAttachmentPermissions()

Checks createpermissions.vbforum_attach and forumpermissions.maxattachments to see that user can add attachments under $data['parentid'] and that attachment limit is not exceeded. Throws exceptions meant to prevent node addition/update, so this function should be called before calling Library's add() or update()

protected checkAttachmentPermissions(array<string|int, mixed> $data[, int $nodeid = false ]) : mixed

The createpermissions.vbforum_attach will be checked if there is any change in attachments. However, the attachment limit forumpermissions.maxattachments will only be checked if there is a net gain of attachments. If there is absolutely no change to attachments (signified by an empty $data['attachments'] and empty $data['removeattachments']), no permission will be checked as we do not want to prevent a recent change in attachment-related channel permissions (e.g. attachment limit being decreased or the createpermission being unset since post creation) to prevent a text-only update.

Parameters
$data : array<string|int, mixed>

Typical data array passed into add() or update(). MUST have 'parentid' for add, 'parentid' OR 'nodeid' for update. CAN have 'attachments' if any is to be added, 'removeattachments' if any is to be removed (update only).

$nodeid : int = false

-- optional node to check permissions against if the parentid isn't in the data array

Tags
throws

vB_Exception_Api('invalid_parentid') if required 'parentid' is not found in $data

throws

vB_Exception_Api('no_create_permissions_attach') if user lacks createpermissions.vbforum_attach channel permission.

throws

vB_Exception_Api('max_attachments_exceeded_x') if attachment limit check failed per above notes.

Return values
mixed

checkHasAdminPermission()

Determines if the calling user has the given admin permission, and if not throws an exception

protected checkHasAdminPermission(string|array<string|int, mixed> $adminPermission) : none

Checks for:

  • A valid CP Session
  • The passed adminpermission.
Parameters
$adminPermission : string|array<string|int, mixed>

The admin permission to check. If an array then the check passes if the user has any of the permissions given.

Tags
throws
inlinemodauth_required

-- The current session is not a mod/admin session

throws
nopermission_loggedin

-- The user does not have the given permission

throws
no_permission

-- The user is not logged in at all.

Return values
none

checkHasPermission()

Determines if the calling user has the given bitfield permission, and if not, throws a 'no_permission' exception.

protected checkHasPermission(string $group, string $permission) : none
Parameters
$group : string

The permission group where the permission is located

$permission : string

The permission to check

Tags
throws
no_permission
Return values
none

checkHtmlstateForComments()

Checks 'htmlstate' and disables it if this is a comment

protected checkHtmlstateForComments(mixed &$data, mixed $nodeid) : void
Parameters
$data : mixed
$nodeid : mixed
Return values
void

This function modifies the passed $data array.

checkIsLoggedIn()

Determines if the calling user has the given admin permission, and if not throws an exception

protected checkIsLoggedIn() : mixed
Return values
mixed

checkTextLength()

Check that the $text length falls in the minChar/maxChar limits Checks some class properties as well as does a transform on the text to normalize things.

protected checkTextLength(int $minChars, int $maxChars, string $text) : mixed

Throws an exception if validation fails.

Parameters
$minChars : int

-- check if $this->textRequired is true

$maxChars : int

-- unlimited if 0

$text : string
Return values
mixed

cleanOptions()

Clean unallowed options from user request, only cleans 'skipFloodCheck' for now

protected cleanOptions(array<string|int, mixed> &$options) : mixed
Parameters
$options : array<string|int, mixed>

Array of options, may be passed in from client

Return values
mixed

getApiClass()

protected static getApiClass(mixed $controller[, mixed $errorCheck = true ]) : mixed
Parameters
$controller : mixed
$errorCheck : mixed = true
Return values
mixed

getApiClassNameInternal()

protected static getApiClassNameInternal(mixed $controller) : mixed
Parameters
$controller : mixed
Return values
mixed

hasAdminPermission()

Determines if the calling user has the given admin permission

protected hasAdminPermission(string|array<string|int, mixed> $adminPermission) : bool

Useful if you need to know if the calling user but do not care why they do not have that permission. Generally useful if there is a behavior difference between admins and non admins, but the call can be processed for either.

Parameters
$adminPermission : string|array<string|int, mixed>

The admin permission to check. If an array then the check passes if the user has any of the permissions given.

Return values
bool

true if checks pass, false otherwise

inDebugMode()

protected inDebugMode() : mixed
Return values
mixed

isDisableFalseReturnOnly()

Checks if method returns false response only when API is disabled.

protected isDisableFalseReturnOnly(mixed $method) : bool
Parameters
$method : mixed
Return values
bool

Indicates whether method returns false response only.

isWhiteListed()

Checks if method is white listed when API is disabled.

protected isWhiteListed(mixed $method) : bool
Parameters
$method : mixed
Return values
bool

Indicates whether method is or is not a white list.

setController()

Set controller

protected setController(mixed $controller) : mixed
Parameters
$controller : mixed
Return values
mixed

verify_limits()

Checks the "limit" permissions for this content item

protected verify_limits(mixed $data) : bool
Parameters
$data : mixed
Return values
bool

Either true if all the tests passed or thrown exception

cms_vb4_to_vb5_method_mapping()

private static cms_vb4_to_vb5_method_mapping(mixed $method, mixed &$request) : mixed
Parameters
$method : mixed
$request : mixed
Return values
mixed

default_vb4_to_vb5_method_mapping()

private static default_vb4_to_vb5_method_mapping(mixed $method) : mixed
Parameters
$method : mixed
Return values
mixed

getCharLimits()

Gets the char limits for a node's text

private getCharLimits(array<string|int, mixed> $vboptions, array<string|int, mixed> $parentNode) : array<string|int, mixed>
Parameters
$vboptions : array<string|int, mixed>

-- the vboption datastore array

$parentNode : array<string|int, mixed>

-- the node to check's parent

Return values
array<string|int, mixed>

-- array($minChars, $maxChars)

hasAdminPermissionInternal()

Internal function to power the previous cover functions

private hasAdminPermissionInternal(mixed $adminPermission) : mixed
@param string|array $adminPermission The admin permission to check.  If an array

then the check passes if the user has any of the permissions given.

Parameters
$adminPermission : mixed
Return values
mixed

remove_nulls()

private static remove_nulls(mixed &$data) : mixed
Parameters
$data : mixed
Return values
mixed

wrapLoggerIfNeeded()

Wrap the api object with the log wrapper class if needed.

private static wrapLoggerIfNeeded(mixed $controller, mixed $api_object) : mixed
Parameters
$controller : mixed
$api_object : mixed
Return values
mixed

Search results