| CommentForm | Return instance of CommentForm object | |
| CommentList | Return instance of CommentList object | |
CommentArray::getField() CommentArray::getField() CommentArray::getField() | CommentField Field | Get the Field that these comments are on | |
CommentArray::getLimit() CommentArray::getLimit() CommentArray::getLimit() | int | Get the imposed limit on number of comments. | |
CommentArray::getPage() CommentArray::getPage() CommentArray::getPage() | Page | Get the page that these comments are on | |
CommentArray::getTotal() CommentArray::getTotal() CommentArray::getTotal() | int | Get the total number of comments | |
| bool | Does this CommentArray have the given Comment (or comment ID)? | |
CommentArray::isIdentical() CommentArray::isIdentical(WireArray $items) CommentArray::isIdentical(WireArray $items, $strict = true) | bool | Is the given CommentArray identical to this one? | |
CommentArray::isValidItem() CommentArray::isValidItem($item) CommentArray::isValidItem($item) | bool | Per the WireArray interface, is the item a Comment | |
CommentArray::makeNew() CommentArray::makeNew() CommentArray::makeNew() | CommentArray | Make a new blank CommentArray setup for the same Page/Field as the one it is called on | |
CommentArray::render() CommentArray::render() CommentArray::render(array $options = []) | string | Provides the default rendering of a comment list, which may or may not be what you want | |
CommentArray::renderAll() CommentArray::renderAll() CommentArray::renderAll(array $options = []) | string | Render all comments and a comments form below it | |
CommentArray::renderForm() CommentArray::renderForm() CommentArray::renderForm(array $options = []) | string | Provides the default rendering of a comment form, which may or may not be what you want | |
CommentArray::renderStars() CommentArray::renderStars() CommentArray::renderStars(bool $showCount = false, array $options = []) | string | Render combined star rating for all comments in this CommentsArray | |
CommentArray::setField() CommentArray::setField($field) CommentArray::setField($field) | (nothing) | Set the Field that these comments are on | |
CommentArray::setPage() CommentArray::setPage(Page $page) CommentArray::setPage(Page $page) | (nothing) | Set the page that these comments are on | |
CommentArray::stars() CommentArray::stars() CommentArray::stars(bool $allowPartial = true, bool $getCount = false) | int float false array | Get an average of all star ratings for all comments in this CommentsArray | |