vBulletin v6.0.4

vB_Library_Content_Infraction extends vB_Library_Content_Text
in package

vB_Library_Content_Infraction

Tags
access

public

Table of Contents

Methods

add()  : array<string|int, mixed>
Adds a new infraction node
assembleContent()  : mixed
Assembles the response for detailed content
autoPopulatePreviewImage()  : mixed
DEPRECATED: This needs to remain until the corresponding API function is removed
buildInfractionGroupIds()  : mixed
Builds infraction groups for users. Also called from the cron script
canInfractNode()  : bool
Determines if the logged-in user can infract the (author of) the given node
canInfractUser()  : bool
Determines if the logged-in user can infract the given user
canViewNodeInfraction()  : bool
Determines if the logged-in user can view any infractions on the given node
clearInfractionGroupCache()  : mixed
delete()  : void
Deletes an infraction. Currently the only UI for this is in the Admin CP
fetchInfractionGroups()  : array<string|int, mixed>
Get the infraction group information for a user.
getAutomaticBanList()  : array<string|int, mixed>
Returns a list of automatic bans or an empty array if there are none.
getAutoparseLinks()  : mixed
Get the actual auto parse links values based on the request and context
getFullContent()  : array<string|int, mixed>
Returns the node content as an associative array with fullcontent
getIndexableFromNode()  : mixed
getInfraction()  : array<string|int, mixed>|false
Returns an infraction node based on its nodeid
getInfractionGroups()  : array<string|int, mixed>
gets the infraction groups
getInfractionLevels()  : array<string|int, mixed>
Returns an array of information for the infraction levels that are currently set up
getInfractionsByType()  : mixed
returns a certain type of infractions
getNodeDescription()  : mixed
getNodeInfraction()  : array<string|int, mixed>|false
Returns the infraction node for the given node (if it has an infraction)
getParticipants()  : array<string|int, mixed>
Returns the displaynames of users that participated in an infraction conversation.
getQuotes()  : array<string|int, mixed>|string
This returns a string with quoted strings in bbcode format.
getQuotesFromNodes()  : mixed
Helper function to allow getQuotes in the API and Library classes to generate the node list independantly (so that the API can check perms without loading the nodes twice).
getUserInfractions()  : array<string|int, mixed>|false
Returns the infraction nodes for infractions that the given user has received.
mergeContent()  : type
Performs the merge of content and updates the node.
mergeContentInfo()  : mixed
Adds content info to $result so that merged content can be edited.
parseAndStrip()  : mixed
postBbcodeParseCleanRawtext()  : mixed
Cleans the input in the $data array, specifically *after* any html/wysiwyg -> bbcode parsing.
reverseInfraction()  : mixed
Reverse an infraction
update()  : void
Cannot update an infraction (you can only reverse them)

Methods

add()

Adds a new infraction node

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

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

$options : array<string|int, mixed> = []

-- Array of options for the content being created -- skipTransaction, --skipFloodCheck, -- floodchecktime, -- skipDupCheck, -- skipNotification, -- nl2br: if TRUE, all \n will be converted to
so that it's not removed by the html parser (e.g. comments). -- autoparselinks.

$convertWysiwygTextToBbcode : mixed = true
Return values
array<string|int, mixed> —

-- nodeid (int), -- success (bool), -- cacheEvents (array of strings), -- nodeVals (array of field => value), -- attachments (array of attachment records).

assembleContent()

Assembles the response for detailed content

public assembleContent(mixed &$content[, mixed $permissions = false ]) : mixed
Parameters
$content : mixed
$permissions : mixed = false
Return values
mixed —

formatted data

autoPopulatePreviewImage()

DEPRECATED: This needs to remain until the corresponding API function is removed

public autoPopulatePreviewImage(mixed $nodeId[, array<string|int, mixed> $node = null ]) : mixed

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
$node : array<string|int, mixed> = null

(optional) Node content array returned by getFullContent

Tags
deprecated

Superceded by getPreviewImage

buildInfractionGroupIds()

Builds infraction groups for users. Also called from the cron script

public buildInfractionGroupIds(array<string|int, mixed> $userids) : mixed
Parameters
$userids : array<string|int, mixed>

canInfractNode()

Determines if the logged-in user can infract the (author of) the given node

public canInfractNode(mixed $nodeid[, array<string|int, mixed> $node = null ]) : bool
Parameters
$nodeid : mixed
$node : array<string|int, mixed> = null
Return values
bool —

The node (user) can be infracted by current user (or not)

canInfractUser()

Determines if the logged-in user can infract the given user

public canInfractUser(mixed $userid) : bool
Parameters
$userid : mixed
Return values
bool —

The user can be infracted by current user (or not)

canViewNodeInfraction()

Determines if the logged-in user can view any infractions on the given node

public canViewNodeInfraction(mixed $nodeid[, array<string|int, mixed> $node = null ]) : bool
Parameters
$nodeid : mixed
$node : array<string|int, mixed> = null
Return values
bool —

The current user can view any infractions on this node (or not)

clearInfractionGroupCache()

public clearInfractionGroupCache() : mixed

delete()

