Arena  1.0
A content management system
 All Classes Files Functions Variables Pages
Plugins.Content.PerUser.Arena.Posts.AnArenaPost Class Reference

This class represents a single post within a channel. More...

+ Inheritance diagram for Plugins.Content.PerUser.Arena.Posts.AnArenaPost:

Public Member Functions

def __init__
 Constructor.
 
def init
 Initializer.
 
def parseContent
 Parse the contents of the post. More...
 
def flush
 Flush the post to the data source. More...
 
def describe
 Generate a description for the post, based on the first 252 characters.
 
def countWords
 Generate keywords for the post.
 
def updateFromRequest
 Update post fields using the specified HTTP request information.
 
def publish
 Publish a post.
 
def delete
 Delete the post.
 
def Mediator
 Retrieve the content mediator driving the display of posts.
 
def preamble
 Retrieve the preamble of the post.
 
def recordPreamble
 Record the preamble parsed from the post.
 
- Public Member Functions inherited from Library.UI.Posts.APost
def __init__
 Constructor.
 
def init
 Initializer.
 
def flush
 Flush changes made to the post record back to the data source.
 
def publish
 Publish a post.
 
def parseContent
 Parse the contents of the post. More...
 
def parsedContent
 Retrieve the parsed content of the post.
 
- Public Member Functions inherited from Library.DataSource.DataRows.ADataRowWithExpandingFields
def __init__
 Constructor.
 
def init
 Initializer.
 
def flush
 Flush the data row back to the source.
 
def fetch
 Fetch the data row from the data source.
 
def insert
 Insert the data row into the data source. More...
 
def __getitem__
 Get the specified item from the data row.
 
- Public Member Functions inherited from Library.DataSource.DataRows.ADataRow
def __init__
 Construct a new instance of the class. More...
 
def init
 Initializer.
 
def flush
 Flush any changes made to the data row back to the data source. More...
 
def fetch
 Fetch the data row from the data source. More...
 
def insert
 Insert the data row into the data source. More...
 
def delete
 Delete the data row from the data source.
 
def toString
 Construct a string representation of the data row. More...
 
def isDirty
 Determine whether or not changes have been made to the data row since it was initially loaded from the data source. More...
 
def changes
 Retrieve the list of changed fields. More...
 
def Source
 Retrieve a reference to the data source used by the data row. More...
 
def __getitem__
 Get value of the specified field from the data row. More...
 
def __setitem__
 Set the value of the specified field. More...
 
def __delitem__
 Delete the specified field. More...
 
def keys
 Retrieve the keys (field names) in the data row. More...
 
- Public Member Functions inherited from Library.Base.Events.ALoggingEventfulObject
def __init__
 Constructor. More...
 
def init
 Initializer.
 
def error
 Generate an error event. More...
 
def log
 Log the specified item. More...
 
def Log
 Retrieve the log used by the class.
 
- Public Member Functions inherited from Library.Base.Events.AnEventfulObject
def __init__
 Constructor. More...
 
def init
 Initializer.
 
def __del__
 Destructor.
 
def parseParams
 Parse the specified parameters, looking for named events and setting event handlers as appropriate. More...
 
def generate
 Generate the named event.
 
def update
 Update the events generated by the object.
 
def error
 Generate an error event. More...
 
def toString
 Construct a string representation of the object. More...
 
def on
 Set the handler for the specified event. More...
 
def onMultiple
 Set handlers for multiple events. More...
 
def handlerFor
 Retrieve the handler for the specified event. More...
 
def generates
 Determine whether or not the object generates the named event. More...
 
def __getitem__
 Retrieve the value of the named property.
 
def __setitem__
 Set the value of the named property.
 
- Public Member Functions inherited from Library.Base.Classwork.AnObject
def init
 Initialize a new object instance. More...
 
def __init__
 Construct and initialize a new instance of AnObject. More...
 
def __del__
 Destroy the object instance. More...
 
def displayName
 Construct a "pretty" display name for the class instance, based on the name of its class. More...
 
def implements
 Determine whether the class instance is related to the specified class. More...
 
def toString
 Return a string representation of the class, suitable for output to a console or text-based device. More...
 
def __str__
 Return a string representation of the class. More...
 
def classname
 Return the name of the class from which the instance was created. More...
 
def name
 Return the name of the class. More...
 
- Public Member Functions inherited from Library.String.Utilities.IsPrintable
def toString
 Return a string representation of the class conveniently. More...
 
def __str__
 Return a string representation of the class. More...
 
def printTo
 Print a string representation of the class to the specified stream. More...
 

Detailed Description

This class represents a single post within a channel.

It allows the contents of the post to be parsed before the post is displayed to the end user.

Member Function Documentation

def Plugins.Content.PerUser.Arena.Posts.AnArenaPost.flush (   Self)

Flush the post to the data source.

def Plugins.Content.PerUser.Arena.Posts.AnArenaPost.parseContent (   Self)

Parse the contents of the post.

Descendant classes should override this method to parse the contents of the post before it is displayed to the end user.


The documentation for this class was generated from the following file: