XpressEngine Core  1.11.2
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | List of all members
commentController Class Reference
Inheritance diagram for commentController:
comment ModuleObject BaseObject

Public Member Functions

 init ()
 
 procCommentVoteUp ()
 
 procCommentVoteDown ()
 
 procCommentDeclare ()
 
 triggerDeleteDocumentComments (&$obj)
 
 triggerDeleteModuleComments (&$obj)
 
 addGrant ($comment_srl)
 
 isModuleUsingPublishValidation ($module_srl=NULL)
 
 insertComment ($obj, $manual_inserted=FALSE)
 
 sendEmailToAdminAfterInsertComment ($obj)
 
 updateComment ($obj, $is_admin=FALSE, $manual_updated=FALSE)
 
 deleteComment ($comment_srl, $is_admin=FALSE, $isMoveToTrash=FALSE)
 
 deleteCommentLog ($args)
 
 deleteComments ($document_srl, $obj=NULL)
 
 _deleteDeclaredComments ($commentSrls)
 
 _deleteVotedComments ($commentSrls)
 
 updateVotedCount ($comment_srl, $point=1)
 
 declaredComment ($comment_srl)
 
 addCommentPopupMenu ($url, $str, $icon= '', $target= 'self')
 
 procCommentInsertModuleConfig ()
 
 setCommentModuleConfig ($srl, $comment_config)
 
 procCommentGetList ()
 
 triggerCopyModule (&$obj)
 
- Public Member Functions inherited from comment
 moduleInstall ()
 
 checkUpdate ()
 
 moduleUpdate ()
 
 recompileCache ()
 
- Public Member Functions inherited from ModuleObject
 setModule ($module)
 
 setModulePath ($path)
 
 setRedirectUrl ($url= './', $output=NULL)
 
 getRedirectUrl ()
 
 setMessage ($message= 'success', $type=NULL)
 
 setMessageType ($type)
 
 getMessageType ()
 
 setRefreshPage ()
 
 setAct ($act)
 
 setModuleInfo ($module_info, $xml_info)
 
 stop ($msg_code)
 
 setTemplateFile ($filename)
 
 getTemplateFile ()
 
 setTemplatePath ($path)
 
 getTemplatePath ()
 
 setEditedLayoutFile ($filename)
 
 getEditedLayoutFile ()
 
 setLayoutFile ($filename)
 
 getLayoutFile ()
 
 setLayoutPath ($path)
 
 getLayoutPath ($layout_name="", $layout_type="P")
 
 proc ()
 
- Public Member Functions inherited from BaseObject
 __construct ($error=0, $message= 'success')
 
 setError ($error=0)
 
 getError ()
 
 setHttpStatusCode ($code= '200')
 
 getHttpStatusCode ()
 
 setMessage ($message= 'success', $type=NULL)
 
 getMessage ()
 
 add ($key, $val)
 
 adds ($object)
 
 get ($key)
 
 gets ()
 
 getVariables ()
 
 getObjectVars ()
 
 toBool ()
 
 toBoolean ()
 

Additional Inherited Members

- Public Attributes inherited from ModuleObject
 $mid = NULL
 string to represent run-time instance of Module (XE Module) More...
 
 $module = NULL
 Class name of Xe Module that is identified by mid. More...
 
 $module_srl = NULL
 integer value to represent a run-time instance of Module (XE Module) More...
 
 $module_info = NULL
 an object containing the module information More...
 
 $origin_module_info = NULL
 
 $xml_info = NULL
 an object containing the module description extracted from XML file More...
 
 $module_path = NULL
 a path to directory where module source code resides More...
 
 $act = NULL
 a string value to contain the action name More...
 
 $template_path = NULL
 a path of directory where template files reside More...
 
 $template_file = NULL
 name of template file More...
 
 $layout_path = ''
 a path of directory where layout files reside More...
 
 $layout_file = ''
 name of layout file More...
 
 $edited_layout_file = ''
 name of temporary layout files that is modified in an admin mode More...
 
 $stop_proc = FALSE
 a flag to indicating whether to stop the execution of code. More...
 
 $module_config = NULL
 
 $ajaxRequestMethod = array('XMLRPC', 'JSON')
 
 $gzhandler_enable = TRUE
 
- Public Attributes inherited from BaseObject
 $error = 0
 
 $message = 'success'
 
 $variables = array()
 
 $httpStatusCode = NULL
 

Detailed Description

Definition at line 12 of file comment.controller.php.

Member Function Documentation

commentController::_deleteDeclaredComments (   $commentSrls)

