Programmer's Reference Guide
Programmer's Reference Guide
     Next

Programmer's Reference Guide

Zym Framework

Copyright © 2008 Zym (http://www.zym-project.com/)

2008-10-26

Table of Contents

1. Zym_Acl
1.1. Introduction
1.2. Assertions
2. Zym_App
2.1. Environments
2.2. Running Zym_App
2.3. Configuration
2.3.1. Bootstrap configuration options
2.4. Resources
2.4.1. Resources included in Zym
2.4.1.1. Autoload Resource
2.4.1.2. Db Resource
2.4.1.3. Cache Resource
2.4.1.4. Controller Resource
2.4.1.5. Json Resource
2.4.1.6. Layout Resource
2.4.1.7. Locale Resource
2.4.1.8. Mail Resource
2.4.1.9. Navigation Resource
2.4.1.10. PHP Resource
2.4.1.11. Route Resource
2.4.1.12. Session Resource
2.4.1.13. Translate Resource
2.4.1.14. View Resource
2.4.2. Resource dispatching priorities
2.4.3. Caching in resources
2.5. Changing directory structure
3. Zym_Auth
3.1. Adapters
3.1.1. Chain adapter
4. Zym_Cache
5. Zym_Controller
5.1. Action
5.1.1. Contexts Integration
5.1.2. View Accessor
5.1.3. Goto method
5.2. Action Helpers
5.2.1. FlashRedirector
5.2.2. Form
5.2.2.1. Changing form loading path conventions
5.2.3. Navigation
5.2.4. Translator
5.3. Plugins
5.3.1. Layout Switcher
5.3.2. RouteByQuery
5.3.3. Sid
5.4. Router
5.4.1. Routes
5.4.1.1. HttpQuery
6. Zym_Filter
6.1. Standard filter classes
6.1.1. Null
6.1.2. Nl2Br
6.1.3. SentenceLength
6.1.4. Sprintf
6.1.5. UrlString
7. Zym_Js
7.1. Beautify
7.2. Minifier
8. Zym_Loader
8.1. Autoloading
8.1.1. Registering an autoloader
8.1.2. Writing your own autoloaders
9. Zym_Message
9.1. Registering a message
10. Zym_Navigation
10.1. Introduction
10.1.1. Pages and Containers
10.1.2. Separation of logic structure and rendering
10.2. Pages
10.2.1. Common page features
10.2.2. Zym_Navigation_Page_Mvc
10.2.3. Zym_Navigation_Page_Uri
10.2.4. Creating custom page types
10.3. Creating a navigational structure
10.3.1. Creating pages using the page factory
10.3.2. Zym_Navigation, a page container
11. Zym_Session
11.1. Save Handlers
11.2. Validators
12. Zym_Timer
12.1. Timing single runs
12.2. Manager
13. Zym_Validate
13.1. Introduction
13.2. Standard Validation Classes
13.2.1. Confirm
13.2.2. Float
13.2.3. StringEquals
13.3. Sitemap Validation Classes
13.3.1. Changefreq
13.3.2. Lastmod
13.3.3. Loc
13.3.4. Priority
14. Zym_Version
15. Zym_View
15.1. View Helpers
15.1.1. GetRequest Helper
15.1.2. GetResponse Helper
15.1.3. GetSession Helper
15.1.4. Navigation Helpers
15.1.4.1. Integration with Zend_Translate
15.1.4.2. Integration with ACL
15.1.4.3. Navigation structure used in examples
15.1.4.4. Breadcrumbs Helper
15.1.4.5. Menu Helper
15.1.4.6. Sitemap Helper
15.1.5. TimeSince Helper
15.1.6. TimeUntil Helper
15.1.7. XmlDeclaration Helper
15.2. Streams
15.2.1. Disabling/Enabling stream functionality
15.2.2. Changing the protocol
15.2.3. Changing the wrapper
15.2.4. Adding stream filters
15.2.5. Stream filters
15.2.5.1. ShortTags
15.2.5.2. AspTags
16. Zym_XmlRpc
16.1. XmlRpc Server
16.1.1. Caching
A. Performance Optimization
A.1. Pre-requiring often used files
A.2. Disabling APC stat with ZF
A.3. Autoloading ZF and Zym
A.4. The Autoloading VS. Requires Argument
A.4.1. So which one is better?
B. Building scalable applications
B.1. Terms
C. Copyright Information

List of Tables

2.1. Zym_App Configuration Options
2.2. Autoload Resource Options
2.3. Db Resource Options
2.4. Cache Resource Options
2.5. Controller Resource Options
2.6. Json Resource Options
2.7. Layout Resource Options
2.8. Locale Resource Options
2.9. Mail Resource Options
2.10. Navigation Resource Options
2.11. PHP Resource Options
2.12. Session Resource Options
2.13. Translate Resource Options
2.14. View Resource Options
10.1. Common page options
10.2. MVC page options
10.3. URI page options
15.1. Sitemap XML elements

List of Examples

2.1. Setting an environment
2.2. Simple dispatching of Zym_App
2.3. Advanced dispatching of Zym_App
2.4. Config file skeleton
2.5. An example of an empty config value
2.6. Simple bootstrap config (bootstrap.xml)
2.7. Single-DB Connection Config Example
2.8. Multi-DB Connection Config Example
2.9. Setting up the navigation resource
2.10. Route Resource config
2.11. Translate resource gettext usage example
2.12. Renaming directories
2.13. Self-contained in document root directory structure
3.1. Authenticating with multiple adapters
4.1. Configuring Zym_Cache
4.2. Zym_Cache simple usage
5.1. Using the Zym_Controller_Action contexts integration
5.2. Setting a flash redirect
5.3. Redirecting after login
5.4. Simple creation of forms
5.5. Simple shorthand creation of forms
5.6. Using the navigation action helper
5.7. Using the translator action helper
5.8. Using layout switchers
5.9. Using RouteByQuery
5.10. Using the HttpQuery Route
7.1. Simple javascript formatting
7.2. Minify a javascript string
7.3. Minify and return code from javascript file
7.4. Minify a javascript file
8.1. Registering autoloaders
8.2. A custom autoloader
9.1. Registering a message
9.2. Attaching, Detaching and Receiving Notifications
10.1. Using finder methods
10.2. Custom page properties
10.3. getHref() generates the page URL
10.4. isActive() determines if page is active
10.5. Using routes
10.6. The most simple custom page
10.7. Adding properties
10.8. Adding custom validation
10.9. Creating a custom page type using the page factory
10.10. Creating a navigation structure using an array
10.11. Creating a navigation structure using a config object
12.1. Code execution timing
12.2. Retrieving execution times
12.3. Timer manager simple usage
13.1. Using Zym_Validate_Confirm
13.2. Sitemap Lastmod Validator
13.3. Sitemap Priority Validator
14.1. Example of compareVersion() method
15.1. Proxying calls to the navigation container
15.2. Rendering breadcrumbs
15.3. Rendering customized breadcrumbs
15.4. Rendering a menu
15.5. Rendering a custom menu
15.6. Rendering an XML sitemap
15.7. Using Zym_View_Helper_TimeSince
15.8. Using Zym_View_Helper_TimeUntil
15.9. Using Zym_View_Helper_XmlDeclaration
16.1. Caching Zend_XmlRpc_Server with Zend_Cache
     Next
     Chapter 1. Zym_Acl