Programmer's Reference Guide

Zend Framework

2006-06-30


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. Zend_Cache factory
2.3. Zend_Cache_Core
2.3.1. Introduction
2.3.2. Available options (for this frontend in Zend_Cache factory)
2.3.3. Examples
2.3.4. clean the cache
2.4. Zend_Cache_Output
2.5. Zend_Cache_Page
2.6. Zend_Cache_File
2.7. Zend_Cache_Function
2.8. Zend_Cache_Class
2.9. Available backends for Zend_Cache
2.9.1. Zend_Cache_Backend_File
2.9.2. Zend_Cache_Backend_Sqlite
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_Db
5.1. Zend_Db_Adapter
5.1.1. Introduction
5.1.2. Quoting Against SQL Injection
5.1.3. Direct Queries
5.1.4. Transactions
5.1.5. Inserting Rows
5.1.6. Updating Rows
5.1.7. Deleting Rows
5.1.8. Fetching Rows
5.2. Zend_Db_Profiler
5.2.1. Introduction
5.2.2. Using the Profiler
5.2.3. Advanced Profiler Usage
5.3. Zend_Db_Select
5.3.1. Introduction
5.3.2. Columns FROM a Table
5.3.3. Columns from JOINed Tables
5.3.4. WHERE Conditions
5.3.5. GROUP BY Clause
5.3.6. HAVING Conditions
5.3.7. ORDER BY Clause
5.3.8. LIMIT By Count and Offset
5.3.9. LIMIT By Page And Count
5.4. Zend_Db_Table
5.4.1. Introduction
5.4.2. Getting Started
5.4.3. Table Name and Primary Key
5.4.4. Inserting Rows
5.4.5. Updating Rows
5.4.6. Deleting Rows
5.4.7. Finding Rows by Primary Key
5.4.8. Fetching One Row
5.4.9. Fetching Multiple Rows
5.4.10. Adding Domain Logic
5.5. Zend_Db_Table_Row
5.5.1. Introduction
5.5.2. Fetching a Row
5.5.3. Modifying Values
5.6. Zend_Db_Table_Rowset
5.6.1. Introduction
5.6.2. Fetching a Rowset
5.6.3. Iterating Through the Rowset
6. Zend_Feed
6.1. Introduction
6.2. Importing Feeds with Zend_Feed
6.3. Retrieving Feeds from Web Pages
6.4. Consuming an RSS Feed
6.5. Consuming an Atom Feed
6.6. Consuming a Single Atom Entry
6.7. Modifying Feed and Entry structures
6.8. Custom Feed and Entry Classes
7. Zend_Filter
7.1. Zend_Filter
7.1.1. Introduction
7.1.2. Use Cases
7.2. Zend_Filter_Input
7.2.1. Introduction
7.2.2. Theory of Operation
7.2.3. Use Cases
8. Zend_Http
8.1. Zend_Http_Client
8.1.1. Introduction
8.1.2. Basic GET Requests with Specified HTTP Headers
8.1.3. Requesting Multiple Domains
8.1.4. Changing the HTTP Timeout
8.1.5. Setting HTTP Headers Dynamically
8.1.6. Making HTTP POST, PUT, and DELETE Requests
8.2. Zend_Http_Response
8.2.1. Introduction
9. Zend_Json
9.1. Introduction
9.2. Basic Usage
9.3. JSON Objects
10. Zend_Log
10.1. Introduction
10.2. Logging to a Single Log
10.3. Log Levels
10.4. Advanced Logging: Multiple Loggers
11. Zend_Mail
11.1. Introduction
11.2. Sending via SMTP
11.3. Sending Multiple Mails per SMTP Connection
11.4. Using Different Transports
11.5. HTML E-Mail
11.6. Attachments
11.7. Adding Recipients
11.8. Controlling the MIME Boundary
11.9. Additional Headers
11.10. Character Sets
11.11. Encoding
11.12. SMTP Authentication
12. Zend_Mime
12.1. Zend_Mime
12.1.1. Introduction
12.1.2. Static Methods and Constants
12.1.3. Instantiating Zend_Mime
12.2. Zend_Mime_Message
12.2.1. Introduction
12.2.2. Instantiation
12.2.3. Adding MIME Parts
12.2.4. Boundary handling
12.2.5. parsing a string to create a Zend_Mime_Message object (experimental)
12.3. Zend_Mime_Part
12.3.1. Introduction
12.3.2. Instantiation
12.3.3. Methods for rendering the message part to a string
13. Zend_Pdf
13.1. Introduction.
13.2. Creating and loading PDF documents.
13.3. Save changes to the PDF document.
13.4. Document pages.
13.5. Drawing.
13.5.1. Geometry.
13.5.2. Colors.
13.5.3. Shape Drawing.
13.5.4. Text Drawing.
13.5.5. Using fonts.
13.5.6. Image Drawing.
13.5.7. Line drawing style.
13.5.8. Fill style.
13.5.9. Rotations.
13.5.10. Save/restore graphics state.
13.5.11. Clipping draw area.
13.5.12. Styles.
13.6. Zend_Pdf module usage example.
14. Zend_Search
14.1. Overview
14.1.1. Introduction
14.1.2. Document and Field Objects
14.1.3. Understanding Field Types
14.2. Building Indexes
14.2.1. Creating a New Index
14.2.2. Updating Index
14.2.3. Updating Documents
14.3. Searching an Index
14.3.1. Building Queries
14.3.2. Search Results
14.3.3. Results Scoring
14.4. Query Types
14.4.1. Term Query
14.4.2. Multi-Term Query
14.4.3. Phrase Query
14.5. Character set.
14.5.1. UTF-8 and single-byte character sets support.
14.6. Extensibility
14.6.1. Text Analysis
14.6.2. Scoring Algorithms
14.6.3. Storage Containers
14.7. Interoperating with Java Lucene
14.7.1. File Formats
14.7.2. Index Directory
14.7.3. Java Source Code
14.7.4. Using LuceneIndexCreation.jar
15. Zend_Service
15.1. Introduction
15.2. Zend_Service_Rest
15.2.1. Introduction
15.3. Zend_Service_Amazon
15.3.1. Introduction
15.3.2. Country Codes
15.3.3. Looking up a Specific Amazon Item by ASIN
15.3.4. Performing Amazon Item Searches
15.3.5. Using the Alternative Query API
15.3.6. Zend_Service_Amazon Classes
15.4. Zend_Service_Flickr
15.4.1. Introduction to Searching Flickr
15.4.2. Finding Flickr Users
15.4.3. Retrieving Flickr Image Details
15.4.4. Zend_Service_Flickr Classes
15.5. Zend_Service_Yahoo
15.5.1. Introduction
15.5.2. Searching the Web with Yahoo!
15.5.3. Finding Images with Yahoo!
15.5.4. Finding Local Businesses and Services with Yahoo!
15.5.5. Searching Yahoo! News
15.5.6. Zend_Service_Yahoo Classes
16. Zend_View
16.1. Introduction
16.1.1. Controller Script
16.1.2. View Script
16.2. Controller Scripts
16.2.1. Assigning Variables
16.2.2. Rendering a View Script
16.2.3. View Script Paths
16.3. View Scripts
16.3.1. Escaping Output
16.3.2. Template Systems
16.4. View Helpers
16.4.1. Initial Helpers
16.4.2. Helper Paths
16.4.3. Writing Custom Helpers
17. Zend_XmlRpc
17.1. Introduction
17.2. Zend_XmlRpc_Client
17.2.1. Introduction
17.2.2. Using parameters
17.2.3. Type hinting of parameters
17.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
14.1. Zend_Search_Lucene_Field Types
15.1. Zend_Service_Amazon_Item Properties
15.2. Zend_Service_Amazon_Image Properties
15.3. Zend_Service_Amazon_OfferSet Properties
15.4. Zend_Service_Amazon_Offer Properties
15.5. Zend_Service_Amazon_SimilarProduct Properties
15.6. Zend_Service_Amazon_Accessories Properties
15.7. Zend_Service_Amazon_CustomerReview Properties
15.8. Zend_Service_Amazon_EditorialReview Properties
15.9. Zend_Service_Amazon_Listmania Properties
15.10. Zend_Service_Flickr_ResultSet Properties
15.11. Zend_Service_Flickr_Result Properties
15.12. Zend_Service_Flickr_Image Properties
15.13. Zend_Service_Yahoo_ResultSet
15.14. Zend_Service_Yahoo_LocalResultSet Properties
15.15. Zend_Service_Yahoo_Result Properties
15.16. Zend_Service_Yahoo_WebResult Properties
15.17. Zend_Service_Yahoo_ImageResult Properties
15.18. Zend_Service_Yahoo_LocalResult Properties
15.19. Zend_Service_Yahoo_NewsResult Properties
15.20. Zend_Service_Yahoo_Image Properties
17.1. PHP native values convertion to XML-RPC types
17.2. Zend_XmlRpc_Value object representing the XML-RPC types

