Programmer's Reference Guide

Zend Framework

2006-07-11


Table of Contents

1. Zend
1.1. Introduction
1.2. Zend::loadFile()
1.3. Zend::loadClass()
1.4. Zend::loadInterface()
1.5. Zend::isReadable()
1.6. Zend::dump()
1.7. Zend::register()
1.8. Zend::registry()
2. Zend_Cache
2.1. Introduction
2.2. The theory of caching
2.2.1. The Zend_Cache factory method
2.2.2. Tagging records
2.2.3. Cleaning the cache
2.3. Zend_Cache frontends
2.3.1. Zend_Cache_Core
2.3.2. Zend_Cache_Frontend_Output
2.3.3. Zend_Cache_Frontend_Function
2.3.4. Zend_Cache_Frontend_Class
2.3.5. Zend_Cache_Frontend_File
2.3.6. Zend_Cache_Frontend_Page
2.4. Zend_Cache backends
2.4.1. Zend_Cache_Backend_File
2.4.2. Zend_Cache_Backend_Sqlite
2.4.3. Zend_Cache_Backend_Memcached
2.4.4. Zend_Cache_Backend_APC
3. Zend_Config
3.1. Introduction
3.2. Zend_Config_Array
3.2.1. Introduction
3.3. Zend_Config_Ini
3.3.1. Introduction
3.4. Zend_Config_Xml
3.4.1. Introduction
4. Zend_Controller
4.1. Overview
4.1.1. Introduction
4.1.2. Route Process
4.1.3. Dispatch Token
4.1.4. Dispatch Process
4.2. Getting Started
4.2.1. Introduction
4.2.2. Server Configuration
4.2.3. Bootstrap File
4.2.4. Directory Structure
4.2.5. IndexController
4.3. Subclassing
4.3.1. Introduction
4.3.2. Conventions
4.3.3. Router Interface
4.3.4. Dispatcher Interface
4.4. Plugins
4.4.1. Introduction
5. Zend_Controller_RewriteRouter
5.1. Introduction
5.2. Using a router
5.3. Basic Routes
5.4. Variable defaults
5.5. Variable requirements
5.6. Base URL and subdirectories
5.7. Default routes
6. Zend_Db
6.1. Zend_Db_Adapter
6.1.1. Introduction
6.1.2. Quoting Against SQL Injection
6.1.3. Direct Queries
6.1.4. Transactions
6.1.5. Inserting Rows
6.1.6. Updating Rows
6.1.7. Deleting Rows
6.1.8. Fetching Rows
6.2. Zend_Db_Profiler
6.2.1. Introduction
6.2.2. Using the Profiler
6.2.3. Advanced Profiler Usage
6.3. Zend_Db_Select
6.3.1. Introduction
6.3.2. Columns FROM a Table
6.3.3. Columns from JOINed Tables
6.3.4. WHERE Conditions
6.3.5. GROUP BY Clause
6.3.6. HAVING Conditions
6.3.7. ORDER BY Clause
6.3.8. LIMIT By Count and Offset
6.3.9. LIMIT By Page And Count
6.4. Zend_Db_Table
6.4.1. Introduction
6.4.2. Getting Started
6.4.3. Table Name and Primary Key
6.4.4. Inserting Rows
6.4.5. Updating Rows
6.4.6. Deleting Rows
6.4.7. Finding Rows by Primary Key
6.4.8. Fetching One Row
6.4.9. Fetching Multiple Rows
6.4.10. Adding Domain Logic
6.5. Zend_Db_Table_Row
6.5.1. Introduction
6.5.2. Fetching a Row
6.5.3. Modifying Values
6.6. Zend_Db_Table_Rowset
6.6.1. Introduction
6.6.2. Fetching a Rowset
6.6.3. Iterating Through the Rowset
7. Zend_Feed
7.1. Introduction
7.2. Importing Feeds with Zend_Feed
7.3. Retrieving Feeds from Web Pages
7.4. Consuming an RSS Feed
7.5. Consuming an Atom Feed
7.6. Consuming a Single Atom Entry
7.7. Modifying Feed and Entry structures
7.8. Custom Feed and Entry Classes
8. Zend_Filter
8.1. Zend_Filter
8.1.1. Introduction
8.1.2. Use Cases
8.2. Zend_Filter_Input
8.2.1. Introduction
8.2.2. Theory of Operation
8.2.3. Use Cases
9. Zend_Http
9.1. Zend_Http_Client
9.1.1. Introduction
9.1.2. Basic GET Requests with Specified HTTP Headers
9.1.3. Requesting Multiple Domains
9.1.4. Changing the HTTP Timeout
9.1.5. Setting HTTP Headers Dynamically
9.1.6. Making HTTP POST, PUT, and DELETE Requests
9.2. Zend_Http_Response
9.2.1. Introduction
10. Zend_Json
10.1. Introduction
10.2. Basic Usage
10.3. JSON Objects
11. Zend_Log
11.1. Introduction
11.2. Logging to a Single Log
11.3. Log Levels
11.4. Advanced Logging: Multiple Loggers
12. Zend_Mail
12.1. Introduction
12.2. Sending via SMTP
12.3. Sending Multiple Mails per SMTP Connection
12.4. Using Different Transports
12.5. HTML E-Mail
12.6. Attachments
12.7. Adding Recipients
12.8. Controlling the MIME Boundary
12.9. Additional Headers
12.10. Character Sets
12.11. Encoding
12.12. SMTP Authentication
13. Zend_Mime
13.1. Zend_Mime
13.1.1. Introduction
13.1.2. Static Methods and Constants
13.1.3. Instantiating Zend_Mime
13.2. Zend_Mime_Message
13.2.1. Introduction
13.2.2. Instantiation
13.2.3. Adding MIME Parts
13.2.4. Boundary handling
13.2.5. parsing a string to create a Zend_Mime_Message object (experimental)
13.3. Zend_Mime_Part
13.3.1. Introduction
13.3.2. Instantiation
13.3.3. Methods for rendering the message part to a string
14. Zend_Pdf
14.1. Introduction.
14.2. Creating and loading PDF documents.
14.3. Save changes to the PDF document.
14.4. Document pages.
14.5. Drawing.
14.5.1. Geometry.
14.5.2. Colors.
14.5.3. Shape Drawing.
14.5.4. Text Drawing.
14.5.5. Using fonts.
14.5.6. Image Drawing.
14.5.7. Line drawing style.
14.5.8. Fill style.
14.5.9. Rotations.
14.5.10. Save/restore graphics state.
14.5.11. Clipping draw area.
14.5.12. Styles.
14.6. Zend_Pdf module usage example.
15. Zend_Search
15.1. Overview
15.1.1. Introduction
15.1.2. Document and Field Objects
15.1.3. Understanding Field Types
15.2. Building Indexes
15.2.1. Creating a New Index
15.2.2. Updating Index
15.2.3. Updating Documents
15.3. Searching an Index
15.3.1. Building Queries
15.3.2. Search Results
15.3.3. Results Scoring
15.4. Query Types
15.4.1. Term Query
15.4.2. Multi-Term Query
15.4.3. Phrase Query
15.5. Character set.
15.5.1. UTF-8 and single-byte character sets support.
15.6. Extensibility
15.6.1. Text Analysis
15.6.2. Scoring Algorithms
15.6.3. Storage Containers
15.7. Interoperating with Java Lucene
15.7.1. File Formats
15.7.2. Index Directory
15.7.3. Java Source Code
15.7.4. Using LuceneIndexCreation.jar
16. Zend_Service
16.1. Introduction
16.2. Zend_Service_Rest
16.2.1. Introduction
16.3. Zend_Service_Amazon
16.3.1. Introduction
16.3.2. Country Codes
16.3.3. Looking up a Specific Amazon Item by ASIN
16.3.4. Performing Amazon Item Searches
16.3.5. Using the Alternative Query API
16.3.6. Zend_Service_Amazon Classes
16.4. Zend_Service_Flickr
16.4.1. Introduction to Searching Flickr
16.4.2. Finding Flickr Users
16.4.3. Retrieving Flickr Image Details
16.4.4. Zend_Service_Flickr Classes
16.5. Zend_Service_Yahoo
16.5.1. Introduction
16.5.2. Searching the Web with Yahoo!
16.5.3. Finding Images with Yahoo!
16.5.4. Finding Local Businesses and Services with Yahoo!
16.5.5. Searching Yahoo! News
16.5.6. Zend_Service_Yahoo Classes
17. Zend_View
17.1. Introduction
17.1.1. Controller Script
17.1.2. View Script
17.2. Controller Scripts
17.2.1. Assigning Variables
17.2.2. Rendering a View Script
17.2.3. View Script Paths
17.3. View Scripts
17.3.1. Escaping Output
17.3.2. Template Systems
17.4. View Helpers
17.4.1. Initial Helpers
17.4.2. Helper Paths
17.4.3. Writing Custom Helpers
18. Zend_XmlRpc
18.1. Introduction
18.2. Zend_XmlRpc_Client
18.2.1. Introduction
18.2.2. Using parameters
18.2.3. Type hinting of parameters
18.2.4. Getting the response
A. Zend Framework PHP Coding Standard
A.1. Overview
A.1.1. Scope
A.1.2. Goals
A.2. PHP File Formatting
A.2.1. General
A.2.2. Indentation
A.2.3. Maximum Line Length
A.2.4. Line Termination
A.3. Naming Conventions
A.3.1. Classes
A.3.2. Interfaces
A.3.3. Filenames
A.3.4. Functions and Methods
A.3.5. Variables
A.3.6. Constants
A.4. Coding Style
A.4.1. PHP Code Demarcation
A.4.2. Strings
A.4.3. Arrays
A.4.4. Classes
A.4.5. Functions and Methods
A.4.6. Control Statements
A.4.7. Inline Documentation
B. Copyright Information
Index

