Arena
1.0
A content management system
|
Library | |
Application | |
Applications | |
AnApplication | The base application class |
BufferedCGIApplications | |
ABufferedCGIApplication | A CGI application that buffers its output |
CGIApplications | |
ACGIApplication | An application class that handles a CGI environment |
Base | |
Classwork | |
AnObject | The base class, from which all others are derived |
Events | |
AnEvent | An event that can be emitted by a class instance |
AnEventfulObject | An object that can generate events |
ALoggingEventfulObject | An object that generates events and which has access to a log for status and debugging messages |
Exceptions | |
AnException | The base exception class used by nearly all other exceptions generated by arena |
DataSource | |
Databases | |
ADataOperation | A basic operation performed against a database (i.e., a query or command) |
ADatabase | The abstract interface to a database |
DataRows | |
ADataRowError | A data row error |
ADataRow | A row of data retrieved from a data source |
AnExpandingListField | A class that represents an expanding list field |
AnExpandingDictionaryField | A class that represents an expanding dictionary field |
ADataRowWithExpandingFields | A data row that includes expandable fields |
DataSources | |
ADataSourceError | |
ADataSource | The abstract interface to a data source |
Queries | |
AQueryIterator | This class allows a query to behave as an iterable object |
AQuery | A basic query executed against a data source |
HTTP | |
HTTPRequests | |
AnHTTPRequest | This class consolidates the various variables related to an HTTP request |
RequestInfo | |
HTTPRequestContentInfo | |
HTTPRequestDateInfo | |
HTTPRequestDocumentInfo | |
HTTPRequestPathInfo | |
HTTPRequestRemoteInfo | |
HTTPRequestRequestInfo | |
HTTPRequestScriptInfo | |
HTTPRequestServerInfo | |
HTTPRequestHTTPInfo | |
IO | |
CGI | |
BufferedResponses | |
AnHTTPResponseBuffer | This class can be used to buffer output from a CGI script |
FileStreams | |
AFileStream | The base file stream class, from which all others are derived |
AFileInputStream | This class represents a stream that is used to read binary data from a file |
AFileOutputStream | This class represents a stream that is used to write binary information to a file |
HTTP | |
RequestInfo | |
HTTPRequestContentInfo | This class consolidates content information for an HTTP request |
HTTPRequestDateInfo | This class consolidates date information as part of an HTTP request |
HTTPRequestDocumentInfo | This class consolidates document information for an HTTP request |
HTTPRequestPathInfo | This class consolidates path information for an HTTP request |
HTTPRequestRemoteInfo | This class consolidates remote information for an HTTP request |
HTTPRequestRequestInfo | This class consolidates request information for an HTTP request |
HTTPRequestScriptInfo | This class consolidates request information for an HTTP request |
HTTPRequestServerInfo | This class consolidates server information for an HTTP request |
HTTPRequestHTTPInfo | This class consolidates HTTP information for an HTTP request |
Requests | |
AnHTTPRequest | This class consolidates the various variables related to an HTTP request |
Logging | |
Counters | |
ACounter | A counter |
Logs | |
AMessage | The base class for items that can be logged (such as messages, errors, hints, warnings, etc.) |
AMessageWithTimeStamp | A message that, when logged, will include a timestamp indicating when it was logged |
AMessageLog | A message log that outputs messages to a given stream or file |
ANullMessageLog | A null message log |
Streams | |
AStream | This class defines the methods common to all stream objects used by arena |
IsStreamable | This class defines the methods which must be implemented by classes that are capable of streaming their instance data to and from an arbitrary stream |
StringStreams | |
AStringStream | A class that allows strings to be used as though they are streams |
XML | |
XMLTags | |
AnXMLTag | A basic XML tag |
AnXMLWrapperTag | An XML tag that wraps around some text |
Memory | |
BinaryTrees | |
ABinaryLeaf | A node in a binary tree |
ABinaryTree | A binary tree |
collections | |
OrderedDict | OrderedDict |
Counter | Counter |
Point | |
Dictionaries | |
ADictionaryEntry | A single entry in a dictionary, which matches a string key to a value |
ADictionary | A binary tree class that acts much like a Python dictionary object |
Nodes | |
ANodeIterator | A class that iterates over a node |
ANode | A node |
StringTrees | |
AStringLeaf | A binary node that uses a string key instead of an integer key for sorting |
Parse | |
Errors | |
AParserMessage | |
AFatalError | |
ASyntaxError | |
AHint | |
AWarning | |
ANote | |
Lex | |
Languages | |
CharacterType | Character types that are recognized by a parser |
TokenType | Token types that are recognized by a parser |
AComputerLanguage | The specifications for a computer language that will be parsed by a parser |
Opcodes | |
AnOpcode | An opcode that matches a token string to an internal value used by a parser |
AnOpcodeSet | A set of opcodes |
Parsers | |
AParser | A parser |
Scan | |
Scanners | |
AScanner | A scanner that tokenizes a source stream |
SourceScanners | |
ASourceScanner | A scanner for a source stream |
Tokens | |
AToken | A generic token |
AWordToken | A token that represents a single word or identifier |
ANumberToken | A token that represents a numeric value |
AStringToken | A token that represents a string literal |
ASpecialToken | A token that represents a special character which is not necessarily a keyword or operator (such a list delimiter, brackets, etc.) |
ASpaceToken | A token that represents whitespace (not a token from space) |
ALineEndingToken | A token which represents an end of line character (or sequence of characters, for Windows-derived streams) |
AStreamEndingToken | A token that represents the end of the stream |
AnErrorToken | An erroneous token read from the source |
Semantic | |
SourceStatements | |
ASourceStatement | A statement parsed from a source stream |
Statements | |
AStatement | A statement parsed from code |
SourceParsers | |
ASourceParser | A parser that parses source code |
Symbols | |
SymbolCategory | Symbol category codes |
ASymbol | A basic symbol |
AStringLiteral | A string literal |
AConstant | A constant |
SymbolTables | |
Scope | Pre-defined scope definitions |
ASymbolTable | A symbol table |
String | |
Utilities | |
Time | A utility class that provides routines to handle time |
String | A utility class for working with strings |
IsPrintable | This class defines and implements a method to print the string representation of a class to the specified stream |
UI | |
Channels | |
AChannel | A channel, which provides a way to categorize content |
ContentFromDataSource | |
ADataSourceContentProvider | A content provider that retrieves content from a data source |
ContentProviders | |
AContentProviderError | A content provider error |
AContentProvider | A content provider |
Posts | |
APostError | Represents an error that may occur with a post |
APost | This class represents a single post within a channel |
Views | |
AViewError | A view error |
AView | A simple view |
Local | |
Configuration | |
Site | This class defines global options that affect how arena will work on your site |
Attachments | |
Channels | |
Data | |
Groups | |
Logging | |
Plugins | |
Posts | |
Sessions | |
Statistics | |
Subscriptions | |
Users | |
Views | |
Error | |
Plugins | |
Application | |
Arena | |
ArenaMediators | |
AnArenaMediatorError | Represents an error that might occur within the arena mediator itself |
AnArenaMediator | A content mediator customized for the default arena setup |
Posting | |
APostingError | Represents an error that may occur within the posting module itself |
APoster | An engine used to create and edit posts |
UserAuthentication | |
AnAuthenticationError | Represents an error that might occur within the authentication module itself |
AUserAuthenticator | A user authentication engine, which authenticates users |
Viewpoints | |
AViewpointError | Represents an error that might occur within the viewpoint module itself |
AViewpoint | The main "engine" of arena, which drives all of its functionality |
Mediators | |
AContentMediatorError | An error that may occur while mediating content |
AContentMediator | |
Content | |
Parse | |
Lex | |
c | |
c | A class that represents the syntax and rules of the C language |
Languages | |
MarkdownOpcode | Markdown opcodes understood by the parser |
AMarkdownLanguage | A class that represents the syntax and rules of a Markdown-style language |
python | |
python | A class that represents the syntax and rules of the Python language |
MarkdownParsers | |
AMarkdownParser | A parser that parses wiki markup and returns HTML output |
Semantic | |
CustomMarkdownStatements | |
CustomOpcode | A custom opcode for our new parser instance |
ASyntaxHighlighter | A special parser that provides syntax highlighting |
ACustomMarkdownTabBlock | A custom Markdown tab block |
MarkdownPreStatements | |
APrescannedMarkdownStatement | A pre-scanned Markdown statement |
AMarkdownLinkIdentifierStatement | A link identifier statement |
AMarkdownXMLStatement | A class that handles XML tags in the source (by skipping them) |
AMarkdownAmpersandStatement | A class that handles ampersands in the source |
AMarkdownParenStatement | A class that handles parentheses in the source |
AMarkdownLineEnding | A class that handle line endings |
AMarkdownSpaceSpan | A class that handles whitespace |
MarkdownStatements | |
AMarkdownStatement | A generic Markdown-style statement |
AMarkdownLinkStatement | A link statement |
AMarkdownImageStatement | An image |
AMarkdownStrongBlock | A class that handles strong formatting |
AMarkdownUnorderedListBlock | A class that handles an unordered list |
AMarkdownOrderedListBlock | A class that handles an ordered list |
AMarkdownAsteriskBlock | A class that handles unordered list or emphasis formatting |
AMarkdownEmphasisBlock | A class that handles emphasis formatting |
AMarkdownHeaderLine | A class that handles header lines |
AMarkdownCodeSpan | A class that handles emphasis formatting |
AMarkdownHorizRuleLine | |
AMarkdownTabBlock | A class that handles tabs |
AMarkdownSpaceBlock | A class that handles whitespace |
AMarkdownLineEnding | A class that handles line breaks |
AMarkdownIdentifier | A class that handles identifiers |
Symbols | |
ALinkIdentifier | A link identifier |
PerUser | |
Arena | |
AttachManagement | |
AnArenaAttachmentManager | |
Attachments | |
AnArenaAttachmentError | Represents an error that may occur with an attachment |
AnArenaAttachment | Represents a single attachment in arena |
ChannelsList | |
AnArenaChannelsListing | A channel list producer |
ContentProviders | |
AnArenaContentProviderError | An arena content provider error |
AnArenaContentProvider | This clas represents a channel record for arena |
AnArenaParsedContentProvider | This class extends AnArenaContentProvider to allow post content to be parsed before it is returned |
PostEditing | |
AnArenaPostEditor | A content provider that allows posts to be edited |
Posts | |
AnArenaPost | This class represents a single post within a channel |
PostsWithHighlighting | |
AnArenaPostWithHighlighting | A post handler that allows for syntax highlighting by replacing the default Markdown parser with a modified one |
UserAuthentication | |
AnAuthenticationError | Represents an error that might occur within the authentication module itself |
AUserAuthenticator | A user authentication engine, which authenticates users |
DataSource | |
DataLists | |
ADataList | A list of data retrieved from a database |
MySQL | |
Databases | |
AMySQLDatabase | This class extends ADatabase to allow connections to be made to MySQL databases |
DictionaryCursors | |
AMySQLDictionaryCursor | This class extends the base MySQLCursor class defined by the MySQL connector library to return query rows as dictionary objects instead of lists |
AMySQLBufferedDictionaryCursor | This class extends the base MySQLCursor class defined by the MySQL connector library to return query rows as dictionary objects instead of lists |
Queries | |
AMySQLQuery | A query executed against a MySQL data source |
AMySQLSelectQuery | A SELECT query executed against a MySQL data source |
AMySQLFullTextQuery | A full-text SELECT query |
AMySQLSelectCountQuery | A MySQL SELECT COUNT(*) query |
AMySQLInsertQuery | A MySQL INSERT query |
AMySQLUpdateQuery | A MySQL UPDATE query |
AMySQLDeleteQuery | A MySQL DELETE query |
AMySQLSelectFunctionQuery | A SELECT statement that returns the result of a function |
AMySQLUseDatabaseQuery | A USE query executed against a MySQL database |
AMySQLShowTablesQuery | A SHOW TABLES query executed against a MySQL database |
SQLQueries | |
AnSQLQuery | A basic SQL query executed against a data source |
Session | |
Arena | |
Sessions | |
AnArenaSession | An instance of ADataSession customized for use with the various arena engine instances |
DataSessions | |
ASessionError | Represents an error that can occur during a session |
ADataSession | A session (such as an HTTP session), for which the information is stored in a data source, such as a database |
Sessions | |
ASession | This is the base class for a session instance |
User | |
Arena | |
Users | |
AnArenaUser | This class customizes the ASubscribedUser class for use with the various arena engines |
GroupedUsers | |
AGroupedUser | This class represents a user that belongs to one or more groups |
Groups | |
AGroupError | This class represents an error that may occur while retrieving or updating group membership information |
AGroupList | This class represents a list of groups to which a specific user may belong |
SubscribedUsers | |
ASubscribedUser | This class represents a user that belongs to one or more groups, which are in turn subscribed to one or more channels |
Subscriptions | |
Right | The rights assigned to channels by means of a subscription |
Rights | A utility class to make managing rights easier |
ASubscriptionError | This class represents an error that may occur while attempting to access and modify group subscription information |
ASubscriptionList | This class represents a list of subscriptions that define the access rights of a specific group |
Users | |
AUserError | This class represents an error that can occur when retrieving or updating user information |
AUser | This class represents a user record for arena |
View | |
Jinja2Views | |
AJinja2View | This class represents a view, which is a jinja template that formats the output retrieved from a channel |
PerUser | |
Arena | |
Views | |
AnArenaViewError | Represents an error that may occur while displaying an arena view |
AnArenaView | A view manager customized to meet the needs of arena |