List of Examples

2.1. A first example with Zend_Cache core
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
6.1. Putting Zend_Feed to Work on RSS Feed Data
6.2. Basic Use of an Atom Feed
6.3. Reading a Single-Entry Atom Feed
6.4. Using the Entry Object Directly for a Single-Entry Atom Feed
6.5. Modifying an Existing Feed Entry
6.6. Creating an Atom Entry with Elements of Custom Namespaces
6.7. Extending the Atom Entry Class with Custom Namespaces
8.1. Performing a Basic GET Request
8.2. Creating a Basic Zend_Http_Client
8.3. Sending Multiple Headers
8.4. Requesting Multiple Domains
8.5. Sending POST data with Zend_Http_Client
8.6. Working with HTTP Response Data
11.1. Simple E-Mail with Zend_Mail
11.2. Sending E-Mail via SMTP
11.3. Sending Multiple Mails per SMTP Connection
11.4. Using Different Transports
11.5. Sending HTML E-Mail
11.6. E-Mail Messages with Attachments
11.7. Changing the MIME Boundary
11.8. Adding E-Mail Message Headers
13.1. Create new or load existing PDF document.
13.2. Requesting specified revision of the PDF document.
13.3. Save PDF document.
13.4. PDF document pages management.
13.5. Draw a string on the page.
13.6. Draw a UTF-8-encoded string on the page.
13.7. Create a standard font.
13.8. Create a TrueType font.
13.9. Create a TrueType font, but do not embed it in the PDF document.
13.10. Do not throw an exception for fonts that cannot be embeded.
13.11. Do not compress an embedded font.
13.12. Combining font embedding options.
13.13. Image drawing.
13.14. Zend_Pdf module usage demo.
14.1. Custom text Analyzer.
15.1. A basic REST Request
15.2. Search Amazon Using the Traditional API
15.3. Search Amazon Using the Query API
15.4. Choosing an Amazon Web Service Country
15.5. Looking up a Specific Amazon Item by ASIN
15.6. Performing Amazon Item Searches
15.7. Search Amazon Using the Alternative Query API
15.8. Simple Flickr Photo Search
15.9. Finding a Flickr User by E-Mail Address
15.10. Retrieving Flickr Image Details
15.11. Searching the Web with Yahoo!
15.12. Finding Images with Yahoo!
15.13. Finding Local Businesses and Services with Yahoo!
15.14. Searching Yahoo! News
17.1. A basic XML-RPC request
17.2. Calling an XML-RPC service with type hinting