List of Tables

2.1. Available options
2.2. Available options
2.3. Available options
2.4. Available options
2.5. Available options
2.6. Available options
2.7. Available options
2.8. Available options
15.1. Zend_Search_Lucene_Field Types
16.1. Zend_Service_Amazon_Item Properties
16.2. Zend_Service_Amazon_Image Properties
16.3. Zend_Service_Amazon_OfferSet Properties
16.4. Zend_Service_Amazon_Offer Properties
16.5. Zend_Service_Amazon_SimilarProduct Properties
16.6. Zend_Service_Amazon_Accessories Properties
16.7. Zend_Service_Amazon_CustomerReview Properties
16.8. Zend_Service_Amazon_EditorialReview Properties
16.9. Zend_Service_Amazon_Listmania Properties
16.10. Zend_Service_Flickr_ResultSet Properties
16.11. Zend_Service_Flickr_Result Properties
16.12. Zend_Service_Flickr_Image Properties
16.13. Zend_Service_Yahoo_ResultSet
16.14. Zend_Service_Yahoo_LocalResultSet Properties
16.15. Zend_Service_Yahoo_Result Properties
16.16. Zend_Service_Yahoo_WebResult Properties
16.17. Zend_Service_Yahoo_ImageResult Properties
16.18. Zend_Service_Yahoo_LocalResult Properties
16.19. Zend_Service_Yahoo_NewsResult Properties
16.20. Zend_Service_Yahoo_Image Properties
18.1. PHP native values convertion to XML-RPC types
18.2. Zend_XmlRpc_Value object representing the XML-RPC types