Deletes an infraction. Currently the only UI for this is in the Admin CP

public delete( $nodeid) : void
Parameters
$nodeid :

fetchInfractionGroups()

Get the infraction group information for a user.

public fetchInfractionGroups(mixed $ipoints, mixed $usergroupid) : array<string|int, mixed>
Parameters
$ipoints : mixed
$usergroupid : mixed
Return values
array<string|int, mixed> —

User's final infraction groups

getAutomaticBanList()

Returns a list of automatic bans or an empty array if there are none.

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

Array of automatic bans

getAutoparseLinks()

Get the actual auto parse links values based on the request and context

public getAutoparseLinks( $parents,  $autoparselinks) : mixed

For the moment we assume that we us autoparse if

  1. It is requested by the caller AND
  2. It is allowed by channel context

There is currently no "force" auto parse. Currently the channel option is not hierarchical, we'll check the containing channel at the lowest level and allow autoparse if that channel allows it regardless of if the parents allow it or not (currently we only have an on/off flag and would need on/off/default to handle hierachy in a reasonable way since we might want to allow it for a child while prohibiting it at the parent level or vice versa.

Parameters
$parents :

-- the parents array the first element should be either the node itself (for updates) or the node's parent (for adds). It will work either way.

$autoparselinks :

-- the requested autoparse value

getFullContent()

Returns the node content as an associative array with fullcontent

public getFullContent(int|array<string|int, mixed> $nodes) : array<string|int, mixed>
Parameters
$nodes : int|array<string|int, mixed>

-- node id(s) to get content for

Return values
array<string|int, mixed>

getIndexableFromNode()

public getIndexableFromNode(mixed $content[, mixed $include_attachments = true ]) : mixed
Parameters
$content : mixed
$include_attachments : mixed = true

getInfraction()

Returns an infraction node based on its nodeid

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

Array of infraction info, or false

getInfractionGroups()

gets the infraction groups

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

infraction groups with infractiongroupid as key >

getInfractionLevels()

Returns an array of information for the infraction levels that are currently set up

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

Infraction levels

getInfractionsByType()

returns a certain type of infractions

public getInfractionsByType([string $type = '' ][, bool $replied_by_me = false ]) : mixed
Parameters
$type : string = ''
$replied_by_me : bool = false
  • if true, only infractions that the user commented on type = 'user' => infractions given to a user type = 'post' => infractions given to a post by a user

getNodeDescription()

public getNodeDescription(mixed $data, mixed $convertWysiwygTextToBbcode) : mixed
Parameters
$data : mixed
$convertWysiwygTextToBbcode : mixed

getNodeInfraction()

Returns the infraction node for the given node (if it has an infraction)

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

Array of infraction info, or false if there is no infraction

getParticipants()

Returns the displaynames of users that participated in an infraction conversation.

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

displaynames first level key is the nodeid, second level key is the userid

getQuotes()

This returns a string with quoted strings in bbcode format.

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

either the quote for the node or an array of $nodeid => $quotes for the array of nodes

getQuotesFromNodes()

Helper function to allow getQuotes in the API and Library classes to generate the node list independantly (so that the API can check perms without loading the nodes twice).

public getQuotesFromNodes(array<string|int, mixed> $nodes) : mixed
Parameters
$nodes : array<string|int, mixed>

-- array of nodes arrays from getContent (API or Library version) does not accept a single node array

getUserInfractions()

Returns the infraction nodes for infractions that the given user has received.

public getUserInfractions(mixed $userid[, mixed $offset = 0 ][, mixed $limit = 20 ]) : array<string|int, mixed>|false
Parameters
$userid : mixed
$offset : mixed = 0
$limit : mixed = 20
Return values
array<string|int, mixed>|false —

Array of infraction info, or false if there are no infractions

mergeContent()

Performs the merge of content and updates the node.

public mergeContent(type $data) : type
Parameters
$data : type
Return values
type

mergeContentInfo()

Adds content info to $result so that merged content can be edited.

public mergeContentInfo(array<string|int, mixed> &$result, array<string|int, mixed> $content) : mixed
Parameters
$result : array<string|int, mixed>
$content : array<string|int, mixed>

parseAndStrip()

public parseAndStrip(mixed $text[, mixed $wysiwyg = true ]) : mixed
Parameters
$text : mixed
$wysiwyg : mixed = true

postBbcodeParseCleanRawtext()

Cleans the input in the $data array, specifically *after* any html/wysiwyg -> bbcode parsing.

public postBbcodeParseCleanRawtext(array<string|int, mixed> &$data) : mixed
Parameters
$data : array<string|int, mixed>

Array of fieldname => data pairs, passed by reference.

reverseInfraction()

Reverse an infraction

public reverseInfraction(mixed $nodeid, mixed $reason) : mixed
Parameters
$nodeid : mixed
$reason : mixed

update()

Cannot update an infraction (you can only reverse them)

public update(mixed $nodeid, mixed $data[, mixed $convertWysiwygTextToBbcode = true ]) : void
Parameters
$nodeid : mixed
$data : mixed
$convertWysiwygTextToBbcode : mixed = true
Tags
throws
vB_Exception_Api 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results