Class CommentArray

ProcessWire FieldtypeComments > CommentArray

Maintains an array of multiple Comment instances. Serves as the value referenced when a FieldtypeComment field is reference from a Page.

Wire implements TrackChanges

WireArray implements IteratorAggregate, ArrayAccess, Countable

CommentArray

Located at modules/Fieldtype/FieldtypeComments/CommentArray.php

Methods summary
`public boolean`	# `isValidItem( mixed $item )` Per the WireArray interface, is the item a Comment Per the WireArray interface, is the item a Comment Parameters `$item` `mixed` Item to add Returns `boolean` True if item is valid and may be added, false if not
`public`	# `render( array $options = array() )` Provides the default rendering of a comment list, which may or may not be what you want Provides the default rendering of a comment list, which may or may not be what you want See CommentList class and override it to serve your needs
`public`	# `renderForm( array $options = array() )` Provides the default rendering of a comment form, which may or may not be what you want Provides the default rendering of a comment form, which may or may not be what you want See CommentForm class and override it to serve your needs
`public`	# `getCommentList( array $options = array() )` Return instance of CommentList object Return instance of CommentList object
`public`	# `getCommentForm( array $options = array() )` Return instance of CommentForm object Return instance of CommentForm object
`public`	# `setPage( Page $page )` Set the page that these comments are on Set the page that these comments are on

Methods inherited from WireArray
__get(), __isset(), __set(), __toString(), __unset(), _insert(), add(), append(), count(), eq(), filter(), filterData(), find(), findOne(), first(), get(), getAll(), getArray(), getItemKey(), getItemThatMatches(), getItemsAdded(), getItemsRemoved(), getIterator(), getKeys(), getNext(), getPrev(), getRandom(), getValues(), has(), import(), index(), insertAfter(), insertBefore(), isValidKey(), iterable(), last(), makeBlankItem(), makeNew(), not(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), pop(), prepend(), push(), remove(), removeAll(), resetTrackChanges(), reverse(), set(), setArray(), shift(), shuffle(), slice(), sort(), trackAdd(), trackRemove(), unique(), unshift(), usesNumericKeys()

Methods inherited from Wire
`_(), ___changed(), __call(), _n(), _x(), addHook(), addHookAfter(), addHookBefore(), addHookProperty(), className(), error(), fuel(), getAllFuel(), getChanges(), getFuel(), getHooks(), isChanged(), isHooked(), message(), removeHook(), runHooks(), setFuel(), setTrackChanges(), trackChange(), trackChanges(), untrackChange(), useFuel()`

Properties summary
`protected`	`$page`	`null`	# Page that owns these comments, required to use the renderForm() or getCommentForm() methods. Page that owns these comments, required to use the renderForm() or getCommentForm() methods.

Properties inherited from WireArray
`$data, $itemsAdded, $itemsRemoved`

Properties inherited from Wire
`$changes, $defaultHookOptions, $fuel, $hookMethodCache, $localHooks, $staticHooks, $trackChanges, $useFuel`