Programmer's Reference Guide

Xyster Framework

The contents of this guide are available under the terms of the FreeBSD Documentation License

Redistribution and use in source (SGML DocBook) and 'compiled' forms (SGML, HTML, PDF, PostScript, RTF and so forth) with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code (SGML DocBook) must retain the above copyright notice, this list of conditions and the following disclaimer as the first lines of this file unmodified.

  2. Redistributions in compiled form (transformed to other DTDs, converted to PDF, PostScript, RTF and other formats) must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS DOCUMENTATION IS PROVIDED BY THE XYSTER FRAMEWORK PROJECT "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FREEBSD DOCUMENTATION PROJECT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

2008-05-19


Table of Contents

1. Introduction to Xyster Framework
1.1. Overview
1.2. Installation
1.2.1. System Requirements
1.2.2. Using the Xyster Framework
2. Xyster_Acl
2.1. Introduction
2.1.1. Authorizers
2.2. The ACL Role Provider
3. Xyster_Collection
3.1. Introduction
3.2. Collections
3.3. Lists
3.4. Sets
3.4.1. Sortable Sets and Comparators
3.5. Maps
3.5.1. String Maps
3.5.2. Object Maps
3.6. Xyster_Collection Static Methods
4. Xyster_Controller
4.1. Introduction
4.2. Action Helpers
4.2.1. Xyster_Controller_Action_Helper_Cache
4.2.2. Xyster_Controller_Action_Helper_File
4.3. Plugins
4.3.1. Xyster_Controller_Plugin_Acl
4.3.2. Xyster_Controller_Plugin_Auth
4.3.3. Xyster_Controller_Plugin_Cache
5. Xyster_Data
5.1. Overview
5.2. Data Symbols
5.2.1. Xyster_Data_Aggregate
5.2.2. Xyster_Data_Field
5.2.3. Xyster_Data_Sort
5.2.4. Xyster_Data_Criterion
5.3. Symbol Clauses
5.3.1. Xyster_Data_Junction
5.3.2. Xyster_Data_Field_Clause
5.3.3. Xyster_Data_Sort_Clause
5.4. Sets and Collections
5.4.1. Xyster_Data_Set
5.4.2. Xyster_Data_Tuple
6. Xyster_Date
6.1. Overview
6.1.1. Xyster_Date_Range
7. Xyster_Enum
7.1. Overview
8. Xyster_Filter
8.1. Overview
8.1.1. TitleCase
9. Xyster_Orm
9.1. Introduction
9.2. Setting Up
9.3. Xyster_Orm_Mapper
9.4. Xyster_Orm_Entity
9.5. Xyster_Orm
9.5.1. Getting entities
9.5.2. Storing Changes
9.5.3. Secondary Cache
9.6. Xyster_Orm_Relation
9.6.1. One-to-one
9.6.2. One-to-many
9.6.3. Joined (Many-to-many)
9.7. Lookups
9.7.1. Xyster_Orm_Entity_Lookup_Date
9.7.2. Xyster_Orm_Entity_Lookup_Enum
9.8. Validation
9.8.1. Options
9.8.2. Setting up
9.9. Queries and Reporting
9.9.1. Xyster_Orm_Query
9.9.2. Xyster_Orm_Query_Report
9.10. Plugins
9.10.1. Plugins Included in the Release
10. Xyster_Type
10.1. Overview
10.1.1. Creating
10.1.2. Basic Usage
10.2. Static Methods
10.2.1. Testing Value Equality
10.2.2. Hash Codes
10.2.3. Parameter Types
11. Xyster_Validate
11.1. Overview
11.1.1. Uri
11.2. Error Notification
11.2.1. Example of Use