Application
Table of Contents
Interfaces
- ControllerInterface
- The interface for all page controllers.
- ActiveRecordProviderInterface
- An interface that defines all of the active record methods that should be
included in a provider that implements this interface.
- TypeInterface
- The interface for all complex data types.
- TaskInterface
- The interface for background tasks that Alpha can run.
- CacheProviderInterface
- An interface that contains the methods for a cache implementation for storing business
objects and other less complex values.
- HighlightProviderInterface
- An interface that contains the methods for a code highlight implementation
that is used in the CMS to colour highlight source code for publication.
- EmailProviderInterface
- An interface that describes the use sending of emails.
- FilterInterface
- Interface for HTTP filters applied to front controller requests.
- SessionProviderInterface
- An interface that describes the use of sessions.
- LogProviderInterface
- Interface that defines the methods required for a logging provider.
- SearchProviderInterface
- A standard interface used for describing search engine implementations.
- RendererProviderInterface
- Defines the renderer interface, which allows us to have various implementations (HTML,
JSON, XML etc.) behind one unified interface. Use the
ServiceFactory::getInstance() method to get instances of this.
Classes
- ActiveRecordController
- The main active record CRUD controller for the framework.
- ArticleController
- Controller used handle Article objects.
- AttachmentController
- Controller used to view (download) an attachment file on an Article.
- CacheController
- Controller used to clear out the CMS cache when required.
- Controller
- The master controller class for the Alpha Framework.
- DEnumController
- Controller used to edit DEnums and associated DEnumItems.
- ExcelController
- Controller for viewing an active record as Excel spreadsheets.
- FeedController
- Controller for viewing news feeds.
- FrontController
- The front controller designed to optionally handle all requests.
- GenSecureQueryStringController
- Controller used to generate secure URLs from the query strings provided.
- ImageController
- Controller for viewing an image rendered with the Image widget.
- IndexController
- Standard index controller for the application. Override the index.phtml template to build your
own home page for your application.
- InstallController
- Controller used install the database.
- ListActiveRecordsController
- Controller used to list all of the active record types in the system.
- LogController
- Controller used to display a log file, the path for which must be supplied in GET vars.
- LoginController
- Login controller that adds the current user object to the session.
- LogoutController
- Logout controller that removes the current user object from the session.
- MetricController
- Controller used to display the software metrics for the application.
- PhpinfoController
- Login controller that adds the current user object to the session.
- RecordSelectorController
- Controller for viewing a RecordSelector widget.
- SearchController
- Search engine controller.
- SequenceController
- Controller used to list all Sequences.
- TagController
- Controller used to edit Tags related to the ActiveRecord indicated in the supplied
GET vars (ActiveRecordType and ActiveRecordID). If no ActiveRecord Type or ID are
indicated, then a screen to manage all tags at a summary level is presented.
- AlphaException
- The parent exception class for Alpha.
- BadTableNameException
- The exception class for invalid active record table name exceptions.
- CustomQueryException
- The exception class for when a custom SQL query failed to run.
- FailedDeleteException
- The exception class for record failed delete errors.
- FailedIndexCreateException
- The exception class for a failed attempt to create a database index or foreign key constraint.
- FailedLookupCreateException
- The exception class for a failed attempt to create a database lookup table for MANY-TO-MANY relationships.
- FailedSaveException
- The exception class for record failed save errors.
- FailedUnitCommitException
- The exception class for a Controller unit of work failing to save exceptions.
- FileNotFoundException
- The exception class for a file/directory not being found.
- IllegalArguementException
- The exception class for an illegal arguement (parameter) being passed to a method.
- LockingException
- The exception class for record locking (versioning) errors.
- MailNotSentException
- The exception class for errors sending email.
- NotImplementedException
- The exception class for when an expected method of an interface
has not been implemented by the provider throwing this exception.
- PHPException
- The exception class for handling generic PHP errors.
- RecordNotFoundException
- The exception class for record not found in the database errors.
- ResourceNotAllowedException
- The exception class for 403 resource not allowed controller errors.
- ResourceNotFoundException
- The exception class for resource not found errors.
- SearchIndexWriteException
- The exception class for issues updating a search index.
- SecurityException
- The exception class for security errors.
- ValidationException
- The exception class for record validation errors.
- ActionLog
- An action carried out be a person using the system can be logged using this class. Best
to call via Logger::action() method rather than directly here.
- ActiveRecord
- Base active record class definition providing database storage via the configured provider.
- ActiveRecordProviderMySQL
- MySQL active record provider (uses the MySQLi native API in PHP).
- ActiveRecordProviderSQLite
- SQLite active record provider (uses the SQLite3 native API in PHP).
- Article
- An article class for the CMS.
- ArticleComment
- An article comment class for user comments.
- ArticleVote
- An article vote class for user ratings.
- BadRequest
- A HTTP request that resulted in a 400 response. The class is only used when the
security.client.temp.blacklist.filter.enabled setting is set to true to enable the filter.
- BlacklistedClient
- A HTTP client that is blacklisted from accessing this application.
- BlacklistedIP
- An IP address that is blacklisted from accessing this application.
- Person
- The main person/user class for the framework.
- Rights
- The group level rights object for the application permissions.
- Tag
- The tag class used in tag clouds and search.
- Boolean
- The Boolean complex data type.
- Date
- The Date complex data type.
- DEnum
- The DEnum (Dynamic Enum) complex data type. Similiar to Enum,
except list items are stored in a database table and are editable.
- DEnumItem
- The DEnumItem (Dynamic Enum Item) complex data type. Has a one-to-many
relationship with the DEnum type.
- Double
- The Double complex data type.
- Enum
- The Enum complex data type.
- HugeText
- The HugeText complex data type.
- Integer
- The Integer complex data type.
- LargeText
- The LargeText complex data type.
- Relation
- The Relation complex data type.
- RelationLookup
- The RelationLookup complex data type. Used to store object2object lookup tables for
MANY-TO-MANY relationships between record objects.
- Sequence
- A custom sequence datatype, which is stored as a string and is made up of a string prefix
and an integer sequence, which is stored in a database.
- SmallText
- The SmallText complex data type.
- Text
- The Text complex data type.
- Timestamp
- The Timestamp complex data type.
- Type
- The base (abstract) complex data type.
- BackupTask
- A cron task for backup up the system database and select folders.
- CronManager
- The main class responsible for running custom cron tasks found under the [webapp]/Task
directory. This class should be executed from Linux cron via the CLI.
- BackupUtils
- A utility class for carrying out various backup tasks.
- CacheProviderAPC
- An implementation of the CacheProviderInterface interface that uses APC/APCu as the
target store.
- CacheProviderArray
- An implementation of the CacheProviderInterface interface that uses an array as the
target store. Only useful for unit tests.
- CacheProviderFile
- An implementation of the CacheProviderInterface interface that uses the
file system (app.file.store.dir) as the target store.
- CacheProviderMemcache
- An implementation of the CacheProviderInterface interface that uses Memcache as the
target store.
- CacheProviderRedis
- An implementation of the CacheProviderInterface interface that uses Redis as the
target store.
- HighlightProviderGeshi
- Wraps Geshi in the standard API defined in HighlightProviderInterface,
for use in the Alpha CMS module.
- Inspector
- Utility class for calculating some software metrics related to a project.
- ConfigProvider
- A singleton config class.
- ActiveRecord2Excel
- Class for converting a an active record to an Excel spreadsheet.
- EmailProviderPHP
- Sends an email using the mb_send_mail() function from PHP.
- ErrorHandlers
- A pair of static methods for capturing normal PHP errors and unhandled Alpha exceptions.
- Markdown
- A custom version of the Markdown class which uses the geshi library for rendering code.
- MarkdownFacade
- A facade class for the Markdown library.
- TCPDF
- Custom version of the TCPDF library class, allowing for any required overrides.
- TCPDFFacade
- A facade class for the TCPDF library which is used to convert some HTML content provided by the
Markdown library to a PDF file using FPDF.
- Atom
- Atom class for syndication.
- Feed
- Base feed class for generating syndication feeds.
- RSS
- RSS 1.0 class for synication.
- RSS2
- RSS 2.0 class for syndication.
- FileUtils
- A utility class for carrying out various file system tasks.
- GraphNode
- Maintains the geometry for a tree node.
- TreeGraph
- Maintains the geometry for a tree graph.
- Validator
- Generic validation class used throughout the Alpha Framework.
- AgentUtils
- A utility class for carrying out various tasks on HTTP user agent strings.
- ClientBlacklistFilter
- Class for filtering requests from blacklisted HTTP clients.
- ClientTempBlacklistFilter
- Class for filtering requests from temporariy blacklisted HTTP clients.
- IPBlacklistFilter
- Class for blocking requests from blacklisted IP addresses.
- PHPServerUtils
- A utility class controlling the build-in HTTP server in PHP.
- Request
- A class to encapsulate a HTTP request.
- Response
- A class to encapsulate a HTTP Response.
- SessionProviderArray
- Provides a session handle that stores session data in an array, useful for testing only.
- SessionProviderPHP
- Provides a session handle that stores session data in $_SESSION, the default PHP implementation.
- ImageUtils
- A utility class for carrying out various image file tasks.
- InputFilter
- A filter class for filtering user input from text fields.
- KPI
- A Key Performance Indicator (KPI) logging class.
- Logger
- Log class used for debug and exception logging.
- LogProviderFile
- Generic log file class to encapsulate common file I/O and rendering calls.
- SearchProviderTags
- Uses the Tag business oject to store searchable tags in the main
application database.
- SecurityUtils
- A utility class for carrying out various security tasks.
- ServiceFactory
- A factory for creating service instances that match the provider name and interface provided
- ArticleCommentView
- The rendering class for the ArticleComment class.
- ArticleView
- The rendering class for the Article class.
- DEnumView
- The rendering class for the DEnum class.
- PersonView
- The rendering class for the Person class.
- RendererProviderHTML
- HTML renderer. Will invoke widgets from the Alpha\View\Widgets package
automatically for the correct data type. Templates from ./templates/html
will be loaded by default, but these can be overridden on a per-record level in
the application when required (consider the default ones to be scaffolding).
- RendererProviderJSON
- JSON renderer.
- SequenceView
- The rendering class for the Sequence class.
- View
- The master rendering view class for the Alpha Framework.
- ViewState
- A singleton class that maintains the view state in the session.
- Button
- Button HTML custom widget.
- DateBox
- A HTML widget for rendering a text box with calendar icon for Date/Timestamp types.
- Image
- A widget that can generate an image which is scaled to the screen resolution of the
user, and can be made secured to prevent hot-linking from remote sites. Note that by
default, a jpg file will be returned (the source file can be jpg, png, or gif).
- RecordSelector
- Record selection HTML widget.
- SmallTextBox
- String HTML input box custom widget.
- TagCloud
- A widget for rendering a tag cloud, based off the Tag instances in the
database.
- TextBox
- Text HTML input box custom widget.