" .
+ "\n" . $this->options['headline'] . $note . $form .
"\n
";
- return $out;
+ return $out;
}
-
+
protected function renderFormNormal($id, $class, $attrs, $labels, $inputValues) {
- $form =
- "\n";
-
- return $form;
+
+ return $form;
}
-
+
protected function renderFormThread($id, $class, $attrs, $labels, $inputValues) {
-
- $form =
- "\n";
-
+
return $form;
}
-
+
protected function renderNotifyOptions() {
if(!$this->commentsField->useNotify) return '';
$out = '';
-
+
$options = array();
-
+
if($this->commentsField->depth > 0) {
$options['2'] = $this->_('Replies');
}
@@ -422,50 +444,50 @@ protected function renderNotifyOptions() {
if($this->commentsField->useNotify == Comment::flagNotifyAll) {
$options['4'] = $this->_('All');
}
-
+
if(count($options)) {
- $out =
- "\n\t" . - "\n\t\t " . + $out = + "\n\t
" . + "\n\t\t " . "\n\t\t "; - + foreach($options as $value => $label) { - $label = str_replace(' ', ' ', $label); + $label = str_replace(' ', ' ', $label); $out .= "\n\t\t "; } $out .= "\n\t
"; } - - return $out; + + return $out; } /** * Process a submitted CommentForm, insert the Comment, and save the Page - * + * * @return Comment|bool * */ public function processInput() { - $data = $this->wire('input')->post; - if(!count($data)) return false; + $data = $this->wire('input')->post; + if(!count($data)) return false; if($key = $this->options['requireSecurityField']) { - if(empty($data[$key])) return false; + if(empty($data[$key])) return false; } - $comment = new Comment(); - $comment->user_agent = $_SERVER['HTTP_USER_AGENT']; + $comment = new Comment(); + $comment->user_agent = $_SERVER['HTTP_USER_AGENT']; $comment->ip = $this->wire('session')->getIP(); - $comment->created_users_id = $this->user->id; - $comment->sort = count($this->comments)+1; - $comment->parent_id = (int) $data->parent_id; + $comment->created_users_id = $this->user->id; + $comment->sort = count($this->comments)+1; + $comment->parent_id = (int) $data->parent_id; $errors = array(); - // $sessionData = array(); + // $sessionData = array(); foreach(array('cite', 'email', 'website', 'text') as $key) { - if($key == 'website' && (!$this->commentsField || !$this->commentsField->useWebsite)) continue; + if($key == 'website' && (!$this->commentsField || !$this->commentsField->useWebsite)) continue; if($this->options['presetsEditable'] || !isset($this->options['presets'][$key]) || $this->options['presets'][$key] === null) { $comment->$key = $data->$key; // Comment performs sanitization/validation } else { @@ -473,7 +495,7 @@ public function processInput() { } if($key != 'website' && !$comment->$key) $errors[] = $key; $this->inputValues[$key] = $comment->$key; - //if($key != 'text') $sessionData[$key] = $comment->$key; + //if($key != 'text') $sessionData[$key] = $comment->$key; } $flags = 0; @@ -494,15 +516,15 @@ public function processInput() { if(!count($errors)) { if($this->comments->add($comment) && $this->commentsField) { - $outputFormatting = $this->page->outputFormatting; + $outputFormatting = $this->page->outputFormatting; $this->page->setOutputFormatting(false); $saveOptions = array(); - if($this->options['quietSave']) $saveOptions['quiet'] = true; - $this->page->save($this->commentsField->name, $saveOptions); - $this->page->setOutputFormatting($outputFormatting); - $this->postedComment = $comment; + if($this->options['quietSave']) $saveOptions['quiet'] = true; + $this->page->save($this->commentsField->name, $saveOptions); + $this->page->setOutputFormatting($outputFormatting); + $this->postedComment = $comment; // $this->wire('session')->set('CommentForm', $sessionData); - return $comment; + return $comment; } } @@ -514,6 +536,6 @@ public function processInput() { * */ public function getPostedComment() { - return $this->postedComment; + return $this->postedComment; } } diff --git a/wire/modules/Fieldtype/FieldtypeComments/CommentList.php b/wire/modules/Fieldtype/FieldtypeComments/CommentList.php index 2f052f5a..7602db31 100644 --- a/wire/modules/Fieldtype/FieldtypeComments/CommentList.php +++ b/wire/modules/Fieldtype/FieldtypeComments/CommentList.php @@ -4,16 +4,16 @@ * ProcessWire CommentListInterface and CommentList * * CommentListInterface defines an interface for CommentLists. - * CommentList provides the default implementation of this interface. + * CommentList provides the default implementation of this interface. * - * Use of these is not required. These are just here to provide output for a FieldtypeComments field. + * Use of these is not required. These are just here to provide output for a FieldtypeComments field. * Typically you would iterate through the field and generate your own output. But if you just need - * something simple, or are testing, then this may fit your needs. - * - * ProcessWire 2.x - * Copyright (C) 2010 by Ryan Cramer + * something simple, or are testing, then this may fit your needs. + * + * ProcessWire 2.x + * Copyright (C) 2010 by Ryan Cramer * Licensed under GNU/GPL v2, see LICENSE.TXT - * + * * http://www.processwire.com * http://www.ryancramer.com * @@ -24,23 +24,23 @@ * */ interface CommentListInterface { - public function __construct(CommentArray $comments, $options = array()); + public function __construct(CommentArray $comments, $options = array()); public function render(); public function renderItem(Comment $comment); } /** - * CommentList provides the default implementation of the CommentListInterface interface. + * CommentList provides the default implementation of the CommentListInterface interface. * */ class CommentList extends Wire implements CommentListInterface { - + /** * Reference to CommentsArray provided in constructor * */ protected $comments = null; - + protected $page; protected $field; @@ -49,24 +49,25 @@ class CommentList extends Wire implements CommentListInterface { * */ protected $options = array( - 'headline' => '', // 'Comments
', + 'headline' => '', // 'Comments
', 'commentHeader' => '', // 'Posted by {cite} on {created}', - 'dateFormat' => '', // 'm/d/y g:ia', - 'encoding' => 'UTF-8', + 'dateFormat' => '', // 'm/d/y g:ia', + 'encoding' => 'UTF-8', 'admin' => false, // shows unapproved comments if true + 'useImageField' => '', // enable user image field 'useGravatar' => '', // enable gravatar? if so, specify maximum rating: [ g | pg | r | x ] or blank = disable gravatar 'useGravatarImageset' => 'mm', // default gravatar imageset, specify: [ 404 | mm | identicon | monsterid | wavatar ] 'usePermalink' => false, // @todo - 'useVotes' => 0, + 'useVotes' => 0, 'upvoteFormat' => '↑{cnt}', - 'downvoteFormat' => '↓{cnt}', - 'depth' => 0, - ); + 'downvoteFormat' => '↓{cnt}', + 'depth' => 0, + ); /** * Construct the CommentList * - * @param CommentArray $comments + * @param CommentArray $comments * @param array $options Options that may override those provided with the class (see CommentList::$options) * */ @@ -74,7 +75,7 @@ public function __construct(CommentArray $comments, $options = array()) { $h3 = $this->_('h3'); // Headline tag $this->options['headline'] = "<$h3>" . $this->_('Comments') . ""; // Header text - + if(empty($options['commentHeader'])) { if(empty($options['dateFormat'])) { $this->options['dateFormat'] = 'relative'; @@ -85,23 +86,23 @@ public function __construct(CommentArray $comments, $options = array()) { $this->options['dateFormat'] = $this->_('%b %e, %Y %l:%M %p'); // Date format in either PHP strftime() or PHP date() format // Example 1 (strftime): %b %e, %Y %l:%M %p = Feb 27, 2012 1:21 PM. Example 2 (date): m/d/y g:ia = 02/27/12 1:21pm. } } - - $this->comments = $comments; + + $this->comments = $comments; $this->page = $comments->getPage(); $this->field = $comments->getField(); - $this->options = array_merge($this->options, $options); + $this->options = array_merge($this->options, $options); } /** * Get replies to the given comment ID, or 0 for root level comments - * + * * @param int|Comment $commentID * @return array - * + * */ public function getReplies($commentID) { - if(is_object($commentID)) $commentID = $commentID->id; - $commentID = (int) $commentID; + if(is_object($commentID)) $commentID = $commentID->id; + $commentID = (int) $commentID; $admin = $this->options['admin']; $replies = array(); foreach($this->comments as $c) { @@ -109,7 +110,7 @@ public function getReplies($commentID) { if(!$admin && $c->status != Comment::statusApproved) continue; $replies[] = $c; } - return $replies; + return $replies; } /** @@ -120,11 +121,11 @@ public function getReplies($commentID) { * */ public function render() { - $out = $this->renderList(0); - if($out) $out = "\n" . $this->options['headline'] . $out; + $out = $this->renderList(0); + if($out) $out = "\n" . $this->options['headline'] . $out; return $out; } - + protected function renderList($parent_id = 0, $depth = 0) { $out = $parent_id ? '' : $this->renderCheckActions(); $comments = $this->options['depth'] > 0 ? $this->getReplies($parent_id) : $this->comments; @@ -134,62 +135,70 @@ protected function renderList($parent_id = 0, $depth = 0) { $class = "CommentList"; if($this->options['depth'] > 0) $class .= " CommentListThread"; else $class .= " CommentListNormal"; - if($this->options['useGravatar']) $class .= " CommentListHasGravatar"; + if($this->options['useImageField'] || $this->options['useGravatar']) $class .= " CommentListHasGravatar"; if($parent_id) $class .= " CommentListReplies"; $out = "- $out\n
";
+ }
- $gravatar = '';
- if($this->options['useGravatar']) {
- $imgUrl = $comment->gravatar($this->options['useGravatar'], $this->options['useGravatarImageset']);
- if($imgUrl) $gravatar = "\n\t\t";
+ if($this->options['useGravatar'] && !$imgUrl) {
+ $imgUrl = $comment->gravatar($this->options['useGravatar'], $this->options['useGravatarImageset']);
+ if($imgUrl) $avatar = "\n\t\t";
}
$website = '';
- if($comment->website) $website = $comment->getFormatted('website');
+ if($comment->website) $website = $comment->getFormatted('website');
if($website) $cite = "$cite";
- $created = wireDate($this->options['dateFormat'], $comment->created);
-
+ $created = wireDate($this->options['dateFormat'], $comment->created);
+
if(empty($this->options['commentHeader'])) {
$header = "$cite $created ";
- if($this->options['useVotes']) $header .= $this->renderVotes($comment);
+ if($this->options['useVotes']) $header .= $this->renderVotes($comment);
} else {
$header = str_replace(array('{cite}', '{created}'), array($cite, $created), $this->options['commentHeader']);
- if(strpos($header, '{votes}') !== false) $header = str_replace('{votes}', $this->renderVotes($comment), $header);
+ if(strpos($header, '{votes}') !== false) $header = str_replace('{votes}', $this->renderVotes($comment), $header);
}
-
+
$liClass = '';
- $replies = $this->options['depth'] > 0 ? $this->renderList($comment->id, $depth+1) : '';
+ $replies = $this->options['depth'] > 0 ? $this->renderList($comment->id, $depth+1) : '';
if($replies) $liClass .= ' CommentHasReplies';
- if($comment->status == Comment::statusPending) $liClass .= ' CommentStatusPending';
+ if($comment->status == Comment::statusPending) $liClass .= ' CommentStatusPending';
else if($comment->status == Comment::statusSpam) $liClass .= ' CommentStatusSpam';
-
- $out =
- "\n\t$header
" . - "\n\t\t" .
- "\n\t\t\t" . $avatar .
+ "\n\t\t
$text
" . + + $out = + "\n\t$header
" . + "\n\t\t" .
+ "\n\t\t\t
";
-
+
if($this->options['usePermalink']) {
$permalink = $comment->getPage()->httpUrl;
$urlSegmentStr = $this->wire('input')->urlSegmentStr;
@@ -202,28 +211,28 @@ public function renderItem(Comment $comment, $depth = 0) {
if($this->options['depth'] > 0 && $depth < $this->options['depth']) {
$out .=
- "\n\t\t$text
" . "\n\t\t