",
),
// values that will be already set, perhaps pulled from a user profile for instance (null = ignore)
// note that using presets is NOT cache safe: do not use for non-logged-in users if output caches are active
'presets' => array(
'cite' => null,
'email' => null,
'website' => null,
'text' => null,
),
// whether or not the preset values above will be changeable by the user
// applies only for preset values that are not null.
'presetsEditable' => false,
// the name of a field that must be set (and have any non-blank value), typically set in Javascript to keep out spammers
// to use it, YOU must set this with a field from your own javascript, somewhere in the form
'requireSecurityField' => '',
// the name of a field that must NOT be set
// creates an input field that a (human) visitor should ignore, maybe hiding it with css is a good idea
'requireHoneypotField' => '',
// should a redirect be performed immediately after a comment is successfully posted?
'redirectAfterPost' => null, // null=unset (must be set to true to enable)
// use threaded comments?
'depth' => 0,
// When a comment is saved to a page, avoid updating the modified time/user
'quietSave' => false,
// interial use: have options been initialized and are ready to use?
'_ready' => false,
);
/**
* Construct a CommentForm
*
* @param Page $page The page with the comments
* @param CommentArray $comments The field value from $page
* @param array $options Optional modifications to default behavior (see CommentForm::$options)
*
*/
public function __construct(Page $page, CommentArray $comments, $options = array()) {
$this->page = $page;
$this->comments = $comments;
// determine which field on the page is the commentsField and save the Field instance
$this->commentsField = $this->comments->getField();
/*
foreach($this->wire('fields') as $field) {
if(!$field->type instanceof FieldtypeComments) continue;
$value = $this->page->get($field->name);
if($value === $this->comments) {
$this->commentsField = $field;
break;
}
}
*/
// populate the value of redirectAfterPost
if($this->commentsField && is_null($this->options['redirectAfterPost'])) {
$this->options['redirectAfterPost'] = (bool) $this->commentsField->redirectAfterPost;
}
if($this->commentsField && $this->commentsField->quietSave) {
$this->options['quietSave'] = true;
}
$this->setOptions($options);
}
/**
* Initialize and set options
*
* @param array $options
*
*/
public function setOptions(array $options) {
if(!$this->options['_ready']) {
// default labels
$this->options['labels'] = array(
'headline' => '', // $this->_('Post Comment'),
'cite' => $this->_('Your Name'),
'email' => $this->_('Your E-Mail'),
'website' => $this->_('Your Website URL'),
'text' => $this->_('Comments'),
'submit' => $this->_('Submit'),
'stars' => '', // i.e. "Your Rating"
'starsRequired' => $this->_('Please choose a star rating'),
'success' => $this->_('Thank you, your submission has been saved.'),
'pending' => $this->_('Your comment has been submitted and will appear once approved by the moderator.'),
'error' => $this->_('Your submission was not saved due to one or more errors. Please check that you have completed all fields before submitting again.'),
'notify' => $this->_('E-Mail Notifications:'),
'notifyReplies' => $this->_('Replies'),
'notifyAll' => $this->_('All'),
'notifyOff' => $this->_('Off'),
);
}
// if request URL does not end with a slash, use the page URL as default action attribute
if(substr($this->wire('input')->url(), -1) != '/') {
$this->options['attrs']['action'] = $this->page->url;
}
// merge any user supplied array-based options to overwrite defaults
foreach(array('labels', 'attrs', 'classes', 'markup', 'presets') as $key) {
if(!isset($options[$key])) continue;
$this->options[$key] = array_merge($this->options[$key], $options[$key]);
unset($options[$key]);
}
// merge user supplied options with defaults
$this->options = array_merge($this->options, $options);
$options = &$this->options;
// default headline
$headline = $options['headline'];
$headlineLabel = $options['labels']['headline'];
if($headline && strpos($headline, '_('h3'); // Default headline tag
$markup = $options['markup']['headline'];
$options['headline'] = str_replace(array('{headline}', '{tag}'), array($headlineLabel, $tag), $markup);
}
// populate markup version of successMessage, pendingMessage, errorMessage
foreach(array('success', 'pending', 'error') as $type) {
$property = $type . 'Message';
$value = $options[$property];
if(empty($value)) {
// option not yet populated
$label = $options['labels'][$type];
} else {
// if already populated and has markup, so we will leave it as-is...
if(strpos($value, '{message}
$options[$property] = str_replace(array('{class}', '{message}'), array($class, $label), $markup);
}
$options['_ready'] = true;
}
/**
* Get options
*
* @return array
*
*/
public function getOptions() {
return $this->options;
}
public function option($key, $value = null) {
if($value === null) {
$value = isset($this->options[$key]) ? $this->options[$key] : null;
} else {
$this->options[$key] = $value;
}
return $value;
}
/**
* Get or set array property
*
* @param string $property Name of array property: labels, markup, classes, attrs, presets
* @param string|array $name Name of item to get or set or omit to get all, or assoc array to set all/multiple (and omit $value)
* @param string|null $value Value to set (if setting) or omit if getting
* @return string|array
* @throws WireException
* @since 3.0.153
*
*/
protected function arrayOption($property, $name = '', $value = null) {
if(!is_array($this->options[$property])) {
// invalid
throw new WireException("Invalid array property: $property");
} else if(empty($name)) {
// get all
$value = $this->options[$property];
} else if(is_array($name)) {
// set all or multiple
$this->options[$property] = array_merge($this->options[$property], $value);
} else if($value !== null) {
// set one
$this->options[$property][$name] = $value;
} else if(isset($this->options[$property][$name])) {
// get one
$value = $this->options[$property][$name];
} else {
// unknown
$value = '';
}
if($value !== null && in_array($name, array('success', 'pending', 'error', 'notification'))) {
// reset notifications rendered by setOptions
$this->options['successMessage'] = '';
$this->options['pendingMessage'] = '';
$this->options['errorMessage'] = '';
$this->setOptions($this->options);
}
return $value;
}
/**
* Get or set label
*
* @param string $name
* @param string|null $value
* @return string
* @since 3.0.153
*
*/
public function labels($name, $value = null) {
$result = $this->arrayOption('labels', $name, $value);
return $result;
}
/**
* Get or set attribute
*
* @param string $name
* @param string|null $value
* @return string
* @since 3.0.153
*
*/
public function attrs($name, $value = null) {
return $this->arrayOption('attrs', $name, $value);
}
/**
* Get or set class(es)
*
* @param string $name
* @param string|null $value
* @return string
* @since 3.0.153
*
*/
public function classes($name, $value = null) {
return $this->arrayOption('classes', $name, $value);
}
/**
* Get or set markup
*
* @param string $name
* @param string|null $value
* @return string
* @since 3.0.153
*
*/
public function markup($name, $value = null) {
return $this->arrayOption('markup', $name, $value);
}
/**
* Get or set presets
*
* @param string $name
* @param string|null $value
* @return string
* @since 3.0.153
*
*/
public function presets($name, $value = null) {
return $this->arrayOption('presets', $name, $value);
}
/**
* Set attribute
*
* @param string $attr
* @param string $value
* @deprecated Use attrs() method instead
*
*/
public function setAttr($attr, $value) {
$this->attrs($attr, $value);
}
/**
* Set label
*
* @param string $label Label name
* @param string $value Label value
* @deprecated Use labels() method instead
*
*/
public function setLabel($label, $value) {
$this->labels($label, $value);
}
/**
* Replaces the output of the render() method when a Comment is posted
*
* A success message is shown rather than the form.
*
* @param Comment|null $comment
* @return string
*
*/
protected function renderSuccess(Comment $comment = null) {
$pageID = (int) $this->wire('input')->post('page_id');
if($pageID && $this->options['redirectAfterPost']) {
// redirectAfterPost option
$page = $this->wire('pages')->get($pageID);
if(!$page->viewable() || !$page->id) $page = $this->wire('page');
$url = $page->id ? $page->url : './';
$url .= "?comment_success=1";
if($comment && $comment->id && $comment->status > Comment::statusPending) {
$url .= "&comment_approved=1#Comment$comment->id";
} else {
$url .= "#CommentPostNote";
}
$this->wire('session')->set('PageRenderNoCachePage', $page->id); // tell PageRender not to use cache if it exists for this page
$this->wire('session')->redirect($url);
return '';
}
if(!$this->commentsField || $this->commentsField->moderate == FieldtypeComments::moderateAll) {
// all comments are moderated
$message = $this->options['pendingMessage'];
} else if($this->commentsField->moderate == FieldtypeComments::moderateNone) {
// no moderation in service
$message = $this->options['successMessage'];
} else if($comment && $comment->status > Comment::statusPending) {
// comment is approved
$message = $this->options['successMessage'];
} else if($this->wire('input')->get('comment_approved') == 1) {
// comment was approved in previous request
$message = $this->options['successMessage'];
} else {
// other/comment still pending
$message = $this->options['pendingMessage'];
}
return str_replace('{out}', $message, $this->options['markup']['wrapNotification']);
}
/**
* Render the CommentForm output and process the input if it's been submitted
*
* @return string
*
*/
public function render() {
if(!$this->commentsField) return "Unable to determine comments field";
$options = $this->options;
$labels = $options['labels'];
$attrs = $options['attrs'];
$id = $attrs['id'];
$submitKey = $id . "_submit";
$honeypot = $options['requireHoneypotField'];
$inputValues = array('cite' => '', 'email' => '', 'website' => '', 'stars' => '', 'text' => '', 'notify' => '');
$sanitizer = $this->wire('sanitizer'); /** @var Sanitizer $sanitizer */
if($honeypot) $inputValues[$honeypot] = '';
$user = $this->wire('user');
if($user->isLoggedin()) {
$inputValues['cite'] = $sanitizer->entities($user->name);
$inputValues['email'] = $sanitizer->entities($user->email);
}
/** @var WireInput $input */
$input = $this->wire('input');
$divClass = 'new';
$class = trim("CommentForm " . $attrs['class']);
$note = '';
foreach($options['presets'] as $key => $value) {
if(!is_null($value)) $inputValues[$key] = $value;
}
if($options['processInput'] && $input->post($submitKey) == 1) {
$comment = $this->processInput();
if($comment) {
$note = $this->renderSuccess($comment); // success, return
} else {
$inputValues = array_merge($inputValues, $this->inputValues);
foreach($inputValues as $key => $value) {
$inputValues[$key] = htmlentities($value, ENT_QUOTES, $this->options['encoding']);
}
$note = "$options[errorMessage]";
$divClass = 'error';
}
} else if($this->options['redirectAfterPost'] && $input->get('comment_success') === "1") {
$note = $this->renderSuccess();
}
$form = $this->renderForm($id, $class, $attrs, $labels, $inputValues);
if(!$options['presetsEditable']) {
foreach($options['presets'] as $key => $value) {
$a = array(" name='$key'", " name=\"$key\"");
if(!is_null($value)) $form = str_replace($a, " name='$key' disabled='disabled'", $form);
}
}
//