Docs For Class PageCommentInterface

Description

Represents an interface for viewing and adding page comments Create one, passing the page discussed to the constructor. It can then be inserted into a template.

Located in /cms/code/sitefeatures/PageCommentInterface.php (line 9)

Object
   |
   --ViewableData
      |
      --RequestHandlingData
         |
         --PageCommentInterface

Variable Summary

static mixed $allowed_actions

static boolean $comments_require_login

static string $comments_require_permission

static mixed $url_handlers

mixed $controller

mixed $methodName

mixed $page

Method Summary

static boolean CanPostComment ()

static void set_comments_require_login (boolean $state)

static void set_comments_require_permission (string $permission)

PageCommentInterface __construct (controller $controller, methodName $methodName, page $page)

void CommentRssLink ()

void Comments ()

void forTemplate ()

void Link ()

void Page ()

void PostCommentForm ()

boolean PostingRequiresPermission ()

Variables

static mixed $allowed_actions = array(
'PostCommentForm',
) (line 13)

Redefinition of:

RequestHandlingData::$allowed_actions: Define a list of action handling methods that are allowed to be called directly by URLs.

static boolean $comments_require_login = false (line 24)

var: If this is true, you must be logged in to post a comment (and therefore, you don't need to specify a 'Your name' field unless your name is blank)

static string $comments_require_permission = "" (line 31)

var: If this is a valid permission code, you must be logged in and have the appropriate permission code on your account before you can post a comment.

static mixed $url_handlers = array(
'$Item!' => '$Item',
) (line 10)

Redefinition of:

RequestHandlingData::$url_handlers: The default URL handling rules. This specifies that the next component of the URL corresponds to a method to be called on this RequestHandlingData object.

mixed $controller (line 17)

access: protected

mixed $methodName (line 17)

access: protected

mixed $page (line 17)

access: protected

Inherited Variables

Inherited from RequestHandlingData

RequestHandlingData::$request

Inherited from ViewableData

ViewableData::$casting
ViewableData::$castingHelperPair_cache
ViewableData::$customisedObj
ViewableData::$failover
ViewableData::$iteratorPos
ViewableData::$iteratorTotalItems
ViewableData::$namedAs
ViewableData::$parent
ViewableData::$_natural_cache
ViewableData::$_object_cache
ViewableData::$_xml_cache

Inherited from Object

Object::$builtInMethods
Object::$class
Object::$classConstructed
Object::$extensions
Object::$extension_instances
Object::$extraMethods
Object::$extraStatics
Object::$statics
Object::$static_cached

Methods

static method CanPostComment (line 76)

return: true if the currently logged in user can post a comment, false if they can't. Users can post comments by default, enforce security by using
link: PageCommentInterface::set_comments_require_login()
link: {PageCommentInterface::set_comments_require_permission()}.

static boolean CanPostComment ()

static method set_comments_require_login (line 53)

See @link PageCommentInterface::$comments_require_login

static void set_comments_require_login (boolean $state)

boolean $state: state The new state of this static field

static method set_comments_require_permission (line 61)

See @link PageCommentInterface::$comments_require_permission

static void set_comments_require_permission (string $permission)

string $permission: permission The permission to check against.

Constructor __construct (line 39)

Create a new page comment interface

PageCommentInterface __construct (controller $controller, methodName $methodName, page $page)

controller $controller: The controller that the interface is used on
methodName $methodName: The method to return this PageCommentInterface object
page $page: The page that we're commenting on

Redefinition of:

Object::__construct()

CommentRssLink (line 165)

void CommentRssLink ()

Comments (line 143)

void Comments ()

forTemplate (line 65)

void forTemplate ()

Link (line 45)

void Link ()

Page (line 98)

void Page ()

PostCommentForm (line 102)

void PostCommentForm ()

PostingRequiresPermission (line 94)

return: true if this page comment form requires users to have a valid permission code in order to post (used to customize the error message).

boolean PostingRequiresPermission ()

Inherited Methods

Inherited From RequestHandlingData

RequestHandlingData::checkAccessAction()
RequestHandlingData::getRequest()
RequestHandlingData::handleRequest()
RequestHandlingData::httpError()

Inherited From ViewableData

ViewableData::ATT_val()
ViewableData::BaseHref()
ViewableData::buildCastingHelperCache()
ViewableData::cachedCall()
ViewableData::castingHelper()
ViewableData::castingHelperPair()
ViewableData::castingObjectCreator()
ViewableData::castingObjectCreatorPair()
ViewableData::CSSClasses()
ViewableData::CurrentMember()
ViewableData::CurrentPage()
ViewableData::customise()
ViewableData::Debug()
ViewableData::defineMethods()
ViewableData::escapeTypeForField()
ViewableData::Even()
ViewableData::EvenOdd()
ViewableData::First()
ViewableData::FirstLast()
ViewableData::getField()
ViewableData::getIterator()
ViewableData::getXMLValues()
ViewableData::hasField()
ViewableData::HasPerm()
ViewableData::hasValue()
ViewableData::i18nLocale()
ViewableData::IsAjax()
ViewableData::iteratorProperties()
ViewableData::JS_val()
ViewableData::Last()
ViewableData::Me()
ViewableData::Middle()
ViewableData::MiddleString()
ViewableData::obj()
ViewableData::Odd()
ViewableData::Pos()
ViewableData::RAW_val()
ViewableData::renderWith()
ViewableData::SecurityID()
ViewableData::setCustomisedObj()
ViewableData::setField()
ViewableData::SQL_val()
ViewableData::ThemeDir()
ViewableData::Top()
ViewableData::TotalItems()
ViewableData::val()
ViewableData::XML_val()
ViewableData::__get()
ViewableData::__isset()
ViewableData::__set()

Inherited From Object

Object::__construct()
Object::addMethodsFrom()
Object::addStaticVars()
Object::addWrapperMethod()
Object::add_extension()
Object::allMethodNames()
Object::buildMethodList()
Object::cacheToFile()
Object::cacheToFileWithArgs()
Object::create()
Object::createMethod()
Object::defineMethods()
Object::exists()
Object::extend()
Object::extInstance()
Object::getCustomClass()
Object::hasExtension()
Object::hasMethod()
Object::invokeWithExtensions()
Object::is_a()
Object::loadCache()
Object::parentClass()
Object::sanitiseCachename()
Object::saveCache()
Object::set_stat()
Object::set_uninherited()
Object::stat()
Object::strong_create()
Object::uninherited()
Object::useCustomClass()
Object::__call()
Object::__toString()