IP.Board  3.3.0
comments_core_reports Class Reference
Inheritance diagram for comments_core_reports:
classes_comments_renderer

Public Member Functions

 can ($type, array $array)
 count ($parent)
 fetchParent ($id)
 perPage ()
 postDelete ($commentIds, $parentId)
 postSave ($type, array $array, $commentId=0, $parentId=0)
 remapKeys ($type='comment')
 reputationEnabled ()
 settings ()
 table ()
 whoAmI ()

Protected Attributes

 $_parentRemap
 $_remap

Member Function Documentation

can ( type,
array $  array 
)

Perform a permission check

Parameters:
stringType of check (add/edit/delete/editall/deleteall/approve all)
arrayArray of GENERIC data
Returns:
true or string to be used in exception

Reimplemented from classes_comments_renderer.

count ( parent)

Fetch a total count of comments we can see

Parameters:
mixedparent Id or parent array
Returns:
int

Reimplemented from classes_comments_renderer.

fetchParent ( id)

Fetch parent

Returns:
array
perPage ( )

Number of items per page

Returns:
int

Reimplemented from classes_comments_renderer.

postDelete ( commentIds,
parentId 
)

Post delete. Can do stuff and that

Parameters:
arrayArray of comment IDs to be deleted
intParent ID
Returns:
void

Reimplemented from classes_comments_renderer.

postSave ( type,
array $  array,
commentId = 0,
parentId = 0 
)

Post save Accepts an array of GENERIC data and allows manipulation after it's added to DB

Parameters:
stringType of action (edit/add)
arrayArray of GENERIC data (comment_xxxx)
intComment id (if available)
intParent id
Returns:
array Array of GENERIC data
remapKeys ( type = 'comment')

Returns remap keys (generic => local)

Returns:
array

Enable reputation?

Returns:
string

Reimplemented from classes_comments_renderer.

settings ( )

Fetch settings

Returns:
array
table ( )

Comment table

Returns:
string
whoAmI ( )

Who am I?

Returns:
string

Field Documentation

$_parentRemap [protected]
Initial value:
 array( 'parent_id'                     => 'id',
                                                                                'parent_owner_id'       => 'updated_by',
                                                                                'parent_parent_id'      => 'uid',
                                                                                'parent_title'          => 'title',
                                                                                'parent_seo_title'      => 'seoname',
                                                                                'parent_date'           => 'date_created' )

Internal parent remap array

Parameters:
array
$_remap [protected]
Initial value:
 array( 'comment_id'                    => 'id',
                                                                'comment_author_id'             => 'comment_by',
                                                                'comment_author_name'   => 'author_name',
                                                                'comment_text'                  => 'comment',
                                                                'comment_ip_address'    => 'ip_address',
                                                                'comment_edit_date'             => 'edit_date',
                                                                'comment_date'                  => 'comment_date',
                                                                'comment_approved'              => 'approved',
                                                                'comment_parent_id'             => 'rid' )

Internal remap array

Parameters:
array

The documentation for this class was generated from the following file:
 All Data Structures Functions Variables