List of Examples

2.1. Getting a frontend with Zend_Cache::factory()
2.2. Caching output with Zend_Cache output frontend
3.1. Loading Configuration Data from an INI File
3.2. Configuration Data Stored in PHP Arrays
3.3. Configuration Data Stored in INI Files
3.4. Configuration Data Stored in XML Files
7.1. Putting Zend_Feed to Work on RSS Feed Data
7.2. Basic Use of an Atom Feed
7.3. Reading a Single-Entry Atom Feed
7.4. Using the Entry Object Directly for a Single-Entry Atom Feed
7.5. Modifying an Existing Feed Entry
7.6. Creating an Atom Entry with Elements of Custom Namespaces
7.7. Extending the Atom Entry Class with Custom Namespaces
9.1. Performing a Basic GET Request
9.2. Creating a Basic Zend_Http_Client
9.3. Sending Multiple Headers
9.4. Requesting Multiple Domains
9.5. Sending POST data with Zend_Http_Client
9.6. Working with HTTP Response Data
12.1. Simple E-Mail with Zend_Mail
12.2. Sending E-Mail via SMTP
12.3. Sending Multiple Mails per SMTP Connection
12.4. Using Different Transports
12.5. Sending HTML E-Mail
12.6. E-Mail Messages with Attachments
12.7. Changing the MIME Boundary
12.8. Adding E-Mail Message Headers
14.1. Create new or load existing PDF document.
14.2. Requesting specified revision of the PDF document.
14.3. Save PDF document.
14.4. PDF document pages management.
14.5. Draw a string on the page.
14.6. Draw a UTF-8-encoded string on the page.
14.7. Create a standard font.
14.8. Create a TrueType font.
14.9. Create a TrueType font, but do not embed it in the PDF document.
14.10. Do not throw an exception for fonts that cannot be embeded.
14.11. Do not compress an embedded font.
14.12. Combining font embedding options.
14.13. Image drawing.
14.14. Zend_Pdf module usage demo.
15.1. Custom text Analyzer.
16.1. A basic REST Request
16.2. Search Amazon Using the Traditional API
16.3. Search Amazon Using the Query API
16.4. Choosing an Amazon Web Service Country
16.5. Looking up a Specific Amazon Item by ASIN
16.6. Performing Amazon Item Searches
16.7. Search Amazon Using the Alternative Query API
16.8. Simple Flickr Photo Search
16.9. Finding a Flickr User by E-Mail Address
16.10. Retrieving Flickr Image Details
16.11. Searching the Web with Yahoo!
16.12. Finding Images with Yahoo!
16.13. Finding Local Businesses and Services with Yahoo!
16.14. Searching Yahoo! News
18.1. A basic XML-RPC request
18.2. Calling an XML-RPC service with type hinting