Recite CMS Development Guide

Table of Contents

1. Introduction
2. Getting Started
Loading PHP Classes
Zend Framework
3. Application Environment
Current Client
Current User
Control Panel
Client Site
Database Abstraction
Maintaining Cross-Platform Compatability
4. Audit Log
Creating a New Audit Entry
Associating Audit Entries With a Module
Including Custom Data With Audit Message
Shorthand Method of Creating Audit Entries
5. Maintenance Queue
Creating a Maintenance Script
Scheduling the Maintenance Script to Run
Storing Custom Data With Maintenance Queue Item
Scheduling the Queue Item
Retaining Client Context
Viewing the Maintenance Queue
Command-Line Tools
Queueing A Maintenance Task
Running a Maintenance Task Immediately
Processing Maintenance Queue
6. Event Handling
Event Naming
Triggering Events
Including Data With An Event
Handling Data Returned by Observers
Listening for Events
Observer Name and Location
Implementing the Observer
Registering An Observer
List of Triggered Events
7. Checking Permissions in the Control Panel
How The Control Panel Handles Permissions
Defining Permissions
Checking Permissions
Checking a Single Permission
Checking Multiple Permissions
Using Permissions in Templates
Using the Recite Permissions Exception
8. Caching
Specifying Cache Options
Disabling the Cache
Setting the Maximum Lifetime
Setting the Tags
Clearing the Cache By Tag(s)

List of Examples

2.1. Manually including the PHP class
2.2. Auto-loading the Text_Lipsum class simply by using it
2.3. Creating the Module_Timesheets_Report class (./timesheets/include/Report.php)
2.4. Auto-loading a module class simply by using it
3.1. Retrieving the active client object
3.2. Retrieving the ID of the active client
3.3. Retrieving the active user object
3.4. Retrieving the active user
3.5. Retrieving the unique user hash.
3.6. Retrieving the user or the hash
3.7. Retrieving the active database connection
4.1. Creating and recording an audit message
4.2. Setting the module for an audit message
4.3. Including memo data with an audit message
4.4. Shorthand Method of Writing to Audit Log
5.1. Queueing up a maintenance script
5.2. Storing custom data with maintenance queue item
5.3. Scheduling Queue Item Execution For January 1, 2011.
6.1. Creating and triggering an event
6.2. Including data with an event
6.3. Receiving a response from an event
6.4. Using an event response
6.5. Creating a module observer (event.php)
6.6. Creating a driver observer (event.php)
6.7. Observing an event
6.8. Observing and responding to an event
7.1. Checking a single permission with both check() and assert()
7.2. Using Shorter Notation for Permissions Check
7.3. Checking multiple permissions at once with an "AND" permissions query
7.4. Checking multiple permissions at once with an "AND" permissions query
7.5. Checking a Permission From Within a Template
7.6. Retrieving the Failed Permissions
8.1. Preventing caching of the content in question
8.2. Specifying the maximum lifetime of a cache entry
8.3. Adding tags to a cache entry
8.4. Clearing the client web site cache by tags