Plugins.Content.PerUser.Arena.ContentProviders.AnArenaParsedContentProvider Class Reference

This class extends AnArenaContentProvider to allow post content to be parsed before it is returned. More...

Inheritance diagram for Plugins.Content.PerUser.Arena.ContentProviders.AnArenaParsedContentProvider:

Public Member Functions
def	__init__
	Constructor.
def	init
	Initializer.
def	next
def	content
	Fetch content for the channel. More...
def	ContentHandler
	Retrieve or set the content handler used by the content provider. More...
def	__iter__
	Return an iterator object. More...
def	__len__
	Return the "length" of the content – that is, how many records there are. More...
Public Member Functions inherited from Plugins.Content.PerUser.Arena.ContentProviders.AnArenaContentProvider
def	__init__
	Constructor. More...
def	init
	Initializer.
def	__del__
	Destructor.
def	beginSession
	Begin an arena session.
def	fetchUser
	Fetch the user specified by the session.
def	fetchContent
	Fetch the content specified by the channel.
def	content
	Fetch content for the channel.
def	Channel
	Retrieve the channel that specified this class should be constructed.
def	Session
	Retrieve the session manager used by this class.
def	User
	Retrieve the user record used by this class.
def	name
	Return the name of the channel that constructed this class.
Public Member Functions inherited from Library.UI.ContentFromDataSource.ADataSourceContentProvider
def	__init__
	Constructor. More...
def	init
	Initializer. More...
def	content
	Retrieve the content from the content provider. More...
Public Member Functions inherited from Library.UI.ContentProviders.AContentProvider
def	__init__
	Constructor. More...
def	init
	Initializer.
def	content
	Retrieve the content from the content provider. More...
def	Mediator
	Retrieve the mediator responsible for constructing the content provider. 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 extends AnArenaContentProvider to allow post content to be parsed before it is returned.

Member Function Documentation

def Plugins.Content.PerUser.Arena.ContentProviders.AnArenaParsedContentProvider.__iter__

(

Self

)

Return an iterator object.

This method allows the instance of AnArenaParsedContentProvider to pretend that it is the content returned by the data source; this allows it to parse each record as it is retrieved for display by the view.

def Plugins.Content.PerUser.Arena.ContentProviders.AnArenaParsedContentProvider.__len__

(

Self

)

Return the "length" of the content – that is, how many records there are.

def Plugins.Content.PerUser.Arena.ContentProviders.AnArenaParsedContentProvider.content

(

Self

)

Fetch content for the channel.

def Plugins.Content.PerUser.Arena.ContentProviders.AnArenaParsedContentProvider.ContentHandler	(		Self,
			params,
			keywordParams
	)

Retrieve or set the content handler used by the content provider.

If params is empty, this method simply returns the current content handler. Alternatively, params may contain one of the following:

• A single class instance, which should either be a reference to an instance of APost (or its descendants);
• Two strings: the first should be the name of a plugin to load, and the second should indicate the name of a class within that plugin to use as the content handler. The class will be instantiated for each content element (or post) needed while the view is being rendered. Any keywordParams specified will be passed to the content handler when it is constructed.

---

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

• Plugins/Content/PerUser/Arena/ContentProviders.py