quipcomment.class.php
- package
- quip
- Classes
- quipComment
Description
Quip
Copyright 2010-11 by Shaun McCormick shaun@modx.com
This file is part of Quip.
Quip is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
Quip is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with Quip; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
\quipComment
- Extends from
- \xPDOSimpleObject
- package
- quip
- Methods
- _loadLexicon
- approve
- getDescendants
- makeUrl
- notifyModerators
- reject
- save
- sendEmail
Description
Methods
_loadLexicon
_loadLexicon(
)
:
booleanLoad the modLexicon service
Output
- boolean
Details
approve
approve(
array $options
=
array
)
:
booleanApproves comment and sends out notification to poster and watchers
Arguments
- $options
- array
Output
- boolean
- True if successful
Details
getDescendants
getDescendants(
int $depth
=
0
)
:
arrayGrabs all descendants of this post.
Arguments
- $depth
- int
If set, will limit to specified depth
Output
- array
- A collection of quipComment objects.
Details
makeUrl
makeUrl(
int $resource
=
0, array $params
=
array, array $options
=
array, boolean $addAnchor
=
true
)
:
stringMake a custom URL For this comment.
Arguments
- $resource
- int
Optional. The ID of the resource to generate the comment for. Defaults to the Thread's resource. - $params
- array
Optional. An array of REQUEST parameters to add to the URL. - $options
- array
Optional. An array of options, which can include 'scheme' and 'idprefix'. - $addAnchor
- boolean
Whether or not to add the idprefix+id as an anchor tag to the URL
Output
- string
- The generated URL
Details
notifyModerators
notifyModerators(
)
:
booleanSends notification email to moderators telling them the comment is awaiting approval.
Output
- boolean
- True if successful
Details
reject
reject(
array $options
=
array
)
:
booleanReject a comment
Arguments
- $options
- array
Output
- boolean
- True if successful
Details
save
save(
boolean $cacheFlag
=
null
)
:
booleanOverrides xPDOObject::save to handle closure table edits.
Arguments
- $cacheFlag
- boolean
Output
- boolean
Details
sendEmail
sendEmail(
string $subject, string $body, string $to
)
:
booleanSend an email
Arguments
- $subject
- string
The subject of the email - $body
- string
The body of the email to send - $to
- string
The email address to send to
Output
- boolean