delete declared comment, log

Parameters
array | string$commentSrls: srls string (ex: 1, 2,56, 88)
Returns
void

Definition at line 1010 of file comment.controller.php.

commentController::_deleteVotedComments (   $commentSrls)

delete voted comment log

Parameters
array | string$commentSrls: srls string (ex: 1, 2,56, 88)
Returns
void

Definition at line 1021 of file comment.controller.php.

commentController::addCommentPopupMenu (   $url,
  $str,
  $icon = '',
  $target = 'self' 
)

Method to add a pop-up menu when clicking for displaying child comments

Parameters
string$url
string$str
strgin$icon
strgin$target
Returns
void

Definition at line 1288 of file comment.controller.php.

commentController::addGrant (   $comment_srl)

Authorization of the comments available only in the current connection of the session value

Returns
void

Definition at line 156 of file comment.controller.php.

commentController::declaredComment (   $comment_srl)

Report a blamed comment

Parameters
$comment_srl
Returns
void

Definition at line 1166 of file comment.controller.php.

commentController::deleteComment (   $comment_srl,
  $is_admin = FALSE,
  $isMoveToTrash = FALSE 
)

Delete comment

Parameters
int$comment_srl
bool$is_admin
bool$isMoveToTrash
Returns
object

Definition at line 787 of file comment.controller.php.

commentController::deleteCommentLog (   $args)

Remove all comment relation log

Returns
BaseObject

Definition at line 921 of file comment.controller.php.

commentController::deleteComments (   $document_srl,
  $obj = NULL 
)

Remove all comments of the article

Parameters
int$document_srl
Returns
object

Definition at line 933 of file comment.controller.php.

commentController::init ( )

Initialization

Returns
void

Definition at line 19 of file comment.controller.php.

commentController::insertComment (   $obj,
  $manual_inserted = FALSE 
)

Enter comments

Parameters
object$obj
bool$manual_inserted
Returns
object

Definition at line 191 of file comment.controller.php.

commentController::isModuleUsingPublishValidation (   $module_srl = NULL)

Check if module is using comment validation system

Parameters
int$document_srl
int$module_srl
Returns
bool

Definition at line 167 of file comment.controller.php.

commentController::procCommentDeclare ( )

Action to be called when a comment posting is reported

Returns
void|BaseObject

Definition at line 104 of file comment.controller.php.

commentController::procCommentGetList ( )

Get comment all list

Returns
void

Definition at line 1382 of file comment.controller.php.

commentController::procCommentInsertModuleConfig ( )

Save the comment extension form for each module

Returns
void

Definition at line 1310 of file comment.controller.php.

commentController::procCommentVoteDown ( )

Action to handle recommendation votes on comments (Down)

Returns
BaseObject

Definition at line 66 of file comment.controller.php.

commentController::procCommentVoteUp ( )

Action to handle recommendation votes on comments (Up)

Returns
BaseObject

Definition at line 28 of file comment.controller.php.

commentController::sendEmailToAdminAfterInsertComment (   $obj)

Send email to module's admins after a new comment was interted successfully if Comments Approval System is used

Parameters
object$obj
Returns
void
Todo:
Removed code send email to document author.

Definition at line 503 of file comment.controller.php.

commentController::setCommentModuleConfig (   $srl,
  $comment_config 
)

Comment module config setting

Parameters
int$srl
object$comment_config
Returns
BaseObject

Definition at line 1371 of file comment.controller.php.

commentController::triggerCopyModule ( &  $obj)

Definition at line 1421 of file comment.controller.php.

commentController::triggerDeleteDocumentComments ( &  $obj)

Trigger to delete its comments together with document deleted

Returns
BaseObject

Definition at line 124 of file comment.controller.php.

commentController::triggerDeleteModuleComments ( &  $obj)

Trigger to delete corresponding comments when deleting a module

Returns
object

Definition at line 139 of file comment.controller.php.

commentController::updateComment (   $obj,
  $is_admin = FALSE,
  $manual_updated = FALSE 
)

Fix the comment

Parameters
object$obj
bool$is_admin
bool$manual_updated
Returns
object

Definition at line 647 of file comment.controller.php.

commentController::updateVotedCount (   $comment_srl,
  $point = 1 
)

Increase vote-up counts of the comment

Parameters
int$comment_srl
int$point
Returns
BaseObject

Definition at line 1032 of file comment.controller.php.

The documentation for this class was generated from the following file:
Generated on Tue Dec 18 2018 17:04:29 for XpressEngine Core by   doxygen 1.8.5