Professional Documents
Culture Documents
ZendFramework 2.2.4 Manual en
ZendFramework 2.2.4 Manual en
Release 2.2.4
Contents
1 2 3
Overview Installation Getting Started with Zend Framework 2 3.1 Some assumptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.2 The tutorial application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Getting started: A skeleton application 4.1 Virtual host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.2 Error reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Modules 5.1 Setting up the Album module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5.2 Conguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5.3 Informing the application about our new module . . . . . . . . . . . . . . . . . . . . . . . . . . . . Routing and controllers Create the controller 7.1 Initialise the view scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Database and models 8.1 The database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8.2 The model les . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8.3 Using ServiceManager to congure the table gateway and inject into the AlbumTable . 8.4 Back to the controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8.5 Listing albums . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Styling and Translations
1 3 5 5 5 7 8 9 11 11 13 13 15 17 18 19 19 19 21 23 23 27 29 29 34 37 i
6 7
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
10 Forms and actions 10.1 Adding new albums . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10.2 Editing an album . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10.3 Deleting an album . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
10.4 Ensuring that the home page displays the list of albums . . . . . . . . . . . . . . . . . . . . . . . . . 11 Conclusion 12 Zend Framework Tool (ZFTool) 12.1 Installation using Composer . . . . . . . 12.2 Manual installation . . . . . . . . . . . . 12.3 Without installation, using the PHAR le 12.4 Usage . . . . . . . . . . . . . . . . . . .
38 41 43 43 43 43 44 47 47 47 49 50 52 52 53 57 57 58 60 61 62 63 64 66 70 71 71 71 73 75 77 78 78 79 80 81 83 85 85 89 90 90 90 93 93 93
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
13 Learning Dependency Injection 13.1 Very brief introduction to Di. . . . . . . . . . . . . . . 13.2 Simplest usage case (2 classes, one consumes the other) 13.3 Simplest Usage Case Without Type-hints . . . . . . . . 13.4 Simplest usage case with Compiled Denition . . . . . 13.5 Creating a precompiled denition for others to use . . . 13.6 Using Multiple Denitions From Multiple Sources . . . 13.7 Generating Service Locators . . . . . . . . . . . . . . . 14 Unit Testing a Zend Framework 2 application 14.1 Setting up the tests directory . . . . . . . . . 14.2 Bootstrapping your tests . . . . . . . . . . . 14.3 Your rst controller test . . . . . . . . . . . 14.4 A failing test case . . . . . . . . . . . . . . 14.5 Conguring the service manager for the tests 14.6 Testing actions with POST . . . . . . . . . . 14.7 Testing model entities . . . . . . . . . . . . 14.8 Testing model tables . . . . . . . . . . . . . 14.9 Conclusion . . . . . . . . . . . . . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
15 Using the EventManager 15.1 Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.2 Getting started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.3 Shared managers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Wildcards 17 Listener aggregates 17.1 Introspecting results . . . . . . . . . . . . . . . . . . . . 17.2 Short-ciruiting listener execution . . . . . . . . . . . . . 17.3 Keeping it in order . . . . . . . . . . . . . . . . . . . . . 17.4 Custom event objects . . . . . . . . . . . . . . . . . . . . 17.5 Putting it together: Implementing a simple caching system 17.6 Conclusion . . . . . . . . . . . . . . . . . . . . . . . . . 18 Advanced Conguration Tricks 18.1 System conguration . . . . . . . 18.2 Module Conguration . . . . . . 18.3 Conguration mapping table . . . 18.4 Conguration Priority . . . . . . 18.5 Conguration merging workow
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
19 Using Zend\Navigation in your Album Module 19.1 Preparation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19.2 Setting Up Zend\Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ii
19.3 Conguring our Site Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19.4 Adding the Menu View Helper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19.5 Adding Breadcrumbs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Using Zend\Paginator in your Album Module 20.1 Preparation . . . . . . . . . . . . . . . . 20.2 Modifying the AlbumTable . . . . . . . 20.3 Modifying the AlbumController . . . . . 20.4 Updating the View Script . . . . . . . . 20.5 Creating the Pagination Control Partial . 21 Using the PaginationControl View Helper
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
22 Setting up a database adapter 107 22.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 22.2 Basic setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 22.3 Setting a static adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 23 Migration from Zend Framework 1 109
24 Namespacing Old Classes 111 24.1 Namespacing a ZF1 Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 24.2 HOWTO Namespace Your Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 25 Running Zend Framework 2 and Zend Framework 1 in parallel 25.1 Use ZF2 in a ZF1 project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25.2 Use ZF1 in a ZF2 project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25.3 Run ZF1 and ZF2 together . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Introduction to Zend\Authentication 26.1 Adapters . . . . . . . . . . . . 26.2 Results . . . . . . . . . . . . . 26.3 Identity Persistence . . . . . . . 26.4 Usage . . . . . . . . . . . . . . 115 115 116 116 119 119 120 121 124
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
27 Database Table Authentication 127 27.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 27.2 Basic Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 27.3 Advanced Usage: Persisting a DbTable Result Object . . . . . . . . . . . . . . . . . . . . . . . . . . 130 28 Digest Authentication 28.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28.2 Specics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28.3 Identity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 HTTP Authentication Adapter 29.1 Introduction . . . . . . . 29.2 Design Overview . . . . . 29.3 Conguration Options . . 29.4 Resolvers . . . . . . . . . 29.5 Basic Usage . . . . . . . 133 133 133 133 135 135 135 136 136 137 139 139 139 141 iii
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
30.4 Server Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142 30.5 Collecting Debugging Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 30.6 Common Options for Specic Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 31 Authentication Validator 147 31.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 31.2 Basic Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 32 Introduction to Zend\Barcode 149
33 Barcode creation using Zend\Barcode\Barcode class 151 33.1 Using Zend\Barcode\Barcode::factory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 33.2 Drawing a barcode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 33.3 Rendering a barcode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 34 Zend\Barcode\Barcode Objects 155 34.1 Common Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 34.2 Common Additional Getters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 35 Description of shipped barcodes 35.1 Zend\Barcode\Object\Error . . . . . . . 35.2 Zend\Barcode\Object\Code128 . . . . . 35.3 Zend\Barcode\Object\Codabar . . . . . . 35.4 Zend\Barcode\Object\Code25 . . . . . . 35.5 Zend\Barcode\Object\Code25interleaved 35.6 Zend\Barcode\Object\Ean2 . . . . . . . 35.7 Zend\Barcode\Object\Ean5 . . . . . . . 35.8 Zend\Barcode\Object\Ean8 . . . . . . . 35.9 Zend\Barcode\Object\Ean13 . . . . . . . 35.10 Zend\Barcode\Object\Code39 . . . . . . 35.11 Zend\Barcode\Object\Identcode . . . . . 35.12 Zend\Barcode\Object\Itf14 . . . . . . . . 35.13 Zend\Barcode\Object\Leitcode . . . . . . 35.14 Zend\Barcode\Object\Planet . . . . . . . 35.15 Zend\Barcode\Object\Postnet . . . . . . 35.16 Zend\Barcode\Object\Royalmail . . . . . 35.17 Zend\Barcode\Object\Upca . . . . . . . 35.18 Zend\Barcode\Object\Upce . . . . . . . 159 159 159 160 160 160 161 161 162 162 163 163 163 164 164 165 165 165 166
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
36 Zend\Barcode Renderers 167 36.1 Common Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 36.2 Zend\Barcode\Renderer\Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 36.3 Zend\Barcode\Renderer\Pdf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 37 Zend\Cache\Storage\Adapter 37.1 Overview . . . . . . . . . . . . . . . 37.2 Quick Start . . . . . . . . . . . . . . 37.3 Basic Conguration Options . . . . . 37.4 The StorageInterface . . . . . . . . . 37.5 The AvailableSpaceCapableInterface 37.6 The TotalSpaceCapableInterface . . . 37.7 The ClearByNamespaceInterface . . 37.8 The ClearByPrexInterface . . . . . 37.9 The ClearExpiredInterface . . . . . . 37.10 The FlushableInterface . . . . . . . . 169 169 169 170 170 172 172 173 173 173 173
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
iv
37.11 37.12 37.13 37.14 37.15 37.16 37.17 37.18 37.19 37.20 37.21 37.22 37.23
The IterableInterface . . . . . The OptimizableInterface . . The TaggableInterface . . . . The Apc Adapter . . . . . . . The Dba Adapter . . . . . . . The Filesystem Adapter . . . The Memcached Adapter . . The Memory Adapter . . . . The WinCache Adapter . . . The XCache Adapter . . . . . The ZendServerDisk Adapter The ZendServerShm Adapter Examples . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
. . . . . . . . . . . . .
173 174 174 174 175 176 177 178 179 180 181 181 182 185 185 185 187 189 189 189 190 190 190 190 191 191 192
38 Zend\Cache\Storage\Capabilities 38.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38.2 Available Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38.3 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Zend\Cache\Storage\Plugin 39.1 Overview . . . . . . . . . . . . . 39.2 Quick Start . . . . . . . . . . . . 39.3 The ClearExpiredByFactor Plugin 39.4 The ExceptionHandler Plugin . . 39.5 The IgnoreUserAbort Plugin . . . 39.6 The OptimizeByFactor Plugin . . 39.7 The Serializer Plugin . . . . . . . 39.8 Available Methods . . . . . . . . 39.9 Examples . . . . . . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
40 Zend\Cache\Pattern 193 40.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193 40.2 Quick Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193 40.3 Available Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194 41 Zend\Cache\Pattern\CallbackCache 41.1 Overview . . . . . . . . . . . . 41.2 Quick Start . . . . . . . . . . . 41.3 Conguration Options . . . . . 41.4 Available Methods . . . . . . . 41.5 Examples . . . . . . . . . . . . 42 Zend\Cache\Pattern\ClassCache 42.1 Overview . . . . . . . . . . 42.2 Quick Start . . . . . . . . . 42.3 Conguration Options . . . 42.4 Available Methods . . . . . 42.5 Examples . . . . . . . . . . 195 195 195 195 196 196 197 197 197 197 198 198 201 201 201 202 202 203
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
43 Zend\Cache\Pattern\ObjectCache 43.1 Overview . . . . . . . . . . . 43.2 Quick Start . . . . . . . . . . 43.3 Conguration Options . . . . 43.4 Available Methods . . . . . . 43.5 Examples . . . . . . . . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
44 Zend\Cache\Pattern\OutputCache 44.1 Overview . . . . . . . . . . . 44.2 Quick Start . . . . . . . . . . 44.3 Conguration Options . . . . 44.4 Available Methods . . . . . . 44.5 Examples . . . . . . . . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
205 205 205 205 205 206 207 207 207 208 208 209 211 213 215 215 216 216 216 217
45 Zend\Cache\Pattern\CaptureCache 45.1 Overview . . . . . . . . . . . . 45.2 Quick Start . . . . . . . . . . . 45.3 Conguration Options . . . . . 45.4 Available Methods . . . . . . . 45.5 Examples . . . . . . . . . . . . 46 Introduction to Zend\Captcha 47 Captcha Operation 48 CAPTCHA Adapters 48.1 Zend\Captcha\AbstractWord 48.2 Zend\Captcha\Dumb . . . . 48.3 Zend\Captcha\Figlet . . . . 48.4 Zend\Captcha\Image . . . . 48.5 Zend\Captcha\ReCaptcha .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
49 Introduction to Zend\Cong 219 49.1 Using Zend\Cong\Cong with a Reader Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219 49.2 Using Zend\Cong\Cong with a PHP Conguration File . . . . . . . . . . . . . . . . . . . . . . . 220 50 Theory of Operation 51 Zend\Cong\Reader 51.1 Zend\Cong\Reader\Ini . 51.2 Zend\Cong\Reader\Xml 51.3 Zend\Cong\Reader\Json 51.4 Zend\Cong\Reader\Yaml 221 223 223 224 226 227 229 229 230 231 232 232 235 235 236 236 237 237
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
52 Zend\Cong\Writer 52.1 Zend\Cong\Writer\Ini . . . . 52.2 Zend\Cong\Writer\Xml . . . 52.3 Zend\Cong\Writer\PhpArray 52.4 Zend\Cong\Writer\Json . . . 52.5 Zend\Cong\Writer\Yaml . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
53 Zend\Cong\Processor 53.1 Zend\Cong\Processor\Constant . 53.2 Zend\Cong\Processor\Filter . . 53.3 Zend\Cong\Processor\Queue . . 53.4 Zend\Cong\Processor\Token . . 53.5 Zend\Cong\Processor\Translator
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
54 The Factory 239 54.1 Loading conguration le . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239 54.2 Storing conguration le . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
vi
55 Introduction to Zend\Console 241 55.1 Writing console routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241 55.2 Handling console requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243 55.3 Adding console usage info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244 56 Console routes and routing 56.1 Router conguration . . . 56.2 Basic route . . . . . . . . 56.3 Catchall route . . . . . . . 56.4 Console routes cheat-sheet 247 247 248 252 253
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
57 Console-aware modules 255 57.1 Application banner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255 57.2 Usage information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257 57.3 Best practices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263 58 Console-aware action controllers 58.1 Handling console requests . . . . . . . . 58.2 Sending output to console . . . . . . . . 58.3 Are we in a console? . . . . . . . . . . . 58.4 Reading values from console parameters 265 265 267 268 269
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
59 Console adapters 273 59.1 Retrieving console adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273 59.2 Using console adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274 60 Console prompts 60.1 Conrm . . 60.2 Line . . . . 60.3 Char . . . 60.4 Select . . . 277 278 278 279 280 283 285
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
63 Key derivation function 287 63.1 Pbkdf2 adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287 63.2 SaltedS2k adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288 63.3 Scrypt adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288 64 Password 291 64.1 Bcrypt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291 64.2 Apache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292 65 Public key cryptography 295 65.1 Dife-Hellman . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295 65.2 RSA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297 66 Zend\Db\Adapter 66.1 Creating an Adapter - Quickstart . . . . . . . . . . . . . . . . . 66.2 Creating an Adapter Using Dependency Injection . . . . . . . . 66.3 Query Preparation Through Zend\Db\Adapter\Adapter::query() 66.4 Query Execution Through Zend\Db\Adapter\Adapter::query() . 66.5 Creating Statements . . . . . . . . . . . . . . . . . . . . . . . 66.6 Using the Driver Object . . . . . . . . . . . . . . . . . . . . . 301 301 302 302 303 303 303 vii
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
66.7 Using The Platform Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305 66.8 Using The Parameter Container . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306 66.9 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307 67 Zend\Db\ResultSet 67.1 Quickstart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67.2 Zend\Db\ResultSet\ResultSet and Zend\Db\ResultSet\AbstractResultSet . . . . . . . . . . . . . . . . 67.3 Zend\Db\ResultSet\HydratingResultSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 Zend\Db\Sql 68.1 Zend\Db\Sql\Sql (Quickstart) . . . . . . . . . . 68.2 Zend\Db\Sqls Select, Insert, Update and Delete 68.3 Zend\Db\Sql\Select . . . . . . . . . . . . . . . . 68.4 Zend\Db\Sql\Insert . . . . . . . . . . . . . . . . 68.5 Zend\Db\Sql\Update . . . . . . . . . . . . . . . 68.6 Zend\Db\Sql\Delete . . . . . . . . . . . . . . . 68.7 Zend\Db\Sql\Where & Zend\Db\Sql\Having . . 69 Zend\Db\Sql\Ddl 70 Creating Tables 71 Altering Tables 72 Dropping Tables 73 Executing DDL Statements 74 Currently Supported Data Types 75 Currently Supported Constraint Types 309 309 310 310 313 313 314 314 317 318 318 318 325 327 329 331 333 335 337
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
76 Zend\Db\TableGateway 339 76.1 Basic Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339 76.2 TableGateway Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341 77 Zend\Db\RowGateway 343 77.1 Quickstart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343 77.2 ActiveRecord Style Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344 78 Zend\Db\Metadata 345 78.1 Basic Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345 79 Introduction to Zend\Di 349 79.1 Dependency Injection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349 79.2 Dependency Injection Containers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349 80 Zend\Di Quickstart 81 Zend\Di Denition 81.1 DenitionList . . . 81.2 RuntimeDenition 81.3 CompilerDenition 81.4 ClassDenition . . 351 355 355 355 356 357
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
84 Zend\Di Debugging & Complex Use Cases 365 84.1 Debugging a DiC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365 84.2 Complex Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365 85 Introduction to Zend\Dom 369
86 Zend\Dom\Query 371 86.1 Theory of Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371 86.2 Methods Available . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372 87 Introduction to Zend\Escaper 375 87.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375 87.2 What Zend\Escaper is not . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376 88 Theory of Operation 377 88.1 The Problem with Inconsistent Functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377 88.2 Why Contextual Escaping? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378 89 Conguring Zend\Escaper 381
90 Escaping HTML 383 90.1 Examples of Bad HTML Escaping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383 90.2 Examples of Good HTML Escaping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384 91 Escaping HTML Attributes 385 91.1 Examples of Bad HTML Attribute Escaping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385 91.2 Examples of Good HTML Attribute Escaping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386 92 Escaping Javascript 389 92.1 Examples of Bad Javascript Escaping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389 92.2 Examples of Good Javascript Escaping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390 93 Escaping Cascading Style Sheets 391 93.1 Examples of Bad CSS Escaping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391 93.2 Examples of Good CSS Escaping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391 94 Escaping URLs 393 94.1 Examples of Bad URL Escaping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393 94.2 Examples of Good URL Escaping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393 95 The EventManager 95.1 Overview . . . . . . . 95.2 Quick Start . . . . . . 95.3 Conguration Options 95.4 Available Methods . . 95.5 Examples . . . . . . . 96 Introduction to Zend\Feed 395 395 395 398 399 400 405
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
ix
98 Retrieving Feeds from Web Pages 99 Consuming an RSS Feed 100Consuming an Atom Feed 101Consuming a Single Atom Entry
102Zend\Feed and Security 417 102.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417 102.2 Filtering data using HTMLPurier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417 102.3 Escaping data using Zend\Escaper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419 103Zend\Feed\Reader\Reader 103.1 Introduction . . . . . . . . . . . . . . . . . . 103.2 Importing Feeds . . . . . . . . . . . . . . . . 103.3 Retrieving Underlying Feed and Entry Sources 103.4 Cache Support and Intelligent Requests . . . . 103.5 Locating Feed URIs from Websites . . . . . . 103.6 Attribute Collections . . . . . . . . . . . . . . 103.7 Retrieving Feed Information . . . . . . . . . . 103.8 Retrieving Entry/Item Information . . . . . . . 103.9 Extending Feed and Entry APIs . . . . . . . . 104Zend\Feed\Writer\Writer 104.1 Introduction . . . . . . . 104.2 Architecture . . . . . . . 104.3 Getting Started . . . . . . 104.4 Setting Feed Data Points . 104.5 Setting Entry Data Points 421 421 421 422 423 424 425 425 428 429 435 435 435 436 438 440 443 443 443 444 445 451 451 451 451
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
105Zend\Feed\PubSubHubbub 105.1 What is PubSubHubbub? . . . . . . . . 105.2 Architecture . . . . . . . . . . . . . . 105.3 Zend\Feed\PubSubHubbub\Publisher . 105.4 Zend\Feed\PubSubHubbub\Subscriber
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
107Introduction to Zend\Filter 453 107.1 What is a lter? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453 107.2 Basic usage of lters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453 108Using the StaticFilter 455 108.1 Double ltering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455 109Standard Filter Classes 109.1 Alnum . . . . . . . . . . . 109.2 Alpha . . . . . . . . . . . . 109.3 BaseName . . . . . . . . . 109.4 Boolean . . . . . . . . . . . 109.5 Callback . . . . . . . . . . 109.6 Compress and Decompress . x 457 457 458 458 459 462 463
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
109.7 Digits . . . . . . . . 109.8 Dir . . . . . . . . . 109.9 Encrypt and Decrypt 109.10HtmlEntities . . . . 109.11Int . . . . . . . . . . 109.12Null . . . . . . . . . 109.13NumberFormat . . . 109.14PregReplace . . . . 109.15RealPath . . . . . . 109.16StringToLower . . . 109.17StringToUpper . . . 109.18StringTrim . . . . . 109.19StripNewLines . . . 109.20StripTags . . . . . . 109.21UriNormalize . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
468 469 469 475 477 477 478 479 480 481 482 482 483 483 485 487 487 487 488 488 489 489 490 490 491 492 492 493 495 495 495 495 495 497 498
110Word Filters 110.1 CamelCaseToDash . . . . 110.2 CamelCaseToSeparator . 110.3 CamelCaseToUnderscore 110.4 DashToCamelCase . . . . 110.5 DashToSeparator . . . . . 110.6 DashToUnderscore . . . . 110.7 SeparatorToCamelCase . 110.8 SeparatorToDash . . . . . 110.9 SeparatorToSeparator . . 110.10UnderscoreToCamelCase 110.11UnderscoreToSeparator . 110.12UnderscoreToDash . . . . 111File Filter Classes 111.1 Decrypt . . . . 111.2 Encrypt . . . . 111.3 Lowercase . . 111.4 Rename . . . . 111.5 RenameUpload 111.6 Uppercase . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
112Filter Chains 499 112.1 Setting Filter Chain Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499 112.2 Using the Plugin Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499 113Zend\Filter\Inector 113.1 Operation . . . . . . . . . . . . . . . . . . . . . . . . . . 113.2 Using Custom Filters . . . . . . . . . . . . . . . . . . . . 113.3 Setting the Inector Target . . . . . . . . . . . . . . . . . 113.4 Inection Rules . . . . . . . . . . . . . . . . . . . . . . . 113.5 Utility Methods . . . . . . . . . . . . . . . . . . . . . . . 113.6 Using a Traversable or an array with Zend\Filter\Inector 114Writing Filters 115Introduction to Zend\Form 116Form Quick Start 501 501 502 502 503 505 505 507 509 511
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
xi
Programmatic Form Creation . Creation via Factory . . . . . . Factory-backed Form Extension Validating Forms . . . . . . . . Hinting to the Input Filter . . . Binding an object . . . . . . . . Rendering . . . . . . . . . . . Validation Groups . . . . . . . Using Annotations . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
511 512 516 517 518 520 521 524 525 529 532 536 537 537 539 541 545 545 548 550 551 555 557 557 557 561 563 565 565 565 567 582 597 597 597 609 613
117Form Collections 117.1 Creating Fieldsets . . . . . . . . . . . . . . 117.2 The Form Element . . . . . . . . . . . . . . 117.3 The Controller . . . . . . . . . . . . . . . . 117.4 The View . . . . . . . . . . . . . . . . . . . 117.5 Adding New Elements Dynamically . . . . . 117.6 Validation groups for eldsets and collection 118File Uploading 118.1 Standard Example . . . . . . 118.2 File Post-Redirect-Get Plugin 118.3 HTML5 Multi-File Uploads . 118.4 Upload Progress . . . . . . . 118.5 Additional Info . . . . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
119Advanced use of forms 119.1 Short names . . . . . . . . . . 119.2 Creating custom elements . . . 119.3 Handling dependencies . . . . . 119.4 The specic case of initializers . 120Form Elements 120.1 Introduction . . . . 120.2 Element Base Class 120.3 Standard Elements . 120.4 HTML5 Elements .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
121Form View Helpers 121.1 Introduction . . . . . . . . . 121.2 Standard Helpers . . . . . . . 121.3 HTML5 Helpers . . . . . . . 121.4 File Upload Progress Helpers
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
122Overview of Zend\Http 615 122.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615 122.2 Zend\Http Request, Response and Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615 123The Request Class 123.1 Overview . . . . . . . 123.2 Quick Start . . . . . . 123.3 Conguration Options 123.4 Available Methods . . 123.5 Examples . . . . . . . 124The Response Class 617 617 617 618 618 621 623
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
xii
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
623 623 624 624 626 629 629 629 630 630 632 632 633 637 637 637 638 638 642 645 645 645 647 648 649 651 655 655 655 657 658 658 659 659 660 663 663 663 663 664 665 665 666 666 666 666
125The Headers Class 125.1 Overview . . . . . . . . . . . . . . 125.2 Quick Start . . . . . . . . . . . . . 125.3 Conguration Options . . . . . . . 125.4 Available Methods . . . . . . . . . 125.5 Zend\Http\Header\* Base Methods 125.6 List of HTTP Header Types . . . . 125.7 Examples . . . . . . . . . . . . . . 126HTTP Client - Overview 126.1 Overview . . . . . . . 126.2 Quick Start . . . . . . 126.3 Conguration Options 126.4 Available Methods . . 126.5 Examples . . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
127HTTP Client - Connection Adapters 127.1 Overview . . . . . . . . . . . . . . . . 127.2 The Socket Adapter . . . . . . . . . . 127.3 The Proxy Adapter . . . . . . . . . . . 127.4 The cURL Adapter . . . . . . . . . . . 127.5 The Test Adapter . . . . . . . . . . . . 127.6 Creating your own connection adapters
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
128HTTP Client - Advanced Usage 128.1 HTTP Redirections . . . . . . . . . . . . . . . . 128.2 Adding Cookies and Using Cookie Persistence . 128.3 Setting Custom Request Headers . . . . . . . . 128.4 File Uploads . . . . . . . . . . . . . . . . . . . 128.5 Sending Raw POST Data . . . . . . . . . . . . 128.6 HTTP Authentication . . . . . . . . . . . . . . 128.7 Sending Multiple Requests With the Same Client 128.8 Data Streaming . . . . . . . . . . . . . . . . . . 129HTTP Client - Static Usage 129.1 Overview . . . . . . . 129.2 Quick Start . . . . . . 129.3 Conguration Options 129.4 Available Methods . . 130Translating 130.1 Adding translations . 130.2 Supported formats . 130.3 Setting a locale . . . 130.4 Translating messages 130.5 Caching . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
xiii
CurrencyFormat Helper . DateFormat Helper . . . . NumberFormat Helper . . Plural Helper . . . . . . . Translate Helper . . . . . TranslatePlural Helper . . Abstract Translator Helper
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
667 668 669 670 671 672 672 675 675 676 676 677 679
132I18n Filters 132.1 Alnum . . . . 132.2 Alpha . . . . . 132.3 NumberFormat 132.4 NumberParse . 133I18n Validators
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
134Float 681 134.1 Supported options for Zend\I18n\Validator\Float . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681 134.2 Simple oat validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681 134.3 Localized oat validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681 135Int 683 135.1 Supported options for Zend\I18n\Validator\Int . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683 135.2 Simple integer validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683 135.3 Localized integer validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683 136Introduction to Zend\InputFilter 137File Upload Input 138Introduction to Zend\Json 685 689 691
139Basic Usage 693 139.1 Pretty-printing JSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693 140Advanced Usage of Zend\Json 140.1 JSON Objects . . . . . . 140.2 Encoding PHP objects . . 140.3 Internal Encoder/Decoder 140.4 JSON Expressions . . . . 141XML to JSON conversion 695 695 695 696 696 697
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
142Zend\Json\Server - JSON-RPC server 699 142.1 Advanced Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701 143Introduction to Zend\Ldap 707 143.1 Theory of operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 707 144API overview 711 144.1 Conguration / options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711 144.2 API Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 712 145Zend\Ldap\Ldap 713 145.1 Zend\Ldap\Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714
xiv
151Zend\Ldap\Node\RootDse 725 151.1 OpenLDAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 727 151.2 ActiveDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 727 151.3 eDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728 152Zend\Ldap\Node\Schema 731 152.1 OpenLDAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733 152.2 ActiveDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 734 153Zend\Ldap\Ldif\Encoder 735
154Usage Scenarios 737 154.1 Authentication scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737 154.2 Basic CRUD operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737 154.3 Extended operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739 155Tools 155.1 Creation and modication of DN strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155.2 Using the lter API to create search lters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155.3 Modify LDAP entries using the Attribute API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156Object-oriented access to the LDAP tree using Zend\Ldap\Node 156.1 Basic CRUD operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156.2 Extended operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156.3 Tree traversal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741 741 741 741 743 743 743 743
157Getting information from the LDAP server 745 157.1 RootDSE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745 157.2 Schema Browsing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745 158Serializing LDAP data to and from LDIF 747 158.1 Serialize a LDAP entry to LDIF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 747 158.2 Deserialize a LDIF string into a LDAP entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748 159The AutoloaderFactory 159.1 Overview . . . . . . . 159.2 Quick Start . . . . . . 159.3 Conguration Options 159.4 Available Methods . . 159.5 Examples . . . . . . . 160The StandardAutoloader 160.1 Overview . . . . . . . 160.2 Quick Start . . . . . . 160.3 Conguration Options 160.4 Available Methods . . 751 751 751 752 752 752 753 753 754 755 755
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
xv
160.5 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756 161The ClassMapAutoloader 161.1 Overview . . . . . . . 161.2 Quick Start . . . . . . 161.3 Conguration Options 161.4 Available Methods . . 161.5 Examples . . . . . . . 162The ModuleAutoloader 162.1 Overview . . . . . . . 162.2 Quickstart . . . . . . 162.3 Conguration Options 162.4 Available Methods . . 162.5 Examples . . . . . . . 757 757 757 758 758 759 761 761 761 761 762 762 763 763 763 764 764 765 767 767 767 768 768 769 773 773 773 774 774 774 775 775 775 775 775 776
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
163The SplAutoloader Interface 163.1 Overview . . . . . . . . 163.2 Quick Start . . . . . . . 163.3 Conguration Options . 163.4 Available Methods . . . 163.5 Examples . . . . . . . . 164The PluginClassLoader 164.1 Overview . . . . . . . 164.2 Quick Start . . . . . . 164.3 Conguration Options 164.4 Available Methods . . 164.5 Examples . . . . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
165The ShortNameLocator Interface 165.1 Overview . . . . . . . . . . . 165.2 Quick Start . . . . . . . . . . 165.3 Conguration Options . . . . 165.4 Available Methods . . . . . . 165.5 Examples . . . . . . . . . . . 166The PluginClassLocator interface 166.1 Overview . . . . . . . . . . . 166.2 Quick Start . . . . . . . . . . 166.3 Conguration Options . . . . 166.4 Available Methods . . . . . . 166.5 Examples . . . . . . . . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
167The Class Map Generator utility: bin/classmap_generator.php 777 167.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 777 167.2 Quick Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 777 167.3 Conguration Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 777 168Overview of Zend\Log 168.1 Creating a Log . . . . . . 168.2 Logging Messages . . . . 168.3 Destroying a Log . . . . . 168.4 Using Built-in Priorities . 168.5 Understanding Log Events 779 779 780 780 780 781
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
xvi
168.6 Log PHP Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 781 169Writers 169.1 Writing to Streams . . . 169.2 Writing to Databases . . 169.3 Writing to FirePHP . . . 169.4 Stubbing Out the Writer 169.5 Testing with the Mock . 169.6 Compositing Writers . . 783 783 784 785 785 785 785
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
170Filters 787 170.1 Available lters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 787 171Formatters 171.1 Simple Formatting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171.2 Formatting to XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171.3 Formatting to FirePhp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 789 789 790 790
172Introduction to Zend\Mail 791 172.1 Getting started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 791 172.2 Conguring the default sendmail transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 792 173Zend\Mail\Message 173.1 Overview . . . . . . . 173.2 Quick Start . . . . . . 173.3 Conguration Options 173.4 Available Methods . . 173.5 Examples . . . . . . . 174Zend\Mail\Transport 174.1 Overview . . . . . . . 174.2 Quick Start . . . . . . 174.3 Conguration Options 174.4 Available Methods . . 174.5 Examples . . . . . . . 793 793 793 795 795 798 799 799 799 800 801 801 803 803 803 805 805 806 807 807 807 807 808 808
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
175Zend\Mail\Transport\SmtpOptions 175.1 Overview . . . . . . . . . . . . 175.2 Quick Start . . . . . . . . . . . 175.3 Conguration Options . . . . . 175.4 Available Methods . . . . . . . 175.5 Examples . . . . . . . . . . . . 176Zend\Mail\Transport\FileOptions 176.1 Overview . . . . . . . . . . . 176.2 Quick Start . . . . . . . . . . 176.3 Conguration Options . . . . 176.4 Available Methods . . . . . . 176.5 Examples . . . . . . . . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
177Introduction to Zend\Math 809 177.1 Random number generator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 809 177.2 Big integers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 810 178Zend\Mime 813 178.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813 xvii
178.2 Static Methods and Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813 178.3 Instantiating Zend\Mime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 814 179Zend\Mime\Message 179.1 Introduction . . . . . . . . . . . . . . . . . . . . . . 179.2 Instantiation . . . . . . . . . . . . . . . . . . . . . . 179.3 Adding MIME Parts . . . . . . . . . . . . . . . . . . 179.4 Boundary handling . . . . . . . . . . . . . . . . . . . 179.5 Parsing a string to create a Zend\Mime\Message object 179.6 Available methods . . . . . . . . . . . . . . . . . . . 180Zend\Mime\Part 180.1 Introduction . . . . . . . . . . . . . . . . . . . . 180.2 Instantiation . . . . . . . . . . . . . . . . . . . . 180.3 Methods for rendering the message part to a string 180.4 Available methods . . . . . . . . . . . . . . . . . 815 815 815 815 815 816 816 817 817 817 817 818
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
181Introduction to the Module System 819 181.1 The autoload_*.php Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 820 182The Module Manager 821 182.1 Module Manager Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 821 182.2 Module Manager Listeners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 821 183The Module Class 183.1 A Minimal Module . . . . . . . 183.2 A Typical Module Class . . . . 183.3 The loadModules.post Event 183.4 The MVC bootstrap Event . . 825 825 825 826 827
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
184The Module Autoloader 829 184.1 Module Autoloader Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 829 184.2 Non-Standard / Explicit Module Paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 830 184.3 Packaging Modules with Phar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 831 185Best Practices when Creating Modules 186Introduction to the MVC Layer 186.1 Basic Application Structure . . . . . 186.2 Basic Module Structure . . . . . . . 186.3 Bootstrapping an Application . . . . 186.4 Bootstrapping a Modular Application 186.5 Conclusion . . . . . . . . . . . . . . 833 835 836 836 838 840 841 843 843 844 844 845 846 846 848 849
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
187Quick Start 187.1 Install the Zend Skeleton Application . 187.2 Create a New Module . . . . . . . . . 187.3 Update the Module Class . . . . . . . . 187.4 Create a Controller . . . . . . . . . . . 187.5 Create a View Script . . . . . . . . . . 187.6 Create a Route . . . . . . . . . . . . . 187.7 Tell the Application About our Module 187.8 Test it Out! . . . . . . . . . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
ServiceManager . . . . . . . . . . Abstract Factories . . . . . . . . . Plugin Managers . . . . . . . . . . ViewManager . . . . . . . . . . . . Application Conguration Options Default Conguration Options . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
851 856 858 859 860 861 865 867 867 873 875 877 878 878 879 880 881 883 883 884
189Routing 189.1 Router Types . . . . . . . 189.2 HTTP Route Types . . . . 189.3 HTTP Routing Examples 189.4 Console Route Types . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
190The MvcEvent 190.1 Order of events . . . . . . . . . . . . . . . 190.2 MvcEvent::EVENT_BOOTSTRAP . . . . 190.3 MvcEvent::EVENT_ROUTE . . . . . . . 190.4 MvcEvent::EVENT_DISPATCH . . . . . 190.5 MvcEvent::EVENT_DISPATCH_ERROR 190.6 MvcEvent::EVENT_RENDER . . . . . . 190.7 MvcEvent::EVENT_RENDER_ERROR . 190.8 MvcEvent::EVENT_FINISH . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
191The SendResponseEvent 887 191.1 Listeners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 887 191.2 Triggerers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 888 192Available Controllers 889 192.1 Common Interfaces Used With Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 889 192.2 The AbstractActionController . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 891 192.3 The AbstractRestfulController . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892 193Controller Plugins 193.1 AcceptableViewModelSelector Plugin 193.2 FlashMessenger Plugin . . . . . . . . 193.3 Forward Plugin . . . . . . . . . . . . 193.4 Identity Plugin . . . . . . . . . . . . 193.5 Layout Plugin . . . . . . . . . . . . 193.6 Params Plugin . . . . . . . . . . . . 193.7 Post/Redirect/Get Plugin . . . . . . . 193.8 File Post/Redirect/Get Plugin . . . . 193.9 Redirect Plugin . . . . . . . . . . . . 193.10Url Plugin . . . . . . . . . . . . . . 895 895 896 898 898 899 899 900 900 902 902
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
194Examples 903 194.1 Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 903 194.2 Bootstrapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 904 195Introduction to Zend\Navigation 907 195.1 Pages and Containers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 907 195.2 View Helpers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 908 196Quick Start 197Pages 909 911
xix
198Common page features 199Zend\Navigation\Page\Mvc 200Zend\Navigation\Page\Uri 201Creating custom page types 202Creating pages using the page factory 203Containers 203.1 Creating containers 203.2 Adding pages . . . 203.3 Removing pages . 203.4 Finding pages . . . 203.5 Iterating containers 203.6 Other operations .
913 917 921 923 925 927 927 933 934 935 937 938
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
204View Helpers 941 204.1 Translation of labels and titles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 942 204.2 Integration with ACL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 942 204.3 Navigation setup used in examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 943 205View Helper - Breadcrumbs 206View Helper - Links 207View Helper - Menu 208View Helper - Sitemap 209View Helper - Navigation Proxy 210Introduction to Zend\Paginator 211Usage 211.1 Paginating data collections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211.2 The DbSelect adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211.3 Rendering pages with view scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212Conguration 213Advanced usage 213.1 Custom data source adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213.2 Custom scrolling styles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213.3 Caching features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214Introduction to Zend\Permissions\Acl 214.1 Resources . . . . . . . . . . . . . 214.2 Roles . . . . . . . . . . . . . . . 214.3 Creating the Access Control List . 214.4 Registering Roles . . . . . . . . . 214.5 Dening Access Controls . . . . 214.6 Querying an ACL . . . . . . . . 949 953 957 965 971 973 975 975 976 977 983 985 985 985 986 989 989 990 991 991 992 993
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
215.2 Removing Access Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 997 216Advanced Usage 999 216.1 Storing ACL Data for Persistence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 999 216.2 Writing Conditional ACL Rules with Assertions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 999 217Introduction to Zend\Permissions\Rbac 1001 217.1 Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1001 217.2 Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1001 217.3 Dynamic Assertions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1001 218Methods 219Examples 219.1 Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219.2 Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219.3 Dynamic Assertions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220Progress Bars 220.1 Introduction . . . 220.2 Basic Usage . . . 220.3 Persistent Progress 220.4 Standard Adapters 1003 1005 . 1005 . 1006 . 1006 1009 1009 1009 1009 1010
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
221File Upload Handlers 221.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221.2 Methods of Reporting Progress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221.3 Standard Handlers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
222Introduction to Zend\Serializer 1017 222.1 Quick Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1017 222.2 Basic conguration Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1018 222.3 Available Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1018 223Zend\Serializer\Adapter 223.1 The PhpSerialize Adapter 223.2 The IgBinary Adapter . . 223.3 The Wddx Adapter . . . . 223.4 The Json Adapter . . . . . 223.5 The PythonPickle Adapter 223.6 The PhpCode Adapter . . 224Introduction to Zend\Server 1021 1021 1021 1021 1022 1022 1023 1025
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
225Zend\Server\Reection 1027 225.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1027 225.2 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1027 226Zend\ServiceManager 1029
227Zend\ServiceManager Quick Start 1033 227.1 Using Conguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1033 227.2 Modules as Service Providers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1034 227.3 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1034
xxi
228Delegator service factories 1039 228.1 Delegator factory signature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1039 228.2 A Delegator factory use case . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1039 229Lazy Services 229.1 Use cases . . . . . 229.2 Setup . . . . . . . 229.3 Practical example . 229.4 Conguration . . . 230Session Cong 1043 1043 1043 1043 1045 1047
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
231Standard Cong 1049 231.1 Basic Conguration Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1049 232Basic Usage 1051
233Session Cong 1053 233.1 Basic Conguration Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1053 234Basic Usage 1055 234.1 Custom Conguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1055 235Session Container 1057 235.1 Basic Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1057 235.2 Setting the Default Session Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1057 236Session Manager 1059 236.1 Initializing the Session Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1059 236.2 Session Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1061 237Session Save Handlers 1063
238Cache 1065 238.1 Basic usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1065 239DbTableGateway 1067 239.1 Creating the database table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1067 239.2 Basic usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1067 240MongoDB 1069 240.1 Basic Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1069 240.2 Custom Save Handlers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1069 241Session Storage 1071
242Array Storage 1073 242.1 Basic Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1073 243Session Storage 1075 243.1 Basic Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1075 244Session Array Storage 1077 244.1 Basic Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1077 244.2 Custom Storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1077 245Session Validators xxii 1079
246Http User Agent 1081 246.1 Basic Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1081 247Remote Addr 1083 247.1 Basic Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1083 247.2 Custom Validators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1083 248Zend\Soap\Server 248.1 Zend\Soap\Server constructor . . . . . 248.2 Methods to dene Web Service API . . 248.3 Request and response objects handling 248.4 Document/Literal WSDL Handling . . 1085 1085 1086 1087 1089
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
249Zend\Soap\Client 1091 249.1 Zend\Soap\Client Constructor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1091 249.2 Performing SOAP Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1092 250WSDL Accessor 250.1 Zend\Soap\Wsdl constructor . . 250.2 addMessage() method . . . . . 250.3 addPortType() method . . . . . 250.4 addPortOperation() method . . 250.5 addBinding() method . . . . . . 250.6 addBindingOperation() method 250.7 addSoapBinding() method . . . 250.8 addSoapOperation() method . . 250.9 addService() method . . . . . . 250.10Type mapping . . . . . . . . . 250.11addDocumentation() method . . 250.12Get nalized WSDL document 251AutoDiscovery 251.1 AutoDiscovery Introduction 251.2 Class autodiscovering . . . 251.3 Functions autodiscovering . 251.4 Autodiscovering Datatypes . 251.5 WSDL Binding Styles . . . 1095 1095 1095 1096 1096 1096 1097 1097 1097 1097 1098 1099 1100 1101 1101 1102 1103 1103 1103
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
252Zend\Stdlib\Hydrator 252.1 HydratorInterface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252.2 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252.3 Available Implementations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253Zend\Stdlib\Hydrator\Filter 253.1 Filter implementations . . . . . . . . 253.2 Remove lters . . . . . . . . . . . . 253.3 Add lters . . . . . . . . . . . . . . 253.4 Use the composite for complex lters 253.5 Using the provider interface . . . . .
1105 . 1105 . 1105 . 1106 1107 1107 1108 1108 1109 1110
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
254Zend\Stdlib\Hydrator\Strategy 1113 254.1 Adding strategies to the hydrators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1113 254.2 Available implementations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1114 254.3 Writing custom strategies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1115
xxiii
255Zend\Stdlib\Hydrator\Aggregate\AggregateHydrator 1117 255.1 Installation requirements for the AggregateHydrator . . . . . . . . . . . . . . . . . . . . . . . . . . 1117 255.2 Example of AggregateHydrator usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1117 255.3 Advanced use cases of the AggregateHydrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1118 256Introduction to Zend\Tag 1121
257Creating tag clouds with Zend\Tag\Cloud 1123 257.1 Decorators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1125 258Introduction to Zend\Test 259Unit testing with PHPUnit 260Setup your TestCase 261Testing your Controllers and MVC Applications 262Assertions 263Request Assertions 264CSS Selector Assertions 265XPath Assertions 266Redirect Assertions 267Response Header Assertions 268Zend\Text\Figlet 269Zend\Text\Table 270Zend\Uri 270.1 Overview . . . . . . . . . . . 270.2 Creating a New URI . . . . . 270.3 Manipulating an Existing URI 270.4 Common Instance Methods . 271Introduction to Zend\Validator 271.1 What is a validator? . . . 271.2 Basic usage of validators . 271.3 Customizing messages . . 271.4 Translating messages . . . 272Standard Validation Classes 273Alnum 273.1 Supported options for ZendI18nValidatorAlnum 273.2 Basic usage . . . . . . . . . . . . . . . . . . . . 273.3 Using whitespaces . . . . . . . . . . . . . . . . 273.4 Using different languages . . . . . . . . . . . . 1129 1131 1133 1135 1137 1139 1141 1143 1145 1147 1149 1151 1153 1153 1153 1154 1154 1159 1159 1159 1160 1161 1163 1165 1165 1165 1165 1166
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
274Alpha 1167 274.1 Supported options for Zend\Validator\Alpha . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1167 274.2 Basic usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1167
xxiv
274.3 Using whitespaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1167 274.4 Using different languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1168 275Barcode 275.1 Supported options for Zend\Validator\Barcode 275.2 Basic usage . . . . . . . . . . . . . . . . . . . 275.3 Optional checksum . . . . . . . . . . . . . . . 275.4 Writing custom adapters . . . . . . . . . . . . 1169 1171 1172 1172 1172
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
276Between 1175 276.1 Supported options for Zend\Validator\Between . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1175 276.2 Default behaviour for Zend\Validator\Between . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1175 276.3 Validation exclusive the border values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1175 277Callback 277.1 Supported options for Zend\Validator\Callback 277.2 Basic usage . . . . . . . . . . . . . . . . . . . 277.3 Usage with closures . . . . . . . . . . . . . . 277.4 Usage with class-based callbacks . . . . . . . 277.5 Adding options . . . . . . . . . . . . . . . . . 1177 1177 1177 1177 1178 1179 1181 1182 1182 1182 1183 1184 1185 1185 1185 1185 1186 1187 1187 1187 1188 1189 1190
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
278CreditCard 278.1 Supported options for Zend\Validator\CreditCard 278.2 Basic usage . . . . . . . . . . . . . . . . . . . . 278.3 Accepting dened credit cards . . . . . . . . . . 278.4 Validation by using foreign APIs . . . . . . . . 278.5 Ccnum . . . . . . . . . . . . . . . . . . . . . . 279Date 279.1 279.2 279.3 279.4
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
Supported options for Zend\Validator\Date Default date validation . . . . . . . . . . . Localized date validation . . . . . . . . . . Self dened date validation . . . . . . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
280Db\RecordExists and Db\NoRecordExists 280.1 Supported options for Zend\Validator\Db\* 280.2 Basic usage . . . . . . . . . . . . . . . . . 280.3 Excluding records . . . . . . . . . . . . . 280.4 Database Schemas . . . . . . . . . . . . . 280.5 Using a Select object . . . . . . . . . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
281Digits 1191 281.1 Supported options for Zend\Validator\Digits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1191 281.2 Validating digits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1191 282EmailAddress 282.1 Basic usage . . . . . . . . . . . . . . . . . . . . 282.2 Options for validating Email Addresses . . . . . 282.3 Complex local parts . . . . . . . . . . . . . . . 282.4 Validating only the local part . . . . . . . . . . . 282.5 Validating different types of hostnames . . . . . 282.6 Checking if the hostname actually accepts email 282.7 Validating International Domains Names . . . . 282.8 Validating Top Level Domains . . . . . . . . . . 282.9 Setting messages . . . . . . . . . . . . . . . . . 1193 1193 1193 1194 1194 1194 1194 1195 1196 1196
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
xxv
283GreaterThan 1197 283.1 Supported options for Zend\Validator\GreaterThan . . . . . . . . . . . . . . . . . . . . . . . . . . . 1197 283.2 Basic usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1197 283.3 Validation inclusive the border value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1197 284Hex 284.1 Supported options for Zend\Validator\Hex 1199 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1199 1201 1201 1201 1202 1202 1203
285Hostname 285.1 Supported options for Zend\Validator\Hostname 285.2 Basic usage . . . . . . . . . . . . . . . . . . . . 285.3 Validating different types of hostnames . . . . . 285.4 Validating International Domains Names . . . . 285.5 Validating Top Level Domains . . . . . . . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
286Iban 1205 286.1 Supported options for Zend\Validator\Iban . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1205 286.2 IBAN validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1205 287Identical 287.1 Supported options for Zend\Validator\Identical 287.2 Basic usage . . . . . . . . . . . . . . . . . . . 287.3 Identical objects . . . . . . . . . . . . . . . . 287.4 Form elements . . . . . . . . . . . . . . . . . 287.5 Strict validation . . . . . . . . . . . . . . . . . 287.6 Conguration . . . . . . . . . . . . . . . . . . 288InArray 288.1 Supported options for Zend\Validator\InArray 288.2 Simple array validation . . . . . . . . . . . . . 288.3 Array validation modes . . . . . . . . . . . . 288.4 Recursive array validation . . . . . . . . . . . 1207 1207 1207 1207 1208 1210 1210 1213 1213 1214 1214 1215
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
289Ip 1217 289.1 Supported options for Zend\Validator\Ip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1217 289.2 Basic usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1217 289.3 Validate IPv4 or IPV6 alone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1218 290Isbn 290.1 290.2 290.3 290.4 1219 1219 1219 1219 1220
Supported options for Zend\Validator\Isbn Basic usage . . . . . . . . . . . . . . . . . Setting an explicit ISBN validation type . . Specifying a separator restriction . . . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
291LessThan 291.1 Supported options for Zend\Validator\LessThan . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291.2 Basic usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291.3 Validation inclusive the border value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
292NotEmpty 1223 292.1 Supported options for Zend\Validator\NotEmpty . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1223 292.2 Default behaviour for Zend\Validator\NotEmpty . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1223 292.3 Changing behaviour for Zend\Validator\NotEmpty . . . . . . . . . . . . . . . . . . . . . . . . . . . 1223 293PostCode 1225 293.1 Constructor options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1226 xxvi
293.2 Supported options for Zend\Validator\PostCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1226 294Regex 1227 294.1 Supported options for Zend\Validator\Regex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1227 294.2 Validation with Zend\Validator\Regex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1227 294.3 Pattern handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1227 295Sitemap Validators 295.1 Sitemap\Changefreq . . . . . . . . . . . . . . . 295.2 Sitemap\Lastmod . . . . . . . . . . . . . . . . . 295.3 Sitemap\Loc . . . . . . . . . . . . . . . . . . . 295.4 Sitemap\Priority . . . . . . . . . . . . . . . . . 295.5 Supported options for Zend\Validator\Sitemap_* 1229 1229 1229 1230 1230 1230
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
296Step 296.1 Supported options for Zend\Validator\Step . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296.2 Basic usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296.3 Using oating-point values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297StringLength 297.1 Supported options for Zend\Validator\StringLength 297.2 Default behaviour for Zend\Validator\StringLength 297.3 Limiting the maximum allowed length of a string . 297.4 Limiting the minimal required length of a string . 297.5 Limiting a string on both sides . . . . . . . . . . . 297.6 Encoding of values . . . . . . . . . . . . . . . . . 298File Validation Classes 298.1 Crc32 . . . . . . . 298.2 ExcludeExtension 298.3 ExcludeMimeType 298.4 Exists . . . . . . . 298.5 Extension . . . . . 298.6 Hash . . . . . . . 298.7 ImageSize . . . . 298.8 IsCompressed . . 298.9 IsImage . . . . . . 298.10Md5 . . . . . . . . 298.11MimeType . . . . 298.12NotExists . . . . . 298.13Sha1 . . . . . . . 298.14Size . . . . . . . . 298.15UploadFile . . . . 298.16WordCount . . . . 299Validator Chains 300Writing Validators
1231 . 1231 . 1231 . 1231 1233 1233 1233 1233 1234 1234 1234 1237 1237 1238 1238 1238 1239 1240 1240 1241 1242 1242 1243 1244 1245 1246 1246 1247 1249 1251
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
301Validation Messages 1255 301.1 Using pre-translated validation messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1255 301.2 Limit the size of a validation message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1256 302Getting the Zend Framework Version 303Zend\View Quick Start 1257 1259 xxvii
304Overview 305Usage 305.1 Conguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305.2 Controllers and View Models . . . . . . . . . . . . . . . . . . . . . . 305.3 Nesting View Models . . . . . . . . . . . . . . . . . . . . . . . . . . 305.4 Dealing with Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . 305.5 Creating and Registering Alternate Rendering and Response Strategies
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
306The PhpRenderer 306.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306.2 Options and Conguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306.3 Additional Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
307PhpRenderer View Scripts 1283 307.1 Escaping Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1284 308The ViewEvent 308.1 Order of events . . . . . . . . . . . . . . . 308.2 ViewEvent::EVENT_RENDERER . . . . 308.3 ViewEvent::EVENT_RENDERER_POST 308.4 ViewEvent::EVENT_RESPONSE . . . . . 309View Helpers 310Included Helpers 311View Helper - Cycle 312View Helper - Doctype 313View Helper - Identity 314View Helper - JSON 315View Helper - Partial 1285 1285 1286 1287 1287 1289 1291 1293 1295 1299 1301 1303
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
316View Helper - Placeholder 1307 316.1 Concrete Placeholder Implementations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1309 317View Helper - URL 1311
318Advanced usage of helpers 1313 318.1 Registering Helpers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1313 318.2 Writing Custom Helpers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1314 318.3 Registering Concrete Helpers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1316 319Introduction to Zend\XmlRpc 1317 319.1 Quick Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1317 320Zend\XmlRpc\Client 320.1 Introduction . . . . . 320.2 Method Calls . . . . . 320.3 Types and Conversions 320.4 Server Proxy Object . 320.5 Error Handling . . . . 320.6 Server Introspection . xxviii 1319 1319 1319 1320 1322 1322 1323
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
320.7 From Request to Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1324 320.8 HTTP Client and Testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1324 321Zend\XmlRpc\Server 321.1 Introduction . . . . . . . . . . . . . . . . . . 321.2 Basic Usage . . . . . . . . . . . . . . . . . . 321.3 Server Structure . . . . . . . . . . . . . . . . 321.4 Anatomy of a webservice . . . . . . . . . . . 321.5 Conventions . . . . . . . . . . . . . . . . . . 321.6 Utilizing Namespaces . . . . . . . . . . . . . 321.7 Custom Request Objects . . . . . . . . . . . . 321.8 Custom Responses . . . . . . . . . . . . . . . 321.9 Handling Exceptions via Faults . . . . . . . . 321.10Caching Server Denitions Between Requests 321.11Usage Examples . . . . . . . . . . . . . . . . 321.12Performance optimization . . . . . . . . . . . 322ZendServiceAkismet 322.1 Introduction . . . . . . . . . . 322.2 Verify an API key . . . . . . . 322.3 Check for spam . . . . . . . . . 322.4 Submitting known spam . . . . 322.5 Submitting false positives (ham) 322.6 Zend-specic Methods . . . . . 1327 1327 1327 1327 1328 1328 1329 1329 1330 1330 1330 1331 1335 1337 1337 1337 1338 1338 1339 1339 1341 1341 1342 1342 1343 1343 1344
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
323ZendServiceAmazon 323.1 Introduction . . . . . . . . . . . . . . . . . . 323.2 Country Codes . . . . . . . . . . . . . . . . . 323.3 Looking up a Specic Amazon Item by ASIN . 323.4 Performing Amazon Item Searches . . . . . . 323.5 Using the Alternative Query API . . . . . . . 323.6 ZendServiceAmazon Classes . . . . . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
324ZendService\Apple\Apns 324.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324.2 Quick Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324.3 Feedback Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325ZendServiceAudioscrobbler 325.1 Introduction . . . . . 325.2 Users . . . . . . . . . 325.3 Artists . . . . . . . . 325.4 Tracks . . . . . . . . 325.5 Tags . . . . . . . . . . 325.6 Groups . . . . . . . . 325.7 Forums . . . . . . . .
1349 . 1349 . 1349 . 1351 1353 1353 1353 1355 1356 1356 1356 1357 1359 1359 1359 1360 1361 1362 1362 1362
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
326ZendServiceDelicious 326.1 Introduction . . . . . . . . . 326.2 Retrieving posts . . . . . . . 326.3 ZendServiceDeliciousPostList 326.4 Editing posts . . . . . . . . . 326.5 Deleting posts . . . . . . . . 326.6 Adding new posts . . . . . . 326.7 Tags . . . . . . . . . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
xxix
326.8 Bundles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1363 326.9 Public data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1363 326.10HTTP client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1364 327Zend_Service_DeveloperGarden 327.1 Introduction to DeveloperGarden 327.2 BaseUserService . . . . . . . . . 327.3 IP Location . . . . . . . . . . . . 327.4 Local Search . . . . . . . . . . . 327.5 Send SMS . . . . . . . . . . . . 327.6 SMS Validation . . . . . . . . . . 327.7 Voice Call . . . . . . . . . . . . 327.8 ConferenceCall . . . . . . . . . . 327.9 Performance and Caching . . . . 1365 1365 1366 1367 1368 1368 1369 1369 1370 1372 1373 1373 1373 1374 1374 1375
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
328ZendServiceFlickr 328.1 Introduction . . . . . . . . . . . . . . . . . 328.2 Finding Flickr Users Photos and Information 328.3 Finding photos From a Group Pool . . . . . 328.4 Retrieving Flickr Image Details . . . . . . . 328.5 ZendServiceFlickr Result Classes . . . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
329ZendService\LiveDocx 1377 329.1 Introduction to LiveDocx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1377 329.2 ZendService\LiveDocx\MailMerge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1379 330ZendServiceNirvanix 330.1 Introduction . . . . . . . 330.2 Registering with Nirvanix 330.3 API Documentation . . . 330.4 Features . . . . . . . . . . 330.5 Getting Started . . . . . . 330.6 Understanding the Proxy . 330.7 Examining Results . . . . 330.8 Handling Errors . . . . . 1397 1397 1397 1397 1397 1398 1398 1399 1400 1401 1401 1401 1401 1402 1402
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
331Zend\Service\Rackspace 331.1 Introduction . . . . . . . . 331.2 Registering with Rackspace 331.3 Cloud Files . . . . . . . . . 331.4 Cloud Servers . . . . . . . 331.5 Available Methods . . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
332ZendServiceReCaptcha 1405 332.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1405 332.2 Simplest use . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1405 332.3 Hiding email addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1406 333ZendServiceSlideShare 333.1 Getting Started with ZendServiceSlideShare 333.2 The SlideShow object . . . . . . . . . . . . 333.3 Retrieving a single slide show . . . . . . . . 333.4 Retrieving Groups of Slide Shows . . . . . . 333.5 ZendServiceSlideShare Caching policies . . 333.6 Changing the behavior of the HTTP Client . 1409 1409 1409 1412 1412 1413 1413
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
xxx
334ZendServiceStrikeIron 334.1 Overview . . . . . . . . . . 334.2 Registering with StrikeIron 334.3 Getting Started . . . . . . . 334.4 Making Your First Query . . 334.5 Examining Results . . . . . 334.6 Handling Errors . . . . . . 334.7 Checking Your Subscription
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
. . . . . . .
1415 1415 1416 1416 1416 1417 1418 1418 1421 1421 1421 1421 1422 1424 1424 1425 1428 1433 1433 1433 1435 1436 1436 1437 1437 1438 1439 1440 1440 1442 1445 1445 1445 1445 1445 1446 1447 1447 1449 1449 1450
335ZendServiceTechnorati 335.1 Introduction . . . . . . . . . . . . . 335.2 Getting Started . . . . . . . . . . . . 335.3 Making Your First Query . . . . . . . 335.4 Consuming Results . . . . . . . . . . 335.5 Handling Errors . . . . . . . . . . . 335.6 Checking Your API Key Daily Usage 335.7 Available Technorati Queries . . . . 335.8 ZendServiceTechnorati Classes . . . 336ZendServiceTwitter 336.1 Introduction . . . . . . 336.2 Quick Start . . . . . . . 336.3 Authentication . . . . . 336.4 Account Methods . . . . 336.5 Application Methods . . 336.6 Blocking Methods . . . 336.7 Direct Message Methods 336.8 Favorites Methods . . . 336.9 Friendship Methods . . 336.10Search Methods . . . . 336.11Status Methods . . . . . 336.12User Methods . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
. . . . . . . . . . . .
337ZendServiceWindowsAzure 337.1 Introduction . . . . . . . . . . . . 337.2 Installing the Windows Azure SDK 337.3 API Documentation . . . . . . . . 337.4 Features . . . . . . . . . . . . . . . 337.5 Architecture . . . . . . . . . . . . 338ZendServiceWindowsAzureStorageBlob 338.1 API Examples . . . . . . . . . . . 338.2 Root container . . . . . . . . . . . 338.3 Blob storage stream wrapper . . . . 338.4 Shared Access Signature . . . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
339ZendServiceWindowsAzureStorageTable 339.1 Operations on tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339.2 Operations on entities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339.3 Table storage session handler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
xxxi
342Introduction to Zend Framework 2 343User Guide 344Zend Framework Tool (ZFTool) 345Learning Zend Framework 2 346Migration 347Zend Framework 2 Reference 347.1 Zend\Authentication . . . 347.2 Zend\Barcode . . . . . . 347.3 Zend\Cache . . . . . . . . 347.4 Zend\Captcha . . . . . . . 347.5 Zend\Cong . . . . . . . 347.6 Zend\Console . . . . . . . 347.7 Zend\Crypt . . . . . . . . 347.8 Zend\Db . . . . . . . . . 347.9 Zend\Di . . . . . . . . . . 347.10Zend\Dom . . . . . . . . 347.11Zend\Escaper . . . . . . . 347.12Zend\EventManager . . . 347.13Zend\Feed . . . . . . . . 347.14Zend\File . . . . . . . . . 347.15Zend\Filter . . . . . . . . 347.16Zend\Form . . . . . . . . 347.17Zend\Http . . . . . . . . . 347.18Zend\I18n . . . . . . . . 347.19Zend\InputFilter . . . . . 347.20Zend\Json . . . . . . . . . 347.21Zend\Ldap . . . . . . . . 347.22Zend\Loader . . . . . . . 347.23Zend\Log . . . . . . . . . 347.24Zend\Mail . . . . . . . . 347.25Zend\Math . . . . . . . . 347.26Zend\Mime . . . . . . . . 347.27Zend\ModuleManager . . 347.28Zend\Mvc . . . . . . . . 347.29Zend\Navigation . . . . . 347.30Zend\Paginator . . . . . . 347.31Zend\Permissions\Acl . . 347.32Zend\Permissions\Rbac . 347.33Zend\ProgressBar . . . . 347.34Zend\Serializer . . . . . . 347.35Zend\Server . . . . . . . 347.36Zend\ServiceManager . . 347.37Zend\Session . . . . . . . 347.38Zend\Soap . . . . . . . . 347.39Zend\Stdlib . . . . . . . . 347.40Zend\Tag . . . . . . . . . 347.41Zend\Test . . . . . . . . . 347.42Zend\Text . . . . . . . . . 347.43Zend\Uri . . . . . . . . . 347.44Zend\Validator . . . . . . xxxii
1469 1471 1473 1475 1477 1479 1479 1479 1479 1480 1480 1480 1480 1481 1481 1481 1481 1482 1482 1482 1482 1482 1483 1483 1483 1483 1484 1484 1484 1484 1485 1485 1485 1485 1485 1486 1486 1486 1486 1486 1487 1487 1487 1487 1487 1488 1488 1488 1488 1488
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
347.45Zend\Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1488 347.46Zend\View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1488 347.47Zend\XmlRpc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1489 348Services for Zend Framework 2 Reference 348.1 ZendService\Akismet . . . . . . . . . 348.2 ZendService\Amazon . . . . . . . . . 348.3 ZendService\AppleApns . . . . . . . . 348.4 ZendService\Audioscrobbler . . . . . . 348.5 ZendService\Del.icio.us . . . . . . . . 348.6 ZendService\Developer Garden . . . . 348.7 ZendService\Flickr . . . . . . . . . . . 348.8 ZendService\Google\Gcm . . . . . . . 348.9 ZendService\LiveDocx . . . . . . . . . 348.10ZendService\Nirvanix . . . . . . . . . 348.11ZendService\Rackspace . . . . . . . . 348.12ZendService\ReCaptcha . . . . . . . . 348.13ZendService\SlideShare . . . . . . . . 348.14ZendService\StrikeIron . . . . . . . . . 348.15ZendService\Technorati . . . . . . . . 348.16ZendService\Twitter . . . . . . . . . . 348.17ZendService\Windows Azure . . . . . 349Copyright 350Indices and tables 1491 1491 1491 1491 1491 1491 1491 1492 1492 1492 1492 1492 1492 1492 1492 1492 1492 1493 1495 1497
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
xxxiii
xxxiv
CHAPTER 1
Overview
Zend Framework 2 is an open source framework for developing web applications and services using PHP 5.3+. Zend Framework 2 uses 100% object-oriented code and utilises most of the new features of PHP 5.3, namely namespaces, late static binding, lambda functions and closures. Zend Framework 2 evolved from Zend Framework 1, a successful PHP framework with over 15 million downloads. Note: ZF2 is not backward compatible with ZF1, because of the new features in PHP 5.3+ implemented by the framework, and due to major rewrites of many components. The component structure of Zend Framework 2 is unique; each component is designed with few dependencies on other components. ZF2 follows the SOLID object-oriented design principle. This loosely coupled architecture allows developers to use whichever components they want. We call this a use-at-will design. We support Pyrus and Composer as installation and dependency tracking mechanisms for the framework as a whole and for each component, further enhancing this design. We use PHPUnit to test our code and Travis CI as a Continuous Integration service. While they can be used separately, Zend Framework 2 components in the standard library form a powerful and extensible web application framework when combined. Also, it offers a robust, high performance MVC implementation, a database abstraction that is simple to use, and a forms component that implements HTML5 form rendering, validation, and ltering so that developers can consolidate all of these operations using one easy-to-use, object oriented interface. Other components, such as Zend\Authentication and Zend\Permissions\Acl, provide user authentication and authorization against all common credential stores. Still others, with the ZendService namespace, implement client libraries to simply access the most popular web services available. Whatever your application needs are, youre likely to nd a Zend Framework 2 component that can be used to dramatically reduce development time with a thoroughly tested foundation. The principal sponsor of the project Zend Framework 2 is Zend Technologies, but many companies have contributed components or signicant features to the framework. Companies such as Google, Microsoft, and StrikeIron have partnered with Zend to provide interfaces to web services and other technologies they wish to make available to Zend Framework 2 developers. Zend Framework 2 could not deliver and support all of these features without the help of the vibrant Zend Framework 2 community. Community members, including contributors, make themselves available on mailing lists, IRC channels and other forums. Whatever question you have about Zend Framework 2, the community is always available to address it.
Chapter 1. Overview
CHAPTER 2
Installation
New to Zend Framework? Download the latest stable release. Available in .zip and .tar.gz formats. Brave, cutting edge? Download Zend Frameworks Git repository using a Git client. Zend Framework is open source software, and the Git repository used for its development is publicly available on GitHub. Consider using Git to get Zend Framework if you want to contribute back to the framework, or need to upgrade your framework version more often than releases occur. Once you have a copy of Zend Framework available, your application needs to be able to access the framework classes found in the library folder. There are several ways to achieve this. Failing to nd a Zend Framework 2 installation, the following error occurs:
Fatal error: Uncaught exception RuntimeException with message Unable to load ZF2. Run php composer.phar install or define a ZF2_PATH environment variable.
To x that, you can add the Zend Frameworks library path to the PHP include_path. Also, you should set an environment path named ZF2_PATH in httpd.conf (or equivalent). i.e. SetEnv ZF2_PATH /var/ZF2 running Linux. Rob Allen has kindly provided the community with an introductory tutorial, Getting Started with Zend Framework 2. Other Zend Framework community members are actively working on expanding the tutorial.
Chapter 2. Installation
CHAPTER 3
This tutorial is intended to give an introduction to using Zend Framework 2 by creating a simple database driven application using the Model-View-Controller paradigm. By the end you will have a working ZF2 application and you can then poke around the code to nd out more about how it all works and ts together.
to
AllowOverride FileInfo
in your httpd.conf le. Check with your distributions documentation for exact details. You will not be able to navigate to any page other than the home page in this tutorial if you have not congured mod_rewrite and .htaccess usage correctly.
We will also need to store our data into a database. We will only need one table with these elds in it: Field name id artist title Type integer varchar(100) varchar(100) Null? No No No Notes Primary key, auto-increment
CHAPTER 4
In order to build our application, we will start with the ZendSkeletonApplication available on github. Use Composer (http://getcomposer.org) to create a new project from scratch with Zend Framework:
Note: Another way to install the ZendSkeletonApplication is to use github. Go to https://github.com/zendframework/ZendSkeletonApplication and click the Zip button. This will download a le with a name like ZendSkeletonApplication-master.zip or similar. Unzip this le into the directory where you keep all your vhosts and rename the resultant directory to zf2-tutorial. ZendSkeletonApplication is set up to use Composer (http://getcomposer.org) to resolve its dependencies. In this case, the dependency is Zend Framework 2 itself. To install Zend Framework 2 into our application we simply type:
php composer.phar self-update php composer.phar install
from the zf2-tutorial folder. This takes a while. You should see an output like:
Installing dependencies from lock file - Installing zendframework/zendframework (dev-master) Cloning 18c8e223f070deb07c17543ed938b54542aa0ed8 Generating autoload files
then your connection was too slow to download the entire package in time, and composer timed out. To avoid this, instead of running:
php composer.phar install
run instead: 7
Make sure that you update your /etc/hosts or c:\windows\system32\drivers\etc\hosts le so that zf2-tutorial.localhost is mapped to 127.0.0.1. The website can then be accessed using http://zf2tutorial.localhost.
127.0.0.1 zf2-tutorial.localhost localhost
Restart your web server. If youve done it right, you should see something like this:
To test that your .htaccess le is working, navigate to http://zf2-tutorial.localhost/1234 and you should see this:
If you see a standard Apache 404 error, then you need to x .htaccess usage before continuing. If youre are using IIS with the URL Rewrite Module, import the following:
RewriteCond %{REQUEST_FILENAME} !-f RewriteRule ^.*$ index.php [NC,L]
You now have a working skeleton application and we can start adding the specics for our application.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
<?php /** * Display all errors when APPLICATION_ENV is development. */ if ($_SERVER[APPLICATION_ENV] == development) { error_reporting(E_ALL); ini_set("display_errors", 1); } /** * This makes our life easier when dealing with paths. Everything is relative * to the application root now. */ chdir(dirname(__DIR__)); // Setup autoloading require init_autoloader.php; // Run the application! Zend\Mvc\Application::init(require config/application.config.php)->run();
10
CHAPTER 5
Modules
Zend Framework 2 uses a module system and you organise your main application-specic code within each module. The Application module provided by the skeleton is used to provide bootstrapping, error and routing conguration to the whole application. It is usually used to provide application level controllers for, say, the home page of an application, but we are not going to use the default one provided in this tutorial as we want our album list to be the home page, which will live in our own module. We are going to put all our code into the Album module which will contain our controllers, models, forms and views, along with conguration. Well also tweak the Application module as required. Lets start with the directories required.
As you can see the Album module has separate directories for the different types of les we will have. The PHP les that contain classes within the Album namespace live in the src/Album directory so that we can have multiple namespaces within our module should we require it. The view directory also has a sub-folder called album for our modules view scripts. In order to load and congure a module, Zend Framework 2 has a ModuleManager. This will look for Module.php in the root of the module directory (module/Album) and expect to nd a class called Album\Module within it. That is, the classes within a given module will have the namespace of the modules name, which is the directory name of the module.
11
module:
Create
le
called
Module.php
under
class Module { public function getAutoloaderConfig() { return array( Zend\Loader\ClassMapAutoloader => array( __DIR__ . /autoload_classmap.php, ), Zend\Loader\StandardAutoloader => array( namespaces => array( __NAMESPACE__ => __DIR__ . /src/ . __NAMESPACE__, ), ), ); } public function getConfig() { return include __DIR__ . /config/module.config.php; } }
The ModuleManager will call getAutoloaderConfig() and getConfig() automatically for us.
As this is an empty array, whenever the autoloader looks for a class within the Album namespace, it will fall back to the to StandardAutoloader for us. Note: If you are using Composer, you could instead just create an empty getAutoloaderConfig() { } and add to composer.json:
"autoload": { "psr-0": { "Album": "module/Album/src/" } },
If you go this way, then you need to run php composer.phar update to update the composer autoloading les.
12
Chapter 5. Modules
5.2 Conguration
Having registered the autoloader, lets have a quick look at the getConfig() method in Album\Module. This method simply loads the config/module.config.php le. Create a le called module.config.php under zf2-tutorial/module/Album/config:
<?php return array( controllers => array( invokables => array( Album\Controller\Album => Album\Controller\AlbumController, ), ), view_manager => array( template_path_stack => array( album => __DIR__ . /../view, ), ), );
The cong information is passed to the relevant components by the ServiceManager. We need two initial sections: controllers and view_manager. The controllers section provides a list of all the controllers provided by the module. We will need one controller, AlbumController, which well reference as Album\Controller\Album. The controller key must be unique across all modules, so we prex it with our module name. Within the view_manager section, we add our view directory to the TemplatePathStack conguration. This will allow it to nd the view scripts for the Album module that are stored in our view/ directory.
As you can see, we have added our Album module into the list of modules after the Application module.
5.2. Conguration
13
We have now set up the module ready for putting our custom code into it.
14
Chapter 5. Modules
CHAPTER 6
We will build a very simple inventory system to display our album collection. The home page will list our collection and allow us to add, edit and delete albums. Hence the following pages are required: Page Home Add new album Edit album Delete album Description This will display the list of albums and provide links to edit and delete them. Also, a link to enable adding new albums will be provided. This page will provide a form for adding a new album. This page will provide a form for editing an album. This page will conrm that we want to delete an album and then delete it.
Before we set up our les, its important to understand how the framework expects the pages to be organised. Each page of the application is known as an action and actions are grouped into controllers within modules. Hence, you would generally group related actions into a controller; for instance, a news controller might have actions of current, archived and view. As we have four pages that all apply to albums, we will group them in a single controller AlbumController within our Album module as four actions. The four actions will be: Page Home Add new album Edit album Delete album Controller AlbumController AlbumController AlbumController AlbumController Action index add edit delete
The mapping of a URL to a particular action is done using routes that are dened in the modules module.config.php le. We will add a route for our album actions. This is the updated module cong le with the new code highlighted.
<?php return array( controllers => array( invokables => array( Album\Controller\Album => Album\Controller\AlbumController, ), ), // The following section is new and should be added to your file router => array(
15
routes => array( album => array( type => segment, options => array( route => /album[/][:action][/:id], constraints => array( action => [a-zA-Z][a-zA-Z0-9_-]*, id => [0-9]+, ), defaults => array( controller => Album\Controller\Album, action => index, ), ), ), ), ), view_manager => array( template_path_stack => array( album => __DIR__ . /../view, ), ), );
The name of the route is album and has a type of segment. The segment route allows us to specify placeholders in the URL pattern (route) that will be mapped to named parameters in the matched route. In this case, the route is /album[/:action][/:id] which will match any URL that starts with /album. The next segment will be an optional action name, and then nally the next segment will be mapped to an optional id. The square brackets indicate that a segment is optional. The constraints section allows us to ensure that the characters within a segment are as expected, so we have limited actions to starting with a letter and then subsequent characters only being alphanumeric, underscore or hyphen. We also limit the id to a number. This route allows us to have the following URLs: URL /album /album/add /album/edit/2 /album/delete/4 Page Home (list of albums) Add new album Edit album with an id of 2 Delete album with an id of 4 Action index add edit delete
16
CHAPTER 7
We are now ready to set up our controller. In Zend Framework 2, the controller is a class that is generally called {Controller name}Controller. Note that {Controller name} must start with a capital letter. This class lives in a le called {Controller name}Controller.php within the Controller directory for the module. In our case that is module/Album/src/Album/Controller. Each action is a public method within the controller class that is named {action name}Action. In this case {action name} should start with a lower case letter. Note: This is by convention. Zend Framework 2 doesnt provide many restrictions on controllers other than that they must implement the Zend\Stdlib\Dispatchable interface. The framework provides two abstract classes that do this for us: Zend\Mvc\Controller\AbstractActionController and Zend\Mvc\Controller\AbstractRestfulController. Well be using the standard AbstractActionController, but if youre intending to write a RESTful web service, AbstractRestfulController may be useful. Lets go ahead and create our controller class zf2-tutorials/module/Album/src/Album/Controller :
<?php namespace Album\Controller; use Zend\Mvc\Controller\AbstractActionController; use Zend\View\Model\ViewModel; class AlbumController extends AbstractActionController { public function indexAction() { } public function addAction() { } public function editAction() { } public function deleteAction()
AlbumController.php
at
17
{ } }
Note: We have already informed the module about our controller in the controller section of module/Album/config/module.config.php. We have now set up the four actions that we want to use. They wont work yet until we set up the views. The URLs for each action are: URL http://zf2-tutorial.localhost/album http://zf2-tutorial.localhost/album/add http://zf2-tutorial.localhost/album/edit http://zf2-tutorial.localhost/album/delete Method called Album\Controller\AlbumController::indexAction Album\Controller\AlbumController::addAction Album\Controller\AlbumController::editAction Album\Controller\AlbumController::deleteAction
We now have a working router and the actions are set up for each page of our application. Its time to build the view and the model layer.
18
CHAPTER 8
(The test data chosen happens to be the Bestsellers on Amazon UK at the time of writing!) We now have some data in a database and can write a very simple model for it.
that load and save entities to the database. Another is to use an Object-relational mapping (ORM) technology, such as Doctrine or Propel. For this tutorial, we are going to create a very simple model by creating an AlbumTable class that uses the Zend\Db\TableGateway\TableGateway class in which each album object is an Album object (known as an entity). This is an implementation of the Table Data Gateway design pattern to allow for interfacing with data in a database table. Be aware though that the Table Data Gateway pattern can become limiting in larger systems. There is also a temptation to put database access code into controller action methods as these are exposed by Zend\Db\TableGateway\AbstractTableGateway. Dont do this! Lets start by creating a le called Album.php under module/Album/src/Album/Model:
<?php namespace Album\Model; class Album { public $id; public $artist; public $title; public function exchangeArray($data) { $this->id = (!empty($data[id])) ? $data[id] : null; $this->artist = (!empty($data[artist])) ? $data[artist] : null; $this->title = (!empty($data[title])) ? $data[title] : null; } }
Our Album entity object is a simple PHP class. In order to work with Zend\Dbs TableGateway class, we need to implement the exchangeArray() method. This method simply copies the data from the passed in array to our entitys properties. We will add an input lter for use with our form later. Next, we create our AlbumTable.php le in module/Album/src/Album/Model directory like this:
<?php namespace Album\Model; use Zend\Db\TableGateway\TableGateway; class AlbumTable { protected $tableGateway; public function __construct(TableGateway $tableGateway) { $this->tableGateway = $tableGateway; } public function fetchAll() { $resultSet = $this->tableGateway->select(); return $resultSet; } public function getAlbum($id) { $id = (int) $id; $rowset = $this->tableGateway->select(array(id => $id)); $row = $rowset->current();
20
if (!$row) { throw new \Exception("Could not find row $id "); } return $row; } public function saveAlbum(Album $album) { $data = array( artist => $album->artist, title => $album->title, ); $id = (int)$album->id; if ($id == 0) { $this->tableGateway->insert($data); } else { if ($this->getAlbum($id)) { $this->tableGateway->update($data, array(id => $id)); } else { throw new \Exception(Album id does not exist); } } } public function deleteAlbum($id) { $this->tableGateway->delete(array(id => $id)); } }
Theres a lot going on here. Firstly, we set the protected property $tableGateway to the TableGateway instance passed in the constructor. We will use this to perform operations on the database table for our albums. We then create some helper methods that our application will use to interface with the table gateway. fetchAll() retrieves all albums rows from the database as a ResultSet, getAlbum() retrieves a single row as an Album object, saveAlbum() either creates a new row in the database or updates a row that already exists and deleteAlbum() removes the row completely. The code for each of these methods is, hopefully, self-explanatory.
8.3 Using ServiceManager to congure the table gateway and inject into the AlbumTable
In order to always use the same instance of our AlbumTable, we will use the ServiceManager to dene how to create one. This is most easily done in the Module class where we create a method called getServiceConfig() which is automatically called by the ModuleManager and applied to the ServiceManager. Well then be able to retrieve it in our controller when we need it. To congure the ServiceManager, we can either supply the name of the class to be instantiated or a factory (closure or callback) that instantiates the object when the ServiceManager needs it. We start by implementing getServiceConfig() to provide a factory that creates an AlbumTable. Add this method to the bottom of the Module.php le in module/Album.
<?php namespace Album;
8.3. Using ServiceManager to congure the table gateway and inject into the AlbumTable
21
// Add these import statements: use Album\Model\Album; use Album\Model\AlbumTable; use Zend\Db\ResultSet\ResultSet; use Zend\Db\TableGateway\TableGateway; class Module { // getAutoloaderConfig() and getConfig() methods here // Add this method: public function getServiceConfig() { return array( factories => array( Album\Model\AlbumTable => function($sm) { $tableGateway = $sm->get(AlbumTableGateway); $table = new AlbumTable($tableGateway); return $table; }, AlbumTableGateway => function ($sm) { $dbAdapter = $sm->get(Zend\Db\Adapter\Adapter); $resultSetPrototype = new ResultSet(); $resultSetPrototype->setArrayObjectPrototype(new Album()); return new TableGateway(album, $dbAdapter, null, $resultSetPrototype); }, ), ); } }
This method returns an array of factories that are all merged together by the ModuleManager before passing to the ServiceManager. The factory for Album\Model\AlbumTable uses the ServiceManager to create an AlbumTableGateway to pass to the AlbumTable. We also tell the ServiceManager that an AlbumTableGateway is created by getting a Zend\Db\Adapter\Adapter (also from the ServiceManager) and using it to create a TableGateway object. The TableGateway is told to use an Album object whenever it creates a new result row. The TableGateway classes use the prototype pattern for creation of result sets and entities. This means that instead of instantiating when required, the system clones a previously instantiated object. See PHP Constructor Best Practices and the Prototype Pattern for more details. Finally, we need to congure the ServiceManager so that it knows how to get a Zend\Db\Adapter\Adapter. This is done using a factory called Zend\Db\Adapter\AdapterServiceFactory which we can congure within the merged cong system. Zend Framework 2s ModuleManager merges all the conguration from each modules module.config.php le and then merges in the les in config/autoload (*.global.php and then *.local.php les). Well add our database conguration information to global.php which you should commit to your version control system. You can use local.php (outside of the VCS) to store the credentials for your database if you want to. Modify config/autoload/global.php (in the Zend Skeleton root, not inside the Album module) with following code:
<?php return array( db => array( driver => Pdo, dsn => mysql:dbname=zf2tutorial;host=localhost, driver_options => array( PDO::MYSQL_ATTR_INIT_COMMAND => SET NAMES \UTF8\ ), ),
22
You should put your database credentials in config/autoload/local.php so that they are not in the git repository (as local.php is ignored):
<?php return array( db => array( username => YOUR USERNAME HERE, password => YOUR PASSWORD HERE, ), );
to the top of the class. We can now call getAlbumTable() from within our controller whenever we need to interact with our model. If the service locator was congured correctly in Module.php, then we should get an instance of Album\Model\AlbumTable when calling getAlbumTable().
23
With Zend Framework 2, in order to set variables in the view, we return a ViewModel instance where the rst parameter of the constructor is an array from the action containing data we need. These are then automatically passed to the view script. The ViewModel object also allows us to change the view script that is used, but the default is to use {controller name}/{action name}. We can now ll in the index.phtml view script:
<?php // module/Album/view/album/album/index.phtml: $title = My albums; $this->headTitle($title); ?> <h1><?php echo $this->escapeHtml($title); ?></h1> <p> <a href="<?php echo $this->url(album, array(action=>add));?>">Add new album</a> </p> <table class="table"> <tr> <th>Title</th> <th>Artist</th> <th> </th> </tr> <?php foreach ($albums as $album) : ?> <tr> <td><?php echo $this->escapeHtml($album->title);?></td> <td><?php echo $this->escapeHtml($album->artist);?></td> <td> <a href="<?php echo $this->url(album, array(action=>edit, id => $album->id));?>">Edit</a> <a href="<?php echo $this->url(album, array(action=>delete, id => $album->id));?>">Delete</a> </td> </tr> <?php endforeach; ?> </table>
The rst thing we do is to set the title for the page (used in the layout) and also set the title for the <head> section using the headTitle() view helper which will display in the browsers title bar. We then create a link to add a new album. The url() view helper is provided by Zend Framework 2 and is used to create the links we need. The rst parameter to url() is the route name we wish to use for construction of the URL, and the second parameter is an array of all the variables to t into the placeholders to use. In this case we use our album route which is set up to accept two placeholder variables: action and id. We iterate over the $albums that we assigned from the controller action. The Zend Framework 2 view system automatically ensures that these variables are extracted into the scope of the view script, so that we dont have to worry about prexing them with $this-> as we used to have to do with Zend Framework 1; however you can do so if you wish. We then create a table to display each albums title and artist, and provide links to allow for editing and deleting the record. A standard foreach: loop is used to iterate over the list of albums, and we use the alternate form using a colon and endforeach; as it is easier to scan than to try and match up braces. Again, the url() view helper is used to create the edit and delete links. 24 Chapter 8. Database and models
Note: We always use the escapeHtml() view helper to help protect ourselves from Cross Site Scripting (XSS) vulnerabilities (see http://en.wikipedia.org/wiki/Cross-site_scripting). If you open http://zf2-tutorial.localhost/album you should see this:
25
26
CHAPTER 9
Weve picked up the SkeletonApplications styling, which is ne, but we need to change the title and remove the copyright message. The ZendSkeletonApplication is set up to use Zend\I18ns translation functionality for all the text. It uses .po les that live in module/Application/language, and you need to use poedit to change the text. Start poedit and open module/Application/language/en_US.po. Click on Skeleton Application in the list of Original strings and then type in Tutorial as the translation.
Press Save in the toolbar and poedit will create an en_US.mo le for us. If you nd that no .mo le is generated, check Preferences -> Editor -> Behavior and see if the checkbox marked Automatically compile .mo file on save is checked. To remove the copyright message, we need to edit the Application modules layout.phtml view script:
// module/Application/view/layout/layout.phtml: // Remove this line: <p>© 2005 - 2012 by Zend Technologies Ltd. <?php echo $this->translate(All rights reserved.) ?></p>
27
28
CHAPTER 10
29
options => array( label => Artist, ), )); $this->add(array( name => submit, type => Submit, attributes => array( value => Go, id => submitbutton, ), )); } }
Within the constructor of AlbumForm we do several things. First, we set the name of the form as we call the parents constructor. We then set the forms method, in this case, post. Finally, we create four form elements: the id, title, artist, and submit button. For each item we set various attributes and options, including the label to be displayed. We also need to set up validation for this form. In Zend Framework 2 this is done using an input lter, which can either be standalone or dened within any class that implements the InputFilterAwareInterface interface, such as a model entity. In our case, we are going to add the input lter to the Album class, which resides in the Album.php le in module/Album/src/Album/Model:
<?php namespace Album\Model; // Add these import statements use Zend\InputFilter\InputFilter; use Zend\InputFilter\InputFilterAwareInterface; use Zend\InputFilter\InputFilterInterface; class Album implements InputFilterAwareInterface { public $id; public $artist; public $title; protected $inputFilter;
public function exchangeArray($data) { $this->id = (isset($data[id])) ? $data[id] : null; $this->artist = (isset($data[artist])) ? $data[artist] : null; $this->title = (isset($data[title])) ? $data[title] : null; } // Add content to these methods: public function setInputFilter(InputFilterInterface $inputFilter) { throw new \Exception("Not used"); } public function getInputFilter() { if (!$this->inputFilter) { $inputFilter = new InputFilter(); $inputFilter->add(array(
30
name => id, required => true, filters => array( array(name => Int), ), )); $inputFilter->add(array( name => artist, required => true, filters => array( array(name => StripTags), array(name => StringTrim), ), validators => array( array( name => StringLength, options => array( encoding => UTF-8, min => 1, max => 100, ), ), ), )); $inputFilter->add(array( name => title, required => true, filters => array( array(name => StripTags), array(name => StringTrim), ), validators => array( array( name => StringLength, options => array( encoding => UTF-8, min => 1, max => 100, ), ), ), )); $this->inputFilter = $inputFilter; } return $this->inputFilter; } }
The InputFilterAwareInterface denes two methods: setInputFilter() and getInputFilter(). We only need to implement getInputFilter() so we simply throw an exception in setInputFilter(). Within getInputFilter(), we instantiate an InputFilter and then add the inputs that we require. We add one input for each property that we wish to lter or validate. For the id eld we add an Int lter as we only need integers. For the text elements, we add two lters, StripTags and StringTrim, to remove unwanted HTML and
31
unnecessary white space. We also set them to be required and add a StringLength validator to ensure that the user doesnt enter more characters than we can store into the database. We now need to get the form to display and then process it on submission. AlbumControllers addAction():
// module/Album/src/Album/Controller/AlbumController.php: //... use Zend\Mvc\Controller\AbstractActionController; use Zend\View\Model\ViewModel; use Album\Model\Album; // <-- Add this import use Album\Form\AlbumForm; // <-- Add this import //... // Add content to this method: public function addAction() { $form = new AlbumForm(); $form->get(submit)->setValue(Add); $request = $this->getRequest(); if ($request->isPost()) { $album = new Album(); $form->setInputFilter($album->getInputFilter()); $form->setData($request->getPost()); if ($form->isValid()) { $album->exchangeArray($form->getData()); $this->getAlbumTable()->saveAlbum($album); // Redirect to list of albums return $this->redirect()->toRoute(album); } } return array(form => $form); } //...
After adding the AlbumForm to the use list, we implement addAction(). Lets look at the addAction() code in a little more detail:
$form = new AlbumForm(); $form->get(submit)->setValue(Add);
We instantiate AlbumForm and set the label on the submit button to Add. We do this here as well want to re-use the form when editing an album and will use a different label.
$request = $this->getRequest(); if ($request->isPost()) { $album = new Album(); $form->setInputFilter($album->getInputFilter()); $form->setData($request->getPost()); if ($form->isValid()) {
If the Request objects isPost() method is true, then the form has been submitted and so we set the forms input lter from an album instance. We then set the posted data to the form and check to see if it is valid using the isValid() member function of the form.
32
$album->exchangeArray($form->getData()); $this->getAlbumTable()->saveAlbum($album);
If the form is valid, then we grab the data from the form and store to the model using saveAlbum().
// Redirect to list of albums return $this->redirect()->toRoute(album);
After we have saved the new album row, we redirect back to the list of albums using the Redirect controller plugin.
return array(form => $form);
Finally, we return the variables that we want assigned to the view. In this case, just the form object. Note that Zend Framework 2 also allows you to simply return an array containing the variables to be assigned to the view and it will create a ViewModel behind the scenes for you. This saves a little typing. We now need to render the form in the add.phtml view script:
<?php // module/Album/view/album/album/add.phtml: $title = Add new album; $this->headTitle($title); ?> <h1><?php echo $this->escapeHtml($title); ?></h1> <?php $form->setAttribute(action, $this->url(album, array(action => add))); $form->prepare(); echo echo echo echo echo echo $this->form()->openTag($form); $this->formHidden($form->get(id)); $this->formRow($form->get(title)); $this->formRow($form->get(artist)); $this->formSubmit($form->get(submit)); $this->form()->closeTag();
Again, we display a title as before and then we render the form. Zend Framework provides some view helpers to make this a little easier. The form() view helper has an openTag() and closeTag() method which we use to open and close the form. Then for each element with a label, we can use formRow(), but for the two elements that are standalone, we use formHidden() and formSubmit().
33
Alternatively, the process of rendering the form can be simplied by using the bundled formCollection view helper. For example, in the view script above replace all the form-rendering echo statements with:
echo $this->formCollection($form);
Note: You still need to call the openTag and closeTag methods of the form. You replace the other echo statements with the call to formCollection, above. This will iterate over the form structure, calling the appropriate label, element and error view helpers for each element, but you still have to wrap formCollection($form) with the open and close form tags. This helps reduce the complexity of your view script in situations where the default HTML rendering of the form is acceptable. You should now be able to use the Add new album link on the home page of the application to add a new album record.
34
// if it cannot be found, in which case go to the index page. try { $album = $this->getAlbumTable()->getAlbum($id); } catch (\Exception $ex) { return $this->redirect()->toRoute(album, array( action => index )); } $form = new AlbumForm(); $form->bind($album); $form->get(submit)->setAttribute(value, Edit); $request = $this->getRequest(); if ($request->isPost()) { $form->setInputFilter($album->getInputFilter()); $form->setData($request->getPost()); if ($form->isValid()) { $this->getAlbumTable()->saveAlbum($album); // Redirect to list of albums return $this->redirect()->toRoute(album); } } return array( id => $id, form => $form, ); } //...
This code should look comfortably familiar. Lets look at the differences from adding an album. Firstly, we look for the id that is in the matched route and use it to load the album to be edited:
$id = (int) $this->params()->fromRoute(id, 0); if (!$id) { return $this->redirect()->toRoute(album, array( action => add )); } // Get the album with the specified id. An exception is thrown // if it cannot be found, in which case go to the index page. try { $album = $this->getAlbumTable()->getAlbum($id); } catch (\Exception $ex) { return $this->redirect()->toRoute(album, array( action => index )); }
params is a controller plugin that provides a convenient way to retrieve parameters from the matched route. We use it to retrieve the id from the route we created in the modules module.config.php. If the id is zero, then we redirect to the add action, otherwise, we continue by getting the album entity from the database.
35
We have to check to make sure that the Album with the specied id can actually be found. If it cannot, then the data access method throws an exception. We catch that exception and re-route the user to the index page.
$form = new AlbumForm(); $form->bind($album); $form->get(submit)->setAttribute(value, Edit);
The forms bind() method attaches the model to the form. This is used in two ways: When displaying the form, the initial values for each element are extracted from the model. After successful validation in isValid(), the data from the form is put back into the model. These operations are done using a hydrator object. There are a number of hydrators, but the default one is Zend\Stdlib\Hydrator\ArraySerializable which expects to nd two methods in the model: getArrayCopy() and exchangeArray(). We have already written exchangeArray() in our Album entity, so just need to write getArrayCopy():
// module/Album/src/Album/Model/Album.php: // ... public function exchangeArray($data) { $this->id = (isset($data[id])) ? $data[id] : null; $this->artist = (isset($data[artist])) ? $data[artist] : null; $this->title = (isset($data[title])) ? $data[title] : null; } // Add the following method: public function getArrayCopy() { return get_object_vars($this); } // ...
As a result of using bind() with its hydrator, we do not need to populate the forms data back into the $album as thats already been done, so we can just call the mappers saveAlbum() to store the changes back to the database. The view template, edit.phtml, looks very similar to the one for adding an album:
<?php // module/Album/view/album/album/edit.phtml: $title = Edit album; $this->headTitle($title); ?> <h1><?php echo $this->escapeHtml($title); ?></h1> <?php $form = $this->form; $form->setAttribute(action, $this->url( album, array( action => edit, id => $this->id, ) )); $form->prepare(); echo $this->form()->openTag($form); echo $this->formHidden($form->get(id));
36
The only changes are to use the Edit Album title and set the forms action to the edit action too. You should now be able to edit albums.
As before, we get the id from the matched route, and check the request objects isPost() to determine whether to show the conrmation page or to delete the album. We use the table object to delete the row using the deleteAlbum() method and then redirect back the list of albums. If the request is not a POST, then we retrieve the correct database record and assign to the view, along with the id. The view script is a simple form:
37
<?php // module/Album/view/album/album/delete.phtml: $title = Delete album; $this->headTitle($title); ?> <h1><?php echo $this->escapeHtml($title); ?></h1> <p>Are you sure that you want to delete <?php echo $this->escapeHtml($album->title); ?> by <?php echo $this->escapeHtml($album->artist); ?>? </p> <?php $url = $this->url(album, array( action => delete, id => $this->id, )); ?> <form action="<?php echo $url; ?>" method="post"> <div> <input type="hidden" name="id" value="<?php echo (int) $album->id; ?>" /> <input type="submit" name="del" value="Yes" /> <input type="submit" name="del" value="No" /> </div> </form>
In this script, we display a conrmation message to the user and then a form with Yes and No buttons. In the action, we checked specically for the Yes value when doing the deletion.
10.4 Ensuring that the home page displays the list of albums
One nal point. At the moment, the home page, http://zf2-tutorial.localhost/ doesnt display the list of albums. This is due to a route set up in the Application modules module.config.php. module/Application/config/module.config.php and nd the home route:
home => array( type => Zend\Mvc\Router\Http\Literal, options => array( route => /, defaults => array( controller => Application\Controller\Index, action => index, ), ), ),
38
), ),
10.4. Ensuring that the home page displays the list of albums
39
40
CHAPTER 11
Conclusion
This concludes our brief look at building a simple, but fully functional, MVC application using Zend Framework 2. In this tutorial we but briey touched quite a number of different parts of the framework. The most important part of applications built with Zend Framework 2 are the modules, the building blocks of any MVC ZF2 application. To ease the work with dependencies inside our applications, we use the service manager. To be able to map a request to controllers and their actions, we use routes. Data persistence, in most cases, includes using Zend\Db to communicate with one of the databases. Input data is ltered and validated with input lters and together with Zend\Form they provide a strong bridge between the domain model and the view layer. Zend\View is responsible for the View in the MVC stack, together with a vast amount of view helpers.
41
42
CHAPTER 12
ZFTool is a utility module for maintaining modular Zend Framework 2 applications. It runs from the command line and can be installed as ZF2 module or as PHAR (see below). This tool gives you the ability to: create a ZF2 project, installing a skeleton application; create a new module inside an existing ZF2 application; get the list of all the modules installed inside an application; get the conguration le of a ZF2 application; install the ZF2 library choosing a specic version. To install the ZFTool you can use one of the following methods or you can just download the PHAR package and use it.
43
12.4 Usage
In the following usage examples, the zf.php command can be replaced with zftool.phar.
The modules option gives you the list of all the modules installed in a ZF2 application.
> zf.php version | --version display current Zend Framework version
The version option gives you the version number of ZFTool and, if executed from the root folder of a ZF2 application, the version number of the Zend Framework library used by the application.
This command can be used to create a new module inside an existing ZF2 application. If the path is not provided the ZFTool try to create a new module in the local directory (only if the local folder contains a ZF2 application).
The directory to scan for PHP classes (use "." to use current directory) File name for generated class map file or - for standard output. If not supplied autoload_classmap.php inside <directory>. Append to classmap file if it exists Whether or not to overwrite existing classmap file
44
This command install the specied version of the ZF2 library in a path. If the version is omitted it will be used the last stable available. Using this command you can install all the tag version specied in the ZF2 github repository (the name used for the version is obtained removing the release- string from the tag name; for instance, the tag release-2.0.0 is equivalent to the version number 2.0.0).
This command will create a zftool.phar le in the bin folder. You can use and ship only this le to execute all the ZFTool functionalities. After the zftool.phar creation, we suggest to add the folder bin of ZFTool in your PATH environment. In this way you can execute the zftool.phar script wherever you are.
12.4. Usage
45
46
CHAPTER 13
Above, A is a dependency of B, and A was injected into B. If you are not familiar with the concept of dependency injection, here are a couple of great reads: Matthew Weier OPhinneys Analogy, Ralph Schindlers Learning DI, or Fabien Potenciers Series on DI.
namespace My { class A { /* Some useful functionality */ } class B { protected $a = null; public function __construct(A $a) { $this->a = $a; } } }
To create B by hand, a developer would follow this work ow, or a similar workow to this:
47
If this workow becomes repeated throughout your application multiple times, this creates an opportunity where one might want to DRY up the code. While there are several ways to do this, using a dependency injection container is one of these solutions. With Zends dependency injection container Zend\Di\Di, the above use case can be taken care of with no conguration (provided all of your autoloading is already congured properly) with the following usage:
1 2
$di = new Zend\Di\Di; $b = $di->get(My\B); // will produce a B object that is consuming an A object
Moreover, by using the Di::get() method, you are ensuring that the same exact object is returned on subsequent calls. To force new objects to be created on each and every request, one would use the Di::newInstance() method:
1
$b = $di->newInstance(My\B);
Lets assume for a moment that A requires some conguration before it can be created. Our previous use case is expanded to this (well throw a 3rd class in for good measure):
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
namespace My { class A { protected $username = null; protected $password = null; public function __construct($username, $password) { $this->username = $username; $this->password = $password; } } class B { protected $a = null; public function __construct(A $a) { $this->a = $a; } } class C { protected $b = null; public function __construct(B $b) { $this->b = $b; } } }
With the above, we need to ensure that our Di is capable of setting the A class with a few conguration values (which are generally scalar in nature). To do this, we need to interact with the InstanceManager:
1 2 3
48
Now that our container has values it can use when creating A, and our new goal is to have a C object that consumes B and in turn consumes A, the usage scenario is still the same:
1 2 3
$c = $di->get(My\C); // or $c = $di->newInstance(My\C);
Simple enough, but what if we wanted to pass in these parameters at call time? Assuming a default Di object ($di = new Zend\Di\Di() without any conguration to the InstanceManager), we could do the following:
1 2 3 4 5 6 7 8
$parameters = array( username => MyUsernameValue, password => MyHardToGuessPassword%$#, ); $c = $di->get(My\C, $parameters); // or $c = $di->newInstance(My\C, $parameters);
Constructor injection is not the only supported type of injection. The other most popular method of injection is also supported: setter injection. Setter injection allows one to have a usage scenario that is the same as our previous example with the exception, for example, of our B class now looking like this:
1 2 3 4 5 6 7 8 9 10
namespace My { class B { protected $a; public function setA(A $a) { $this->a = $a; } } }
Since the method is prexed with set, and is followed by a capital letter, the Di knows that this method is used for setter injection, and again, the use case $c = $di->get(C), will once again know how to ll the dependencies when needed to create an object of type C. Other methods are being created to determine what the wirings between classes are, such as interface injection and annotation based injection.
49
describe the mappings with objects. Lets say for example, our above A/B/C usage scenario, were altered such that class B now looks like this:
1 2 3 4 5 6 7 8 9 10
Youll notice the only change is that setA now does not include any type-hinting information.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
use Zend\Di\Di; use Zend\Di\Definition; use Zend\Di\Definition\Builder; // Describe this class: $builder = new Definition\BuilderDefinition; $builder->addClass(($class = new Builder\PhpClass)); $class->setName(My\B); $class->addInjectableMethod(($im = new Builder\InjectableMethod)); $im->setName(setA); $im->addParameter(a, My\A); // Use both our Builder Definition as well as the default // RuntimeDefinition, builder first $aDef = new Definition\AggregateDefinition; $aDef->addDefinition($builder); $aDef->addDefinition(new Definition\RuntimeDefinition); // Now make sure the Di understands it $di = new Di; $di->setDefinition($aDef); // and finally, create C $parameters = array( username => MyUsernameValue, password => MyHardToGuessPassword%$#, ); $c = $di->get(My\C, $parameters);
This above usage scenario provides that whatever the code looks like, you can ensure that it works with the dependency injection container. In an ideal world, all of your code would have the proper type hinting and/or would be using a mapping strategy that reduces the amount of bootstrapping work that needs to be done in order to have a full denition that is capable of instantiating all of the objects you might require.
with the fact that PHP does not have a true application layer capable of storing objects in-memory between requests, and you get a recipe that is less performant than similar solutions youll nd in Java and .Net (where there is an application layer with in-memory object storage.) To mitigate this shortcoming, Zend\Di has several features built in capable of pre-compiling the most expensive tasks that surround dependency injection. It is worth noting that the RuntimeDefinition, which is used by default, is the only denition that does lookups on-demand. The rest of the Definition objects are capable of being aggregated and stored to disk in a very performant way. Ideally, 3rd party code will ship with a pre-compiled Definition that will describe the various relationships and parameter/property needs of each class that is to be instantiated. This Definition would have been built as part of some deployment or packaging task by this 3rd party. When this is not the case, you can create these Definitions via any of the Definition types provided with the exception of the RuntimeDefinition. Here is a breakdown of the job of each denition type: AggregateDefinition- Aggregates multiple denitions of various types. When looking for a class, it looks it up in the order the denitions were provided to this aggregate. ArrayDefinition- This denition takes an array of information and exposes it via the interface provided by Zend\Di\Definition suitable for usage by Di or an AggregateDefinition BuilderDefinition- Creates a denition based on an object graph consisting of various Builder\PhpClass objects and Builder\InjectionMethod objects that describe the mapping needs of the target codebase and Compiler- This is not actually a denition, but produces an ArrayDefinition based off of a code scanner (Zend\Code\Scanner\DirectoryScanner or Zend\Code\Scanner\FileScanner). The following is an example of producing a denition via a DirectoryScanner:
1 2 3 4 5
This denition can then be directly used by the Di (assuming the above A, B, C scenario was actually a le per class on disk):
1 2 3 4 5
$di = new Zend\Di\Di; $di->setDefinition($definition); $di->getInstanceManager()->setProperty(My\A, username, foo); $di->getInstanceManager()->setProperty(My\A, password, bar); $c = $di->get(My\C);
One strategy for persisting these compiled denitions would be the following:
1 2 3 4 5 6 7 8 9 10 11 12 13 14
if (!file_exists(__DIR__ . /di-definition.php) && $isProduction) { $compiler = new Zend\Di\Definition\Compiler(); $compiler->addCodeScannerDirectory( new Zend\Code\Scanner\ScannerDirectory(path/to/library/My/) ); $definition = $compiler->compile(); file_put_contents( __DIR__ . /di-definition.php, <?php return . var_export($definition->toArray(), true) . ; ); } else { $definition = new Zend\Di\Definition\ArrayDefinition( include __DIR__ . /di-definition.php );
51
15 16 17 18
Since Zend\Code\Scanner does not include les, the classes contained within are not loaded into memory. Instead, Zend\Code\Scanner uses tokenization to determine the structure of your les. This makes this suitable to use this solution during development and within the same request as any one of your applications dispatched actions.
// First, compile the information $compiler = new Zend\Di\Definition\CompilerDefinition(); $compiler->addDirectoryScanner( new Zend\Code\Scanner\DirectoryScanner(__DIR__ . /My/) ); $compiler->compile(); $definition = $compiler->toArrayDefinition(); // Now, create a Definition class for this information $codeGenerator = new Zend\Code\Generator\FileGenerator(); $codeGenerator->setClass(($class = new Zend\Code\Generator\ClassGenerator())); $class->setNamespaceName(My); $class->setName(DiDefinition); $class->setExtendedClass(\Zend\Di\Definition\ArrayDefinition); $class->addMethod( __construct, array(), \Zend\Code\Generator\MethodGenerator::FLAG_PUBLIC, parent::__construct( . var_export($definition->toArray(), true) . ); ); file_put_contents(__DIR__ . /My/DiDefinition.php, $codeGenerator->generate());
use Zend\Di\Di; use Zend\Di\Definition; use Zend\Di\Definition\Builder; $di = new Di; $diDefAggregate = new Definition\Aggregate(); // first add in provided Definitions, for example $diDefAggregate->addDefinition(new ThirdParty\Dbal\DiDefinition());
52
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
$diDefAggregate->addDefinition(new Zend\Controller\DiDefinition()); // for code that does not have TypeHints $builder = new Definition\BuilderDefinition(); $builder->addClass(($class = Builder\PhpClass)); $class->addInjectionMethod( ($injectMethod = new Builder\InjectionMethod()) ); $injectMethod->setName(injectImplementation); $injectMethod->addParameter( implementation, Class\For\Specific\Implementation ); // now, your application code $compiler = new Definition\Compiler() $compiler->addCodeScannerDirectory( new Zend\Code\Scanner\DirectoryScanner(__DIR__ . /App/) ); $appDefinition = $compiler->compile(); $diDefAggregate->addDefinition($appDefinition); // now, pass in properties $im = $di->getInstanceManager(); // this could come from Zend\Config\Config::toArray $propertiesFromConfig = array( ThirdParty\Dbal\DbAdapter => array( username => someUsername, password => somePassword ), Zend\Controller\Helper\ContentType => array( default => xhtml5 ), ); $im->setProperties($propertiesFromConfig);
53
5 6 7 8 9 10
The above code will write to ../Application/Context.php, and that le will contain the class Application\Context. That le might look like the following:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
<?php namespace Application; use Zend\Di\ServiceLocator; class Context extends ServiceLocator { public function get($name, array $params = array()) { switch ($name) { case composed: case My\ComposedClass: return $this->getMyComposedClass(); case struct: case My\Struct: return $this->getMyStruct(); default: return parent::get($name, $params); } } public function getComposedClass() { if (isset($this->services[My\ComposedClass])) { return $this->services[My\ComposedClass]; } $object = new \My\ComposedClass(); $this->services[My\ComposedClass] = $object; return $object; } public function getMyStruct() { if (isset($this->services[My\Struct])) { return $this->services[My\Struct]; } $object = new \My\Struct(); $this->services[My\Struct] = $object; return $object; } public function getComposed() { return $this->get(My\ComposedClass);
54
50 51 52 53 54 55 56
One note about this functionality in its current incarnation. Conguration is per-environment only at this time. This means that you will need to generate a container per execution environment. Our recommendation is that you do so, and then in your environment, specify the container class to use.
55
56
CHAPTER 14
A solid unit test suite is essential for ongoing development in large projects, especially those with many people involved. Going back and manually testing every individual component of an application after every change is impractical. Your unit tests will help alleviate that by automatically testing your applications components and alerting you when something is not working the same way it was when you wrote your tests. This tutorial is written in the hopes of showing how to test different parts of a Zend Framework 2 MVC application. As such, this tutorial will use the application written in the getting started user guide. It is in no way a guide to unit testing in general, but is here only to help overcome the initial hurdles in writing unit tests for ZF2 applications. It is recommended to have at least a basic understanding of unit tests, assertions and mocks. As the Zend Framework 2 API uses PHPUnit, so will this tutorial. This tutorial assumes that you already have PHPUnit installed. The version of PHPUnit used should be 3.7.*
The structure of the test directory matches exactly with that of the modules source les, and it will allow you to keep your tests well-organized and easy to nd.
57
<?php namespace AlbumTest; use use use use Zend\Loader\AutoloaderFactory; Zend\Mvc\Service\ServiceManagerConfig; Zend\ServiceManager\ServiceManager; RuntimeException;
error_reporting(E_ALL | E_STRICT); chdir(__DIR__); /** * Test bootstrap, for setting up autoloading */ class Bootstrap { protected static $serviceManager; public static function init() { $zf2ModulePaths = array(dirname(dirname(__DIR__))); if (($path = static::findParentPath(vendor))) { $zf2ModulePaths[] = $path; } if (($path = static::findParentPath(module)) !== $zf2ModulePaths[0]) { $zf2ModulePaths[] = $path; } static::initAutoloader(); // use ModuleManager to load this module and its dependencies $config = array( module_listener_options => array( module_paths => $zf2ModulePaths, ), modules => array( Album ) ); $serviceManager = new ServiceManager(new ServiceManagerConfig());
58
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
$serviceManager->setService(ApplicationConfig, $config); $serviceManager->get(ModuleManager)->loadModules(); static::$serviceManager = $serviceManager; } public static function chroot() { $rootPath = dirname(static::findParentPath(module)); chdir($rootPath); } public static function getServiceManager() { return static::$serviceManager; } protected static function initAutoloader() { $vendorPath = static::findParentPath(vendor); $zf2Path = getenv(ZF2_PATH); if (!$zf2Path) { if (defined(ZF2_PATH)) { $zf2Path = ZF2_PATH; } elseif (is_dir($vendorPath $zf2Path = $vendorPath . } elseif (is_dir($vendorPath $zf2Path = $vendorPath . } }
if (!$zf2Path) { throw new RuntimeException( Unable to load ZF2. Run php composer.phar install or . define a ZF2_PATH environment variable. ); } if (file_exists($vendorPath . /autoload.php)) { include $vendorPath . /autoload.php; } include $zf2Path . /Zend/Loader/AutoloaderFactory.php; AutoloaderFactory::factory(array( Zend\Loader\StandardAutoloader => array( autoregister_zf => true, namespaces => array( __NAMESPACE__ => __DIR__ . / . __NAMESPACE__, ), ), )); } protected static function findParentPath($path) { $dir = __DIR__; $previousDir = .; while (!is_dir($dir . / . $path)) {
59
101 102 103 104 105 106 107 108 109 110
$dir = dirname($dir); if ($previousDir === $dir) return false; $previousDir = $dir; } return $dir . / . $path; } } Bootstrap::init(); Bootstrap::chroot();
The contents of this bootstrap le can be daunting at rst sight, but all it really does is ensuring that all the necessary les are autoloadable for our tests. The most important lines is line 38 on which we say what modules we want to load for our test. In this case we are only loading the Album module as it has no dependencies against other modules. Now, if you navigate to the zf2-tutorial/module/Album/test/ directory, and run phpunit, you should get a similar output to this:
PHPUnit 3.7.13 by Sebastian Bergmann. Configuration read from /var/www/zf2-tutorial/module/Album/test/phpunit.xml Time: 0 seconds, Memory: 1.75Mb No tests executed!
Even though no tests were executed, we at least know that the autoloader found the ZF2 les, otherwise it would throw a RuntimeException, dened on line 69 of our bootstrap le.
The AbstractHttpControllerTestCase class we extend here helps us setting up the application itself, helps with dispatching and other tasks that happen during a request, as well offers methods for asserting request params, response headers, redirects and more. See Zend\Test documentation for more. 60 Chapter 14. Unit Testing a Zend Framework 2 application
One thing that is needed is to set the application cong with the setApplicationConfig method. Now, add the following function to the AlbumControllerTest class:
public function testIndexActionCanBeAccessed() { $this->dispatch(/album); $this->assertResponseStatusCode(200); $this->assertModuleName(Album); $this->assertControllerName(Album\Controller\Album); $this->assertControllerClass(AlbumController); $this->assertMatchedRouteName(album); }
This test case dispatches the /album URL, asserts that the response code is 200, and that we ended up in the desired module and controller. Note: For asserting the controller name we are using the controller name we dened in our routing conguration for the Album module. In our example this should be dened on line 19 of the module.config.php le in the Album module.
The failure message doesnt tell us much, apart from that the expected status code is not 200, but 500. To get a bit more information when something goes wrong in a test case, we set the protected $traceError member to true. Add the following just above the setUp method in our AlbumControllerTest class:
protected $traceError = true;
Running the phpunit command again and we should see some more information about what went wrong in our test. The main error message we are interested in should read something like:
Zend\ServiceManager\Exception\ServiceNotFoundException: Zend\ServiceManager\ServiceManager::get was unable to fetch or create an instance for Zend\Db\Adapter\Adapter
61
From this error message it is clear that not all our dependencies are available in the service manager. Let us take a look how can we x this.
public function testIndexActionCanBeAccessed() { $albumTableMock = $this->getMockBuilder(Album\Model\AlbumTable) ->disableOriginalConstructor() ->getMock(); $albumTableMock->expects($this->once()) ->method(fetchAll) ->will($this->returnValue(array())); $serviceManager = $this->getApplicationServiceLocator(); $serviceManager->setAllowOverride(true); $serviceManager->setService(Album\Model\AlbumTable, $albumTableMock); $this->dispatch(/album); $this->assertResponseStatusCode(200); $this->assertModuleName(Album); $this->assertControllerName(Album\Controller\Album); $this->assertControllerClass(AlbumController); $this->assertMatchedRouteName(album); }
By default, the Service Manager does not allow us to replace existing services. As the Album\Model\AlbumTable was already set, we are allowing for overrides (line 12), and then replacing the real instance of the AlbumTable with a mock. The mock is created so that it will return just an empty array when the fetchAll method is called. This allows us to test for what we care about in this test, and that is that by dispatching to the /album URL we get to the Album modules AlbumController. Running the phpunit command at this point, we will get the following output as the tests now pass:
62
PHPUnit 3.7.13 by Sebastian Bergmann. Configuration read from /var/www/zf2-tutorial/module/Album/test/phpunit.xml . Time: 0 seconds, Memory: 9.00Mb OK (1 test, 6 assertions)
Here we test that when we make a POST request against the /album/add URL, the Album\Model\AlbumTables saveAlbum will be called and after that we will be redirected back to the /album URL. Running phpunit gives us the following output:
PHPUnit 3.7.13 by Sebastian Bergmann. Configuration read from /home/robert/www/zf2-tutorial/module/Album/test/phpunit.xml .. Time: 0 seconds, Memory: 10.75Mb OK (2 tests, 9 assertions)
Testing the editAction and deleteAction methods can be easily done in a manner similar as shown for the addAction. 14.6. Testing actions with POST 63
<?php namespace AlbumTest\Model; use Album\Model\Album; use PHPUnit_Framework_TestCase; class AlbumTest extends PHPUnit_Framework_TestCase { public function testAlbumInitialState() { $album = new Album(); $this->assertNull( $album->artist, "artist" should initially be null ); $this->assertNull( $album->id, "id" should initially be null ); $this->assertNull( $album->title, "title" should initially be null ); } public function testExchangeArraySetsPropertiesCorrectly() { $album = new Album(); $data = array(artist => some artist, id => 123, title => some title); $album->exchangeArray($data); $this->assertSame( $data[artist], $album->artist, "artist" was not set correctly ); $this->assertSame( $data[id], $album->id, "id" was not set correctly ); $this->assertSame( $data[title],
64
$album->title, "title" was not set correctly ); } public function testExchangeArraySetsPropertiesToNullIfKeysAreNotPresent() { $album = new Album(); $album->exchangeArray(array(artist => some artist, id => 123, title => some title)); $album->exchangeArray(array()); $this->assertNull( $album->artist, "artist" should have defaulted to null ); $this->assertNull( $album->id, "id" should have defaulted to null ); $this->assertNull( $album->title, "title" should have defaulted to null ); } public function testGetArrayCopyReturnsAnArrayWithPropertyValues() { $album = new Album(); $data = array(artist => some artist, id => 123, title => some title); $album->exchangeArray($data); $copyArray = $album->getArrayCopy(); $this->assertSame( $data[artist], $copyArray[artist], "artist" was not set correctly ); $this->assertSame( $data[id], $copyArray[id], "id" was not set correctly ); $this->assertSame( $data[title], $copyArray[title], "title" was not set correctly ); } public function testInputFiltersAreSetCorrectly() { $album = new Album(); $inputFilter = $album->getInputFilter();
65
We are testing for 5 things: 1. Are all of the Albums properties initially set to NULL? 2. Will the Albums properties be set correctly when we call exchangeArray()? 3. Will a default value of NULL be used for properties whose keys are not present in the $data array? 4. Can we get an array copy of our model? 5. Do all elements have input lters present? If we run phpunit again, we will get the following output, conrming that our model is indeed correct:
PHPUnit 3.7.13 by Sebastian Bergmann. Configuration read from /var/www/zf2-tutorial/module/Album/test/phpunit.xml ....... Time: 0 seconds, Memory: 11.00Mb OK (7 tests, 25 assertions)
class AlbumTableTest extends PHPUnit_Framework_TestCase { public function testFetchAllReturnsAllAlbums() { $resultSet = new ResultSet(); $mockTableGateway = $this->getMock( Zend\Db\TableGateway\TableGateway, array(select),
66
array(), , false ); $mockTableGateway->expects($this->once()) ->method(select) ->with() ->will($this->returnValue($resultSet)); $albumTable = new AlbumTable($mockTableGateway); $this->assertSame($resultSet, $albumTable->fetchAll()); } }
Since we are testing the AlbumTable here and not the TableGateway class (which has already been tested in Zend Framework), we just want to make sure that our AlbumTable class is interacting with the TableGateway class the way that we expect it to. Above, were testing to see if the fetchAll() method of AlbumTable will call the select() method of the $tableGateway property with no parameters. If it does, it should return a ResultSet object. Finally, we expect that this same ResultSet object will be returned to the calling method. This test should run ne, so now we can add the rest of the test methods:
public function testCanRetrieveAnAlbumByItsId() { $album = new Album(); $album->exchangeArray(array(id => 123, artist => The Military Wives, title => In My Dreams)); $resultSet = new ResultSet(); $resultSet->setArrayObjectPrototype(new Album()); $resultSet->initialize(array($album)); $mockTableGateway = $this->getMock( Zend\Db\TableGateway\TableGateway, array(select), array(), , false ); $mockTableGateway->expects($this->once()) ->method(select) ->with(array(id => 123)) ->will($this->returnValue($resultSet)); $albumTable = new AlbumTable($mockTableGateway); $this->assertSame($album, $albumTable->getAlbum(123)); } public function testCanDeleteAnAlbumByItsId() { $mockTableGateway = $this->getMock( Zend\Db\TableGateway\TableGateway, array(delete), array(), , false
67
); $mockTableGateway->expects($this->once()) ->method(delete) ->with(array(id => 123)); $albumTable = new AlbumTable($mockTableGateway); $albumTable->deleteAlbum(123); } public function testSaveAlbumWillInsertNewAlbumsIfTheyDontAlreadyHaveAnId() { $albumData = array( artist => The Military Wives, title => In My Dreams ); $album = new Album(); $album->exchangeArray($albumData); $mockTableGateway = $this->getMock( Zend\Db\TableGateway\TableGateway, array(insert), array(), , false ); $mockTableGateway->expects($this->once()) ->method(insert) ->with($albumData); $albumTable = new AlbumTable($mockTableGateway); $albumTable->saveAlbum($album); } public function testSaveAlbumWillUpdateExistingAlbumsIfTheyAlreadyHaveAnId() { $albumData = array( id => 123, artist => The Military Wives, title => In My Dreams, ); $album = new Album(); $album->exchangeArray($albumData); $resultSet = new ResultSet(); $resultSet->setArrayObjectPrototype(new Album()); $resultSet->initialize(array($album)); $mockTableGateway = $this->getMock( Zend\Db\TableGateway\TableGateway, array(select, update), array(), , false ); $mockTableGateway->expects($this->once()) ->method(select) ->with(array(id => 123)) ->will($this->returnValue($resultSet));
68
$mockTableGateway->expects($this->once()) ->method(update) ->with( array( artist => The Military Wives, title => In My Dreams ), array(id => 123) ); $albumTable = new AlbumTable($mockTableGateway); $albumTable->saveAlbum($album); } public function testExceptionIsThrownWhenGettingNonExistentAlbum() { $resultSet = new ResultSet(); $resultSet->setArrayObjectPrototype(new Album()); $resultSet->initialize(array()); $mockTableGateway = $this->getMock( Zend\Db\TableGateway\TableGateway, array(select), array(), , false ); $mockTableGateway->expects($this->once()) ->method(select) ->with(array(id => 123)) ->will($this->returnValue($resultSet)); $albumTable = new AlbumTable($mockTableGateway); try { $albumTable->getAlbum(123); } catch (\Exception $e) { $this->assertSame(Could not find row 123, $e->getMessage()); return; } $this->fail(Expected exception was not thrown); }
These tests are nothing complicated and they should be self explanatory. In each test we are injecting a mock table gateway into our AlbumTable and set our expectations accordingly. We are testing that: 1. We can retrieve an individual album by its ID. 2. We can delete albums. 3. We can save new album. 4. We can update existing albums. 5. We will encounter an exception if were trying to retrieve an album that doesnt exist. Running phpunit command for one last time, we get the output as follows: 14.8. Testing model tables 69
PHPUnit 3.7.13 by Sebastian Bergmann. Configuration read from /var/www/zf2-tutorial/module/Album/test/phpunit.xml ............. Time: 0 seconds, Memory: 11.50Mb OK (13 tests, 34 assertions)
14.9 Conclusion
In this short tutorial we gave a few examples how different parts of a Zend Framework 2 MVC application can be tested. We covered setting up the environment for testing, how to test controllers and actions, how to approach failing test cases, how to congure the service manager, as well as how to test model entities and model tables. This tutorial is by no means a denitive guide to writing unit tests, just a small stepping stone helping you develop applications of higher quality.
70
CHAPTER 15
15.1 Terminology
An Event is a named action. A Listener is any PHP callback that reacts to an event. An EventManager aggregates listeners for one or more named events, and triggers events. Typically, an event will be modeled as an object, containing metadata surrounding when and how it was triggered, including the event name, what object triggered the event (the target), and what parameters were provided. Events are named, which allows a single listener to branch logic based on the event.
use Zend\EventManager\EventManager; $events = new EventManager(); $events->attach(do, function ($e) { $event = $e->getName(); $params = $e->getParams(); printf( Handled event "%s", with parameters %s, $event, json_encode($params) ); });
71
13 14 15
$params = array(foo => bar, baz => bat); $events->trigger(do, null, $params);
Note: Throughout this tutorial, we use closures as listeners. However, any valid PHP callback can be attached as a listeners: PHP function names, static class methods, object instance methods, functors, or closures. We use closures within this post simply for illustration and simplicity. If you were paying attention to the example, you will have noted the null argument. Why is it there? Typically, you will compose an EventManager within a class, to allow triggering actions within methods. The middle argument to trigger() is the target, and in the case described, would be the current object instance. This gives event listeners access to the calling object, which can often be useful.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
use Zend\EventManager\EventManager; use Zend\EventManager\EventManagerAwareInterface; use Zend\EventManager\EventManagerInterface; class Example implements EventManagerAwareInterface { protected $events; public function setEventManager(EventManagerInterface $events) { $events->setIdentifiers(array( __CLASS__, get_class($this) )); $this->events = $events; } public function getEventManager() { if (!$this->events) { $this->setEventManager(new EventManager()); } return $this->events; } public function do($foo, $baz) { $params = compact(foo, baz); $this->getEventManager()->trigger(__FUNCTION__, $this, $params); } } $example = new Example(); $example->getEventManager()->attach(do, function($e) { $event = $e->getName(); $target = get_class($e->getTarget()); // "Example" $params = $e->getParams(); printf(
72
41 42 43 44 45 46 47 48
Handled event "%s" on target "%s", with parameters %s, $event, $target, json_encode($params) ); }); $example->do(bar, bat);
The above is basically the same as the rst example. The main difference is that were now using that middle argument in order to pass the target, the instance of Example, on to the listeners. Our listener is now retrieving that ($e->getTarget()), and doing something with it. If youre reading this critically, you should have a new question: What is the call to setIdentifiers() for?
Zend\EventManager\SharedEventManagerInterface describes an object that aggregates listeners for events attached to objects with specic identiers. It does not trigger events itself. Instead, an EventManager instance that composes a SharedEventManager will query the SharedEventManager for listeners on identiers its interested in, and trigger those listeners as well. How does this work, exactly? Consider the following:
1 2 3 4 5 6 7 8 9 10 11 12 13 14
use Zend\EventManager\SharedEventManager; $sharedEvents = new SharedEventManager(); $sharedEvents->attach(Example, do, function ($e) { $event = $e->getName(); $target = get_class($e->getTarget()); // "Example" $params = $e->getParams(); printf( Handled event "%s" on target "%s", with parameters %s, $event, $target, json_encode($params) ); });
This looks almost identical to the previous example; the key difference is that there is an additional argument at the start of the list, Example. This code is basically saying, Listen to the do event of the Example target, and, when notied, execute this callback. This is where the setIdentifiers() argument of EventManager comes into play. The method allows passing a string, or an array of strings, dening the name or names of the context or targets the given instance will be interested in. If an array is given, then any listener on any of the targets given will be notied. So, getting back to our example, lets assume that the above shared listener is registered, and also that the Example class is dened as above. We can then execute the following:
1 2 3
73
One interesting aspect of our setEventManager() method is that we dened it to listen both on __CLASS__ and get_class($this). This means that calling do() on our SubExample class would also trigger the shared listener! It also means that, if desired, we could attach to specically SubExample, and listeners attached to only the Example target would not be triggered. Finally, the names used as contexts or targets need not be class names; they can be some name that only has meaning in your application if desired. As an example, you could have a set of classes that respond to log or cache and listeners on these would be notied by any of them. Note: We recommend using class names, interface names, and/or abstract class names for identiers. This makes determining what events are available easier, as well as nding which listeners might be attaching to those events. Interfaces make a particularly good use case, as they allow attaching to a group of related classes a single operation. At any point, if you do not want to notify shared listeners, pass a null value to setSharedManager(): and they will be ignored. If at any point, you want to enable them again, pass the SharedEventManager instance:
74
CHAPTER 16
Wildcards
So far, with both a normal EventManager instance and with the SharedEventManager instance, weve seen the usage of singular strings representing the event and target names to which we want to attach. What if you want to attach a listener to multiple events or targets? The answer is to supply an array of events or targets, or a wildcard, *. Consider the following examples:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
// Multiple named events: $events->attach( array(foo, bar, baz), // events $listener ); // All events via wildcard: $events->attach( *, // all events $listener ); // Multiple named targets: $sharedEvents->attach( array(Foo, Bar, Baz), // targets doSomething, // named event $listener ); // All targets via wildcard $sharedEvents->attach( *, // all targets doSomething, // named event $listener ); // Mix and match: multiple named events on multiple named targets: $sharedEvents->attach( array(Foo, Bar, Baz), // targets array(foo, bar, baz), // events $listener );
75
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
// Mix and match: all events on multiple named targets: $sharedEvents->attach( array(Foo, Bar, Baz), // targets *, // events $listener ); // Mix and match: multiple named events on all targets: $sharedEvents->attach( *, // targets array(foo, bar, baz), // events $listener ); // Mix and match: all events on all targets: $sharedEvents->attach( *, // targets *, // events $listener );
The ability to specify multiple targets and/or events when attaching can slim down your code immensely.
76
CHAPTER 17
Listener aggregates
Another approach to listening to multiple events is via a concept of listener aggregates, represented by Zend\EventManager\ListenerAggregateInterface. Via this approach, a single class can listen to multiple events, attaching one or more instance methods as listeners. This interface denes two methods, attach(EventManagerInterface $events) and detach(EventManagerInterface $events). Basically, you pass an EventManager instance to one and/or the other, and then its up to the implementing class to determine what to do. As an example:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
class LogEvents implements ListenerAggregateInterface { protected $listeners = array(); protected $log; public function __construct(Logger $log) { $this->log = $log; } public function attach(EventManagerInterface $events) { $this->listeners[] = $events->attach(do, array($this, log)); $this->listeners[] = $events->attach(doSomethingElse, array($this, log)); } public function detach(EventCollection $events) { foreach ($this->listeners as $index => $listener) { if ($events->detach($listener)) { unset($this->listeners[$index]; } } }
77
31 32 33 34 35 36 37
public function log(EventInterface $e) { $event = $e->getName(); $params = $e->getParams(); $this->log->info(sprintf(%s: %s, $event, json_encode($params))); } }
You can attach this using either attach() or attachAggregate(): Any events the aggregate attaches to will then be notied when triggered. Why bother? For a couple of reasons: Aggregates allow you to have stateful listeners. The above example demonstrates this via the composition of the logger; another example would be tracking conguration options. Aggregates make detaching listeners easier. When you call attach() normally, you receive a Zend\Stdlib\CallbackHandler instance; the only way to detach() a listener is to pass that instance back which means if you want to detach later, you need to keep that instance somewhare. Aggregates typically do this for you as you can see in the example above.
78
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
public function someExpensiveCall($criteria1, $criteria2) { $params = compact(criteria1, criteria2); $results = $this->getEventManager()->trigger( __FUNCTION__, $this, $params, function ($r) { return ($r instanceof SomeResultClass); } ); if ($results->stopped()) { return $results->last(); } // ... do some work ... }
With this paradigm, we know that the likely reason of execution halting is due to the last result meeting the test callback criteria; as such, we simply return that last result. The other way to halt execution is within a listener, acting on the Event object it receives. In this case, the listener calls stopPropagation(true), and the EventManager will then return without notifying any additional listeners.
1 2 3 4
This, of course, raises some ambiguity when using the trigger paradigm, as you can no longer be certain that the last result meets the criteria its searching on. As such, we recommend that you standardize on one approach or the other.
$priority = 100; $events->attach(Example, do, function($e) { $event = $e->getName(); $target = get_class($e->getTarget()); // "Example" $params = $e->getParams(); printf( Handled event "%s" on target "%s", with parameters %s, $event, $target, json_encode($params)
79
11 12
); }, $priority);
This would execute with high priority, meaning it would execute early. If we changed $priority to -100, it would execute with low priority, executing late. While you cant necessarily know all the listeners attached, chances are you can make adequate guesses when necessary in order to set appropriate priority values. We advise avoiding setting a priority value unless absolutely necessary.
$routeMatch = $e->getParam(route-match, false); if (!$routeMatch) { // Oh noes! we cannot do our work! whatever shall we do?!?!?! }
The problems with this are several. First, relying on string keys is going to very quickly run into problems typos when setting or retrieving the argument can lead to hard to debug situations. Second, we now have a documentation issue; how do we document expected arguments? how do we document what were shoving into the event? Third, as a side effect, we cant use IDE or editor hinting support string keys give these tools nothing to work with. Similarly, consider how you might represent a computational result of a method when triggering an event. As an example:
1 2 3 4 5 6 7 8 9
// in the method: $params[__RESULT] = $computedResult; $events->trigger(__FUNCTION__ . .post, $this, $params); // in the listener: $result = $e->getParam(__RESULT__); if (!$result) { // Oh noes! we cannot do our work! whatever shall we do?!?!?! }
Sure, that key may be unique, but it suffers from a lot of the same issues. So, the solution is to create custom events. As an example, we have a custom MvcEvent in the ZF2 MVC layer. This event composes the application instance, the router, the route match object, request and response objects, the view model, and also a result. We end up with code like this in our listeners:
1 2 3 4 5 6
$response = $e->getResponse(); $result = $e->getResult(); if (is_string($result)) { $content = $view->render(layout.phtml, array(content => $result)); $response->setContent($content); }
But how do we use this custom event? Simple: trigger() can accept an event object instead of any of the event name, target, or params arguments.
80
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
$event = new CustomEvent(); $event->setSomeKey($value); // Injected with event name and target: $events->trigger(foo, $this, $event); // Injected with event name: $event->setTarget($this); $events->trigger(foo, $event); // Fully encapsulates all necessary properties: $event->setName(foo); $event->setTarget($this); $events->trigger($event); // Passing a callback following the event object works for // short-circuiting, too. $results = $events->trigger(foo, $this, $event, $callback);
This is a really powerful technique for domain-specic event systems, and denitely worth experimenting with.
public function someExpensiveCall($criteria1, $criteria2) { $params = compact(criteria1, criteria2); $results = $this->getEventManager()->trigger( __FUNCTION__ . .pre, $this, $params, function ($r) { return ($r instanceof SomeResultClass); } ); if ($results->stopped()) { return $results->last(); } // ... do some work ...
81
17 18 19 20 21
Now, to provide some caching listeners. Well need to attach to each of the someExpensiveCall.pre and someExpensiveCall.post methods. In the former case, if a cache hit is detected, we return it, and move on. In the latter, we store the value in the cache. Well assume $cache is dened, and follows the paradigms of Zend\Cache. Well want to return early if a hit is detected, and execute late when saving a cache (in case the result is modied by another listener). As such, well set the someExpensiveCall.pre listener to execute with priority 100, and the someExpensiveCall.post listener to execute with priority -100.
1 2 3 4 5 6 7 8 9 10 11 12 13 14
$events->attach(someExpensiveCall.pre, function($e) use ($cache) { $params = $e->getParams(); $key = md5(json_encode($params)); $hit = $cache->load($key); return $hit; }, 100); $events->attach(someExpensiveCall.post, function($e) use ($cache) { $params = $e->getParams(); $result = $params[__RESULT__]; unset($params[__RESULT__]); $key = md5(json_encode($params)); $cache->save($result, $key); }, -100);
Note: The above could have been done within a ListenerAggregate, which would have allowed keeping the $cache instance as a stateful property, instead of importing it into closures. Another approach would be to move the body of the method to a listener as well, which would allow using the priority system in order to implement caching. That would look like this:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
public function setEventManager(EventManagerInterface $events) { $this->events = $events; $events->setIdentifiers(array(__CLASS__, get_class($this))); $events->attach(someExpensiveCall, array($this, doSomeExpensiveCall)); } public function someExpensiveCall($criteria1, $criteria2) { $params = compact(criteria1, criteria2); $results = $this->getEventManager()->trigger( __FUNCTION__, $this, $params, function ($r) { return ($r instanceof SomeResultClass); } ); return $results->last(); }
82
22 23 24 25 26 27
public function doSomeExpensiveCall($e) { // ... do some work ... $e->setParam(__RESULT__, $calculatedResult); return $calculatedResult; }
The listeners would then attach to the someExpensiveCall event, with the cache lookup listener listening at high priority, and the cache storage listener listening at low (negative) priority. Sure, we could probably simply add caching to the object itself - but this approach allows the same handlers to be attached to multiple events, or to attach multiple listeners to the same events (e.g. an argument validator, a logger and a cache manager). The point is that if you design your object with events in mind, you can easily make it more exible and extensible, without requiring developers to actually extend it they can simply attach listeners.
17.6 Conclusion
The EventManager is a powerful component. It drives the workow of the MVC layer, and is used in countless components to provide hook points for developers to manipulate the workow. It can be put to any number of uses inside your own code, and is an important part of your Zend Framework toolbox.
17.6. Conclusion
83
84
CHAPTER 18
Conguration of Zend Framework 2 applications happens in several steps: Initial conguration is passed to the Application instance and used to seed the ModuleManager and ServiceManager. In this tutorial, we will call this conguration system conguration. The ModuleManagers ConfigListener aggregates conguration and merges it while modules are being loaded. In this tutorial, we will call this conguration application conguration. Once conguration is aggregated from all modules, the ConfigListener will also merge application conguration globbed in specied directories (typically config/autoload/). In this tutorial, well look at the exact sequence, and how you can tie into it.
is
by
default
in
<?php return array( // This should be an array of module namespaces used in the application. modules => array( Application, ), // These are various options for the listeners attached to the ModuleManager module_listener_options => array( // This should be an array of paths in which modules reside. // If a string key is provided, the listener will consider that a module // namespace, the value of that key the specific path to that modules // Module class. module_paths => array( ./module, ./vendor,
85
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
), // An array of paths from which to glob configuration files after // modules are loaded. These effectively overide configuration // provided by modules themselves. Paths may use GLOB_BRACE notation. config_glob_paths => array( config/autoload/{,*.}{global,local}.php, ), // Whether or not to enable a configuration cache. // If enabled, the merged configuration will be cached and used in // subsequent requests. //config_cache_enabled => $booleanValue, // The key used to create the configuration cache file name. //config_cache_key => $stringKey, // Whether or not to enable a module class map cache. // If enabled, creates a module class map cache which will be used // by in future requests, to reduce the autoloading process. //module_map_cache_enabled => $booleanValue, // The key used to create the class map cache file name. //module_map_cache_key => $stringKey, // The path in which to cache merged configuration. //cache_dir => $stringPath, // // // // ), // Used to create an own service manager. May contain one or more child arrays. //service_listener_options => array( // array( // service_manager => $stringServiceManagerName, // config_key => $stringConfigKey, // interface => $stringOptionalInterface, // method => $stringRequiredMethodName, // ), // ) // Initial configuration with which to seed the ServiceManager. // Should be compatible with Zend\ServiceManager\Config. // service_manager => array(), ); Whether or not to enable modules dependency checking. Enabled by default, prevents usage of modules that depend on other modules that werent loaded. check_dependencies => true,
The system conguration is for the bits and pieces related to the MVC that run before your application is ready. The conguration is usually brief, and quite minimal. Also, system conguration is used immediately, and is not merged with any other conguration which means it cannot be overridden by a module. This leads us to our rst trick: how do you provide environment-specic system conguration?
86
For other web servers, consult the web server documentation to determine how to set environment variables. To simplify matters, well assume the environment is production if no environment variable is present. Well modify the config/application.config.php le to read as follows:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
<?php $env = getenv(APP_ENV) ?: production; // Use the $env value to determine which modules to load $modules = array( Application, ); if ($env == development) { $modules[] = ZendDeveloperTools; } return array( modules => $modules, module_listener_options => array( module_paths => array( ./module, ./vendor, ), config_glob_paths => array( config/autoload/{,*.}{global,local}.php, ), // Use the $env value to determine the state of the flag config_cache_enabled => ($env == production), config_cache_key => app_config, // Use the $env value to determine the state of the flag module_map_cache_enabled => ($env == production), module_map_cache_key => module_map, cache_dir => data/config/,
87
36 37 38 39 40
// Use the $env value to determine the state of the flag check_dependencies => ($env != production), ), );
This approach gives you exibility to alter system-level settings. However, how about altering application specic settings (not system conguration) based on the environment?
The above will allow you to dene an additional set of application conguration les per environment; furthermore, these will be loaded only if that environment is detected! As an example, consider the following tree of conguration les:
config/ autoload/ global.php local.php users.development.php users.testing.php users.local.php
If $env evaluates to testing, then the following les will be merged, in the following order:
88
Note that users.development.php is not loaded this is because it will not match the glob pattern! Also, because of the order in which they are loaded, you can predict which values will overwrite the others, allowing you to both selectively overwrite as well as debug later. Note: The les under config/autoload/ are merged after your module conguration, detailed in next section. We have detailed it here, however, as setting up the application conguration glob path happens within the system conguration (config/application.config.php).
where module.config.php returns a PHP array. From that PHP array you can provide general conguration as well as conguration for all the available Manager classes provided by the ServiceManager. Please refer to the Conguration mapping table to see which conguration key is used for each specic Manager. Second, modules can implement a number of interfaces and/or methods related to specic service manager or plugin manager conguration. You will nd an overview of all interfaces and their matching Module Conguration functions inside the Conguration mapping table. All interfaces are in the Zend\ModuleManager\Feature namespace, and each is expected to return an array of conguration for a service manager, as denoted in the section on default service conguration.
89
91
92
CHAPTER 19
In this tutorial we will use the Zend\Navigation component to add a navigation menu to the black bar at the top of the screen, and add breadcrumbs above the main site content.
19.1 Preparation
In a real world application, the album browser would be only a portion of a working website. Usually the user would land on a homepage rst, and be able to view albums by using a standard navigation menu. So that we have a site that is more realistic than just the albums feature, lets make the standard skeleton welcome page our homepage, with the /album route still showing our album module. In order to make this change, we need to undo some work we did earlier. Currently, navigating to the root of your app (/) routes you to the AlbumControllers default action. Lets undo this route change so we have two discrete entry points to the app, a home page, and an albums area. module/Application/config/module.config.php
1 2 3 4 5 6 7 8 9 10
home => array( type => Zend\Mvc\Router\Http\Literal, options => array( route => /, defaults => array( controller => Application\Controller\Index, // <-- change back here action => index, ), ), ),
This change means that if you go to the home page of your application (http://zf2-tutorial.localhost/), you see the default skeleton application introduction. Your list of albums is still available at the /album route.
93
factory, we simply add a navigation key to the service manager. Its best to do this in the Application module, because, like the translation data, this is specic to the entire application, and not just to our album pages: module/Application/config/module.config.php
1 2 3 4 5 6
service_manager => array( factories => array( translator => Zend\I18n\Translator\TranslatorServiceFactory, navigation => Zend\Navigation\Service\DefaultNavigationFactory, // <-- add this ), ),
return array( ... navigation => array( default => array( array( label => Home, route => home, ), array( label => Album, route => album, pages => array( array( label => Add, route => album, action => add, ), array( label => Edit, route => album, action => edit, ), array( label => Delete, route => album, action => delete, ), ), ), ), ), ... );
This conguration maps out the pages weve dened in our controller, with labels linking to the given route names. You can dene highly complex hierarchical sites here with pages and sub-pages linking to route names, controller/action pairs or external uris. For more information see the docs here.
94
... <a class="brand" href="<?php echo $this->url(home) ?>"><?php echo $this->translate(Skeleton Application) ? <?php // <-- Add this !! echo $this->navigation(navigation)->menu(); ?> ...
The navigation helper is built in to Zend Framework 2, and uses the service manager conguration weve already dened to congure itself automatically. Refreshing your application you will see a working menu, with just a few tweaks however, we can make it look awesome: module/Application/view/layout/layout.phtml
1 2 3 4 5 6 7 8 9
<a class="brand" href="<?php echo $this->url(home) ?>"><?php echo $this->translate(Skeleton Application) ?></a <?php // <-- Update this !! echo $this->navigation(navigation) ->menu() ->setMinDepth(0) ->setMaxDepth(0) ->setUlClass(nav); ?>
Here we tell the renderer to give the root UL the class of nav so that Twitter Bootstrap styles the menu correctly, and only render the rst level of any given page. If you view your application in your browser, you will now see a nicely styled menu appear in the title bar. The great thing about Zend\Navigation is that it integrates with ZF2s route so can tell which page you are currently viewing. Because of this, it sets the active page to have a class of active in the menu. Twitter Bootstrap uses this to highlight your current page accordingly.
... <div class="container"> <?php echo $this->navigation(navigation)->breadcrumbs()->setMinDepth(0); // <-- Add this!! ?> <?php echo $this->content; ?> </div> ...
This adds a simple but functional breadcrumb to every page (we simply tell it to render from a depth of 0 so we see all level of pages) but we can do better than that! Because Bootstrap has a styled breadcrumb as part of its base CSS, so lets add a partial that outputs the UL in bootstrap happy CSS. Well create it in the view directory of the Application module (this partial is application wide, rather than album specic): module/Application/view/partial/breadcrumb.phtml
95
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
<ul class="breadcrumb"> <?php // iterate through the pages foreach ($this->pages as $key => $page): ?> <li> <?php // if this isnt the last page, add a link and the separator if ($key < count($this->pages) - 1): ?> <a href="<?php echo $page->getHref(); ?>"><?php echo $page->getLabel(); ?></a> <span class="divider">/</span> <?php // otherwise, just output the name else: ?> <?php echo $page->getLabel(); ?> <?php endif; ?> </li> <?php endforeach; ?> </ul>
Notice how the partial is passed a Zend\View\Model\ViewModel instance with the pages property set to an array of pages to render. Now all we have to do is tell the breadcrumb helper to use the partial we have just written: module/Application/view/layout/layout.phtml
1 2 3 4 5 6 7 8 9 10 11
... <div class="container"> <?php echo $this->navigation(navigation) // <-- Update this!! ->breadcrumbs() ->setMinDepth(0) ->setPartial(array(partial/breadcrumb.phtml, Album)); ?> <?php echo $this->content; ?> </div> ...
Refreshing the page now gives us a lovely styled set of breadcrumbs on each page.
96
CHAPTER 20
In this tutorial we will use the Zend\Paginator component to add a handy pagination controller to the bottom of the album list. Currently, we only have a handful of albums to display, so showing everything on one page is not a problem. However, how will the album list look when we have 100 albums or more in our database? The standard solution to this problem is to split the data up into a number of pages, and allow the user to navigate around these pages using a pagination control. Just type Zend Framework into Google, and you can see their pagination control at the bottom of the page:
20.1 Preparation
In order for us to have lots of albums in our database, youll need to run the following SQL insert statement to insert the current 150 top iTunes albums (at the time of writing!):
INSERT INTO album (artist, title) VALUES (David Bowie, The Next Day (Deluxe Version)), (Bastille, Bad Blood), (Bruno Mars, Unorthodox Jukebox), (Emeli Sand, Our Version of Events (Special Edition)), (Bon Jovi, What About Now (Deluxe Version)), (Justin Timberlake, The 20/20 Experience (Deluxe Version)), (Bastille, Bad Blood (The Extended Cut)), (P!nk, The Truth About Love), (Sound City - Real to Reel, Sound City - Real to Reel), (Jake Bugg, Jake Bugg), (Various Artists, The Trevor Nelson Collection),
97
(David Bowie, The Next Day), (Mumford & Sons, Babel), (The Lumineers, The Lumineers), (Various Artists, Get Ur Freak On - R&B Anthems), (The 1975, Music For Cars EP), (Various Artists, Saturday Night Club Classics - Ministry of Sound), (Hurts, Exile (Deluxe)), (Various Artists, Mixmag - The Greatest Dance Tracks of All Time), (Ben Howard, Every Kingdom), (Stereophonics, Graffiti On the Train), (The Script, #3), (Stornoway, Tales from Terra Firma), (David Bowie, Hunky Dory (Remastered)), (Worship Central, Let It Be Known (Live)), (Ellie Goulding, Halcyon), (Various Artists, Dermot O\Leary Presents the Saturday Sessions 2013), (Stereophonics, Graffiti On the Train (Deluxe Version)), (Dido, Girl Who Got Away (Deluxe)), (Hurts, Exile), (Bruno Mars, Doo-Wops & Hooligans), (Calvin Harris, 18 Months), (Olly Murs, Right Place Right Time), (Alt-J (?), An Awesome Wave), (One Direction, Take Me Home), (Various Artists, Pop Stars), (Various Artists, Now That\s What I Call Music! 83), (John Grant, Pale Green Ghosts), (Paloma Faith, Fall to Grace), (Laura Mvula, Sing To the Moon (Deluxe)), (Duke Dumont, Need U (100%) [feat. A*M*E] - EP), (Watsky, Cardboard Castles), (Blondie, Blondie: Greatest Hits), (Foals, Holy Fire), (Maroon 5, Overexposed), (Bastille, Pompeii (Remixes) - EP), (Imagine Dragons, Hear Me - EP), (Various Artists, 100 Hits: 80s Classics), (Various Artists, Les Misrables (Highlights From the Motion Picture Soundtrack)), (Mumford & Sons, Sigh No More), (Frank Ocean, Channel ORANGE), (Bon Jovi, What About Now), (Various Artists, BRIT Awards 2013), (Taylor Swift, Red), (Fleetwood Mac, Fleetwood Mac: Greatest Hits), (David Guetta, Nothing But the Beat Ultimate), (Various Artists, Clubbers Guide 2013 (Mixed By Danny Howard) - Ministry of Sound), (David Bowie, Best of Bowie), (Laura Mvula, Sing To the Moon), (ADELE, 21), (Of Monsters and Men, My Head Is an Animal), (Rihanna, Unapologetic), (Various Artists, BBC Radio 1\s Live Lounge - 2012), (Avicii & Nicky Romero, I Could Be the One (Avicii vs. Nicky Romero)), (The Streets, A Grand Don\t Come for Free), (Tim McGraw, Two Lanes of Freedom), (Foo Fighters, Foo Fighters: Greatest Hits), (Various Artists, Now That\s What I Call Running!), (Swedish House Mafia, Until Now),
98
(The xx, Coexist), (Five, Five: Greatest Hits), (Jimi Hendrix, People, Hell & Angels), (Biffy Clyro, Opposites (Deluxe)), (The Smiths, The Sound of the Smiths), (The Saturdays, What About Us - EP), (Fleetwood Mac, Rumours), (Various Artists, The Big Reunion), (Various Artists, Anthems 90s - Ministry of Sound), (The Vaccines, Come of Age), (Nicole Scherzinger, Boomerang (Remixes) - EP), (Bob Marley, Legend (Bonus Track Version)), (Josh Groban, All That Echoes), (Blue, Best of Blue), (Ed Sheeran, +), (Olly Murs, In Case You Didn\t Know (Deluxe Edition)), (Macklemore & Ryan Lewis, The Heist (Deluxe Edition)), (Various Artists, Defected Presents Most Rated Miami 2013), (Gorgon City, Real EP), (Mumford & Sons, Babel (Deluxe Version)), (Various Artists, The Music of Nashville: Season 1, Vol. 1 (Original Soundtrack)), (Various Artists, The Twilight Saga: Breaking Dawn, Pt. 2 (Original Motion Picture Soundtrack) (Various Artists, Mum - The Ultimate Mothers Day Collection), (One Direction, Up All Night), (Bon Jovi, Bon Jovi Greatest Hits), (Agnetha Fltskog, A), (Fun., Some Nights), (Justin Bieber, Believe Acoustic), (Atoms for Peace, Amok), (Justin Timberlake, Justified), (Passenger, All the Little Lights), (Kodaline, The High Hopes EP), (Lana Del Rey, Born to Die), (JAY Z & Kanye West, Watch the Throne (Deluxe Version)), (Biffy Clyro, Opposites), (Various Artists, Return of the 90s), (Gabrielle Aplin, Please Don\t Say You Love Me - EP), (Various Artists, 100 Hits - Driving Rock), (Jimi Hendrix, Experience Hendrix - The Best of Jimi Hendrix), (Various Artists, The Workout Mix 2013), (The 1975, Sex), (Chase & Status, No More Idols), (Rihanna, Unapologetic (Deluxe Version)), (The Killers, Battle Born), (Olly Murs, Right Place Right Time (Deluxe Edition)), (A$AP Rocky, LONG.LIVE.A$AP (Deluxe Version)), (Various Artists, Cooking Songs), (Haim, Forever - EP), (Lianne La Havas, Is Your Love Big Enough?), (Michael Bubl, To Be Loved), (Daughter, If You Leave), (The xx, xx), (Eminem, Curtain Call), (Kendrick Lamar, good kid, m.A.A.d city (Deluxe)), (Disclosure, The Face - EP), (Palma Violets, 180), (Cody Simpson, Paradise), (Ed Sheeran, + (Deluxe Version)),
20.1. Preparation
99
(Michael Bubl, Crazy Love (Hollywood Edition)), (Bon Jovi, Bon Jovi Greatest Hits - The Ultimate Collection), (Rita Ora, Ora), (g33k, Spabby), (Various Artists, Annie Mac Presents 2012), (David Bowie, The Platinum Collection), (Bridgit Mendler, Ready or Not (Remixes) - EP), (Dido, Girl Who Got Away), (Various Artists, Now That\s What I Call Disney), (The 1975, Facedown - EP), (Kodaline, The Kodaline - EP), (Various Artists, 100 Hits: Super 70s), (Fred V & Grafix, Goggles - EP), (Biffy Clyro, Only Revolutions (Deluxe Version)), (Train, California 37), (Ben Howard, Every Kingdom (Deluxe Edition)), (Various Artists, Motown Anthems), (Courteeners, ANNA), (Johnny Marr, The Messenger), (Rodriguez, Searching for Sugar Man), (Jessie Ware, Devotion), (Bruno Mars, Unorthodox Jukebox), (Various Artists, Call the Midwife (Music From the TV Series) );
This gives us a handy extra 150 rows to play with. If you now visit your album list at /album, youll see a huge long list of 150+ albums, its ugly.
<?php namespace Album\Model; use use use use use Zend\Db\ResultSet\ResultSet; Zend\Db\TableGateway\TableGateway; Zend\Db\Sql\Select; Zend\Paginator\Adapter\DbSelect; Zend\Paginator\Paginator;
class AlbumTable { ... public function fetchAll($paginated=false) { if($paginated) { // create a new Select object for the table album $select = new Select(album); // create a new result set based on the Album entity
100
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
$resultSetPrototype = new ResultSet(); $resultSetPrototype->setArrayObjectPrototype(new Album()); // create a new pagination adapter object $paginatorAdapter = new DbSelect( // our configured select object $select, // the adapter to run it against $this->tableGateway->getAdapter(), // the result set to hydrate $resultSetPrototype ); $paginator = new Paginator($paginatorAdapter); return $paginator; } $resultSet = $this->tableGateway->select(); return $resultSet; } ...
This will return a fully congured Paginator object. Weve already told the DbSelect adapter to use our created Select object, to use the adapter that the TableGateway object uses, and also how to hydrate the result into a Album entity in the same fashion as the TableGateway does. This means that our executed and returned paginator results will return Album objects in exactly the same fashion as the non-paginated results.
... public function indexAction() { // grab the paginator from the AlbumTable $paginator = $this->getAlbumTable()->fetchAll(true); // set the current page to what has been passed in query string, or to 1 if none set $paginator->setCurrentPageNumber((int)$this->params()->fromQuery(page, 1)); // set the number of items per page to 10 $paginator->setItemCountPerPage(10); return new ViewModel(array( paginator => $paginator )); } ...
Here we are getting the congured Paginator object from the AlbumTable, and then telling it to use the page that is optionally passed in the querystring page parameter. We are also telling the paginator we want to display 10 objects per page.
module/Album/view/album/album/index.phtml
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
<table class="table"> <tr> <th>Title</th> <th>Artist</th> <th> </th> </tr> <?php foreach ($this->paginator as $album) : // <-- change here! ?> <tr> <td><?php echo $this->escapeHtml($album->title);?></td> <td><?php echo $this->escapeHtml($album->artist);?></td> <td> <a href="<?php echo $this->url(album, array(action => edit, id => $album->id));?>">Edit</a> <a href="<?php echo $this->url(album, array(action => delete, id => $album->id));?>">Delete</a> </td> </tr> <?php endforeach; ?> </table>
Checking the /album route on your website should now give you a list of just 10 albums, but with no method to navigate through the pages. Lets correct that now...
<?php if ($this->pageCount): ?> <div class="pagination pagination-centered"> <ul> <!-- Previous page link --> <?php if (isset($this->previous)): ?> <li> <a href="<?php echo $this->url($this->route); ?>?page=<?php echo $this->previous << </a> </li> <?php else: ?> <li class="disabled"> <a href="#"> << </a> </li> <?php endif; ?> <!-- Numbered page links --> <?php foreach ($this->pagesInRange as $page): ?> <?php if ($page != $this->current): ?> <li>
102
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
<a href="<?php echo $this->url($this->route);?>?page=<?php echo $page; ?>"> <?php echo $page; ?> </a> </li> <?php else: ?> <li class="active"> <a href="#"><?php echo $page; ?></a> </li> <?php endif; ?> <?php endforeach; ?>
<!-- Next page link --> <?php if (isset($this->next)): ?> <li> <a href="<?php echo $this->url($this->route); ?>?page=<?php echo $this->next; ?> >> </a> </li> <?php else: ?> <li class="disabled"> <a href="#"> >> </a> </li> <?php endif; ?> </ul> </div> <?php endif; ?>
All this partial does is to create a pagination control with links to the correct pages (if there is more than one page in the pagination object). It will render a previous page link (and mark it disabled if you are at the rst page), then render a list of intermediate pages (that are passed to the partial based on the rendering style well set in the view helper in the next step). Finally, it will create a next page link (and disable it if youre at the end). Notice how we pass the page number via the page querystring parameter which we have already told our controller to use to display the current page.
103
104
CHAPTER 21
The only thing left for us to do so that we can page through the albums is to use the paginationControl view helper to display our pagination control. This is nicely straightforward as we have already done all the ground work needed to display the control: module/Album/view/album/album/index.phtml
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
... <?php // add at the end of the file after the table echo $this->paginationControl( // the paginator object $this->paginator, // the scrolling style sliding, // the partial to use to render the control array(partial/paginator.phtml, Album), // the route to link to when a user clicks a control link array( route => album ) ); ?>
All we need to do here is to echo the paginationControl helper, and tell it to use our paginator object, sliding scrolling style, our paginator partial, and which route to use for clicks. Refreshing your application should give you a lovely bootstrap styled pagination control!
105
106
CHAPTER 22
22.1 Introduction
In most cases, e.g. in your controllers, your database adapter can be fetched directly from the service manager. Some classes however, like Zend\Validator\DbRecordExists isnt aware of the service manager, but still needs an adapter to function. There are many different ways to provide this functionality to your application. Below are a few examples.
// config/autoload/global.php return array( db => array( driver => Pdo, dsn => mysql:dbname=zf2tutorial;host=localhost, ), service_manager => array( factories => array( Zend\Db\Adapter\Adapter => Zend\Db\Adapter\AdapterServiceFactory, ), ), );
public function getAdapter() { if (!$this->adapter) { $sm = $this->getServiceLocator(); $this->adapter = $sm->get(Zend\Db\Adapter\Adapter); } return $this->adapter; }
107
More information on adapter options can be found in the docs for Zend\Db\Adapter.
// config/autoload/global.php return array( db => array( driver => Pdo, dsn => mysql:dbname=zf2tutorial;host=localhost, ), service_manager => array( factories => array( Zend\Db\Adapter\Adapter => function ($serviceManager) { $adapterFactory = new Zend\Db\Adapter\AdapterServiceFactory(); $adapter = $adapterFactory->createService($serviceManager); \Zend\Db\TableGateway\Feature\GlobalAdapterFeature::setStaticAdapter($adapter); return $adapter; } ), ), );
The adapter can then later be fetched using Zend\Db\TableGateway\Feature\GlobalAdapterFeature::getStaticAda for use in e.g. Zend\Validator\DbRecordExists:
1 2 3 4 5 6 7
$validator = new Zend\Validator\Db\RecordExists( array( table => users, field => emailaddress, adapter => \Zend\Db\TableGateway\Feature\GlobalAdapterFeature::getStaticAdapter() ) );
108
CHAPTER 23
This guide is intended to provide tools and strategies for migrating from Zend Framework 1 to Zend Framework 2. There is no single solution that will work for every project, nor any tools to automate the process. In this guide, we will cover the following: Tools for namespacing your code. Tools for consuming Zend Framework 2 within your Zend Framework 1 application. Strategies for running Zend Framework 2 and Zend Framework 1 in parallel. Strategies for making your code easier to migrate, focussing primarily on clean separation of your domain logic and the MVC layer. Strategies for migrating the MVC layer. Strategies for migrating your domain layer.
109
110
CHAPTER 24
ZF2s minimal version is PHP 5.3. The most notable feature of PHP 5.3 is the addition of namespaces, which ZF2 fully embraces. Moreover, new projects built on ZF2 also fully embrace PHP namespaces. The addition of namespaces to PHP has greatly improved the readability of long class names and has helped better organize code into modules and components. This transition has also given birth to some naming best practices that help developers organize their code bases consisting of classes, components, and modules in a consistent and clean fashion. Converting an older code base that follows the original PEAR/ZF underscore separated class naming convention into a properly namespaced codebase is one of the easier strategies to employ in both modernizing your code base as well as getting ready to ZF2-ify your ZF1 application. Weve created a tool to help in this endeavor, it is located here: https://github.com/zendframework/Namespacer This tool will take a wholesale approach to converting older code like the following:
class My_Long_NestedComponent_ClassName { // methods that use other classes }
into:
namespace My\Long\NestedComponent; use Other\Classes; use Something\ElseConsumed; class ClassName { // methods with classes converted to short name from use statement. }
Some IDEs have this capability to some degree. That said, a good approach might be to use the command line Namespacer to do a full sweep of your codebase, then use the IDE to make more specic naming changes that might makes more sense to your application.
111
It would not be a good strategy to attempt to do a wholesale namespacing of this kind of project for a number of reasons: 1. ZF1 has special, context-aware autoloaders that will assist loading a class of a particular context from a special location on disk. For example, ZF1 understands controllers will be located in the controllers directory and will not be prexed unless they are inside of a named modules controllers directory. 2. Attempting to apply namespacing to controller classes would generally render a ZF1 application useless. ZF1, beyond loading les from disk, assumes controllers will have a very specic naming convention so that they can be invoked by the framework upon routing and dispatching. 3. Beyond dispatching, ZF1 uses the class name to identify and map the proper view script to automatically execute. 112 Chapter 24. Namespacing Old Classes
By naming the controller something non-standard, views will no longer this this 1:1 mapping of controllers by name to controller action named view scripts. A better solution would be to start by namespacing the parts of your ZF1 application that have fewer tie-ins with the ZF1 architecture. The place to start with this is models and forms. Since models and forms do not touch controller and view classes (which make heavy use of ZF1 classes by way of inheritance), model and form classes might not have the same level of coupling.
<?php return array ( array ( root_directory => /realpath/to/project/application/models, original_class => Application_Model_Invoice, original_file => /realpath/to/project/application/models/Invoice.php, new_namespace => Application\\Model, new_class => Invoice, new_file => /realpath/to/project/application/models/Application/Model/Invoice.php, ), ... );
This gives you an opportunity to manually edit the transformations if you so desire. While you can modify this le, you also might nd it to be easier to go with the default transformations, and do the remaining changes with your IDEs refactoring utility. Once you are happy with the map le, run the transformations:
namespacer.phar transform --mapfile model-map.php
At this point, you can use your version control systems status command to see how the directory has transformed. As an example, in a sample project of mine, git reports the following:
renamed: new file: renamed: renamed: renamed: renamed: new file: renamed: renamed:
models/DbTable/Invoice.php -> models/Application/Model/DbTable/Invoice.php models/Application/Model/DbTable/Transaction.php models/Invoice.php -> models/Application/Model/Invoice.php models/Payment/Paypal/DirectPayment.php -> models/Application/Model/Payment/Paypal/DirectPa models/PurchaseOrder.php -> models/Application/Model/PurchaseOrder.php models/PurchaseOrderRepository.php -> models/Application/Model/PurchaseOrderRepository.php models/Application/Model/PurchaseOrderService.php models/Purchaser.php -> models/Application/Model/Purchaser.php models/Ticket.php -> models/Application/Model/Ticket.php
113
Youll notice that the resulting les have treated the models/ directory as the autoloader root directory. That means that from this root, class les follow the strict PEAR/ZF2 classle naming convention. The contents of one of the les will look like this:
1 2 3 4 5 6 7 8 9 10 11 12 13 14
namespace Application\Model; use Application\Model\PurchaseOrder; use Application\Model\Transaction; use Zend_Filter_Alnum; class Invoice { protected $tickets; protected $transaction; ... }
Things to notice here: A namespace has been created for this class. The namespacer has created PHP use statements for classes known in the map le. Unknown classes are also included (for example, Zend classes) in use statements. By keeping the old ZF1 classes, your models should continue to work if they consume ZF1 classes. This will allow you to, at your own pace, transition your codebase to ZF2. This same procedure can largely be adapted to forms and independent library code as well.
114
CHAPTER 25
From a technical point of view it is absolutely possible to run ZF2 in parallel with ZF1 because there is no conict between the classnames due to the fact that ZF2 uses namespaces and ZF1 does not. Running ZF1 and ZF2 in parallel can be used as a migration strategy in projects where it is not possible, or not convenient, to migrate an entire application from ZF1 to ZF2. For instance, you could implement any new features of the application using ZF2, while maintaining original ZF1 features. Lets examine some scenarios on how to execute ZF1 and ZF2 together.
define(ZF2_PATH, /path/to/zf2/library); require_once ZF2_PATH . /Zend/Loader/StandardAutoloader.php; $loader = new Zend\Loader\StandardAutoloader(array( autoregister_zf => true, )); $loader->register();
We used the StandardAutoloader class from ZF2. Using this autoloader, classes with the initial namespace Zend will be loaded using the ZF2_PATH, and any ZF1 classes will continue to be loaded via the mechanisms present in ZF1. Of course, this is not a real integration of ZF2 inside ZF1; it only provides the ability to consume ZF2 classes within your ZF1 application. For instance, you cannot use the MVC architecture of ZF2 because you are using the MVC of ZF1. Evan Coury, a member of the ZF community review team, has produced a nice module for ZF1 (zf-2-for-1) that allows you to use ZF2 features inside an existing ZF1 application. This module offers some basic integrations like the usage of ZF2 view helpers in the ZF1 view layer (i.e. $this->zf2->get(formRow)).
115
After executing composer.phar update, you can start to use ZF1 classes in your ZF2 project. Since all ZF1 classes exist in the global namespace, you will need to refer to them by their full name; as examples, Zend_Date, Zend_Feed_Reader, etc. For other strategies on how to use ZF1 in a ZF2 project, you can check out this blog post by Abdul Malik Ikhsan, Zend Framework 2 : Using Zend Framework 1 libraries.
SetEnv APPLICATION_ENV development RewriteEngine On RewriteCond %{REQUEST_FILENAME} -s [OR] RewriteCond %{REQUEST_FILENAME} -l [OR] RewriteCond %{REQUEST_FILENAME} -d RewriteRule ^.*$ - [NC,L] RewriteRule ^album(/.*)?$ index_zf2.php [NC,L] RewriteRule ^.*$ index.php [NC,L]
index_zf2.php is a PHP script that includes as the typical public/index.php le of ZF2. Here is the source code for index_zf2.php:
1
require_once ../path-to-ZF2-app/public/index.php;
We suggest putting the ZF2 application in a separate folder under the same root directory of the ZF1 application. In this way you can continue to maintain the existing ZF1 code and use ZF2 only for the new features. Moreover, if you want to migrate the old code you can do that by URL and switch to the new ZF2 code only when you are ready. This approach can be useful to provide migration guideline without losing development time in a full stack migration. Note: All web servers support a rewriting mechanism. For instance, if you are using Microsoft IIS 7_, you can check how to congure the rewriting rules from Rob Allens post Zend Framework URL Rewriting in IIS7; if you are using nginx, you can check out this StackOverow question: Zend Framework on nginx. 116 Chapter 25. Running Zend Framework 2 and Zend Framework 1 in parallel
117
118
CHAPTER 26
Introduction to Zend\Authentication
The Zend\Authentication component provides an API for authentication and includes concrete authentication adapters for common use case scenarios. Zend\Authentication is concerned only with authentication and not with authorization. Authentication is loosely dened as determining whether an entity actually is what it purports to be (i.e., identication), based on some set of credentials. Authorization, the process of deciding whether to allow an entity access to, or to perform operations upon, other entities is outside the scope of Zend\Authentication. For more information about authorization and access control with Zend Framework, please see the Zend\Permissions\Acl or Zend\Permissions\Rbac component. Note: There is no Zend\Authentication\Authentication class, instead the class Zend\Authentication\AuthenticationService is provided. This class uses underlying authentication adapters and persistent storage backends.
26.1 Adapters
Zend\Authentication adapters are used to authenticate against a particular type of authentication service, such as LDAP, RDBMS, or le-based storage. Different adapters are likely to have vastly different options and behaviors, but some basic things are common among authentication adapters. For example, accepting authentication credentials (including a purported identity), performing queries against the authentication service, and returning results are common to Zend\Authentication adapters. Each Zend\Authentication adapter class implements Zend\Authentication\Adapter\AdapterInterface. This interface denes one method, authenticate(), that an adapter class must implement for performing an authentication query. Each adapter class must be prepared prior to calling authenticate(). Such adapter preparation includes setting up credentials (e.g., username and password) and dening values for adapter-specic conguration options, such as database connection settings for a database table adapter. The following is an example authentication adapter that requires a username and password to be set for authentication. Other details, such as how the authentication service is queried, have been omitted for brevity:
1 2 3 4 5 6
use Zend\Authentication\Adapter\AdapterInterface; class My\Auth\Adapter implements AdapterInterface { /** * Sets username and password for authentication
119
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
* * @return void */ public function __construct($username, $password) { // ... } /** * Performs an authentication attempt * * @return \Zend\Authentication\Result * @throws \Zend\Authentication\Adapter\Exception\ExceptionInterface If authentication cannot be performed * */ public function authenticate() { // ... } }
As indicated in its docblock, authenticate() must return an instance of Zend\Authentication\Result (or of a class derived from Zend\Authentication\Result). If for some reason performing an authentication query is impossible, authenticate() should throw an exception that derives from Zend\Authentication\Adapter\Exception\ExceptionInterface.
26.2 Results
Zend\Authentication adapters return an instance of Zend\Authentication\Result with authenticate() in order to represent the results of an authentication attempt. Adapters populate the Zend\Authentication\Result object upon construction, so that the following four methods provide a basic set of user-facing operations that are common to the results of Zend\Authentication adapters: isValid()- returns TRUE if and only if the result represents a successful authentication attempt getCode()- returns a Zend\Authentication\Result constant identier for determining the type of authentication failure or whether success has occurred. This may be used in situations where the developer wishes to distinguish among several authentication result types. This allows developers to maintain detailed authentication result statistics, for example. Another use of this feature is to provide specic, customized messages to users for usability reasons, though developers are encouraged to consider the risks of providing such detailed reasons to users, instead of a general authentication failure message. For more information, see the notes below. getIdentity()- returns the identity of the authentication attempt getMessages()- returns an array of messages regarding a failed authentication attempt A developer may wish to branch based on the type of authentication result in order to perform more specic operations. Some operations developers might nd useful are locking accounts after too many unsuccessful password attempts, agging an IP address after too many nonexistent identities are attempted, and providing specic, customized authentication result messages to the user. The following result codes are available:
1 2 3 4 5 6
120
7 8
Result::FAILURE_CREDENTIAL_INVALID Result::FAILURE_UNCATEGORIZED
The following example illustrates how a developer may branch on the result code:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
// inside of AuthController / loginAction $result = $this->auth->authenticate($adapter); switch ($result->getCode()) { case Result::FAILURE_IDENTITY_NOT_FOUND: /** do stuff for nonexistent identity **/ break; case Result::FAILURE_CREDENTIAL_INVALID: /** do stuff for invalid credential **/ break; case Result::SUCCESS: /** do stuff for successful authentication **/ break; default: /** do stuff for other failure **/ break; }
121
Zend\Authentication\Storage\Session uses a session namespace of Zend_Auth. This namespace may be overridden by passing a different value to the constructor of Zend\Authentication\Storage\Session, and this value is internally passed along to the constructor of Zend\Session\Container. This should occur before authentication is attempted, since Zend\Authentication\AuthenticationService::authenticate() performs the automatic storage of the identity.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
use Zend\Authentication\AuthenticationService; use Zend\Authentication\Storage\Session as SessionStorage; $auth = new AuthenticationService(); // Use someNamespace instead of Zend_Auth $auth->setStorage(new SessionStorage(someNamespace)); /** * @todo Set up the auth adapter, $authAdapter */ // Authenticate, saving the result, and persisting the identity on // success $result = $auth->authenticate($authAdapter);
$storage = new Chain; $storage->add(new Session); $storage->add(new OAuth); // Note: imaginary storage, not part of ZF2
Now if the Chain Storage is accessed its underlying Storage will get accessed in the order in which they were added to the chain. Thus rst the Session Storage is used. Now either: The Session Storage is non-empty and the Chain will use its contents. The Sesssion Storage is empty. Next the OAuth Storage is accessed. If this one is also empty the Chain will act as empty. If this one is non-empty the Chain will use its contents. However it will also populate all Storage with higher priority. Thus the Session Storage will be populated with the contents of the Oauth Storage. The priority of Storage in the Chain can be made explicit via the Chain::add method.
1 2
122
In order to use an identity persistence storage class other than Zend\Authentication\Storage\Session, a developer implements Zend\Authentication\Storage\StorageInterface:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
use Zend\Authentication\Storage\StorageInterface; class My\Storage implements StorageInterface { /** * Returns true if and only if storage is empty * * @throws \Zend\Authentication\Exception\ExceptionInterface If it is impossible to * determine whether storage is empty * * @return boolean */ public function isEmpty() { /** * @todo implementation */ } /** * Returns the contents of storage * * Behavior is undefined when storage is empty. * * @throws \Zend\Authentication\Exception\ExceptionInterface If reading contents from storage is impossible * * @return mixed */ public function read() { /** * @todo implementation */ } /** * Writes $contents to storage * * @param mixed $contents * @throws \Zend\Authentication\Exception\ExceptionInterface If writing $contents to storage is impossible * * @return void */ public function write($contents) { /** * @todo implementation
123
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
*/ } /** * Clears contents from storage * * @throws \Zend\Authentication\Exception\ExceptionInterface If clearing contents from storage is impossible * * @return void */ public function clear() { /** * @todo implementation */ } }
In order to use this custom storage class, Zend\Authentication\AuthenticationService::setStorage() is invoked before an authentication query is attempted:
1 2 3 4 5 6 7 8 9 10 11 12 13 14
use Zend\Authentication\AuthenticationService; // Instruct AuthenticationService to use the custom storage class $auth = new AuthenticationService(); $auth->setStorage(new My\Storage()); /** * @todo Set up the auth adapter, $authAdapter */ // Authenticate, saving the result, and persisting the identity on // success $result = $auth->authenticate($authAdapter);
26.4 Usage
There are two provided ways to use Zend\Authentication adapters: indirectly, through Zend\Authentication\AuthenticationService::authenticate() directly, through the adapters authenticate() method The following example illustrates how to use a Zend\Authentication adapter indirectly, through the use of the Zend\Authentication\AuthenticationService class:
1 2 3 4 5 6 7 8 9
use Zend\Authentication\AuthenticationService; // instantiate the authentication service $auth = new AuthenticationService(); // Set up the authentication adapter $authAdapter = new My\Auth\Adapter($username, $password); // Attempt authentication, saving the result
124
10 11 12 13 14 15 16 17 18 19 20 21 22
$result = $auth->authenticate($authAdapter); if (!$result->isValid()) { // Authentication failed; print the reasons why foreach ($result->getMessages() as $message) { echo "$message\n"; } } else { // Authentication succeeded; the identity ($username) is stored // in the session // $result->getIdentity() === $auth->getIdentity() // $result->getIdentity() === $username }
Once authentication has been attempted in a request, as in the above example, it is a simple matter to check whether a successfully authenticated identity exists:
1 2 3 4 5 6 7 8 9 10 11 12
use Zend\Authentication\AuthenticationService; $auth = new AuthenticationService(); /** * @todo Set up the auth adapter, $authAdapter */ if ($auth->hasIdentity()) { // Identity exists; get it $identity = $auth->getIdentity(); }
To remove an identity from persistent storage, simply use the clearIdentity() method. This typically would be used for implementing an application logout operation:
1
$auth->clearIdentity();
When the automatic use of persistent storage is inappropriate for a particular use case, a developer may simply bypass the use of the Zend\Authentication\AuthenticationService class, using an adapter class directly. Direct use of an adapter class involves conguring and preparing an adapter object and then calling its authenticate() method. Adapter-specic details are discussed in the documentation for each adapter. The following example directly utilizes My\Auth\Adapter:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
// Set up the authentication adapter $authAdapter = new My\Auth\Adapter($username, $password); // Attempt authentication, saving the result $result = $authAdapter->authenticate(); if (!$result->isValid()) { // Authentication failed; print the reasons why foreach ($result->getMessages() as $message) { echo "$message\n"; } } else { // Authentication succeeded // $result->getIdentity() === $username }
26.4. Usage
125
126
CHAPTER 27
27.1 Introduction
Zend\Authentication\Adapter\DbTable provides the ability to authenticate against credentials stored in a database table. Because Zend\Authentication\Adapter\DbTable requires an instance of Zend\Db\Adapter\Adapter to be passed to its constructor, each instance is bound to a particular database connection. Other conguration options may be set through the constructor and through instance methods, one for each option. The available conguration options include: tableName: This is the name of the database table that contains the authentication credentials, and against which the database authentication query is performed. identityColumn: This is the name of the database table column used to represent the identity. The identity column must contain unique values, such as a username or e-mail address. credentialColumn: This is the name of the database table column used to represent the credential. Under a simple identity and password authentication scheme, the credential value corresponds to the password. See also the credentialTreatment option. credentialTreatment: In many cases, passwords and other sensitive data are encrypted, hashed, encoded, obscured, salted or otherwise treated through some function or algorithm. By specifying a parameterized treatment string with this method, such as MD5(?) or PASSWORD(?), a developer may apply such arbitrary SQL upon input credential data. Since these functions are specic to the underlying RDBMS, check the database manual for the availability of such functions for your database system.
127
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
use Zend\Db\Adapter\Adapter as DbAdapter; // Create a SQLite database connection $dbAdapter = new DbAdapter(array( driver => Pdo_Sqlite, database => path/to/sqlite.db )); // Build a simple table creation query $sqlCreate = CREATE TABLE [users] ( . [id] INTEGER NOT NULL PRIMARY KEY, . [username] VARCHAR(50) UNIQUE NOT NULL, . [password] VARCHAR(32) NULL, . [real_name] VARCHAR(150) NULL); // Create the authentication credentials table $dbAdapter->query($sqlCreate); // Build a query to insert a row for which authentication may succeed $sqlInsert = "INSERT INTO users (username, password, real_name) " . "VALUES (my_username, my_password, My Real Name)"; // Insert the data $dbAdapter->query($sqlInsert);
With the database connection and table data available, an instance of Zend\Authentication\Adapter\DbTable may be created. Conguration option values may be passed to the constructor or deferred as parameters to setter methods after instantiation:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
use Zend\Authentication\Adapter\DbTable as AuthAdapter; // Configure the instance with constructor parameters... $authAdapter = new AuthAdapter($dbAdapter, users, username, password ); // ...or configure the instance with setter methods $authAdapter = new AuthAdapter($dbAdapter); $authAdapter ->setTableName(users) ->setIdentityColumn(username) ->setCredentialColumn(password) ;
At this point, the authentication adapter instance is ready to accept authentication queries. In order to formulate an authentication query, the input credential values are passed to the adapter prior to calling the authenticate() method:
1 2 3 4 5 6 7
// Set the input credential values (e.g., from a login form) $authAdapter ->setIdentity(my_username) ->setCredential(my_password) ; // Perform the authentication query, saving the result
128
In addition to the availability of the getIdentity() method upon the authentication result object, Zend\Authentication\Adapter\DbTable also supports retrieving the table row upon authentication success:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
// Print the identity echo $result->getIdentity() . "\n\n"; // Print the result row print_r($authAdapter->getResultRowObject()); /* Output: my_username Array ( [id] => 1 [username] => my_username [password] => my_password [real_name] => My Real Name ) */
Since the table row contains the credential value, it is important to secure the values against unintended access. When retrieving the result object, we can either specify what columns to return, or what columns to omit:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
$columnsToReturn = array( id, username, real_name ); print_r($authAdapter->getResultRowObject($columnsToReturn)); /* Output: Array ( [id] => 1 [username] => my_username [real_name] => My Real Name ) */ $columnsToOmit = array(password); print_r($authAdapter->getResultRowObject(null, $columnsToOmit); /* Output: Array ( [id] => 1 [username] => my_username [real_name] => My Real Name ) */
129
// authenticate with Zend\Authentication\Adapter\DbTable $result = $this->_auth->authenticate($adapter); if ($result->isValid()) { // store the identity as an object where only the username and // real_name have been returned $storage = $this->_auth->getStorage(); $storage->write($adapter->getResultRowObject(array( username, real_name, ))); // store the identity as an object where the password column has // been omitted $storage->write($adapter->getResultRowObject( null, password )); /* ... */ } else { /* ... */ }
use Zend\Authentication\Adapter\DbTable as AuthAdapter; // The status field value of an account is not equal to "compromised" $adapter = new AuthAdapter($db, users, username, password, MD5(?) AND status != "compromised" ); // The active field value of an account is equal to "TRUE"
130
12 13 14 15 16 17
$adapter = new AuthAdapter($db, users, username, password, MD5(?) AND active = "TRUE" );
Another scenario can be the implementation of a salting mechanism. Salting is a term referring to a technique which can highly improve your applications security. Its based on the idea that concatenating a random string to every password makes it impossible to accomplish a successful brute force attack on the database using pre-computed hash values from a dictionary. Therefore, we need to modify our table to store our salt string:
1 2 3
$sqlAlter = "ALTER TABLE [users] " . "ADD COLUMN [password_salt] " . "AFTER [password]";
Heres a simple way to generate a salt string for every user at registration:
1 2 3 4
Note: You can improve security even more by using a static salt value hard coded into your application. In the case that your database is compromised (e. g. by an SQL injection attack) but your web server is intact your data is still unusable for the attacker. Another alternative is to use the getDbSelect() method of the Zend\Authentication\Adapter\DbTable after the adapter has been constructed. This method will return the Zend\Db\Sql\Select object instance it will use to complete the authenticate() routine. It is important to note that this method will always return the same object regardless if authenticate() has been called or not. This object will not have any of the identity or credential information in it as those values are placed into the select object at authenticate() time. An example of a situation where one might want to use the getDbSelect() method would check the status of a user, in other words to see if that users account is enabled.
1 2 3 4 5 6 7 8 9 10 11
// Continuing with the example from above $adapter = new AuthAdapter($db, users, username, password, MD5(?) ); // get select object (by reference) $select = $adapter->getDbSelect(); $select->where(active = "TRUE");
131
12 13 14
132
CHAPTER 28
Digest Authentication
28.1 Introduction
Digest authentication is a method of HTTP authentication that improves upon Basic authentication by providing a way to authenticate without having to transmit the password in clear text across the network. This adapter allows authentication against text les containing lines having the basic elements of Digest authentication: username, such as joe.user realm, such as Administrative Area MD5 hash of the username, realm, and password, separated by colons The above elements are separated by colons, as in the following example (in which the password is somePassword):
1
someUser:Some Realm:fde17b91c3a510ecbaf7dbd37f59d4f8
28.2 Specics
The digest authentication adapter, Zend\Authentication\Adapter\Digest, requires several input parameters: lename - Filename against which authentication queries are performed realm - Digest authentication realm username - Digest authentication user password - Password for the user of the realm These parameters must be set prior to calling authenticate().
28.3 Identity
The digest authentication adapter returns a Zend\Authentication\Result object, which has been populated with the identity as an array having keys of realm and username. The respective array values associated with these keys correspond to the values set before authenticate() is called.
133
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
use Zend\Authentication\Adapter\Digest as AuthAdapter; $adapter = new AuthAdapter($filename, $realm, $username, $password); $result = $adapter->authenticate(); $identity = $result->getIdentity(); print_r($identity); /* Array ( [realm] => Some Realm [username] => someUser ) */
134
CHAPTER 29
29.1 Introduction
Zend\Authentication\Adapter\Http provides a mostly-compliant implementation of RFC-2617, Basic and Digest HTTP Authentication. Digest authentication is a method of HTTP authentication that improves upon Basic authentication by providing a way to authenticate without having to transmit the password in clear text across the network. Major Features: Supports both Basic and Digest authentication. Issues challenges in all supported schemes, so client can respond with any scheme it supports. Supports proxy authentication. Includes support for authenticating against text les and provides an interface for authenticating against other sources, such as databases. There are a few notable features of RFC-2617 that are not implemented yet: Nonce tracking, which would allow for stale support, and increased replay attack protection. Authentication with integrity checking, or auth-int. Authentication-Info HTTP header.
135
Species whether to send the opaque value in the header. True by default. Specied the algorithm. Defaults to MD5, the only supported option (for now). Disabled by default. Enable to perform Proxy authentication, instead of normal origin server authentication.
Note: The current implementation of the nonce_timeout has some interesting side effects. This setting is supposed to determine the valid lifetime of a given nonce, or effectively how long a clients authentication information is accepted. Currently, if its set to 3600 (for example), it will cause the adapter to prompt the client for new credentials every hour, on the hour. This will be resolved in a future release, once nonce tracking and stale support are implemented.
29.4 Resolvers
The resolvers job is to take a username and realm, and return some kind of credential value. Basic authentication expects to receive the Base64 encoded version of the users password. Digest authentication expects to receive a hash of the users username, the realm, and their password (each separated by colons). Currently, the only supported hash algorithm is MD5. Zend\Authentication\Adapter\Http relies on objects implementing Zend\Authentication\Adapter\Http\ResolverInterface. A text le resolver class is included with this adapter, but any other kind of resolver can be created simply by implementing the resolver interface.
<username>:<realm>:<credentials>\n
Each line consists of three elds - username, realm, and credentials - each separated by a colon. The credentials eld is opaque to the le resolver; it simply returns that value as-is to the caller. Therefore, this same le format serves both 136 Chapter 29. HTTP Authentication Adapter
Basic and Digest authentication. In Basic authentication, the credentials eld should be written in clear text. In Digest authentication, it should be the MD5 hash described above. There are two equally easy ways to create a File resolver:
1 2 3
or
1 2 3
This array will cause the adapter to accept either Basic or Digest authentication, and will require authenticated access to all the areas of the site under /members_only and /my_account. The realm value is usually displayed by the browser in the password dialog box. The nonce_timeout, of course, behaves as described above. Next, create the Zend\Authentication\Adapter\Http object:
1
Since were supporting both Basic and Digest authentication, we need two different resolver objects. Note that this could just as easily be two different classes:
1 2 3 4 5 6 7 8 9 10
use Zend\Authentication\Adapter\Http\FileResolver; $basicResolver = new FileResolver(); $basicResolver->setFile(files/basicPasswd.txt); $digestResolver = new FileResolver(); $digestResolver->setFile(files/digestPasswd.txt); $adapter->setBasicResolver($basicResolver); $adapter->setDigestResolver($digestResolver);
Finally, we perform the authentication. The adapter needs a reference to both the Request and Response objects in order to do its job:
1 2 3 4 5
137
6 7 8 9 10
138
CHAPTER 30
LDAP Authentication
30.1 Introduction
Zend\Authentication\Adapter\Ldap supports web application authentication with LDAP services. Its features include username and domain name canonicalization, multi-domain authentication, and failover capabilities. It has been tested to work with Microsoft Active Directory and OpenLDAP, but it should also work with other LDAP service providers. This documentation includes a guide on using Zend\Authentication\Adapter\Ldap, an exploration of its API, an outline of the various available options, diagnostic information for troubleshooting authentication problems, and example options for both Active Directory and OpenLDAP servers.
30.2 Usage
To incorporate Zend\Authentication\Adapter\Ldap authentication into your application quickly, even if youre not using Zend\Mvc, the meat of your code should look something like the following:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
Zend\Authentication\AuthenticationService; Zend\Authentication\Adapter\Ldap as AuthAdapter; Zend\Config\Reader\Ini as ConfigReader; Zend\Config\Config; Zend\Log\Logger; Zend\Log\Writer\Stream as LogWriter; Zend\Log\Filter\Priority as LogFilter;
$auth = new AuthenticationService(); $configReader = new ConfigReader(); $configData = $configReader->fromFile(./ldap-config.ini); $config = new Config($configData, true); $log_path = $config->production->ldap->log_path; $options = $config->production->ldap->toArray();
139
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
unset($options[log_path]); $adapter = new AuthAdapter($options, $username, $password); $result = $auth->authenticate($adapter); if ($log_path) { $messages = $result->getMessages(); $logger = new Logger; $writer = new LogWriter($log_path); $logger->addWriter($writer); $filter = new LogFilter(Logger::DEBUG); $writer->addFilter($filter); foreach ($messages as $i => $message) { if ($i-- > 1) { // $messages[2] and up are log messages $message = str_replace("\n", "\n ", $message); $logger->debug("Ldap: $i: $message"); } } }
Of course, the logging code is optional, but it is highly recommended that you use a logger. Zend\Authentication\Adapter\Ldap will record just about every bit of information anyone could want in $messages (more below), which is a nice feature in itself for something that has a history of being notoriously difcult to debug. The Zend\Config\Reader\Ini code is used above to load the adapter options. It is also optional. A regular array would work equally well. The following is an example ldap-config.ini le that has options for two separate servers. With multiple sets of server options the adapter will try each, in order, until the credentials are successfully authenticated. The names of the servers (e.g., server1 and server2) are largely arbitrary. For details regarding the options array, see the Server Options section below. Note that Zend\Config\Reader\Ini requires that any values with equals characters (=) will need to be quoted (like the DNs shown below).
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
[production] ldap.log_path = /tmp/ldap.log ; Typical options for OpenLDAP ldap.server1.host = s0.foo.net ldap.server1.accountDomainName = foo.net ldap.server1.accountDomainNameShort = FOO ldap.server1.accountCanonicalForm = 3 ldap.server1.username = "CN=user1,DC=foo,DC=net" ldap.server1.password = pass1 ldap.server1.baseDn = "OU=Sales,DC=foo,DC=net" ldap.server1.bindRequiresDn = true ; Typical options for Active Directory ldap.server2.host = dc1.w.net ldap.server2.useStartTls = true ldap.server2.accountDomainName = w.net ldap.server2.accountDomainNameShort = W
140
20 21
The above conguration will instruct Zend\Authentication\Adapter\Ldap to attempt to authenticate users with the OpenLDAP server s0.foo.net rst. If the authentication fails for any reason, the AD server dc1.w.net will be tried. With servers in different domains, this conguration illustrates multi-domain authentication. You can also have multiple servers in the same domain to provide redundancy. Note that in this case, even though OpenLDAP has no need for the short NetBIOS style domain name used by Windows, we provide it here for name canonicalization purposes (described in the Username Canonicalization section below).
Array ( [server2] => Array ( [host] => dc1.w.net [useStartTls] => 1 [accountDomainName] => w.net [accountDomainNameShort] => W [accountCanonicalForm] => 3 [baseDn] => CN=Users,DC=w,DC=net ) [server1] => Array ( [host] => s0.foo.net [accountDomainName] => foo.net [accountDomainNameShort] => FOO [accountCanonicalForm] => 3 [username] => CN=user1,DC=foo,DC=net [password] => pass1 [baseDn] => OU=Sales,DC=foo,DC=net [bindRequiresDn] => 1 ) )
The information provided in each set of options above is different mainly because AD does not require a username be in DN form when binding (see the bindRequiresDn option in the Server Options section below), which means we can omit a number of options associated with retrieving the DN for a username being authenticated. Note: What is a Distinguished Name?
141
A DN or distinguished name is a string that represents the path to an object within the LDAP directory. Each comma-separated component is an attribute and value representing a node. The components are evaluated in reverse. For example, the user account CN=Bob Carter,CN=Users,DC=w,DC=net is located directly within the CN=Users,DC=w,DC=net container. This structure is best explored with an LDAP browser like the ADSI Edit MMC snap-in for Active Directory or phpLDAPadmin. The names of servers (e.g. server1 and server2 shown above) are largely arbitrary, but for the sake of using Zend\Config\Reader\Ini, the identiers should be present (as opposed to being numeric indexes) and should not contain any special characters used by the associated le formats (e.g. the .INI property separator, & for XML entity references, etc). With multiple sets of server options, the adapter can authenticate users in multiple domains and provide failover so that if one server is not available, another will be queried. Note: The Gory Details: What Happens in the Authenticate Method? When the authenticate() method is called, the adapter iterates over each set of server options, sets them on the internal Zend\Ldap\Ldap instance, and calls the Zend\Ldap\Ldap::bind() method with the username and password being authenticated. The Zend\Ldap\Ldap class checks to see if the username is qualied with a domain (e.g., has a domain component like alice@foo.net or FOO\alice). If a domain is present, but does not match either of the servers domain names (foo.net or FOO), a special exception is thrown and caught by Zend\Authentication\Adapter\Ldap that causes that server to be ignored and the next set of server options is selected. If a domain does match, or if the user did not supply a qualied username, Zend\Ldap\Ldap proceeds to try to bind with the supplied credentials. if the bind is not successful, Zend\Ldap\Ldap throws a Zend\Ldap\Exception\LdapException which is caught by Zend\Authentication\Adapter\Ldap and the next set of server options is tried. If the bind is successful, the iteration stops, and the adapters authenticate() method returns a successful result. If all server options have been tried without success, the authentication fails, and authenticate() returns a failure result with error messages from the last iteration. The username and password parameters of the Zend\Authentication\Adapter\Ldap constructor represent the credentials being authenticated (i.e., the credentials supplied by the user through your HTML login form). Alternatively, they may also be set with the setUsername() and setPassword() methods.
142
Table 30.1: Server Options Description The hostname of LDAP server that these options represent. This option is required. The port on which the LDAP server is listening. If useSsl is TRUE, the default port value is 636. If useSsl is FALSE, the default port value is 389. useStartTls Whether or not the LDAP client should use TLS (aka SSLv2) encrypted transport. A value of TRUE is strongly favored in production environments to prevent passwords from be transmitted in clear text. The default value is FALSE, as servers frequently require that a certicate be installed separately after installation. The useSsl and useStartTls options are mutually exclusive. The useStartTls option should be favored over useSsl but not all servers support this newer mechanism. useSsl Whether or not the LDAP client should use SSL encrypted transport. The useSsl and useStartTls options are mutually exclusive, but useStartTls should be favored if the server and LDAP client library support it. This value also changes the default port value (see port description above). username The DN of the account used to perform account DN lookups. LDAP servers that require the username to be in DN form when performing the bind require this option. Meaning, if bindRequiresDn is TRUE, this option is required. This account does not need to be a privileged account; an account with read-only access to objects under the baseDn is all that is necessary (and preferred based on the Principle of Least Privilege). password The password of the account used to perform account DN lookups. If this option is not supplied, the LDAP client will attempt an anonymous bind when performing account DN lookups. bindRequiresDn Some LDAP servers require that the username used to bind be in DN form like CN=Alice Baker,OU=Sales,DC=foo,DC=net (basically all servers except AD). If this option is TRUE, this instructs Zend\Ldap\Ldap to automatically retrieve the DN corresponding to the username being authenticated, if it is not already in DN form, and then re-bind with the proper DN. The default value is FALSE. Currently only Microsoft Active Directory Server (ADS) is known not to require usernames to be in DN form when binding, and therefore this option may be FALSE with AD (and it should be, as retrieving the DN requires an extra round trip to the server). Otherwise, this option must be set to TRUE (e.g. for OpenLDAP). This option also controls the default accountFilterFormat used when searching for accounts. See the accountFilterFormat option. baseDn The DN under which all accounts being authenticated are located. This option is required. if you are uncertain about the correct baseDn value, it should be sufcient to derive it from the users DNS domain using DC= components. For example, if the users principal name is alice@foo.net, a baseDn of DC=foo,DC=net should work. A more precise location (e.g., OU=Sales,DC=foo,DC=net) will be more efcient, however. accountCanon- A value of 2, 3 or 4 indicating the form to which account names should be canonicalized after icalForm successful authentication. Values are as follows: 2 for traditional username style names (e.g., alice), 3 for backslash-style names (e.g., FOO\alice) or 4 for principal style usernames (e.g., alice@foo.net). The default value is 4 (e.g., alice@foo.net). For example, with a value of 3, the identity returned by Zend\Authentication\Result::getIdentity() (and Zend\Authentication\AuthenticationService::getIdentity(), if Zend\Authentication\AuthenticationService was used) will always be FOO\alice, regardless of what form Alice supplied, whether it be alice, alice@foo.net, FOO\alice, FoO\aLicE, foo.net\alice, etc. See the Account Name Canonicalization section in the Zend\Ldap\Ldap documentation for details. Note that when using multiple sets of server options it is recommended, but not required, that the same accountCanonicalForm be used with all server options so that the resulting usernames are always canonicalized to the same form (e.g., if you canonicalize to EXAMPLE\username with an AD server but to username@example.com with an OpenLDAP server, that may be awkward for the applications high-level logic). accountDoThe FQDN domain name for which the target LDAP server is an authority (e.g., example.com). mainName This option is used to canonicalize names so that the username supplied by the user can be converted as necessary for binding. It is also used to determine if the server is an authority for the supplied username (e.g., if accountDomainName is foo.net and the user supplies 30.4. Server Options 143 bob@bar.net, the server will not be queried, and a failure will result). This option is not required, but if it is not supplied, usernames in principal name form (e.g., alice@foo.net) are not supported. It is strongly recommended that you supply this option, as there are many use-cases that require generating the principal name form. Name host port
Note: If you enable useStartTls = TRUE or useSsl = TRUE you may nd that the LDAP client generates an error claiming that it cannot validate the servers certicate. Assuming the PHP LDAP extension is ultimately linked to the OpenLDAP client libraries, to resolve this issue you can set TLS_REQCERT never in the OpenLDAP client ldap.conf (and restart the web server) to indicate to the OpenLDAP client library that you trust the server. Alternatively, if you are concerned that the server could be spoofed, you can export the LDAP servers root certicate and put it on the web server so that the OpenLDAP client can validate the servers identity.
In practice, index 0 should be displayed to the user (e.g., using the FlashMessenger helper), index 1 should be logged and, if debugging information is being collected, indexes 2 and higher could be logged as well (although the nal message always includes the string from index 1).
144
Table 30.3: Options for Active Directory Name host useStartTls useSsl baseDn Additional Notes As with all servers, this option is required. For the sake of security, this should be TRUE if the server has the necessary certicate installed. Possibly used as an alternative to useStartTls (see above). As with all servers, this option is required. By default AD places all user accounts under the Users container (e.g., CN=Users,DC=foo,DC=net), but the default is not common in larger organizations. Ask your AD administrator what the best DN for accounts for your application would be. You almost certainly want this to be 3 for backslash style names (e.g., FOO\alice), which are most familiar to Windows users. You should not use the unqualied form 2 (e.g., alice), as this may grant access to your application to users with the same username in other trusted domains (e.g., BAR\alice and FOO\alice will be treated as the same user). (See also note below.) This is required with AD unless accountCanonicalForm 2 is used, which, again, is discouraged. The NetBIOS name of the domain that users are in and for which the AD server is an authority. This is required if the backslash style accountCanonicalForm is used.
accountCanonicalForm
accountDomainName accountDomainNameShort
Note: Technically there should be no danger of accidental cross-domain authentication with the current Zend\Authentication\Adapter\Ldap implementation, since server domains are explicitly checked, but this may not be true of a future implementation that discovers the domain at runtime, or if an alternative adapter is used (e.g., Kerberos). In general, account name ambiguity is known to be the source of security issues, so always try to use qualied account names.
145
Table 30.4: Options for OpenLDAP Name host useStartTls useSsl username Additional Notes As with all servers, this option is required. For the sake of security, this should be TRUE if the server has the necessary certicate installed. Possibly used as an alternative to useStartTls (see above). Required and must be a DN, as OpenLDAP requires that usernames be in DN form when performing a bind. Try to use an unprivileged account. password The password corresponding to the username above, but this may be omitted if the LDAP server permits an anonymous binding to query user accounts. bindRequiresDn Required and must be TRUE, as OpenLDAP requires that usernames be in DN form when performing a bind. baseDn As with all servers, this option is required and indicates the DN under which all accounts being authenticated are located. accountCanon- Optional, but the default value is 4 (principal style names like alice@foo.net), which may not icalForm be ideal if your users are used to backslash style names (e.g., FOO\alice). For backslash style names use value 3. accountDoRequired unless youre using accountCanonicalForm 2, which is not recommended. mainName accountDoIf AD is not also being used, this value is not required. Otherwise, if accountCanonicalForm 3 mainis used, this option is required and should be a short name that corresponds adequately to the NameShort accountDomainName (e.g., if your accountDomainName is foo.net, a good accountDomainNameShort value might be FOO).
146
CHAPTER 31
Authentication Validator
31.1 Introduction
Zend\Authentication\Validator\Authentication provides the ability to utilize a validator for an InputFilter in the instance of a Form or for single use where you simply want a true/false value and being able to introspect the error. The available conguration options include: adapter: This is an instance of Zend\Authentication\Adapter. identity: This is the identity or name of the identity in the passed in context. credential: This is the credential or the name of the credential in the passed in context. service: This is an instance of Zend\Authentication\AuthenticationService
use Zend\Authentication\AuthenticationService; use Zend\Authentication\Validator\Authentication as AuthenticationValidator; $service = new AuthenticationService(); $adapter = new My\Authentication\Adapter(); $validator = new AuthenticationValidator( service => $service, adapter => $adapter, ); $validator->setCredential(myCredentialContext); $validator->isValid(myIdentity, array( myCredentialContext => myCredential, ));
147
148
CHAPTER 32
Introduction to Zend\Barcode
Zend\Barcode\Barcode provides a generic way to generate barcodes. The Zend\Barcode component is divided into two subcomponents: barcode objects and renderers. Objects allow you to create barcodes independently of the renderer. Renderer allow you to draw barcodes based on the support required.
149
150
CHAPTER 33
Zend\Barcode\Barcode::factory() instantiates barcode classes and renderers and ties them together. In this rst example, we will use the Code39 barcode type together with the Image renderer.
1 2 3 4 5 6 7 8 9 10
use Zend\Barcode\Barcode; // Only the text to draw is required $barcodeOptions = array(text => ZEND-FRAMEWORK); // No required options $rendererOptions = array(); $renderer = Barcode::factory( code39, image, $barcodeOptions, $rendererOptions );
151
You may pass a Zend\Config\Config object to the factory in order to create the necessary objects. The following example is functionally equivalent to the previous.
1 2 3 4 5 6 7 8 9 10 11 12
use Zend\Config\Config; use Zend\Barcode\Barcode; // Using only one Zend\Config\Config object $config = new Config(array( barcode => code39, barcodeParams => array(text => ZEND-FRAMEWORK), renderer => image, rendererParams => array(imageType => gif), )); $renderer = Barcode::factory($config);
1 2 3 4 5 6 7 8 9 10 11 12
Drawing a barcode with Zend\Barcode\Barcode::draw() use Zend\Barcode\Barcode; // Only the text to draw is required $barcodeOptions = array(text => ZEND-FRAMEWORK); // No required options $rendererOptions = array(); // Draw the barcode in a new image, $imageResource = Barcode::draw( code39, image, $barcodeOptions, $rendererOptions );
1 2 3 4 5 6 7 8 9 10 11 12
152
1 2 3 4 5 6 7 8 9 10 11 12 13
Rendering a barcode with Zend\Barcode\Barcode::render() use Zend\Barcode\Barcode; // Only the text to draw is required $barcodeOptions = array(text => ZEND-FRAMEWORK); // No required options $rendererOptions = array(); // Draw the barcode in a new image, // send the headers and the image Barcode::render( code39, image, $barcodeOptions, $rendererOptions );
1 2 3 4 5 6 7 8 9 10 11 12 13
153
154
CHAPTER 34
Zend\Barcode\Barcode Objects
Barcode objects allow you to generate barcodes independently of the rendering support. After generation, you can retrieve the barcode as an array of drawing instructions that you can provide to a renderer. Objects have a large number of options. Most of them are common to all objects. These options can be set in three ways: As an array or a Traversable object passed to the constructor. As an array passed to the setOptions() method. Via individual setters for each conguration type.
Different ways to parameterize a barcode object use Zend\Barcode\Object; $options = array(text => ZEND-FRAMEWORK, barHeight => 40); // Case 1: constructor $barcode = new Object\Code39($options); // Case 2: setOptions() $barcode = new Object\Code39(); $barcode->setOptions($options); // Case 3: individual setters $barcode = new Object\Code39(); $barcode->setText(ZEND-FRAMEWORK) ->setBarHeight(40);
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
Table 34.1: Common Options Option barcodeNamespace barHeight barThickWidth barThinWidth factor foreColor backgroundColor orientation font fontSize withBorder withQuietZones drawText stretchText withChecksum withChecksumInText text Data Type String Integer Integer Integer Integer Integer Integer or String Float String or Integer Float Boolean Boolean Boolean Boolean Boolean Boolean String Default Description Value Zend\Barcode\Object Namespace of the barcode; for example, if you need to extend the embedding objects 50 Height of the bars 3 Width of the thick bar 1 1 0x000000 (black) 0xFFFFFF (white) 0 NULL 10 FALSE TRUE TRUE FALSE FALSE FALSE NULL Width of the thin bar Factor by which to multiply bar widths and font sizes (barHeight, barThinWidth, barThickWidth and fontSize) Color of the bar and the text. Could be provided as an integer or as a HTML value (e.g. #333333) Color of the background. Could be provided as an integer or as a HTML value (e.g. #333333) Orientation of the barcode Font path to a TTF font or a number between 1 and 5 if using image generation with GD (internal fonts) Size of the font (not applicable with numeric fonts) Draw a border around the barcode and the quiet zones Leave a quiet zone before and after the barcode Set if the text is displayed below the barcode Specify if the text is stretched all along the barcode Indicate whether or not the checksum is automatically added to the barcode Indicate whether or not the checksum is displayed in the textual representation The text to represent as a barcode
use Zend\Barcode\Barcode; // In your bootstrap: Barcode::setBarcodeFont(my_font.ttf); // Later in your code: Barcode::render( code39, pdf, array(text => ZEND-FRAMEWORK) ); // will use my_font.ttf // or: Barcode::render( code39, image,
156
17 18 19 20 21
array( text => ZEND-FRAMEWORK, font => 3 ) ); // will use the 3rd GD internal font
Integer Integer
Return the width of the barcode calculated after possible rotation Return the position of the top of the barcode calculated after possible rotation
Integer
Return the position of the left of the barcode calculated after possible rotation
157
158
CHAPTER 35
You will nd below detailed information about all barcode types shipped by default with Zend Framework.
35.1 Zend\Barcode\Object\Error
This barcode is a special case. It is internally used to automatically render an exception caught by the Zend\Barcode component.
35.2 Zend\Barcode\Object\Code128
Name: Code 128 Allowed characters: the complete ASCII-character set Checksum: optional (modulo 103) Length: variable There are no particular options for this barcode.
159
35.3 Zend\Barcode\Object\Codabar
Name: Codabar (or Code 2 of 7) Allowed characters:0123456789-$:/.+ with ABCD as start and stop characters Checksum: none Length: variable There are no particular options for this barcode.
35.4 Zend\Barcode\Object\Code25
Name: Code 25 (or Code 2 of 5 or Code 25 Industrial) Allowed characters:0123456789 Checksum: optional (modulo 10) Length: variable There are no particular options for this barcode.
35.5 Zend\Barcode\Object\Code25interleaved
This barcode extends Zend\Barcode\Object\Code25 (Code 2 of 5), and has the same particulars and options, and adds the following: Name: Code 2 of 5 Interleaved Allowed characters:0123456789 Checksum: optional (modulo 10) Length: variable (always even number of characters)
160
Available options include: Table 35.1: Zend\Barcode\Object\Code25interleaved Options Option withBearerBars Data Type Boolean Default Value FALSE Description Draw a thick bar at the top and the bottom of the barcode.
Note: If the number of characters is not even, Zend\Barcode\Object\Code25interleaved will automatically prepend the missing zero to the barcode text.
35.6 Zend\Barcode\Object\Ean2
This barcode extends Zend\Barcode\Object\Ean5 (EAN 5), and has the same particulars and options, and adds the following: Name: EAN -2 Allowed characters:0123456789 Checksum: only use internally but not displayed Length: 2 characters There are no particular options for this barcode. Note: If the number of characters is lower than 2, Zend\Barcode\Object\Ean2 will automatically prepend the missing zero to the barcode text.
35.7 Zend\Barcode\Object\Ean5
This barcode extends Zend\Barcode\Object\Ean13 (EAN 13), and has the same particulars and options, and adds the following: Name: EAN -5 Allowed characters:0123456789 Checksum: only use internally but not displayed Length: 5 characters
35.6. Zend\Barcode\Object\Ean2
161
There are no particular options for this barcode. Note: If the number of characters is lower than 5, Zend\Barcode\Object\Ean5 will automatically prepend the missing zero to the barcode text.
35.8 Zend\Barcode\Object\Ean8
This barcode extends Zend\Barcode\Object\Ean13 (EAN 13), and has the same particulars and options, and adds the following: Name: EAN -8 Allowed characters:0123456789 Checksum: mandatory (modulo 10) Length: 8 characters (including checksum) There are no particular options for this barcode. Note: If the number of characters is lower than 8, Zend\Barcode\Object\Ean8 will automatically prepend the missing zero to the barcode text.
35.9 Zend\Barcode\Object\Ean13
Name: EAN -13 Allowed characters:0123456789 Checksum: mandatory (modulo 10) Length: 13 characters (including checksum) There are no particular options for this barcode. Note: If the number of characters is lower than 13, Zend\Barcode\Object\Ean13 will automatically prepend the missing zero to the barcode text. The option withQuietZones has no effect with this barcode.
162
35.10 Zend\Barcode\Object\Code39
Name: Code 39 Allowed characters:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ -.$/+% Checksum: optional (modulo 43) Length: variable Note: Zend\Barcode\Object\Code39 will automatically add the start and stop characters (*) for you. There are no particular options for this barcode.
35.11 Zend\Barcode\Object\Identcode
This barcode extends Zend\Barcode\Object\Code25interleaved (Code 2 of 5 Interleaved), and inherits some of its capabilities; it also has a few particulars of its own. Name: Identcode (Deutsche Post Identcode) Allowed characters:0123456789 Checksum: mandatory (modulo 10 different from Code25) Length: 12 characters (including checksum) There are no particular options for this barcode. Note: If the number of characters is lower than 12, Zend\Barcode\Object\Identcode will automatically prepend missing zeros to the barcode text.
35.12 Zend\Barcode\Object\Itf14
35.10. Zend\Barcode\Object\Code39
163
This barcode extends Zend\Barcode\Object\Code25interleaved (Code 2 of 5 Interleaved), and inherits some of its capabilities; it also has a few particulars of its own. Name: ITF -14 Allowed characters:0123456789 Checksum: mandatory (modulo 10) Length: 14 characters (including checksum) There are no particular options for this barcode. Note: If the number of characters is lower than 14, Zend\Barcode\Object\Itf14 will automatically prepend missing zeros to the barcode text.
35.13 Zend\Barcode\Object\Leitcode
This barcode extends Zend\Barcode\Object\Identcode (Deutsche Post Identcode), and inherits some of its capabilities; it also has a few particulars of its own. Name: Leitcode (Deutsche Post Leitcode) Allowed characters:0123456789 Checksum: mandatory (modulo 10 different from Code25) Length: 14 characters (including checksum) There are no particular options for this barcode. Note: If the number of characters is lower than 14, Zend\Barcode\Object\Leitcode will automatically prepend missing zeros to the barcode text.
35.14 Zend\Barcode\Object\Planet
Name: Planet (PostaL Alpha Numeric Encoding Technique) Allowed characters:0123456789 Checksum: mandatory (modulo 10) Length: 12 or 14 characters (including checksum) There are no particular options for this barcode.
164
35.15 Zend\Barcode\Object\Postnet
Name: Postnet (POSTal Numeric Encoding Technique) Allowed characters:0123456789 Checksum: mandatory (modulo 10) Length: 6, 7, 10 or 12 characters (including checksum) There are no particular options for this barcode.
35.16 Zend\Barcode\Object\Royalmail
Name: Royal Mail or RM4SCC (Royal Mail 4-State Customer Code) Allowed characters:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ Checksum: mandatory Length: variable There are no particular options for this barcode.
35.17 Zend\Barcode\Object\Upca
This barcode extends Zend\Barcode\Object\Ean13 (EAN -13), and inherits some of its capabilities; it also has a few particulars of its own. Name: UPC-A (Universal Product Code) Allowed characters:0123456789 Checksum: mandatory (modulo 10) Length: 12 characters (including checksum) There are no particular options for this barcode. Note: If the number of characters is lower than 12, Zend\Barcode\Object\Upca will automatically prepend missing zeros to the barcode text. The option withQuietZones has no effect with this barcode.
35.15. Zend\Barcode\Object\Postnet
165
35.18 Zend\Barcode\Object\Upce
This barcode extends Zend\Barcode\Object\Upca (UPC-A), and inherits some of its capabilities; it also has a few particulars of its own. The rst character of the text to encode is the system (0 or 1). Name: UPC-E (Universal Product Code) Allowed characters:0123456789 Checksum: mandatory (modulo 10) Length: 8 characters (including checksum) There are no particular options for this barcode. Note: If the number of characters is lower than 8, Zend\Barcode\Object\Upce will automatically prepend missing zeros to the barcode text.
Note: If the rst character of the text to encode is not 0 or 1, Zend\Barcode\Object\Upce will automatically replace it by 0. The option withQuietZones has no effect with this barcode.
166
CHAPTER 36
Zend\Barcode Renderers
Renderers have some common options. These options can be set in three ways: As an array or a Traversable object passed to the constructor. As an array passed to the setOptions() method. As discrete values passed to individual setters.
Different ways to parameterize a renderer object use Zend\Barcode\Renderer; $options = array(topOffset => 10); // Case 1 $renderer = new Renderer\Pdf($options); // Case 2 $renderer = new Renderer\Pdf(); $renderer->setOptions($options); // Case 3 $renderer = new Renderer\Pdf(); $renderer->setTopOffset(10);
1 2 3 4 5 6 7 8 9 10 11 12 13 14
167
Table 36.1: Common Options Option rendererNamespace horizontalPosition verticalPosition leftOffset topOffset automaticRenderError moduleSize barcode Data Type String Default Description Value Zend\Barcode\Renderer Namespace of the renderer; for example, if you need to extend the renderers left Can be left, center or right. Can be useful with PDF or if the setWidth() method is used with an image renderer. Can be top, middle or bottom. Can be useful with PDF or if the setHeight() method is used with an image renderer. Top position of the barcode inside the renderer. If used, this value will override the horizontalPosition option. Top position of the barcode inside the renderer. If used, this value will override the verticalPosition option. Whether or not to automatically render errors. If an exception occurs, the provided barcode object will be replaced with an Error representation. Note that some errors (or exceptions) can not be rendered. Size of a rendering module in the support. The barcode object to render.
String
top 0 0 FALSE
Float
Zend\Barcode\Object NULL
An additional getter exists: getType(). It returns the name of the renderer class without the namespace (e.g. Zend\Barcode\Renderer\Image returns image).
36.2 Zend\Barcode\Renderer\Image
The Image renderer will draw the instruction list of the barcode object in an image resource. The component requires the GD extension. The default width of a module is 1 pixel. Available options are: Table 36.2: Zend\Barcode\Renderer\Image Options Option height width imageType Data Type Integer Integer String Default Value 0 0 png Description Allow you to specify the height of the result image. If 0, the height will be calculated by the barcode object. Allow you to specify the width of the result image. If 0, the width will be calculated by the barcode object. Specify the image format. Can be png, jpeg, jpg or gif.
36.3 Zend\Barcode\Renderer\Pdf
The PDF renderer will draw the instruction list of the barcode object in a PDF document. The default width of a module is 0.5 point. There are no particular options for this renderer.
168
CHAPTER 37
Zend\Cache\Storage\Adapter
37.1 Overview
Storage adapters are wrappers for real storage resources such as memory and the lesystem, using the well known adapter pattern. They come with tons of methods to read, write and modify stored items and to get information about stored items and the storage. All adapters implement the interface Zend\Cache\Storage\StorageInterface and most extend Zend\Cache\Storage\Adapter\AbstractAdapter, which comes with basic logic. Conguration is handled by either Zend\Cache\Storage\Adapter\AdapterOptions, or an adapter-specic options class if it exists. You may pass the options instance to the class at instantiation or via the setOptions() method, or alternately pass an associative array of options in either place (internally, these are then passed to an options class instance). Alternately, you can pass either the options instance or associative array to the Zend\Cache\StorageFactory::factory method. Note: Many methods throw exceptions Because many caching operations throw an exception on error, you need to catch them manually or you can use the plug-in Zend\Cache\Storage\Plugin\ExceptionHandler with throw_exceptions set to false to automatically catch them. You can also dene an exception_callback to log exceptions.
169
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
name => apc, options => array(ttl => 3600), ), plugins => array( exception_handler => array(throw_exceptions => false), ), )); // Alternately: $cache = StorageFactory::adapterFactory(apc, array(ttl => 3600)); $plugin = StorageFactory::pluginFactory(exception_handler, array( throw_exceptions => false, )); $cache->addPlugin($plugin); // Or manually: $cache = new Zend\Cache\Storage\Adapter\Apc(); $cache->getOptions()->setTtl(3600); $plugin = new Zend\Cache\Storage\Plugin\ExceptionHandler(); $plugin->getOptions()->setThrowExceptions(false); $cache->addPlugin($plugin);
170
getItems(array $keys) Load all items given by $keys returning key-value pairs. Return type array hasItem(string $key) Test if an item exists. Return type boolean hasItems(array $keys) Test multiple items. Return type string[] getMetadata(string $key) Get metadata of an item. Return type array|boolean getMetadatas(array $keys) Get multiple metadata. Return type array setItem(string $key, mixed $value) Store an item. Return type boolean setItems(array $keyValuePairs) Store multiple items. Return type boolean addItem(string $key, mixed $value) Add an item. Return type boolean addItems(array $keyValuePairs) Add multiple items. Return type boolean replaceItem(string $key, mixed $value) Replace an item. Return type boolean replaceItems(array $keyValuePairs) Replace multiple items. Return type boolean checkAndSetItem(mixed $token, string $key, mixed $value) Set item only if token matches. It uses the token received from getItem() to check if the item has changed before overwriting it. Return type boolean touchItem(string $key) Reset lifetime of an item. Return type boolean
171
touchItems(array $keys) Reset lifetime of multiple items. Return type boolean removeItem(string $key) Remove an item. Return type boolean removeItems(array $keys) Remove multiple items. Return type boolean incrementItem(string $key, int $value) Increment an item. Return type integer|boolean incrementItems(array $keyValuePairs) Increment multiple items. Return type boolean decrementItem(string $key, int $value) Decrement an item. Return type integer|boolean decrementItems(array $keyValuePairs) Decrement multiple items. Return type boolean getCapabilities() Capabilities of this storage. Return type Zend\Cache\Storage\Capabilities
172
173
174
Table 37.1: Capabilities Capability supportedDatatypes supportedMetadata minTtl maxTtl staticTtl ttlPrecision useRequestTime expiredRead maxKeyLength namespaceIsPrex namespaceSeparator Value null, boolean, integer, double, string, array (serialized), object (serialized) internal_key, atime, ctime, mtime, rtime, size, hits, ttl 1 0 true 1 <ini value of apc.use_request_time> false 5182 true <Option value of namespace_separator>
Table 37.2: Adapter specic options Name namespace_separator Data Type string Default Value : Description A separator for the namespace and prex
175
Table 37.4: Adapter specic options Name namespace_separator pathname mode handler Data Type string string string string Default Value : c atle Description A separator for the namespace and prex Pathname to the database le The mode to open the database Please read dba_open for more information The name of the handler which shall be used for accessing the database.
Note: This adapter doesnt support automatically expire items Because of this adapter doesnt support automatically expire items its very important to clean outdated items by self.
176
Table 37.5: Capabilities Capability supportedDatatypes supportedMetadata minTtl maxTtl staticTtl ttlPrecision useRequestTime expiredRead maxKeyLength namespaceIsPrex namespaceSeparator Value string, null => string, boolean => string, integer => string, double => string mtime, lespec, atime, ctime 1 0 false 1 false true 251 true <Option value of namespace_separator>
Table 37.6: Adapter specic options Name namespace_separator cache_dir clear_stat_cache dir_level dir_permission le_locking le_permission key_pattern no_atime no_ctime umask Data Type string string boolean integer integer false boolean integer false string boolean boolean integer false Default Value : true 1 0700 true 0600 Description A separator for the namespace and prex Directory to store cache les Call clearstatcache() enabled? Denes how much sub-directories should be created Set explicit permission on creating new directories Lock les on writing Set explicit permission on creating new les
/^[a-z0-9_\+\-]*$/Di Validate key against pattern true Dont get leatime as atime on metadata true Dont get lectime as ctime on metadata false Use umask to set le and directory permissions
177
Table 37.7: Capabilities Capability supportedDatatypes supportedMetadata minTtl maxTtl staticTtl ttlPrecision useRequestTime expiredRead maxKeyLength namespaceIsPrex namespaceSeparator Value null, boolean, integer, double, string, array (serialized), object (serialized) <none> 1 0 true 1 false false 255 true <none>
Table 37.8: Adapter specic options Default Value servers array [] lib_options array [] Name Data Type Description
List of servers in [] = array(string host, integer port) Associative array of Libmemcached options were the array key is the option name (without the prex OPT_) or the constant value. The array value is the option value Please read this<http://php.net/manual/memcached.setoption.php> for more information
178
Table 37.9: Capabilities Capability supportedDatatypes supportedMetadata minTtl maxTtl staticTtl ttlPrecision useRequestTime expiredRead maxKeyLength namespaceIsPrex Value string, null, boolean, integer, double, array, object, resource mtime 1 <Value of PHP_INT_MAX> false 0.05 false true 0 false
Table 37.10: Adapter specic options Name memory_limit Data Type string integer Default Value <50% of ini memory_limit> value Description Limit of how much memory can PHP allocate to allow store items into this adapter If the used memory of PHP exceeds this limit an OutOfSpaceException will be thrown. A number less or equal 0 will disable the memory limit When a number is used, the value is measured in bytes (Shorthand notation may also be used)
Note: All stored items will be lost after terminating the script.
179
Table 37.11: Capabilities Capability supportedDatatypes supportedMetadata minTtl maxTtl staticTtl ttlPrecision useRequestTime expiredRead namespaceIsPrex namespaceSeparator Value null, boolean, integer, double, string, array (serialized), object (serialized) internal_key, ttl, hits, size 1 0 true 1 <ini value of apc.use_request_time> false true <Option value of namespace_separator>
Table 37.12: Adapter specic options Name namespace_separator Data Type string Default Value : Description A separator for the namespace and prex
180
Table 37.14: Adapter specic options Default Value namesstring: pace_separator adboolean false min_auth Name Data Type Description
A separator for the namespace and prex Enable admin authentication by conguration options admin_user and admin_pass This makes XCache administration functions accessible if xcache.admin.enable_auth is enabled without the need of HTTP-Authentication. The username of xcache.admin.user The password of xcache.admin.pass in plain text
admin_user admin_pass
string string
181
This adapter implements the following interfaces: Zend\Cache\Storage\StorageInterface Zend\Cache\Storage\ClearByNamespaceInterface Zend\Cache\Storage\FlushableInterface Zend\Cache\Storage\TotalSpaceCapableInterface Table 37.16: Capabilities Capability supportedDatatypes supportedMetadata minTtl maxTtl maxKeyLength staticTtl ttlPrecision useRequestTime expiredRead namespaceIsPrex namespaceSeparator Value null, boolean, integer, double, string, array (serialized), object (serialized) <none> 1 0 0 true 1 false false true ::
37.23 Examples
Basic usage $cache = \Zend\Cache\StorageFactory::factory(array( adapter => array( name => filesystem ), plugins => array( // Dont throw exceptions on cache errors exception_handler => array( throw_exceptions => false ), ) )); $key = unique-cache-key; $result = $cache->getItem($key, $success); if (!$success) { $result = doExpensiveStuff(); $cache->setItem($key, $result); }
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
Get multiple rows from db // Instantiate the cache instance using a namespace for the same type of items $cache = \Zend\Cache\StorageFactory::factory(array( adapter => array( name => filesystem // With a namespace we can indicate the same type of items
1 2 3 4 5
182
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
// -> So we can simple use the db id as cache key options => array( namespace => dbtable ), ), plugins => array( // Dont throw exceptions on cache errors exception_handler => array( throw_exceptions => false ), // We store database rows on filesystem so we need to serialize them Serializer ) )); // Load two rows from cache if possible $ids = array(1, 2); $results = $cache->getItems($ids); if (count($results) < count($ids)) { // Load rows from db if loading from cache failed $missingIds = array_diff($ids, array_keys($results)); $missingResults = array(); $query = SELECT * FROM dbtable WHERE id IN ( . implode(,, $missingIds) . ); foreach ($pdo->query($query, PDO::FETCH_ASSOC) as $row) { $missingResults[ $row[id] ] = $row; } // Update cache items of the loaded rows from db $cache->setItems($missingResults); // merge results from cache and db $results = array_merge($results, $missingResults); }
37.23. Examples
183
184
CHAPTER 38
Zend\Cache\Storage\Capabilities
38.1 Overview
Storage capabilities describes how a storage adapter works and which features it supports. To get capabilities of a storage adapter, you can use the method getCapabilities() of the storage adapter but only the storage adapter and its plugins have permissions to change them. Because capabilities are mutable, for example, by changing some options, you can subscribe to the change event to get notications; see the examples for details. If you are writing your own plugin or adapter, you can also change capabilities because you have access to the marker object and can create your own marker to instantiate a new object of Zend\Cache\Storage\Capabilities.
185
getMinTtl() Get minimum supported time-to-live. (Returning 0 means items never expire) Return type integer setMinTtl(stdClass $marker, int $minTtl) Set minimum supported time-to-live. Return type Zend\Cache\Storage\Capabilities getMaxTtl() Get maximum supported time-to-live. Return type integer setMaxTtl(stdClass $marker, int $maxTtl) Set maximum supported time-to-live. Return type Zend\Cache\Storage\Capabilities getStaticTtl() Is the time-to-live handled static (on write), or dynamic (on read). Return type boolean setStaticTtl(stdClass $marker, boolean $ag) Set if the time-to-live is handled statically (on write) or dynamically (on read). Return type Zend\Cache\Storage\Capabilities getTtlPrecision() Get time-to-live precision. Return type oat setTtlPrecision(stdClass $marker, oat $ttlPrecision) Set time-to-live precision. Return type Zend\Cache\Storage\Capabilities getUseRequestTime() Get the use request time ag status. Return type boolean setUseRequestTime(stdClass $marker, boolean $ag) Set the use request time ag. Return type Zend\Cache\Storage\Capabilities getExpiredRead() Get ag indicating if expired items are readable. Return type boolean setExpiredRead(stdClass $marker, boolean $ag) Set if expired items are readable. Return type Zend\Cache\Storage\Capabilities getMaxKeyLength() Get maximum key length. Return type integer
186
setMaxKeyLength(stdClass $marker, int $maxKeyLength) Set maximum key length. Return type Zend\Cache\Storage\Capabilities getNamespaceIsPrefix() Get if namespace support is implemented as a key prex. Return type boolean setNamespaceIsPrefix(stdClass $marker, boolean $ag) Set if namespace support is implemented as a key prex. Return type Zend\Cache\Storage\Capabilities getNamespaceSeparator() Get namespace separator if namespace is implemented as a key prex. Return type string setNamespaceSeparator(stdClass $marker, string $separator) Set the namespace separator if namespace is implemented as a key prex. Return type Zend\Cache\Storage\Capabilities
38.3 Examples
Get storage capabilities and do specic stuff in base of it use Zend\Cache\StorageFactory; $cache = StorageFactory::adapterFactory(filesystem); $supportedDatatypes = $cache->getCapabilities()->getSupportedDatatypes(); // now you can run specific stuff in base of supported feature if ($supportedDatatypes[object]) { $cache->set($key, $object); } else { $cache->set($key, serialize($object)); }
1 2 3 4 5 6 7 8 9 10 11
Listen to change event use Zend\Cache\StorageFactory; $cache = StorageFactory::adapterFactory(filesystem, array( no_atime => false, )); // Catching capability changes $cache->getEventManager()->attach(capability, function($event) { echo count($event->getParams()) . capabilities changed; }); // change option which changes capabilities $cache->getOptions()->setNoATime(true);
1 2 3 4 5 6 7 8 9 10 11 12 13
38.3. Examples
187
188
CHAPTER 39
Zend\Cache\Storage\Plugin
39.1 Overview
Cache storage plugins are objects to add missing functionality or to inuence behavior of a storage adapter. The plugins listen to events the adapter triggers and can change called method arguments (*.post - events), skipping and directly return a result (using stopPropagation), changing the result (with setResult of Zend\Cache\Storage\PostEvent) and catching exceptions (with Zend\Cache\Storage\ExceptionEvent).
use Zend\Cache\StorageFactory; // Via factory: $cache = StorageFactory::factory(array( adapter => filesystem, plugins => array(serializer), )); // Alternately: $cache = StorageFactory::adapterFactory(filesystem); $plugin = StorageFactory::pluginFactory(serializer); $cache->addPlugin($plugin); // Or manually: $cache = new Zend\Cache\Storage\Adapter\Filesystem(); $plugin = new Zend\Cache\Storage\Plugin\Serializer(); $cache->addPlugin($plugin);
189
Note: ** The ClearExpiredInterface is required ** The storage have to implement the Zend\Cache\Storage\ClearExpiredInterface to work with this plugin.
190
Note: ** The OptimizableInterface is required ** The storage have to implement the Zend\Cache\Storage\OptimizableInterface to work with this plugin.
serializer_options
191
39.9 Examples
Basics of writing an own storage plugin use Zend\Cache\Storage\Event; use Zend\Cache\Storage\Plugin\AbstractPlugin; use Zend\EventManager\EventManagerInterface; class MyPlugin extends AbstractPlugin { protected $handles = array(); // This method have to attach all events required by this plugin public function attach(EventManagerInterface $events) { $this->handles[] = $events->attach(getItem.pre, array($this, onGetItemPre)); $this->handles[] = $events->attach(getItem.post, array($this, onGetItemPost)); return $this; } // This method have to attach all events required by this plugin public function detach(EventManagerInterface $events) { foreach ($this->handles as $handle) { $events->detach($handle); } $this->handles = array(); return $this; } public function onGetItemPre(Event $event) { $params = $event->getParams(); echo sprintf("Method getItem with key %s started\n", params[key]); } public function onGetItemPost(Event $event) { $params = $event->getParams(); echo sprintf("Method getItem with key %s finished\n", params[key]); } } // After defining this basic plugin we can instantiate and add it to an adapter instance $plugin = new MyPlugin(); $cache->addPlugin($plugin); // Now on calling getItem our basic plugin should print the expected output $cache->getItem(cache-key); // Method getItem with key cache-key started // Method getItem with key cache-key finished
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
192
CHAPTER 40
Zend\Cache\Pattern
40.1 Overview
Cache patterns are congurable objects to solve known performance bottlenecks. Each should be used only in the specic situations they are designed to address. For example you can use one of the CallbackCache, ObjectCache or ClassCache patterns to cache method and function calls; to cache output generation, the OutputCache pattern could assist. All cache patterns implement the same interface, Zend\Cache\Pattern\PatternInterface, and most extend the abstract class Zend\Cache\Pattern\AbstractPattern to implement basic logic. Conguration is provided via the Zend\Cache\Pattern\PatternOptions class, which can simply be instantiated with an associative array of options passed to the constructor. To congure a pattern object, you can set an instance of Zend\Cache\Pattern\PatternOptions with setOptions, or provide your options (either as an associative array or PatternOptions instance) as the second argument to the factory. Its also possible to use a single instance of Zend\Cache\Pattern\PatternOptions and pass it to multiple pattern objects.
// Via the factory: $callbackCache = Zend\Cache\PatternFactory::factory(callback, array( storage => apc, )); // OR, the equivalent manual instantiation: $callbackCache = new Zend\Cache\Pattern\CallbackCache(); $callbackCache->setOptions(new Zend\Cache\Pattern\PatternOptions(array( storage => apc, )));
1 2 3 4 5
193
194
CHAPTER 41
Zend\Cache\Pattern\CallbackCache
41.1 Overview
The callback cache pattern caches calls of non specic functions and methods given as a callback.
use Zend\Cache\PatternFactory; use Zend\Cache\Pattern\PatternOptions; // Via the factory: $callbackCache = PatternFactory::factory(callback, array( storage => apc, cache_output => true, )); // OR, the equivalent manual instantiation: $callbackCache = new \Zend\Cache\Pattern\CallbackCache(); $callbackCache->setOptions(new PatternOptions(array( storage => apc, cache_output => true, )));
195
41.5 Examples
Instantiating the callback cache pattern use Zend\Cache\PatternFactory; $callbackCache = PatternFactory::factory(callback, array( storage => apc ));
1 2 3 4 5
196
CHAPTER 42
Zend\Cache\Pattern\ClassCache
42.1 Overview
The ClassCache pattern is an extension to the CallbackCache pattern. It has the same methods but instead it generates the internally used callback in base of the congured class name and the given method name.
use Zend\Cache\PatternFactory; $classCache = PatternFactory::factory(class, array( class => MyClass, storage => apc ));
197
42.5 Examples
Caching of import feeds
198
1 2 3 4 5 6 7 8 9 10 11 12
$cachedFeedReader = Zend\Cache\PatternFactory::factory(class, array( class => Zend\Feed\Reader\Reader, storage => apc, // The feed reader doesnt output anything // so the output dont need to be caught and cached cache_output => false, )); $feed = $cachedFeedReader->call("import", array(http://www.planet-php.net/rdf/)); // OR $feed = $cachedFeedReader->import(http://www.planet-php.net/rdf/);
42.5. Examples
199
200
CHAPTER 43
Zend\Cache\Pattern\ObjectCache
43.1 Overview
The ObjectCache pattern is an extension to the CallbackCache pattern. It has the same methods but instead it generates the internally used callback in base of the congured object and the given method name.
use Zend\Cache\PatternFactory; $object = new stdClass(); $objectCache = PatternFactory::factory(object, array( object => $object, storage => apc ));
201
202
generateKey(string $method, array $args = array()) Generate a unique key in base of a key representing the callback part and a key representing the arguments part. Return type string setOptions(Zend\Cache\Pattern\PatternOptions $options) Set pattern options. Return type Zend\Cache\Pattern\ObjectCache getOptions() Get all pattern options. Return type Zend\Cache\Pattern\PatternOptions
43.5 Examples
Caching a lter $filter = new Zend\Filter\RealPath(); $cachedFilter = Zend\Cache\PatternFactory::factory(object, array( object => $filter, object_key => RealpathFilter, storage => apc, // The realpath filter doesnt output anything // so the output dont need to be caught and cached cache_output => false, )); $path = $cachedFilter->call("filter", array(/www/var/path/../../mypath)); // OR $path = $cachedFilter->filter(/www/var/path/../../mypath);
1 2 3 4 5 6 7 8 9 10 11 12 13 14
43.5. Examples
203
204
CHAPTER 44
Zend\Cache\Pattern\OutputCache
44.1 Overview
The OutputCache pattern caches output between calls to start() and end().
205
Return type boolean setOptions(Zend\Cache\Pattern\PatternOptions $options) Set pattern options. Return type Zend\Cache\Pattern\OutputCache getOptions() Get all pattern options. Return type Zend\Cache\Pattern\PatternOptions
44.5 Examples
Caching simple view scripts $outputCache = Zend\Cache\PatternFactory::factory(output, array( storage => apc, )); $outputCache->start(mySimpleViewScript); include /path/to/view/script.phtml; $outputCache->end();
1 2 3 4 5 6 7
206
CHAPTER 45
Zend\Cache\Pattern\CaptureCache
45.1 Overview
The CaptureCache pattern is useful to auto-generate static resources in base of a HTTP request. The Webserver needs to be congured to run a PHP script generating the requested resource so further requests for the same resource can be shipped without calling PHP again. It comes with basic logic to manage generated resources.
# .htdocs ErrorDocument 404 /index.php // index.php use Zend\Cache\PatternFactory; $capture = Zend\Cache\PatternFactory::factory(capture, array( public_dir => __DIR__, )); // Start capturing all output excl. headers and write to public directory $capture->start(); // Dont forget to change HTTP response code header(Status: 200, true, 200); // do stuff to dynamically generate output
1 2 3 4 5 6 7 8 9 10 11 12 13
207
208
45.5 Examples
Scaling images in base of request # .htdocs ErrorDocument 404 /index.php // index.php $captureCache = Zend\Cache\PatternFactory::factory(capture, array( public_dir => __DIR__, )); // TODO
1 2
1 2 3 4 5 6
45.5. Examples
209
210
CHAPTER 46
Introduction to Zend\Captcha
CAPTCHA stands for Completely Automated Public Turing test to tell Computers and Humans Apart; it is used as a challenge-response to ensure that the individual submitting information is a human and not an automated process. Typically, a captcha is used with form submissions where authenticated users are not necessary, but you want to prevent spam submissions. Captchas can take a variety of forms, including asking logic questions, presenting skewed fonts, and presenting multiple images and asking how they relate. The Zend\Captcha component aims to provide a variety of back ends that may be utilized either standalone or in conjunction with the Zend\Form component.
211
212
CHAPTER 47
Captcha Operation
All CAPTCHA adapters implement Zend\Captcha\AdapterInterface, which looks like the following:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
namespace Zend\Captcha; use Zend\Validator\ValidatorInterface; interface AdapterInterface extends ValidatorInterface { public function generate(); public function setName($name); public function getName(); // Get helper name used for rendering this captcha type public function getHelperName(); }
The name setter and getter are used to specify and retrieve the CAPTCHA identier. The most interesting methods are generate() and render(). generate() is used to create the CAPTCHA token. This process typically will store the token in the session so that you may compare against it in subsequent requests. render() is used to render the information that represents the CAPTCHA, be it an image, a glet, a logic problem, or some other CAPTCHA. A simple use case might look like the following:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
// Originating request: $captcha = new Zend\Captcha\Figlet(array( name => foo, wordLen => 6, timeout => 300, )); $id = $captcha->generate(); //this will output a Figlet string echo $captcha->getFiglet()->render($captcha->getWord());
// On a subsequent request: // Assume a captcha setup as before, with corresponding form fields, the value of $_POST[foo]
213
16 17 18 19
// would be key/value array: id => captcha ID, input => captcha value if ($captcha->isValid($_POST[foo], $_POST)) { // Validated! }
Note: Under most circumstances, you probably prefer the use of Zend\Captcha functionality combined with the power of the Zend\Form component. For an example on how to use Zend\Form\Element\Captcha, have a look at the Zend\Form Quick Start.
214
CHAPTER 48
CAPTCHA Adapters
48.1 Zend\Captcha\AbstractWord
Zend\Captcha\AbstractWord is an abstract adapter that serves as the base class for most other CAPTCHA adapters. It provides mutators for specifying word length, session TTL and the session container object to use. Zend\Captcha\AbstractWord also encapsulates validation logic. By default, the word length is 8 characters, the session timeout is 5 minutes, and Zend\Session\Container is used for persistence (using the namespace Zend\Form\Captcha\<captcha ID>). In addition to the methods required by the Zend\Captcha\AdapterInterface Zend\Captcha\AbstractWord exposes the following methods: interface,
setWordLen($length) and getWordLen() allow you to specify the length of the generated word in characters, and to retrieve the current value. setTimeout($ttl) and getTimeout() allow you to specify the time-to-live of the session token, and to retrieve the current value. $ttl should be specied in seconds. setUseNumbers($numbers) and getUseNumbers() allow you to specify if numbers will be considered as possible characters for the random work or only letters would be used. setSessionClass($class) and getSessionClass() allow you to specify an alternate Zend\Session\Container implementation to use to persist the CAPTCHA token and to retrieve the current value. getId() allows you to retrieve the current token identier. getWord() allows you to retrieve the generated word to use with the CAPTCHA. It will generate the word for you if none has been generated yet. setSession(Zend\Session\Container $session) allows you to specify a session object to use for persisting the CAPTCHA token. getSession() allows you to retrieve the current session object. All word CAPTCHAs allow you to pass an array of options or Traversable object to the constructor, or, alternately, pass them to setOptions(). By default, the wordLen, timeout, and sessionClass keys may all be used. Each concrete implementation may dene additional keys or utilize the options in other ways.
215
48.2 Zend\Captcha\Dumb
The Zend\Captcha\Dumb adapter is mostly self-descriptive. It provides a random string that must be typed in reverse to validate. As such, its not a good CAPTCHA solution and should only be used for testing. It extends Zend\Captcha\AbstractWord.
48.3 Zend\Captcha\Figlet
The Zend\Captcha\Figlet adapter utilizes Zend\Text\Figlet to present a glet to the user. Options passed to the constructor will also be passed to the Zend\Text\Figlet object. See the Zend\Text\Figlet documentation for details on what conguration options are available.
48.4 Zend\Captcha\Image
The Zend\Captcha\Image adapter takes the generated word and renders it as an image, performing various skewing permutations to make it difcult to automatically decipher. It requires the GD extension compiled with TrueType or Freetype support. Currently, the Zend\Captcha\Image adapter can only generate PNG images. Zend\Captcha\Image extends Zend\Captcha\AbstractWord, and additionally exposes the following methods: setExpiration($expiration) and getExpiration() allow you to specify a maximum lifetime the CAPTCHA image may reside on the lesystem. This is typically a longer than the session lifetime. Garbage collection is run periodically each time the CAPTCHA object is invoked, deleting all images that have expired. Expiration values should be specied in seconds. setGcFreq($gcFreq) and getGcFreg() allow you to specify how frequently garbage collection should run. Garbage collection will run every 1/$gcFreq calls. The default is 100. setFont($font) and getFont() allow you to specify the font you will use. $font should be a fully qualied path to the font le. This value is required; the CAPTCHA will throw an exception during generation if the font le has not been specied. setFontSize($fsize) and getFontSize() allow you to specify the font size in pixels for generating the CAPTCHA. The default is 24px. setHeight($height) and getHeight() allow you to specify the height in pixels of the generated CAPTCHA image. The default is 50px. setWidth($width) and getWidth() allow you to specify the width in pixels of the generated CAPTCHA image. The default is 200px. setImgDir($imgDir) and getImgDir() allow you to specify the directory for storing CAPTCHA images. The default is ./images/captcha/, relative to the bootstrap script. setImgUrl($imgUrl) and getImgUrl() allow you to specify the relative path to a CAPTCHA image to use for HTML markup. The default is /images/captcha/. setSuffix($suffix) and getSuffix() allow you to specify the lename sufx for the CAPTCHA image. The default is .png. Note: changing this value will not change the type of the generated image.
216
setDotNoiseLevel($level) and getDotNoiseLevel(), along with setLineNoiseLevel($level) and getLineNoiseLevel(), allow you to control how much noise in the form of random dots and lines the image would contain. Each unit of $level produces one random dot or line. The default is 100 dots and 5 lines. The noise is added twice - before and after the image distortion transformation. All of the above options may be passed to the constructor by simply removing the set method prex and casting the initial letter to lowercase: sufx, height, imgUrl, etc.
48.5 Zend\Captcha\ReCaptcha
The Zend\Captcha\ReCaptcha adapter uses Zend\Service\ReCaptcha\ReCaptcha to generate and validate CAPTCHAs. It exposes the following methods: setPrivKey($key) and getPrivKey() allow you to specify the private key to use for the ReCaptcha service. This must be specied during construction, although it may be overridden at any point. setPubKey($key) and getPubKey() allow you to specify the public key to use with the ReCaptcha service. This must be specied during construction, although it may be overridden at any point. setService(ZendService\ReCaptcha\ReCaptcha $service) and getService() allow you to set and get the ReCaptcha service object.
48.5. Zend\Captcha\ReCaptcha
217
218
CHAPTER 49
Introduction to Zend\Cong
Zend\Config is designed to simplify access to conguration data within applications. It provides a nested object property-based user interface for accessing this conguration data within application code. The conguration data may come from a variety of media supporting hierarchical data storage. Currently, Zend\Config provides adapters that read and write conguration data stored in .ini, JSON, YAML and XML les.
// An array of configuration data is given $configArray = array( webhost => www.example.com, database => array( adapter => pdo_mysql, params => array( host => db.example.com, username => dbuser, password => secret, dbname => mydatabase ) ) ); // Create the object-oriented wrapper using the configuration data $config = new Zend\Config\Config($configArray); // Print a configuration datum (results in www.example.com) echo $config->webhost;
As illustrated in the example above, Zend\Config\Config provides nested object property syntax to access conguration data passed to its constructor. Along with the object-oriented access to the data values, Zend\Config\Config also has get() method that returns the supplied value if the data element doesnt exist in the conguration array. For example:
219
// config.php return array( webhost => www.example.com, database => array( adapter => pdo_mysql, params => array( host => db.example.com, username => dbuser, password => secret, dbname => mydatabase ) ) ); // Consumes the configuration array $config = new Zend\Config\Config(include config.php); // Print a configuration datum (results in www.example.com) echo $config->webhost;
1 2 3 4 5
220
CHAPTER 50
Theory of Operation
Conguration data are made accessible to Zend\Config\Configs constructor with an associative array, which may be multi-dimensional, so data can be organized from general to specic. Concrete adapter classes adapt conguration data from storage to produce the associative array for Zend\Config\Configs constructor. If needed, user scripts may provide such arrays directly to Zend\Config\Configs constructor, without using a reader class. Each value in the conguration data array becomes a property of the Zend\Config\Config object. The key is used as the property name. If a value is itself an array, then the resulting object property is created as a new Zend\Config\Config object, loaded with the array data. This occurs recursively, such that a hierarchy of conguration data may be created with any number of levels. Zend\Config\Config implements the Countable and Iterator interfaces in order to facilitate simple access to conguration data. Thus, Zend\Config\Config objects support the count() function and PHP constructs such as foreach. By default, conguration data made available through Zend\Config\Config are read-only, and an assignment (e.g. $config->database->host = example.com;) results in a thrown exception. This default behavior may be overridden through the constructor, allowing modication of data values. Also, when modications are allowed, Zend\Config\Config supports unsetting of values (i.e. unset($config->database->host)). The isReadOnly() method can be used to determine if modications to a given Zend\Config\Config object are allowed and the setReadOnly() method can be used to stop any further modications to a Zend\Config\Config object that was created allowing modications. Note: Modifying Cong does not save changes It is important not to confuse such in-memory modications with saving conguration data out to specic storage media. Tools for creating and modifying conguration data for various storage media are out of scope with respect to Zend\Config\Config. Third-party open source solutions are readily available for the purpose of creating and modifying conguration data for various storage media. If you have two Zend\Config\Config objects, you can merge them into a single object using the merge() function. For example, given $config and $localConfig, you can merge data from $localConfig to $config using $config->merge($localConfig);. The items in $localConfig will override any items with the same name in $config. Note: The Zend\Config\Config object that is performing the merge must have been constructed to allow modications, by passing TRUE as the second parameter of the constructor. The setReadOnly() method can then be used to prevent any further modications after the merge is complete.
221
222
CHAPTER 51
Zend\Cong\Reader
Zend\Config\Reader gives you the ability to read a cong le. It works with concrete implementations for different le format. The Zend\Config\Reader is only an interface, that dene the two methods fromFile() and fromString(). The concrete implementations of this interface are: Zend\Config\Reader\Ini Zend\Config\Reader\Xml Zend\Config\Reader\Json Zend\Config\Reader\Yaml The fromFile() and fromString() return a PHP array contains the data of the conguration le. Note: Differences from ZF1 The Zend\Config\Reader component no longer supports the following features: Inheritance of sections. Reading of specic sections.
51.1 Zend\Cong\Reader\Ini
Zend\Config\Reader\Ini enables developers to store conguration data in a familiar INI format and read them in the application by using an array syntax. Zend\Config\Reader\Ini utilizes the parse_ini_le() PHP function. Please review this documentation to be aware of its specic behaviors, which propagate to Zend\Config\Reader\Ini, such as how the special values of TRUE, FALSE, yes, no, and NULL are handled. Note: Key Separator By default, the key separator character is the period character (.). This can be changed, however, using the setNestSeparator() method. For example:
1 2
223
The following example illustrates a basic use of Zend\Config\Reader\Ini for loading conguration data from an INI le. In this example there are conguration data for both a production system and for a staging system. Suppose we have the following INI conguration le:
1 2 3 4 5 6
= = = = = =
$reader = new Zend\Config\Reader\Ini(); $data = $reader->fromFile(/path/to/config.ini); echo $data[webhost] // prints "www.example.com" echo $data[database][params][dbname]; // prints "dbproduction"
The Zend\Config\Reader\Ini supports a feature to include the content of a INI le in a specic section of another INI le. For instance, suppose we have an INI le with the database conguration:
1 2 3 4 5
= = = = =
If we read this le using the component Zend\Config\Reader\Ini we will obtain the same conguration data structure of the previous example. The @include = file-to-include.ini can be used also in a subelement of a value. For instance we can have an INI le like that:
1 2 3 4 5
= = = = =
51.2 Zend\Cong\Reader\Xml
Zend\Config\Reader\Xml enables developers to read conguration data in a familiar XML format and read them in the application by using an array syntax. The root element of the XML le or string is irrelevant and may be named arbitrarily.
224
The following example illustrates a basic use of Zend\Config\Reader\Xml for loading conguration data from an XML le. Suppose we have the following XML conguration le:
1 2 3 4 5 6 7 8 9 10 11 12 13
<?xml version="1.0" encoding="utf-8"?>?> <config> <webhost>www.example.com</webhost> <database> <adapter value="pdo_mysql"/> <params> <host value="db.example.com"/> <username value="dbuser"/> <password value="secret"/> <dbname value="dbproduction"/> </params> </database> </config>
$reader = new Zend\Config\Reader\Xml(); $data = $reader->fromFile(/path/to/config.xml); echo $data[webhost] // prints "www.example.com" echo $data[database][params][dbname]; // prints "dbproduction"
Zend\Config\Reader\Xml utilizes the XMLReader PHP class. Please review this documentation to be aware of its specic behaviors, which propagate to Zend\Config\Reader\Xml. Using Zend\Config\Reader\Xml we can include the content of XML les in a specic XML element. This is provided using the standard function XInclude of XML. To use this function you have to add the namespace xmlns:xi="http://www.w3.org/2001/XInclude" to the XML le. Suppose we have an XML les that contains only the database conguration:
1 2 3 4 5 6 7 8 9 10 11 12
<?xml version="1.0" encoding="utf-8"?> <config> <database> <adapter>pdo_mysql</adapter> <params> <host>db.example.com</host> <username>dbuser</username> <password>secret</password> <dbname>dbproduction</dbname> </params> </database> </config>
51.2. Zend\Cong\Reader\Xml
225
51.3 Zend\Cong\Reader\Json
Zend\Config\Reader\Json enables developers to read conguration data in a JSON format and read them in the application by using an array syntax. The following example illustrates a basic use of Zend\Config\Reader\Json for loading conguration data from a JSON le. Suppose we have the following JSON conguration le:
1 2 3 4 5 6 7 8 9 10 11 12
{ "webhost" : "www.example.com", "database" : { "adapter" : "pdo_mysql", "params" : { "host" : "db.example.com", "username" : "dbuser", "password" : "secret", "dbname" : "dbproduction" } } }
$reader = new Zend\Config\Reader\Json(); $data = $reader->fromFile(/path/to/config.json); echo $data[webhost] // prints "www.example.com" echo $data[database][params][dbname]; // prints "dbproduction"
Zend\Config\Reader\Json utilizes the Zend\Json\Json class. Using Zend\Config\Reader\Json we can include the content of a JSON le in a specic JSON section or element. This is provided using the special syntax @include. Suppose we have a JSON le that contains only the database conguration:
1 2 3 4 5 6 7 8 9 10 11
{ "database" : { "adapter" : "pdo_mysql", "params" : { "host" : "db.example.com", "username" : "dbuser", "password" : "secret", "dbname" : "dbproduction" } } }
226
51.4 Zend\Cong\Reader\Yaml
Zend\Config\Reader\Yaml enables developers to read conguration data in a YAML format and read them in the application by using an array syntax. In order to use the YAML reader we need to pass a callback to an external PHP library or use the Yaml PECL extension. The following example illustrates a basic use of Zend\Config\Reader\Yaml that use the Yaml PECL extension. Suppose we have the following YAML conguration le:
1 2 3 4 5 6 7 8
webhost: www.example.com database: adapter: pdo_mysql params: host: db.example.com username: dbuser password: secret dbname: dbproduction
$reader = new Zend\Config\Reader\Yaml(); $data = $reader->fromFile(/path/to/config.yaml); echo $data[webhost] // prints "www.example.com" echo $data[database][params][dbname]; // prints "dbproduction"
If you want to use an external YAML reader you have to pass the callback function in the constructor of the class. For instance, if you want to use the Spyc library:
1 2 3 4 5 6 7 8
// include the Spyc library require_once (path/to/spyc.php); $reader = new Zend\Config\Reader\Yaml(array(Spyc,YAMLLoadString)); $data = $reader->fromFile(/path/to/config.yaml); echo $data[webhost] // prints "www.example.com" echo $data[database][params][dbname]; // prints "dbproduction"
You can also instantiate the Zend\Config\Reader\Yaml without any parameter and specify the YAML reader in a second moment using the setYamlDecoder() method. Using Zend\Config\ReaderYaml we can include the content of a YAML le in a specic YAML section or element. This is provided using the special syntax @include. Suppose we have a YAML le that contains only the database conguration:
1 2 3 4 5 6 7
database: adapter: pdo_mysql params: host: db.example.com username: dbuser password: secret dbname: dbproduction
51.4. Zend\Cong\Reader\Yaml
227
228
CHAPTER 52
Zend\Cong\Writer
Zend\Config\Writer gives you the ability to write cong les out of array, Zend\Config\Config and any Traversable object. The Zend\Config\Writer is an interface that denes two methods: toFile() and toString(). We have ve specic writers that implement this interface: Zend\Config\Writer\Ini Zend\Config\Writer\Xml Zend\Config\Writer\PhpArray Zend\Config\Writer\Json Zend\Config\Writer\Yaml
52.1 Zend\Cong\Writer\Ini
The INI writer has two modes for rendering with regard to sections. By default the top-level conguration is always written into section names. By calling $writer->setRenderWithoutSectionsFlags(true); all options are written into the global namespace of the INI le and no sections are applied. As an addition Zend\Config\Writer\Ini has an additional option parameter nestSeparator, which denes with which character the single nodes are separated. The default is a single dot, like it is accepted by Zend\Config\Reader\Ini by default. When modifying or creating a Zend\Config\Config object, there are some things to know. To create or modify a value, you simply say set the parameter of the Config object via the parameter accessor (->). To create a section in the root or to create a branch, you just create a new array ($config->branch = array();).
Using Zend\Cong\Writer\Ini
This example illustrates the basic use of Zend\Config\Writer\Ini to create a new cong le:
1 2 3 4 5 6
// Create the config object $config = new Zend\Config\Config(array(), true); $config->production = array(); $config->production->webhost = www.example.com; $config->production->database = array();
229
7 8 9 10 11 12 13 14
$config->production->database->params = array(); $config->production->database->params->host = localhost; $config->production->database->params->username = production; $config->production->database->params->password = secret; $config->production->database->params->dbname = dbproduction; $writer = new Zend\Config\Writer\Ini(); echo $writer->toString($config);
The result of this code is an INI string contains the following values:
1 2 3 4 5 6
[production] webhost = "www.example.com" database.params.host = "localhost" database.params.username = "production" database.params.password = "secret" database.params.dbname = "dbproduction"
You can use the method toFile() to store the INI data in a le.
52.2 Zend\Cong\Writer\Xml
The Zend\Config\Writer\Xml can be used to generate an XML string or le starting from a Zend\Config\Config object.
Using Zend\Cong\Writer\Ini
This example illustrates the basic use of Zend\Config\Writer\Xml to create a new cong le:
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// Create the config object $config = new Zend\Config\Config(array(), true); $config->production = array(); $config->production->webhost = www.example.com; $config->production->database = array(); $config->production->database->params = array(); $config->production->database->params->host = localhost; $config->production->database->params->username = production; $config->production->database->params->password = secret; $config->production->database->params->dbname = dbproduction; $writer = new Zend\Config\Writer\Xml(); echo $writer->toString($config);
The result of this code is an XML string contains the following data:
1 2 3 4 5 6 7 8 9
<?xml version="1.0" encoding="UTF-8"?> <zend-config> <production> <webhost>www.example.com</webhost> <database> <params> <host>localhost</host> <username>production</username> <password>secret</password>
230
10 11 12 13 14
You can use the method toFile() to store the XML data in a le.
52.3 Zend\Cong\Writer\PhpArray
The Zend\Config\Writer\PhpArray can be used to generate a PHP code that returns an array representation of an Zend\Config\Config object.
Using Zend\Cong\Writer\PhpArray
This example illustrates the basic use of Zend\Config\Writer\PhpArray to create a new cong le:
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// Create the config object $config = new Zend\Config\Config(array(), true); $config->production = array(); $config->production->webhost = www.example.com; $config->production->database = array(); $config->production->database->params = array(); $config->production->database->params->host = localhost; $config->production->database->params->username = production; $config->production->database->params->password = secret; $config->production->database->params->dbname = dbproduction; $writer = new Zend\Config\Writer\PhpArray(); echo $writer->toString($config);
The result of this code is a PHP script that returns an array as follow:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
<?php return array ( production => array ( webhost => www.example.com, database => array ( params => array ( host => localhost, username => production, password => secret, dbname => dbproduction, ), ), ), );
You can use the method toFile() to store the PHP script in a le.
52.3. Zend\Cong\Writer\PhpArray
231
52.4 Zend\Cong\Writer\Json
The Zend\Config\Writer\Json can be used to generate a PHP code that returns the JSON representation of a Zend\Config\Config object.
Using Zend\Cong\Writer\Json
This example illustrates the basic use of Zend\Config\Writer\Json to create a new cong le:
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// Create the config object $config = new Zend\Config\Config(array(), true); $config->production = array(); $config->production->webhost = www.example.com; $config->production->database = array(); $config->production->database->params = array(); $config->production->database->params->host = localhost; $config->production->database->params->username = production; $config->production->database->params->password = secret; $config->production->database->params->dbname = dbproduction; $writer = new Zend\Config\Writer\Json(); echo $writer->toString($config);
The result of this code is a JSON string contains the following values:
1 2 3 4 5 6 7 8 9 10
{ "webhost" : "www.example.com", "database" : { "params" : { "host" : "localhost", "username" : "production", "password" : "secret", "dbname" : "dbproduction" } } }
You can use the method toFile() to store the JSON data in a le. The Zend\Config\Writer\Json class uses the Zend\Json\Json component to convert the data in a JSON format.
52.5 Zend\Cong\Writer\Yaml
The Zend\Config\Writer\Yaml can be used to generate a PHP code that returns the YAML representation of a Zend\Config\Config object. In order to use the YAML writer we need to pass a callback to an external PHP library or use the Yaml PECL extension.
Using Zend\Cong\Writer\Yaml
This example illustrates the basic use of Zend\Config\Writer\Yaml to create a new cong le using the Yaml PECL extension:
232
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// Create the config object $config = new Zend\Config\Config(array(), true); $config->production = array(); $config->production->webhost = www.example.com; $config->production->database = array(); $config->production->database->params = array(); $config->production->database->params->host = localhost; $config->production->database->params->username = production; $config->production->database->params->password = secret; $config->production->database->params->dbname = dbproduction; $writer = new Zend\Config\Writer\Yaml(); echo $writer->toString($config);
The result of this code is a YAML string contains the following values:
1 2 3 4 5 6 7
webhost: www.example.com database: params: host: localhost username: production password: secret dbname: dbproduction
You can use the method toFile() to store the YAML data in a le. If you want to use an external YAML writer library you have to pass the callback function in the constructor of the class. For instance, if you want to use the Spyc library:
1 2 3 4 5
// include the Spyc library require_once (path/to/spyc.php); $writer = new Zend\Config\Writer\Yaml(array(Spyc,YAMLDump)); echo $writer->toString($config);
52.5. Zend\Cong\Writer\Yaml
233
234
CHAPTER 53
Zend\Cong\Processor
Zend\Config\Processor gives you the ability to perform some operations on a Zend\Config\Config object. The Zend\Config\Processor is an interface that denes two methods: process() and processValue(). These operations are provided by the following concrete implementations: Zend\Config\Processor\Constant: manage PHP constant values; Zend\Config\Processor\Filter: lter the conguration data using Zend\Filter; Zend\Config\Processor\Queue: manage a queue of operations to apply to conguration data; Zend\Config\Processor\Token: nd and replace specic tokens; Zend\Config\Processor\Translator: Zend\I18n\Translator; translate conguration values in other languages using
53.1 Zend\Cong\Processor\Constant
Using Zend\Cong\Processor\Constant
define (TEST_CONST, bar); // set true to Zend\Config\Config to allow modifications $config = new Zend\Config\Config(array(foo => TEST_CONST), true); $processor = new Zend\Config\Processor\Constant(); echo $config->foo . ,; $processor->process($config); echo $config->foo;
235
53.2 Zend\Cong\Processor\Filter
Using Zend\Cong\Processor\Filter
use Zend\Filter\StringToUpper; use Zend\Config\Processor\Filter as FilterProcessor; use Zend\Config\Config; $config = new Config(array (foo => bar), true); $upper = new StringToUpper(); $upperProcessor = new FilterProcessor($upper); echo $config->foo . ,; $upperProcessor->process($config); echo $config->foo;
53.3 Zend\Cong\Processor\Queue
Using Zend\Cong\Processor\Queue
$config = new Config(array (foo => bar), true); $upper = new StringToUpper(); $lower = new StringToLower(); $lowerProcessor = new FilterProcessor($lower); $upperProcessor = new FilterProcessor($upper); $queue = new Queue(); $queue->insert($upperProcessor); $queue->insert($lowerProcessor); $queue->process($config); echo $config->foo;
This example returns the output: bar. The lters in the queue are applied with a FIFO logic (First In, First Out).
236
53.4 Zend\Cong\Processor\Token
Using Zend\Cong\Processor\Token
// set the Config to true to allow modifications $config = new Config(array(foo => Value is TOKEN), true); $processor = new TokenProcessor(); $processor->addToken(TOKEN, bar); echo $config->foo . ,; $processor->process($config); echo $config->foo;
53.5 Zend\Cong\Processor\Translator
Using Zend\Cong\Processor\Translator
use Zend\Config\Config; use Zend\Config\Processor\Translator as TranslatorProcessor; use Zend\I18n\Translator\Translator; $config = new Config(array(animal => dog), true); /* * The following mapping would exist for the translation * loader you provide to the translator instance * $italian = array( dog => cane * * ); */ $translator = new Translator(); // ... configure the translator ... $processor = new TranslatorProcessor($translator); echo "English: {$config->animal}, "; $processor->process($config); echo "Italian: {$config->animal}";
dog, Italian:
cane.
53.4. Zend\Cong\Processor\Token
237
238
CHAPTER 54
The Factory
The factory gives you the ability to load a conguration le to an array or to Zend\Config\Config object. The factory has two purposes Loading conguration le(s) Storing a conguration le Note: Storing the conguration will be done to one le. The factory is not aware of merging two or more congurations and will not store it into multiple les. If you want to store particular conguration sections to a different le you should separate it manually.
//Load a php file as array $config = Zend\Config\Factory::fromFile(__DIR__./config/my.config.php); //Load a xml file as Config object $config = Zend\Config\Factory::fromFile(__DIR__./config/my.config.xml, true);
239
240
CHAPTER 55
Introduction to Zend\Console
Zend Framework 2 features built-in console support. When a Zend\Application is run from a console window (a shell window or Windows command prompt), it will recognize this fact and prepare Zend\Mvc components to handle the request. Console support is enabled by default, but to function properly it requires at least one console route and one action controller to handle the request. Console routing allows you to invoke controllers and action depending on command line parameters provided by the user. Module Manager integration allows ZF2 applications and modules to display help and usage information, in case the command line has not been understood (no route matched). Console-aware action controllers will receive a console request containing all named parameters and ags. They are able to send output back to the console window. Console adapters provide a level of abstraction for interacting with console on different operating systems. Console prompts can be used to interact with the user by asking him questions and retrieving input.
When a user runs our application (zf) with these parameters, wed like to call action resetpassword of Application\Controller\IndexController. Note: We will use zf to depict the entry point for your application, it can be shell script in application bin folder or simply an alias for php public/index.php First we need to create a route denition:
user resetpassword <userEmail>
241
This simple route denition expects exactly 3 arguments: a literal user, literal resetpassword followed by a parameter were calling userEmail. Lets assume we also accept one optional parameter, that will turn on verbose operation:
user resetpassword [--verbose|-v] <userEmail>
Now our console route expects the same 3 parameters but will also recognise an optional --verbose ag, or its shorthand version: -v. Note: The order of ags is ignored by Zend\Console. Flags can appear before positional parameters, after them or anywhere in between. The order of multiple ags is also irrelevant. This applies both to route denitions and the order that ags are used on the command line. Lets use the denition above and congure our console route. Console routes are automatically loaded from the following location inside cong le:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
array( router => array( routes => array( // HTTP routes are defined here ) ), console => array( router => array( routes => array( // Console routes go here ) ) ), )
// we could define routes for Application\Controller\IndexController in Application module config fil // which is usually located at modules/application/config/module.config.php array( console => array( router => array( routes => array( user-reset-password => array( options => array( route => user resetpassword [--verbose|-v] <userEmail>, defaults => array( controller => Application\Controller\Index, action => password ) ) ) ) ) ) )
See Also: To learn more about console routes and how to use them, please read this chapter: Console routes and routing
242
<?php namespace Application\Controller; use use use use Zend\Mvc\Controller\AbstractActionController; Zend\View\Model\ViewModel; Zend\Console\Request as ConsoleRequest; Zend\Math\Rand;
class IndexController extends AbstractActionController { public function indexAction() { return new ViewModel(); // display standard index page } public function resetpasswordAction(){ $request = $this->getRequest(); // Make sure that we are running in a console and the user has not tricked our // application into running this action from a public web server. if (!$request instanceof ConsoleRequest){ throw new \RuntimeException(You can only use this action from a console!); } // Get user email from console and check if the user used --verbose or -v flag $userEmail = $request->getParam(userEmail); $verbose = $request->getParam(verbose); // reset new password $newPassword = Rand::getString(16); // Fetch the user and change his password, then email him ... // [...]
if (!$verbose){ return "Done! $userEmail has received an email with his new password.\n"; }else{ return "Done! New password for user $userEmail is $newPassword . It has also been emaile } } }
We have created resetpasswordAction() than retrieves current request and checks if its really coming from the console (as a precaution). In this example we do not want our action to be invocable from a web page. Because we have not dened any http route pointing to it, it should never be possible. However in the future, we might dene a wildcard route or a 3rd party module might erroneously route some requests to our action - that is why we want to make sure that the request is always coming from a Console environment. All console arguments supplied by the user are accessible via $request->getParam() method. Flags will be represented by a booleans, where true means a ag has been used and false otherwise. When our action has nished working it returns a simple string that will be shown to the user in console window. 55.2. Handling console requests 243
See Also: There are different ways you can interact with console from a controller. It has been covered in more detail in the following chapter: Console-aware action controllers
<?php namespace Application; use Zend\ModuleManager\Feature\ConfigProviderInterface; use Zend\ModuleManager\Feature\ConsoleUsageProviderInterface; use Zend\Console\Adapter\AdapterInterface as Console; class Module implements AutoloaderProviderInterface, ConfigProviderInterface, ConsoleUsageProviderInterface { public function getConfig() { // [...] }
// <- our module implement this feature and provides console usag
public function getAutoloaderConfig() { // [...] } public function getConsoleUsage(Console $console){ return array( // Describe available commands user resetpassword [--verbose|-v] EMAIL
// Describe expected parameters array( EMAIL, Email of the user for a password reset ), array( --verbose|-v, (optional) turn on verbose mode ), ); } }
Each module that implements ConsoleUsageProviderInterface will be queried for console usage info. On route mismatch, all info from all modules will be concatenated, formatted to console width and shown to the user. Note: The order of usage info displayed in the console is the order modules load. If you want your application to display important usage info rst, change the order your modules are loaded. See Also: 244 Chapter 55. Introduction to Zend\Console
Modules can also provide an application banner (title). To learn more about the format expected from getConsoleUsage() and about application banners, please read this chapter: Console-aware modules
245
246
CHAPTER 56
Zend Framework 2 has native MVC integration with console, which means that command line arguments are read and used to determine the appropriate action controller and action method that will handle the request. Actions can perform any number of task prior to returning a result, that will be displayed to the user in his console window. There are several routes you can use with Console. All of them are dened in Zend\Mvc\Router\Console\* classes. See Also: Routes are used to handle real commands, but they are not used to create help messages (usage information). When a zf2 application is run in console for the rst time (without arguments) it can display usage information that is provided by modules. To learn more about providing usage information, please read this chapter: Console-aware modules.
// This can sit inside of modules/Application/config/module.config.php or any other modules config. array( router => array( routes => array( // HTTP routes are here ) ), console => array( router => array( routes => array( // Console routes go here ) ) ), )
Console Routes will only be processed when the application is run inside console (terminal) window. They have no effect in web (http) request and will be ignored. It is possible to dene only HTTP routes (only web application) or only Console routes (which means we want a console-only application which will refuse to run in a browser). A single route can be described with the following array: 247
1 2 3 4 5 6 7 8 9 10 11 12
// inside config.console.router.routes: // [...] my-first-route => array( type => simple, // <- simple route is created by default, we can skip that options => array( route => foo bar, defaults => array( controller => Application\Controller\Index, action => password ) ) )
We have created a simple console route with a name my-first-route. It expects two parameters: foo and bar. If user puts these in a console, Application\Controller\IndexController::passwordAction() action will be invoked. See Also: You can read more about how ZF2 routing works in this chapter.
show-users => array( options => array( route => show users, defaults => array( controller => Application\Controller\Users, action => show ) ) )
This route will only match for the following command line
> zf show users
It expects mandatory literal parameters show users. It will not match if there are any more params, or if one of the words is missing. The order of words is also enforced. We can also provide optional literal parameters, for example:
248
1 2 3 4 5 6 7 8 9
show-users => array( options => array( route => show [all] users, defaults => array( controller => Application\Controller\Users, action => show ) ) )
show-users => array( options => array( route => show [all|deleted|locked|admin] users, defaults => array( controller => Application\Controller\Users, action => show ) ) )
This route will match both without and with second parameter being one of the words, which enables us to capture commands such:
> zf show users > zf show locked users > zf show admin users etc.
Note: Whitespaces in route denition are ignored. If you separate your parameters with more spaces, or separate alternatives and pipe characters with spaces, it wont matter for the parser. The above route denition is equivalent to: show [ all | deleted | locked | admin ] users
check-users => array( options => array( route => check users [--verbose] [--fast] [--thorough], defaults => array( controller => Application\Controller\Users, action => check ) ) )
This route will match for commands like: 56.2. Basic route 249
zf zf zf zf
We can also dene one or more mandatory long ags and group them as an alternative:
1 2 3 4 5 6 7 8 9
check-users => array( options => array( route => check users (--suspicious|--expired) [--verbose] [--fast] [--thorough], defaults => array( controller => Application\Controller\Users, action => check ) ) )
This route will only match if we provide either --suspicious or --expired ag, i.e.:
> zf check users --expired > zf check users --expired --fast > zf check users --verbose --thorough --suspicious
We can also use short ags in our routes and group them with long ags for convenience, for example:
1 2 3 4 5 6 7 8 9
check-users => array( options => array( route => check users [--verbose|-v] [--fast|-f] [--thorough|-t], defaults => array( controller => Application\Controller\Users, action => check ) ) )
delete-user => array( options => array( route => delete user <userEmail>, defaults => array( controller => Application\Controller\Users, action => delete ) ) )
This route will match for commands like: 250 Chapter 56. Console routes and routing
We can access the email value by calling $this->getRequest()->getParam(userEmail) inside of our controller action (you can read more about accessing values here) We can also dene optional positional value parameters by adding square brackets:
1 2 3 4 5 6 7 8 9
delete-user => array( options => array( route => delete user [<userEmail>], defaults => array( controller => Application\Controller\Users, action => delete ) ) )
In this case, userEmail parameter will not be required for the route to match. If it is not provided, userEmail parameter will not be set. We can dene any number of positional value parameters, for example:
1 2 3 4 5 6 7 8 9
create-user => array( options => array( route => create user <firstName> <lastName> <email> <position>, defaults => array( controller => Application\Controller\Users, action => create ) ) )
Note: Command line arguments on all systems must be properly escaped, otherwise they will not be passed to our application correctly. For example, to create a user with two names and a complex position description, we could write something like this:
> zf create user "Johnan Tom" Bravo john@acme.org "Head of the Entertainment Department"
find-user => array( options => array( route => find user [--id=] [--firstName=] [--lastName=] [--email=] [--position=] , defaults => array( controller => Application\Controller\Users, action => find )
251
8 9
) )
Note: The parser understands values that are provided after equal symbol (=) and separated by a space. Values without whitespaces can be provided after = symbol or after a space. Values with one more whitespaces however, must be properly quoted and written after a space. In previous example, all value ags are optional. It is also possible to dene mandatory value ags:
1 2 3 4 5 6 7 8 9
rename-user => array( options => array( route => rename user --id= [--firstName=] [--lastName=], defaults => array( controller => Application\Controller\Users, action => rename ) ) )
The --id parameter is required for this route to match. The following commands will work with this route:
> zf rename user --id 123 > zf rename user --id 123 --firstName Jonathan > zf rename user --id=123 --lastName=Bravo
default-route => array( options => array( type => catchall, defaults => array( controller => Application\Controller\Index, action => consoledefault ) ) )
Note: This route type is rarely used. You could use it as a last console route, to display usage information. Before you do so, read about the preferred way of displaying console usage information. It is the recommended way and will guarantee proper inter-operation with other modules in your application. 252 Chapter 56. Console routes and routing
foo --bar foo [--bar] foo [--bar|--baz] foo -b foo [-b] foo [-b|-z] foo [--bar|-b]
foo as rst parameter, bar ag before or after foo as rst parameter, optional bar ag before or after foo as rst parameter, optional bar or baz, before or after foo as rst parameter, -b ag before or after foo as rst parameter, optional -b ag before or after foo as rst parameter, optional -b or -z, before or after foo as rst parameter, optional bar or -b before or after foo followed by any text (stored as bar param) foo, optionally followed by any text (stored as bar param) foo as rst parameter, bar with a value, before or after foo as rst parameter, optionally bar with a value, before or after
foo foo followed by bar or baz (stored as myParam (bar|baz):myParam param) foo foo followed by optional bar or baz (stored as [bar|baz]:myParam myParam param) foo foo, bar or baz ag before or after (stored as (--bar|--baz):myParam myParam param) foo foo, optional bar or baz ag before or after (as [--bar|--baz]:myParam myParam param) foo foo, -b or -z ag before or after (stored as (-b|-z):myParam myParam param) foo foo, optional -b or -z ag before or after (stored [-b|-z]:myParam as myParam param)
253
254
CHAPTER 57
Console-aware modules
Zend Framework 2 has native MVC integration with console. The integration also works with modules loaded with Module Manager. ZF2 ships with RouteNotFoundStrategy which is responsible of displaying usage information inside Console, in case the user has not provided any arguments, or arguments could not be understood. The strategy currently supports two types of information: application banners and usage information.
Our Application module (and any other module) can provide application banner. In order to do so, our Module class has to implement Zend\ModuleManager\Feature\ConsoleBannerProviderInterface. Lets do this now.
255
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
// modules/Application/Module.php <?php namespace Application; use Zend\ModuleManager\Feature\ConsoleBannerProviderInterface; use Zend\Console\Adapter\AdapterInterface as Console; class Module implements ConsoleBannerProviderInterface { /** * This method is defined in ConsoleBannerProviderInterface */ public function getConsoleBanner(Console $console) { return MyModule 0.0.1; } }
As you can see, the application banner should be a single line string that returns the modules name and (if available) its current version. If several modules dene their own banner, they are all shown one after the other (they will be joined together in the order modules are loaded). This way, it makes it very easy to spot which modules provide console commands. After running our application, well see our newly created banner.
<?php // config/application.config.php return array( modules => array( Application, User, // < load user module in modules/User ),
256
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
// modules/User/Module.php <?php namespace User; use Zend\ModuleManager\Feature\ConsoleBannerProviderInterface; use Zend\Console\Adapter\AdapterInterface as Console; class Module implements ConsoleBannerProviderInterface { /** * This method is defined in ConsoleBannerProviderInterface */ public function getConsoleBanner(Console $console){ return "User Module 0.0.1"; } }
Because User module is loaded after Application module, the result will look like this:
Note: Application banner is displayed as-is - no trimming or other adjustments will be performed on the text. As you can see, banners are also automatically colorized as blue.
257
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
use Zend\ModuleManager\Feature\ConsoleUsageProviderInterface; use Zend\Console\Adapter\AdapterInterface as Console; class Module implements ConsoleBannerProviderInterface, ConsoleUsageProviderInterface { public function getConsoleBanner(Console $console){ // ... } /** * This method is defined in ConsoleUsageProviderInterface */ public function getConsoleUsage(Console $console) { return array( show stats => Show application statistics, run cron => Run automated jobs, (enable|disable) debug => Enable or disable debug mode for the application. ); } }
Similar to application banner multiple modules can provide usage information, which will be joined together and displayed to the user. The order in which usage information is displayed is the order in which modules are loaded. As you can see, Console component also prepended each modules usage by the modules name. This helps to visually
258
separate each modules (this can be useful when you have multiple modules that provide commands). By default, the component colorizes those in red. Note: Usage info provided in modules does not connect with console routing. You can describe console usage in any form you prefer and it does not affect how MVC handles console commands. In order to handle real console requests you need to dene 1 or more console routes.
public function getConsoleUsage(Console $console) { return User module expects exactly one argument - user name. It will display information for thi }
Note: The text provided is displayed as-is - no trimming or other adjustments will be performed. If youd like to t your usage information inside console window, you could check its width with $console->getWidth().
259
public function getConsoleUsage(Console $console) { return array( delete user <userEmail> => Delete user with email <userEmail>, disable user <userEmail> => Disable user with email <userEmail>, list [all|disabled] users => Show a list of users, find user [--email=] [--name=] => Attempt to find a user by email or name, ); }
Note: Commands and their descriptions will be aligned in two columns, that t inside Console window. If the window is resized, some texts might be wrapped but all content will be aligned accordingly. If you dont like this behavior, you can always return free-form text that will not be transformed in any way.
260
1 2 3 4 5 6 7 8 9
public function getConsoleUsage(Console $console){ return array( array( <userEmail> , email of the user ), array( --verbose , Turn on verbose mode ), array( --quick , Perform a "quick" operation ), array( -v , Same as --verbose ), array( -w , Wide output) ); }
Using this method, we can display more than 2 columns of information, for example:
1 2 3 4 5 6 7 8 9
public function getConsoleUsage(Console $console){ return array( array( <userEmail> , user email array( --verbose , verbose mode array( --quick , "quick" operation array( -v , Same as --verbose array( -w , wide output ); }
, , , , ,
Full email address of the user to find. ), Display additional information during processin Do not check integrity, just make changes and f Display additional information during processin When listing users, use the whole available scr
261
Note: All info will be aligned in one or more columns that t inside Console window. If the window is resized, some texts might be wrapped but all content will be aligned accordingly. In case the number of columns changes (i.e. the array() contains different number of elements) a new table will be started, with new alignment and different column widths. If you dont like this behavior, you can always return free-form text that will not be transformed in any way.
public function getConsoleUsage(Console $console){ return array( Finding and listing users, list [all|disabled] users [-w] => Show a list of users, find user [--email=] [--name=] => Attempt to find a user by email or name, array([all|disabled], array(--email=EMAIL, array(--name=NAME, array(-w,
Display all users or only disabled accounts), Email of the user to find), Full name of the user to find.), Wide output - When listing users use the whole available screen w
Manipulation of user database:, delete user <userEmail> [--verbose|-v] [--quick] disable user <userEmail> [--verbose|-v]
=> Delete user with email <userEmail>, => Disable user with email <userEmail>,
array( <userEmail> , user email , Full email address of the user to change. ), array( --verbose , verbose mode , Display additional information during processin array( --quick , "quick" operation , Do not check integrity, just make changes and f
262
19 20 21 22
array( -v ); }
263
264
CHAPTER 58
Zend Framework 2 has built-in MVC integration with the console. When the user runs an application in a console window, the request will be routed. By matching command line arguments against console routes we have dened in our application, the MVC will invoke a controller and an action. In this chapter we will learn how ZF2 Controllers can interact with and return output to console window. See Also: In order for a controller to be invoked, at least one route must point to it. To learn about creating console routes, please read the chapter Console routes and routing
// FILE: modules/Application/config/module.config.php array( router => array( routes => array( // HTTP routes are here ) ), console => array( router => array( routes => array( list-users => array( options => array( route => show [all|disabled|deleted]:mode users [--verbose|-v],
265
15 16 17 18 19 20 21 22 23 24
This route points to the method Application\Controller\IndexController::showUsersAction(). Lets add it to our controller.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
<?php namespace Application\Controller; use Zend\Mvc\Controller\AbstractActionController; use Zend\View\Model\ViewModel; class IndexController extends AbstractActionController { public function indexAction() { return new ViewModel(); // display standard index page } public function showUsersAction() { $request = $this->getRequest(); // Check verbose flag $verbose = $request->getParam(verbose) || $request->getParam(v); // Check mode $mode = $request->getParam(mode, all); // defaults to all $users = array(); switch ($mode) { case disabled: $users = $this->getServiceLocator()->get(users)->fetchDisabledUsers(); break; case deleted: $users = $this->getServiceLocator()->get(users)->fetchDeletedUsers(); break; case all: default: $users = $this->getServiceLocator()->get(users)->fetchAllUsers(); break; } } }
266
We fetch the console request, read parameters, and load users from our (theoretical) users service. In order to make this method functional, well have to display the result in the console window.
public function showUsersAction() { $request = $this->getRequest(); // Check verbose flag $verbose = $request->getParam(verbose) || $request->getParam(v); // Check mode $mode = $request->getParam(mode, all); // defaults to all $users = array(); switch ($mode) { case disabled: $users = $this->getServiceLocator()->get(users)->fetchDisabledUsers(); break; case deleted: $users = $this->getServiceLocator()->get(users)->fetchDeletedUsers(); break; case all: default: $users = $this->getServiceLocator()->get(users)->fetchAllUsers(); break; } if (count($users) == 0) { // Show an error message in the console return "There are no users in the database\n"; } $result = ; foreach ($users as $user) { $result .= $user->name . . $user->email . "\n"; } return $result; // show it in the console }
On line 27, we are checking if the users service found any users - otherwise we are returning an error message that will be immediately displayed and the application will end. If there are 1 or more users, we will loop through them with and prepare a listing. It is then returned from the action and displayed in the console window.
267
namespace Application\Controller; use use use use Zend\Mvc\Controller\AbstractActionController; Zend\View\Model\ViewModel; Zend\Console\Request as ConsoleRequest; RuntimeException;
class IndexController extends AbstractActionController { public function showUsersAction() { $request = $this->getRequest(); // Make sure that we are running in a console and the user has not tricked our // application into running this action from a public web server. if (!$request instanceof ConsoleRequest) { throw new RuntimeException(You can only use this action from a console!); } // ... } }
Note: You do not need to secure all your controllers and methods from console requests. Controller actions will only be invoked when at least one console route matches it. HTTP and Console routes are separated and dened in different places in module (and application) conguration. There is no way to invoke a console action unless there is at least one route pointing to it. Similarly, there is no way for an HTTP action to be invoked unless there is at least one HTTP route that points to it. The example below shows how a single controller method can handle both Console and HTTP requests:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
namespace Application\Controller; use use use use use Zend\Mvc\Controller\AbstractActionController; Zend\View\Model\ViewModel; Zend\Console\Request as ConsoleRequest; Zend\Http\Request as HttpRequest; RuntimeException;
class IndexController extends AbstractActionController { public function showUsersAction() { $request = $this->getRequest(); $users = array(); // ... fetch users from database ... if ($request instanceof HttpRequest) { // display a web page with users list
268
20 21 22 23 24 25 26 27 28
return new ViewModel($result); } elseif ($request instanceof ConsoleRequest) { // ... prepare console output and return it ... return $result; } else { throw new RuntimeException(Cannot handle request of type . get_class($request)); } } }
// inside of config.console.router.routes: show-users => array( options => array( route => show (all|deleted|locked|admin) [<groupName>] defaults => array( controller => Application\Controller\Users, action => showusers ) ) )
If this route matches, our action can now query parameters in the following way:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
// an action inside Application\Controller\UsersController: public function showUsersAction() { $request = $this->getRequest(); // We can access named value parameters directly by their name: $showUsersFromGroup = $request->getParam(groupName); // Literal parameters can be checked with isset() against their exact spelling if (isset($request->getParam(all))) { // show all users } elseif (isset($request->getParam(deleted))) { // show deleted users } // ... }
In case of parameter alternatives, it is a good idea to assign a name to the group, which simplies the branching in our action controllers. We can do this with the following syntax:
269
1 2 3 4 5 6 7 8 9 10
// inside of config.console.router.routes: show-users => array( options => array( route => show (all|deleted|locked|admin):userTypeFilter [<groupName>] defaults => array( controller => Application\Controller\Users, action => showusers ) ) )
Now we can use a the group name userTypeFilter to check which option has been selected by the user:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
public function showUsersAction() { $request = $this->getRequest(); // We can access named value parameters directly by their name: $showUsersFromGroup = $request->getParam(groupName); // The selected option from second parameter is now stored under userTypeFilter $userTypeFilter = $request->getParam(userTypeFilter); switch ($userTypeFilter) { case all: // all users case deleted: // deleted users case locked // ... // ... } }
58.4.2 Flags
Flags are directly accessible by name. Value-capturing ags will contain string values, as provided by the user. Nonvalue ags will be equal to true. Given the following route:
1 2 3 4 5 6 7 8 9
find-user => array( options => array( route => find user [--fast] [--verbose] [--id=] [--firstName=] [--lastName=] [--email=] defaults => array( controller => Application\Controller\Users, action => find, ) ) )
public function findAction() { $request = $this->getRequest(); // We can retrieve values from value flags using their name
270
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
= = = =
// Standard flags that have been matched will be equal to TRUE $isFast = (bool) $request->getParam(fast, false); // default false $isVerbose = (bool) $request->getParam(verbose,false); if ($isFast) { // perform a fast query ... } else { // perform standard query ... } }
// Assuming our route now reads: // route => find user [--fast|-f] [--verbose|-v] ... , // public function findAction() { $request = $this->getRequest(); // Check both alternatives $isFast = $request->getParam(fast,false) || $request->getParam(f,false); $isVerbose = $request->getParam(verbose,false) || $request->getParam(v,false); // ... }
271
272
CHAPTER 59
Console adapters
Zend Framework 2 provides console abstraction layer, which works around various bugs and limitations in operating systems. It handles displaying of colored text, retrieving console window size, charset and provides basic line drawing capabilities. See Also: Console Adapters can be used for a low-level access to the console. If you plan on building functional console applications you do not normally need to use adapters. Make sure to read about console MVC integration rst, because it provides a convenient way for running modular console applications without directly writing to or reading from console window.
class ConsoleController extends AbstractActionController { public function testAction() { $console = $this->getServiceLocator()->get(console); if (!$console instanceof Console) { throw new RuntimeException(Cannot obtain console adapter. Are we running in a console?) } } }
If you are using Zend\Console without MVC, we can get adapter using the following code:
1 2 3 4
273
5 6 7 8
$console = Console::getInstance(); } catch (ConsoleException $e){ // Could not get console adapter - most likely we are not running inside a console window. }
Note: For practical and security reasons, Console::getInstance() will always throw an exception if you attempt to get console instance in a non-console environment (i.e. when running on a HTTP server). You can override this behavior by manually instantiating one of Zend\Console\Adapter\* classes.
Note: On consoles with virtual buffers (i.e. MS Windows Command Prompt) width and height represent visible (real) size, without scrolling the window. For example - if the window scrolling width is 120 chars, but its real, visible width is 80 chars, getWidth() will return 80.
274
59.2.5 Miscellaneous
$console->hideCursor() Hide blinking cursor from console. $console->showCursor() Show blinking cursor in console. $console->clear() Clear the screen. $console->clearLine() Clear the line that the cursor currently sits at.
275
276
CHAPTER 60
Console prompts
In addition to console abstraction layer Zend Framework 2 provides numerous convenience classes for interacting with the user in console environment. This chapter describes available Zend\Console\Prompt classes and their example usage. All prompts can be instantiated as objects and provide show() method.
1 2 3 4 5 6 7
use Zend\Console\Prompt; $confirm = new Prompt\Confirm(Are you sure you want to continue?); $result = $confirm->show(); if ($result) { // the user chose to continue }
There is also a shorter method of displaying prompts, using static prompt() method:
1 2 3 4 5 6
use Zend\Console\Prompt; $result = Prompt\Confirm::prompt(Are you sure you want to continue?); if ($result) { // the user chose to continue }
See Also: Make sure to read about console MVC integration rst, because it provides a convenient way for running modular console applications without directly writing to or reading from console window.
277
60.1 Conrm
This prompt is best used for a yes / no type of choices.
Confirm( string $text, string $yesChar = y, string $noChar = n )
$text (string) The text to show with the prompt $yesChar (string) The char that corresponds with YES choice. Defaults to y. $noChar (string) The char that corresponds with NO choice. Defaults to n. Example usage:
use Zend\Console\Prompt\Confirm; if ( Confirm::prompt(Is this the correct answer? [y/n], y, n) ) { $console->write("You chose YES"); } else { $console->write("You chose NO"); }
60.2 Line
This prompt asks for a line of text input.
Line( string $text = Please enter value, bool $allowEmpty = false, bool $maxLength = 2048 )
$text (string) The text to show with the prompt $allowEmpty (boolean) Can this prompt be skipped, by pressing [ENTER] ? (default fo false) $maxLength (integer) Maximum length of the input. Anything above this limit will be truncated. Example usage:
use Zend\Console\Prompt\Line; $name = Line::prompt( What is your name?, false, 100
278
60.3 Char
This prompt reads a single keystroke and optionally validates it against a list o allowed characters.
Char( string string bool bool bool ) $text = Please hit a key, $allowedChars = abc, $ignoreCase = true, $allowEmpty = false, $echo = true
$text (string) The text to show with the prompt $allowedChars (string) A list of allowed keys that can be pressed. $ignoreCase (boolean) Ignore the case of chars pressed (default to true) $allowEmpty (boolean) Can this prompt be skipped, by pressing [ENTER] ? (default fo false) $echo (boolean) Should the selection be displayed on the screen ? Example usage:
use Zend\Console\Prompt\Char; $answer = Char::prompt( What is the correct answer? [a,b,c,d,e], abcde, true, false, true ); if ($answer == b) { $console->write(Correct. This it the right answer); } else { $console->write(Wrong ! Try again.); }
60.3. Char
279
60.4 Select
This prompt displays a number of choices and asks the user to pick one.
Select( string array bool bool ) $text = Please select one option, $options = array(), $allowEmpty = false, $echo = false
$text (string) The text to show with the prompt $options (array) An associative array with keys strokes (chars) and their displayed values. $allowEmpty (boolean) Can this prompt be skipped, by pressing [ENTER] ? (default fo false) $echo (boolean) Should the selection be displayed on the screen ? Example usage:
$options = a => o => p => b => n => ); array( Apples, Oranges, Pears, Bananas, none of the above...
$answer = Select::prompt( Which fruit do you like the best?, $options, false, false ); $console->write("You told me that you like " . $options[$answer]);
280
See Also: To learn more about accessing console, writing to and reading from it, make sure to read the following chapter: Console adapters.
60.4. Select
281
282
CHAPTER 61
Introduction to Zend\Crypt
Zend\Crypt provides support of some cryptographic tools. The available features are: encrypt-then-authenticate using symmetric ciphers (the authentication step is provided using HMAC); encrypt/decrypt using symmetric and public key algorithm (e.g. RSA algorithm); generate digital sign using public key algorithm (e.g. RSA algorithm); key exchange using the Dife-Hellman method; Key derivation function (e.g. using PBKDF2 algorithm); Secure password hash (e.g. using Bcrypt algorithm); generate Hash values; generate HMAC values; The main scope of this component is to offer an easy and secure way to protect and authenticate sensitive data in PHP. Because the use of cryptography is not so easy we recommend to use the Zend\Crypt component only if you have a minimum background on this topic. For an introduction to cryptography we suggest the following references: Dan Boneh Cryptography course Stanford University, Coursera - free online course N.Ferguson, B.Schneier, and T.Kohno, Cryptography Engineering, John Wiley & Sons (2010) B.Schneier Applied Cryptography, John Wiley & Sons (1996) Note: PHP-CryptLib Most of the ideas behind the Zend\Crypt component have been inspired by the PHP-CryptLib project of Anthony Ferrara. PHP-CryptLib is an all-inclusive pure PHP cryptographic library for all cryptographic needs. It is meant to be easy to install and use, yet extensible and powerful enough for even the most experienced developer.
283
284
CHAPTER 62
Zend\Crypt\BlockCipher implements the encrypt-then-authenticate mode using HMAC to provide authentication. The symmetric cipher can be choose with a specic adapter that implements the Zend\Crypt\Symmetric\SymmetricInterface. We support the standard algorithms of the Mcrypt extension. The adapter that implements the Mcrypt is Zend\Crypt\Symmetric\Mcrypt. In the following code we reported an example on how to use the BlockCipher class to encrypt-then-authenticate a string using the AES block cipher (with a key of 256 bit) and the HMAC algorithm (using the SHA-256 hash function).
1 2 3 4 5 6
use Zend\Crypt\BlockCipher; $blockCipher = BlockCipher::factory(mcrypt, array(algo => aes)); $blockCipher->setKey(encryption key); $result = $blockCipher->encrypt(this is a secret message); echo "Encrypted text: $result \n";
The BlockCipher is initialized using a factory method with the name of the cipher adapter to use (mcrypt) and the parameters to pass to the adapter (the AES algorithm). In order to encrypt a string we need to specify an encryption key and we used the setKey() method for that scope. The encryption is provided by the encrypt() method. The output of the encryption is a string, encoded in Base64 (default), that contains the HMAC value, the IV vector, and the encrypted text. The encryption mode used is the CBC (with a random IV by default) and SHA256 as default hash algorithm of the HMAC. The Mcrypt adapter encrypts using the PKCS#7 padding mechanism by default. You can specify a different padding method using a special adapter for that (Zend\Crypt\Symmetric\Padding). The encryption and authentication keys used by the BlockCipher are generated with the PBKDF2 algorithm, used as key derivation function from the users key specied using the setKey() method. Note: Key size BlockCipher try to use always the longest size of the key for the specied cipher. For instance, for the AES algorithm it uses 256 bits and for the Blowsh algorithm it uses 448 bits. You can change all the default settings passing the values to the factory parameters. For instance, if you want to use the Blowsh algorithm, with the CFB mode and the SHA512 hash function for HMAC you have to initialize the class as follow:
1 2
use Zend\Crypt\BlockCipher;
285
3 4 5 6 7
$blockCipher = BlockCipher::factory(mcrypt, array( algo => blowfish, mode => cfb, hash => sha512 ));
Note: Recommendation If you are not familiar with symmetric encryption techniques we strongly suggest to use the default values of the BlockCipher class. The default values are: AES algorithm, CBC mode, HMAC with SHA256, PKCS#7 padding. To decrypt a string we can use the decrypt() method. In order to successfully decrypt a string we have to congure the BlockCipher with the same parameters of the encryption. We can also initialize the BlockCipher manually without use the factory method. We can inject the symmetric cipher adapter directly to the constructor of the BlockCipher class. For instance, we can rewrite the previous example as follow:
1 2 3 4 5 6 7
use Zend\Crypt\BlockCipher; use Zend\Crypt\Symmetric\Mcrypt; $blockCipher = new BlockCipher(new Mcrypt(array(algo => aes))); $blockCipher->setKey(encryption key); $result = $blockCipher->encrypt(this is a secret message); echo "Encrypted text: $result \n";
286
CHAPTER 63
In cryptography, a key derivation function (or KDF) derives one or more secret keys from a secret value such as a master key or other known information such as a password or passphrase using a pseudo-random function. For instance, a KDF function can be used to generate encryption or authentication keys from a user password. The Zend\Crypt\Key\Derivation implements a key derivation function using specic adapters. User passwords are not really suitable to be used as keys in cryptographic algorithms, since users normally choose keys they can write on keyboard. These passwords use only 6 to 7 bits per character (or less). It is highly recommended to use always a KDF function to transform a users password in a cryptographic key. The output of the following key derivation functions is a binary string. If you need to store the value in a database or a different persistent storage, we suggest to convert it in Base64 format, using base64_encode() function, or in hex format, using the bin2hex() function.
use Zend\Crypt\Key\Derivation\Pbkdf2; use Zend\Math\Rand; $pass = password; $salt = Rand::getBytes(strlen($pass), true); $key = Pbkdf2::calc(sha256, $pass, $salt, 10000, strlen($pass)*2); printf ("Original password: %s\n", $pass); printf ("Derived key (hex): %s\n", bin2hex($key));
The Pbkdf2 adapter takes the password ($pass) and generate a binary key with a size double of the password. The syntax is calc($hash, $pass, $salt, $iterations, $length) where $hash is the name of the hash function to use, $pass is the password, $salt is a pseudo random value, $iterations is the number of iterations of the algorithm and $length is the size of the key to be generated. We used the Rand::getBytes function of
287
the Zend\Math\Rand class to generate a random bytes using a strong generators (the true value means the usage of strong generators). The number of iterations is a very important parameter for the security of the algorithm. Big values means more security. There is not a xed value for that because the number of iterations depends on the CPU power. You should always choose a number of iteration that prevent brute force attacks. For instance, a value of 1000000 iterations, that is equal to 1 sec of elaboration for the PBKDF2 algorithm, is enough secure using an Intel Core i5-2500 CPU at 3.3 Ghz.
use Zend\Crypt\Key\Derivation\SaltedS2k; use Zend\Math\Rand; $pass = password; $salt = Rand::getBytes(strlen($pass), true); $key = SaltedS2k::calc(sha256, $pass, $salt, strlen($pass)*2); printf ("Original password: %s\n", $pass); printf ("Derived key (hex): %s\n", bin2hex($key));
288
1 2 3 4 5 6 7 8 9
use Zend\Crypt\Key\Derivation\Scrypt; use Zend\Math\Rand; $pass = password; $salt = Rand::getBytes(strlen($pass), true); $key = Scrypt::calc($pass, $salt, 2048, 2, 1, 64); printf ("Original password: %s\n", $pass); printf ("Derived key (hex): %s\n", bin2hex($key));
Note: Performance of the scrypt implementation The aim of the scrypt algorithm is to generate secure derived key preventing brute force attacks. Just like the other derivation functions, the more time (and memory) we spent executing the algorithm, the more secure the derived key will be. Unfortunately a pure PHP implementation of the scrypt algorithm is very slow compared with the C implementation (this is always true, if you compare execution time of C with PHP). If you want use a faster scrypt algorithm we suggest to use the C implementation of scrypt, supported by this Scrypt extension for PHP (please note that this PHP extension is not ofcially supported by php.net). The Scrypt adapter of Zend Framework is able to recognize if this extension is loaded and use it instead of the pure PHP implementation.
289
290
CHAPTER 64
Password
In the Zend\Crypt\Password namespace you can nd all the password formats supported by Zend Framework. We currently support the following passwords: bcrypt; Apache (htpasswd). If you need to choose a password format to store the users password we suggest to use the bcrypt algorithm that is considered secure against brute forcing attacks (see the details below).
64.1 Bcrypt
The bcrypt algorithm is an hashing algorithm that is widely used and suggested by the security community to store users passwords in a secure way. Classic hashing mechanisms like MD5 or SHA, with or without a salt value, are not considered secure anymore (read this post to know why). The security of bcrypt is related to the speed of the algorithm. Bcrypt is very slow, it can request even a second to generate an hash value. That means a brute force attack is impossible to execute, due to the amount of time that its need. Bcrypt uses a cost parameter that specify the number of cycles to use in the algorithm. Increasing this number the algorithm will spend more time to generate the hash output. The cost parameter is represented by an integer value between 4 to 31. The default cost value of the Zend\Crypt\Password\Bcrypt component is 14, that means almost a second using a CPU Intel i5 at 3.3Ghz (the cost parameter is a relative value according to the speed of the CPU used). If you want to change the cost parameter of the bcrypt algorithm you can use the setCost() method. Please note that if you change the cost parameter, the resulting hash will be different. This will not affect the verication process of the algorithm, therefore not breaking the password hashes you already have stored. Bcrypt reads the cost parameter from the hash value, during the password authentication. All of the parts needed to verify the hash are all together, separated with $s, rst the algorithm, then the cost, the salt, and then nally the hash. The example below shows how to use the bcrypt algorithm to store a users password:
1 2
use Zend\Crypt\Password\Bcrypt;
291
3 4
The output of the create() method is the hash of the password. This value can then be stored in a repository like a database (the output is a string of 60 bytes). To verify if a given password is valid against a bcrypt value you can use the verify() method. An example is reported below:
1 2 3 4 5 6 7 8 9 10 11
use Zend\Crypt\Password\Bcrypt; $bcrypt = new Bcrypt(); $securePass = the stored bcrypt value; $password = the password to check; if ($bcrypt->verify($password, $securePass)) { echo "The password is correct! \n"; } else { echo "The password is NOT correct.\n"; }
In the bcrypt uses also a salt value to improve the randomness of the algorithm. By default, the Zend\Crypt\Password\Bcrypt component generates a random salt for each hash. If you want to specify a preselected salt you can use the setSalt() method. We provide also a getSalt() method to retrieve the salt specied by the user. The salt and the cost parameter can be also specied during the constructor of the class, below is reported an example:
1 2 3 4 5 6
use Zend\Crypt\Password\Bcrypt; $bcrypt = new Bcrypt(array( salt => random value, cost => 13 ));
Note: Bcrypt with non-ASCII passwords (8-bit characters) The bcrypt implementation used by PHP < 5.3.7 can contains a security aw if the password uses 8-bit characters (heres the security report). The impact of this bug was that most (but not all) passwords containing non-ASCII characters with the 8th bit set were hashed incorrectly, resulting in password hashes incompatible with those of OpenBSDs original implementation of bcrypt. This security aw has been xed starting from PHP 5.3.7 and the prex used in the output was changed to $2y$ in order to put evidence on the correctness of the hash value. If you are using PHP < 5.3.7 with 8-bit passwords, the Zend\Crypt\Password\Bcrypt throws an exception suggesting to upgrade to PHP 5.3.7+ or use only 7-bit passwords.
64.2 Apache
The Zend\Crypt\Password\Apache supports all the password formats used by Apache (htpasswd). These formats are: CRYPT, uses the traditional Unix crypt(3) function with a randomly-generated 32-bit salt (only 12 bits used) and the rst 8 characters of the password; SHA1, {SHA} + Base64-encoded SHA-1 digest of the password;
292
MD5, $apr1$ + the result of an Apache-specic algorithm using an iterated (1,000 times) MD5 digest of various combinations of a random 32-bit salt and the password. Digest, the MD5 hash of the string user:realm:password as a 32-character string of hexadecimal digits. realm is the Authorization Realm argument to the AuthName directive in httpd.conf. In order to specify the format of the Apaches password you can use the setFormat() method. An example with all the formats usage is reported below:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
use Zend\Crypt\Password\Apache; $apache = new Apache(); $apache->setFormat(crypt); printf ("CRYPT output: %s\n", $apache->create(password)); $apache->setFormat(sha1); printf ("SHA1 output: %s\n", $apache->create(password)); $apache->setFormat(md5); printf ("MD5 output: %s\n", $apache->create(password)); $apache->setFormat(digest); $apache->setUserName(enrico); $apache->setAuthName(test); printf ("Digest output: %s\n", $apache->create(password));
You can also specify the format of the password during the constructor of the class:
1 2 3 4 5
Other possible parameters to pass in the constructor are username and authname, for the digest format.
64.2. Apache
293
294
CHAPTER 65
Public-key cryptography refers to a cryptographic system requiring two separate keys, one of which is secret and one of which is public. Although different, the two parts of the key pair are mathematically linked. One key locks or encrypts the plaintext, and the other unlocks or decrypts the cyphertext. Neither key can perform both functions. One of these keys is published or public, while the other is kept private. In Zend Framework we implemented two public key algorithms: Dife-Hellman key exchange and RSA.
65.1 Dife-Hellman
The Dife-Hellman algorithm is a specic method of exchanging cryptographic keys. It is one of the earliest practical examples of key exchange implemented within the eld of cryptography. The DifeHellman key exchange method allows two parties that have no prior knowledge of each other to jointly establish a shared secret key over an insecure communications channel. This key can then be used to encrypt subsequent communications using a symmetric key cipher. The diagram of operation of the Dife-Hellman algorithm can be dened by the following picture (taken by the DifeHellman Wikipedia page): The schemas colors represent the parameters of the algorithm. Here is reported an example of usage using the Zend\Crypt\PublicKey\DiffieHellman class:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
use Zend\Crypt\PublicKey\DiffieHellman;
$aliceOptions = array( prime => 1551728981814736974712322577637155399157248019669154044797077953140576293785419175 4236981889937278161526466314385615958256881888899512721588426754199503412587065565 1048705376814767265132557470407658574792912915723345106432450947150072296210941943 984760375594985848253359305585439638443, generator=> 2, private => 9920931406657259523640856959196798855714124956149426748625180803553539633227862014 81312712891672623072630995180324388841681491857745515696789091127409515009250358965 46342049838178521379132153348139908016819196219448310107072632515749339055798122538 04828702523796951800575031871051678091 ); $bobOptions = array( prime => $aliceOptions[prime], generator=> 2,
295
296
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
private
);
$alice = new DiffieHellman($aliceOptions[prime], $aliceOptions[generator], $aliceOptions[private $bob = new DiffieHellman($bobOptions[prime], $bobOptions[generator], $bobOptions[private]); $alice->generateKeys(); $bob->generateKeys(); $aliceSecretKey = $alice->computeSecretKey($bob->getPublicKey(DiffieHellman::FORMAT_BINARY), DiffieHellman::FORMAT_BINARY, DiffieHellman::FORMAT_BINARY); $bobSecretKey = $bob->computeSecretKey($alice->getPublicKey(DiffieHellman::FORMAT_BINARY), DiffieHellman::FORMAT_BINARY, DiffieHellman::FORMAT_BINARY);
if ($aliceSecretKey !== $bobSecretKey) { echo "ERROR!\n"; } else { printf("The secret key is: %s\n", base64_encode($aliceSecretKey)); }
The parameters of the Dife-Hellman class are: a prime number (p), a generator (g) that is a primitive root mod p and a private integer number. The security of the Dife-Hellman exchange algorithm is related to the choice of these parameters. To know how to choose secure numbers you can read the RFC 3526 document. Note: The Zend\Crypt\PublicKey\DiffieHellman class use by default the OpenSSL extension of PHP to generate the parameters. If you dont want to use the OpenSSL library you have to set the useOpensslExtension static method to false.
65.2 RSA
RSA is an algorithm for public-key cryptography that is based on the presumed difculty of factoring large integers, the factoring problem. A user of RSA creates and then publishes the product of two large prime numbers, along with an auxiliary value, as their public key. The prime factors must be kept secret. Anyone can use the public key to encrypt a message, but with currently published methods, if the public key is large enough, only someone with knowledge of the prime factors can feasibly decode the message. Whether breaking RSA encryption is as hard as factoring is an open question known as the RSA problem. The RSA algorithm can be used to encrypt/decrypt message and also to provide authenticity and integrity generating a digital signature of a message. Suppose that Alice wants to send an encrypted message to Bob. Alice must use the public key of Bob to encrypt the message. Bob can decrypt the message using his private key. Because Bob he is the only one that can access to his private key, he is the only one that can decrypt the message. If Alice wants to provide authenticity and integrity of a message to Bob she can use her private key to sign the message. Bob can check the correctness of the digital signature using the public key of Alice. Alice can provide encryption, authenticity and integrity of a message to Bob using the previous schemas in sequence, applying the encryption rst and the digital signature after. Below we reported some examples of usage of the Zend\Crypt\PublicKey\Rsa class in order to: generate a public key and a private key; 65.2. RSA 297
use Zend\Crypt\PublicKey\RsaOptions; $rsaOptions = new RsaOptions(array( pass_phrase => test )); $rsaOptions->generateKeys(array( private_key_bits => 2048, )); file_put_contents(private_key.pem, $rsaOptions->getPrivateKey()); file_put_contents(public_key.pub, $rsaOptions->getPublicKey());
This example generates a public and private key of 2048 bit storing the keys in two separate les, the private_key.pem for the private key and the public_key.pub for the public key. You can also generate the public and private key using OpenSSL from the command line (Unix style syntax):
ssh-keygen -t rsa
use Zend\Crypt\PublicKey\Rsa; $rsa = Rsa::factory(array( public_key => public_key.pub, private_key => private_key.pem, pass_phrase => test, binary_output => false )); $text = This is the message to encrypt; $encrypt = $rsa->encrypt($text); printf("Encrypted message:\n%s\n", $encrypt); $decrypt = $rsa->decrypt($encrypt); if ($text !== $decrypt) { echo "ERROR\n"; } else {
298
20 21
use Zend\Crypt\PublicKey\Rsa; $rsa = Rsa::factory(array( private_key => path/to/private_key, pass_phrase => passphrase of the private key, binary_output => false )); $file = file_get_contents(path/file/to/sign); $signature = $rsa->sign($file, $rsa->getOptions()->getPrivateKey()); $verify = $rsa->verify($file, $signature, $rsa->getOptions()->getPublicKey()); if ($verify) { echo "The signature is OK\n"; file_put_contents($filename . .sig, $signature); echo "Signature save in $filename.sig\n"; } else { echo "The signature is not valid!\n"; }
In this example we used the Base64 format to encode the digital signature of the le (binary_output is false). Note: The implementation of Zend\Crypt\PublicKey\Rsa algorithm uses the OpenSSL extension of PHP.
65.2. RSA
299
300
CHAPTER 66
Zend\Db\Adapter
The Adapter object is the most important sub-component of Zend\Db. It is responsible for adapting any code written in or for Zend\Db to the targeted php extensions and vendor databases. In doing this, it creates an abstraction layer for the PHP extensions, which is called the Driver portion of the Zend\Db adapter. It also creates a lightweight abstraction layer, called the Platform portion of the adapter, for the various idiosyncrasies that each vendor-specic platform might have in its SQL/RDBMS implementation.
This driver array is an abstraction for the extension level required parameters. Here is a table for the key-value pairs that should be in conguration array. Key driver database username password hostname port charset Is Required? required generally required generally required generally required not generally required not generally required not generally required Value Mysqli, Sqlsrv, Pdo_Sqlite, Pdo_Mysql, Pdo=OtherPdoDriver the name of the database (schema) the connection username the connection password the IP address or hostname to connect to the port to connect to (if applicable) the character set to use
Note: Other names will work as well. Effectively, if the PHP manual uses a particular naming, this naming will be supported by our Driver. For example, dbname in most cases will also work for database. Another example is that in the case of Sqlsrv, UID will work in place of username. Which format you chose is up to you, but the above table represents the ofcial abstraction names. So, for example, a MySQL connection using ext/mysqli:
1 2 3 4
$adapter = new Zend\Db\Adapter\Adapter(array( driver => Mysqli, database => zend_db_example, username => developer,
301
5 6
$adapter = new Zend\Db\Adapter\Adapter(array( driver => Pdo_Sqlite, database => path/to/sqlite.db ));
It is important to know that by using this style of adapter creation, the Adapter will attempt to create any dependencies that were not explicitly provided. A Driver object will be created from the conguration array provided in the constructor. A Platform object will be created based off the type of Driver class that was instantiated. And lastly, a default ResultSet object is created and utilized. Any of these objects can be injected, to do this, see the next section. The list of ofcially supported drivers: Mysqli: The ext/mysqli driver Pgsql: The ext/pgsql driver Sqlsrv: The ext/sqlsrv driver (from Microsoft) Pdo_Mysql: MySQL through the PDO extension Pdo_Sqlite: SQLite though the PDO extension Pdo_Pgsql: PostgreSQL through the PDO extension
class Zend\Db\Adapter\Adapter { public function __construct($driver, PlatformInterface $platform = null, ResultSet $queryResultSe }
What can be injected: $driver an array of connection parameters Zend\Db\Adapter\Driver\DriverInterface (see above) or an instance of
$platform - (optional) an instance of Zend\Db\Platform\PlatformInterface, the default will be created based off the driver implementation $queryResultSetPrototype - (optional) an instance of Zend\Db\ResultSet\ResultSet, to understand this objects role, see the section below on querying through the adapter
The above example will go through the following steps: create a new Statement object prepare an array into a ParameterContainer if necessary inject the ParameterContainer into the Statement object execute the Statement object, producing a Result object check the Result object to check if the supplied sql was a query, or a result set producing statement if it is a result set producing query, clone the ResultSet prototype, inject Result as datasource, return it else, return the Result
The primary difference to notice is that you must provide the Adapter::QUERY_MODE_EXECUTE (execute) as the second parameter.
// with optional parameters to bind up-front $statement = $adapter->createStatement($sql, $optionalParameters); $result = $statement->execute();
The adapter chooses the proper driver to instantiate, for example Zend\Db\Adapter\Driver\Mysqli That driver class is instantiated If no connection, statement or result objects are injected, defaults are instantiated This driver is now ready to be called on when particular workows are requested. Here is what the Driver API looks like:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
namespace Zend\Db\Adapter\Driver; interface DriverInterface { const PARAMETERIZATION_POSITIONAL = positional; const PARAMETERIZATION_NAMED = named; const NAME_FORMAT_CAMELCASE = camelCase; const NAME_FORMAT_NATURAL = natural; public function getDatabasePlatformName($nameFormat = self::NAME_FORMAT_CAMELCASE); public function checkEnvironment(); public function getConnection(); public function createStatement($sqlOrResource = null); public function createResult($resource); public function getPrepareType(); public function formatParameterName($name, $type = null); public function getLastGeneratedValue(); }
From this DriverInterface, you can Determine the name of the platform this driver supports (useful for choosing the proper platform object) Check that the environment can support this driver Return the Connection object Create a Statement object which is optionally seeded by an SQL statement (this will generally be a clone of a prototypical statement object) Create a Result object which is optionally seeded by a statement resource (this will generally be a clone of a prototypical result object) Format parameter names, important to distinguish the difference between the various ways parameters are named between extensions Retrieve the overall last generated value (such as an auto-increment value) Statement objects generally look like this:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
namespace Zend\Db\Adapter\Driver; interface StatementInterface extends StatementContainerInterface { public function getResource(); public function prepare($sql = null); public function isPrepared(); public function execute($parameters = null); /** Inherited from StatementContainerInterface */ public function setSql($sql); public function getSql(); public function setParameterContainer(ParameterContainer $parameterContainer); public function getParameterContainer(); }
304
namespace Zend\Db\Adapter\Driver; interface ResultInterface extends \Countable, \Iterator { public function buffer(); public function isQueryResult(); public function getAffectedRows(); public function getGeneratedValue(); public function getResource(); public function getFieldCount(); }
namespace Zend\Db\Adapter\Platform; interface PlatformInterface { public function getName(); public function getQuoteIdentifierSymbol(); public function quoteIdentifier($identifier); public function quoteIdentifierChain($identiferChain) public function getQuoteValueSymbol(); public function quoteValue($value); public function quoteValueList($valueList); public function getIdentifierSeparator(); public function quoteIdentifierInFragment($identifier, array $additionalSafeWords = array()); }
While one can instantiate your own Platform object, generally speaking, it is easier to get the proper Platform instance from the congured adapter (by default the Platform type will match the underlying driver implementation):
1 2 3
/** @var $adapter Zend\Db\Adapter\Adapter */ /** @var $platform Zend\Db\Adapter\Platform\Sql92 */ $platform = $adapter->getPlatform(); // "first_name" echo $platform->quoteIdentifier(first_name); // " echo $platform->getQuoteIdentifierSymbol(); // "schema"."mytable" echo $platform->quoteIdentifierChain(array(schema,mytable)));
305
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
// echo $platform->getQuoteValueSymbol(); // myvalue echo $platform->quoteValue(myvalue); // value, Foo O\\Bar echo $platform->quoteValueList(array(value,"Foo OBar"))); // . echo $platform->getIdentifierSeparator(); // "foo" as "bar" echo $platform->quoteIdentifierInFragment(foo as bar); // additionally, with some safe words: // ("foo"."bar" = "boo"."baz") echo $platform->quoteIdentifierInFragment((foo.bar = boo.baz), array((, ), =));
306
/** merge existing array of parameters with existing parameters */ public function merge($parameters) }
In addition to handling parameter names and values, the container will assist in tracking parameter types for PHP type to SQL type handling. For example, it might be important that:
$container->offsetSet(limit, 5);
be bound as an integer. To achieve this, pass in the ParameterContainer::TYPE_INTEGER constant as the 3rd parameter:
$container->offsetSet(limit, 5, $container::TYPE_INTEGER);
This will ensure that if the underlying driver supports typing of bound parameters, that this translated information will also be passed along to the actual php database driver.
66.9 Examples
Creating a Driver and Vendor portable Query, Preparing and Iterating Result
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
$adapter = new Zend\Db\Adapter\Adapter($driverConfig); $qi = function($name) use ($adapter) { return $adapter->platform->quoteIdentifier($name); }; $fp = function($name) use ($adapter) { return $adapter->driver->formatParameterName($name); }; $sql = UPDATE . $qi(artist) . SET . $qi(name) . = . $fp(name) . WHERE . $qi(id) . = . $fp(id); /** @var $statement Zend\Db\Adapter\Driver\StatementInterface */ $statement = $adapter->query($sql); $parameters = array( name => Updated Artist, id => 1 ); $statement->execute($parameters); // DATA INSERTED, NOW CHECK /* @var $statement Zend\Db\Adapter\DriverStatementInterface */ $statement = $adapter->query(SELECT * FROM . $qi(artist) . WHERE id = . $fp(id)); /* @var $results Zend\Db\ResultSet\ResultSet */ $results = $statement->execute(array(id => 1));
66.9. Examples
307
30 31
308
CHAPTER 67
Zend\Db\ResultSet
Zend\Db\ResultSet is a sub-component of Zend\Db for abstracting the iteration of rowset producing queries. While data sources for this can be anything that is iterable, generally a Zend\Db\Adapter\Driver\ResultInterface based object is the primary source for retrieving data. Zend\Db\ResultSets must implement the Zend\Db\ResultSet\ResultSetInterface and all subcomponents of Zend\Db that return a ResultSet as part of their API will assume an instance of a ResultSetInterface should be returned. In most casts, the Prototype pattern will be used by consuming object to clone a prototype of a ResultSet and return a specialized ResultSet with a specic data source injected. The interface of ResultSetInterface looks like this:
1 2 3 4 5
interface ResultSetInterface extends \Traversable, \Countable { public function initialize($dataSource); public function getFieldCount(); }
67.1 Quickstart
Zend\Db\ResultSet\ResultSet is the most basic form of a ResultSet object that will expose each row as either an ArrayObject-like object or an array of row data. By default, Zend\Db\Adapter\Adapter will use a prototypical Zend\Db\ResultSet\ResultSet object for iterating when using the Zend\Db\Adapter\Adapter::query() method. The following is an example workow Zend\Db\Adapter\Adapter::query():
1 2 3 4 5 6 7 8 9 10 11
similar
to
what
one
might
nd
inside
use Zend\Db\Adapter\Driver\ResultInterface; use Zend\Db\ResultSet\ResultSet; $stmt = $driver->createStatement(SELECT * FROM users); $stmt->prepare(); $result = $stmt->execute($parameters); if ($result instanceof ResultInterface && $result->isQueryResult()) { $resultSet = new ResultSet; $resultSet->initialize($result);
309
12 13 14 15
abstract class AbstractResultSet implements Iterator, ResultSetInterface { public function initialize($dataSource) public function getDataSource() public function getFieldCount() /** Iterator */ public function public function public function public function public function
/** countable */ public function count() /** get rows as array */ public function toArray() }
67.3 Zend\Db\ResultSet\HydratingResultSet
Zend\Db\ResultSet\HydratingResultSet is a more exible ResultSet object that allows the developer to choose an appropriate hydration strategy for getting row data into a target object. While iterating over results, HydratingResultSet will take a prototype of a target object and clone it once for each row. The HydratingResultSet will then hydrate that clone with the row data. In the example below, rows from the database will be iterated, and during iteration, HydratingRowSet will use the Reection based hydrator to inject the row data directly into the protected members of the cloned UserEntity object:
1 2 3 4 5 6 7 8 9 10 11 12 13
use Zend\Db\Adapter\Driver\ResultInterface; use Zend\Db\ResultSet\HydratingResultSet; use Zend\Stdlib\Hydrator\Reflection as ReflectionHydrator; class UserEntity { protected $first_name; protected $last_name; public function getFirstName() { return $this->first_name; } public function getLastName() { return $this->last_name; } public function setFirstName($first_name) { $this->first_name = $first_name; } public function setLastName($last_name) { $this->last_name = $last_name; } }
310
14 15 16 17 18 19 20 21 22 23 24 25
$stmt = $driver->createStatement($sql); $stmt->prepare($parameters); $result = $stmt->execute(); if ($result instanceof ResultInterface && $result->isQueryResult()) { $resultSet = new HydratingResultSet(new ReflectionHydrator, new UserEntity); $resultSet->initialize($result); foreach ($resultSet as $user) { echo $user->getFirstName() . . $user->getLastName() . PHP_EOL; } }
For more information, see the Zend\Stdlib\Hydrator documentation to get a better sense of the different strategies that can be employed in order to populate a target object.
67.3. Zend\Db\ResultSet\HydratingResultSet
311
312
CHAPTER 68
Zend\Db\Sql
Zend\Db\Sql is a SQL abstraction layer for building platform specic SQL queries via a object-oriented API. The end result of an Zend\Db\Sql object will be to either produce a Statement and Parameter container that represents the target query, or a full string that can be directly executed against the database platform. To achieve this, Zend\Db\Sql objects require a Zend\Db\Adapter\Adapter object in order to produce the desired results.
use Zend\Db\Sql\Sql; $sql = new Sql($adapter); $select = $sql->select(); $insert = $sql->insert(); $update = $sql->update(); $delete = $sql->delete();
// // // //
As a developer, you can now interact with these objects, as described in the sections below, to specialize each query. Once they have been populated with values, they are ready to either be prepared or executed. To prepare (using a Select object):
1 2 3 4 5 6 7 8
use Zend\Db\Sql\Sql; $sql = new Sql($adapter); $select = $sql->select(); $select->from(foo); $select->where(array(id => 2)); $statement = $sql->prepareStatementForSqlObject($select); $results = $statement->execute();
313
1 2 3 4 5 6 7 8
use Zend\Db\Sql\Sql; $sql = new Sql($adapter); $select = $sql->select(); $select->from(foo); $select->where(array(id => 2)); $selectString = $sql->getSqlStringForSqlObject($select); $results = $adapter->query($selectString, $adapter::QUERY_MODE_EXECUTE);
Zend\Db\Sql\Sql objects can also be bound to a particular table so that in getting a select, insert, update, or delete object, they are all primarily seeded with the same table when produced.
1 2 3 4
use Zend\Db\Sql\Sql; $sql = new Sql($adapter, foo); $select = $sql->select(); $select->where(array(id => 2)); // $select already has the from(foo) applied
interface PreparableSqlInterface { public function prepareStatement(Adapter $adapter, StatementInterface $statement); } interface SqlInterface { public function getSqlString(PlatformInterface $adapterPlatform = null); }
These are the functions you can call to either produce (a) a prepared statement, or (b) a string to be executed.
68.3 Zend\Db\Sql\Select
Zend\Db\Sql\Select is an object whos primary function is to present a unied API for building platform specic SQL SELECT queries. The class can be instantiated and consumed without Zend\Db\Sql\Sql:
1 2 3 4
use Zend\Db\Sql\Select; $select = new Select(); // or, to produce a $select bound to a specific table $select = new Select(foo);
If a table is provided to the Select object, then from() cannot be called later to change the name of the table. Once you have a valid Select object, the following API can be used to further specify various select statement parts:
1 2 3 4 5 6 7 8 9 10 11
class Select extends AbstractSql implements SqlInterface, PreparableSqlInterface { const JOIN_INNER = inner; const JOIN_OUTER = outer; const JOIN_LEFT = left; const JOIN_RIGHT = right; const SQL_STAR = *; const ORDER_ASCENDING = ASC; const ORDER_DESCENDING = DESC; public $where; // @param Where $where
314
12 13 14 15 16 17 18 19 20 21 22 23
public public public public public public public public public public }
function function function function function function function function function function
__construct($table = null); from($table); columns(array $columns, $prefixColumnsWithTable = true); join($name, $on, $columns = self::SQL_STAR, $type = self::JOIN_INNER); where($predicate, $combination = Predicate\PredicateSet::OP_AND); group($group); having($predicate, $combination = Predicate\PredicateSet::OP_AND); order($order); limit($limit); offset($offset);
68.3.1 from():
1 2 3 4 5 6 7 8 9 10 11 12
// as a string: $select->from(foo); // as an array to specify an alias: // produces SELECT "t".* FROM "table" AS "t" $select->from(array(t => table)); // using a Sql\TableIdentifier: // same output as above $select->from(new TableIdentifier(array(t => table)));
68.3.2 columns():
1 2 3 4 5 6 7
// as array of names $select->columns(array(foo, bar)); // as an associative array with aliases as the keys: // produces bar AS foo, bax AS baz $select->columns(array(foo => bar, baz => bax));
68.3.3 join():
1 2 3 4 5 6 7 8 9 10
$select->join( foo // table name, id = bar.id, // expression to join on (will be quoted by platform object before insertion), array(bar, baz), // (optional) list of columns, same requirements as columns() above $select::JOIN_OUTER // (optional), one of inner, outer, left, right also represented by constant ); $select->from(array(f => foo)) ->join(array(b => bar), f.foo_id = b.foo_id); // base table // join table with alias // join expression
68.3. Zend\Db\Sql\Select
315
/** * Create where clause * * @param Where|\Closure|string|array $predicate * @param string $combination One of the OP_* constants from Predicate\PredicateSet * @return Select */ public function where($predicate, $combination = Predicate\PredicateSet::OP_AND);
As you can see, there are a number of different ways to pass criteria to both having() and where(). If you provide a Zend\Db\Sql\Where object to where() or a Zend\Db\Sql\Having object to having(), the internal objects for Select will be replaced completely. When the where/having() is processed, this object will be iterated to produce the WHERE or HAVING section of the SELECT statement. If you provide a Closure to where() or having(), this function will be called with the Selects Where object as the only parameter. So the following is possible:
1 2 3 4 5
If you provide a string, this string will be used to instantiate a Zend\Db\Sql\Predicate\Expression object so that its contents will be applied as is. This means that there will be no quoting in the fragment provided. Consider the following code:
1 2
If you provide an array whos values are keyed by an integer, the value can either be a string that will be then used to build a Predicate\Expression or any object that implements Predicate\PredicateInterface. These objects are pushed onto the Where stack with the $combination provided. Consider the following code:
1 2
If you provide an array whos values are keyed with a string, these values will be handled in the following: PHP value nulls will be made into a Predicate\IsNull object PHP value array()s will be made into a Predicate\In object PHP value strings will be made into a Predicate\Operator object such that the string key will be identier, and the value will target value. Consider the following code:
1 2 3 4
// SELECT "foo".* FROM "foo" WHERE "c1" IS NULL AND "c2" IN (?, ?, ?) AND "c3" IS NOT NULL $select->from(foo)->where(array( c1 => null, c2 => array(1, 2, 3),
316
5 6
68.3.5 order():
1 2 3 4 5 6 7 8 9
$select = new Select; $select->order(id DESC); // produces id DESC $select = new Select; $select->order(id DESC) ->order(name ASC, age DESC); // produces id DESC, name ASC, age DESC $select = new Select; $select->order(array(name ASC, age DESC)); // produces name ASC, age DESC
$select = new Select; $select->limit(5); // always takes an integer/numeric $select->offset(10); // similarly takes an integer/numeric
68.4 Zend\Db\Sql\Insert
The Insert API:
1 2 3 4 5 6 7 8 9 10
class Insert implements SqlInterface, PreparableSqlInterface { const VALUES_MERGE = merge; const VALUES_SET = set; public public public public } function function function function __construct($table = null); into($table); columns(array $columns); values(array $values, $flag = self::VALUES_SET);
Similarly to Select objects, the table can be set at construction time or via into().
68.4.1 columns():
1
68.4.2 values():
1 2 3 4 5 6
// default behavior of values is to set the values // successive calls will not preserve values from previous calls $insert->values(array( col_1 => value1, col_2 => value2 ));
68.4. Zend\Db\Sql\Insert
317
1 2
68.5 Zend\Db\Sql\Update
1 2 3 4 5 6 7 8 9 10 11
class Update { const VALUES_MERGE = merge; const VALUES_SET = set; public public public public public } $where; // @param Where $where function __construct($table = null); function table($table); function set(array $values, $flag = self::VALUES_SET); function where($predicate, $combination = Predicate\PredicateSet::OP_AND);
68.5.1 set():
1
68.5.2 where():
See where section below.
68.6 Zend\Db\Sql\Delete
1 2 3 4 5 6 7
class Delete { public $where; // @param Where $where public function __construct($table = null); public function from($table); public function where($predicate, $combination = Predicate\PredicateSet::OP_AND); }
68.6.1 where():
See where section below.
parameterization, the parameters will be replaced with their proper placeholder (a named or positional parameter), and the values stored inside a Adapter\ParameterContainer. When executed, the values will be interpolated into the fragments they belong to and properly quoted. It is important to know that in this API, a distinction is made between what elements are considered identiers (TYPE_IDENTIFIER) and which of those is a value (TYPE_VALUE). There is also a special use case type for literal values (TYPE_LITERAL). These are all exposed via the Zend\Db\Sql\ExpressionInterface interface. Note: In ZF 2.1, an actual Literal type was added. Zend\Db\Sql now makes the distinction that Literals will not have any parameters that need interpolating whereas it is expected that Expression objects might have parameters that need interpolating. In cases where there are parameters in an Expression, Zend\Db\Sql\AbstractSql will do its best to identify placeholders when the Expression is processed during statement creation. In short, if you dont have parameters, use Literal objects. The Zend\Db\Sql\Where (Predicate/PredicateSet) API:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
// Where & Having: class Predicate extends PredicateSet { public $and; public $or; public $AND; public $OR; public $NEST; public $UNNEST; public public public public public public public public public public public public public public public function function function function function function function function function function function function function function function
nest(); setUnnest(Predicate $predicate); unnest(); equalTo($left, $right, $leftType = self::TYPE_IDENTIFIER, $rightType = self::TYP lessThan($left, $right, $leftType = self::TYPE_IDENTIFIER, $rightType = self::TY greaterThan($left, $right, $leftType = self::TYPE_IDENTIFIER, $rightType = self: lessThanOrEqualTo($left, $right, $leftType = self::TYPE_IDENTIFIER, $rightType = greaterThanOrEqualTo($left, $right, $leftType = self::TYPE_IDENTIFIER, $rightTyp like($identifier, $like); literal($literal); expression($expression, $parameter); isNull($identifier); isNotNull($identifier); in($identifier, array $valueSet = array()); between($identifier, $minValue, $maxValue);
// Inherited From PredicateSet public public public public public public } function function function function function function addPredicate(PredicateInterface $predicate, $combination = null); getPredicates(); orPredicate(PredicateInterface $predicate); andPredicate(PredicateInterface $predicate); getExpressionData(); count();
Each method in the Where API will produce a corresponding Predicate object of a similarly named type, described below, with the full API of the object:
319
$where->equalTo(id, 5); // same as the following workflow $where->addPredicate( new Predicate\Operator($left, Operator::OPERATOR_EQUAL_TO, $right, $leftType, $rightType) ); class Operator implements PredicateInterface { const OPERATOR_EQUAL_TO const OP_EQ const OPERATOR_NOT_EQUAL_TO const OP_NE const OPERATOR_LESS_THAN const OP_LT const OPERATOR_LESS_THAN_OR_EQUAL_TO const OP_LTE const OPERATOR_GREATER_THAN const OP_GT const OPERATOR_GREATER_THAN_OR_EQUAL_TO const OP_GTE public public public public public public public public public public public public } function function function function function function function function function function function function
= = = = = = = = = = = =
=; =; !=; !=; <; <; <=; <=; >; >; >=; >=;
__construct($left = null, $operator = self::OPERATOR_EQUAL_TO, $right = null, $le setLeft($left); getLeft(); setLeftType($type); getLeftType(); setOperator($operator); getOperator(); setRight($value); getRight(); setRightType($type); getRightType(); getExpressionData();
$where->like($identifier, $like): // same as $where->addPredicate( new Predicate\Like($identifier, $like) ); // full API class Like { public public public public implements PredicateInterface function function function function __construct($identifier = null, $like = null); setIdentifier($identifier); getIdentifier(); setLike($like);
320
16 17
68.7.3 literal($literal);
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
$where->literal($literal); // same as $where->addPredicate( new Predicate\Literal($literal) ); // full API class Literal implements ExpressionInterface, PredicateInterface { const PLACEHOLDER = ?; public function __construct($literal = ); public function setLiteral($literal); public function getLiteral(); }
$where->expression($expression, $parameter); // same as $where->addPredicate( new Predicate\Expression($expression, $parameter) ); // full API class Expression implements ExpressionInterface, PredicateInterface { const PLACEHOLDER = ?; public function __construct($expression = null, $valueParameter = null /*[, $valueParameter, ... public function setExpression($expression); public function getExpression(); public function setParameters($parameters); public function getParameters(); public function setTypes(array $types); public function getTypes(); }
68.7.5 isNull($identier);
1 2 3 4 5 6 7 8
321
9 10 11 12 13 14
class IsNull implements PredicateInterface { public function __construct($identifier = null); public function setIdentifier($identifier); public function getIdentifier(); }
68.7.6 isNotNull($identier);
1 2 3 4 5 6 7 8 9 10 11 12 13 14
$where->isNotNull($identifier); // same as $where->addPredicate( new Predicate\IsNotNull($identifier) ); // full API class IsNotNull implements PredicateInterface { public function __construct($identifier = null); public function setIdentifier($identifier); public function getIdentifier(); }
$where->in($identifier, array $valueSet = array()); // same as $where->addPredicate( new Predicate\In($identifier, $valueSet) ); // full API class In implements { public function public function public function public function public function }
PredicateInterface __construct($identifier = null, array $valueSet = array()); setIdentifier($identifier); getIdentifier(); setValueSet(array $valueSet); getValueSet();
$where->between($identifier, $minValue, $maxValue); // same as $where->addPredicate( new Predicate\Between($identifier, $minValue, $maxValue) ); // full API
322
9 10 11 12 13 14 15 16 17 18 19
class Between implements PredicateInterface { public function __construct($identifier = null, $minValue = null, $maxValue = null); public function setIdentifier($identifier); public function getIdentifier(); public function setMinValue($minValue); public function getMinValue(); public function setMaxValue($maxValue); public function getMaxValue(); public function setSpecification($specification); }
323
324
CHAPTER 69
Zend\Db\Sql\Ddl
Zend\Db\Sql\Ddl is a sub-component of Zend\Db\Sql that allows consumers to create statement objects that will produce DDL (Data Denition Language) SQL statements. When combined with a platform specic Zend\Db\Sql\Sql object, these DDL objects are capable of producing platform-specic CREATE TABLE statements, with specialized data types, constraints, and indexes for a database/schema. The following platforms have platform specializations for DDL: MySQL All databases compatible with ANSI SQL92
325
326
CHAPTER 70
Creating Tables
Like Zend\Db\Sql objects, each statement type is represented by a class. For example, CREATE TABLE is modeled by a CreateTable object; this is likewise the same for ALTER TABLE (as AlterTable), and DROP TABLE (as DropTable). These classes exist in the Zend\Db\Sql\Ddl namespace. To initiate the building of a DDL statement, such as CreateTable, one needs to instantiate the object. There are a couple of valid patterns for this:
1 2 3 4 5 6 7 8 9
use Zend\Db\Sql\Ddl; $table = new Ddl\CreateTable(); // or with table $table = new Ddl\CreateTable(bar); // optionally, as a temporary table $table = new Ddl\CreateTable(bar, true);
$table->setTable(bar);
Currently, columns are added by creating a column object, described in the data type table in the data type section below:
1 2 3
327
328
CHAPTER 71
Altering Tables
use Zend\Db\Sql\Ddl; $table = new Ddl\AlterTable(); // or with table $table = new Ddl\AlterTable(bar); // optionally, as a temporary table $table = new Ddl\AlterTable(bar, true);
The primary difference between a CreateTable and AlterTable is that the AlterTable takes into account that the table and its assets already exist. Therefore, while you still have addColumn() and addConstraint(), you will also see the ability to change existing columns:
1 2
$table->dropColumn(foo); $table->dropConstraint(my_index);
329
330
CHAPTER 72
Dropping Tables
331
332
CHAPTER 73
After a DDL statement object has been created and congured, at some point you will want to execute the statement. To do this, you will need two other objects: an Adapter instance, and a properly seeded Sql instance. The workow looks something like this, with $ddl being a CreateTable, AlterTable, or DropTable instance:
1 2 3 4 5 6 7 8 9
use Zend\Db\Sql\Sql; // existence of $adapter is assumed $sql = new Sql($adapter); $adapter->query( $sql->getSqlStringForSqlObject($ddl), $adapter::QUERY_MODE_EXECUTE );
By passing the $ddl object through the $sql objects getSqlStringForSqlObject() method, we ensure that any platform specic specializations/modications are utilized to create a platform specic SQL statement. Next, using the constant Zend\Db\Adapter\Adapter::QUERY_MODE_EXECUTE ensures that the SQL statement is not prepared, as many DDL statements on a variety of platforms cannot be prepared, only executed.
333
334
CHAPTER 74
These types exist in the Zend\Db\Sql\Ddl\Column namespace. Zend\Db\Sql\Ddl\Column\ColumnInterface. In alphabetical order: Type Blob Boolean Char Column (generic) Date Decimal Float Integer Time Varchar
Arguments For Construction $name, $length, $nullable = false, $default = null, array $options = array() $name $name, $length $name = null $name $name, $precision, $scale = null $name, $digits, $decimal $name, $nullable = false, $default = null, array $options = array() $name $name, $length
Each of the above types can be utilized in any place that accepts a Column\ColumnInterface instance. Currently, this is primarily in CreateTable::addColumn() and AlterTables addColumn() and changeColumn() methods.
335
336
CHAPTER 75
Type Arguments For Construction Check $expression, $name For$name, $column, $referenceTable, $referenceColumn, $onDeleteRule = eignKey null, $onUpdateRule = null Prima$columns ryKey UniqueKey $column, $name = null Each of the above types can be utilized in any place that accepts a Column\ConstraintInterface instance. Currently, this is primarily in CreateTable::addConstraint() and AlterTable::addConstraint().
337
338
CHAPTER 76
Zend\Db\TableGateway
The Table Gateway object is intended to provide an object that represents a table in a database, and the methods of this object mirror the most common operations on a database table. In code, the interface for such an object looks like this:
1 2 3 4 5 6 7 8
interface Zend\Db\TableGateway\TableGatewayInterface { public function getTable(); public function select($where = null); public function insert($set); public function update($set, $where = null); public function delete($where); }
There are two primary implementations of the TableGatewayInterface that are of the most useful: AbstractTableGateway and TableGateway. The AbstractTableGateway is an abstract basic implementation that provides functionality for select(), insert(), update(), delete(), as well as an additional API for doing these same kinds of tasks with explicit SQL objects. These methods are selectWith(), insertWith(), updateWith() and deleteWith(). In addition, AbstractTableGateway also implements a Feature API, that allows for expanding the behaviors of the base TableGateway implementation without having to extend the class with this new functionality. The TableGateway concrete implementation simply adds a sensible constructor to the AbstractTableGateway class so that out-of-the-box, TableGateway does not need to be extended in order to be consumed and utilized to its fullest.
class TableGateway extends AbstractTableGateway { public $lastInsertValue; public $table; public $adapter;
public function __construct($table, Adapter $adapter, $features = null, ResultSet $resultSetProt /** Inherited from AbstractTableGateway */
339
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
public public public public public public public public public public public public public public public public public }
function function function function function function function function function function function function function function function function function
isInitialized(); initialize(); getTable(); getAdapter(); getColumns(); getFeatureSet(); getResultSetPrototype(); getSql(); select($where = null); selectWith(Select $select); insert($set); insertWith(Insert $insert); update($set, $where = null); updateWith(Update $update); delete($where); deleteWith(Delete $delete); getLastInsertValue();
The concrete TableGateway object practices constructor injection for getting dependencies and options into the instance. The table name and an instance of an Adapter are all that is needed to setup a working TableGateway object. Out of the box, this implementation makes no assumptions about table structure or metadata, and when select() is executed, a simple ResultSet object with the populated Adapters Result (the datasource) will be returned and ready for iteration.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
use Zend\Db\TableGateway\TableGateway; $projectTable = new TableGateway(project, $adapter); $rowset = $projectTable->select(array(type => PHP)); echo Projects of type PHP: ; foreach ($rowset as $projectRow) { echo $projectRow[name] . PHP_EOL; } // or, when expecting a single row: $artistTable = new TableGateway(artist, $adapter); $rowset = $artistTable->select(array(id => 2)); $artistRow = $rowset->current(); var_dump($artistRow);
The select() method takes the same arguments as Zend\Db\Sql\Select::where() with the addition of also being able to accept a closure, which in turn, will be passed the current Select object that is being used to build the SELECT query. The following usage is possible:
1 2 3 4 5 6 7 8 9
use Zend\Db\TableGateway\TableGateway; use Zend\Db\Sql\Select; $artistTable = new TableGateway(artist, $adapter); // search for at most 2 artists whos name starts with Brit, ascending $rowset = $artistTable->select(function (Select $select) { $select->where->like(name, Brit%); $select->order(name ASC)->limit(2); });
340
use Zend\Db\TableGateway\AbstractTableGateway; use Zend\Db\TableGateway\Feature; class MyTableGateway extends AbstractTableGateway { public function __construct() { $this->table = my_table; $this->featureSet = new Feature\FeatureSet(); $this->featureSet->addFeature(new Feature\GlobalAdapterFeature()); $this->initialize(); } } // elsewhere in code, in a bootstrap Zend\Db\TableGateway\Feature\GlobalAdapterFeature::setStaticAdapter($adapter); // in a controller, or model somewhere $table = new MyTableGateway(); // adapter is statically loaded
MasterSlaveFeature: the ability to use a master adapter for insert(), update(), and delete() while using a slave adapter for all select() operations.
1
MetadataFeature: the ability populate TableGateway with column information from a Metadata object. It will also store the primary key information in case RowGatewayFeature needs to consume this information.
1
EventFeature: the ability utilize a TableGateway object with Zend\EventManager and to be able to subscribe to various events in a TableGateway lifecycle.
1
RowGatewayFeature: the ability for select() to return a ResultSet object that upon iteration will return a RowGateway object for each row.
1 2 3 4
$table = new TableGateway(artist, $adapter, new Feature\RowGatewayFeature(id)); $results = $table->select(array(id => 2)); $artistRow = $results->current();
341
5 6
342
CHAPTER 77
Zend\Db\RowGateway
Zend\Db\RowGateway is a sub-component of Zend\Db that implements the Row Gateway pattern from PoEAA. This effectively means that Row Gateway objects primarily model a row in a database, and have methods such as save() and delete() that will help persist this row-as-an-object in the database itself. Likewise, after a row from the database is retrieved, it can then be manipulated and save()d back to the database in the same position (row), or it can be delete()d from the table. The interface for a Row Gateway object simply adds save() and delete() and this is the interface that should be assumed when a component has a dependency that is expected to be an instance of a RowGateway object:
1 2 3 4 5
77.1 Quickstart
While most of the time, RowGateway will be used in conjunction with other Zend\Db\ResultSet producing objects, it is possible to use it standalone. To use it standalone, you simply need an Adapter and a set of data to work with. The following use case demonstrates Zend\Db\RowGateway\RowGateway usage in its simplest form:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
use Zend\Db\RowGateway\RowGateway; // query the database $resultSet = $adapter->query(SELECT * FROM user WHERE id = ?, array(2)); // get array of data $rowData = $resultSet->current()->getArrayCopy(); // row gateway $rowGateway = new RowGateway(id, my_table, $adapter); $rowGateway->populate($rowData); $rowGateway->first_name = New Name; $rowGateway->save();
343
16 17
The workow described above is greatly simplied when RowGateway is used in conjunction with the TableGateway feature. What this achieves is a Table Gateway object that when select()ing from a table, will produce a ResultSet that is then capable of producing valid Row Gateway objects. Its usage looks like this:
1 2 3 4 5 6 7 8 9
use Zend\Db\TableGateway\Feature\RowGatewayFeature; use Zend\Db\TableGateway\TableGateway; $table = new TableGateway(artist, $adapter, new RowGatewayFeature(id)); $results = $table->select(array(id => 2)); $artistRow = $results->current(); $artistRow->name = New Name; $artistRow->save();
use Zend\Db\TableGateway\Feature\RowGatewayFeature; use Zend\Db\TableGateway\TableGateway; use Zend\Db\RowGateway\RowGatewayInterface; class Artist implements RowGatewayInterface { protected $adapter; public function __construct($adapter) { $this->adapter = $adapter; } // ... save() and delete() implementations } $table = new TableGateway(artist, $adapter, new RowGatewayFeature(new Artist($adapter)));
344
CHAPTER 78
Zend\Db\Metadata
Zend\Db\Metadata is as sub-component of Zend\Db that makes it possible to get metadata information about tables, columns, constraints, triggers, and other information from a database in a standardized way. The primary interface for the Metadata objects is:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
interface MetadataInterface { public function getSchemas(); public function getTableNames($schema = null, $includeViews = false); public function getTables($schema = null, $includeViews = false); public function getTable($tableName, $schema = null); public function getViewNames($schema = null); public function getViews($schema = null); public function getView($viewName, $schema = null); public function getColumnNames($table, $schema = null); public function getColumns($table, $schema = null); public function getColumn($columnName, $table, $schema = null); public function getConstraints($table, $schema = null); public function getConstraint($constraintName, $table, $schema = null); public function getConstraintKeys($constraint, $table, $schema = null); public function getTriggerNames($schema = null); public function getTriggers($schema = null); public function getTrigger($triggerName, $schema = null); }
345
Metadata::get*Names() methods will return an array of strings, while the other methods will return specic value objects with the containing information. This is best demonstrated by the script below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
$metadata = new Zend\Db\Metadata\Metadata($adapter); // get the table names $tableNames = $metadata->getTableNames(); foreach ($tableNames as $tableName) { echo In Table . $tableName . PHP_EOL; $table = $metadata->getTable($tableName);
echo With columns: . PHP_EOL; foreach ($table->getColumns() as $column) { echo . $column->getName() . -> . $column->getDataType() . PHP_EOL; } echo PHP_EOL; echo With constraints: . PHP_EOL; foreach ($metadata->getConstraints($tableName) as $constraint) { /** @var $constraint Zend\Db\Metadata\Object\ConstraintObject */ echo . $constraint->getName() . -> . $constraint->getType() . PHP_EOL; if (!$constraint->hasColumns()) { continue; } echo column: . implode(, , $constraint->getColumns()); if ($constraint->isForeignKey()) { $fkCols = array(); foreach ($constraint->getReferencedColumns() as $refColumn) { $fkCols[] = $constraint->getReferencedTableName() . . . $refColumn; } echo => . implode(, , $fkCols); } echo PHP_EOL; } echo ---- . PHP_EOL; }
Metadata returns value objects that provide an interface to help developers better explore the metadata. Below is the API for the various value objects: The TableObject:
1 2 3 4 5 6 7
class Zend\Db\Metadata\Object\TableObject { public function __construct($name); public function setColumns(array $columns); public function getColumns(); public function setConstraints($constraints); public function getConstraints();
346
8 9 10
The ColumnObject:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
class Zend\Db\Metadata\Object\ColumnObject { public function __construct($name, $tableName, $schemaName = null); public function setName($name); public function getName(); public function getTableName(); public function setTableName($tableName); public function setSchemaName($schemaName); public function getSchemaName(); public function getOrdinalPosition(); public function setOrdinalPosition($ordinalPosition); public function getColumnDefault(); public function setColumnDefault($columnDefault); public function getIsNullable(); public function setIsNullable($isNullable); public function isNullable(); public function getDataType(); public function setDataType($dataType); public function getCharacterMaximumLength(); public function setCharacterMaximumLength($characterMaximumLength); public function getCharacterOctetLength(); public function setCharacterOctetLength($characterOctetLength); public function getNumericPrecision(); public function setNumericPrecision($numericPrecision); public function getNumericScale(); public function setNumericScale($numericScale); public function getNumericUnsigned(); public function setNumericUnsigned($numericUnsigned); public function isNumericUnsigned(); public function getErratas(); public function setErratas(array $erratas); public function getErrata($errataName); public function setErrata($errataName, $errataValue); }
The ConstraintObject:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
class Zend\Db\Metadata\Object\ConstraintObject { public function __construct($name, $tableName, $schemaName = null); public function setName($name); public function getName(); public function setSchemaName($schemaName); public function getSchemaName(); public function getTableName(); public function setTableName($tableName); public function setType($type); public function getType(); public function hasColumns(); public function getColumns(); public function setColumns(array $columns); public function getReferencedTableSchema(); public function setReferencedTableSchema($referencedTableSchema); public function getReferencedTableName();
347
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
public public public public public public public public public public public public public public public }
function function function function function function function function function function function function function function function
setReferencedTableName($referencedTableName); getReferencedColumns(); setReferencedColumns(array $referencedColumns); getMatchOption(); setMatchOption($matchOption); getUpdateRule(); setUpdateRule($updateRule); getDeleteRule(); setDeleteRule($deleteRule); getCheckClause(); setCheckClause($checkClause); isPrimaryKey(); isUnique(); isForeignKey(); isCheck();
The TriggerObject:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
class Zend\Db\Metadata\Object\TriggerObject { public function getName(); public function setName($name); public function getEventManipulation(); public function setEventManipulation($eventManipulation); public function getEventObjectCatalog(); public function setEventObjectCatalog($eventObjectCatalog); public function getEventObjectSchema(); public function setEventObjectSchema($eventObjectSchema); public function getEventObjectTable(); public function setEventObjectTable($eventObjectTable); public function getActionOrder(); public function setActionOrder($actionOrder); public function getActionCondition(); public function setActionCondition($actionCondition); public function getActionStatement(); public function setActionStatement($actionStatement); public function getActionOrientation(); public function setActionOrientation($actionOrientation); public function getActionTiming(); public function setActionTiming($actionTiming); public function getActionReferenceOldTable(); public function setActionReferenceOldTable($actionReferenceOldTable); public function getActionReferenceNewTable(); public function setActionReferenceNewTable($actionReferenceNewTable); public function getActionReferenceOldRow(); public function setActionReferenceOldRow($actionReferenceOldRow); public function getActionReferenceNewRow(); public function setActionReferenceNewRow($actionReferenceNewRow); public function getCreated(); public function setCreated($created); }
348
CHAPTER 79
Introduction to Zend\Di
Above, MovieFinder is a dependency of MovieLister, and MovieFinder was injected into MovieLister. If you are not familiar with the concept of DI, here are a couple of great reads: Matthew Weier OPhinneys Analogy, Ralph Schindlers Learning DI, or Fabien Potenciers Series on DI.
349
350
CHAPTER 80
Zend\Di Quickstart
This QuickStart is intended to get developers familiar with the concepts of the Zend\Di DiC. Generally speaking, code is never as simple as it is inside this example, so working knowledge of the other sections of the manual is suggested. Assume for a moment, you have the following code as part of your application that you feel is a good candidate for being managed by a DiC, after all, you are already injecting all your dependencies:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
namespace MyLibrary { class DbAdapter { protected $username = null; protected $password = null; public function __construct($username, $password) { $this->username = $username; $this->password = $password; } } } namespace MyMovieApp { class MovieFinder { protected $dbAdapter = null; public function __construct(\MyLibrary\DbAdapter $dbAdapter) { $this->dbAdapter = $dbAdapter; } } class MovieLister { protected $movieFinder = null; public function __construct(MovieFinder $movieFinder) { $this->movieFinder = $movieFinder; } } }
351
With the above code, you nd yourself writing the following to wire and utilize this code:
1 2 3 4 5 6 7 8
// $config object is assumed $dbAdapter = new MyLibrary\DbAdapter($config->username, $config->password); $movieFinder = new MyMovieApp\MovieFinder($dbAdapter); $movieLister = new MyMovieApp\MovieLister($movieFinder); foreach ($movieLister as $movie) { // iterate and display $movie }
If you are doing this above wiring in each controller or view that wants to list movies, not only can this become repetitive and boring to write, but also unmaintainable if for example you want to swap out one of these dependencies on a wholesale scale. Since this example of code already practices good dependency injection, with constructor injection, it is a great candidate for using Zend\Di. The usage is as simple as:
1 2 3 4 5 6 7 8 9 10 11 12
// inside a bootstrap somewhere $di = new Zend\Di\Di(); $di->instanceManager()->setParameters(MyLibrary\DbAdapter, array( username => $config->username, password => $config->password )); // inside each controller $movieLister = $di->get(MyMovieApp\MovieLister); foreach ($movieLister as $movie) { // iterate and display $movie }
In the above example, we are obtaining a default instance of Zend\Di\Di. By default, we mean that Zend\Di\Di is constructed with a DenitionList seeded with a RuntimeDenition (uses Reection) and an empty instance manager and no conguration. Here is the Zend\Di\Di constructor:
1 2 3 4 5 6 7 8 9
public function __construct(DefinitionList $definitions = null, InstanceManager $instanceManager { $this->definitions = ($definitions) ?: new DefinitionList(new Definition\RuntimeDefinition()) $this->instanceManager = ($instanceManager) ?: new InstanceManager(); if ($config) { $this->configure($config); } }
This means that when $di->get() is called, it will be consulting the RuntimeDenition, which uses reection to understand the structure of the code. Once it knows the structure of the code, it can then know how the dependencies t together and how to go about wiring your objects for you. Zend\Di\Denition\RuntimeDenition will utilize the names of the parameters in the methods as the class parameter names. This is how both username and password key are mapped to the rst and second parameter, respectively, of the constructor consuming these named parameters. If you were to want to pass in the username and password at call time, this is achieved by passing them as the second argument of get():
1 2 3 4 5 6
// inside each controller $di = new Zend\Di\Di(); $movieLister = $di->get(MyMovieApp\MovieLister, array( username => $config->username, password => $config->password ));
352
7 8 9
It is important to note that when using call time parameters, these parameter names will be applied to any class that accepts a parameter of such name. By calling $di->get(), this instance of MovieLister will be automatically shared. This means subsequent calls to get() will return the same instance as previous calls. If you wish to have completely new instances of MovieLister, you can utilize $di->newInstance().
353
354
CHAPTER 81
Zend\Di Denition
Denitions are the place where Zend\Di attempts to understand the structure of the code it is attempting to wire. This means that if youve written non-ambiguous, clear and concise code; Zend\Di has a very good chance of understanding how to wire things up without much added complexity.
81.1 DenitionList
Denitions are introduced to the Zend\Di\Di object through a denition list implemented as Zend\Di\DenitionList (SplDoublyLinkedList). Order is important. Denitions in the front of the list will be consulted on a class before denitions at the end of the list. Note: Regardless of what kind of Denition strategy you decide to use, it is important that your autoloaders are already setup and ready to use.
81.2 RuntimeDenition
The default DenitionList instantiated by Zend\Di\Di, when no other DenitionList is provided, has as Denition\RuntimeDenition baked-in. The RuntimeDenition will respond to querys about classes by using Reection. This Runtime denitions uses any available information inside methods: their signature, the names of parameters, the type-hints of the parameters, and the default values to determine if something is optional or required when making a call to that method. The more explicit you can be in your method naming and method signatures, the easier of a time Zend\Di\Denition\RuntimeDenition will have determining the structure of your code. This is what the constructor of a RuntimeDenition looks like:
1 2 3 4 5 6 7
public function __construct(IntrospectionStrategy $introspectionStrategy = null, array $explicitClass { $this->introspectionStrategy = ($introspectionStrategy) ?: new IntrospectionStrategy(); if ($explicitClasses) { $this->setExplicitClasses($explicitClasses); } }
The IntrospectionStrategy object is an object that determines the rules, or guidelines, for how the RuntimeDenition will introspect information about your classes. Here are the things it knows how to do:
355
Whether or not to use Annotations (Annotations are expensive and off by default, read more about these in the Annotations section) Which method names to include in the introspection, by default, the pattern /^set[A-Z]{1}\w*/ is registered by default, this is a list of patterns. Which interface names represent the interface injection pattern. By default, the pattern /\w*Aware\w*/ is registered, this is a list of patterns. The constructor for the IntrospectionStrategy looks like this:
1 2 3 4
This goes to say that an AnnotationManager is not required, but if you wish to create a special AnnotationManager with your own annotations, and also wish to extend the RuntimeDenition to look for these special Annotations, this is the place to do it. The RuntimeDenition also can be used to look up either all classes (implicitly, which is default), or explicitly look up for particular pre-dened classes. This is useful when your strategy for inspecting one set of classes might differ from those of another strategy for another set of classes. This can be achieved by using the setExplicitClasses() method or by passing a list of classes as a second argument to the constructor of the RuntimeDenition.
81.3 CompilerDenition
The CompilerDenition is very much similar in nature to the RuntimeDenition with the exception that it can be seeded with more information for the purposes of compiling a denition. This is useful when you do not want to be making all those (sometimes expensive) calls to reection and the annotation scanning system during the request of your application. By using the compiler, a denition can be created and written to disk to be used during a request, as opposed to the task of scanning the actual code. For example, lets assume we want to create a script that will create denitions for some of our library code:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
// in "package name" format $components = array( My_MovieApp, My_OtherClasses, ); foreach ($components as $component) { $diCompiler = new Zend\Di\Definition\CompilerDefinition; $diCompiler->addDirectory(/path/to/classes/ . str_replace(_, /, $component)); $diCompiler->compile(); file_put_contents( __DIR__ . /../data/di/ . $component . -definition.php, <?php return . var_export($diCompiler->toArrayDefinition()->toArray(), true) . ; ); }
This will create a couple of les that will return an array of the denition for that class. To utilize this in an application, the following code will sufce:
1 2 3
356
4 5 6 7 8 9 10 11
new Definition\ArrayDefinition(include __DIR__ . /path/to/data/di/My_MovieApp-definition.php new Definition\ArrayDefinition(include __DIR__ . /path/to/data/di/My_OtherClasses-definition $runtime = new Definition\RuntimeDefinition(), )); $di = new Di($definitionList, null, new Configuration($this->config->di)); $di->instanceManager()->addTypePreference(Zend\Di\LocatorInterface, $di); $app->setLocator($di); }
The above code would more than likely go inside your applications or modules bootstrap le. This represents the simplest and most performant way of conguring your DiC for usage.
81.4 ClassDenition
The idea behind using a ClassDenition is two-fold. First, you may want to override some information inside of a RuntimeDenition. Secondly, you might want to simply dene your complete classs denition with an xml, ini, or php le describing the structure. This class denition can be fed in via Conguration or by directly instantiating and registering the Denition with the DenitionList. Todo - example
81.4. ClassDenition
357
358
CHAPTER 82
Zend\Di InstanceManager
The InstanceManager is responsible for any runtime information associated with the Zend\Di\Di DiC. This means that the information that goes into the instance manager is specic to both how the particular consuming Applications needs and even more specically to the environment in which the application is running.
82.1 Parameters
Parameters are simply entry points for either dependencies or instance conguration values. A class consists of a set of parameters, each uniquely named. When writing your classes, you should attempt to not use the same parameter name twice in the same class when you expect that that parameters is used for either instance conguration or an object dependency. This leads to an ambiguous parameter, and is a situation best avoided. Our movie nder example can be further used to explain these concepts:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
namespace MyLibrary { class DbAdapter { protected $username = null; protected $password = null; public function __construct($username, $password) { $this->username = $username; $this->password = $password; } } } namespace MyMovieApp { class MovieFinder { protected $dbAdapter = null; public function __construct(\MyLibrary\DbAdapter $dbAdapter) { $this->dbAdapter = $dbAdapter; } }
359
25 26 27 28 29 30 31 32 33 34
class MovieLister { protected $movieFinder = null; public function __construct(MovieFinder $movieFinder) { $this->movieFinder = $movieFinder; } } }
In the above example, the class DbAdapter has 2 parameters: username and password; MovieFinder has one parameter: dbAdapter, and MovieLister has one parameter: movieFinder. Any of these can be utilized for injection of either dependencies or scalar values during instance conguration or during call time. When looking at the above code, since the dbAdapter parameter and the movieFinder parameter are both type-hinted with concrete types, the DiC can assume that it can fulll these object tendencies by itself. On the other hand, username and password do not have type-hints and are, more than likely, scalar in nature. Since the DiC cannot reasonably know this information, it must be provided to the instance manager in the form of parameters. Not doing so will force $di->get(MyMovieApp\MovieLister) to throw an exception. The following ways of using parameters are available:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
// setting instance configuration into the instance manager $di->instanceManager()->setParameters(MyLibrary\DbAdapter, array( username => myusername, password => mypassword )); // forcing a particular dependency to be used by the instance manager $di->instanceManager()->setParameters(MyMovieApp\MovieFinder, array( dbAdapter => new MyLibrary\DbAdapter(myusername, mypassword) )); // passing instance parameters at call time $movieLister = $di->get(MyMovieApp\MovieLister, array( username => $config->username, password => $config->password )); // passing a specific instance at call time $movieLister = $di->get(MyMovieApp\MovieLister, array( dbAdapter => new MyLibrary\DbAdapter(myusername, mypassword) ));
82.2 Preferences
In some cases, you might be using interfaces as type hints as opposed to concrete types. Lets assume the movie example was modied in the following way:
1 2 3 4 5 6 7
360
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
class GenericMovieFinder implements MovieFinderInterface { protected $dbAdapter = null; public function __construct(\MyLibrary\DbAdapter $dbAdapter) { $this->dbAdapter = $dbAdapter; } } class MovieLister { protected $movieFinder = null; public function __construct(MovieFinderInterface $movieFinder) { $this->movieFinder = $movieFinder; } } }
What youll notice above is that now the MovieLister type minimally expects that the dependency injected implements the MovieFinderInterface. This allows multiple implementations of this base interface to be used as a dependency, if that is what the consumer decides they want to do. As you can imagine, Zend\Di, by itself would not be able to determine what kind of concrete object to use fulll this dependency, so this type of preference needs to be made known to the instance manager. To give this information to the instance manager, see the following code example:
1 2 3
$di->instanceManager()->addTypePreference(MyMovieApp\MovieFinderInterface, MyMovieApp\GenericMovie // assuming all instance config for username, password is setup $di->get(MyMovieApp\MovieLister);
82.3 Aliases
In some situations, youll nd that you need to alias an instance. There are two main reasons to do this. First, it creates a simpler, alternative name to use when using the DiC, as opposed to using the full class name. Second, you might nd that you need to have the same object type in two separate contexts. This means that when you alias a particular class, you can then attach a specic instance conguration to that alias; as opposed to attaching that conguration to the class name. To demonstrate both of these points, well look at a use case where well have two separate DbAdapters, one will be for read-only operations, the other will be for read-write operations: Note: Aliases can also have parameters registered at alias time
1 2 3 4 5 6 7 8 9 10 11 12
// assume the MovieLister example of code from the QuickStart $im = $di->instanceManager(); // add alias for short naming $im->addAlias(movielister, MyMovieApp\MovieLister); // add aliases for specific instances $im->addAlias(dbadapter-readonly, MyLibrary\DbAdapter, array( username => $config->db->readAdapter->username, password => $config->db->readAdapter->password, ));
82.3. Aliases
361
13 14 15 16 17 18 19 20 21 22
$im->addAlias(dbadapter-readwrite, MyLibrary\DbAdapter, array( username => $config->db->readWriteAdapter->username, password => $config->db->readWriteAdapter->password, )); // set a default type to use, pointing to an alias $im->addTypePreference(MyLibrary\DbAdapter, dbadapter-readonly);
362
CHAPTER 83
Zend\Di Conguration
Most of the conguration for both the setup of Denitions as well as the setup of the Instance Manager can be attained by a conguration le. This le will produce an array (typically) and have a particular iterable structure. The top two keys are denition and instance, each specifying values for respectively, denition setup and instance manager setup. The denition section expects the following information expressed as a PHP array:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
$config = array( definition => array( compiler => array(/* @todo compiler information */), runtime => array(/* @todo runtime information */), class => array( instantiator => , // the name of the instantiator, by default this is __construct supertypes => array(), // an array of supertypes the class implements methods => array( setSomeParameter => array( // a method name parameterName => array( name, // string parameter name type, // type or null is-required // bool ) ) ) ) ) );
363
364
CHAPTER 84
Zend\Di\Display\Console::export($di);
If you are using a RuntimeDenition where upon you expect a particular denition to be resolve at the rst-call, you can see that information to the console display to force it to read that class:
1
Zend\Di\Display\Console::export($di, array(A\ClassIWantTo\GetTheDefinitionFor));
namespace Foo\Bar { class Baz implements BamAwareInterface { public $bam; public function setBam(Bam $bam){ $this->bam = $bam; } } class Bam { } interface BamAwareInterface { public function setBam(Bam $bam); } } namespace {
365
17 18 19 20
namespace Foo\Bar { class Baz { public $bam; public function setBam(Bam $bam){ $this->bam = $bam; } } class Bam { } } namespace { $di = new Zend\Di\Di; $di->configure(new Zend\Di\Config(array( definition => array( class => array( Foo\Bar\Baz => array( setBam => array(required => true) ) ) ) ))); $baz = $di->get(Foo\Bar\Baz); }
namespace Application { class Page { public $blocks; public function addBlock(Block $block){ $this->blocks[] = $block; } } interface Block { } } namespace MyModule { class BlockOne implements \Application\Block {} class BlockTwo implements \Application\Block {} } namespace { include zf2bootstrap.php; $di = new Zend\Di\Di; $di->configure(new Zend\Di\Config(array( definition => array(
366
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
class => array( Application\Page => array( addBlock => array( block => array(type => Application\Block, required => true) ) ) ) ), instance => array( Application\Page => array( injections => array( MyModule\BlockOne, MyModule\BlockTwo ) ) ) ))); $page = $di->get(Application\Page); }
367
368
CHAPTER 85
Introduction to Zend\Dom
The Zend\Dom component provides tools for working with DOM documents and structures. Currently, we offer Zend\Dom\Query, which provides a unied interface for querying DOM documents utilizing both XPath and CSS selectors.
369
370
CHAPTER 86
Zend\Dom\Query
Zend\Dom\Query provides mechanisms for querying XML and (X) HTML documents utilizing either XPath or CSS selectors. It was developed to aid with functional testing of MVC applications, but could also be used for rapid development of screen scrapers. CSS selector notation is provided as a simpler and more familiar notation for web developers to utilize when querying documents with XML structures. The notation should be familiar to anybody who has developed Cascading Style Sheets or who utilizes Javascript toolkits that provide functionality for selecting nodes utilizing CSS selectors (Prototypes $$() and Dojos dojo.query were both inspirations for the component).
descendents: string together multiple selectors to indicate a hierarchy along which to search. div .foo span #one would select an element of id one that is a descendent of arbitrary depth beneath a span element, which is in turn a descendent of arbitrary depth beneath an element with a class of foo, that is an descendent of arbitrary depth beneath a div element. For example, it would match the link to the word One in the listing below:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
<div> <table> <tr> <td class="foo"> <div> Lorem ipsum <span class="bar"> <a href="/foo/bar" id="one">One</a> <a href="/foo/baz" id="two">Two</a> <a href="/foo/bat" id="three">Three</a> <a href="/foo/bla" id="four">Four</a> </span> </div> </td> </tr> </table> </div>
Once youve performed your query, you can then work with the result object to determine information about the nodes, as well as to pull them and/or their content directly for examination and manipulation. Zend\Dom\NodeList implements Countable and Iterator, and stores the results internally as a DOMDocument and DOMNodeList. As an example, consider the following call, that selects against the HTML above:
1 2 3 4 5 6 7 8 9
use Zend\Dom\Query; $dom = new Query($html); $results = $dom->execute(.foo .bar a); $count = count($results); // get number of matches: 4 foreach ($results as $result) { // $result is a DOMElement }
Zend\Dom\Query also allows straight XPath queries utilizing the queryXpath() method; you can pass any valid XPath query to this method, and it will return a Zend\Dom\NodeList object.
86.2.1 Zend\Dom\Query
The following methods are available to Zend\Dom\Query: setDocumentXml($document, $encoding = null): specify an XML string to query against. setDocumentXhtml($document, $encoding = null): specify an XHTML string to query against. setDocumentHtml($document, $encoding = null): specify an HTML string to query against. setDocument($document, $encoding = null): specify Zend\Dom\Query will then attempt to autodetect the document type. 372 a string to query against;
setEncoding($encoding): specify an encoding string to use. This encoding will be passed to DOMDocuments constructor if specied. getDocument(): retrieve the original document string provided to the object. getDocumentType(): retrieve the document type of the document provided to the object; will be one of the DOC_XML, DOC_XHTML, or DOC_HTML class constants. getEncoding(): retrieves the specied encoding. execute($query): query the document using CSS selector notation. queryXpath($xPathQuery): query the document using XPath notation.
86.2.2 Zend\Dom\NodeList
As mentioned previously, Zend\Dom\NodeList implements both Iterator and Countable, and as such can be used in a foreach() loop as well as with the count() function. Additionally, it exposes the following methods: getCssQuery(): return the CSS selector query used to produce the result (if any). getXpathQuery(): return the XPath query used to produce the result. Internally, Zend\Dom\Query converts CSS selector queries to XPath, so this value will always be populated. getDocument(): retrieve the DOMDocument the selection was made against.
373
374
CHAPTER 87
Introduction to Zend\Escaper
The OWASP Top 10 web security risks study lists Cross-Site Scripting (XSS) in second place. PHPs sole functionality against XSS is limited to two functions of which one is commonly misapplied. Thus, the Zend\Escaper component was written. It offers developers a way to escape output and defend from XSS and related vulnerabilities by introducing contextual escaping based on peer-reviewed rules. Zend\Escaper was written with ease of use in mind, so it can be used completely stand-alone from the rest of the framework, and as such can be installed with Composer. For easier use of the Escaper component within the framework itself, especially with the Zend\View component, a set of view helpers is provided. Warning: The Zend\Escaper is a security related component. As such, if you believe you found an issue with this component, we ask that you follow our Security Policy and report security issues accordingly. The Zend Framework team and the contributors thanks you in advance.
87.1 Overview
The Zend\Escaper component provides one class, Zend\Escaper\Escaper which in turn, provides ve methods for escaping output. Which method to use when, depends on the context in which the outputted data is used. It is up to the developer to use the right methods in the right context. Zend\Escaper\Escaper has the following escaping methods available for each context: escapeHtml: escape a string for the HTML Body context. escapeHtmlAttr: escape a string for the HTML Attribute context. escapeJs: escape a string for the Javascript context. escapeCss: escape a string for the CSS context. escapeUrl: escape a string for the URI or Parameter contexts. Usage of each method will be discussed in detail in later chapters.
375
376
CHAPTER 88
Theory of Operation
Zend\Escaper provides methods for escaping output data, dependent on the context in which the data will be used. Each method is based on peer-reviewed rules and is in compliance with the current OWASP recommendations. The escaping follows a well known and xed set of encoding rules for each key HTML context, which are dened by OWASP. These rules cannot be impacted or negated by browser quirks or edge-case HTML parsing unless the browser suffers a catastrophic bug in its HTML parser or Javascript interpreter - both of these are unlikely. The contexts in which Zend\Escaper should be used are HTML Body, HTML Attribute, Javascript, CSS and URL/URI contexts. Every escaper method will take the data to be escaped, make sure it is utf-8 encoded data, or try to convert it to utf-8, do the context-based escaping, encode the escaped data back to its original encoding and return the data to the caller. The actual escaping of the data differs between each method, they all have their own set of rules according to which the escaping is done. An example will allow us to clearly demonstrate the difference, and how the same characters are being escaped differently between contexts:
1 2 3 4 5 6 7 8 9 10 11 12
$escaper = new Zend\Escaper\Escaper(utf-8); // <script>alert("zf2")</script> echo $escaper->escapeHtml(<script>alert("zf2")</script>); // <script>alert("zf2")</script> echo $escaper->escapeHtmlAttr(<script>alert("zf2")</script>); // \x3Cscript\x3Ealert\x28\x22zf2\x22\x29\x3C\x2Fscript\x3E echo $escaper->escapeJs(<script>alert("zf2")</script>); // \3C script\3E alert\28 \22 zf2\22 \29 \3C \2F script\3E echo $escaper->escapeCss(<script>alert("zf2")</script>); // %3Cscript%3Ealert%28%22zf2%22%29%3C%2Fscript%3E echo $escaper->escapeUrl(<script>alert("zf2")</script>);
377
Javascript: addslashes() or json_encode() CSS: n/a URL/URI: rawurlencode() or urlencode() In practice, these decisions appear to depend more on what PHP offers, and if it can be interpreted as offering sufcient escaping safety, than it does on what is recommended in reality to defend against XSS. While these functions can prevent some forms of XSS, they do not cover all use cases or risks and are therefore insufcient defenses. Using htmlspecialchars() in a perfectly valid HTML5 unquoted attribute value, for example, is completely useless since the value can be terminated by a space (among other things) which is never escaped. Thus, in this instance, we have a conict between a widely used HTML escaper and a modern HTML specication, with no specic function available to cover this use case. While its tempting to blame users, or the HTML specication authors, escaping just needs to deal with whatever HTML and browsers allow. Using addslashes(), custom backslash escaping or json_encode() will typically ignore HTML special characters such as ampersands which may be used to inject entities into Javascript. Under the right circumstances, browser will convert these entities into their literal equivalents before interpreting Javascript thus allowing attackers to inject arbitrary code. Inconsistencies with valid HTML, insecure default parameters, lack of character encoding awareness, and misrepresentations of what functions are capable of by some programmers - these all make escaping in PHP an unnecessarily convoluted quest. To circumvent the lack of escaping methods in PHP, Zend\Escaper addresses the need to apply context-specic escaping in web applications. It implements methods that specically target XSS and offers programmers a tool to secure their applications without misusing other inadequate methods, or using, most likely incomplete, home-grown solutions.
88.2.1 HTML escaping of unquoted HTML attribute values still allows XSS
This is probably the best known way to defeat htmlspecialchars() when used on attribute values since any space (or character interpreted as a space - there are a lot) lets you inject new attributes whose content cant be neutralised by HTML escaping. The solution (where this is possible) is additional escaping as dened by the OWASP ESAPI codecs. The point here can be extended further - escaping only works if a programmer or designer know what theyre doing. In many contexts, there are additional practices and gotchas that need to be carefully monitored since escaping sometimes needs a little extra help to protect against XSS - even if that means ensuring all attribute values are properly double quoted despite this not being required for valid HTML.
88.2.2 HTML escaping of CSS, Javascript or URIs is often reversed when passed to non-HTML interpreters by the browser
HTML escaping is just that - its designed to escape a string for HTML (i.e. prevent tag or attribute insertion) but not alter the underlying meaning of the content whether it be Text, Javascript, CSS or URIs. For that purpose a fully HTML escaped version of any other context may still have its unescaped form extracted before its interpreted or executed. For this reason we need separate escapers for Javascript, CSS and URIs and those writing templates must know which escaper to apply to which context. Of course this means you need to be able to identify the correct context before selecting the right escaper!
378
88.2.3 DOM based XSS requires a defence using at least two levels of different escaping in many cases
DOM based XSS has become increasingly common as Javascript has taken off in popularity for large scale client side coding. A simple example is Javascript dened in a template which inserts a new piece of HTML text into the DOM. If the string is only HTML escaped, it may still contain Javascript that will execute in that context. If the string is only Javascript escaped, it may contain HTML markup (new tags and attributes) which will be injected into the DOM and parsed once the inserting Javascript executes. Damned either way? The solution is to escape twice - rst escape the string for HTML (make it safe for DOM insertion), and then for Javascript (make it safe for the current Javascript context). Nested contexts are a common means of bypassing naive escaping habits (e.g. you can inject Javascript into a CSS expression within a HTML Attribute).
88.2.4 PHP has no known anti-XSS escape functions (only those kidnapped from their original purposes)
A simple example, widely used, is when you see json_encode() used to escape Javascript, or worse, some kind of mutant addslashes() implementation. These were never designed to eliminate XSS yet PHP programmers use them as such. For example, json_encode() does not escape the ampersand or semi-colon characters by default. That means you can easily inject HTML entities which could then be decoded before the Javascript is evaluated in a HTML document. This lets you break out of strings, add new JS statements, close tags, etc. In other words, using json_encode() is insufcient and naive. The same, arguably, could be said for htmlspecialchars() which has its own well known limitations that make a singular reliance on it a questionable practice.
379
380
CHAPTER 89
Conguring Zend\Escaper
Zend\Escaper\Escaper has only one conguration option available, and that is the encoding to be used by the Escaper object. The default encoding is utf-8. Other supported encodings are: iso-8859-1 iso-8859-5 iso-8859-15 cp866, ibm866, 866 cp1251, windows-1251 cp1252, windows-1252 koi8-r, koi8-ru big5, big5-hkscs, 950, gb2312, 936 shift_jis, sjis, sjis-win, cp932 eucjp, eucjp-win macroman If an unsupported encoding is passed to Zend\Escaper\Escaper, Zend\Escaper\Exception\InvalidArgumentException will be thrown. a
381
382
CHAPTER 90
Escaping HTML
Probably the most common escaping happens in the HTML Body context. There are very few characters with special meaning in this context, yet it is quite common to escape data incorrectly, namely by setting the wrong ags and character encoding. For escaping data in the HTML Body context, use Zend\Escaper\Escapers escapeHtml method. Internally it uses PHPs htmlspecialchars, and additionally correctly sets the ags and encoding.
1 2 3 4 5 6 7 8 9 10 11
// outputting this without escaping would be a bad idea! $input = <script>alert("zf2")</script>; $escaper = new Zend\Escaper\Escaper(utf-8); // somewhere in an HTML template <div class="user-provided-input"> <?php echo $escaper->escapeHtml($input); // all safe! ?> </div>
One thing a developer needs to pay special attention too, is that the encoding in which the document is served to the client, as it must be the same as the encoding used for escaping!
<?php $input = <script>alert("zf2")</script>; $escaper = new Zend\Escaper\Escaper(utf-8); ?> <?php header(Content-Type: text/html; charset=ISO-8859-1); ?> <!DOCTYPE html> <html> <head> <title>Encodings set incorrectly!</title> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> </head> <body>
383
13 14 15 16 17
<?php // Bad! The escapers and the documents encodings are different! echo $escaper->escapeHtml($input); ?> </body>
<?php $input = <script>alert("zf2")</script>; $escaper = new Zend\Escaper\Escaper(utf-8); ?> <?php header(Content-Type: text/html; charset=UTF-8); ?> <!DOCTYPE html> <html> <head> <title>Encodings set correctly!</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> </head> <body> <?php // Good! The escapers and the documents encodings are same! echo $escaper->escapeHtml($input); ?> </body>
384
CHAPTER 91
Escaping data in the HTML Attribute context is most often done incorrectly, if not overlooked completely by developers. Regular HTML escaping can be used for escaping HTML attributes, but only if the attribute value can be guaranteed as being properly quoted! To avoid confusion, we recommend always using the HTML Attribute escaper method in the HTML Attribute context. To escape data in the HTML Attribute, use Zend\Escaper\Escapers escapeHtmlAttr method. Internally it will convert the data to UTF-8, check for its validity, and use an extended set of characters to escape that are not covered by htmlspecialchars to cover the cases where an attribute might be unquoted or quoted illegally.
<?php header(Content-Type: text/html; charset=UTF-8); ?> <!DOCTYPE html> <?php $input = <<<INPUT onmouseover=alert(/ZF2!/); INPUT; /** * NOTE: This is equivalent to using htmlspecialchars($input, ENT_COMPAT) */ $output = htmlspecialchars($input); ?> <html> <head> <title>Single Quoted Attribute</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> </head> <body> <div> <?php // the span tag will look like: // <span title= onmouseover=alert(/ZF2!/);> ?> <span title=<?php echo $output ?>> What framework are you using?
385
25 26 27 28
In the above example, the default ENT_COMPAT ag is being used, which does not escape single quotes, thus resulting in an alert box popping up when the onmouseover event happens on the span element. Another example of incorrect HTML attribute escaping can happen when unquoted attributes are used, which is, by the way, perfectly valid HTML5:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
<?php header(Content-Type: text/html; charset=UTF-8); ?> <!DOCTYPE html> <?php $input = <<<INPUT faketitle onmouseover=alert(/ZF2!/); INPUT; // Tough luck using proper flags when the title attribute is unquoted! $output = htmlspecialchars($input,ENT_QUOTES); ?> <html> <head> <title>Quoteless Attribute</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> </head> <body> <div> <?php // the span tag will look like: // <span title=faketitle onmouseover=alert(/ZF2!/);> ?> <span title=<?php echo $output ?>> What framework are you using? </span> </div> </body> </html>
The above example shows how it is easy to break out from unquoted attributes in HTML5.
<?php header(Content-Type: text/html; charset=UTF-8); ?> <!DOCTYPE html> <?php $input = <<<INPUT faketitle onmouseover=alert(/ZF2!/); INPUT; $escaper = new Zend\Escaper\Escaper(utf-8); $output = $escaper->escapeHtmlAttr($input); ?> <html> <head> <title>Quoteless Attribute</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
386
14 15 16 17 18 19 20 21 22 23 24 25 26
</head> <body> <div> <?php // the span tag will look like: // <span title=faketitle onmouseover=alert(/ZF2!/);> ?> <span title=<?php echo $output ?>> What framework are you using? </span> </div> </body> </html>
In the above example, the malicious input from the attacker becomes completely harmless as we used proper HTML attribute escaping!
387
388
CHAPTER 92
Escaping Javascript
Javascript string literals in HTML are subject to signicant restrictions particularly due to the potential for unquoted attributes and any uncertainty as to whether Javascript will be viewed as being CDATA or PCDATA by the browser. To eliminate any possible XSS vulnerabilities, Javascript escaping for HTML extends the escaping rules of both ECMAScript and JSON to include any potentially dangerous character. Very similar to HTML attribute value escaping, this means escaping everything except basic alphanumeric characters and the comma, period and underscore characters as hexadecimal or unicode escapes. Javascript escaping applies to all literal strings and digits. It is not possible to safely escape other Javascript markup. To escape data in the Javascript context, use Zend\Escaper\Escapers escapeJs method. An extended set of characters are escaped beyond ECMAScripts rules for Javascript literal string escaping in order to prevent misinterpretation of Javascript as HTML leading to the injection of special characters and entities.
<?php header(Content-Type: application/xhtml+xml; charset=UTF-8); ?> <!DOCTYPE html> <?php $input = <<<INPUT bar"; alert("Meow!"); var xss="true INPUT; $output = json_encode($input); ?> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>Unescaped Entities</title> <meta charset="UTF-8"/> <script type="text/javascript"> <?php // this will result in // var foo = "bar"; alert("Meow!"); var xss="true"; ?> var foo = <?php echo $output ?>; </script> </head> <body>
389
22 23 24
The above example will show an alert popup box as soon as the page is loaded, because the data is not properly escaped for the Javascript context.
<?php header(Content-Type: text/html; charset=UTF-8); ?> <!DOCTYPE html> <?php $input = <<<INPUT bar"; alert("Meow!"); var xss="true INPUT; $escaper = new Zend\Escaper\Escaper(utf-8); $output = $escaper->escapeJs($input); ?> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>Escaped Entities</title> <meta charset="UTF-8"/> <script type="text/javascript"> <?php // this will look like // var foo = bar\x26quot\x3B\x3B\x20alert\x28\x26quot\x3BMeow\x21\x26quot\x3B\x29\x3B\x20var\ ?> var foo = <?php echo $output ?>; </script> </head> <body> <p>Zend\Escaper\Escaper::escapeJs() is good for escaping javascript!</p> </body> </html>
In the above example, the Javascript parser will most likely report a SyntaxError, but at least the targeted application remains safe from such attacks.
390
CHAPTER 93
CSS is similar to Javascript for the same reasons. CSS escaping excludes only basic alphanumeric characters and escapes all other characters into valid CSS hexadecimal escapes.
<?php header(Content-Type: application/xhtml+xml; charset=UTF-8); ?> <!DOCTYPE html> <?php $input = <<<INPUT body { background-image: url(http://example.com/foo.jpg?</style><script>alert(1)</script>); } INPUT; ?> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>Unescaped CSS</title> <meta charset="UTF-8"/> <style> <?php echo $input; ?> </style> </head> <body> <p>User controlled CSS needs to be properly escaped!</p> </body> </html>
In the above example, by failing to escape the user provided CSS, an attacker can execute an XSS attack fairly easily.
391
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
<?php header(Content-Type: application/xhtml+xml; charset=UTF-8); ?> <!DOCTYPE html> <?php $input = <<<INPUT body { background-image: url(http://example.com/foo.jpg?</style><script>alert(1)</script>); } INPUT; $escaper = new Zend\Escaper\Escaper(utf-8); $output = $escaper->escapeCss($input); ?> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>Escaped CSS</title> <meta charset="UTF-8"/> <style> <?php // output will look something like // body\20 \7B \A \20 \20 \20 \20 background\2D image\3A \20 url\28 ... echo $output; ?> </style> </head> <body> <p>User controlled CSS needs to be properly escaped!</p> </body> </html>
By properly escaping user controlled CSS, we can prevent XSS attacks in our web applications.
392
CHAPTER 94
Escaping URLs
This method is basically an alias for PHPs rawurlencode() which has applied RFC 3986 since PHP 5.3. It is included primarily for consistency. URL escaping applies to data being inserted into a URL and not to the whole URL itself.
<?php header(Content-Type: application/xhtml+xml; charset=UTF-8); ?> <!DOCTYPE html> <?php $input = <<<INPUT " onmouseover="alert(zf2) INPUT; ?> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>Unescaped URL data</title> <meta charset="UTF-8"/> </head> <body> <a href="http://example.com/?name=<?php echo $input; ?>">Click here!</a> </body> </html>
<?php header(Content-Type: application/xhtml+xml; charset=UTF-8); ?> <!DOCTYPE html> <?php $input = <<<INPUT " onmouseover="alert(zf2) INPUT;
393
7 8 9 10 11 12 13 14 15 16 17 18
$escaper = new Zend\Escaper\Escaper(utf-8); $output = $escaper->escapeUrl($input); ?> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>Unescaped URL data</title> <meta charset="UTF-8"/> </head> <body> <a href="http://example.com/?name=<?php echo $output; ?>">Click here!</a> </body> </html>
394
CHAPTER 95
The EventManager
95.1 Overview
The EventManager is a component designed for the following use cases: Implementing simple subject/observer patterns. Implementing Aspect-Oriented designs. Implementing event-driven architectures. The basic architecture allows you to attach and detach listeners to named events, both on a per-instance basis as well as via shared collections; trigger events; and interrupt execution of listeners.
use Zend\EventManager\EventManagerInterface; use Zend\EventManager\EventManager; use Zend\EventManager\EventManagerAwareInterface; class Foo implements EventManagerAwareInterface { protected $events; public function setEventManager(EventManagerInterface $events) { $events->setIdentifiers(array( __CLASS__, get_called_class(), )); $this->events = $events; return $this; } public function getEventManager() { if (null === $this->events) {
395
22 23 24 25 26
The above allows users to access the EventManager instance, or reset it with a new instance; if one does not exist, it will be lazily instantiated on-demand. An EventManager is really only interesting if it triggers some events. Basic triggering takes three arguments: the event name, which is usually the current function/method name; the context, which is usually the current object instance; and the arguments, which are usually the arguments provided to the current function/method.
1 2 3 4 5 6 7 8 9 10
class Foo { // ... assume events definition from above public function bar($baz, $bat = null) { $params = compact(baz, bat); $this->getEventManager()->trigger(__FUNCTION__, $this, $params); } }
In turn, triggering events is only interesting if something is listening for the event. Listeners attach to the EventManager, specifying a named event and the callback to notify. The callback receives an Event object, which has accessors for retrieving the event name, context, and parameters. Lets add a listener, and trigger the event.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
use Zend\Log\Factory as LogFactory; $log = LogFactory($someConfig); $foo = new Foo(); $foo->getEventManager()->attach(bar, function ($e) use ($log) { $event = $e->getName(); $target = get_class($e->getTarget()); $params = json_encode($e->getParams()); $log->info(sprintf( %s called on %s, using params %s, $event, $target, $params )); }); // Results in log message: $foo->bar(baz, bat); // reading: bar called on Foo, using params {"baz" : "baz", "bat" : "bat"}"
Note that the second argument to attach() is any valid callback; an anonymous function is shown in the example in order to keep the example self-contained. However, you could also utilize a valid function name, a functor, a string referencing a static method, or an array callback with a named static method or instance method. Again, any PHP callback is valid. Sometimes you may want to specify listeners without yet having an object instance of the class composing an EventManager. Zend Framework enables this through the concept of a SharedEventCollection. Simply put, you can inject individual EventManager instances with a well-known SharedEventCollection, and the EventManager instance will query it for additional listeners. Listeners attach to a SharedEventCollection in roughly the same way the do normal event managers; the call to attach is identical to the EventManager, 396 Chapter 95. The EventManager
but expects an additional parameter at the beginning: a named instance. Remember the example of composing an EventManager, how we passed it __CLASS__? That value, or any strings you provide in an array to the constructor, may be used to identify an instance when using a SharedEventCollection. As an example, assuming we have a SharedEventManager instance that we know has been injected in our EventManager instances (for instance, via dependency injection), we could change the above example to attach via the shared collection:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
use Zend\Log\Factory as LogFactory; // Assume $events is a Zend\EventManager\SharedEventManager instance $log = LogFactory($someConfig); $events->attach(Foo, bar, function ($e) use ($log) { $event = $e->getName(); $target = get_class($e->getTarget()); $params = json_encode($e->getParams()); $log->info(sprintf( %s called on %s, using params %s, $event, $target, $params )); }); // Later, instantiate Foo: $foo = new Foo(); $foo->getEventManager()->setSharedManager($events); // And we can still trigger the above event: $foo->bar(baz, bat); // results in log message: // bar called on Foo, using params {"baz" : "baz", "bat" : "bat"}"
Note: StaticEventManager As of 2.0.0beta3, you can use the StaticEventManager singleton as a SharedEventCollection. As such, you do not need to worry about where and how to get access to the SharedEventCollection; its globally available by simply calling StaticEventManager::getInstance(). Be aware, however, that its usage is deprecated within the framework, and starting with 2.0.0beta4, you will instead congure a SharedEventManager instance that will be injected by the framework into individual EventManager instances. The EventManager also provides the ability to detach listeners, short-circuit execution of an event either from within a listener or by testing return values of listeners, test and loop through the results returned by listeners, prioritize listeners, and more. Many of these features are detailed in the examples.
397
Attaching to many events at once $events = new EventManager(); $events->attach(array(these, are, event, names), $callback);
1 2
Note that if you specify a priority, that priority will be used for all events specied.
Attaching using the wildcard $events = new EventManager(); $events->attach(*, $callback);
1 2
Note that if you specify a priority, that priority will be used for this listener for any event triggered. What the above species is that any event triggered will result in notication of this particular listener.
Attaching to many events at once via a SharedEventManager $events = new SharedEventManager(); // Attach to many events on the context "foo" $events->attach(foo, array(these, are, event, names), $callback); // Attach to many events on the contexts "foo" and "bar" $events->attach(array(foo, bar), array(these, are, event, names), $callback);
1 2 3 4 5 6
Note that if you specify a priority, that priority will be used for all events specied.
Attaching using the wildcard via a SharedEventManager $events = new SharedEventManager(); // Attach to all events on the context "foo" $events->attach(foo, *, $callback); // Attach to all events on the contexts "foo" and "bar" $events->attach(array(foo, bar), *, $callback);
1 2 3 4 5 6
Note that if you specify a priority, that priority will be used for all events specied. The above is specifying that for the contexts foo and bar, the specied listener should be notied for any event they trigger.
identier A string or array of strings to which the given EventManager instance can answer when accessed via a SharedEventManager. event_class The name of an alternate Event class to use for representing events passed to listeners. shared_collections An instance of a SharedEventCollection instance to use when triggering events.
398
399
detachAggregate detachAggregate(ListenerAggregateInterface $aggregate) Loops through all listeners of all events to identify listeners that are represented by the aggregate; for all matches, the listeners will be removed. Returns a boolean true if any listeners have been identied and unsubscribed, and a boolean false otherwise. getEvents getEvents() Returns an array of all event names that have listeners attached. getListeners getListeners(string $event) Returns a Zend\Stdlib\PriorityQueue instance of all listeners attached to $event. clearListeners clearListeners(string $event) Removes all listeners attached to $event. prepareArgs prepareArgs(array $args) Creates an ArrayObject from the provided $args. This can be useful if you want yours listeners to be able to modify arguments such that later listeners or the triggering method can see the changes.
95.5 Examples
Modifying Arguments
Occasionally it can be useful to allow listeners to modify the arguments they receive so that later listeners or the calling method will receive those changed values. As an example, you might want to pre-lter a date that you know will arrive as a string and convert it to a DateTime argument. To do this, you can pass your arguments to prepareArgs(), and pass this new object when triggering an event. You will then pull that value back into your method.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
class ValueObject { // assume a composed event manager function inject(array $values) { $argv = compact(values); $argv = $this->getEventManager()->prepareArgs($argv); $this->getEventManager()->trigger(__FUNCTION__, $this, $argv); $date = isset($argv[values][date]) ? $argv[values][date] : new DateTime(now); // ... } } $v = new ValueObject(); $v->getEventManager()->attach(inject, function($e) { $values = $e->getParam(values); if (!$values) { return; } if (!isset($values[date])) {
400
24 25 26 27 28 29 30 31 32
$values[date] = new \DateTime(now); return; } $values[date] = new \Datetime($values[date]); }); $v->inject(array( date => 2011-08-10 15:30:29, ));
Short Circuiting
One common use case for events is to trigger listeners until either one indicates no further processing should be done, or until a return value meets specic criteria. As examples, if an event creates a Response object, it may want execution to stop.
1 2 3 4 5 6 7
$listener = function($e) { // do some work // Stop propagation and return a response $e->stopPropagation(true); return $response; };
Alternately, we could do the check from the method triggering the event.
1 2 3 4 5 6 7 8 9 10 11 12
class Foo implements DispatchableInterface { // assume composed event manager public function dispatch(Request $request, Response $response = null) { $argv = compact(request, response); $results = $this->getEventManager()->triggerUntil(__FUNCTION__, $this, $argv, function($v) { return ($v instanceof Response); }); } }
Typically, you may want to return a value that stopped execution, or use it some way. Both trigger() and triggerUntil() return a ResponseCollection instance; call its stopped() method to test if execution was stopped, and last() method to retrieve the return value from the last executed listener:
1 2 3 4 5 6 7 8 9 10 11 12 13 14
class Foo implements DispatchableInterface { // assume composed event manager public function dispatch(Request $request, Response $response = null) { $argv = compact(request, response); $results = $this->getEventManager()->triggerUntil(__FUNCTION__, $this, $argv, function($v) { return ($v instanceof Response); }); // Test if execution was halted, and return last result: if ($results->stopped()) { return $results->last();
95.5. Examples
401
15 16 17 18 19
} // continue... } }
One use case for the EventManager is for implementing caching systems. As such, you often want to check the cache early, and save to it late. The third argument to attach() is a priority value. The higher this number, the earlier that listener will execute; the lower it is, the later it executes. The value defaults to 1, and values will trigger in the order registered within a given priority. So, to implement a caching system, our method will need to trigger an event at method start as well as at method end. At method start, we want an event that will trigger early; at method end, an event should trigger late. Here is the class in which we want caching:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
class SomeValueObject { // assume it composes an event manager public function get($id) { $params = compact(id); $results = $this->getEventManager()->trigger(get.pre, $this, $params); // If an event stopped propagation, return the value if ($results->stopped()) { return $results->last(); } // do some work... $params[__RESULT__] = $someComputedContent; $this->getEventManager()->trigger(get.post, $this, $params); } }
Now, lets create a ListenerAggregateInterface that can handle caching for us:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
class CacheListener implements ListenerAggregateInterface { protected $cache; protected $listeners = array(); public function __construct(Cache $cache) { $this->cache = $cache; }
402
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
public function attach(EventManagerInterface $events) { $this->listeners[] = $events->attach(get.pre, array($this, load), 100); $this->listeners[] = $events->attach(get.post, array($this, save), -100); } public function detach(EventManagerInterface $events) { foreach ($this->listeners as $index => $listener) { if ($events->detach($listener)) { unset($this->listeners[$index]); } } } public function load(EventInterface $e) { $id = get_class($e->getTarget()) . - . json_encode($e->getParams()); if (false !== ($content = $this->cache->load($id))) { $e->stopPropagation(true); return $content; } } public function save(EventInterface $e) { $params = $e->getParams(); $content = $params[__RESULT__]; unset($params[__RESULT__]); $id = get_class($e->getTarget()) . - . json_encode($params); $this->cache->save($content, $id); } }
Now, as we call get(), if we have a cached entry, it will be returned immediately; if not, a computed entry will be cached when we complete the method.
95.5. Examples
403
404
CHAPTER 96
Introduction to Zend\Feed
Zend\Feed provides functionality for consuming RSS and Atom feeds. It provides a natural syntax for accessing elements of feeds, feed attributes, and entry attributes. Zend\Feed also has extensive support for modifying feed and entry structure with the same natural syntax, and turning the result back into XML. In the future, this modication support could provide support for the Atom Publishing Protocol. Zend\Feed consists of Zend\Feed\Reader for reading RSS and Atom feeds, Zend\Feed\Writer for writing RSS and Atom feeds, and Zend\Feed\PubSubHubbub for working with Hub servers. Furthermore, both Zend\Feed\Reader and Zend\Feed\Writer support extensions which allows for working with additional data in feeds, not covered in the core API but used in conjunction with RSS and Atom feeds. In the example below, we demonstrate a simple use case of retrieving an RSS feed and saving relevant portions of the feed data to a simple PHP array, which could then be used for printing the data, storing to a database, etc. Note: Be aware Many RSS feeds have different channel and item properties available. The RSS specication provides for many optional properties, so be aware of this when writing code to work with RSS data. Zend\Feed supports all optional properties of the core RSS and Atom specications.
Reading RSS Feed Data with Zend\Feed\Reader // Fetch the latest Slashdot headlines try { $slashdotRss = Zend\Feed\Reader\Reader::import(http://rss.slashdot.org/Slashdot/slashdot); } catch (Zend\Feed\Exception\Reader\RuntimeException $e) { // feed import failed echo "Exception caught importing feed: {$e->getMessage()}\n"; exit; } // Initialize the $channel = array( title link description items channel/feed data array => => => => $slashdotRss->getTitle(), $slashdotRss->getLink(), $slashdotRss->getDescription(), array()
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
405
17 18 19 20 21 22 23 24 25 26
); // Loop over each channel item/entry and store relevant data for each foreach ($slashdotRss as $item) { $channel[items][] = array( title => $item->getTitle(), link => $item->getLink(), description => $item->getDescription() ); }
Your $channel array now contains the basic meta-information for the RSS channel and all items that it contained. The process is identical for Atom feeds since Zend\Feed features a common denominator API, i.e. all getters and setters are the same regardless of feed format.
406
CHAPTER 97
Importing Feeds
Zend\Feed enables developers to retrieve feeds very easily, by using Zend\Feader\Reader. If you know the URI of a feed, simply use the Zend\Feed\Reader\Reader::import() method:
1
$feed = Zend\Feed\Reader\Reader::import(http://feeds.example.com/feedName);
You can also use Zend\Feed\Reader\Reader to fetch the contents of a feed from a le or the contents of a PHP string variable:
1 2 3 4 5
// importing a feed from a text file $feedFromFile = Zend\Feed\Reader\Reader::importFile(feed.xml); // importing a feed from a PHP string variable $feedFromPHP = Zend\Feed\Reader\Reader::importString($feedString);
In each of the examples above, an object of a class that extends Zend\Feed\Reader\Feed\AbstractFeed is returned upon success, depending on the type of the feed. If an RSS feed were retrieved via one of the import methods above, then a Zend\Feed\Reader\Feed\Rss object would be returned. On the other hand, if an Atom feed were imported, then a Zend\Feed\Reader\Feed\Atom object is returned. The import methods will also throw a Zend\Feed\Exception\Reader\RuntimeException object upon failure, such as an unreadable or malformed feed.
assert($feed instanceof Zend\Feed\Reader\Feed\AbstractFeed); // dump the feed to standard output print $feed->saveXml();
407
408
CHAPTER 98
Web pages often contain <link> tags that refer to feeds with content relevant to the particular page. Zend\Feed\Reader\Reader enables you to retrieve all feeds referenced by a web page with one simple method call:
1
$feedLinks = Zend\Feed\Reader\Reader::findFeedLinks(http://www.example.com/news.html);
Here the findFeedLinks() method returns a Zend\Feed\Reader\FeedSet object, that is in turn, a collection of other Zend\Feed\Reader\FeedSet objects, that are referenced by <link> tags on the news.html web page. Zend\Feed\Reader\Reader will throw a Zend\Feed\Reader\Exception\RuntimeException upon failure, such as an HTTP 404 response code or a malformed feed. You can examine all feed links located by iterating across the collection:
1 2 3 4 5 6 7
$rssFeed = null; $feedLinks = Zend\Feed\Reader\Reader::findFeedLinks(http://www.example.com/news.html); foreach ($feedLinks as $link) { if (stripos($link[type], application/rss+xml) !== false) { $rssFeed = $link[href]; break; }
Each Zend\Feed\Reader\FeedSet object will expose the rel, href, type and title properties of detected links for all RSS, Atom or RDF feeds. You can always select the rst encountered link of each type by using a shortcut:
1 2 3
409
410
CHAPTER 99
Reading an RSS feed is as simple as passing the URL of the feed to Zend\Feed\Reader\Readers import method.
1
If any errors occur fetching the feed, a Zend\Feed\Reader\Exception\RuntimeException will be thrown. Once you have a feed object, you can access any of the standard RSS channel properties directly on the object:
1
echo $channel->getTitle();
Properties of the channel can be accessed via getter methods, such as getTitle, getAuthor ... If channel properties have attributes, the getter method will return a key/value pair, where the key is the attribute name, and the value is the attribute value.
1 2
Most commonly youll want to loop through the feed and do something with its entries. Zend\Feed\Reader\Feed\Rss internally converts all entries to a Zend\Feed\Reader\Entry\Rss. Entry properties, similarly to channel properties, can be accessed via getter methods, such as getTitle, getDescription ... An example of printing all titles of articles in a channel is:
1 2 3
If you are not familiar with RSS, here are the standard elements you can expect to be available in an RSS channel and in individual RSS items (entries). Required channel elements: title- The name of the channel link- The URL of the web site corresponding to the channel description- A sentence or several describing the channel Common optional channel elements: 411
pubDate- The publication date of this set of content, in RFC 822 date format language- The language the channel is written in category- One or more (specied by multiple tags) categories the channel belongs to RSS <item> elements do not have any strictly required elements. However, either title or description must be present. Common item elements: title- The title of the item link- The URL of the item description- A synopsis of the item author- The authors email address category- One more categories that the item belongs to comments-URL of comments relating to this item pubDate- The date the item was published, in RFC 822 date format In your code you can always test to see if an element is non-empty with:
1 2 3
Where relevant, Zend\Feed supports a number of common RSS extensions including Dublin Core, Atom (inside RSS) and the Content, Slash, Syndication, Syndication/Thread and several other extensions or modules. For further information, the ofcial RSS 2.0 specication is available at: http://blogs.law.harvard.edu/tech/rss
412
CHAPTER 100
Zend\Feed\Reader\Feed\Atom is used in much the same way as Zend\Feed\Reader\Feed\Rss. It provides the same access to feed-level properties and iteration over entries in the feed. The main difference is in the structure of the Atom protocol itself. Atom is a successor to RSS; it is a more generalized protocol and it is designed to deal more easily with feeds that provide their full content inside the feed, splitting RSS description tag into two elements, summary and content, for that purpose.
Basic Use of an Atom Feed
Read an Atom feed and print the title and summary of each entry:
1 2 3 4 5 6 7
$feed = Zend\Feed\Reader\Reader::import(http://atom.example.com/feed/); echo The feed contains . $feed->count() . entries. . "\n\n"; foreach ($feed as $entry) { echo Title: . $entry->getTitle() . "\n"; echo Description: . $entry->getDescription() . "\n"; echo URL: . $entry->getLink() . "\n\n"; }
In an Atom feed you can expect to nd the following feed properties: title- The feeds title, same as RSSs channel title id- Every feed and entry in Atom has a unique identier link- Feeds can have multiple links, which are distinguished by a type attribute The equivalent to RSSs channel link would be type="text/html". if the link is to an alternate version of the same content thats in the feed, it would have a rel="alternate" attribute. subtitle- The feeds description, equivalent to RSS channel description author- The feeds author, with name and email sub-tags Atom entries commonly have the following properties: id- The entrys unique identier title- The entrys title, same as RSS item titles link- A link to another format or an alternate view of this entry The link property of an atom entry typically has an href attribute.
413
summary- A summary of this entrys content content- The full content of the entry; can be skipped if the feed just contains summaries author- with name and email sub-tags like feeds have published- the date the entry was published, in RFC 3339 format updated- the date the entry was last updated, in RFC 3339 format Where relevant, Zend\Feed supports a number of common RSS extensions including Dublin Core and the Content, Slash, Syndication, Syndication/Thread and several other extensions in common use on blogs. For more information on Atom and plenty of resources, see http://www.atomenabled.org/.
414
CHAPTER 101
Single Atom <entry> elements are also valid by themselves. Usually the URL for an entry is the feeds URL followed by /<entryId>, such as http://atom.example.com/feed/1, using the example URL we used above. This pattern may exist for some web services which use Atom as a container syntax. If you read a single entry, you will have a Zend\Feed\Reader\Entry\Atom object.
Reading a Single-Entry Atom Feed $entry = Zend\Feed\Reader\Reader::import(http://atom.example.com/feed/1); echo Entry title: . $entry->getTitle();
1 2
415
416
CHAPTER 102
102.1 Introduction
As with any data coming from a source that is beyond the developers control, special attention needs to be given to securing, validating and ltering that data. Similar to data input to our application by users, data coming from RSS and Atom feeds should also be considered unsafe and potentially dangerous, as it allows the delivery of HTML and xHTML 1 . Because data validation and ltration is out of Zend\Feeds scope, this task is left for implementation by the developer, by using libraries such as Zend\Escaper for escaping and HTMLPurier for validating and ltering feed data. Escaping and ltering of potentially insecure data is highly recommended before outputting it anywhere in our application or before storing that data in some storage engine (be it a simple le, a database...).
// Setting HTMLPurifiers options $options = array( // Allow only paragraph tags // and anchor tags wit the href attribute array( HTML.Allowed, p,a[href] ), // Format end output with Tidy array( Output.TidyFormat, true
1
http://tools.ietf.org/html/rfc4287#section-8.1
417
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
), // Assume XHTML 1.0 Strict Doctype array( HTML.Doctype, XHTML 1.0 Strict ), // Disable cache, but see note after the example array( Cache.DefinitionImpl, null ) ); // Configuring HTMLPurifier $config = HTMLPurifier_Config::createDefault(); foreach ($options as $option) { $config->set($option[0], $option[1]); } // Creating a HTMLPurifier with its config $purifier = new HTMLPurifier($config); // Fetch the RSS try { $rss = Zend\Feed\Reader\Reader::import(http://www.planet-php.net/rss/); } catch (Zend\Feed\Exception\Reader\RuntimeException $e) { // feed import failed echo "Exception caught importing feed: {$e->getMessage()}\n"; exit; } // Initialize the channel data array // See that were cleaning the description with HTMLPurifier $channel = array( title => $rss->getTitle(), link => $rss->getLink(), description => $purifier->purify($rss->getDescription()), items => array() ); // Loop over each channel item and store relevant data // See that were cleaning the descriptions with HTMLPurifier foreach ($rss as $item) { $channel[items][] = array( title => $item->getTitle(), link => $item->getLink(), description => $purifier->purify($item->getDescription()) ); }
Note: HTMLPurier is using the PHP Tidy extension to clean and repair the nal output. If this extension is not available, it will silently fail but its availability has no impact on the librarys security.
Note: For the sake of this example, the HTMLPuriers cache is disabled, but it is recommended to congure caching and use its standalone include le as it can improve the performance of HTMLPurier substantially.
418
try { $rss = Zend\Feed\Reader\Reader::import(http://www.planet-php.net/rss/); } catch (Zend\Feed\Exception\Reader\RuntimeException $e) { // feed import failed echo "Exception caught importing feed: {$e->getMessage()}\n"; exit; } // Validate all URIs $linkValidator = new Zend\Validator\Uri; $link = null; if ($linkValidator->isValid($rss->getLink())) { $link = $rss->getLink(); } // Escaper used for escaping data $escaper = new Zend\Escaper\Escaper(utf-8); // Initialize the $channel = array( title link description items ); channel data array => => => => $escaper->escapeHtml($rss->getTitle()), $escaper->escapeHtml($link), $escaper->escapeHtml($rss->getDescription()), array()
// Loop over each channel item and store relevant data foreach ($rss as $item) { $link = null; if ($linkValidator->isValid($rss->getLink())) { $link = $item->getLink(); } $channel[items][] = array( title => $escaper->escapeHtml($item->getTitle()), link => $escaper->escapeHtml($link), description => $escaper->escapeHtml($item->getDescription()) ); }
The feed data is now safe for output to HTML templates. You can, of course, skip escaping when simply storing the data persistently but remember to escape it on output later! Of course, these are just basic examples, and cannot cover all possible scenarios that you, as a developer, can, and most likely will, encounter. Your responsibility is to learn what libraries and tools are at your disposal, and when and how to use them to secure your web applications.
419
420
CHAPTER 103
Zend\Feed\Reader\Reader
103.1 Introduction
Zend\Feed\Reader\Reader is a component used to consume RSS and Atom feeds of any version, including RDF /RSS 1.0, RSS 2.0, Atom 0.3 and Atom 1.0. The API for retrieving feed data is deliberately simple since Zend\Feed\Reader is capable of searching any feed of any type for the information requested through the API. If the typical elements containing this information are not present, it will adapt and fall back on a variety of alternative elements instead. This ability to choose from alternatives removes the need for users to create their own abstraction layer on top of the component to make it useful or have any in-depth knowledge of the underlying standards, current alternatives, and namespaced extensions. Internally, Zend\Feed\Reader\Reader works almost entirely on the basis of making XPath queries against the feed XMLs Document Object Model. This singular approach to parsing is consistent and the component offers a plugin system to add to the Feed and Entry level API by writing Extensions on a similar basis. Performance is assisted in three ways. First of all, Zend\Feed\Reader\Reader supports caching using Zend\Cache to maintain a copy of the original feed XML. This allows you to skip network requests for a feed URI if the cache is valid. Second, the Feed and Entry level API is backed by an internal cache (non-persistent) so repeat API calls for the same feed will avoid additional DOM or XPath use. Thirdly, importing feeds from a URI can take advantage of HTTP Conditional GET requests which allow servers to issue an empty 304 response when the requested feed has not changed since the last time you requested it. In the nal case, an instance of Zend\Cache will hold the last received feed along with the ETag and Last-Modied header values sent in the HTTP response. Zend\Feed\Reader\Reader is not capable of constructing feeds and delegates this responsibility to Zend\Feed\Writer\Writer.
421
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
$feed = Zend\Feed\Reader\Reader::import(http://www.planet-php.net/rdf/); $data = array( title => $feed->getTitle(), link => $feed->getLink(), dateModified => $feed->getDateModified(), description => $feed->getDescription(), language => $feed->getLanguage(), entries => array(), ); foreach ($feed as $entry) { $edata = array( title => $entry->getTitle(), description => $entry->getDescription(), dateModified => $entry->getDateModified(), authors => $entry->getAuthors(), link => $entry->getLink(), content => $entry->getContent() ); $data[entries][] = $edata; }
The example above demonstrates Zend\Feed\Reader\Readers API, and it also demonstrates some of its internal operation. In reality, the RDF feed selected does not have any native date or author elements, however it does utilise the Dublin Core 1.1 module which offers namespaced creator and date elements. Zend\Feed\Reader\Reader falls back on these and similar options if no relevant native elements exist. If it absolutely cannot nd an alternative it will return NULL, indicating the information could not be found in the feed. You should note that classes implementing Zend\Feed\Reader\Feed\AbstractFeed also implement the SPL Iterator and Countable interfaces. Feeds can also be imported from strings or les.
1 2 3 4 5 6 7 8
// from a URI $feed = Zend\Feed\Reader\Reader::import(http://www.planet-php.net/rdf/); // from a String $feed = Zend\Feed\Reader\Reader::importString($feedXmlString); // from a file $feed = Zend\Feed\Reader\Reader::importFile(./feed.xml);
422
getXpath() returns the DOMXPath object for the current feed (even if called from an Entry object) with the namespaces of the current feed type and all loaded Extensions pre-registered. getXpathPrefix() returns the query prex for the current object (i.e. the Feed or current Entry) which includes the correct XPath query path for that specic Feed or Entry. Heres an example where a feed might include an RSS Extension not supported by Zend\Feed\Reader\Reader out of the box. Notably, you could write and register an Extension (covered later) to do this, but thats not always warranted for a quick check. You must register any new namespaces on the DOMXPath object before use unless they are registered by Zend\Feed\Reader or an Extension beforehand.
1 2 3 4 5 6 7
$feed = Zend\Feed\Reader\Reader::import(http://www.planet-php.net/rdf/); $xpathPrefix = $feed->getXpathPrefix(); $xpath = $feed->getXpath(); $xpath->registerNamespace(admin, http://webns.net/mvcb/); $reportErrorsTo = $xpath->evaluate(string( . $xpathPrefix . /admin:errorReportsTo));
Warning: If you register an already registered namespace with a different prex name to that used internally by Zend\Feed\Reader\Reader, it will break the internal operation of this component.
423
4 5 6
In the example above, with HTTP Conditional GET requests enabled, the response header values for ETag and LastModied will be cached along with the feed. For the the caches lifetime, feeds will only be updated on the cache if a non-304 response is received containing a valid RSS or Atom XML document. If you intend on managing request headers from outside Zend\Feed\Reader\Reader, you can set the relevant If-None-Matches and If-Modied-Since request headers via the URI import method.
1 2 3 4 5
$lastEtagReceived = 5e6cefe7df5a7e95c8b1ba1a2ccaff3d; $lastModifiedDateReceived = Wed, 08 Jul 2009 13:37:22 GMT; $feed = Zend\Feed\Reader\Reader::import( $uri, $lastEtagReceived, $lastModifiedDateReceived );
$links = Zend\Feed\Reader\Reader::findFeedLinks(http://www.planet-php.net); if (isset($links->rdf)) { echo $links->rdf, "\n"; // http://www.planet-php.org/rdf/ } if (isset($links->rss)) { echo $links->rss, "\n"; // http://www.planet-php.org/rss/ } if (isset($links->atom)) { echo $links->atom, "\n"; // http://www.planet-php.org/atom/ }
Based on these links, you can then import from whichever source you wish in the usual manner. This quick method only gives you one link for each feed type, but websites may indicate many links of any type. Perhaps its a news site with a RSS feed for each news category. You can iterate over all links using the ArrayObjects iterator.
1 2 3 4 5
424
$feed = Zend\Feed\Reader\Reader::import(http://www.example.com/atom.xml); $categories = $feed->getCategories(); $labels = array(); foreach ($categories as $cat) { $labels[] = $cat[label] }
Its a contrived example, but the point is that the labels are tied up with other information. However, the container class allows you to access the most relevant data as a simple array using the getValues() method. The concept of most relevant is obviously a judgement call. For categories it means the category labels (not the terms or schemes) while for authors it would be the authors names (not their email addresses or URI s). The simple array is at (just values) and passed through array_unique() to remove duplication.
1 2 3
The above example shows how to extract only labels and nothing else thus giving simple access to the category labels without any additional work to extract that data by itself.
ambiguities and does not detail the correct treatment of all elements. As a result, this component rigorously applies the RSS 2.0.11 Specication published by the RSS Advisory Board and its accompanying RSS Best Practices Prole. No other interpretation of RSS 2.0 will be supported though exceptions may be allowed where it does not directly prevent the application of the two documents mentioned above. Of course, we dont live in an ideal world so there may be times the API just does not cover what youre looking for. To assist you, Zend\Feed\Reader\Reader offers a plugin system which allows you to write Extensions to expand the core API and cover any additional data you are trying to extract from feeds. If writing another Extension is too much trouble, you can simply grab the underlying DOM or XPath objects and do it by hand in your application. Of course, we really do encourage writing an Extension simply to make it more portable and reusable, and useful Extensions may be proposed to the Framework for formal addition. Heres a summary of the Core API for Feeds. You should note it comprises not only the basic RSS and Atom standards, but also accounts for a number of included Extensions bundled with Zend\Feed\Reader\Reader. The naming of these Extension sourced methods remain fairly generic - all Extension methods operate at the same level as the Core API though we do allow you to retrieve any specic Extension object separately if required.
426
Table 103.1: Feed Level API Methods getId() getTitle() getDescription() getLink() Returns a unique ID associated with this feed Returns the title of the feed Returns the text description of the feed. Returns a URI to the HTML website containing the same or similar information as this feed (i.e. if the feed is from a blog, it should provide the blogs URI where the HTML version of the entries can be read). Returns the URI of this feed, which may be the same as the URI used to import the feed. There are important cases where the feed link may differ because the source URI is being updated and is intended to be removed in the future. Returns an object of type ZendFeedReaderCollectionAuthor which is an ArrayObject whose elements are each simple arrays containing any combination of the keys name, email and uri. Where irrelevant to the source data, some of these keys may be omitted. Returns either the rst author known, or with the optional $index parameter any specic index on the array of Authors as described above (returning NULL if an invalid index). Returns the date on which this feed was created. Generally only applicable to Atom where it represents the date the resource described by an Atom 1.0 document was created. The returned date will be a DateTime object. Returns the date on which this feed was last modied. The returned date will be a DateTime object. Returns the date on which this feed was last built. The returned date will be a DateTime object. This is only supported by RSS - Atom feeds will always return NULL. Returns the language of the feed (if dened) or simply the language noted in the XML document. Returns the generator of the feed, e.g. the software which generated it. This may differ between RSS and Atom since Atom denes a different notation. Returns any copyright notice associated with the feed. Returns an array of all Hub Server URI endpoints which are advertised by the feed for use with the Pubsubhubbub Protocol, allowing subscriptions to the feed for real-time updates. Returns a ZendFeedReaderCollectionCategory object containing the details of any categories associated with the overall feed. The supported elds include term (the machine readable category name), scheme (the categorisation scheme and domain for this category), and label (a HTML decoded human readable category name). Where any of the three elds are absent from the eld, they are either set to the closest available alternative or, in the case of scheme, set to NULL. Returns an array containing data relating to any feed image or logo, or NULL if no image found. The resulting array may contain the following keys: uri, link, title, description, height, and width. Atom logos only contain a URI so the remaining metadata is drawn from RSS feeds only.
getFeedLink()
getAuthors()
getAuthor(integer $index = 0) getDateCreated() getDateModied() getLastBuildDate() getLanguage() getGenerator() getCopyright() getHubs() getCategories()
getImage()
Given the variety of feeds in the wild, some of these methods will undoubtedly return NULL indicating the relevant information couldnt be located. Where possible, Zend\Feed\Reader\Reader will fall back on alternative elements during its search. For example, searching an RSS feed for a modication date is more complicated than it looks. RSS 2.0 feeds should include a <lastBuildDate> tag and (or) a <pubDate> element. But what if it doesnt, maybe this is an RSS 1.0 feed? Perhaps it instead has an <atom:updated> element with identical information (Atom may be used to supplement RSSs syntax)? Failing that, we could simply look at the entries, pick the most recent, and use its <pubDate> element. Assuming it exists... Many feeds also use Dublin Core 1.0 or 1.1 <dc:date> elements for feeds and entries. Or we could nd Atom lurking again. The point is, Zend\Feed\Reader\Reader was designed to know this. When you ask for the modication date (or anything else), it will run off and search for all these alternatives until it either gives up and returns NULL, or nds an alternative that should have the right answer.
427
In addition to the above methods, all Feed objects implement methods for retrieving the DOM and XPath objects for the current feeds as described earlier. Feed objects also implement the SPL Iterator and Countable interfaces. The extended API is summarised below.
getDateModied() getContent()
getEnclosure()
The extended API for entries is identical to that for feeds with the exception of the Iterator methods which are not needed here.
428
Caution: There is often confusion over the concepts of modied and created dates. In Atom, these are two clearly dened concepts (so knock yourself out) but in RSS they are vague. RSS 2.0 denes a single <pubDate> element which typically refers to the date this entry was published, i.e. a creation date of sorts. This is not always the case, and it may change with updates or not. As a result, if you really want to check whether an entry has changed, dont rely on the results of getDateModified(). Instead, consider tracking the MD5 hash of three other elements concatenated, e.g. using getTitle(), getDescription() and getContent(). If the entry was truly updated, this hash computation will give a different result than previously saved hashes for the same entry. This is obviously content oriented, and will not assist in detecting changes to other relevant elements. Atom feeds should not require such steps. Further muddying the waters, dates in feeds may follow different standards. Atom and Dublin Core dates should follow ISO 8601, and RSS dates should follow RFC 822 or RFC 2822 which is also common. Date methods will throw an exception if DateTime cannot load the date string using one of the above standards, or the PHP recognised possibilities for RSS dates. Warning: The values returned from these methods are not validated. This means users must perform validation on all retrieved data including the ltering of any HTML such as from getContent() before it is output from your application. Remember that most feeds come from external sources, and therefore the default assumption should be that they cannot be trusted.
The Core Extensions are somewhat special since they are extremely common and multi-faceted. For example, we have a Core Extension for Atom. Atom is implemented as an Extension (not just a base class) because it doubles as a valid
429
RSS module - you can insert Atom elements into RSS feeds. Ive even seen RDF feeds which use a lot of Atom in place of more common Extensions like Dublin Core. Table 103.4: Non-Core Extensions (must register manually) Syndication CreativeCommons Implements Syndication 1.0 support for RSS feeds A RSS module that adds an element at the <channel> or <item> level that species which Creative Commons license applies.
The additional non-Core Extensions are offered but not registered to Zend\Feed\Reader\Reader by default. If you want to use them, youll need to tell Zend\Feed\Reader\Reader to load them in advance of importing a feed. Additional non-Core Extensions will be included in future iterations of the component. Registering an Extension with Zend\Feed\Reader\Reader, so it is loaded and its API is available to Feed and Entry objects, is a simple affair using the Zend\Feed\Reader\ExtensionManager. Here we register the optional Syndication Extension, and discover that it can be directly called from the Entry level API without any effort. Note that Extension names are case sensitive and use camel casing for multiple terms.
1 2 3
In the simple example above, we checked how frequently a feed is being updated using the getUpdatePeriod() method. Since its not part of Zend\Feed\Reader\Readers core API, it could only be a method supported by the newly registered Syndication Extension. As you can also notice, the new methods from Extensions are accessible from the main API using PHPs magic methods. As an alternative, you can also directly access any Extension object for a similar result as seen below.
1 2 3 4
A snippet of RSS containing this extension in practice could be something similar to:
1 2 3 4 5 6
<?xml version="1.0" encoding="utf-8" ?> <rss version="2.0" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:jungle="http://example.com/junglebooks/rss/module/1.0/"> <channel> <title>Jungle Books Customer Reviews</title>
430
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
<link>http://example.com/junglebooks</link> <description>Many book reviews!</description> <pubDate>Fri, 26 Jun 2009 19:15:10 GMT</pubDate> <jungle:dayPopular> http://example.com/junglebooks/book/938 </jungle:dayPopular> <item> <title>Review Of Flatland: A Romance of Many Dimensions</title> <link>http://example.com/junglebooks/review/987</link> <author>Confused Physics Student</author> <content:encoded> A romantic square?! </content:encoded> <pubDate>Thu, 25 Jun 2009 20:03:28 -0700</pubDate> <jungle:isbn>048627263X</jungle:isbn> </item> </channel> </rss>
Implementing this new ISBN element as a simple entry level extension would require the following class (using your own class namespace outside of Zend).
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
class My\FeedReader\Extension\JungleBooks\Entry extends Zend\Feed\Reader\Extension\AbstractEntry { public function getIsbn() { if (isset($this->data[isbn])) { return $this->data[isbn]; } $isbn = $this->xpath->evaluate( string( . $this->getXpathPrefix() . /jungle:isbn) ); if (!$isbn) { $isbn = null; } $this->data[isbn] = $isbn; return $this->data[isbn]; } protected function registerNamespaces() { $this->xpath->registerNamespace( jungle, http://example.com/junglebooks/rss/module/1.0/ ); } }
This extension is easy enough to follow. It creates a new method getIsbn() which runs an XPath query on the current entry to extract the ISBN number enclosed by the <jungle:isbn> element. It can optionally store this to the internal non-persistent cache (no need to keep querying the DOM if its called again on the same entry). The value is returned to the caller. At the end we have a protected method (its abstract so it must exist) which registers the Jungle Books namespace for their custom RSS module. While we call this an RSS module, theres nothing to prevent the same element being used in Atom feeds - and all Extensions which use the prex provided by getXpathPrefix() are actually neutral and work on RSS or Atom feeds with no extra code. Since this Extension is stored outside of Zend Framework, youll need to register the path prex for your Extensions so Zend\Loader\PluginLoader can nd them. After that, its merely a matter of registering the Extension, if
431
if (!Zend\Feed\Reader\Reader::isRegistered(JungleBooks)) { $extensions = Zend\Feed\Reader\Reader::getExtensionManager(); $extensions->setInvokableClass(JungleBooksEntry, My\FeedReader\Extension\JungleBooks\Entry); Zend\Feed\Reader\Reader::registerExtension(JungleBooks); } $feed = Zend\Feed\Reader\Reader::import(http://example.com/junglebooks/rss); // ISBN for whatever book the first entry in the feed was concerned with $firstIsbn = $feed->current()->getIsbn();
Writing a feed level Extension is not much different. The example feed from earlier included an unmentioned <jungle:dayPopular> element which Jungle Books have added to their standard to include a link to the days most popular book (in terms of visitor trafc). Heres an Extension which adds a getDaysPopularBookLink() method to the feel level API.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
class My\FeedReader\Extension\JungleBooks\Feed extends Zend\Feed\Reader\Extension\AbstractFeed { public function getDaysPopularBookLink() { if (isset($this->data[dayPopular])) { return $this->data[dayPopular]; } $dayPopular = $this->xpath->evaluate( string( . $this->getXpathPrefix() . /jungle:dayPopular) ); if (!$dayPopular) { $dayPopular = null; } $this->data[dayPopular] = $dayPopular; return $this->data[dayPopular]; } protected function registerNamespaces() { $this->xpath->registerNamespace( jungle, http://example.com/junglebooks/rss/module/1.0/ ); } }
Lets repeat the last example using a custom Extension to show the method being used.
1 2 3 4 5 6 7 8 9
if (!Zend\Feed\Reader\Reader::isRegistered(JungleBooks)) { $extensions = Zend\Feed\Reader\Reader::getExtensionManager(); $extensions->setInvokableClass(JungleBooksFeed, My\FeedReader\Extension\JungleBooks\Feed); Zend\Feed\Reader\Reader::registerExtension(JungleBooks); } $feed = Zend\Feed\Reader\Reader::import(http://example.com/junglebooks/rss); // URI to the information page of the days most popular book with visitors $daysPopularBookLink = $feed->getDaysPopularBookLink();
Going through these examples, youll note that we dont register feed and entry Extensions separately. Extensions within the same standard may or may not include both a feed and entry class, so Zend\Feed\Reader\Reader only requires you to register the overall parent name, e.g. JungleBooks, DublinCore, Slash. Internally, it can check at what level Extensions exist and load them up if found. In our case, we have a full set of Extensions now:
432
433
434
CHAPTER 104
Zend\Feed\Writer\Writer
104.1 Introduction
Zend\Feed\Writer\Writer is the sibling component to Zend\Feed\Reader\Reader responsible for generating feeds for output. It supports the Atom 1.0 specication (RFC 4287) and RSS 2.0 as specied by the RSS Advisory Board (RSS 2.0.11). It does not deviate from these standards. It does, however, offer a simple Extension system which allows for any extension and module for either of these two specications to be implemented if they are not provided out of the box. In many ways, Zend\Feed\Writer\Writer is the inverse of Zend\Feed\Reader\Reader. Where Zend\Feed\Reader\Reader focuses on providing an easy to use architecture fronted by getter methods, Zend\Feed\Writer\Writer is fronted by similarly named setters or mutators. This ensures the API wont pose a learning curve to anyone familiar with Zend\Feed\Reader\Reader. As a result of this design, the rest may even be obvious. Behind the scenes, data set on any Zend\Feed\Writer\Writer Data Container object is translated at render time onto a DOMDocument object using the necessary feed elements. For each supported feed type there is both an Atom 1.0 and RSS 2.0 renderer. Using a DOMDocument class rather than a templating solution has numerous advantages, the most obvious being the ability to export the DOMDocument for additional processing and relying on PHP DOM for correct and valid rendering.
104.2 Architecture
The architecture of Zend\Feed\Writer\Writer is very simple. It has two core sets of classes: data containers and renderers. The containers include the Zend\Feed\Writer\Feed and Zend\Feed\Writer\Entry classes. The Entry classes can be attached to any Feed class. The sole purpose of these containers is to collect data about the feed to generate using a simple interface of setter methods. These methods perform some data validity testing. For example, it will validate any passed URI s, dates, etc. These checks are not tied to any of the feed standards denitions. The container objects also contain methods to allow for fast rendering and export of the nal feed, and these can be reused at will. In addition to the main data container classes, there are two additional Atom 2.0 specic classes. Zend\Feed\Writer\Source and Zend\Feed\Writer\Deleted. The former implements Atom 2.0 source elements which carry source feed metadata for a specic entry within an aggregate feed (i.e. the current feed is not
435
the entrys original source). The latter implements the Atom Tombstones RFC allowing feeds to carry references to entries which have been deleted. While there are two main data container types, there are four renderers - two matching container renderers per supported feed type. Each renderer accepts a container, and based on its content attempts to generate valid feed markup. If the renderer is unable to generate valid feed markup, perhaps due to the container missing an obligatory data point, it will report this by throwing an Exception. While it is possible to ignore Exceptions, this removes the default safeguard of ensuring you have sufcient data set to render a wholly valid feed. To explain this more clearly, you may construct a set of data containers for a feed where there is a Feed container, into which has been added some Entry containers and a Deleted container. This forms a data hierarchy resembling a normal feed. When rendering is performed, this hierarchy has its pieces passed to relevant renderers and the partial feeds (all DOMDocuments) are then pieced together to create a complete feed. In the case of Source or Deleted (Tomestone) containers, these are rendered only for Atom 2.0 and ignored for RSS. Due to the system being divided between data containers and renderers, it can make Extensions somewhat interesting. A typical Extension offering namespaced feed and entry level elements, must itself reect the exact same architecture, i.e. offer feed and entry level data containers, and matching renderers. There is, fortunately, no complex integration work required since all Extension classes are simply registered and automatically used by the core classes. Well meet Extensions in more detail at the end of this section.
/** * Create the parent feed */ $feed = new Zend\Feed\Writer\Feed; $feed->setTitle(Paddy\s Blog); $feed->setLink(http://www.example.com); $feed->setFeedLink(http://www.example.com/atom, atom); $feed->addAuthor(array( name => Paddy, email => paddy@example.com, uri => http://www.example.com, )); $feed->setDateModified(time()); $feed->addHub(http://pubsubhubbub.appspot.com/); /** * Add one or more entries. Note that entries must * be manually added once created. */ $entry = $feed->createEntry(); $entry->setTitle(All Your Base Are Belong To Us); $entry->setLink(http://www.example.com/all-your-base-are-belong-to-us); $entry->addAuthor(array( name => Paddy, email => paddy@example.com, uri => http://www.example.com, )); $entry->setDateModified(time()); $entry->setDateCreated(time()); $entry->setDescription(Exposing the difficultly of porting games to English.);
436
31 32 33 34 35 36 37 38 39 40
$entry->setContent( I am not writing the article. The example is long enough as is ;). ); $feed->addEntry($entry); /** * Render the resulting feed to Atom 1.0 and assign to $out. * You can substitute "atom" with "rss" to generate an RSS 2.0 feed. */ $out = $feed->export(atom);
<?xml version="1.0" encoding="utf-8"?> <feed xmlns="http://www.w3.org/2005/Atom"> <title type="text">Paddys Blog</title> <subtitle type="text">Writing about PC Games since 176 BC.</subtitle> <updated>2009-12-14T20:28:18+00:00</updated> <generator uri="http://framework.zend.com" version="1.10.0alpha"> Zend\Feed\Writer </generator> <link rel="alternate" type="text/html" href="http://www.example.com"/> <link rel="self" type="application/atom+xml" href="http://www.example.com/atom"/> <id>http://www.example.com</id> <author> <name>Paddy</name> <email>paddy@example.com</email> <uri>http://www.example.com</uri> </author> <link rel="hub" href="http://pubsubhubbub.appspot.com/"/> <entry> <title type="html"><![CDATA[All Your Base Are Belong To Us]]></title> <summary type="html"> <![CDATA[Exposing the difficultly of porting games to English.]]> </summary> <published>2009-12-14T20:28:18+00:00</published> <updated>2009-12-14T20:28:18+00:00</updated> <link rel="alternate" type="text/html" href="http://www.example.com/all-your-base-are-belong-to-us"/> <id>http://www.example.com/all-your-base-are-belong-to-us</id> <author> <name>Paddy</name> <email>paddy@example.com</email> <uri>http://www.example.com</uri> </author> <content type="html"> <![CDATA[I am not writing the article. The example is long enough as is ;).]]> </content> </entry> </feed>
This is a perfectly valid Atom 1.0 example. It should be noted that omitting an obligatory point of data, such as a title, will trigger an Exception when rendering as Atom 1.0. This will differ for RSS 2.0 since a title may be omitted so long as a description is present. This gives rise to Exceptions that differ between the two standards depending on the
437
renderer in use. By design, Zend\Feed\Writer\Writer will not render an invalid feed for either standard unless the end-user deliberately elects to ignore all Exceptions. This built in safeguard was added to ensure users without in-depth knowledge of the relevant specications have a bit less to worry about.
438
Table 104.1: Feed Level API Methods setId() Set a unique ID associated with this feed. For Atom 1.0 this is an atom:id element, whereas for RSS 2.0 it is added as a guid element. These are optional so long as a link is added, i.e. the link is set as the ID. Set the title of the feed. Set the text description of the feed.
Set a URI to the HTML website containing the same or similar information as this feed (i.e. if the feed is from a blog, it should provide the blogs URI where the HTML version of the entries can be read). setAdd a link to an XML feed, whether the feed being generated or an alternate URI pointing to the FeedLinks() same feed but in a different format. At a minimum, it is recommended to include a link to the feed being generated so it has an identiable nal URI allowing a client to track its location changes without necessitating constant redirects. The parameter is an array of arrays, where each sub-array contains the keys type and uri. The type should be one of atom, rss, or rdf. addAuSets the data for authors. The parameter is an array of arrays where each sub-array may contain the thors() keys name, email and uri. The uri value is only applicable for Atom feeds since RSS contains no facility to show it. For RSS 2.0, rendering will create two elements - an author element containing the email reference with the name in brackets, and a Dublin Core creator element only containing the name. addAuSets the data for a single author following the same array format as described above for a single thor() sub-array. setDateSets the date on which this feed was created. Generally only applicable to Atom where it represents Created() the date the resource described by an Atom 1.0 document was created. The expected parameter may be a UNIX timestamp or a DateTime object. setDateSets the date on which this feed was last modied. The expected parameter may be a UNIX Modied() timestamp or a DateTime object. setLastSets the date on which this feed was last build. The expected parameter may be a UNIX timestamp Buildor a DateTime object. This will only be rendered for RSS 2.0 feeds and is automatically rendered as Date() the current date by default when not explicitly set. setSets the language of the feed. This will be omitted unless set. Language() setGenera- Allows the setting of a generator. The parameter should be an array containing the keys name, tor() version and uri. If omitted a default generator will be added referencing ZendFeedWriter, the current Zend Framework version and the Frameworks URI. setCopySets a copyright notice associated with the feed. right() addHubs() Accepts an array of Pubsubhubbub Hub Endpoints to be rendered in the feed as Atom links so that PuSH Subscribers may subscribe to your feed. Note that you must implement a Pubsubhubbub Publisher in order for real-time updates to be enabled. A Publisher may be implemented using ZendFeedPubsubhubbubPublisher. The method addHub() allows adding a single hub at a time. addCateAccepts an array of categories for rendering, where each element is itself an array whose possible gories() keys include term, label and scheme. The term is a typically a category name suitable for inclusion in a URI. The label may be a human readable category name supporting special characters (it is HTML encoded during rendering) and is a required key. The scheme (called the domain in RSS) is optional but must be a valid URI. The method addCategory() allows adding a single category at a time. setImage() Accepts an array of image metadata for an RSS image or Atom logo. Atom 1.0 only requires a URI. RSS 2.0 requires a URI, HTML link, and an image title. RSS 2.0 optionally may send a width, height and image description. The array parameter may contain these using the keys: uri, link, title, description, height and width. The RSS 2.0 HTML link should point to the feed sources HTML page. createEnReturns a new instance of ZendFeedWriterEntry. This is the Entry level data container. New entries try() are not automatically assigned to the current feed, so you must explicitly call addEntry() to add the entry forData rendering. 104.4. Setting Feed Points 439 addEntry() Adds an instance of ZendFeedWriterEntry to the current feed container for rendering. createReturns a new instance of ZendFeedWriterDeleted. This is the Atom 2.0 Tombstone level data Tombcontainer. New entries are not automatically assigned to the current feed, so you must explicitly call
Note: In addition to these setters, there are also matching getters to retrieve data from the Entry data container. For example, setImage() is matched with a getImage() method.
440
Table 104.2: Entry Level API Methods setId() Set a unique ID associated with this entry. For Atom 1.0 this is an atom:id element, whereas for RSS 2.0 it is added as a guid element. These are optional so long as a link is added, i.e. the link is set as the ID. Set the title of the entry. Set the text description of the entry. Set the content of the entry. Set a URI to the HTML website containing the same or similar information as this entry (i.e. if the feed is from a blog, it should provide the blog articles URI where the HTML version of the entry can be read). Add a link to an XML feed, whether the feed being generated or an alternate URI pointing to the same feed but in a different format. At a minimum, it is recommended to include a link to the feed being generated so it has an identiable nal URI allowing a client to track its location changes without necessitating constant redirects. The parameter is an array of arrays, where each sub-array contains the keys type and uri. The type should be one of atom, rss, or rdf. If a type is omitted, it defaults to the type used when rendering the feed. Sets the data for authors. The parameter is an array of arrays where each sub-array may contain the keys name, email and uri. The uri value is only applicable for Atom feeds since RSS contains no facility to show it. For RSS 2.0, rendering will create two elements - an author element containing the email reference with the name in brackets, and a Dublin Core creator element only containing the name. Sets the data for a single author following the same format as described above for a single sub-array. Sets the date on which this feed was created. Generally only applicable to Atom where it represents the date the resource described by an Atom 1.0 document was created. The expected parameter may be a UNIX timestamp or a DateTime object. If omitted, the date used will be the current date and time. Sets the date on which this feed was last modied. The expected parameter may be a UNIX timestamp or a DateTime object. If omitted, the date used will be the current date and time. Sets a copyright notice associated with the feed. Accepts an array of categories for rendering, where each element is itself an array whose possible keys include term, label and scheme. The term is a typically a category name suitable for inclusion in a URI. The label may be a human readable category name supporting special characters (it is encoded during rendering) and is a required key. The scheme (called the domain in RSS) is optional but must be a valid URI. Sets the number of comments associated with this entry. Rendering differs between RSS and Atom 2.0 depending on the element or attribute needed. Seta a link to a HTML page containing comments associated with this entry. Sets a link to a XML feed containing comments associated with this entry. The parameter is an array containing the keys uri and type, where the type is one of rdf, rss or atom. Same as setCommentFeedLink() except it accepts an array of arrays, where each subarray contains the expected parameters of setCommentFeedLink(). Sets the encoding of entry text. This will default to UTF-8 which is the preferred encoding.
setFeedLinks()
addAuthors()
addAuthor() setDateCreated()
Note: In addition to these setters, there are also matching getters to retrieve data from the Entry data container.
441
442
CHAPTER 105
Zend\Feed\PubSubHubbub
Zend\Feed\PubSubHubbub is an implementation of the PubSubHubbub Core 0.2 Specication (Working Draft). It offers implementations of a Pubsubhubbub Publisher and Subscriber suited to Zend Framework and other PHP applications.
105.2 Architecture
Zend\Feed\PubSubHubbub implements two sides of the Pubsubhubbub 0.2 Specication: a Publisher and a Subscriber. It does not currently implement a Hub Server though this is in progress for a future Zend Framework release.
443
A Publisher is responsible for notifying all supported Hubs (many can be supported to add redundancy to the system) of any updates to its feeds, whether they be Atom or RSS based. This is achieved by pinging the supported Hub Servers with the URL of the updated feed. In Pubsubhubbub terminology, any updatable resource capable of being subscribed to is referred to as a Topic. Once a ping is received, the Hub will request the updated feed, process it for updated items, and forward all updates to all Subscribers subscribed to that feed. A Subscriber is any party or application which subscribes to one or more Hubs to receive updates from a Topic hosted by a Publisher. The Subscriber never directly communicates with the Publisher since the Hub acts as an intermediary, accepting subscriptions and sending updates to subscribed Subscribers. The Subscriber therefore communicates only with the Hub, either to subscribe or unsubscribe to Topics, or when it receives updates from the Hub. This communication design (Fat Pings) effectively removes the possibility of a Thundering Herd issue. This occurs in a pubsub system where the Hub merely informs Subscribers that an update is available, prompting all Subscribers to immediately retrieve the feed from the Publisher giving rise to a trafc spike. In Pubsubhubbub, the Hub distributes the actual update in a Fat Ping so the Publisher is not subjected to any trafc spike. Zend\Feed\PubSubHubbub implements Pubsubhubbub Publishers and Subscribers with the classes Zend\Feed\PubSubHubbub\Publisher and Zend\Feed\PubSubHubbub\Subscriber. In addition, the Subscriber implementation may handle any feed updates forwarded from a Hub by using Zend\Feed\PubSubHubbub\Subscriber\Callback. These classes, their use cases, and API s are covered in subsequent sections.
105.3 Zend\Feed\PubSubHubbub\Publisher
In Pubsubhubbub, the Publisher is the party who publishes a live feed and frequently updates it with new content. This may be a blog, an aggregator, or even a web service with a public feed based API. In order for these updates to be pushed to Subscribers, the Publisher must notify all of its supported Hubs that an update has occurred using a simple HTTP POST request containing the URI or the updated Topic (i.e the updated RSS or Atom feed). The Hub will conrm receipt of the notication, fetch the updated feed, and forward any updates to any Subscribers who have subscribed to that Hub for updates from the relevant feed. By design, this means the Publisher has very little to do except send these Hub pings whenever its feeds change. As a result, the Publisher implementation is extremely simple to use and requires very little work to setup and use when feeds are updated. Zend\Feed\PubSubHubbub\Publisher implements a full Pubsubhubbub Publisher. Its setup for use is also simple, requiring mainly that it is congured with the URI endpoint for all Hubs to be notied of updates, and the URI s of all Topics to be included in the notications. The following example shows a Publisher notifying a collection of Hubs about updates to a pair of local RSS and Atom feeds. The class retains a collection of errors which include the Hub URLs, so the notication can be re-attempted later and/or logged if any notications happen to fail. Each resulting error array also includes a response key containing the related HTTP response object. In the event of any errors, it is strongly recommended to attempt the operation for failed Hub Endpoints at least once more at a future time. This may require the use of either a scheduled task for this purpose or a job queue though such extra steps are optional.
1 2 3 4 5 6 7 8 9 10 11
$publisher = new Zend\Feed\PubSubHubbub\Publisher; $publisher->addHubUrls(array( http://pubsubhubbub.appspot.com/, http://hubbub.example.com, )); $publisher->addUpdatedTopicUrls(array( http://www.example.net/rss, http://www.example.net/atom, )); $publisher->notifyAll();
444
12 13 14 15 16 17 18 19 20 21
if (!$publisher->isSuccess()) { // check for errors $errors = $publisher->getErrors(); $failedHubs = array(); foreach ($errors as $error) { $failedHubs[] = $error[hubUrl]; } } // reschedule notifications for the failed Hubs in $failedHubs
If you prefer having more concrete control over the Publisher, the methods addHubUrls() and addUpdatedTopicUrls() pass each array value to the singular addHubUrl() and addUpdatedTopicUrl() public methods. There are also matching removeUpdatedTopicUrl() and removeHubUrl() methods. You can also skip setting Hub URI s, and notify each in turn using the notifyHub() method which accepts the URI of a Hub endpoint as its only argument. There are no other tasks to cover. The Publisher implementation is very simple since most of the feed processing and distribution is handled by the selected Hubs. It is however important to detect errors and reschedule notications as soon as possible (with a reasonable maximum number of retries) to ensure notications reach all Subscribers. In many cases as a nal alternative, Hubs may frequently poll your feeds to offer some additional tolerance for failures both in terms of their own temporary downtime or Publisher errors or downtime.
105.4 Zend\Feed\PubSubHubbub\Subscriber
In Pubsubhubbub, the Subscriber is the party who wishes to receive updates to any Topic (RSS or Atom feed). They achieve this by subscribing to one or more of the Hubs advertised by that Topic, usually as a set of one or more Atom 1.0 links with a rel attribute of hub. The Hub from that point forward will send an Atom or RSS feed containing all updates to that Subscribers Callback URL when it receives an update notication from the Publisher. In this way, the Subscriber need never actually visit the original feed (though its still recommended at some level to ensure updates are retrieved if ever a Hub goes ofine). All subscription requests must contain the URI of the Topic being subscribed and a Callback URL which the Hub will use to conrm the subscription and to forward updates. The Subscriber therefore has two roles. To create and manage subscriptions, including subscribing for new Topics with a Hub, unsubscribing (if necessary), and periodically renewing subscriptions since they may have a limited validity as set by the Hub. This is handled by Zend\Feed\PubSubHubbub\Subscriber. The second role is to accept updates sent by a Hub to the Subscribers Callback URL, i.e. the URI the Subscriber has assigned to handle updates. The Callback URL also handles events where the Hub contacts the Subscriber to conrm all subscriptions and unsubscriptions. This is handled by using an instance of Zend\Feed\PubSubHubbub\Subscriber\Callback when the Callback URL is accessed. Important: Zend\Feed\PubSubHubbub\Subscriber implements the Pubsubhubbub 0.2 Specication. As this is a new specication version not all Hubs currently implement it. The new specication allows the Callback URL to include a query string which is used by this class, but not supported by all Hubs. In the interests of maximising compatibility it is therefore recommended that the query string component of the Subscriber Callback URI be presented as a path element, i.e. recognised as a parameter in the route associated with the Callback URI and used by the applications Router.
105.4. Zend\Feed\PubSubHubbub\Subscriber
445
$storage = new Zend\Feed\PubSubHubbub\Model\Subscription; $subscriber = new Zend\Feed\PubSubHubbub\Subscriber; $subscriber->setStorage($storage); $subscriber->addHubUrl(http://hubbub.example.com); $subscriber->setTopicUrl(http://www.example.net/rss.xml); $subscriber->setCallbackUrl(http://www.mydomain.com/hubbub/callback); $subscriber->subscribeAll();
In order to store subscriptions and offer access to this data for general use, the component requires a database (a schema is provided later in this section). By default, it is assumed the table name is subscription and it utilises Zend\Db\Table\Abstract in the background meaning it will use the default adapter you have set for your application. You may also pass a specic custom Zend\Db\Table\Abstract instance into the associated model Zend\Feed\PubSubHubbub\Model\Subscription. This custom adapter may be as simple in intent as changing the table name to use or as complex as you deem necessary. While this Model is offered as a default ready-to-roll solution, you may create your own Model using any other backend or database layer (e.g. Doctrine) so long as the resulting class implements the interface Zend\Feed\PubSubHubbub\Model\SubscriptionInterface. An example schema (MySQL) for a subscription table accessible by the provided model may look similar to:
1 2 3 4 5 6 7 8 9 10 11 12
CREATE TABLE IF NOT EXISTS subscription ( id varchar(32) COLLATE utf8_unicode_ci NOT NULL DEFAULT , topic_url varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL, hub_url varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL, created_time datetime DEFAULT NULL, lease_seconds bigint(20) DEFAULT NULL, verify_token varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL, secret varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL, expiration_time datetime DEFAULT NULL, subscription_state varchar(12) COLLATE utf8_unicode_ci DEFAULT NULL, PRIMARY KEY (id) ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;
Behind the scenes, the Subscriber above will send a request to the Hub endpoint containing the following parameters (based on the previous example):
446
PaValue Explanation rameter hub.callback http://www.mydomain.com/hubbub/callback?xhub.subscription=5536df06b5dcb966edab3a4c4d56213c16a8184 The URI used by a Hub to contact the Subscriber and either request conrmation of a (un)subscription request or send updates from subscribed feeds. The appended query string contains a custom parameter (hence the xhub designation). It is a query string parameter preserved by the Hub and resent with all Subscriber requests. Its purpose is to allow the Subscriber to identify and look up the subscription associated with any Hub request in a backend storage medium. This is a non=standard parameter used by this component in preference to encoding a subscription key in the URI path which is more difcult to implement in a Zend Framework application. Nevertheless, since not all Hubs support query string parameters, we still strongly recommend adding the subscription key as a path component in the form http://www.mydomain.com/hubbub/callback/5536df06b5dcb966edab3a4c4d5621 To accomplish this, it requires dening a route capable of parsing out the nal value of the key and then retrieving the value and passing it to the Subscriber Callback object. The value would be passed into the method ZendPubSubHubbubSubscriberCallback::setSubscriptionKey(). A detailed example is offered later. hub.lease_seconds 2592000 The number of seconds for which the Subscriber would like a new subscription to remain valid for (i.e. a TTL). Hubs may enforce their own maximum subscription period. All subscriptions should be renewed by simply re-subscribing before the subscription period ends to ensure continuity of updates. Hubs should additionally attempt to automatically refresh subscriptions before they expire by contacting Subscribers (handled automatically by the Callback class). hub.modesubscribe Simple value indicating this is a subscription request. Unsubscription requests would use the unsubscribe value. hub.topic http://www.example.net/rss.xml The URI of the topic (i.e. Atom or RSS feed) which the Subscriber wishes to subscribe to for updates. hub.verifysync Indicates to the Hub the preferred mode of verifying subscriptions or unsubscriptions. It is repeated twice in order of preference. Technically this component does not distinguish between the two modes and treats both equally. hub.verifyasync Indicates to the Hub the preferred mode of verifying subscriptions or unsubscriptions. It is repeated twice in order of preference. Technically this component does not distinguish between the two modes and treats both equally. hub.verify_token 3065919804abA verication token returned to the Subscriber by the Hub caa7212ae89.879827871253878386 when it is conrming a subscription or unsubscription. Offers a measure of reliance that the conrmation request originates from the correct Hub to prevent misuse. You ence. can modify several For example, of you these can parameters to set a different indicate lease a different seconds value preferusing
105.4. Zend\Feed\PubSubHubbub\Subscriber
447
Zend\Feed\PubSubHubbub\Subscriber::setLeaseSeconds() or show a preference for the async verify mode by using setPreferredVerificationMode(Zend\Feed\PubSubHubbub\PubSubHubbub::VERIFICATION_ However the Hubs retain the capability to enforce their own preferences and for this reason the component is deliberately designed to work across almost any set of options with minimum end-user conguration required. Conventions are great when they work! Note: While Hubs may require the use of a specic verication mode (both are supported by Zend\Feed\PubSubHubbub), you may indicate a specic preference using the setPreferredVerificationMode() method. In sync (synchronous) mode, the Hub attempts to conrm a subscription as soon as it is received, and before responding to the subscription request. In async (asynchronous) mode, the Hub will return a response to the subscription request immediately, and its verication request may occur at a later time. Since Zend\Feed\PubSubHubbub implements the Subscriber verication role as a separate callback class and requires the use of a backend storage medium, it actually supports both transparently though in terms of end-user performance, asynchronous verication is very much preferred to eliminate the impact of a poorly performing Hub tying up end-user server resources and connections for too long. Unsubscribing from a Topic follows the exact same pattern as the previous example, with the exception that we should call unsubscribeAll() instead. The parameters included are identical to a subscription request with the exception that hub.mode is set to unsubscribe. By default, a new instance of Zend\PubSubHubbub\Subscriber will attempt to use a database backed storage medium which defaults to using the default Zend\Db adapter with a table name of subscription. It is recommended to set a custom storage solution where these defaults are not apt either by passing in a new Model supporting the required interface or by passing a new instance of Zend\Db\Table\Abstract to the default Models constructor to change the used table name.
$storage = new Zend\Feed\PubSubHubbub\Model\Subscription; $callback = new Zend\Feed\PubSubHubbub\Subscriber\Callback; $callback->setStorage($storage); $callback->handle(); $callback->sendResponse(); /** * Check if the callback resulting in the receipt of a feed update. * Otherwise it was either a (un)sub verification request or invalid request. * Typically we need do nothing other than add feed update handling - the rest * is handled internally by the class. */ if ($callback->hasFeedUpdate()) { $feedString = $callback->getFeedUpdate(); /** * Process the feed update asynchronously to avoid a Hub timeout. */ }
448
Note: It should be noted that Zend\Feed\PubSubHubbub\Subscriber\Callback may independently parse any incoming query string and other parameters. This is necessary since PHP alters the structure and keys of a query string when it is parsed into the $_GET or $_POST superglobals. For example, all duplicate keys are ignored and periods are converted to underscores. Pubsubhubbub features both of these in the query strings it generates.
Important: It is essential that developers recognise that Hubs are only concerned with sending requests and receiving a response which veries its receipt. If a feed update is received, it should never be processed on the spot since this leaves the Hub waiting for a response. Rather, any processing should be ofoaded to another process or deferred until after a response has been returned to the Hub. One symptom of a failure to promptly complete Hub requests is that a Hub may continue to attempt delivery of the update or verication request leading to duplicated update attempts being processed by the Subscriber. This appears problematic - but in reality a Hub may apply a timeout of just a few seconds, and if no response is received within that time it may disconnect (assuming a delivery failure) and retry later. Note that Hubs are expected to distribute vast volumes of updates so their resources are stretched - please do process feeds asynchronously (e.g. in a separate process or a job queue or even a cron scheduled task) as much as possible.
Since the query string method is the default in anticipation of a greater level of future support for the full 0.2 specication, this requires some additional work to implement. The rst step to make the Zend\Feed\PubSubHubbub\Subscriber\Callback class aware of the path contained subscription key. Its manually injected therefore since it also requires manually dening a route for this purpose. This is achieved simply by called the method Zend\Feed\PubSubHubbub\Subscriber\Callback::setSubscriptionKey() with the parameter being the key value available from the Router. The example below demonstrates this using a Zend Framework controller.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
use Zend\Mvc\Controller\AbstractActionController; class CallbackController extends AbstractActionController { public function indexAction() { $storage = new Zend\Feed\PubSubHubbub\Model\Subscription; $callback = new Zend\Feed\PubSubHubbub\Subscriber\Callback; $callback->setStorage($storage); /** * Inject subscription key parsing from URL path using * a parameter from Router. */ $subscriptionKey = $this->params()->fromRoute(subkey); $callback->setSubscriptionKey($subscriptionKey);
105.4. Zend\Feed\PubSubHubbub\Subscriber
449
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
$callback->handle(); $callback->sendResponse(); /** * Check if the callback resulting in the receipt of a feed update. * Otherwise it was either a (un)sub verification request or invalid * request. Typically we need do nothing other than add feed update * handling - the rest is handled internally by the class. */ if ($callback->hasFeedUpdate()) { $feedString = $callback->getFeedUpdate(); /** * Process the feed update asynchronously to avoid a Hub timeout. */ } } }
Actually adding the route which would map the path-appended key to a parameter for retrieval from a controller can be accomplished using a Route like in the example below.
1 2 3 4 5 6 7 8 9 10 11
// Callback Route to enable appending a PuSH Subscriptions lookup key $route = Zend\Mvc\Router\Http\Segment::factory(array( route => /callback/:subkey, constraints => array( subkey => [a-z0-9]+ ), defaults => array( controller => application-index, action => index ) ));
450
CHAPTER 106
Zend\File\ClassFileLocator
106.1 Overview
TODO
106.3 Examples
TODO
451
452
CHAPTER 107
Introduction to Zend\Filter
The Zend\Filter component provides a set of commonly needed data lters. It also provides a simple lter chaining mechanism by which multiple lters may be applied to a single datum in a user-dened order.
Also, if a Filter inherits from Zend\Filter\AbstractFilter (just like all out-of-the-box Filters) you can also use them as such: 453
1 2 3 4
$strtolower = new Zend\Filter\StringToLower; echo $strtolower(I LOVE ZF2!); // i love zf2! $zf2love = $strtolower(I LOVE ZF2!);
454
CHAPTER 108
If it is inconvenient to load a given lter class and create an instance of the lter, you can use StaticFilter with its method execute() as an alternative invocation style. The rst argument of this method is a data input value, that you would pass to the filter() method. The second argument is a string, which corresponds to the basename of the lter class, relative to the Zend\Filter namespace. The execute() method automatically loads the class, creates an instance, and applies the filter() method to the data input.
1
You can also pass an array of constructor arguments, if they are needed for the lter class.
1 2 3
The static usage can be convenient for invoking a lter ad hoc, but if you have the need to run a lter for multiple inputs, its more efcient to follow the rst example above, creating an instance of the lter object and calling its filter() method. Also, the FilterChain class allows you to instantiate and run multiple lter and validator classes on demand to process sets of input data. See FilterChain. You can set and receive the FilterPluginManager for the StaticFilter to amend the standard lter classes.
1 2 3 4 5
$original = "my_original_content";
455
3 4 5 6 7 8 9
// Attach a filter $filter = new Zend\Filter\Word\UnderscoreToCamelCase(); $filtered = $filter->filter($original); // Use its opposite $filter2 = new Zend\Filter\Word\CamelCaseToUnderscore(); $filtered = $filter2->filter($filtered)
The above code example could lead to the impression that you will get the original output after the second lter has been applied. But thinking logically this is not the case. After applying the rst lter my_original_content will be changed to MyOriginalContent. But after applying the second lter the result is My_Original_Content. As you can see it is not always possible to get the original output by using a lter which seems to be the opposite. It depends on the lter and also on the given input.
456
CHAPTER 109
Zend Framework comes with a standard set of lters, which are ready for you to use.
109.1 Alnum
The Alnum lter can be used to return only alphabetic characters and digits in the unicode letter and number categories, respectively. All other characters are suppressed.
Supported Options for Alnum Filter
The following options are supported for Alnum: Alnum([ boolean $allowWhiteSpace [, string $locale ]]) $allowWhiteSpace: If set to true then whitespace characters are allowed. Otherwise they are suppressed. Default is false (whitespace is not allowed). Methods for getting/setting the allowWhiteSpace option are also available: getAllowWhiteSpace() and setAllowWhiteSpace() $locale: The locale string used in identifying the characters to lter (locale name, e.g. en_US). If unset, it will use the default locale (Locale::getDefault()). Methods for getting/setting the locale are also available: getLocale() and setLocale()
Alnum Filter Usage // Default settings, deny whitespace $filter = new \Zend\I18n\Filter\Alnum(); echo $filter->filter("This is (my) content: 123"); // Returns "Thisismycontent123" // First param in constructor is $allowWhiteSpace $filter = new \Zend\I18n\Filter\Alnum(true); echo $filter->filter("This is (my) content: 123"); // Returns "This is my content 123"
1 2 3 4 5 6 7 8 9
457
Note: Alnum works on almost all languages, except: Chinese, Japanese and Korean. Within these languages the english alphabet is used instead of the characters from these languages. The language itself is detected using the Locale.
109.2 Alpha
The Alpha lter can be used to return only alphabetic characters in the unicode letter category. All other characters are suppressed.
Supported Options for Alpha Filter
The following options are supported for Alpha: Alpha([ boolean $allowWhiteSpace [, string $locale ]]) $allowWhiteSpace: If set to true then whitespace characters are allowed. Otherwise they are suppressed. Default is false (whitespace is not allowed). Methods for getting/setting the allowWhiteSpace option are also available: getAllowWhiteSpace() and setAllowWhiteSpace() $locale: The locale string used in identifying the characters to lter (locale name, e.g. en_US). If unset, it will use the default locale (Locale::getDefault()). Methods for getting/setting the locale are also available: getLocale() and setLocale()
Alpha Filter Usage // Default settings, deny whitespace $filter = new \Zend\I18n\Filter\Alpha(); echo $filter->filter("This is (my) content: 123"); // Returns "Thisismycontent" // Allow whitespace $filter = new \Zend\I18n\Filter\Alpha(true); echo $filter->filter("This is (my) content: 123"); // Returns "This is my content "
1 2 3 4 5 6 7 8 9
Note: Alpha works on almost all languages, except: Chinese, Japanese and Korean. Within these languages the english alphabet is used instead of the characters from these languages. The language itself is detected using the Locale.
109.3 BaseName
Zend\Filter\BaseName allows you to lter a string which contains the path to a le and it will return the base name of this le.
458
Supported Options
109.4 Boolean
This lter changes a given input to be a BOOLEAN value. This is often useful when working with databases or when processing form values.
Supported Options
The following options are supported for Zend\Filter\Boolean: casting: When this option is set to TRUE then any given input will be casted to boolean. This option defaults to TRUE. locale: This option sets the locale which will be used to detect localized input. type: The type option sets the boolean type which should be used. Read the following for details.
Default Behavior
By default, this lter works by casting the input to a BOOLEAN value; in other words, it operates in a similar fashion to calling (boolean) $value.
1 2 3 4
This means that without providing any conguration, Zend\Filter\Boolean accepts all input types and returns a BOOLEAN just as you would get by type casting to BOOLEAN.
109.4. Boolean
459
Sometimes casting with (boolean) will not sufce. Zend\Filter\Boolean allows you to congure specic types to convert, as well as which to omit. The following types can be handled: boolean: Returns a boolean value as is. integer: Converts an integer 0 value to FALSE. oat: Converts a oat 0.0 value to FALSE. string: Converts an empty string to FALSE. zero: Converts a string containing the single character zero (0) to FALSE. empty_array: Converts an empty array to FALSE. null: Converts a NULL value to FALSE. php: Converts values according to PHP when casting them to BOOLEAN. false_string: Converts a string containing the word false to a boolean FALSE. yes: Converts a localized string which contains the word no to FALSE. all: Converts all above types to BOOLEAN. All other given values will return TRUE by default. There are several ways to select which of the above types are ltered. You can give one or multiple types and add them, you can give an array, you can use constants, or you can give a textual string. See the following examples:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
// converts 0 to false $filter = new Zend\Filter\Boolean(Zend\Filter\Boolean::INTEGER); // converts 0 and 0 to false $filter = new Zend\Filter\Boolean( Zend\Filter\Boolean::INTEGER + Zend\Filter\Boolean::ZERO ); // converts 0 and 0 to false $filter = new Zend\Filter\Boolean(array( type => array( Zend\Filter\Boolean::INTEGER, Zend\Filter\Boolean::ZERO, ), )); // converts 0 and 0 to false $filter = new Zend\Filter\Boolean(array( type => array( integer, zero, ), ));
You can also give an instance of Zend\Config\Config to set the desired types. To set types after instantiation, use the setType() method.
460
Localized Booleans
As mentioned previously, Zend\Filter\Boolean can also recognise localized yes and no strings. This means that you can ask your customer in a form for yes or no within his native language and Zend\Filter\Boolean will convert the response to the appropriate boolean value. To set the desired locale, you can either use the locale option, or the method setLocale().
1 2 3 4 5 6 7 8 9 10 11 12
$filter = new Zend\Filter\Boolean(array( type => Zend\Filter\Boolean::ALL, locale => de, )); // returns false echo $filter->filter(nein); $filter->setLocale(en); // returns true $filter->filter(yes);
Disable Casting
Sometimes it is necessary to recognise only TRUE or FALSE and return all other values without changes. Zend\Filter\Boolean allows you to do this by setting the casting option to FALSE. In this case Zend\Filter\Boolean will work as described in the following table, which shows which values return TRUE or FALSE. All other given values are returned without change when casting is set to FALSE Table 109.1: Usage without casting Type Zend\Filter\Boolean::BOOLEAN Zend\Filter\Boolean::INTEGER Zend\Filter\Boolean::FLOAT Zend\Filter\Boolean::STRING Zend\Filter\Boolean::ZERO Zend\Filter\Boolean::EMPTY_ARRAY Zend\Filter\Boolean::NULL Zend\Filter\Boolean::FALSE_STRING Zend\Filter\Boolean::YES True TRUE 0 0.0 0 array() NULL false (case independently) localized yes (case independently) False FALSE 1 1.0 1
The following example shows the behaviour when changing the casting option:
1 2 3 4 5 6 7 8 9 10 11 12 13
$filter = new Zend\Filter\Boolean(array( type => Zend\Filter\Boolean::ALL, casting => false, )); // returns false echo $filter->filter(0); // returns true echo $filter->filter(1); // returns the value echo $filter->filter(2);
109.4. Boolean
461
109.5 Callback
This lter allows you to use own methods in conjunction with Zend\Filter. You dont have to create a new lter when you already have a method which does the job.
Supported Options
The following options are supported for Zend\Filter\Callback: callback: This sets the callback which should be used. options: This property sets the options which are used when the callback is processed.
Basic Usage
The usage of this lter is quite simple. Lets expect we want to create a lter which reverses a string.
1 2 3 4
As you can see its really simple to use a callback to dene a own lter. It is also possible to use a method, which is dened within a class, by giving an array as callback.
1 2 3 4 5 6 7 8 9
// Our classdefinition class MyClass { public function Reverse($param); } // The filter definition $filter = new Zend\Filter\Callback(array(MyClass, Reverse)); print $filter->filter(Hello!);
To get the actual set callback use getCallback() and to set another callback use setCallback(). Note: Possible exceptions You should note that dening a callback method which can not be called will raise an exception.
It is also possible to dene default parameters, which are given to the called method as array when the lter is executed. This array will be concatenated with the value which will be ltered.
1 2 3 4 5 6 7
$filter = new Zend\Filter\Callback( array( callback => MyMethod, options => array(key => param1, key2 => param2) ) ); $filter->filter(array(value => Hello));
462
When you would call the above method denition manually it would look like this:
1
The following options are supported for Zend\Filter\Compress and Zend\Filter\Decompress: adapter: The compression adapter which should be used. It defaults to Gz. options: Additional options which are given to the adapter at initiation. Each adapter supports its own options.
Supported Compression Adapters
The following compression formats are supported by their own adapter: Bz2 Gz Lzf Rar Tar Zip Each compression format has different capabilities as described below. All compression lters may be used in approximately the same ways, and differ primarily in the options available and the type of compression they offer (both algorithmically as well as string vs. le vs. directory)
Generic Handling
To create a compression lter you need to select the compression format you want to use. The following description takes the Bz2 adapter. Details for all other adapters are described after this section. The two lters are basically identical, in that they utilize the same backends. Zend\Filter\Compress should be used when you wish to compress items, and Zend\Filter\Decompress should be used when you wish to decompress items. For instance, if we want to compress a string, we have to initiate Zend\Filter\Compress and indicate the desired adapter.
1
To use a different adapter, you simply specify it to the constructor. You may also provide an array of options or a Traversable object. If you do, provide minimally the key adapter, and then either the key options or adapterOptions (which should be an array of options to provide to the adapter on instantiation).
463
1 2 3 4 5 6
$filter = new Zend\Filter\Compress(array( adapter => Bz2, options => array( blocksize => 8, ), ));
Note: Default compression Adapter When no compression adapter is given, then the Gz adapter will be used. Almost the same usage is we want to decompress a string. We just have to use the decompression lter in this case.
1
To get the compressed string, we have to give the original string. The ltered value is the compressed version of the original string.
1 2 3
$filter = new Zend\Filter\Compress(Bz2); $compressed = $filter->filter(Uncompressed string); // Returns the compressed string
$filter = new Zend\Filter\Decompress(Bz2); $compressed = $filter->filter(Compressed string); // Returns the uncompressed string
Note: Note on string compression Not all adapters support string compression. Compression formats like Rar can only handle les and directories. For details, consult the section for the adapter you wish to use.
Creating an Archive
Creating an archive le works almost the same as compressing a string. However, in this case we need an additional parameter which holds the name of the archive we want to create.
1 2 3 4 5 6 7 8
$filter = new Zend\Filter\Compress(array( adapter => Bz2, options => array( archive => filename.bz2, ), )); $compressed = $filter->filter(Uncompressed string); // Returns true on success and creates the archive file
In the above example the uncompressed string is compressed, and is then written into the given archive le. Note: Existing archives will be overwritten The content of any existing le will be overwritten when the given lename of the archive already exists. When you want to compress a le, then you must give the name of the le with its path.
464
1 2 3 4 5 6 7 8
$filter = new Zend\Filter\Compress(array( adapter => Bz2, options => array( archive => filename.bz2 ), )); $compressed = $filter->filter(C:\temp\compressme.txt); // Returns true on success and creates the archive file
You may also specify a directory instead of a lename. In this case the whole directory with all its les and subdirectories will be compressed into the archive.
1 2 3 4 5 6 7 8
$filter = new Zend\Filter\Compress(array( adapter => Bz2, options => array( archive => filename.bz2 ), )); $compressed = $filter->filter(C:\temp\somedir); // Returns true on success and creates the archive file
Note: Do not compress large or base directories You should never compress large or base directories like a complete partition. Compressing a complete partition is a very time consuming task which can lead to massive problems on your server when there is not enough space or your script takes too much time.
Decompressing an Archive
Decompressing an archive le works almost like compressing it. You must specify either the archive parameter, or give the lename of the archive when you decompress the le.
1 2 3
$filter = new Zend\Filter\Decompress(Bz2); $decompressed = $filter->filter(filename.bz2); // Returns true on success and decompresses the archive file
Some adapters support decompressing the archive into another subdirectory. In this case you can set the target parameter.
1 2 3 4 5 6 7 8 9
$filter = new Zend\Filter\Decompress(array( adapter => Zip, options => array( target => C:\temp, ) )); $decompressed = $filter->filter(filename.zip); // Returns true on success and decompresses the archive file // into the given target directory
Note: Directories to extract to must exist When you want to decompress an archive into a directory, then that directory must exist.
465
Bz2 Adapter
The Bz2 Adapter can compress and decompress: Strings Files Directories This adapter makes use of PHPs Bz2 extension. To customize compression, this adapter supports the following options: Archive: This parameter sets the archive le which should be used or created. Blocksize: This parameter sets the blocksize to use. It can be from 0 to 9. The default value is 4. All options can be set at instantiation or by using a related method. For example, the related methods for Blocksize are getBlocksize() and setBlocksize(). You can also use the setOptions() method which accepts all options as array.
Gz Adapter
The Gz Adapter can compress and decompress: Strings Files Directories This adapter makes use of PHPs Zlib extension. To customize the compression this adapter supports the following options: Archive: This parameter sets the archive le which should be used or created. Level: This compression level to use. It can be from 0 to 9. The default value is 9. Mode: There are two supported modes. compress and deate. The default value is compress. All options can be set at initiation or by using a related method. For example, the related methods for Level are getLevel() and setLevel(). You can also use the setOptions() method which accepts all options as array.
Lzf Adapter
The Lzf Adapter can compress and decompress: Strings Note: Lzf supports only strings The Lzf adapter can not handle les and directories. This adapter makes use of PHPs Lzf extension. There are no options available to customize this adapter.
466
Rar Adapter
The Rar Adapter can compress and decompress: Files Directories Note: Rar does not support strings The Rar Adapter can not handle strings. This adapter makes use of PHPs Rar extension. Note: Rar compression not supported Due to restrictions with the Rar compression format, there is no compression available for free. When you want to compress les into a new Rar archive, you must provide a callback to the adapter that can invoke a Rar compression program. To customize the compression this adapter supports the following options: Archive: This parameter sets the archive le which should be used or created. Callback: A callback which provides compression support to this adapter. Password: The password which has to be used for decompression. Target: The target where the decompressed les will be written to. All options can be set at instantiation or by using a related method. For example, the related methods for Target are getTarget() and setTarget(). You can also use the setOptions() method which accepts all options as array.
Tar Adapter
The Tar Adapter can compress and decompress: Files Directories Note: Tar does not support strings The Tar Adapter can not handle strings. This adapter makes use of PEARs Archive_Tar component. To customize the compression this adapter supports the following options: Archive: This parameter sets the archive le which should be used or created. Mode: A mode to use for compression. Supported are either NULL which means no compression at all, Gz which makes use of PHPs Zlib extension and Bz2 which makes use of PHPs Bz2 extension. The default value is NULL. Target: The target where the decompressed les will be written to.
467
All options can be set at instantiation or by using a related method. For example, the related methods for Target are getTarget() and setTarget(). You can also use the setOptions() method which accepts all options as array. Note: Directory usage When compressing directories with Tar then the complete le path is used. This means that created Tar les will not only have the subdirectory but the complete path for the compressed le.
Zip Adapter
The Zip Adapter can compress and decompress: Strings Files Directories Note: Zip does not support string decompression The Zip Adapter can not handle decompression to a string; decompression will always be written to a le. This adapter makes use of PHPs Zip extension. To customize the compression this adapter supports the following options: Archive: This parameter sets the archive le which should be used or created. Target: The target where the decompressed les will be written to. All options can be set at instantiation or by using a related method. For example, the related methods for Target are getTarget() and setTarget(). You can also use the setOptions() method which accepts all options as array.
109.7 Digits
Returns the string $value, removing all but digits.
Supported Options
468
1 2 3
This returns 5.
109.8 Dir
Given a string containing a path to a le, this function will return the name of the directory.
Supported Options
The following options are supported for Zend\Filter\Encrypt and Zend\Filter\Decrypt: adapter: This sets the encryption adapter which should be used algorithm: Only BlockCipher. The algorithm which has to be used by the adapter Zend\Crypt\Symmetric\Mcrypt. It should be one of the algorithm ciphers supported by Zend\Crypt\Symmetric\Mcrypt (see the getSupportedAlgorithms() method). If not set it defaults to aes, the Advanced Encryption Standard (see Zend\Crypt\BlockCipher for more details). compression: If the encrypted value should be compressed. Default is no compression. envelope: Only OpenSSL. The encrypted envelope key from the user who encrypted the content. You can either provide the path and lename of the key le, or just the content of the key le itself. When the package option has been set, then you can omit this parameter. 109.8. Dir 469
key: Only BlockCipher. The encryption key with which the input will be encrypted. You need the same key for decryption. mode: Only BlockCipher. The encryption mode which has to be used. It should be one of the modes which can be found under PHPs mcrypt modes. If not set it defaults to cbc. mode_directory: Only BlockCipher. The directory where the mode can be found. If not set it defaults to the path set within the Mcrypt extension. package: Only OpenSSL. If the envelope key should be packed with the encrypted value. Default is FALSE. private: Only OpenSSL. Your private key which will be used for encrypting the content. Also the private key can be either a lename with path of the key le, or just the content of the key le itself. public: Only OpenSSL. The public key of the user whom you want to provide the encrypted content. You can give multiple public keys by using an array. You can either provide the path and lename of the key le, or just the content of the key le itself. vector: Only BlockCipher. The initialization vector which shall be used. If not set it will be a random vector.
Adapter Usage
As these two encryption methodologies work completely different, also the usage of the adapters differ. You have to select the adapter you want to use when initiating the lter.
1 2 3 4 5
// Use the BlockCipher adapter $filter1 = new Zend\Filter\Encrypt(array(adapter => BlockCipher)); // Use the OpenSSL adapter $filter2 = new Zend\Filter\Encrypt(array(adapter => openssl));
To set another adapter you can also use setAdapter(), and the getAdapter() method to receive the actual set adapter.
1 2 3
Note: When you do not supply the adapter option or do not use setAdapter(), then the BlockCipher adapter will be used per default.
To encrypt a string using the BlockCipher you have to specify the encryption key using the setKey() method or passing it during the constructor.
1 2 3 4 5 6 7 8 9
// Use the default AES encryption algorithm $filter = new Zend\Filter\Encrypt(array(adapter => BlockCipher)); $filter->setKey(encryption key); // or // $filter = new Zend\Filter\Encrypt(array( // adapter => BlockCipher, // key => encryption key // ));
470
10 11 12
You can get and set the encryption values also afterwards with the getEncryption() and setEncryption() methods.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
// Use the default AES encryption algorithm $filter = new Zend\Filter\Encrypt(array(adapter => BlockCipher)); $filter->setKey(encryption key); var_dump($filter->getEncryption()); // Will print: //array(4) { // ["key_iteration"]=> // int(5000) // ["algorithm"]=> // string(3) "aes" // ["hash"]=> // string(6) "sha256" // ["key"]=> // string(14) "encryption key" //}
Note: The BlockCipher adapter uses the Mcrypt PHP extension by default. That means you will need to install the Mcrypt module in your PHP environment. If you dont specify an initialization Vector (salt or iv), the BlockCipher will generate a random value during each encryption. If you try to execute the following code the output will be always different (note that even if the output is always different you can decrypt it using the same key).
1 2 3 4 5 6 7 8 9
$key = encryption key; $text = message to encrypt; // use the default adapter that is BlockCipher $filter = new \Zend\Filter\Encrypt(); $filter->setKey(encryption key); for ($i=0; $i < 10; $i++) { printf("%d) %s\n", $i, $filter->filter($text)); }
If you want to obtain the same output you need to specify a xed Vector, using the setVector() method. This script will produce always the same encryption output.
1 2 3 4 5 6 7 8
// use the default adapter that is BlockCipher $filter = new \Zend\Filter\Encrypt(); $filter->setKey(encryption key); $filter->setVector(12345678901234567890); printf("%s\n", $filter->filter(message));
// output: // 04636a6cb8276fad0787a2e187803b6557f77825d5ca6ed4392be702b9754bb3MTIzNDU2Nzg5MDEyMzQ1NgZ+zPwTGpV6gQ
Note: For a security reason its always better to use a different Vector on each encryption. We suggest to use the setVector() method only if you really need it.
471
For decrypting content which was previously encrypted with BlockCipher you need to have the options with which the encryption has been called. If you used only the encryption key, you can just use it to decrypt the content. As soon as you have provided all options decryption is as simple as encryption.
1 2 3 4 5 6 7 8
$content = 04636a6cb8276fad0787a2e187803b6557f77825d5ca6ed4392be702b9754bb3MTIzNDU2Nzg5MDEyMzQ1NgZ+z // use the default adapter that is BlockCipher $filter = new Zend\Filter\Decrypt(); $filter->setKey(encryption key); printf("Decrypt: %s\n", $filter->filter($content)); // output: // Decrypt: message
Note that even if we did not specify the same Vector, the BlockCipher is able to decrypt the message because the Vector is stored in the encryption string itself (note that the Vector can be stored in plaintext, it is not a secret, the Vector is only used to improve the randomness of the encryption algorithm). Note: You should also note that all settings which be checked when you create the instance or when you call setEncryption().
When you have installed the OpenSSL extension you can use the OpenSSL adapter. You can get or set the public keys also afterwards with the getPublicKey() and setPublicKey() methods. The private key can also be get and set with the related getPrivateKey() and setPrivateKey() methods.
1 2 3 4 5 6 7 8 9 10 11
// Use openssl and provide a private key $filter = new Zend\Filter\Encrypt(array( adapter => openssl, private => /path/to/mykey/private.pem )); // of course you can also give the public keys at initiation $filter->setPublicKey(array( /public/key/path/first.pem, /public/key/path/second.pem ));
Note: Note that the OpenSSL adapter will not work when you do not provide valid keys. When you want to encode also the keys, then you have to provide a passphrase with the setPassphrase() method. When you want to decode content which was encoded with a passphrase you will not only need the public key, but also the passphrase to decode the encrypted key.
1 2 3 4 5 6
// Use openssl and provide a private key $filter = new Zend\Filter\Encrypt(array( adapter => openssl, private => /path/to/mykey/private.pem ));
472
7 8 9 10 11 12
// of course you can also give the public keys at initiation $filter->setPublicKey(array( /public/key/path/first.pem, /public/key/path/second.pem )); $filter->setPassphrase(mypassphrase);
At last, when you use OpenSSL you need to give the receiver the encrypted content, the passphrase when have provided one, and the envelope keys for decryption. This means for you, that you have to get the envelope keys after the encryption with the getEnvelopeKey() method. So our complete example for encrypting content with OpenSSL look like this.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
// Use openssl and provide a private key $filter = new Zend\Filter\Encrypt(array( adapter => openssl, private => /path/to/mykey/private.pem )); // of course you can also give the public keys at initiation $filter->setPublicKey(array( /public/key/path/first.pem, /public/key/path/second.pem )); $filter->setPassphrase(mypassphrase); $encrypted = $filter->filter(text_to_be_encoded); $envelope = $filter->getEnvelopeKey(); print $encrypted; // For decryption look at the Decrypt filter
As seen before, you need to get the envelope key to be able to decrypt the previous encrypted value. This can be very annoying when you work with multiple values. To have a simplied usage you can set the package option to TRUE. The default value is FALSE.
1 2 3 4 5 6 7 8 9 10 11 12
// Use openssl and provide a private key $filter = new Zend\Filter\Encrypt(array( adapter => openssl, private => /path/to/mykey/private.pem, public => /public/key/path/public.pem, package => true )); $encrypted = $filter->filter(text_to_be_encoded); print $encrypted; // For decryption look at the Decrypt filter
Now the returned value contains the encrypted value and the envelope. You dont need to get them after the compression. But, and this is the negative aspect of this feature, the encrypted value can now only be decrypted by using Zend\Filter\Encrypt.
473
Compressing Content
Based on the original value, the encrypted value can be a very large string. Zend\Filter\Encrypt allows the usage of compression.
The compression option can either be set to the name of a compression adapter, or to an array which sets all wished options for the compression adapter.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
// Use basic compression adapter $filter1 = new Zend\Filter\Encrypt(array( adapter => openssl, private => /path/to/mykey/private.pem, public => /public/key/path/public.pem, package => true, compression => bz2 )); // Use basic compression adapter $filter2 = new Zend\Filter\Encrypt(array( adapter => openssl, private => /path/to/mykey/private.pem, public => /public/key/path/public.pem, package => true, compression => array(adapter => zip, target => \usr\tmp\tmp.zip) ));
Note: Decryption with same settings When you want to decrypt a value which is additionally compressed, then you need to set the same compression settings for decryption as for encryption. Otherwise the decryption will fail.
Decryption with OpenSSL is as simple as encryption. But you need to have all data from the person who encrypted the content. See the following example:
1 2 3 4 5 6 7 8 9 10 11
// Use openssl and provide a private key $filter = new Zend\Filter\Decrypt(array( adapter => openssl, private => /path/to/mykey/private.pem )); // of course you can also give the envelope keys at initiation $filter->setEnvelopeKey(array( /key/from/encoder/first.pem, /key/from/encoder/second.pem ));
Note: Note that the OpenSSL adapter will not work when you do not provide valid keys. Optionally it could be necessary to provide the passphrase for decrypting the keys themself by using the setPassphrase() method.
1 2
474
3 4 5 6 7 8 9 10 11 12
adapter => openssl, private => /path/to/mykey/private.pem )); // of course you can also give the envelope keys at initiation $filter->setEnvelopeKey(array( /key/from/encoder/first.pem, /key/from/encoder/second.pem )); $filter->setPassphrase(mypassphrase);
At last, decode the content. Our complete example for decrypting the previously encrypted content looks like this.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
// Use openssl and provide a private key $filter = new Zend\Filter\Decrypt(array( adapter => openssl, private => /path/to/mykey/private.pem )); // of course you can also give the envelope keys at initiation $filter->setEnvelopeKey(array( /key/from/encoder/first.pem, /key/from/encoder/second.pem )); $filter->setPassphrase(mypassphrase); $decrypted = $filter->filter(encoded_text_normally_unreadable); print $decrypted;
109.10 HtmlEntities
Returns the string $value, converting characters to their corresponding HTML entity equivalents where they exist.
Supported Options
The following options are supported for Zend\Filter\HtmlEntities: quotestyle: Equivalent to the PHP htmlentities native function parameter quote_style. This allows you to dene what will be done with single and double quotes. The following constants are accepted: ENT_COMPAT, ENT_QUOTES ENT_NOQUOTES with the default being ENT_COMPAT. charset: Equivalent to the PHP htmlentities native function parameter charset. This denes the character set to be used in ltering. Unlike the PHP native function the default is UTF-8. See http://php.net/htmlentities for a list of supported character sets. Note: This option can also be set via the $options parameter as a Traversable object or array. The option key will be accepted as either charset or encoding. doublequote: Equivalent to the PHP htmlentities native function parameter double_encode. If set to false existing html entities will not be encoded. The default is to convert everything (true). Note: This option must be set via the $options parameter or the setDoubleEncode() method.
109.10. HtmlEntities
475
Basic Usage
See the following example for the default behavior of this lter.
1 2 3
Quote Style
Zend\Filter\HtmlEntities allows changing the quote style used. This can be useful when you want to leave double, single, or both types of quotes un-ltered. See the following example:
1 2 3 4
$filter = new Zend\Filter\HtmlEntities(array(quotestyle => ENT_QUOTES)); $input = "A single and " . "double"; print $filter->filter($input);
The above example returns A 'single' and "double". Notice that single as well as "double" quotes are ltered.
1 2 3 4
$filter = new Zend\Filter\HtmlEntities(array(quotestyle => ENT_COMPAT)); $input = "A single and " . "double"; print $filter->filter($input);
The above example returns A single and "double". Notice that "double" quotes are ltered while single quotes are not altered.
1 2 3 4
$filter = new Zend\Filter\HtmlEntities(array(quotestyle => ENT_NOQUOTES)); $input = "A single and " . "double"; print $filter->filter($input);
The above example returns A single and "double". Notice that neither "double" or single quotes are altered.
Helper Methods
To change or retrieve the quotestyle after instantiation, the two methods setQuoteStyle() and getQuoteStyle() may be used respectively. setQuoteStyle() accepts one parameter $quoteStyle. The following constants are accepted: ENT_COMPAT, ENT_QUOTES, ENT_NOQUOTES
1 2 3 4
To change or retrieve the charset after instantiation, the two methods setCharSet() and getCharSet() may be used respectively. setCharSet() accepts one parameter $charSet. See http://php.net/htmlentities for a list of supported character sets.
1 2 3 4
476
To change or retrieve the doublequote option after instantiation, the two methods setDoubleQuote() and getDoubleQuote() may be used respectively. setDoubleQuote() accepts one boolean parameter $doubleQuote.
1 2 3 4
109.11 Int
Zend\Filter\Int allows you to transform a scalar value which contains into an integer.
Supported Options
109.12 Null
This lter will change the given input to be NULL if it meets specic criteria. This is often necessary when you work with databases and want to have a NULL value instead of a boolean or any other type.
Supported Options
The following options are supported for Zend\Filter\Null: type: The variable type which should be supported.
Default Behavior
Per default this lter works like PHPs empty() method; in other words, if empty() returns a boolean TRUE, then a NULL value will be returned.
1 2 3 4
$filter = new Zend\Filter\Null(); $value = ; $result = $filter->filter($value); // returns null instead of the empty string
109.11. Int
477
This means that without providing any conguration, Zend\Filter\Null will accept all input types and return NULL in the same cases as empty(). Any other value will be returned as is, without any changes.
Changing the Default Behavior
Sometimes its not enough to lter based on empty(). Therefor Zend\Filter\Null allows you to congure which type will be converted and which not. The following types can be handled: boolean: Converts a boolean FALSE value to NULL. integer: Converts an integer 0 value to NULL. empty_array: Converts an empty array to NULL. oat: Converts an oat 0.0 value to NULL. string: Converts an empty string to NULL. zero: Converts a string containing the single character zero (0) to NULL. all: Converts all above types to NULL. (This is the default behavior.) There are several ways to select which of the above types are ltered. You can give one or multiple types and add them, you can give an array, you can use constants, or you can give a textual string. See the following examples:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
// converts false to null $filter = new Zend\Filter\Null(Zend\Filter\Null::BOOLEAN); // converts false and 0 to null $filter = new Zend\Filter\Null( Zend\Filter\Null::BOOLEAN + Zend\Filter\Null::INTEGER ); // converts false and 0 to null $filter = new Zend\Filter\Null( array( Zend\Filter\Null::BOOLEAN, Zend\Filter\Null::INTEGER )); // converts false and 0 to null $filter = new Zend\Filter\Null(array( boolean, integer, ));
You can also give a Traversable or an array to set the wished types. To set types afterwards use setType().
109.13 NumberFormat
The NumberFormat lter can be used to return locale-specic number and percentage strings. It extends the NumberParse lter, which acts as wrapper for the NumberFormatter class within the Internationalization extension (Intl).
478
The following options are supported for NumberFormat: NumberFormat([ string $locale [, int $style [, int $type ]]]) $locale: (Optional) Locale in which the number would be formatted (locale name, e.g. en_US). If unset, it will use the default locale (Locale::getDefault()) Methods for getting/setting the locale are also available: getLocale() and setLocale() $style: (Optional) Style of the formatting, one of the format style constants. NumberFormatter::DEFAULT_STYLE as the default style. If unset, it will use
Methods for getting/setting the format style are also available: getStyle() and setStyle() $type: (Optional) The formatting type to use. If unset, it will use NumberFormatter::TYPE_DOUBLE as the default type. Methods for getting/setting the format type are also available: getType() and setType()
NumberFormat Filter Usage $filter = new \Zend\I18n\Filter\NumberFormat("de_DE"); echo $filter->filter(1234567.8912346); // Returns "1.234.567,891" $filter = new \Zend\I18n\Filter\NumberFormat("en_US", NumberFormatter::PERCENT); echo $filter->filter(0.80); // Returns "80%" $filter = new \Zend\I18n\Filter\NumberFormat("fr_FR", NumberFormatter::SCIENTIFIC); echo $filter->filter(0.00123456789); // Returns "1,23456789E-3"
1 2 3 4 5 6 7 8 9 10 11
109.14 PregReplace
Zend\Filter\PregReplace performs a search using regular expressions and replaces all found elements.
Supported Options
The following options are supported for Zend\Filter\PregReplace: pattern: The pattern which will be searched for. replacement: The string which is used as replacement for the matches.
Basic Usage
To use this lter properly you must give two options: The option pattern has to be given to set the pattern which will be searched for. It can be a string for a single pattern, or an array of strings for multiple pattern.
109.14. PregReplace
479
To set the pattern which will be used as replacement the option replacement has to be used. It can be a string for a single pattern, or an array of strings for multiple pattern.
1 2 3 4 5 6 7 8
$filter = new Zend\Filter\PregReplace(array( pattern => /bob/, replacement => john, )); $input = Hy bob!"; $filter->filter($input); // returns Hy john!
You can use getPattern() and setPattern() to set the matching pattern afterwards. To set the replacement pattern you can use getReplacement() and setReplacement().
1 2 3 4 5 6 7
$filter = new Zend\Filter\PregReplace(); $filter->setMatchPattern(array(bob, Hy)) ->setReplacement(array(john, Bye)); $input = Hy bob!"; $filter->filter($input); // returns Bye john!
For a more complex usage take a look into PHPs PCRE Pattern Chapter.
109.15 RealPath
This lter will resolve given links and pathnames and returns canonicalized absolute pathnames.
Supported Options
The following options are supported for Zend\Filter\RealPath: exists: This option defaults to TRUE which checks if the given path really exists.
Basic Usage
For any given link of pathname its absolute path will be returned. References to /./, /../ and extra / characters in the input path will be stripped. The resulting path will not have any symbolic link, /./ or /../ character. Zend\Filter\RealPath will return FALSE on failure, e.g. if the le does not exist. On BSD systems Zend\Filter\RealPath doesnt fail if only the last path component doesnt exist, while other systems will return FALSE.
1 2 3 4 5
480
Non-Existing Paths
Sometimes it is useful to get also paths when they dont exist, f.e. when you want to get the real path for a path which you want to create. You can then either give a FALSE at initiation, or use setExists() to set it.
1 2 3 4 5 6
$filter = new Zend\Filter\RealPath(false); $path = /www/var/path/../../non/existing/path; $filtered = $filter->filter($path); // returns /www/non/existing/path // even when file_exists or realpath would return false
109.16 StringToLower
This lter converts any input to be lowercased.
Supported Options
The following options are supported for Zend\Filter\StringToLower: encoding: This option can be used to set an encoding which has to be used.
Basic Usage
Per default it will only handle characters from the actual locale of your server. Characters from other charsets would be ignored. Still, its possible to also lowercase them when the mbstring extension is available in your environment. Simply set the wished encoding when initiating the StringToLower lter. Or use the setEncoding() method to change the encoding afterwards.
1 2 3 4 5 6 7 8
// using UTF-8 $filter = new Zend\Filter\StringToLower(UTF-8); // or give an array which can be useful when using a configuration $filter = new Zend\Filter\StringToLower(array(encoding => UTF-8)); // or do this afterwards $filter->setEncoding(ISO-8859-1);
Note: Setting wrong encodings Be aware that you will get an exception when you want to set an encoding and the mbstring extension is not available in your environment.
109.16. StringToLower
481
Also when you are trying to set an encoding which is not supported by your mbstring extension you will get an exception.
109.17 StringToUpper
This lter converts any input to be uppercased.
Supported Options
The following options are supported for Zend\Filter\StringToUpper: encoding: This option can be used to set an encoding which has to be used.
Basic Usage
Like the StringToLower lter, this lter handles only characters from the actual locale of your server. Using different character sets works the same as with StringToLower.
1 2 3 4
109.18 StringTrim
This lter modies a given string such that certain characters are removed from the beginning and end.
Supported Options
The following options are supported for Zend\Filter\StringTrim: charlist: List of characters to remove from the beginning and end of the string. If this is not set or is null, the default behavior will be invoked, which is to remove only whitespace from the beginning and end of the string.
482
Basic Usage
The above example returns This is (my) content:. Notice that the whitespace characters have been removed.
Default Behavior $filter = new Zend\Filter\StringTrim(:); // or new Zend\Filter\StringTrim(array(charlist => :)); print $filter->filter( This is (my) content:);
1 2 3 4
The above example returns This is (my) content. Notice that the whitespace characters and colon are removed. You can also provide a Traversable or an array with a charlist key. To set the desired character list after instantiation, use the setCharList() method. The getCharList() return the values set for charlist.
109.19 StripNewLines
This lter modies a given string and removes all new line characters within that string.
Supported Options
The above example returns This is (my) content:. Notice that all newline characters have been removed.
109.20 StripTags
This lter can strip XML and HTML tags from given content. Warning: Be warned that Zend\Filter\StripTags should only be used to strip all available tags. Using Zend\Filter\StripTags to make your site secure by stripping some unwanted tags will lead to unsecure and dangerous code. Zend\Filter\StripTags must not be used to prevent XSS attacks. This lter is no replacement for using Tidy or HtmlPurier.
109.19. StripNewLines
483
Supported Options
The following options are supported for Zend\Filter\StripTags: allowAttribs: This option sets the attributes which are accepted. All other attributes are stripped from the given content. allowTags: This option sets the tags which are accepted. All other tags will be stripped from the given content.
Basic Usage
See the following example for the default behaviour of this lter:
1 2 3
As result you will get the stripped content My content. When the content contains broken or partial tags then the complete following content will be erased. See the following example:
1 2 3
$filter = new Zend\Filter\StripTags(); print $filter->filter(This contains <a href="http://example.com">no ending tag);
The above will return This contains with the rest being stripped.
Allowing Dened Tags
Zend\Filter\StripTags allows stripping of all but dened tags. This can be used for example to strip all tags but links from a text.
1 2 3 4
$filter = new Zend\Filter\StripTags(array(allowTags => a)); $input = "A text with <br/> a <a href=link.com>link</a>"; print $filter->filter($input);
The above will return A text with a <a href=link.com>link</a> as result. It strips all tags but the link. By providing an array you can set multiple tags at once. Warning: Do not use this feature to get a probably secure content. This component does not replace the use of a proper congured html lter.
$filter = new Zend\Filter\StripTags(array(allowAttribs => src)); $input = "A text with <br/> a <img src=picture.com width=100>picture</img>"; print $filter->filter($input);
484
The above will return A text with a <img src=picture.com>picture</img> as result. It strips all tags but img. Additionally from the img tag all attributes but src will be stripped. By providing an array you can set multiple attributes at once.
109.21 UriNormalize
This lter can set a scheme on an URI, if a scheme is not present. If a scheme is present, that scheme will not be affected, even if a different scheme is enforced. The following options are supported for Zend\Filter\UriNormalize: defaultScheme: This option can be used to set the default scheme to use when parsing scheme-less URIs. enforcedScheme: Set a URI scheme to enforce on schemeless URIs.
Basic Usage
See the following example for the default behaviour of this lter:
1 2 3 4 5
109.21. UriNormalize
485
486
CHAPTER 110
Word Filters
In addition to the standard set of lters, there are several classes specic to ltering word strings.
110.1 CamelCaseToDash
This lter modies a given string such that CamelCaseWords are converted to Camel-Case-Words.
Supported Options
110.2 CamelCaseToSeparator
This lter modies a given string such that CamelCaseWords are converted to Camel Case Words.
Supported Options
The following options are supported for Zend\Filter\Word\CamelCaseToSeparator: separator: A separator char. If this is not set the separator will be a space character.
487
Basic Usage
1 2 3
110.3 CamelCaseToUnderscore
This lter modies a given string such that CamelCaseWords are converted to Camel_Case_Words.
Supported Options
110.4 DashToCamelCase
This lter modies a given string such that words-with-dashes are converted to WordsWithDashes.
Supported Options
488
Basic Usage
110.5 DashToSeparator
This lter modies a given string such that words-with-dashes are converted to words with dashes.
Supported Options
The following options are supported for Zend\Filter\Word\DashToSeparator: separator: A separator char. If this is not set the separator will be a space character.
Basic Usage
1 2 3
110.6 DashToUnderscore
This lter modies a given string such that words-with-dashes are converted to words_with_dashes.
Supported Options
110.5. DashToSeparator
489
Basic Usage
110.7 SeparatorToCamelCase
This lter modies a given string such that words with separators are converted to WordsWithSeparators.
Supported Options
The following options are supported for Zend\Filter\Word\SeparatorToCamelCase: separator: A separator char. If this is not set the separator will be a space character.
Basic Usage
1 2 3
110.8 SeparatorToDash
This lter modies a given string such that words with separators are converted to words-with-separators.
Supported Options
The following options are supported for Zend\Filter\Word\SeparatorToDash: separator: A separator char. If this is not set the separator will be a space character.
490
Basic Usage
1 2 3
110.9 SeparatorToSeparator
This lter modies a given string such that words with separators are converted to words-with-separators.
Supported Options
The following options are supported for Zend\Filter\Word\SeparatorToSeparator: searchSeparator: The search separator char. If this is not set the separator will be a space character. replaceSeparator: The replace separator char. If this is not set the separator will be a dash.
Basic Usage
1 2 3
110.9. SeparatorToSeparator
491
110.10 UnderscoreToCamelCase
This lter modies a given string such that words_with_underscores are converted to WordsWithUnderscores.
Supported Options
110.11 UnderscoreToSeparator
This lter modies a given string such that words_with_underscores are converted to words with underscores.
Supported Options
The following options are supported for Zend\Filter\Word\UnderscoreToSeparator: separator: A separator char. If this is not set the separator will be a space character.
Basic usage
1 2 3
492
110.12 UnderscoreToDash
This lter modies a given string such that words_with_underscores are converted to words-with-underscores.
Supported Options
110.12. UnderscoreToDash
493
494
CHAPTER 111
Zend Framework comes with a set of classes for ltering le contents as well as performing other actions, such as le renaming. Note: All of the File Filter Classes filter() methods support both a le path string or a $_FILES array as the supplied argument. When a $_FILES array is passed in, the tmp_name is used for the le path.
111.1 Decrypt
TODO
111.2 Encrypt
TODO
111.3 Lowercase
TODO
111.4 Rename
Zend\Filter\File\Rename can be used to rename a le and/or move a le to a new path.
Supported Options
The following set of options are supported: target (string) default: "*" Target lename or directory, the new name of the source le.
495
Used to match the ltered le with an options set. overwrite (boolean) default: false Shall existing les be overwritten? target path, a
randomize (boolean) default: false Shall target les have a random postx attached? The random postx will be a uniqid(_) after the le name and before the extension. For example, "file.txt" will be randomized to "file_4b3403665fea6.txt" An array of option sets is also supported, where a single Rename lter instance can lter several les using different options. The options used for the ltered le will be matched from the source option in the options set.
Usage Examples
// target option is assumed if param is a string $filter = \Zend\Filter\File\Rename("/tmp/"); echo $filter->filter("./myfile.txt"); // File has been moved to "/tmp/myfile.txt"
$filter = \Zend\Filter\File\Rename(array( "target" => "/tmp/newfile.txt", "randomize" => true, )); echo $filter->filter("./myfile.txt"); // File has been renamed to "/tmp/newfile_4b3403665fea6.txt"
$filter = \Zend\Filter\File\Rename(array( array( "source" => "fileA.txt" "target" => "/dest1/newfileA.txt", "overwrite" => true, ), array( "source" => "fileB.txt" "target" => "/dest2/newfileB.txt", "randomize" => true, ), )); echo $filter->filter("fileA.txt"); // File has been renamed to "/dest1/newfileA.txt" echo $filter->filter("fileB.txt"); // File has been renamed to "/dest2/newfileB_4b3403665fea6.txt"
496
Public Methods
The specic public methods for the Rename lter, besides the common filter() method, are as follows: getFile() Returns the les to rename and their new name and location Return type array setFile(string|array $options) Sets the le options for renaming. Removes any previously set le options. Parameters $options See Supported Options section for more information. addFile(string|array $options) Adds le options for renaming to the current list of le options. Parameters $options See Supported Options section for more information.
111.5 RenameUpload
Zend\Filter\File\RenameUpload can be used to rename or move an uploaded le to a new path.
Supported Options
The following set of options are supported: target (string) default: "*" Target directory or full lename path. false Shall existing les be overwritten? target path, a
randomize (boolean) default: false Shall target les have a random postx attached? The random postx will be a uniqid(_) after the le name and before the extension. For example, "file.txt" will be randomized to "file_4b3403665fea6.txt" use_upload_name (boolean) default: false When true, this lter will use the $_FILES[name] as the target lename. Otherwise, the default target rules and the $_FILES[tmp_name] will be used. use_upload_extension (boolean) default: original extension if not specied. false When true, the uploaded le will maintains its
For example, if the uploaded le is "file.txt" and the target is something like "mynewfile", the upload will be renamed to "mynewfile.txt". Warning: Be very careful when using the use_upload_name option. For instance, extremely bad things could happen if you were to allow uploaded .php les (or other CGI les) to be moved into the DocumentRoot. It is generally a better idea to supply an internal lename to avoid security risks. RenameUpload does not support an array of options like theRename lter. When ltering HTML5 le uploads with the multiple attribute set, all les will be ltered with the same option settings.
111.5. RenameUpload
497
Usage Examples
use Zend\Http\PhpEnvironment\Request; $request = new Request(); $files = $request->getFiles(); // i.e. $files[my-upload][tmp_name] === /tmp/php5Wx0aJ // i.e. $files[my-upload][name] === myfile.txt // target option is assumed if param is a string $filter = \Zend\Filter\File\RenameUpload("./data/uploads/"); echo $filter->filter($files[my-upload]); // File has been moved to "./data/uploads/php5Wx0aJ" // ... or retain the uploaded file name $filter->setUseUploadName(true); echo $filter->filter($files[my-upload]); // File has been moved to "./data/uploads/myfile.txt"
use Zend\Http\PhpEnvironment\Request; $request = new Request(); $files = $request->getFiles(); // i.e. $files[my-upload][tmp_name] === /tmp/php5Wx0aJ $filter = \Zend\Filter\File\Rename("./data/uploads/newfile.txt"); echo $filter->filter($files[my-upload]); // File has been renamed to "./data/uploads/newfile.txt"
use Zend\Http\PhpEnvironment\Request; $request = new Request(); $files = $request->getFiles(); // i.e. $files[my-upload][tmp_name] === /tmp/php5Wx0aJ $filter = \Zend\Filter\File\Rename(array( "target" => "./data/uploads/newfile.txt", "randomize" => true, )); echo $filter->filter($files[my-upload]); // File has been renamed to "./data/uploads/newfile_4b3403665fea6.txt"
111.6 Uppercase
TODO
498
CHAPTER 112
Filter Chains
Often multiple lters should be applied to some value in a particular order. For example, a login form accepts a username that should be only lowercase, alphabetic characters. Zend\Filter\FilterChain provides a simple method by which lters may be chained together. The following code illustrates how to chain together two lters for the submitted username:
1 2 3 4 5 6 7
// Create a filter chain and add filters to the chain $filterChain = new Zend\Filter\FilterChain(); $filterChain->attach(new Zend\Filter\Alpha()) ->attach(new Zend\Filter\StringToLower()); // Filter the username $username = $filterChain->filter($_POST[username]);
Filters are run in the order they were added to Zend\Filter\FilterChain. In the above example, the username is rst removed of any non-alphabetic characters, and then any uppercase characters are converted to lowercase. Any object that implements Zend\Filter\FilterInterface may be used in a lter chain.
// Create a filter chain and add filters to the chain $filterChain = new Zend\Filter\FilterChain(); $filterChain->attach(new Zend\Filter\Alpha()) ->attach(new Zend\Filter\StringToLower(), 500);
499
lter within the FilterPluginManager. The second parameter takes any options for creating the lter instance. The third parameter is the priority.
1 2 3 4
// Create a filter chain and add filters to the chain $filterChain = new Zend\Filter\FilterChain(); $filterChain->attachByName(alpha) ->attachByName(stringtolower, array(encoding => utf-8), 500);
The following example shows how to add a custom lter to the FilterPluginManager and the FilterChain.
1 2 3 4 5 6
500
CHAPTER 113
Zend\Filter\Inector
Zend\Filter\Inflector is a general purpose tool for rules-based inection of strings to a given target. As an example, you may nd you need to transform MixedCase or camelCasedWords into a path; for readability, OS policies, or other reasons, you also need to lower case this, and you want to separate the words using a dash (-). An inector can do this for you. Zend\Filter\Inflector implements Zend\Filter\FilterInterface; you perform inection by calling filter() on the object instance.
Transforming MixedCase and camelCaseText to another format $inflector = new Zend\Filter\Inflector(pages/:page.:suffix); $inflector->setRules(array( :page => array(Word\CamelCaseToDash, StringToLower), suffix => html, )); $string = camelCasedWords; $filtered = $inflector->filter(array(page => $string)); // pages/camel-cased-words.html $string = this_is_not_camel_cased; $filtered = $inflector->filter(array(page => $string)); // pages/this_is_not_camel_cased.html
1 2 3 4 5 6 7 8 9 10 11 12 13
113.1 Operation
An inector requires a target and one or more rules. A target is basically a string that denes placeholders for variables you wish to substitute. These are specied by prexing with a :: :script. When calling filter(), you then pass in an array of key and value pairs corresponding to the variables in the target. Each variable in the target can have zero or more rules associated with them. Rules may be either static or refer to a Zend\Filter class. Static rules will replace with the text provided. Otherwise, a class matching the rule provided will be used to inect the text. Classes are typically specied using a short name indicating the lter name stripped of any common prex.
501
As an example, you can use any Zend\Filter concrete implementations; however, instead of referring to them as Zend\Filter\Alpha or Zend\Filter\StringToLower, youd specify only Alpha or StringToLower.
To use custom lters, you have two choices: reference them by fully qualied class name (e.g., My\Custom\Filter\Mungify), or manipulate the composed FilterPluginManager instance.
1 2
// Via constructor: $inflector = new Zend\Filter\Inflector(#foo/#bar.#sfx, null, #); // Via accessor: $inflector->setTargetReplacementIdentifier(#);
Typically, you will set the target via the constructor. However, you may want to re-set the target later. setTarget() can be used for this purpose:
1
$inflector->setTarget(layouts/:script.phtml);
Additionally, you may wish to have a class member for your class that you can use to keep the inector target updated without needing to directly update the target each time (thus saving on method calls). setTargetReference() allows you to do this:
1 2 3 4 5 6 7 8 9 10 11
class Foo { /** * @var string Inflector target */ protected $_target = foo/:bar/:baz.:suffix; /** * Constructor * @return void */
502
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
public function __construct() { $this->_inflector = new Zend\Filter\Inflector(); $this->_inflector->setTargetReference($this->_target); } /** * Set target; updates target in inflector * * @param string $target * @return Foo */ public function setTarget($target) { $this->_target = $target; return $this; } }
Much like the target itself, you can also bind a static rule to a reference, allowing you to update a single variable instead of require a method call; this is often useful when your class uses an inector internally, and you dont want your users to need to fetch the inector in order to update it. The setStaticRuleReference() method is used to accomplish this:
1 2 3 4 5 6 7
503
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
/** * Constructor * @return void */ public function __construct() { $this->_inflector = new Zend\Filter\Inflector(:script.:suffix); $this->_inflector->setStaticRuleReference(suffix, $this->_suffix); } /** * Set suffix; updates suffix static rule in inflector * * @param string $suffix * @return Foo */ public function setSuffix($suffix) { $this->_suffix = $suffix; return $this; } }
$inflector = new Zend\Filter\Inflector(:script.:suffix); // Set rule to use Zend\Filter\Word\CamelCaseToDash filter $inflector->setFilterRule(script, Word\CamelCaseToDash); // Add rule to lowercase string $inflector->addFilterRule(script, new Zend\Filter\StringToLower()); // Set rules en-masse $inflector->setFilterRule(script, array( Word\CamelCaseToDash, new Zend\Filter\StringToLower() ));
504
1 2 3 4 5 6 7 8 9
505
pluginManager species the Zend\Filter\FilterPluginManager instance or extension to use for obtaining plugins; alternately, you may specify a class name of a class that extends the FilterPluginManager. throwTargetExceptionsOn should be a boolean indicating whether or not to throw exceptions when a replacement identier is still present after inection. targetReplacementIdentifier species the character to use when identifying replacement variables in the target string. rules species an array of inection rules; it should consist of keys that specify either values or arrays of values, consistent with addRules().
Using a Traversable or an array with Zend\Filter\Inflector // With the constructor: $options; // implements Traversable $inflector = new Zend\Filter\Inflector($options); // Or with setOptions(): $inflector = new Zend\Filter\Inflector(); $inflector->setOptions($options);
1 2 3 4 5 6 7
506
CHAPTER 114
Writing Filters
Zend\Filter supplies a set of commonly needed lters, but developers will often need to write custom lters for their particular use cases. The task of writing a custom lter is facilitated by implementing Zend\Filter\FilterInterface. Zend\Filter\FilterInterface denes a single method, filter(), that may be implemented by user classes. The following example demonstrates how to write a custom lter:
1 2 3 4 5 6 7 8 9 10 11 12 13
namespace Application\Filter; use Zend\Filter\FilterInterface; class MyFilter implements FilterInterface { public function filter($value) { // perform some transformation upon $value to arrive on $valueFiltered return $valueFiltered; } }
507
508
CHAPTER 115
Introduction to Zend\Form
Zend\Form is intended primarily as a bridge between your domain models and the View Layer. It composes a thin layer of objects representing form elements, an InputFilter, and a small number of methods for binding data to and from the form and attached objects. The Zend\Form component consists of the following objects: Elements, which simply consist of a name and attributes. Fieldsets, which extend from Elements, but allow composing other eldsets and elements. Forms, which extend from Fieldsets (and thus Elements). They provide data and object binding, and compose InputFilters. Data binding is done via ZendStdlibHydrator. To facilitate usage with the view layer, the Zend\Form component also aggregates a number of form-specic view helpers. These accept elements, eldsets, and/or forms, and use the attributes they compose to render markup. A small number of specialized elements are provided for accomplishing application-centric tasks. These include the Csrf element, used to prevent Cross Site Request Forgery attacks, and the Captcha element, used to display and validate CAPTCHAs. A Factory is provided to facilitate creation of elements, eldsets, forms, and the related input lter. The default Form implementation is backed by a factory to facilitate extension and ease the process of form creation. The code related to forms can often spread between a variety of concerns: a form denition, an input lter definition, a domain model class, and one or more hydrator implementations. As such, nding the various bits of code and how they relate can become tedious. To simplify the situation, you can also annotate your domain model class, detailing the various input lter denitions, attributes, and hydrators that should all be used together. Zend\Form\Annotation\AnnotationBuilder can then be used to build the various objects you need.
509
510
CHAPTER 116
Forms are relatively easy to create. At the bare minimum, each element or eldset requires a name; typically, youll also provide some attributes to hint to the view layer how it might render the item. The form itself will also typically compose an InputFilter which you can also conveniently create directly in the form via a factory. Individual elements can hint as to what defaults to use when generating a related input for the input lter. Form validation is as easy as providing an array of data to the setData() method. If you want to simplify your work even more, you can bind an object to the form; on successful validation, it will be populated from the validated values.
$name = new Element(name); $name->setLabel(Your name); $name->setAttributes(array( type => text )); $email = new Element\Email(email); $email->setLabel(Your email address); $subject = new Element(subject); $subject->setLabel(Subject); $subject->setAttributes(array( type => text )); $message = new Element\Textarea(message); $message->setLabel(Message);
511
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
$captcha = new Element\Captcha(captcha); $captcha->setCaptcha(new Captcha\Dumb()); $captcha->setLabel(Please verify you are human); $csrf = new Element\Csrf(security); $send = new Element(send); $send->setValue(Submit); $send->setAttributes(array( type => submit ));
$form = new Form(contact); $form->add($name); $form->add($email); $form->add($subject); $form->add($message); $form->add($captcha); $form->add($csrf); $form->add($send); $nameInput = new Input(name); // configure input... and all others $inputFilter = new InputFilter(); // attach all inputs $form->setInputFilter($inputFilter);
As a demonstration of eldsets, lets alter the above slightly. Well create two eldsets, one for the sender information, and another for the message details.
1 2 3 4 5 6 7 8 9 10 11 12 13 14
$sender = new Fieldset(sender); $sender->add($name); $sender->add($email); $details = new Fieldset(details); $details->add($subject); $details->add($message); $form = new Form(contact); $form->add($sender); $form->add($details); $form->add($captcha); $form->add($csrf); $form->add($send);
512
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
use Zend\Form\Factory; $factory = new Factory(); $form = $factory->createForm(array( hydrator => Zend\Stdlib\Hydrator\ArraySerializable, elements => array( array( spec => array( name => name, options => array( label => Your name, ), type => Text, ) ), array( spec => array( type => Zend\Form\Element\Email, name => email, options => array( label => Your email address, ) ), ), array( spec => array( name => subject, options => array( label => Subject, ), type => Text, ), ), array( spec => array( type => Zend\Form\Element\Textarea, name => message, options => array( label => Message, ) ), ), array( spec => array( type => Zend\Form\Element\Captcha, name => captcha, options => array( label => Please verify you are human., captcha => array( class => Dumb, ), ), ), ), array( spec => array( type => Zend\Form\Element\Csrf, name => security,
513
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
), ), array( spec => array( name => send, type => Submit, attributes => array( value => Submit, ), ), ), ), /* If we had fieldsets, theyd go here; fieldsets contain * "elements" and "fieldsets" keys, and potentially a "type" * key indicating the specific FieldsetInterface * implementation to use. fieldsets => array( ), */ // Configuration to pass on to // Zend\InputFilter\Factory::createInputFilter() input_filter => array( /* ... */ ), ));
If we wanted to use eldsets, as we demonstrated in the previous example, we could do the following:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
use Zend\Form\Factory; $factory = new Factory(); $form = $factory->createForm(array( hydrator => Zend\Stdlib\Hydrator\ArraySerializable, fieldsets => array( array( spec => array( name => sender, elements => array( array( spec => array( name => name, options => array( label => Your name, ), type => Text ), ), array( spec => array( type => Zend\Form\Element\Email, name => email, options => array( label => Your email address, ), ), ), ), ),
514
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
), array( spec => array( name => details, elements => array( array( spec => array( name => subject, options => array( label => Subject, ), type => Text, ), ), array( spec => array( name => message, type => Zend\Form\Element\Textarea, options => array( label => Message, ), ), ), ), ), ), ), elements => array( array( spec => array( type => Zend\Form\Element\Captcha, name => captcha, options => array( label => Please verify you are human. , captcha => array( class => Dumb, ), ), ), ), array( spec => array( type => Zend\Form\Element\Csrf, name => security, ), ), array( spec => array( name => send, type => Submit, attributes => array( value => Submit, ), ), ), ), // Configuration to pass on to // Zend\InputFilter\Factory::createInputFilter()
515
89 90 91 92
Note that the chief difference is nesting; otherwise, the information is basically the same. The chief benets to using the Factory are allowing you to store denitions in conguration, and usage of signicant whitespace.
namespace Contact; use Zend\Captcha\AdapterInterface as CaptchaAdapter; use Zend\Form\Element; use Zend\Form\Form; class ContactForm extends Form { protected $captcha; public function __construct(CaptchaAdapter $captcha) { $this->captcha = $captcha; // add() can take either an Element/Fieldset instance, // or a specification, from which the appropriate object // will be built. $this->add(array( name => name, options => array( label => Your name, ), type => Text, )); $this->add(array( type => Zend\Form\Element\Email, name => email, options => array( label => Your email address, ), )); $this->add(array( name => subject, options => array( label => Subject, ), type => Text, )); $this->add(array(
516
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
type => Zend\Form\Element\Textarea, name => message, options => array( label => Message, ), )); $this->add(array( type => Zend\Form\Element\Captcha, name => captcha, options => array( label => Please verify you are human., captcha => $this->captcha, ), )); $this->add(new Element\Csrf(security)); $this->add(array( name => send, type => Submit, attributes => array( value => Submit, ), )); // We could also define the input filter here, or // lazy-create it in the getInputFilter() method. } }
Youll note that this example, the elements are added in the constructor. This is done to allow altering and/or conguring either the form or input lter factory instances, which could then have bearing on how elements, inputs, etc. are created. In this case, it also allows injection of the CAPTCHA adapter, allowing us to congure it elsewhere in our application and inject it into the form.
$form = new Contact\ContactForm(); // If the form doesnt define an input filter by default, inject one. $form->setInputFilter(new Contact\ContactFilter()); // Get the data. In an MVC application, you might try: $data = $request->getPost(); // for POST data $data = $request->getQuery(); // for GET (or query string) data $form->setData($data); // Validate the form if ($form->isValid()) { $validatedData = $form->getData(); } else { $messages = $form->getMessages(); }
517
You can get the raw data if you want, by accessing the composed input lter.
1 2 3 4
namespace Zend\Form\Element; use use use use Zend\Form\Element; Zend\InputFilter\InputProviderInterface; Zend\Validator\Regex as RegexValidator; Zend\Validator\ValidatorInterface;
/** Zend * @category Zend_Form * @package * @subpackage Element */ class Color extends Element implements InputProviderInterface { /** * Seed attributes * * @var array */ protected $attributes = array( type => color, ); /** * @var ValidatorInterface */ protected $validator; /** * Get validator * * @return ValidatorInterface
518
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
*/ protected function getValidator() { if (null === $this->validator) { $this->validator = new RegexValidator(/^#[0-9a-fA-F]{6}$/); } return $this->validator; } /** * Provide default input rules for this element * * Attaches an email validator. * * @return array */ public function getInputSpecification() { return array( name => $this->getName(), required => true, filters => array( array(name => Zend\Filter\StringTrim), array(name => Zend\Filter\StringToLower), ), validators => array( $this->getValidator(), ), ); } }
The above would hint to the input lter to create and attach an input named after the element, marking it as required, and giving it a StringTrim and StringToLower lters and a Regex validator. Note that you can either rely on the input lter to create lters and validators, or directly instantiate them. For eldsets, you do very similarly; the difference is that getInputFilterSpecification() must return conguration for an input lter.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
namespace Contact\Form; use Zend\Form\Fieldset; use Zend\InputFilter\InputFilterProviderInterface; use Zend\Validator; class SenderFieldset extends Fieldset implements InputFilterProviderInterface { public function getInputFilterSpecification() { return array( name => array( required => true, filters => array( array(name => Zend\Filter\StringTrim), ), ), email => array( required => true, filters => array(
519
21 22 23 24 25 26 27 28 29
Specications are a great way to make forms, eldsets, and elements re-usable trivially in your applications. In fact, the Captcha and Csrf elements dene specications in order to ensure they can work without additional user conguration!
$contact = new ArrayObject; $contact[subject] = [Contact Form] ; $contact[message] = Type your message here; $form = new Contact\ContactForm;
$form->bind($contact); // form now has default values for // subject and message $data = array( name => John Doe, email => j.doe@example.tld, subject => [Contact Form] \sup?, ); $form->setData($data); if ($form->isValid()) { // $contact now looks like: // array( // name => John Doe, // email => j.doe@example.tld, // subject => [Contact Form] \sup?,
520
23 24 25 26
When an object is bound to the form, calling getData() will return that object by default. If you want to return an associative array instead, you can pass the FormInterface::VALUES_AS_ARRAY ag to the method.
1 2
Zend Framework ships several standard hydrators, and implementation is as simple as implementing Zend\Stdlib\Hydrator\HydratorInterface, which looks like this:
1 2 3 4 5 6 7 8
namespace Zend\Stdlib\Hydrator; interface HydratorInterface { /** @return array */ public function extract($object); public function hydrate(array $data, $object); }
116.7 Rendering
As noted previously, forms are meant to bridge the domain model and view layer. Weve discussed the domain model binding, but what about the view? The form component ships a set of form-specic view helpers. These accept the various form objects, and introspect them in order to generate markup. Typically, they will inspect the attributes, but in special cases, they may look at other properties and composed objects. When preparing to render, you will likely want to call prepare(). This method ensures that certain injections are done, and will likely in the future munge names to allow for scoped[array][notation]. The simplest view helpers available are Form, FormElement, FormLabel, and FormElementErrors. Lets use them to display the contact form.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
<?php // within a view script $form = $this->form; $form->prepare(); // Assuming the "contact/process" route exists... $form->setAttribute(action, $this->url(contact/process)); // Set the method attribute for the form $form->setAttribute(method, post); // Get the form label plugin $formLabel = $this->plugin(formLabel); // Render the opening tag echo $this->form()->openTag($form); ?> <div class="form_element"> <?php
116.7. Rendering
521
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
$name = $form->get(name); echo $formLabel->openTag() . $name->getOption(label); echo $this->formInput($name); echo $this->formElementErrors($name); echo $formLabel->closeTag(); ?></div> <div class="form_element"> <?php $subject = $form->get(subject); echo $formLabel->openTag() . $subject->getOption(label); echo $this->formInput($subject); echo $this->formElementErrors($subject); echo $formLabel->closeTag(); ?></div> <div class="form_element"> <?php $message = $form->get(message); echo $formLabel->openTag() . $message->getOption(label); echo $this->formTextarea($message); echo $this->formElementErrors($message); echo $formLabel->closeTag(); ?></div> <div class="form_element"> <?php $captcha = $form->get(captcha); echo $formLabel->openTag() . $captcha->getOption(label); echo $this->formCaptcha($captcha); echo $this->formElementErrors($captcha); echo $formLabel->closeTag(); ?></div> <?php echo $this->formElement($form->get(security)) ?> <?php echo $this->formElement($form->get(send)) ?> <?php echo $this->form()->closeTag() ?>
There are a few things to note about this. First, to prevent confusion in IDEs and editors when syntax highlighting, we use helpers to both open and close the form and label tags. Second, theres a lot of repetition happening here; we could easily create a partial view script or a composite helper to reduce boilerplate. Third, note that not all elements are created equal the CSRF and submit elements dont need labels or error messages necessarily. Finally, note that the FormElement helper tries to do the right thing it delegates actual markup generation to other view helpers; however, it can only guess what specic form helper to delegate to based on the list it has. If you introduce new form view helpers, youll need to extend the FormElement helper, or create your own. However, your view les can quickly become long and repetitive to write. While we do not currently provide a singleline form view helper (as this reduces the form customization), the simplest and most recommended way to render your form is by using the FormRow view helper. This view helper automatically renders a label (if present), the element itself using the FormElement helper, as well as any errors that could arise. Here is the previous form, rewritten to take advantage of this helper :
1 2 3 4 5
522
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
// Assuming the "contact/process" route exists... $form->setAttribute(action, $this->url(contact/process)); // Set the method attribute for the form $form->setAttribute(method, post); // Render the opening tag echo $this->form()->openTag($form); ?> <div class="form_element"> <?php $name = $form->get(name); echo $this->formRow($name); ?></div> <div class="form_element"> <?php $subject = $form->get(subject); echo $this->formRow($subject); ?></div> <div class="form_element"> <?php $message = $form->get(message); echo $this->formRow($message); ?></div> <div class="form_element"> <?php $captcha = $form->get(captcha); echo $this->formRow($captcha); ?></div> <?php echo $this->formElement($form->get(security)) ?> <?php echo $this->formElement($form->get(send)) ?> <?php echo $this->form()->closeTag() ?>
Note that FormRow helper automatically prepends the label. If you want it to be rendered after the element itself, you can pass an optional parameter to the FormRow view helper :
1 2 3 4 5
$form->add(array( name => phoneNumber, options => array( label => Your phone number
116.7. Rendering
523
5 6 7 8 9 10 11
), attributes => array( type => tel required => required, pattern => ^0[1-68]([-. ]?[0-9]{2}){4}$ ) ));
View helpers will automatically render those attributes, and hence allowing modern browsers to perform automatic validation. Note: Although client validation is nice from a user experience point of view, it has to be used in addition with server validation, as client validation can be easily fooled.
$form->setValidationGroup(name, email, subject, message); $form->setData($data); if ($form->isValid()) { // Contains only the "name", "email", "subject", and "message" values $data = $form->getData(); }
If you later want to reset the form to validate all, simply pass the FormInterface::VALIDATE_ALL ag to the setValidationGroup() method.
1 2
When your form contains nested eldsets, you can use an array notation to validate only a subset of the eldsets :
1 2 3 4 5 6 7 8 9 10 11 12
$form->setValidationGroup(array( profile => array( firstname, lastname ) )); $form->setData($data); if ($form->isValid()) { // Contains only the "firstname" and "lastname" values from the // "profile" fieldset $data = $form->getData(); }
524
525
"doctrine/common": ">=2.1",
Then run php composer.phar update to install the dependency. If youre not using Composer, visit the Doctrine project website for more details on installation. Heres a simple example.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
use Zend\Form\Annotation; /** * @Annotation\Name("user") * @Annotation\Hydrator("Zend\Stdlib\Hydrator\ObjectProperty") */ class User { /** * @Annotation\Exclude() */ public $id;
/** * @Annotation\Filter({"name":"StringTrim"}) * @Annotation\Validator({"name":"StringLength", "options":{"min":1, "max":25}}) * @Annotation\Validator({"name":"Regex", "options":{"pattern":"/^[a-zA-Z][a-zA-Z0-9_-]{0,24}$/"} * @Annotation\Attributes({"type":"text"}) * @Annotation\Options({"label":"Username:"}) */ public $username; /** * @Annotation\Type("Zend\Form\Element\Email") * @Annotation\Options({"label":"Your email address:"}) */ public $email; }
The above will hint to the annotation build to create a form with name user, which uses the hydrator Zend\Stdlib\Hydrator\ObjectProperty. That form will have two elements, username and email. The username element will have an associated input that has a StringTrim lter, and two validators: a StringLength validator indicating the username is between 1 and 25 characters, and a Regex validator asserting it follows a specic accepted pattern. The form element itself will have an attribute type with value text (a text element), and a label Username:. The email element will be of type Zend\Form\Element\Email, and have the label Your email address:. To use the above, we need Zend\Form\Annotation\AnnotationBuilder:
1 2 3 4
At this point, you have a form with the appropriate hydrator attached, an input lter with the appropriate inputs, and all elements. Note: Youre not done In all likelihood, youll need to add some more elements to the form you construct. For example, youll want a submit
526
button, and likely a CSRF-protection element. We recommend creating a eldset with common elements such as these that you can then attach to the form you build via annotations.
527
528
CHAPTER 117
Form Collections
Often, eldsets or elements in your forms will correspond to other domain objects. In some cases, they may correspond to collections of domain objects. In this latter case, in terms of user interfaces, you may want to add items dynamically in the user interface a great example is adding tasks to a task list. This document is intended to demonstrate these features. To do so, we rst need to dene some domain objects that well be using.
namespace Application\Entity; class Product { /** * @var string */ protected $name; /** * @var int */ protected $price; /** * @var Brand */ protected $brand; /** * @var array */ protected $categories; /** * @param string $name * @return Product */ public function setName($name) { $this->name = $name; return $this; }
529
/** * @return string */ public function getName() { return $this->name; } /** * @param int $price * @return Product */ public function setPrice($price) { $this->price = $price; return $this; } /** * @return int */ public function getPrice() { return $this->price; } /** * @param Brand $brand * @return Product */ public function setBrand(Brand $brand) { $this->brand = $brand; return $this; } /** * @return Brand */ public function getBrand() { return $this->brand; } /** * @param array $categories * @return Product */ public function setCategories(array $categories) { $this->categories = $categories; return $this; } /** * @return array */ public function getCategories()
530
{ return $this->categories; } } class Brand { /** * @var string */ protected $name; /** * @var string */ protected $url; /** * @param string $name * @return Brand */ public function setName($name) { $this->name = $name; return $this; } /** * @return string */ public function getName() { return $this->name; } /** * @param string $url * @return Brand */ public function setUrl($url) { $this->url = $url; return $this; } /** * @return string */ public function getUrl() { return $this->url; } } class Category { /** * @var string
531
*/ protected $name; /** * @param string $name * @return Category */ public function setName($name) { $this->name = $name; return $this; } /** * @return string */ public function getName() { return $this->name; } }
As you can see, this is really simple code. A Product has two scalar properties (name and price), a OneToOne relationship (one product has one brand), and a OneToMany relationship (one product has many categories).
class BrandFieldset extends Fieldset implements InputFilterProviderInterface { public function __construct() { parent::__construct(brand); $this->setHydrator(new ClassMethodsHydrator(false)) ->setObject(new Brand()); $this->add(array( name => name, options => array( label => Name of the brand ), attributes => array( required => required ) )); $this->add(array(
532
name => url, type => Zend\Form\Element\Url, options => array( label => Website of the brand ), attributes => array( required => required ) )); } /** * @return array */ public function getInputFilterSpecification() { return array( name => array( required => true, ) ); } }
We can discover some new things here. As you can see, the eldset calls the method setHydrator(), giving it a ClassMethods hydrator, and the setObject() method, giving it an empty instance of a concrete Brand object. When the data will be validated, the Form will automatically iterate through all the eld sets it contains, and automatically populate the sub-objects, in order to return a complete entity. Also notice that the Url element has a type of Zend\Form\Element\Url. This information will be used to validate the input eld. You dont need to manually add lters or validators for this input as that element provides a reasonable input specication. Finally, getInputFilterSpecification() gives the specication for the remaining input (name), indicating that this input is required. Note that required in the array attributes (when elements are added) is only meant to add the required attribute to the form markup (and therefore has semantic meaning only). Here is the Category eldset:
namespace Application\Form; use use use use Application\Entity\Category; Zend\Form\Fieldset; Zend\InputFilter\InputFilterProviderInterface; Zend\Stdlib\Hydrator\ClassMethods as ClassMethodsHydrator;
class CategoryFieldset extends Fieldset implements InputFilterProviderInterface { public function __construct() { parent::__construct(category); $this->setHydrator(new ClassMethodsHydrator(false)) ->setObject(new Category()); $this->setLabel(Category); $this->add(array( name => name,
533
options => array( label => Name of the category ), attributes => array( required => required ) )); } /** * @return array */ public function getInputFilterSpecification() { return array( name => array( required => true, ) ); } }
class ProductFieldset extends Fieldset implements InputFilterProviderInterface { public function __construct() { parent::__construct(product); $this->setHydrator(new ClassMethodsHydrator(false)) ->setObject(new Product()); $this->add(array( name => name, options => array( label => Name of the product ), attributes => array( required => required ) )); $this->add(array( name => price, options => array( label => Price of the product ), attributes => array( required => required )
534
)); $this->add(array( type => Application\Form\BrandFieldset, name => brand, options => array( label => Brand of the product ) )); $this->add(array( type => Zend\Form\Element\Collection, name => categories, options => array( label => Please choose categories for this product, count => 2, should_create_template => true, allow_add => true, target_element => array( type => Application\Form\CategoryFieldset ) ) )); } /** * Should return an array specification compatible with * {@link Zend\InputFilter\Factory::createInputFilter()}. * * @return array */ public function getInputFilterSpecification() { return array( name => array( required => true, ), price => array( required => true, validators => array( array( name => Float ) ) ) ); } }
We have a lot of new things here! First, notice how the brand element is added: we specify it to be of type Application\Form\BrandFieldset. This is how you handle a OneToOne relationship. When the form is validated, the BrandFieldset will rst be populated, and will return a Brand entity (as we have specied a ClassMethods hydrator, and bound the eldset to a Brand entity using the setObject() method). This Brand entity will then be used to populate the Product entity by calling the setBrand() method. The next element shows you how to handle OneToMany relationship. The type is Zend\Form\Element\Collection, which is a specialized element to handle such cases. As you can 117.1. Creating Fieldsets 535
see, the name of the element (categories) perfectly matches the name of the property in the Product entity. This element has a few interesting options: count: this is how many times the element (in this case a category) has to be rendered. Weve set it to two in this examples. should_create_template: if set to true, it will generate a template markup in a <span> element, in order to simplify adding new element on the y (we will speak about this one later). allow_add: if set to true (which is the default), dynamically added elements will be retrieved and validated; otherwise, they will be completely ignored. This, of course, depends on what you want to do. target_element: this is either an element or, as this is the case in this example, an array that describes the element or eldset that will be used in the collection. In this case, the target_element is a Category eldset.
536
} }
CreateProduct is quite simple, as it only denes a Product eldset, as well as some other useful elds (CSRF for security, and a Submit button). Notice the use_as_base_fieldset option. This option is here to say to the form: hey, the object I bind to you is, in fact, bound to the eldset that is the base eldset. This will be to true most of the times. Whats cool with this approach is that each entity can have its own Fieldset and can be reused. You describe the elements, the lters, and validators for each entity only once, and the concrete Form instance will only compose those eldsets. You no longer have to add the username input to every form that deals with users!
This is super easy. Nothing to do in the controllers. All the magic is done behind the scene.
537
echo $this->formRow($product->get(price)); echo $this->formCollection($product->get(categories)); $brand = $product->get(brand); echo $this->formRow($brand->get(name)); echo $this->formRow($brand->get(url)); echo $this->formHidden($form->get(csrf)); echo $this->formElement($form->get(submit)); echo $this->form()->closeTag();
A few new things here : the prepare() method. You must call it prior to rendering anything in the view (this function is only meant to be called in views, not in controllers). the FormRow helper renders a label (if present), the input itself, and errors. the FormCollection helper will iterate through every element in the collection, and render every element with the FormRow helper (you may specify an alternate helper if desired, using the setElementHelper() method on that FormCollection helper instance). If you need more control about the way you render your forms, you can iterate through the elements in the collection, and render them manually one by one. Here is the result:
As you can see, collections are wrapped inside a eldset, and every item in the collection is itself wrapped in the eldset. In fact, the Collection element uses label for each item in the collection, while the label of the Collection element itself is used as the legend of the eldset. You must have a label on every element in order to use this feature. If you dont want the eldset created, but just the elements within it, simply add a boolean false as the second parameter of the FormCollection view helper. If you validate, all elements will show errors (this is normal, as weve marked them as required). As soon as the form is valid, this is what we get :
538
As you can see, the bound object is completely lled, not with arrays, but with objects! But thats not all.
As you can see, the collection generates two eldsets (the two categories) plus a span with a data-template attribute that contains the full HTML code to copy to create a new element in the collection. Of course __index__ (this is the placeholder generated) has to be changed to a valid value. Currently, we have 2 elements (categories[0] and categories[1], so __index__ has to be changed to 2. If you want, this placeholder (__index__ is the default) can be changed using the template_placeholder option key:
$this->add(array( type => Zend\Form\Element\Collection, name => categories, options => array( label => Please choose categories for this product, count => 2, should_create_template => true, template_placeholder => __placeholder__, target_element => array( type => Application\Form\CategoryFieldset ) ) ));
539
First, lets add a small button Add new category anywhere in the form:
<button onclick="return add_category()">Add a new category</button>
The add_category function is fairly simple: 1. First, count the number of elements we already have. 2. Get the template from the spans data-template attribute. 3. Change the placeholder to a valid index. 4. Add the element to the DOM. Here is the code:
<script> function add_category() { var currentCount = $(form > fieldset > fieldset).length; var template = $(form > fieldset > span).data(template); template = template.replace(/__index__/g, currentCount); $(form > fieldset).append(template); return false; } </script>
(Note: the above example assumes $() is dened, and equivalent to jQuerys $() function, Dojos dojo.query, etc.) One small remark about the template.replace: the example uses currentCount and not currentCount + 1, as the indices are zero-based (so, if we have two elements in the collection, the third one will have the index 2). Now, if we validate the form, it will automatically take into account this new element by validating it, ltering it and retrieving it:
Of course, if you dont want to allow adding elements in a collection, you must set the option allow_add to false. This way, even if new elements are added, they wont be validated and hence, not added to the entity. Also, if we dont want elements to be added, we dont need the data template, either. Heres how you do it:
540
$this->add(array( type => Zend\Form\Element\Collection, name => categories, options => array( label => Please choose categories for this product, count => 2, should_create_template => false, allow_add => false, target_element => array( type => Application\Form\CategoryFieldset ) ) ));
There are some limitations to this capability: Although you can add new elements and remove them, you CANNOT remove more elements in a collection than the initial count (for instance, if your code species count == 2, you will be able to add a third one and remove it, but you wont be able to remove any others. If the initial count is 2, you must have at least two elements. Dynamically added elements have to be added at the end of the collection. They can be added anywhere (these elements will still be validated and inserted into the entity), but if the validation fails, this newly added element will be automatically be replaced at the end of the collection.
541
The URL input has disappeared, but even if we ll every input, the form wont validate. In fact, this is normal. We specied in the input lter that the URL is a required eld, so if the form does not have it, it wont validate, even though we didnt add it to the view! Of course, you could create a BrandFieldsetWithoutURL eldset, but of course this is not recommended, as a lot of code will be duplicated. The solution: validation groups. A validation group is specied in a Form object (hence, in our case, in the CreateProduct form) by giving an array of all the elements we want to validate. Our CreateProduct now looks like this:
namespace Application\Form; use Zend\Form\Form; use Zend\InputFilter\InputFilter; use Zend\Stdlib\Hydrator\ClassMethods as ClassMethodsHydrator; class CreateProduct extends Form { public function __construct() { parent::__construct(create_product); $this->setAttribute(method, post) ->setHydrator(new ClassMethodsHydrator()) ->setInputFilter(new InputFilter()); $this->add(array( type => Application\Form\ProductFieldset, options => array( use_as_base_fieldset => true ) ));
542
$this->add(array( type => Zend\Form\Element\Csrf, name => csrf )); $this->add(array( name => submit, attributes => array( type => submit, value => Send ) )); $this->setValidationGroup(array( csrf, product => array( name, price, brand => array( name ), categories => array( name ) ) )); } }
Of course, dont forget to add the CSRF element, as we want it to be validated too (but notice that I didnt write the submit element, as we dont care about it). You can recursively select the elements you want. There is one simple limitation currently: validation groups for collections are set on a per-collection basis, not perelement in a collection basis. This means you cannot say, validate the name input for the rst element of the categories collection, but dont validate it for the second one. But, honestly, this is really an edge-case. Now, the form validates (and the URL is set to null as we didnt specify it).
543
544
CHAPTER 118
File Uploading
Zend Framework provides support for le uploading by using features in Zend\Form, Zend\InputFilter, Zend\Validator, Zend\Filter, and Zend\ProgressBar. These reusable framework components provide a convenient and secure way for handling le uploads in your projects. Note: If the reader has experience with le uploading in Zend Framework v1.x, he/she will notice some major differences. Zend_File_Transfer has been deprecated in favor of using the standard ZF2 Zend\Form and Zend\InputFilter features.
Note: The le upload features described here are specically for forms using the POST method. Zend Framework itself does not currently provide specic support for handling uploads via the PUT method, but it is possible with PHP. See the PUT Method Support in the PHP documentation for more information.
545
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
class UploadForm extends Form { public function __construct($name = null, $options = array()) { parent::__construct($name, $options); $this->addElements(); } public function addElements() { // File Input $file = new Element\File(image-file); $file->setLabel(Avatar Image Upload) ->setAttribute(id, image-file); $this->add($file); } }
The File element provides some automatic features that happen behind the scenes: The forms enctype will automatically be set to multipart/form-data when the form prepare() method is called. The le elements default input specication will create the correct Input type: Zend\InputFilter\FileInput. The FileInput will automatically prepend an UploadFile Validator, to securely validate that the le is actually an uploaded le, and to report other types of upload errors to the user.
// File: upload-form.phtml <?php $form->prepare(); // The correct enctype is set here ?> <?php echo $this->form()->openTag($form); ?> <div class="form-element"> <?php $fileElement = $form->get(image-file); ?> <?php echo $this->formLabel($fileElement); ?> <?php echo $this->formFile($fileElement); ?> <?php echo $this->formElementErrors($fileElement); ?> </div> <button>Submit</button> <?php echo $this->form()->closeTag(); ?>
546
// File: MyController.php public function uploadFormAction() { $form = new UploadForm(upload-form); $request = $this->getRequest(); if ($request->isPost()) { // Make certain to merge the files info! $post = array_merge_recursive( $request->getPost()->toArray(), $request->getFiles()->toArray() ); $form->setData($post); if ($form->isValid()) { $data = $form->getData(); // Form is valid, save the form! return $this->redirect()->toRoute(upload-form/success); } } return array(form => $form); }
Note: It is suggested that you always use the Zend\Http\PhpEnvironment\Request object to retrieve and merge the $_FILES information with the form, instead of using $_FILES directly. This is due to how the le information is mapped in the $_FILES array:
// A $_FILES array with single input and multiple files: array(1) { ["image-file"]=>array(2) { ["name"]=>array(2) { [0]=>string(9)"file0.txt" [1]=>string(9)"file1.txt" } ["type"]=>array(2) { [0]=>string(10)"text/plain" [1]=>string(10)"text/html"
547
} } } // How Zend\Http\PhpEnvironment\Request remaps the $_FILES array: array(1) { ["image-file"]=>array(2) { [0]=>array(2) { ["name"]=>string(9)"file0.txt" ["type"]=>string(10)"text/plain" }, [1]=>array(2) { ["name"]=>string(9)"file1.txt" ["type"]=>string(10)"text/html" } } }
// File: UploadForm.php use Zend\InputFilter; use Zend\Form\Element; use Zend\Form\Form; class UploadForm extends Form { public function __construct($name = null, $options = array()) { parent::__construct($name, $options); $this->addElements(); $this->addInputFilter(); } public function addElements() { // File Input $file = new Element\File(image-file);
548
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
$file->setLabel(Avatar Image Upload) ->setAttribute(id, image-file); $this->add($file); } public function addInputFilter() { $inputFilter = new InputFilter\InputFilter(); // File Input $fileInput = new InputFilter\FileInput(image-file); $fileInput->setRequired(true); $fileInput->getFilterChain()->attachByName( filerenameupload, array( target => ./data/tmpuploads/avatar.png, randomize => true, ) ); $inputFilter->add($fileInput); $this->setInputFilter($inputFilter); } }
The filerenameupload options above would cause an uploaded le to be renamed and moved to: ./data/tmpuploads/avatar_4b3403665fea6.png. See the RenameUpload lter documentation for more information on its supported options. 2. And, changing the Controller action to use the fileprg plugin:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
// File: MyController.php public function uploadFormAction() { $form = new UploadForm(upload-form); $tempFile = null; $prg = $this->fileprg($form); if ($prg instanceof \Zend\Http\PhpEnvironment\Response) { return $prg; // Return PRG redirect response } elseif (is_array($prg)) { if ($form->isValid()) { $data = $form->getData(); // Form is valid, save the form! return $this->redirect()->toRoute(upload-form/success); } else { // Form not valid, but file uploads might be valid... // Get the temporary file information to show the user in the view $fileErrors = $form->get(image-file)->getMessages(); if (empty($fileErrors)) { $tempFile = $form->get(image-file)->getValue(); } } } return array( form
=> $form,
549
28 29 30
Behind the scenes, the FilePRG plugin will: Run the Forms lters, namely the RenameUpload lter, to move the les out of temporary storage. Store the valid POST data in the session across requests. Change the required ag of any le inputs that had valid uploads to false. This is so that form resubmissions without uploads will not cause validation errors. Note: In the case of a partially valid form, it is up to the developer whether to notify the user that les have been uploaded or not. For example, you may wish to hide the form input and/or display the le information. These things would be implementation details in the view or in a custom view helper. Just note that neither the FilePRG plugin nor the formFile view helper will do any automatic notications or view changes when les have been successfully uploaded.
// File: UploadForm.php use Zend\InputFilter; use Zend\Form\Element; use Zend\Form\Form; class UploadForm extends Form { public function __construct($name = null, $options = array()) { parent::__construct($name, $options); $this->addElements(); $this->addInputFilter(); } public function addElements() { // File Input $file = new Element\File(image-file); $file->setLabel(Avatar Image Upload) ->setAttribute(id, image-file) ->setAttribute(multiple, true); $this->add($file); }
// Thats it
550
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
// File Input $fileInput = new InputFilter\FileInput(image-file); $fileInput->setRequired(true); // You only need to define validators and filters // as if only one file was being uploaded. All files // will be run through the same validators and filters // automatically. $fileInput->getValidatorChain() ->attachByName(filesize, array(max => 204800)) ->attachByName(filemimetype, array(mimeType => image/png,image/x-png)) ->attachByName(fileimagesize, array(maxWidth => 100, maxHeight => 100)); // All files will be renamed, i.e.: // ./data/tmpuploads/avatar_4b3403665fea6.png, // ./data/tmpuploads/avatar_5c45147660fb7.png $fileInput->getFilterChain()->attachByName( filerenameupload, array( target => ./data/tmpuploads/avatar.png, randomize => true, ) ); $inputFilter->add($fileInput); $this->setInputFilter($inputFilter); } }
You do not need to do anything special with the validators and lters to support multiple le uploads. All of the les that are uploaded will have the same validators and lters run against them automatically (from logic within FileInput). You only need to dene them as if one le was being uploaded.
551
When uploading a le with a form POST, you must also include the progress identier in a hidden input. The File Upload Progress View Helpers provide a convenient way to add the hidden input based on your handler type.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
// File: upload-form.phtml <?php $form->prepare(); ?> <?php echo $this->form()->openTag($form); ?> <?php echo $this->formFileSessionProgress(); // Must come before the file input! ?> <div class="form-element"> <?php $fileElement = $form->get(image-file); ?> <?php echo $this->formLabel($fileElement); ?> <?php echo $this->formFile($fileElement); ?> <?php echo $this->formElementErrors($fileElement); ?> </div> <button>Submit</button> <?php echo $this->form()->closeTag(); ?>
There are a few different methods for getting progress information to the browser (long vs. short polling). Here we will use short polling since it is simpler and less taxing on server resources, though keep in mind it is not as responsive as long polling. When our form is submitted via AJAX, the browser will continuously poll the server for upload progress. The following is an example Controller action which provides the progress information:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
// File: MyController.php public function uploadProgressAction() { $id = $this->params()->fromQuery(id, null); $progress = new \Zend\ProgressBar\Upload\SessionProgress(); return new \Zend\View\Model\JsonModel($progress->getProgress($id)); } // Returns JSON //{ // "total" // "current" // "rate" // "message" // "done" //}
: : : : :
552
Warning: This is not the most efcient way of providing upload progress, since each polling request must go through the Zend Framework bootstrap process. A better example would be to use a standalone php le in the public folder that bypasses the MVC bootstrapping and only uses the essential Zend\ProgressBar adapters. Back in our view template, we will add the JavaScript to perform the AJAX POST of the form data, and to start a timeout interval for the progress polling. To keep the example code relatively short, we are using the jQuery Form plugin to do the AJAX form POST. If your project uses a different JavaScript framework (or none at all), this will hopefully at least illustrate the necessary high-level logic that would need to be performed.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
// File: upload-form.phtml // ...after the form... <!-- Twitter Bootstrap progress bar styles: http://twitter.github.com/bootstrap/components.html#progress --> <div id="progress" class="help-block"> <div class="progress progress-info progress-striped"> <div class="bar"></div> </div> <p></p> </div> <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js"></script> <script src="/js/jquery.form.js"></script> <script> var progressInterval; function getProgress() { // Poll our controller action with the progress id var url = /upload-form/upload-progress?id= + $(#progress_key).val(); $.getJSON(url, function(data) { if (data.status && !data.status.done) { var value = Math.floor((data.status.current / data.status.total) * 100); showProgress(value, Uploading...); } else { showProgress(100, Complete!); clearInterval(progressInterval); } }); } function startProgress() { showProgress(0, Starting upload...); progressInterval = setInterval(getProgress, 900); } function showProgress(amount, message) { $(#progress).show(); $(#progress .bar).width(amount + %); $(#progress > p).html(message); if (amount < 100) { $(#progress .progress) .addClass(progress-info active) .removeClass(progress-success); } else { $(#progress .progress) .removeClass(progress-info active) .addClass(progress-success);
553
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
} } $(function() { // Register a submit event listener on the form to perform the AJAX POST $(#upload-form).on(submit, function(e) { e.preventDefault(); if ($(#image-file).val() == ) { // No files selected, abort return; } // Perform the submit //$.fn.ajaxSubmit.debug = true; $(this).ajaxSubmit({ beforeSubmit: function(arr, $form, options) { // Notify backend that submit is via ajax arr.push({ name: "isAjax", value: "1" }); }, success: function (response, statusText, xhr, $form) { clearInterval(progressInterval); showProgress(100, Complete!); // TODO: Youll need to do some custom logic here to handle a successful // form post, and when the form is invalid with validation errors. if (response.status) { // TODO: Do something with a successful form post, like redirect // window.location.replace(response.redirect); } else { // Clear the file input, otherwise the same file gets re-uploaded // http://stackoverflow.com/a/1043969 var fileInput = $(#image-file); fileInput.replaceWith( fileInput.val().clone( true ) ); // TODO: Do something with these errors // showErrors(response.formErrors); } }, error: function(a, b, c) { // NOTE: This callback is *not* called when the form is invalid. // It is called when the browser is unable to initiate or complete the ajax submit. // You will need to handle validation errors in the success callback. console.log(a, b, c); } }); // Start the progress polling startProgress(); }); }); </script>
And nally, our Controller action can be modied to return form status and validation messages in JSON format if we see the isAjax post parameter (which was set in the JavaScript just before submit):
1 2 3
554
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
{ $form = new UploadForm(upload-form); $request = $this->getRequest(); if ($request->isPost()) { // Make certain to merge the files info! $post = array_merge_recursive( $request->getPost()->toArray(), $request->getFiles()->toArray() ); $form->setData($post); if ($form->isValid()) { $data = $form->getData(); // Form is valid, save the form! if (!empty($post[isAjax])) { return new JsonModel(array( status => true, redirect => $this->url()->fromRoute(upload-form/success), formData => $data, )); } else { // Fallback for non-JS clients return $this->redirect()->toRoute(upload-form/success); } } else { if (!empty($post[isAjax])) { // Send back failure information via JSON return new JsonModel(array( status => false, formErrors => $form->getMessages(), formData => $form->getData(), )); } } } return array(form => $form); }
External resources and blog posts from the community: ZF2FileUploadExamples : A ZF2 module with several le upload examples.
556
CHAPTER 119
Beginning with Zend Framework 2.1, forms elements can be registered using a designated plugin manager of Zend\ServiceManager. This is similar to how view helpers, controller plugins, and lters are registered. This new feature has a number of benets, especially when you need to handle complex dependencies in forms/eldsets. This section describes all the benets of this new architecture in ZF 2.1.
Each element provided out-of-the-box by Zend Framework 2 support this natively, so you can now make your initialization code more compact.
557
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
namespace Application\Form\Element; use Zend\Form\Element; use Zend\Form\Element; use Zend\InputFilter\InputProviderInterface; use Zend\Validator\Regex as RegexValidator; class Phone extends Element implements InputProviderInterface { /** * @var ValidatorInterface */ protected $validator; /** * Get a validator if none has been set. * * @return ValidatorInterface */ public function getValidator() { if (null === $this->validator) { $validator = new RegexValidator(/^\+?\d{11,12}$/); $validator->setMessage(Please enter 11 or 12 digits only!, RegexValidator::NOT_MATCH); $this->validator = $validator; } return $this->validator; } /** * Sets the validator to use for this element * * @param ValidatorInterface $validator * @return Application\Form\Element\Phone */ public function setValidator(ValidatorInterface $validator) { $this->validator = $validator; return $this; } /** * Provide default input rules for this element * * Attaches a phone number validator. * * @return array */ public function getInputSpecification() { return array( name => $this->getName(), required => true, filters => array(
558
59 60 61 62 63 64 65 66
By implementing the Zend\InputFilter\InputProviderInterface interface, we are hinting to our form object that this element provides some default input rules for ltering and/or validating values. In this example the default input specication provides a Zend\Filter\StringTrim lter and a Zend\Validator\Regex validator that validates that the value optionally has a + sign at the beginning and is followed by 11 or 12 digits. The easiest way of start using your new custom element in your forms is to use the custom elements FCQN:
1 2 3 4 5
$form = new Zend\Form\Form(); $form->add(array( name => phone, type => Application\Form\Element\Phone, ));
namespace Application\Form; use Zend\Form\Form; class MyForm extends Form { public function __construct($name = null) { parent::__construct($name); $this->add(array( name => phone, type => Application\Form\Element\Phone, )) } }
If you dont want to use the custom elements FCQN, but rather a short name, as of Zend Framework 2.1 you can do so by adding them to the Zend\Form\FormElementManager plugin manager by utilising the getFormElementConfig function. Warning: To use custom elements with the FormElementManager needs a bit more work and most likely a change in how you write and use your forms. First, add the custom element to the plugin manager, in your Module.php class:
1 2 3 4 5 6 7 8
namespace Application; use Zend\ModuleManager\Feature\FormElementProviderInterface; class Module implements FormElementProviderInterface { public function getFormElementConfig() {
559
9 10 11 12 13 14 15
return array( form_elements => array( invokables => array( phone => Application\Form\Element\Phone ) ) );
You can use a factory instead of an invokable in order to handle dependencies in your elements/eldsets/forms. And now comes the rst catch. If you are creating your form class by extending Zend\Form\Form, you must not add the custom element in the __construct-or (as we have done in the previous example where we used the custom elements FCQN), but rather in the init() method:
namespace Application\Form; use Zend\Form\Form; class MyForm extends Form { public function init() { $this->add(array( name => phone, type => Phone, )) } }
The second catch is that you must not directly instantiate your form class, but rather get an instance of it through the Zend\Form\FormElementManager:
namespace Application\Controller; use Zend\Mvc\Controller\AbstractActionController; class IndexController extends AbstractActionController { public function indexAction() { $sl = $this->getServiceLocator(); $form = $sl->get(FormElementManager)->get(\Application\Form\MyForm); return array(form => $form); } }
The biggest gain of this is that you can easily override any built-in Zend Framework form elements if they do not t your needs. For instance, if you want to create your own Email element instead of the standard one, you can simply 560 Chapter 119. Advanced use of forms
create your element and add it to the form element cong with the same key as the element you want to replace:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
namespace Application; use Zend\ModuleManager\Feature\FormElementProviderInterface; class Module implements FormElementProviderInterface { public function getFormElementConfig() { return array( invokables => array( Email => Application\Form\Element\MyEmail ) ); } }
Now, whenever youll create an element whose type is Email, it will create the custom Email element instead of the built-in one. Note: if you want to be able to use both the built-in one and your own one, you can still provide the FQCN of the element, i.e. Zend\Form\Element\Email. As you can see here, we rst get the form manager (that we modied in our Module.php class), and create the form by specifying the fully qualied class name of the form. Please note that you dont need to add ApplicationFormMyForm to the invokables array. If it is not specied, the form manager will just instantiate it directly. In short, to create your own form elements (or even reusable eldsets !) and be able to use them in your form using the short-name notation, you need to: 1. Create your element (like you did before). 2. Add it to the form element manager by dening the getFormElementConfig, exactly like using getServiceConfig() and getControllerConfig. 3. Make sure the custom form element is not added in the forms __construct-or, but rather in its init() method, or after getting an instance of the form. 4. Create your form through the form element manager instead of directly instantiating it.
561
6 7 8 9 10 11 12 13 14
{ public function init() { $this->add(array( name => album, type => AlbumFieldset )); } }
Lets now create the AlbumFieldset that depends on an AlbumTable object that allows you to fetch albums from the database.
1 2 3 4 5 6 7 8 9 10 11 12 13
namespace Application\Form; use Album\Model\AlbumTable; use Zend\Form\Fieldset; class AlbumFieldset extends Fieldset { public function __construct(AlbumTable $albumTable) { // Add any elements that need to fetch data from database // using the album table ! } }
For this to work, you need to add a line to the form element manager by adding an element to your Module.php class:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
namespace Application; use Application\Form\AlbumFieldset; use Zend\ModuleManager\Feature\FormElementProviderInterface; class Module implements FormElementProviderInterface { public function getFormElementConfig() { return array( factories => array( AlbumFieldset => function($sm) { // I assume here that the Album\Model\AlbumTable // dependency have been defined too $serviceLocator = $sm->getServiceLocator(); $albumTable = $serviceLocator->get(Album\Model\AlbumTable); $fieldset = new AlbumFieldset($albumTable); return $fieldset; } ) ); } }
Create your form using the form element manager instead of directly instantiating it:
1 2 3
562
4 5
$form = $formManager->get(Application\Form\CreateAlbum); }
Finally, to use your eldset in a view you need to use the formCollection function.
1 2 3
Et voil! The dependency will be automatically handled by the form element manager, and you dont need to create the AlbumTable in your controller, transfer it to the form, which itself passes it over to the eldset.
namespace Application\Form; use use use use Album\Model; Zend\Form\Fieldset; Zend\ServiceManager\ServiceLocatorAwareInterface; Zend\ServiceManager\ServiceLocatorInterface;
class AlbumFieldset extends Fieldset implements ServiceLocatorAwareInterface { protected $serviceLocator; public function __construct() { // Here, $this->serviceLocator is null because it has not been // injected yet, as initializers are run after __construct } public function setServiceLocator(ServiceLocatorInterface $sl) { $this->serviceLocator = $sl; } public function getServiceLocator() { return $this->serviceLocator; } }
Thankfully, there is an easy workaround: every form element now implements the new interface Zend\\Stdlib\\InitializableInterface, that denes a single init() function. In the context of form elements, this init() function is automatically called once all the dependencies (including all initializers) are resolved. Therefore, the previous example can be rewritten as such:
563
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
namespace Application\Form; use use use use Album\Model; Zend\Form\Fieldset; Zend\ServiceManager\ServiceLocatorAwareInterface; Zend\ServiceManager\ServiceLocatorInterface;
class AlbumFieldset extends Fieldset implements ServiceLocatorAwareInterface { protected $serviceLocator; public function init() { // Here, we have $this->serviceLocator !! } public function setServiceLocator(ServiceLocatorInterface $sl) { $this->serviceLocator = $sl; } public function getServiceLocator() { return $this->serviceLocator; } }
564
CHAPTER 120
Form Elements
120.1 Introduction
A set of specialized elements are provided for accomplishing application-centric tasks. These include several HTML5 input elements with matching server-side validators, the Csrf element (to prevent Cross Site Request Forgery attacks), and the Captcha element (to display and validate CAPTCHAs). A Factory is provided to facilitate creation of elements, eldsets, forms, and the related input lter. See the Zend\Form Quick Start for more information.
At the bare minimum, each element or eldset requires a name. You will also typically provide some attributes to hint to the view layer how it might render the item.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
use Zend\Form\Element; use Zend\Form\Form; $username = new Element\Text(username); $username ->setLabel(Username) ->setAttributes(array( class => username, size => 30, )); $password = new Element\Password(password); $password ->setLabel(Password) ->setAttributes(array( size => 30, ));
565
18 19 20 21 22
Public Methods
setName(string $name) Set the name for this element. getName() Return the name for this element. Return type string setValue(string $value) Set the value for this element. getValue() Return the value for this element. Return type string setLabel(string $label) Set the label content for this element. getLabel() Return the label content for this element. Return type string setLabelAttributes(array $labelAttributes) Set the attributes to use with the label. getLabelAttributes() Return the attributes to use with the label. Return type array setOptions(array $options) Set options for an element. Accepted options are: "label" and "label_attributes", which call setLabel and setLabelAttributes, respectively. getOptions() Get dened options for an element Return type array getOption(string $option) Return the specied option, if dened. If its not dened, returns null. Return type null|mixed setAttribute(string $key, mixed $value) Set a single element attribute. getAttribute(string $key) Retrieve a single element attribute. Return type mixed
566
removeAttribute(string $key) Remove a single attribute hasAttribute(string $key) Check if a specic attribute exists for this element. Return type boolean setAttributes(array|Traversable $arrayOrTraversable) Set many attributes at once. Implementation will decide if this will overwrite or merge. getAttributes() Retrieve all attributes at once. Return type array|Traversable removeAttributes(array $keys) Remove many attributes at once clearAttributes() Clear all attributes for this element. setMessages(array|Traversable $messages) Set a list of messages to report when validation fails. getMessages() Returns a list of validation failure messages, if any. Return type array|Traversable
use Zend\Form\Element; use Zend\Form\Form; $button = new Element\Button(my-button); $button->setLabel(My Button) ->setValue(foo); $form = new Form(my-form); $form->add($button);
567
120.3.2 Captcha
Zend\Form\Element\Captcha can be used with forms where authenticated users are not necessary, but you want to prevent spam submissions. It is paired with one of the Zend\Form\View\Helper\Captcha\* view helpers that matches the type of CAPTCHA adapter in use.
Basic Usage
A CAPTCHA adapter must be attached in order for validation to be included in the elements input lter specication. See the section on Zend CAPTCHA Adapters for more information on what adapters are available.
1 2 3 4 5 6 7 8 9 10 11
use Zend\Captcha; use Zend\Form\Element; use Zend\Form\Form; $captcha = new Element\Captcha(captcha); $captcha ->setCaptcha(new Captcha\Dumb()) ->setLabel(Please verify you are human); $form = new Form(my-form); $form->add($captcha);
use Zend\Captcha; use Zend\Form\Form; $form = new Form(my-form); $form->add(array( type => Zend\Form\Element\Captcha, name => captcha, options => array( label => Please verify you are human, captcha => new Captcha\Dumb(), ), ));
Public Methods
The following methods are in addition to the inherited methods of Zend\Form\Element. setCaptcha(array|Zend\Captcha\AdapterInterface $captcha) Set the CAPTCHA adapter for this element. If $captcha is an array, Zend\Captcha\Factory::factory() will be run to create the adapter from the array conguration. getCaptcha() Return the CAPTCHA adapter for this element. Return type Zend\Captcha\AdapterInterface getInputSpecification() Returns a input lter specication, which includes a Zend\Filter\StringTrim lter, and a CAPTCHA validator. Return type array
568
120.3.3 Checkbox
Zend\Form\Element\Checkbox is meant to be paired with the Zend\Form\View\Helper\FormCheckbox for HTML inputs with type checkbox. This element adds an InArray validator to its input lter specication in order to validate on the server if the checkbox contains either the checked value or the unchecked value.
Basic Usage
use Zend\Form\Element; use Zend\Form\Form; $checkbox = new Element\Checkbox(checkbox); $checkbox->setLabel(A checkbox); $checkbox->setUseHiddenElement(true); $checkbox->setCheckedValue("good"); $checkbox->setUncheckedValue("bad"); $form = new Form(my-form); $form->add($checkbox);
use Zend\Form\Form; $form = new Form(my-form); $form->add(array( type => Zend\Form\Element\Checkbox, name => checkbox, options => array( label => A checkbox, use_hidden_element => true, checked_value => good, unchecked_value => bad ) ));
Public Methods
The following methods are in addition to the inherited methods of Zend\Form\Element . setOptions(array $options) Set options for an element of type Checkbox. Accepted options, in addition to the inherited options of Zend\Form\Element , are: "use_hidden_element", "checked_value" and "unchecked_value" , which call setUseHiddenElement, setCheckedValue and setUncheckedValue , respectively. setUseHiddenElement(boolean $useHiddenElement) If set to true (which is default), the view helper will generate a hidden element that contains the unchecked value. Therefore, when using custom unchecked value, this option have to be set to true. useHiddenElement() Return if a hidden element is generated. Return type boolean
569
setCheckedValue(string $checkedValue) Set the value to use when the checkbox is checked. getCheckedValue() Return the value used when the checkbox is checked. Return type string setUncheckedValue(string $uncheckedValue) Set the value to use when the checkbox is unchecked. use_hidden_element is set to true. getUncheckedValue() Return the value used when the checkbox is unchecked. Return type string getInputSpecification() Returns a input lter specication, which includes a Zend\Validator\InArray to validate if the value is either checked value or unchecked value. Return type array isChecked() Checks if the checkbox is checked. Return type boolean setChecked(bool $value) Checks or unchecks the checkbox. For this to work, you must make sure that
120.3.4 Collection
Sometimes, you may want to add input (or a set of inputs) multiple times, either because you dont want to duplicate code, or because you do not know in advance how many elements you will need (in the case of elements dynamically added to a form using JavaScript, for instance). For more information about Collection, please refer to the Form Collections tutorial. Zend\Form\Element\Collection is meant to be paired with the Zend\Form\View\Helper\FormCollection.
Basic Usage use Zend\Form\Element; use Zend\Form\Form; $colors = new Element\Collection(collection); $colors->setLabel(Colors); $colors->setCount(2); $colors->setTargetElement(new Element\Color()); $colors->setShouldCreateTemplate(true); $form = new Form(my-form); $form->add($colors);
1 2 3 4 5 6 7 8 9 10 11
570
1 2 3 4 5 6 7 8 9 10 11 12 13
use Zend\Form\Element; use Zend\Form\Form; $form = new Form(my-form); $form->add(array( type => Zend\Form\Element\Collection, options => array( label => Colors, count => 2, should_create_template => true, target_element => new Element\Color() ) ));
Public Methods
The following methods are in addition to the inherited methods of Zend\Form\Element . setOptions(array $options) Set options for an element of type Collection. Accepted options, in addition to the inherited options of Zend\Form\Element , are: "target_element", "count", "allow_add", "allow_remove", "should_create_template" and "template_placeholder". Those option keys respectively call call setTargetElement, setCount, setAllowAdd, setAllowRemove, setShouldCreateTemplate and setTemplatePlaceholder. allowObjectBinding(object $object) Checks if the object can be set in this eldset. Return type bool setObject(array|Traversable $object) Set the object used by the hydrator. In this case the object is a collection of objects. populateValues(array|Traversable $data) Populate values allowValueBinding() Checks if this eldset can bind data Return type bool setCount($count) Denes how many times the target element will Zend\Form\View\Helper\FormCollection view helper. getCount() Return the number of times the target element will Zend\Form\View\Helper\FormCollection view helper. Return type integer setTargetElement($elementOrFieldset) This function either takes an Zend\Form\ElementInterface, Zend\Form\FieldsetInterface instance or an array to pass to the form factory. When the Collection element will be validated, the input lter will be retrieved from this target element and be used to validate each element in the collection. getTargetElement() Return the target element used by the collection. Return type ElementInterface | null 120.3. Standard Elements 571 be initially rendered by the
be
initially
rendered
by
the
setAllowAdd($allowAdd) If allowAdd is set to true (which is the default), new elements added dynamically in the form (using JavaScript, for instance) will also be validated and retrieved. allowAdd() Return if new elements can be dynamically added in the collection. Return type boolean setAllowRemove($allowRemove) If allowRemove is set to true (which is the default), new elements added dynamically in the form (using JavaScript, for instance) will be allowed to be removed. allowRemove() Return if new elements can be dynamically removed from the collection. Return type boolean setShouldCreateTemplate($shouldCreateTemplate) If shouldCreateTemplate is set to true (defaults to false), a <span> element will be generated by the Zend\Form\View\Helper\FormCollection view helper. This non-semantic span element contains a single data-template HTML5 attribute whose value is the whole HTML to copy to create a new element in the form. The template is indexed using the templatePlaceholder value. shouldCreateTemplate() Return if a template should be created. Return type boolean setTemplatePlaceholder($templatePlaceholder) Set the template placeholder (defaults to __index__) used to index element in the template. getTemplatePlaceholder() Returns the template placeholder used to index element in the template. Return type string getTemplateElement() Get a template element used for rendering purposes only Return type null|ElementInterface|FieldsetInterface prepareElement() Prepare the collection by adding a dummy template element if the user want one prepareFieldset() If both count and targetElement are set, add them to the eldset
120.3.5 Csrf
Zend\Form\Element\Csrf pairs with the Zend\Form\View\Helper\FormHidden to provide protection from CSRF attacks on forms, ensuring the data is submitted by the user session that generated the form and not by a rogue script. Protection is achieved by adding a hash element to a form and verifying it when the form is submitted.
Basic Usage
572
1 2 3 4 5 6 7
use Zend\Form\Element; use Zend\Form\Form; $csrf = new Element\Csrf(csrf); $form = new Form(my-form); $form->add($csrf);
You can change the options of the CSRF validator using the setCsrfValidatorOptions function, or by using the "csrf_options" key. Here is an example using the array notation:
1 2 3 4 5 6 7 8 9 10 11 12
use Zend\Form\Form; $form = new Form(my-form); $form->add(array( type => Zend\Form\Element\Csrf, name => csrf, options => array( csrf_options => array( timeout => 600 ) ) ));
Public Methods
The following methods are in addition to the inherited methods of Zend\Form\Element. getInputSpecification() Returns a input lter specication, which includes a Zend\Filter\StringTrim lter and a Zend\Validator\Csrf to validate the CSRF value. Return type array setCsrfValidatorOptions(array $options) Set the options that are used by the CSRF validator. getCsrfValidatorOptions() Get the options that are used by the CSRF validator. Return type array setCsrfValidator(ZendValidatorCsrf $validator) Override the default CSRF validator by setting another one. getCsrfValidator() Get the CSRF validator. Return type ZendValidatorCsrf
120.3.6 File
Zend\Form\Element\File represents a form le input and provides a default input specication with a type of FileInput (important for handling validators and lters correctly). It can be used with the Zend\Form\View\Helper\FormFile view helper. Zend\Form\Element\File extends from Zend\Form\Element.
573
Basic Usage
This element automatically adds a "type" attribute of value "file". It will also set the forms enctype to multipart/form-data during $form->prepare().
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
use Zend\Form\Element; use Zend\Form\Form; // Single file upload $file = new Element\File(file); $file->setLabel(Single file input); // HTML5 multiple file upload $multiFile = new Element\File(multi-file); $multiFile->setLabel(Multi file input) ->setAttribute(multiple, true); $form = new Form(my-file); $form->add($file) ->add($multiFile);
120.3.7 Hidden
Zend\Form\Element\Hidden represents a hidden Zend\Form\View\Helper\FormHidden view helper. form input. It can be used with the
use Zend\Form\Element; use Zend\Form\Form; $hidden = new Element\Hidden(my-hidden); $hidden->setValue(foo); $form = new Form(my-form); $form->add($hidden);
use Zend\Form\Form; $form = new Form(my-form); $form->add(array( type => Zend\Form\Element\Hidden, name => my-hidden, attributes => array( value => foo ) ));
574
120.3.8 Image
Zend\Form\Element\Image represents a image button form input. Zend\Form\View\Helper\FormImage view helper. Zend\Form\Element\Image extends from Zend\Form\Element.
Basic Usage
use Zend\Form\Element; use Zend\Form\Form; $image = new Element\Image(my-image); $image->setAttribute(src, http://my.image.url); // Src attribute is required $form = new Form(my-form); $form->add($image);
1 2 3 4 5 6 7 8 9
use Zend\Form\Form; $form = new Form(dateselect); $form->add(array( type => Zend\Form\Element\MonthSelect, name => monthyear, options => array( label => Select a month and a year, min_year => 1986, ) ));
575
Public Methods
The following methods are in addition to the inherited methods of Zend\Form\Element. getMonthElement() Returns the Select element that is used for the months part. Return type Zend\Form\Element\Select getYearElement() Returns the Select element that is used for the years part. Return type Zend\Form\Element\Select setMonthAttributes(array $monthAttributes) Set attributes on the Select element that is used for the months part. getMonthAttributes() Get attributes on the Select element that is used for the months part. Return type array setYearAttributes(array $yearAttributes) Set attributes on the Select element that is used for the years part. getYearAttributes() Get attributes on the Select element that is used for the years part. Return type array setMinYear(int $minYear) Set the minimum year. getMinYear() Get the minimum year. setMaxYear(int $maxYear) Set the maximum year. getMaxYear() Get the maximum year. setValue(mixed $value) Set the value for the MonthSelect element. If the value is an instance of \DateTime, it will use the month and year values from that date. Otherwise, the value should be an associative array with the month key for the month value, and with the year key for the year value.
120.3.10 MultiCheckbox
Zend\Form\Element\MultiCheckbox is meant to be paired with the Zend\Form\View\Helper\FormMultiCheckbox for HTML inputs with type checkbox. This element adds an InArray validator to its input lter specication in order to validate on the server if the checkbox contains values from the multiple checkboxes.
Basic Usage
This element automatically adds a "type" attribute of value "checkbox" for every checkboxes.
576
1 2 3 4 5 6 7 8 9 10 11 12 13
use Zend\Form\Element; use Zend\Form\Form; $multiCheckbox = new Element\MultiCheckbox(multi-checkbox); $multiCheckbox->setLabel(What do you like ?); $multiCheckbox->setValueOptions(array( 0 => Apple, 1 => Orange, 2 => Lemon )); $form = new Form(my-form); $form->add($multiCheckbox);
use Zend\Form\Form; $form = new Form(my-form); $form->add(array( type => Zend\Form\Element\MultiCheckbox, name => multi-checkbox, options => array( label => What do you like ?, value_options => array( 0 => Apple, 1 => Orange, 2 => Lemon, ), ) ));
Public Methods
The following methods are in addition to the inherited methods of Zend\Form\Element\Checkbox . setOptions(array $options) Set options for an element of type Checkbox. Accepted options, in addition to the inherited options of Zend\Form\Element\Checkbox , are: "value_options", which call setValueOptions. setValueOptions(array $options) Set the value options for every checkbox of the multi-checkbox. The array must contain a key => value for every checkbox. getValueOptions() Return the value options. Return type array
120.3.11 Password
Zend\Form\Element\Password represents a password form input. Zend\Form\View\Helper\FormPassword view helper. Zend\Form\Element\Password extends from Zend\Form\Element. It can be used with the
577
Basic Usage
use Zend\Form\Element; use Zend\Form\Form; $password = new Element\Password(my-password); $password->setLabel(Enter your password); $form = new Form(my-form); $form->add($password);
120.3.12 Radio
Zend\Form\Element\Radio is meant to be paired with the Zend\Form\View\Helper\FormRadio for HTML inputs with type radio. This element adds an InArray validator to its input lter specication in order to validate on the server if the value is contains within the radio value elements.
Basic Usage
This element automatically adds a "type" attribute of value "radio" for every radio.
1 2 3 4 5 6 7 8 9 10 11 12
use Zend\Form\Element; use Zend\Form\Form; $radio = new Element\Radio(gender); $radio->setLabel(What is your gender ?); $radio->setValueOptions(array( 0 => Female, 1 => Male, )); $form = new Form(my-form); $form->add($radio);
use Zend\Form\Form; $form = new Form(my-form); $form->add(array( type => Zend\Form\Element\Radio, name => gender, options => array( label => What is your gender ?, value_options => array( 0 => Female, 1 => Male, ), ) ));
578
Public Methods
All the methods from the inherited methods of Zend\Form\Element\MultiCheckbox are also available for this element.
120.3.13 Select
Zend\Form\Element\Select is meant to be paired with the Zend\Form\View\Helper\FormSelect for HTML inputs with type select. This element adds an InArray validator to its input lter specication in order to validate on the server if the selected value belongs to the values. This element can be used as a multi-select element by adding the multiple HTML attribute to the element.
Basic Usage
use Zend\Form\Element; use Zend\Form\Form; $select = new Element\Select(language); $select->setLabel(Which is your mother tongue?); $select->setValueOptions(array( 0 => French, 1 => English, 2 => Japanese, 3 => Chinese, )); $form = new Form(language); $form->add($select);
use Zend\Form\Form; $form = new Form(my-form); $form->add(array( type => Zend\Form\Element\Select, name => language, options => array( label => Which is your mother tongue?, value_options => array( 0 => French, 1 => English, 2 => Japanese, 3 => Chinese, ), ) ));
You can add an empty option (option with no value) using the "empty_option" option:
1 2 3 4 5
579
6 7 8 9 10 11 12 13 14 15 16 17
name => language, options => array( label => Which is your mother tongue?, empty_option => Please choose your language, value_options => array( 0 => French, 1 => English, 2 => Japanese, 3 => Chinese, ), ) ));
Option groups are also supported. You just need to add an options key to the value options.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
use Zend\Form\Element; use Zend\Form\Form; $select = new Element\Select(language); $select->setLabel(Which is your mother tongue?); $select->setValueOptions(array( european => array( label => European languages, options => array( 0 => French, 1 => Italian, ), ), asian => array( label => Asian languages, options => array( 2 => Japanese, 3 => Chinese, ), ), )); $form = new Form(language); $form->add($select);
Public Methods
The following methods are in addition to the inherited methods of Zend\Form\Element . setOptions(array $options) Set options for an element of type Checkbox. Accepted options, in addition to the inherited options of Zend\Form\Element\Checkbox , are: "value_options" and "empty_option", which call setValueOptions and setEmptyOption, respectively. setValueOptions(array $options) Set the value options for the select element. The array must contain key => value pairs. getValueOptions() Return the value options. Return type array setEmptyOption($emptyOption)
580
Optionally set a label for an empty option (option with no value). It is set to null by default, which means that no empty option will be rendered. getEmptyOption() Get the label for the empty option (null if none). Return type string|null
120.3.14 Submit
Zend\Form\Element\Submit represents a submit button form input. Zend\Form\View\Helper\FormSubmit view helper. Zend\Form\Element\Submit extends from Zend\Form\Element.
Basic Usage
use Zend\Form\Element; use Zend\Form\Form; $submit = new Element\Submit(my-submit); $submit->setValue(Submit Form); $form = new Form(my-form); $form->add($submit);
120.3.15 Text
Zend\Form\Element\Text represents a text Zend\Form\View\Helper\FormText view helper. form input. It can be used with the
use Zend\Form\Element; use Zend\Form\Form; $text = new Element\Text(my-text); $text->setLabel(Enter your name); $form = new Form(my-form); $form->add($text);
120.3.16 Textarea
Zend\Form\Element\Textarea represents a textarea form input. Zend\Form\View\Helper\FormTextarea view helper. Zend\Form\Element\Textarea extends from Zend\Form\Element. 120.3. Standard Elements 581 It can be used with the
Basic Usage
use Zend\Form\Element; use Zend\Form\Form; $textarea = new Element\Textarea(my-textarea); $textarea->setLabel(Enter a description); $form = new Form(my-form); $form->add($textarea);
use Zend\Form\Element; use Zend\Form\Form; $color = new Element\Color(color); $color->setLabel(Background color); $form = new Form(my-form); $form->add($color);
use Zend\Form\Form; $form = new Form(my-form); $form->add(array( type => Zend\Form\Element\Color, name => color, options => array( label => Background color ) ));
Public Methods
The following methods are in addition to the inherited methods of Zend\Form\Element. getInputSpecification() Returns a input lter specication, which includes Zend\Filter\StringTrim and
582
Zend\Filter\StringToLower lters, and a Zend\Validator\Regex to validate the RGB hex format. Return type array
120.4.2 Date
Zend\Form\Element\Date is meant to be paired with the Zend\Form\View\Helper\FormDate for HTML5 inputs with type date. This element adds lters and validators to its input lter specication in order to validate HTML5 date input values on the server.
Basic Usage
use Zend\Form\Element; use Zend\Form\Form; $date = new Element\Date(appointment-date); $date ->setLabel(Appointment Date) ->setAttributes(array( min => 2012-01-01, max => 2020-01-01, step => 1, // days; default step interval is 1 day )) ->setOptions(array( format => Y-m-d )); $form = new Form(my-form); $form->add($date);
use Zend\Form\Form; $form = new Form(my-form); $form->add(array( type => Zend\Form\Element\Date, name => appointment-date, options => array( label => Appointment Date, format => Y-m-d ), attributes => array( min => 2012-01-01, max => 2020-01-01, step => 1, // days; default step interval is 1 day ) ));
Note: Note: the min, max, and step attributes should be set prior to calling Zend\Form::prepare(). Otherwise, the default input specication for the element may not contain the correct validation rules.
583
Public Methods
The following methods are in addition to the inherited methods of Zend\Form\Element\DateTime. getInputSpecification() Returns a input lter specication, which includes Zend\Filter\StringTrim and will add the appropriate validators based on the values from the min, max, and step attributes and format option. See getInputSpecication in Zend\Form\Element\DateTime for more information. One difference from Zend\Form\Element\DateTime is that the Zend\Validator\DateStep validator will expect the step attribute to use an interval of days (default is 1 day). Return type array
120.4.3 DateTime
Zend\Form\Element\DateTime is meant to be paired with the Zend\Form\View\Helper\FormDateTime for HTML5 inputs with type datetime. This element adds lters and validators to its input lter specication in order to validate HTML5 datetime input values on the server.
Basic Usage
use Zend\Form\Element; use Zend\Form\Form; $dateTime = new Element\DateTime(appointment-date-time); $dateTime ->setLabel(Appointment Date/Time) ->setAttributes(array( min => 2010-01-01T00:00:00Z, max => 2020-01-01T00:00:00Z, step => 1, // minutes; default step interval is 1 min )) ->setOptions(array( format => Y-m-d\TH:iP )); $form = new Form(my-form); $form->add($dateTime);
use Zend\Form\Form; $form = new Form(my-form); $form->add(array( type => Zend\Form\Element\DateTime, name => appointment-date-time, options => array( label => Appointment Date/Time, format => Y-m-d\TH:iP ), attributes => array( min => 2010-01-01T00:00:00Z,
584
13 14 15 16
max => 2020-01-01T00:00:00Z, step => 1, // minutes; default step interval is 1 min ) ));
Note: Note: the min, max, and step attributes should be set prior to calling Zend\Form::prepare(). Otherwise, the default input specication for the element may not contain the correct validation rules.
Public Methods
The following methods are in addition to the inherited methods of Zend\Form\Element. getInputSpecification() Returns a input lter specication, which includes Zend\Filter\StringTrim and will add the appropriate validators based on the values from the min, max, and step attributes and format option. If the min attribute is set, a Zend\Validator\GreaterThan validator will be added to ensure the date value is greater than the minimum value. If the max attribute is set, a Zend\Validator\LessThanValidator validator will be added to ensure the date value is less than the maximum value. If the step attribute is set to any, step validations will be skipped. Otherwise, a Zend\Validator\DateStep validator will be added to ensure the date value is within a certain interval of minutes (default is 1 minute). The input lter specication also includes a Zend\Validator\Date validator to ensure the format of the value. If the format option is set, that format will be used. Otherwise the default format will be used. Return type array setOptions(array $options) Set options for an element of type DateTime. The accepted option, in addition to the inherited options of Zend\Form\Element , is: "format", which calls setFormat. setFormat(string $format) Sets the format used to validate the value. Accepts a \DateTime compatible string. getFormat() Return the DateTime format used to validate the value. Return type String
120.4.4 DateTimeLocal
Zend\Form\Element\DateTimeLocal is meant to be paired with the Zend\Form\View\Helper\FormDateTimeLocal for HTML5 inputs with type datetime-local. This element adds lters and validators to its input lter specication in order to validate HTML5 a local datetime input values on the server.
Basic Usage
585
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
use Zend\Form\Element; use Zend\Form\Form; $dateTimeLocal = new Element\DateTimeLocal(appointment-date-time); $dateTimeLocal ->setLabel(Appointment Date) ->setAttributes(array( min => 2010-01-01T00:00:00, max => 2020-01-01T00:00:00, step => 1, // minutes; default step interval is 1 min )) ->setOptions(array( format => Y-m-d\TH:i )); $form = new Form(my-form); $form->add($dateTimeLocal);
use Zend\Form\Form; $form = new Form(my-form); $form->add(array( type => Zend\Form\Element\DateTimeLocal, name => appointment-date-time, options => array( label => Appointment Date, format => Y-m-d\TH:i ), attributes => array( min => 2010-01-01T00:00:00, max => 2020-01-01T00:00:00, step => 1, // minutes; default step interval is 1 min ) ));
Note: Note: the min, max, and step attributes should be set prior to calling Zend\Form::prepare(). Otherwise, the default input specication for the element may not contain the correct validation rules.
Public Methods
The following methods are in addition to the inherited methods of Zend\Form\Element\DateTime. getInputSpecification() Returns a input lter specication, which includes Zend\Filter\StringTrim and will add the appropriate validators based on the values from the min, max, and step attributes and format option. See getInputSpecication in Zend\Form\Element\DateTime for more information. Return type array
120.4.5 Email
Zend\Form\Element\Email is meant to be paired with the Zend\Form\View\Helper\FormEmail for HTML5 inputs with type email. This element adds lters and validators to its input lter specication in order to 586 Chapter 120. Form Elements
use Zend\Form\Element; use Zend\Form\Form; $form = new Form(my-form); // Single email address $email = new Element\Email(email); $email->setLabel(Email Address) $form->add($email); // Comma separated list of emails $emails = new Element\Email(emails); $emails ->setLabel(Email Addresses) ->setAttribute(multiple, true); $form->add($emails);
use Zend\Form\Form; $form = new Form(my-form); $form->add(array( type => Zend\Form\Element\Email, name => email, options => array( label => Email Address ), )); $form->add(array( type => Zend\Form\Element\Email, name => emails, options => array( label => Email Addresses ), attributes => array( multiple => true ) ));
Note: Note: the multiple attribute should be set prior to calling Zend\Form::prepare(). Otherwise, the default input specication for the element may not contain the correct validation rules.
Public Methods
587
getInputSpecification() Returns a input lter specication, which includes a Zend\Filter\StringTrim lter, and a validator based on the multiple attribute. If the multiple attribute is unset or false, a Zend\Validator\Regex validator will be added to validate a single email address. If the multiple attribute is true, a Zend\Validator\Explode validator will be added to ensure the input string value is split by commas before validating each email address with Zend\Validator\Regex. Return type array setValidator(ValidatorInterface $validator) Sets the primary validator to use for this element getValidator() Get the primary validator Return type ValidatorInterface setEmailValidator(ValidatorInterface $validator) Sets the email validator to use for multiple or single email addresses. getEmailValidator() Get the email validator to use for multiple or single email addresses. The default Regex validator in use is to match that of the browser validation, but you are free to set a different (more strict) email validator such as Zend\Validator\Email if you wish.
120.4.6 Month
Zend\Form\Element\Month is meant to be paired with the Zend\Form\View\Helper\FormMonth for HTML5 inputs with type month. This element adds lters and validators to its input lter specication in order to validate HTML5 month input values on the server.
Basic Usage
use Zend\Form\Element; use Zend\Form\Form; $month = new Element\Month(month); $month ->setLabel(Month) ->setAttributes(array( min => 2012-01, max => 2020-01, step => 1, // months; default step interval is 1 month )); $form = new Form(my-form); $form->add($month);
588
4 5 6 7 8 9 10 11 12 13 14 15
$form->add(array( type => Zend\Form\Element\Month, name => month, options => array( label => Month ), attributes => array( min => 2012-12, max => 2020-01, step => 1, // months; default step interval is 1 month ) ));
Note: Note: the min, max, and step attributes should be set prior to calling Zend\Form::prepare(). Otherwise, the default input specication for the element may not contain the correct validation rules.
Public Methods
The following methods are in addition to the inherited methods of Zend\Form\Element\DateTime. getInputSpecification() Returns a input lter specication, which includes Zend\Filter\StringTrim and will add the appropriate validators based on the values from the min, max, and step attributes. See getInputSpecication in Zend\Form\Element\DateTime for more information. One difference from Zend\Form\Element\DateTime is that the Zend\Validator\DateStep validator will expect the step attribute to use an interval of months (default is 1 month). Return type array
120.4.7 Number
Zend\Form\Element\Number is meant to be paired with the Zend\Form\View\Helper\FormNumber for HTML5 inputs with type number. This element adds lters and validators to its input lter specication in order to validate HTML5 number input values on the server.
Basic Usage
use Zend\Form\Element; use Zend\Form\Form; $number = new Element\Number(quantity); $number ->setLabel(Quantity) ->setAttributes(array( min => 0, max => 10, step => 1, // default step interval is 1 ));
589
13 14
use Zend\Form\Form; $form = new Form(my-form); $form->add(array( type => Zend\Form\Element\Number, name => quantity, options => array( label => Quantity ), attributes => array( min => 0, max => 10, step => 1, // default step interval is 1 ) ));
Note: Note: the min, max, and step attributes should be set prior to calling Zend\Form::prepare(). Otherwise, the default input specication for the element may not contain the correct validation rules.
Public Methods
The following methods are in addition to the inherited methods of Zend\Form\Element. getInputSpecification() Returns a input lter specication, which includes Zend\Filter\StringTrim and will add the appropriate validators based on the values from the min, max, and step attributes. If the min attribute is set, a Zend\Validator\GreaterThan validator will be added to ensure the number value is greater than the minimum value. The min value should be a valid oating point number. If the max attribute is set, a Zend\Validator\LessThan validator will be added to ensure the number value is less than the maximum value. The max value should be a valid oating point number. If the step attribute is set to any, step validations will be skipped. Otherwise, a Zend\Validator\Step validator will be added to ensure the number value is within a certain interval (default is 1). The step value should be either any or a valid oating point number. Return type array
120.4.8 Range
Zend\Form\Element\Range is meant to be paired with the Zend\Form\View\Helper\FormRange for HTML5 inputs with type range. This element adds lters and validators to its input lter specication in order to validate HTML5 range values on the server.
Basic Usage
590
1 2 3 4 5 6 7 8 9 10 11 12 13 14
use Zend\Form\Element; use Zend\Form\Form; $range = new Element\Range(range); $range ->setLabel(Minimum and Maximum Amount) ->setAttributes(array( min => 0, // default minimum is 0 max => 100, // default maximum is 100 step => 1, // default interval is 1 )); $form = new Form(my-form); $form->add($range);
use Zend\Form\Form; $form = new Form(my-form); $form->add(array( type => Zend\Form\Element\Range, name => range, options => array( label => Minimum and Maximum Amount ), attributes => array( min => 0, // default minimum is 0 max => 100, // default maximum is 100 step => 1 // default interval is 1 ) ));
Note: Note: the min, max, and step attributes should be set prior to calling Zend\Form::prepare(). Otherwise, the default input specication for the element may not contain the correct validation rules.
Public Methods
The following methods are in addition to the inherited methods of Zend\Form\Element\Number. getInputSpecification() Returns a input lter specication, which includes Zend\Filter\StringTrim and will add the appropriate validators based on the values from the min, max, and step attributes. See getInputSpecication in Zend\Form\Element\Number for more information. The Range element differs from Zend\Form\Element\Number in that the Zend\Validator\GreaterThan and Zend\Validator\LessThan validators will always be present. The default minimum is 1, and the default maximum is 100. Return type array
120.4.9 Time
Zend\Form\Element\Time is meant to be paired with the Zend\Form\View\Helper\FormTime for HTML5 inputs with type time. This element adds lters and validators to its input lter specication in order to 120.4. HTML5 Elements 591
use Zend\Form\Element; use Zend\Form\Form; $time = new Element\Time(time); $time ->setLabel(Time) ->setAttributes(array( min => 00:00:00, max => 23:59:59, step => 60, // seconds; default step interval is 60 seconds )) ->setOptions(array( format => H:i:s )); $form = new Form(my-form); $form->add($time);
use Zend\Form\Form; $form = new Form(my-form); $form->add(array( type => Zend\Form\Element\Time, name => time, options=> array( label => Time, format => H:i:s ), attributes => array( min => 00:00:00, max => 23:59:59, step => 60, // seconds; default step interval is 60 seconds ) ));
Note: The min, max, and step attributes should be set prior to calling Zend\Form::prepare(). Otherwise, the default input specication for the element may not contain the correct validation rules.
Note: The default date format for the validator is H:i:s. A valid time string is however not required to have a seconds part. In fact some user agent UIs such as Google Chrome and Opera submits a value on the H:i format (i.e. without a second part). You might therefore want to set the date format accordingly.
Public Methods
592
getInputSpecification() Returns a input lter specication, which includes Zend\Filter\StringTrim and will add the appropriate validators based on the values from the min, max, and step attributes and format option. See getInputSpecication in Zend\Form\Element\DateTime for more information. One difference from Zend\Form\Element\DateTime is that the Zend\Validator\DateStep validator will expect the step attribute to use an interval of seconds (default is 60 seconds). Return type array
120.4.10 Url
Zend\Form\Element\Url is meant to be paired with the Zend\Form\View\Helper\FormUrl for HTML5 inputs with type url. This element adds lters and a Zend\Validator\Uri validator to its input lter specication for validating HTML5 URL input values on the server.
Basic Usage
use Zend\Form\Element; use Zend\Form\Form; $url = new Element\Url(webpage-url); $url->setLabel(Webpage URL); $form = new Form(my-form); $form->add($url);
use Zend\Form\Form; $form = new Form(my-form); $form->add(array( type => Zend\Form\Element\Url, name => webpage-url, options => array( label => Webpage URL ) ));
Public Methods
The following methods are in addition to the inherited methods of Zend\Form\Element. getInputSpecification() Returns a input lter specication, which includes a Zend\Filter\StringTrim lter, and a Zend\Validator\Uri to validate the URI string. Return type array
593
120.4.11 Week
Zend\Form\Element\Week is meant to be paired with the Zend\Form\View\Helper\FormWeek for HTML5 inputs with type week. This element adds lters and validators to its input lter specication in order to validate HTML5 week input values on the server.
Basic Usage
use Zend\Form\Element; use Zend\Form\Form; $week = new Element\Week(week); $week ->setLabel(Week) ->setAttributes(array( min => 2012-W01, max => 2020-W01, step => 1, // weeks; default step interval is 1 week )); $form = new Form(my-form); $form->add($week);
use Zend\Form\Form; $form = new Form(my-form); $form->add(array( type => Zend\Form\Element\Week, name => week, options => array( label => Week ), attributes => array( min => 2012-W01, max => 2020-W01, step => 1, // weeks; default step interval is 1 week ) ));
Note: Note: the min, max, and step attributes should be set prior to calling Zend\Form::prepare(). Otherwise, the default input specication for the element may not contain the correct validation rules.
Public Methods
The following methods are in addition to the inherited methods of Zend\Form\Element\DateTime. getInputSpecification() Returns a input lter specication, which includes Zend\Filter\StringTrim and will add the appropriate validators based on the values from the min, max, and step attributes. See getInputSpecication in Zend\Form\Element\DateTime for more information.
594
One difference from Zend\Form\Element\DateTime is that the Zend\Validator\DateStep validator will expect the step attribute to use an interval of weeks (default is 1 week). Return type array
595
596
CHAPTER 121
121.1 Introduction
Zend Framework comes with an initial set of helper classes related to Forms: e.g., rendering a text input, selection box, or form labels. You can use helper, or plugin, classes to perform these behaviors for you. See the section on view helpers for more information.
use Zend\Form\Form; use Zend\Form\Element; // Within your view... $form = new Form(); // ...add elements and input filter to form... // Set attributes $form->setAttribute(action, $this->url(contact/process)); $form->setAttribute(method, post); // Prepare the form elements $form->prepare(); // Render the opening tag echo $this->form()->openTag($form); // <form action="/contact/process" method="post"> // ...render the form elements...
597
22 23 24
The following public methods are in addition to those inherited from Zend\Form\View\Helper\AbstractHelper. openTag(FormInterface $form = null) Renders the <form> open tag for the $form instance. Return type string closeTag() Renders a </form> closing tag. Return type string
121.2.2 FormButton
The FormButton view helper is used to render a <button> HTML element and its attributes. Basic usage:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
use Zend\Form\Element; $element = new Element\Button(my-button); $element->setLabel("Reset"); // Within your view... /** * Example #1: Render entire button in one shot... */ echo $this->formButton($element); // <button name="my-button" type="button">Reset</button> /** * Example #2: Render button in 3 steps */ // Render the opening tag echo $this->formButton()->openTag($element); // <button name="my-button" type="button"> echo <span class="inner"> . $element->getLabel() . </span>; // Render the closing tag echo $this->formButton()->closeTag(); // </button> /** * Example #3: Override the element label */ echo $this->formButton()->render($element, My Content); // <button name="my-button" type="button">My Content</button>
The following public methods are in addition to those inherited from Zend\Form\View\Helper\FormInput. openTag($element = null) Renders the <button> open tag for the $element instance. Return type string 598 Chapter 121. Form View Helpers
closeTag() Renders a </button> closing tag. Return type string render(ElementInterface $element[, $buttonContent = null ]) Renders a buttons opening tag, inner content, and closing tag. Parameters $element The button element. $buttonContent (optional) The inner content to render. If null, will default to the $elements label. Return type string
121.2.3 FormCaptcha
TODO Basic usage:
1 2 3 4 5 6 7 8 9 10 11 12 13
use Zend\Captcha; use Zend\Form\Element; $captcha = new Element\Captcha(captcha); $captcha ->setCaptcha(new Captcha\Dumb()) ->setLabel(Please verify you are human); // Within your view... echo $this->formCaptcha($captcha); // TODO
121.2.4 FormCheckbox
The FormCheckbox view helper can be used to render a <input type="checkbox"> HTML form input. It is meant to work with the Zend\Form\Element\Checkbox element, which provides a default input specication for validating the checkbox values. FormCheckbox extends from Zend\Form\View\Helper\FormInput. Basic usage:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
use Zend\Form\Element; $element = new Element\Checkbox(my-checkbox); // Within your view... /** * Example #1: Default options */ echo $this->formCheckbox($element); // <input type="hidden" name="my-checkbox" value="0"> // <input type="checkbox" name="my-checkbox" value="1"> /** * Example #2: Disable hidden element
599
16 17 18 19 20 21 22 23 24 25 26 27 28 29
*/ $element->setUseHiddenElement(false); echo $this->formCheckbox($element); // <input type="checkbox" name="my-checkbox" value="1"> /** * Example #3: Change checked/unchecked values */ $element->setUseHiddenElement(true) ->setUncheckedValue(no) ->setCheckedValue(yes); echo $this->formCheckbox($element); // <input type="hidden" name="my-checkbox" value="no"> // <input type="checkbox" name="my-checkbox" value="yes">
121.2.5 FormCollection
TODO Basic usage: TODO
121.2.6 FormElement
The FormElement view helper proxies the rendering to specic form view helpers depending on the type of the Zend\Form\Element that is passed in. For instance, if the passed in element had a type of text, the FormElement helper will retrieve and use the FormText helper to render the element. Basic usage:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
use Zend\Form\Form; use Zend\Form\Element; // Within your view... /** * Example #1: Render different types of form elements */ $textElement = new Element\Text(my-text); $checkboxElement = new Element\Checkbox(my-checkbox); echo $this->formElement($textElement); // <input type="text" name="my-text" value=""> echo $this->formElement($checkboxElement); // <input type="hidden" name="my-checkbox" value="0"> // <input type="checkbox" name="my-checkbox" value="1"> /** * Example #2: Loop through form elements and render them */ $form = new Form(); // ...add elements and input filter to form... $form->prepare(); // Render the opening tag echo $this->form()->openTag($form);
600
28 29 30 31 32 33 34 35 36
// ...loop through and render the form elements... foreach ($form as $element) { echo $this->formElement($element); // <-- Magic! echo $this->formElementErrors($element); } // Render the closing tag echo $this->form()->closeTag();
121.2.7 FormElementErrors
The FormElementErrors view helper is used to render the validation error messages of an element. Basic usage:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
// Create a form $form = new Form(); $element = new Element\Text(my-text); $form->add($element); // Create a input $input = new Input(my-text); $input->setRequired(true); $inputFilter = new InputFilter(); $inputFilter->add($input); $form->setInputFilter($inputFilter); // Force a failure $form->setData(array()); // Empty data $form->isValid(); // Not valid // Within your view... /** * Example #1: Default options */ echo $this->formElementErrors($element); // <ul><li>Value is required and can't be empty</li></ul> /** * Example #2: Add attributes to open format */ echo $this->formElementErrors($element, array(class => help-inline)); // <ul class="help-inline"><li>Value is required and can't be empty</li></ul> /** * Example #3: Custom format */ echo $this->formElementErrors() ->setMessageOpenFormat(<div class="help-inline">)
601
42 43 44 45
->setMessageSeparatorString(</div><div class="help-inline">) ->setMessageCloseString(</div>) ->render($element); // <div class="help-inline">Value is required and can't be empty</div>
The following public methods are in addition to those inherited from Zend\Form\View\Helper\AbstractHelper. setMessageOpenFormat(string $messageOpenFormat) Set the formatted string used to open message representation. Parameters $messageOpenFormat The formatted string to use to open the messages. Uses <ul%s><li> by default. Attributes are inserted here. getMessageOpenFormat() Returns the formatted string used to open message representation. Return type string setMessageSeparatorString(string $messageSeparatorString) Sets the string used to separate messages. Parameters $messageSeparatorString The string to use to separate the messages. </li><li> by default. getMessageSeparatorString() Returns the string used to separate messages. Return type string setMessageCloseString(string $messageCloseString) Sets the string used to close message representation. Parameters $messageCloseString The string to use to close the messages. </li></ul> by default. getMessageCloseString() Returns the string used to close message representation. Return type string setAttributes(array $attributes) Set the attributes that will go on the message open format. Parameters $attributes Key value pairs of attributes. getAttributes() Returns the attributes that will go on the message open format. Return type array render(ElementInterface $element[, array $attributes = array() ]) Renders validation errors for the provided $element. Parameters $element The element. $attributes Additional attributes that will go on the message open format. These are merged with those set via setAttributes(). Return type string Uses Uses
602
121.2.8 FormFile
The FormFile view helper can be used to render a <input type="file"> form input. It is meant to work with the Zend\Form\Element\File element. FormFile extends from Zend\Form\View\Helper\FormInput. Basic usage:
1 2 3 4 5 6 7 8
use Zend\Form\Element; $element = new Element\File(my-file); // Within your view... echo $this->formFile($element); // <input type="file" name="my-file">
For HTML5 multiple le uploads, the multiple attribute can be used. Browsers that do not support HTML5 will default to a single upload input.
1 2 3 4 5 6 7 8 9
use Zend\Form\Element; $element = new Element\File(my-file); $element->setAttribute(multiple, true); // Within your view... echo $this->formFile($element); // <input type="file" name="my-file" multiple="multiple">
121.2.9 FormHidden
The FormHidden view helper can be used to render a <input type="hidden"> HTML form input. It is meant to work with the Zend\Form\Element\Hidden element. FormHidden extends from Zend\Form\View\Helper\FormInput. Basic usage:
1 2 3 4 5 6 7 8 9
use Zend\Form\Element; $element = new Element\Hidden(my-hidden); $element->setValue(foo); // Within your view... echo $this->formHidden($element); // <input type="hidden" name="my-hidden" value="foo">
121.2.10 FormImage
The FormImage view helper can be used to render a <input type="image"> HTML form input. It is meant to work with the Zend\Form\Element\Image element. FormImage extends from Zend\Form\View\Helper\FormInput. Basic usage:
1 2 3 4
603
5 6 7 8 9
121.2.11 FormInput
The FormInput view helper is used to render a <input> HTML form input tag. It acts as a base class for all of the specically typed form input helpers (FormText, FormCheckbox, FormSubmit, etc.), and is not suggested for direct use. It contains a general map of valid tag attributes and types for attribute ltering. Each subclass of FormInput implements its own specic map of valid tag attributes. The following public methods are in addition to those inherited from Zend\Form\View\Helper\AbstractHelper. render(ElementInterface $element) Renders the <input> tag for the $element. Return type string
121.2.12 FormLabel
The FormLabel view helper is used to render a <label> HTML element and its attributes. If you have a Zend\I18n\Translator\Translator attached, FormLabel will translate the label contents during its rendering. Basic usage:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
use Zend\Form\Element; $element = new Element\Text(my-text); $element->setLabel(Label) ->setAttribute(id, text-id) ->setLabelAttributes(array(class => control-label)); // Within your view... /** * Example #1: Render label in one shot */ echo $this->formLabel($element); // <label class="control-label" for="text-id">Label</label> echo $this->formLabel($element, $this->formText($element)); // <label class="control-label" for="text-id">Label<input type="text" name="my-text"></label> echo $this->formLabel($element, $this->formText($element), append); // <label class="control-label" for="text-id"><input type="text" name="my-text">Label</label> /** * Example #2: Render label in separate steps */ // Render the opening tag echo $this->formLabel()->openTag($element); // <label class="control-label" for="text-id">
604
29 30 31
// Setting a translator $this->formLabel()->setTranslator($translator); // Setting a text domain $this->formLabel()->setTranslatorTextDomain(my-text-domain); // Setting both $this->formLabel()->setTranslator($translator, my-text-domain);
Note: Note: If you have a translator in the Service Manager under the key, translator, the view helper plugin manager will automatically attach the translator to the FormLabel view helper. See Zend\\View\\HelperPluginManager::injectTranslator() for more information. The following public methods are in addition to those inherited from Zend\Form\View\Helper\AbstractHelper. __invoke(ElementInterface $element = null, string $labelContent = null, string $position = null) Render a form label, optionally with content. Always generates a for statement, as we cannot assume the form input will be provided in the $labelContent. Parameters $element A form element. $labelContent If null, will attempt to use the elements label value. $position Append or prepend the elements label value to the $labelContent. One of FormLabel::APPEND or FormLabel::PREPEND (default) Return type string openTag(array|ElementInterface $attributesOrElement = null) Renders the <label> open tag and attributes. Parameters $attributesOrElement An array of key value attributes or a ElementInterface instance. Return type string closeTag() Renders a </label> closing tag. Return type string
121.2.13 FormMultiCheckbox
The FormMultiCheckbox view helper can be used to render a group <input type="checkbox"> HTML form inputs. It is meant to work with the Zend\Form\Element\MultiCheckbox element, which provides a default input specication for validating a multi checkbox. FormMultiCheckbox extends from Zend\Form\View\Helper\FormInput. Basic usage:
605
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
use Zend\Form\Element; $element = new Element\MultiCheckbox(my-multicheckbox); $element->setValueOptions(array( 0 => Apple, 1 => Orange, 2 => Lemon, )); // Within your view... /** * Example #1: using the default label placement */ echo $this->formMultiCheckbox($element); // <label><input type="checkbox" name="my-multicheckbox[]" value="0">Apple</label> // <label><input type="checkbox" name="my-multicheckbox[]" value="1">Orange</label> // <label><input type="checkbox" name="my-multicheckbox[]" value="2">Lemon</label> /** * Example #2: using the prepend label placement */ echo $this->formMultiCheckbox($element, prepend); // <label>Apple<input type="checkbox" name="my-multicheckbox[]" value="0"></label> // <label>Orange<input type="checkbox" name="my-multicheckbox[]" value="1"></label> // <label>Lemon<input type="checkbox" name="my-multicheckbox[]" value="2"></label>
121.2.14 FormPassword
The FormPassword view helper can be used to render a <input type="password"> HTML form input. It is meant to work with the Zend\Form\Element\Password element. FormPassword extends from Zend\Form\View\Helper\FormInput. Basic usage:
1 2 3 4 5 6
use Zend\Form\Element; $element = new Element\Password(my-password); // Within your view... echo $this->formPassword($element);
Output:
1
121.2.15 FormRadio
The FormRadio view helper can be used to render a group <input type="radio"> HTML form inputs. It is meant to work with the Zend\Form\Element\Radio element, which provides a default input specication for validating a radio. FormRadio extends from Zend\Form\View\Helper\FormMultiCheckbox. Basic usage:
1 2 3
606
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
$element->setValueOptions(array( 0 => Male, 1 => Female, )); // Within your view... /** * Example #1: using the default label placement */ echo $this->formRadio($element); // <label><input type="radio" name="gender[]" value="0">Male</label> // <label><input type="radio" name="gender[]" value="1">Female</label> /** * Example #2: using the prepend label placement */ echo $this->formRadio($element, prepend); // <label>Male<input type="checkbox" name="gender[]" value="0"></label> // <label>Female<input type="checkbox" name="gender[]" value="1"></label>
121.2.16 FormReset
The FormReset view helper can be used to render a <input type="reset"> HTML form input. FormText extends from Zend\Form\View\Helper\FormInput. Basic usage:
1 2 3 4 5 6 7
use Zend\Form\Element; $element = new Element(my-reset); $element->setAttribute(value, Reset); // Within your view... echo $this->formReset($element);
Output:
1
121.2.17 FormRow
TODO Basic usage: TODO
121.2.18 FormSelect
The FormSelect view helper can be used to render a group <input type="select"> HTML form input. It is meant to work with the Zend\Form\Element\Select element, which provides a default input specication for validating a select. FormSelect extends from Zend\Form\View\Helper\FormInput. Basic usage:
607
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
use Zend\Form\Element; $element = new Element\Select(language); $element->setValueOptions(array( 0 => French, 1 => English, 2 => Japanese, 3 => Chinese )); // Within your view... /** * Example */ echo $this->formSelect($element);
121.2.19 FormSubmit
The FormSubmit view helper can be used to render a <input type="submit"> HTML form input. It is meant to work with the Zend\Form\Element\Submit element. FormSubmit extends from Zend\Form\View\Helper\FormInput. Basic usage:
1 2 3 4 5 6
use Zend\Form\Element; $element = new Element\Submit(my-submit); // Within your view... echo $this->formSubmit($element);
Output:
1
121.2.20 FormText
The FormText view helper can be used to render a <input type="text"> HTML form input. It is meant to work with the Zend\Form\Element\Text element. FormText extends from Zend\Form\View\Helper\FormInput. Basic usage:
1 2 3 4 5 6
use Zend\Form\Element; $element = new Element\Text(my-text); // Within your view... echo $this->formText($element);
Output:
1
608
121.2.21 FormTextarea
The FormTextarea view helper can be used to render a <textarea></textarea> HTML form input. It is meant to work with the Zend\Form\Element\Textarea element. Basic usage:
1 2 3 4 5 6
use Zend\Form\Element; $element = new Element\Textarea(my-textarea); // Within your view... echo $this->formTextarea($element);
Output:
1
<textarea name="my-textarea"></textarea>
121.2.22 AbstractHelper
The AbstractHelper is used as a base abstract class for Form view helpers, providing methods for validating form HTML attributes, as well as controlling the doctype and character encoding. AbstractHelper also extends from Zend\I18n\View\Helper\AbstractTranslatorHelper which provides an implementation for the Zend\I18n\Translator\TranslatorAwareInterface that allows setting a translator and text domain. The following public methods are in addition to the inherited methods of Zend\I18n\View\Helper\AbstractTranslatorHelper. setDoctype(string $doctype) Sets a doctype to use in the helper. getDoctype() Returns the doctype used in the helper. Return type string setEncoding(string $encoding) Set the translation text domain to use in helper when translating. getEncoding() Returns the character encoding used in the helper. Return type string getId() Returns the element id. If no ID attribute present, attempts to use the name attribute. If name attribute is also not present, returns null. Return type string or null
609
1 2 3 4 5 6
use Zend\Form\Element; $element = new Element\Color(my-color); // Within your view... echo $this->formColor($element);
Output:
1
121.3.2 FormDate
The FormDate view helper can be used to render a <input type="date"> HTML5 form input. It is meant to work with the Zend\Form\Element\Date element, which provides a default input specication for validating HTML5 date values. FormDate extends from Zend\Form\View\Helper\FormDateTime. Basic usage:
1 2 3 4 5 6 7 8
use Zend\Form\Element; $element = new Element\Date(my-date); // Within your view... echo $this->formDate($element); // <input type="date" name="my-date" value="">
121.3.3 FormDateTime
The FormDateTime view helper can be used to render a <input type="datetime"> HTML5 form input. It is meant to work with the Zend\Form\Element\DateTime element, which provides a default input specication for validating HTML5 datetime values. FormDateTime extends from Zend\Form\View\Helper\FormInput. Basic usage:
1 2 3 4 5 6 7 8
use Zend\Form\Element; $element = new Element\DateTime(my-datetime); // Within your view... echo $this->formDateTime($element); // <input type="datetime" name="my-datetime" value="">
121.3.4 FormDateTimeLocal
The FormDateTimeLocal view helper can be used to render a <input type="datetime-local"> HTML5 form input. It is meant to work with the Zend\Form\Element\DateTimeLocal element, which provides a default input specication for validating HTML5 datetime values. FormDateTimeLocal extends from Zend\Form\View\Helper\FormDateTime. Basic usage:
610
1 2 3 4 5 6 7 8
use Zend\Form\Element; $element = new Element\DateTimeLocal(my-datetime); // Within your view... echo $this->formDateTimeLocal($element); // <input type="datetime-local" name="my-datetime" value="">
121.3.5 FormEmail
The FormEmail view helper can be used to render a <input type="email"> HTML5 form input. It is meant to work with the Zend\Form\Element\Email element, which provides a default input specication with an email validator. FormEmail extends from Zend\Form\View\Helper\FormInput. Basic usage:
1 2 3 4 5 6 7 8
use Zend\Form\Element; $element = new Element\Email(my-email); // Within your view... echo $this->formEmail($element); // <input type="email" name="my-email" value="">
121.3.6 FormMonth
The FormMonth view helper can be used to render a <input type="month"> HTML5 form input. It is meant to work with the Zend\Form\Element\Month element, which provides a default input specication for validating HTML5 date values. FormMonth extends from Zend\Form\View\Helper\FormDateTime. Basic usage:
1 2 3 4 5 6 7 8
use Zend\Form\Element; $element = new Element\Month(my-month); // Within your view... echo $this->formMonth($element); // <input type="month" name="my-month" value="">
121.3.7 FormNumber
TODO Basic usage: TODO
121.3.8 FormRange
TODO Basic usage: TODO
611
121.3.9 FormSearch
The FormSearch view helper can be used to render a <input type="search"> HTML5 form input. FormSearch extends from Zend\Form\View\Helper\FormText. Basic usage:
1 2 3 4 5 6
use Zend\Form\Element; $element = new Element(my-search); // Within your view... echo $this->formSearch($element);
Output:
1
121.3.10 FormTel
The FormTel view helper can be used to render a <input type="tel"> HTML5 form input. FormTel extends from Zend\Form\View\Helper\FormInput. Basic usage:
1 2 3 4 5 6
use Zend\Form\Element; $element = new Element(my-tel); // Within your view... echo $this->formTel($element);
Output:
1
121.3.11 FormTime
The FormTime view helper can be used to render a <input type="time"> HTML5 form input. It is meant to work with the Zend\Form\Element\Time element, which provides a default input specication for validating HTML5 time values. FormTime extends from Zend\Form\View\Helper\FormDateTime. Basic usage:
1 2 3 4 5 6 7 8
use Zend\Form\Element; $element = new Element\Time(my-time); // Within your view... echo $this->formTime($element); // <input type="time" name="my-time" value="">
121.3.12 FormUrl
TODO Basic usage: TODO
612
121.3.13 FormWeek
The FormWeek view helper can be used to render a <input type="week"> HTML5 form input. It is meant to work with the Zend\Form\Element\Week element, which provides a default input specication for validating HTML5 week values. FormWeek extends from Zend\Form\View\Helper\FormDateTime. Basic usage:
1 2 3 4 5 6 7 8
use Zend\Form\Element; $element = new Element\Week(my-week); // Within your view... echo $this->formWeek($element); // <input type="week" name="my-week" value="">
// Within your view... echo $this->formFileApcProgress(); // <input type="hidden" id="progress_key" name="APC_UPLOAD_PROGRESS" value="12345abcde">
121.4.2 FormFileSessionProgress
The FormFileSessionProgress view helper can be used to render a <input type="hidden" ...> which can be used by the PHP 5.4 File Upload Session Progress feature. PHP 5.4 is required for this view helper to work. Unlike other Form view helpers, the FormFileSessionProgress helper does not accept a Form Element as a parameter. An id attribute with a value of "progress_key" will automatically be added. Warning: The view helper must be rendered before the le input in the form, or upload progress will not work correctly.
613
Best used with the Zend\ProgressBar\Upload\SessionProgress handler. See the Session Upload Progress in the PHP documentation for more information. FormFileSessionProgress extends from Zend\Form\View\Helper\FormInput. Basic usage:
1 2 3 4
// Within your view... echo $this->formFileSessionProgress(); // <input type="hidden" id="progress_key" name="PHP_SESSION_UPLOAD_PROGRESS" value="12345abcde">
121.4.3 FormFileUploadProgress
The FormFileUploadProgress view helper can be used to render a <input type="hidden" ...> which can be used by the PECL uploadprogress extension. Unlike other Form view helpers, the FormFileUploadProgress helper does not accept a Form Element as a parameter. An id attribute with a value of "progress_key" will automatically be added. Warning: The view helper must be rendered before the le input in the form, or upload progress will not work correctly. Best used with the Zend\ProgressBar\Upload\UploadProgress handler. See the PECL uploadprogress extension for more information. FormFileUploadProgress extends from Zend\Form\View\Helper\FormInput. Basic usage:
1 2 3 4
// Within your view... echo $this->formFileSessionProgress(); // <input type="hidden" id="progress_key" name="UPLOAD_IDENTIFIER" value="12345abcde">
614
CHAPTER 122
Overview of Zend\Http
122.1 Overview
Zend\Http is a primary foundational component of Zend Framework. Since much of what PHP does is web-based, specically HTTP, it makes sense to have a performant, extensible, concise and consistent API to do all things HTTP. In nutshell, there are several parts of Zend\Http: Context-less Request and Response classes that expose a uent API for introspecting several aspects of HTTP messages: Request line information and response status information Parameters, such as those found in POST and GET Message Body Headers A Client implementation with various adapters that allow for sending requests and introspecting responses.
615
616
CHAPTER 123
123.1 Overview
The Zend\Http\Request object is responsible for providing a uent API that allows a developer to interact with all the various parts of an HTTP request. A typical HTTP request looks like this:
-------------------------| METHOD | URI | VERSION | -------------------------| HEADERS | -------------------------| BODY | --------------------------
In simplied terms, the request consists of a method, URI and HTTP version number which together make up the Request Line. Next come the HTTP headers, of which there can be 0 or more. After that is the request body, which is typically used when a client wishes to send data to the server in the form of an encoded le, or include a set of POST parameters, for example. More information on the structure and specication of a HTTP request can be found in RFC-2616 on the W3.org site.
use Zend\Http\Request; $request = Request::fromString(<<<EOS POST /foo HTTP/1.1 \r\n HeaderField1: header-field-value1 HeaderField2: header-field-value2 \r\n\r\n foo=bar& EOS );
617
12 13 14 15 16 17 18 19 20 21 22
// OR, the completely equivalent $request = new Request(); $request->setMethod(Request::METHOD_POST); $request->setUri(/foo); $request->getHeaders()->addHeaders(array( HeaderField1 => header-field-value1, HeaderField2 => header-field-value2, )); $request->getPost()->set(foo, bar);
618
getVersion getVersion() Return the HTTP version for this request. Returns string setQuery setQuery(Zend\Stdlib\ParametersInterface $query) Provide an alternate Parameter Container implementation for query parameters in this object. (This is NOT the primary API for value setting; for that, see getQuery()). Returns Zend\Http\Request getQuery getQuery(string|null $name, mixed|null $default) Return the parameter container responsible for query parameters or a single query parameter. Returns string, Zend\Stdlib\ParametersInterface, or null depending on value of $name argument. setPost setPost(Zend\Stdlib\ParametersInterface $post) Provide an alternate Parameter Container implementation for POST parameters in this object. (This is NOT the primary API for value setting; for that, see getPost()). Returns Zend\Http\Request getPost getPost(string|null $name, mixed|null $default) Return the parameter container responsible for POST parameters or a single POST parameter. Returns string, Zend\Stdlib\ParametersInterface, or null depending on value of $name argument. getCookie getCookie() Return the Cookie header, this is the same as calling $request->getHeaders()->get(Cookie);. Returns Zend\Http\Header\Cookie setFiles setFiles(Zend\Stdlib\ParametersInterface $files) Provide an alternate Parameter Container implementation for le parameters in this object, (This is NOT the primary API for value setting; for that, see getFiles()). Returns Zend\Http\Request getFiles getFiles(string|null $name, mixed|null $default) Return the parameter container responsible for le parameters or a single le parameter. Returns string, Zend\Stdlib\ParametersInterface, or null depending on value of $name argument. setHeaders setHeaders(Zend\Http\Headers $headers) Provide an alternate Parameter Container implementation for headers in this object, (this is NOT the primary API for value setting, for that see getHeaders()). Returns Zend\Http\Request getHeaders getHeaders(string|null $name, mixed|null $default) Return the container responsible for storing HTTP headers. This container exposes the primary API for manipulating headers set in the HTTP request. See the section on Zend\Http\Headers for more information. Returns Zend\Http\Headers if $name is null. Returns Zend\Http\Header\HeaderInterface or ArrayIterator if $name matches one or more stored headers, respectively.
619
setMetadata setMetadata(string|int|array|Traversable $spec, mixed $value) Set message metadata. Non-destructive setting of message metadata; always adds to the metadata, never overwrites the entire metadata container. Returns Zend\Http\Request getMetadata getMetadata(null|string|int $key, null|mixed $default) Retrieve all metadata or a single metadatum as specied by key. Returns mixed setContent setContent(mixed $value) Set request body (content). Returns Zend\Http\Request getContent getContent() Get request body (content). Returns mixed isOptions isOptions() Is this an OPTIONS method request? Returns bool isGet isGet() Is this a GET method request? Returns bool isHead isHead() Is this a HEAD method request? Returns bool isPost isPost() Is this a POST method request? Returns bool isPut isPut() Is this a PUT method request? Returns bool isDelete isDelete() Is this a DELETE method request? Returns bool isTrace isTrace() Is this a TRACE method request? Returns bool
620
isConnect isConnect() Is this a CONNECT method request? Returns bool isPatch isPatch() Is this a PATCH method request? Returns bool isXmlHttpRequest isXmlHttpRequest() Is this a Javascript XMLHttpRequest? Returns bool isFlashRequest isFlashRequest() Is this a Flash request? Returns bool renderRequestLine renderRequestLine() Return the formatted request line (rst line) for this HTTP request. Returns string toString toString() Returns string __toString __toString() Allow PHP casting of this object. Returns string
123.5 Examples
Generating a Request object from a string use Zend\Http\Request; $string = "GET /foo HTTP/1.1\r\n\r\nSome Content"; $request = Request::fromString($string); $request->getMethod(); $request->getUri(); $request->getUriString(); $request->getVersion(); $request->getContent(); // // // // // returns returns returns returns returns Request::METHOD_GET Zend\Uri\Http object /foo Request::VERSION_11 or 1.1 Some Content
1 2 3 4 5 6 7 8 9 10
Retrieving and setting headers use Zend\Http\Request; use Zend\Http\Header\Cookie; $request = new Request();
1 2 3 4
123.5. Examples
621
5 6 7 8 9
$request->getHeaders()->get(Content-Type); // return content type $request->getHeaders()->addHeader(new Cookie(array(foo => bar))); foreach ($request->getHeaders() as $header) { echo $header->getFieldName() . with value . $header->getFieldValue(); }
Retrieving and setting GET and POST values use Zend\Http\Request; $request = new Request(); // getPost() and getQuery() both return, by default, a Parameters object, which extends ArrayObject $request->getPost()->foo = Foo value; $request->getQuery()->bar = Bar value; $request->getPost(foo); // returns Foo value $request->getQuery()->offsetGet(bar); // returns Bar value
1 2 3 4 5 6 7 8 9
Generating a formatted HTTP Request from a Request object use Zend\Http\Request; $request = new Request(); $request->setMethod(Request::METHOD_POST); $request->setUri(/foo); $request->getHeaders()->addHeaders(array( HeaderField1 => header-field-value1, HeaderField2 => header-field-value2, )); $request->getPost()->set(foo, bar); echo $request->toString(); /** Will produce: POST /foo HTTP/1.1 HeaderField1: header-field-value1 HeaderField2: header-field-value2 foo=bar */
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
622
CHAPTER 124
124.1 Overview
The Zend\Http\Response class is responsible for providing a uent API that allows a developer to interact with all the various parts of an HTTP response. A typical HTTP Response looks like this:
--------------------------| VERSION | CODE | REASON | --------------------------| HEADERS | --------------------------| BODY | ---------------------------
The rst line of the response consists of the HTTP version, status code, and the reason string for the provided status code; this is called the Response Line. Next is a set of headers; there can be 0 or an unlimited number of headers. The remainder of the response is the response body, which is typically a string of HTML that will render on the clients browser, but which can also be a place for request/response payload data typical of an AJAX request. More information on the structure and specication of an HTTP response can be found in RFC-2616 on the W3.org site.
use Zend\Http\Response; $response = Response::fromString(<<<EOS HTTP/1.0 200 OK HeaderField1: header-field-value HeaderField2: header-field-value2 <html> <body> Hello World </body> </html>
623
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
EOS); // OR $response = new Response(); $response->setStatusCode(Response::STATUS_CODE_200); $response->getHeaders()->addHeaders(array( HeaderField1 => header-field-value, HeaderField2 => header-field-value2, )); $response->setContent(<<<EOS <html> <body> Hello World </body> </html> EOS);
624
getVersion getVersion() Return the HTTP version for this request Returns string setStatusCode setStatusCode(numeric $code) Set HTTP status code Returns Zend\Http\Response getStatusCode getStatusCode() Retrieve HTTP status code Returns int setReasonPhrase setReasonPhrase(string $reasonPhrase) Set custom HTTP status message Returns Zend\Http\Response getReasonPhrase getReasonPhrase() Get HTTP status message Returns string isClientError isClientError() Does the status code indicate a client error? Returns bool isForbidden isForbidden() Is the request forbidden due to ACLs? Returns bool isInformational isInformational() Is the current status informational? Returns bool isNotFound isNotFound() Does the status code indicate the resource is not found? Returns bool isOk isOk() Do we have a normal, OK response? Returns bool isServerError isServerError() Does the status code reect a server error? Returns bool isRedirect isRedirect() Do we have a redirect? Returns bool
625
isSuccess isSuccess() Was the response successful? Returns bool decodeChunkedBody decodeChunkedBody(string $body) Decode a chunked transfer-encoded body and return the decoded text Returns string decodeGzip decodeGzip(string $body) Decode a gzip encoded message (when Content-encoding = gzip) Currently requires PHP with zlib support Returns string decodeDeate decodeDeflate(string $body) Decode a zlib deated message (when Content-encoding = deate) Currently requires PHP with zlib support Returns string setMetadata setMetadata(string|int|array|Traversable $spec, mixed $value) Set message metadata Non-destructive setting of message metadata; always adds to the metadata, never overwrites the entire metadata container. Returns Zend\Stdlib\Message getMetadata getMetadata(null|string|int $key, null|mixed $default) Retrieve all metadata or a single metadatum as specied by key Returns mixed setContent setContent(mixed $value) Set message content Returns Zend\Stdlib\Message getContent getContent() Get message content Returns mixed toString toString() Returns string
124.5 Examples
Generating a Response object from a string
626
1 2 3 4 5 6 7 8 9 10 11 12
use Zend\Http\Response; $request = Response::fromString(<<<EOS HTTP/1.0 200 OK HeaderField1: header-field-value HeaderField2: header-field-value2 <html> <body> Hello World </body> </html> EOS);
Generating a formatted HTTP Response from a Response object use Zend\Http\Response; $response = new Response(); $response->setStatusCode(Response::STATUS_CODE_200); $response->getHeaders()->addHeaders(array( HeaderField1 => header-field-value, HeaderField2 => header-field-value2, )); $response->setContent(<<<EOS <html> <body> Hello World </body> </html> EOS);
1 2 3 4 5 6 7 8 9 10 11 12 13 14
124.5. Examples
627
628
CHAPTER 125
125.1 Overview
The Zend\Http\Headers class is a container for HTTP headers. It is typically accessed as part of a Zend\Http\Request or Zend\Http\Response getHeaders() call. The Headers container will lazily load actual Header objects as to reduce the overhead of header specic parsing. The Zend\Http\Header\* classes are the domain specic implementations for the various types of Headers that one might encounter during the typical HTTP request. If a header of unknown type is encountered, it will be implemented as a Zend\Http\Header\GenericHeader instance. See the below table for a list of the various HTTP headers and the API that is specic to each header type.
// $client is an instance of Zend\Http\Client // You can retrieve the request headers by first retrieving // the Request object and then calling getHeaders on it $requestHeaders = $client->getRequest()->getHeaders(); // The same method also works for retrieving Response headers $responseHeaders = $client->getResponse()->getHeaders();
$headerString = <<<EOB Host: www.example.com Content-Type: text/html Content-Length: 1337 EOB; $headers = Zend\Http\Headers::fromString($headerString); // $headers is now populated with three objects // (1) Zend\Http\Header\Host
629
10 11
// //
Now that you have an instance of Zend\Http\Headers you can manipulate the individual headers it contains using the provided public API methods outlined in the Available Methods section.
630
clearHeaders clearHeaders() Clear all headers Removes all headers from queue Returns Zend\Http\Headers get get(string $name) Get all headers of a certain name/type Returns false| Zend\Http\Header\HeaderInterface| ArrayIterator has has(string $name) Test for existence of a type of header Returns bool next next() Advance the pointer for this object as an iterator Returns void key key() Return the current key for this object as an iterator Returns mixed valid valid() Is this iterator still valid? Returns bool rewind rewind() Reset the internal pointer for this object as an iterator Returns void current current() Return the current value for this iterator, lazy loading it if need be Returns Zend\Http\Header\HeaderInterface count count() Return the number of headers in this container. If all headers have not been parsed, actual count could increase if MultipleHeader objects exist in the Request/Response. If you need an exact count, iterate. Returns int toString toString() Render all headers at once This method handles the normal iteration of headers; it is up to the concrete classes to prepend with the appropriate status/request line. Returns string toArray toArray() Return the headers container as an array Returns array
631
forceLoading forceLoading() By calling this, it will force parsing and loading of all headers, after this count() will be accurate Returns bool
Class Name Accept AcceptCharset AcceptEncoding AcceptLanguage AcceptRanges Age Allow AuthenticationInfo Authorization CacheControl Connection ContentDisposition ContentEncoding ContentLanguage ContentLength ContentLocation
Additional Methods N/A N/A N/A N/A getRangeUnit() / setRangeUnit() - The range unit of the accept ranges header getDeltaSeconds() / setDeltaSeconds() - The age in delta seconds getAllowedMethods() / setAllowedMethods() - An array of allowed methods N/A N/A N/A N/A N/A N/A N/A N/A N/A
632
Class Name ContentMD5 ContentRange ContentType Cookie Date Etag Expect Expires From Host IfMatch IfModiedSince IfNoneMatch IfRange IfUnmodiedSince KeepAlive LastModied Location MaxForwards Pragma ProxyAuthenticate ProxyAuthorization Range Referer Refresh RetryAfter Server SetCookie TE Trailer TransferEncoding Upgrade UserAgent Vary Via Warning WWWAuthenticate
Additional Methods N/A N/A N/A Extends \ArrayObject setEncodeValue() / getEncodeValue() - Whether or not to encode values N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A getName() / setName() - The cookie name getValue() / setValue() - The cookie value getExpires() / setExpires() N/A N/A N/A N/A N/A N/A N/A N/A N/A
125.7 Examples
Retrieving headers from a Zend\Http\Headers object // $client is an instance of Zend\Http\Client $response = $client->send(); $headers = $response->getHeaders(); // We can check if the Request contains a specific header by // using the has method. Returns boolean TRUE if at least // one matching header found, and FALSE otherwise
1 2 3 4 5 6 7
125.7. Examples
633
8 9 10 11 12
$headers->has(Content-Type); // We can retrieve all instances of a specific header by using // the get method: $contentTypeHeaders = $headers->get(Content-Type);
There are three possibilities for the return value of the above call to the get method: If no Content-Type header was set in the Request, get will return false. If only one Content-Type header was set in the Request, Zend\Http\Header\ContentType. get will return an instance of
If more than one Content-Type header was set in the Request, get will return an ArrayIterator containing one Zend\Http\Header\ContentType instance per header.
Adding headers to a Zend\Http\Headers object $headers = new Zend\Http\Headers(); // We can directly add any object that implements Zend\Http\Header\HeaderInterface $typeHeader = Zend\Http\Header\ContentType::fromString(Content-Type: text/html); $headers->addHeader($typeHeader); // We can add headers using the raw string representation, either // passing the header name and value as separate arguments... $headers->addHeaderLine(Content-Type, text/html); // .. or we can pass the entire header as the only argument $headers->addHeaderLine(Content-Type: text/html); // We can also add headers in bulk using addHeaders, which accepts // an array of individual header definitions that can be in any of // the accepted formats outlined below: $headers->addHeaders(array( // An object implementing Zend\Http\Header\HeaderInterface Zend\Http\Header\ContentType::fromString(Content-Type: text/html), // A raw header string Content-Type: text/html, // We can also pass the header name as the array key and the // header content as that array keys value Content-Type => text/html); ));
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
We can remove all headers of a specic type using the removeHeader method, which accepts a single object implementing Zend\Http\Header\HeaderInterface
1 2 3
// $headers is a pre-configured instance of Zend\Http\Headers // We can also delete individual headers or groups of headers
634
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
$matches = $headers->get(Content-Type); // If more than one header was found, iterate over the collection // and remove each one individually if ($matches instanceof ArrayIterator) { foreach ($headers as $header) { $headers->removeHeader($header); } // If only a single header was found, remove it directly } elseif ($matches instanceof Zend\Http\Header\HeaderInterface) { $headers->removeHeader($header); } // In addition to this, we can clear all the headers currently stored in // the container by calling the clearHeaders() method $matches->clearHeaders();
125.7. Examples
635
636
CHAPTER 126
126.1 Overview
Zend\Http\Client provides an easy interface for performing Hyper-Text Transfer Protocol (HTTP) requests. Zend\Http\Client supports the most simple features expected from an HTTP client, as well as some more complex features such as HTTP authentication and le uploads. Successful requests (and most unsuccessful ones too) return a Zend\Http\Response object, which provides access to the responses headers and body (see this section).
use Zend\Http\Client; $client = new Client(http://example.org, array( maxredirects => 0, timeout => 30 )); // This is actually exactly the same: $client = new Client(); $client->setUri(http://example.org); $client->setOptions(array( maxredirects => 0, timeout => 30 )); // You can also pass a Zend\Config\Config object to set the clients configuration $config = Zend\Config\Factory::fromFile(httpclient.ini); $client->setOptions($config);
Note: Zend\Http\Client uses Zend\Uri\Http to validate URLs. See the Zend\Uri manual page for more information on the validation process.
637
boolean FALSE
Zend\Http\Client 10 1.1
boolean TRUE
boolean TRUE
boolean FALSE
boolean FALSE
638
While this method is not called more than once for a client, it is separated from ->send() to preserve logic and readability Returns Zend\Http\Client getAdapter getAdapter() Retrieve the connection adapter Returns Zend\Http\Client\Adapter\AdapterInterface setRequest setRequest(Zend\Http\Request $request) Set request object Returns void getRequest getRequest() Get Request object Returns Zend\Http\Request getLastRawRequest getLastRawRequest() Get the last request (as a string) Returns string setResponse setResponse(Zend\Http\Response $response) Set response Returns Zend\Http\Client getResponse getResponse() Get Response object Returns Zend\Http\Response getLastRawResponse getLastRawResponse() Get the last response (as a string) Returns string getRedirectionsCount getRedirectionsCount() Get the redirections count Returns integer setUri setUri(string|Zend\Http\Zend\Uri\Http $uri) Set Uri (to the request) Returns Zend\Http\Client getUri getUri() Get uri (from the request) Returns Zend\Uri\Http setMethod setMethod(string $method) Set the HTTP method (to the request) Returns Zend\Http\Client
639
getMethod getMethod() Get the HTTP method Returns string setEncType setEncType(string $encType, string $boundary) Set the encoding type and the boundary (if any) Returns void getEncType getEncType() Get the encoding type Returns type setRawBody setRawBody(string $body) Set raw body (for advanced use cases) Returns Zend\Http\Client setParameterPost setParameterPost(array $post) Set the POST parameters Returns Zend\Http\Client setParameterGet setParameterGet(array $query) Set the GET parameters Returns Zend\Http\Client getCookies getCookies() Return the current cookies Returns array addCookie addCookie(ArrayIterator|SetCookie|string $cookie, string $value = null, string $expire = null, string $path = null, string $domain = null, boolean $secure = false, boolean $httponly = true, string $maxAge = null, string $version = null) Add a cookie Returns Zend\Http\Client setCookies setCookies(array $cookies) Set an array of cookies Returns Zend\Http\Client clearCookies clearCookies() Clear all the cookies Returns void setHeaders setHeaders(Zend\Http\Headers|array $headers) Set the headers (for the request) Returns Zend\Http\Client
640
hasHeader hasHeader(string $name) Check if exists the header type specied Returns boolean getHeader getHeader(string $name) Get the header value of the request Returns string|boolean setStream setStream(string|boolean $streamfile = true) Set streaming for received data Returns Zend\Http\Client getStream getStream() Get status of streaming for received data Returns boolean|string setAuth setAuth(string $user, string $password, string $type = basic) Create a HTTP authentication Authorization: header according to the specied user, password and authentication method. Returns Zend\Http\Client resetParameters resetParameters() Reset all the HTTP parameters (auth,cookies,request, response, etc) Returns void dispatch dispatch(Zend\Stdlib\RequestInterface $request, Zend\Stdlib\ResponseInterface $response= null) Dispatch HTTP request Returns Response send send(Zend\Http\Request $request) Send HTTP request Returns Response setFileUpload setFileUpload(string $filename, string $formname, string $data = null, string $ctype = null) Set a le to upload (using a POST request) Can be used in two ways: 1. $data is null (default): $lename is treated as the name if a local le which will be read and sent. Will try to guess the content type using mime_content_type(). 2. $data is set - $lename is sent as the le name, but $data is sent as the le contents and no le is read from the le system. In this case, you need to manually set the Content-Type ($ctype) or it will default to application/octet-stream. Returns Zend\Http\Client removeFileUpload removeFileUpload(string $filename) Remove a le to upload Returns boolean
641
encodeFormData encodeFormData(string $boundary, string $name, mixed $value, string $filename = null, array $headers = array ( )) Encode data to a multipart/form-data part suitable for a POST request. Returns string
126.5 Examples
126.5.1 Performing a Simple GET Request
Performing simple HTTP requests is very easily done using the setRequest() and dispatch() methods:
1 2 3 4 5 6 7
use Zend\Http\Client; use Zend\Http\Request; $request = new Request(); $client = new Client(http://example.org); $client->setRequest($request); $response = $client->dispatch();
The request object can be congured using his methods as shown in the Zend\Http\Request manual page. One of these methods is setMethod which refers to the HTTP Method. This can be either GET, POST, PUT, HEAD, DELETE, TRACE, OPTIONS or CONNECT as dened by the HTTP protocol 1 .
If no method is specied, the method set by the last setMethod() call is used. If setMethod() was never called, the default request method is GET (see the above example).
1 2 3 4 5 6 7 8 9 10 11
use Zend\Http\Client; use Zend\Http\Request; $request = new Request(); $request->setUri(http://example.org); $client = new Client(); // Performing a POST request $request->setMethod(Request::METHOD_POST); $client->setRequest($request); $response = $client->dispatch();
642
1 2 3 4 5 6 7 8 9 10 11 12 13
use Zend\Http\Client; $client = new Client(); // This is equivalent to setting a URL in the Clients constructor: $client->setUri(http://example.com/index.php?knight=lancelot); // Adding several parameters with one call $client->setParameterGet(array( first_name => Bender, middle_name => Bending, last_name => Rodrguez, made_in => Mexico, ));
use Zend\Http\Client; $client = new Client(); // Setting several POST parameters, one of them with several values $client->setParameterPost(array( language => es, country => ar, selection => array(45, 32, 80) ));
Note that when sending POST requests, you can set both GET and POST parameters. On the other hand, setting POST parameters on a non-POST request will not trigger an error, rendering it useless. Unless the request is a POST request, POST parameters are simply ignored.
use Zend\Http\Request; use Zend\Http\Client; $request = new Request(); $request->setUri(http://www.test.com); $request->setMethod(POST); $request->getPost()->set(foo, bar); $client = new Client(); $response = $client->dispatch($request); if ($response->isSuccess()) { // the POST was successful }
126.5. Examples
643
644
CHAPTER 127
127.1 Overview
Zend\Http\Client is based on a connection adapter design. The connection adapter is the object in charge of performing the actual connection to the server, as well as writing requests and reading responses. This connection adapter can be replaced, and you can create and extend the default connection adapters to suite your special needs, without the need to extend or replace the entire HTTP client class, and with the same interface. Currently, the Zend\Http\Client class provides four built-in connection adapters: Zend\Http\Client\Adapter\Socket (default) Zend\Http\Client\Adapter\Proxy Zend\Http\Client\Adapter\Curl Zend\Http\Client\Adapter\Test The Zend\Http\Client objects adapter connection adapter is set using the adapter conguration option. When instantiating the client object, you can set the adapter conguration option to a string containing the adapters name (eg. Zend\Http\Client\Adapter\Socket) or to a variable holding an adapter object (eg. new Zend\Http\Client\Adapter\Socket). You can also set the adapter later, using the Zend\Http\Client->setAdapter() method.
Note: Persistent TCP Connections Using persistent TCP connections can potentially speed up HTTP requests - but in most use cases, will have little positive effect and might overload the HTTP server you are connecting to. 645
It is recommended to use persistent TCP connections only if you connect to the same server very frequently, and are sure that the server is capable of handling a large number of concurrent connections. In any case you are encouraged to benchmark the effect of persistent connections on both the client speed and server load before using this option. Additionally, when using persistent connections it is recommended to enable Keep-Alive HTTP requests as described in the conguration section- otherwise persistent connections might have little or no effect.
Note: HTTPS SSL Stream Parameters ssltransport, sslcert and sslpassphrase are only relevant when connecting using HTTPS. While the default SSL settings should work for most applications, you might need to change them if the server you are connecting to requires special client setup. If so, you should read the sections about SSL transport layers and options here.
Changing the HTTPS transport layer // Set the configuration parameters $config = array( adapter => Zend\Http\Client\Adapter\Socket, ssltransport => tls ); // Instantiate a client object $client = new Zend\Http\Client(https://www.example.com, $config); // The following request will be sent over a TLS secure connection. $response = $client->send();
1 2 3 4 5 6 7 8 9 10 11
The result of the example above will be similar to opening a TCP connection using the following PHP command: fsockopen(tls://www.example.com, 443)
646
Setting stream context options for the Socket adapter // Array of options $options = array( socket => array( // Bind local socket side to a specific interface bindto => 10.1.2.3:50505 ), ssl => array( // Verify server side certificate, // do not accept invalid or self-signed SSL certificates verify_peer => true, allow_self_signed => false, // Capture the peers certificate capture_peer_cert => true ) ); // Create an adapter object and attach it to the HTTP client $adapter = new Zend\Http\Client\Adapter\Socket(); $client = new Zend\Http\Client(); $client->setAdapter($adapter); // Method 1: pass the options array to setStreamContext() $adapter->setStreamContext($options); // Method 2: create a stream context and pass it to setStreamContext() $context = stream_context_create($options); $adapter->setStreamContext($context); // Method 3: get the default stream context and set the options on it $context = $adapter->getStreamContext(); stream_context_set_option($context, $options); // Now, perform the request $response = $client->send(); // If everything went well, you can now access the context again $opts = stream_context_get_options($adapter->getStreamContext()); echo $opts[ssl][peer_certificate];
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
Note: Note that you must set any stream context options before using the adapter to perform actual requests. If no context is set before performing HTTP requests with the Socket adapter, a default stream context will be created. This context resource could be accessed after performing any requests using the getStreamContext() method.
647
proxy_host should always be set - if it is not set, the client will fall back to a direct connection using Zend\Http\Client\Adapter\Socket. proxy_port defaults to 8080 - if your proxy listens on a different port you must set this one as well. proxy_user and proxy_pass are only required if your proxy server requires you to authenticate. Providing these will add a Proxy-Authentication header to the request. If your proxy does not require authentication, you can leave these two options out. proxy_auth sets the proxy authentication type, if your proxy server requires authentication. Possibly values are similar to the ones accepted by the Zend\Http\Client::setAuth() method. Currently, only basic authentication (Zend\Http\Client::AUTH_BASIC) is supported.
Using Zend\Http\Client behind a proxy server // Set the configuration parameters $config = array( adapter => Zend\Http\Client\Adapter\Proxy, proxy_host => proxy.int.zend.com, proxy_port => 8000, proxy_user => shahar.e, proxy_pass => bananashaped ); // Instantiate a client object $client = new Zend\Http\Client(http://www.example.com, $config); // Continue working...
1 2 3 4 5 6 7 8 9 10 11 12 13
As mentioned, if proxy_host is not set or is set to a blank string, the connection will fall back to a regular direct connection. This allows you to easily write your application in a way that allows a proxy to be used optionally, according to a conguration parameter. Note: Since the proxy adapter inherits from Zend\Http\Client\Adapter\Socket, you can use the stream context access method (see this section) to set stream context options on Proxy connections as demonstrated above.
1 2 3 4 5
648
By default the cURL adapter is congured to behave exactly like the Socket Adapter and it also accepts the same conguration parameters as the Socket and Proxy adapters. You can also change the cURL options by either specifying the curloptions key in the constructor of the adapter or by calling setCurlOption($name, $value). The $name key corresponds to the CURL_* constants of the cURL extension. You can get access to the Curl handle by calling $adapter->getHandle();
Transfering Files by Handle
You can use cURL to transfer very large les over HTTP by lehandle.
1 2 3 4 5 6 7 8 9 10 11 12 13 14
$putFileSize = filesize("filepath"); $putFileHandle = fopen("filepath", "r"); $adapter = new Zend\Http\Client\Adapter\Curl(); $client = new Zend\Http\Client(); $client->setAdapter($adapter); $client->setMethod(PUT); $adapter->setOptions(array( curloptions => array( CURLOPT_INFILE => $putFileHandle, CURLOPT_INFILESIZE => $putFileSize ) )); $client->send();
1 2 3 4 5 6 7 8 9 10 11 12
649
13 14 15 16 17 18 19 20 21 22 23
<rss version="2.0" . xmlns:content="http://purl.org/rss/1.0/modules/content/" . xmlns:wfw="http://wellformedweb.org/CommentAPI/" . xmlns:dc="http://purl.org/dc/elements/1.1/"> . <channel> . <title>Premature Optimization</title> . // and so on... </rss>); $response = $client->send(); // .. continue parsing $response..
The above example shows how you can preset your HTTP client to return the response you need. Then, you can continue testing your own code, without being dependent on a network connection, the servers response, etc. In this case, the test would continue to check how the application parses the XML in the response body. Sometimes, a single method call to an object can result in that object performing multiple HTTP transactions. In this case, its not possible to use setResponse() alone because theres no opportunity to set the next response(s) your program might need before returning to the caller.
Testing Against Multiple HTTP Response Stubs // Instantiate a new adapter and client $adapter = new Zend\Http\Client\Adapter\Test(); $client = new Zend\Http\Client(http://www.example.com, array( adapter => $adapter )); // Set the first expected response $adapter->setResponse( "HTTP/1.1 302 Found" . "\r\n" . "Location: /" . "\r\n" . "Content-Type: text/html" . "\r\n" . "\r\n" . <html> . <head><title>Moved</title></head> . <body><p>This page has moved.</p></body> . </html>); // Set the next successive response $adapter->addResponse( "HTTP/1.1 200 OK" . "\r\n" . "Content-Type: text/html" . "\r\n" . "\r\n" . <html> . <head><title>My Pet Store Home Page</title></head> . <body><p>...</p></body> . </html>); // inject the http client object ($client) into your object // being tested and then test your objects behavior below
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
The setResponse() method clears any responses in the Zend\Http\Client\Adapter\Tests buffer and sets the rst response that will be returned. The addResponse() method will add successive responses. The responses will be replayed in the order that they were added. If more requests are made than the number of responses stored, the responses will cycle again in order.
650
In the example above, the adapter is congured to test your objects behavior when it encounters a 302 redirect. Depending on your application, following a redirect may or may not be desired behavior. In our example, we expect that the redirect will be followed and we congure the test adapter to help us test this. The initial 302 response is set up with the setResponse() method and the 200 response to be returned next is added with the addResponse() method. After conguring the test adapter, inject the HTTP client containing the adapter into your object under test and test its behavior. If you need the adapter to fail on demand you can use setNextRequestWillFail($flag). The method will cause the next call to connect() to throw an Zend\Http\Client\Adapter\Exception\RuntimeException exception. This can be useful when our application caches content from an external site (in case the site goes down) and you want to test this feature.
Forcing the adapter to fail // Instantiate a new adapter and client $adapter = new Zend\Http\Client\Adapter\Test(); $client = new Zend\Http\Client(http://www.example.com, array( adapter => $adapter )); // Force the next request to fail with an exception $adapter->setNextRequestWillFail(true); try { // This call will result in a Zend\Http\Client\Adapter\Exception\RuntimeException $client->request(); } catch (Zend\Http\Client\Adapter\Exception\RuntimeException $e) { // ... } // Further requests will work as expected until // you call setNextRequestWillFail(true) again
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
1 2 3 4 5 6 7
651
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
*/ public function setOptions($config = array()) { // This rarely changes - you should usually copy the // implementation in Zend\Http\Client\Adapter\Socket. } /** * Connect to the remote server * * @param string $host $port * @param int * @param boolean $secure */ public function connect($host, $port = 80, $secure = false) { // Set up the connection to the remote server } /** * Send request to the remote server * $method * @param string * @param Zend\Uri\Http $url $http_ver * @param string $headers * @param array $body * @param string * @return string Request as text */ public function write($method, $url, $http_ver = 1.1, $headers = array(), $body = ) { // Send request to the remote server. // This function is expected to return the full request // (headers and body) as a string } /** * Read response from server * * @return string */ public function read() { // Read response from remote server and return it as a string } /** * Close the connection to the server * */ public function close() { // Close the connection to the remote server - called last. }
652
66 67 68 69 70 71
} // Then, you could use this adapter: $client = new Zend\Http\Client(array( adapter => MyApp\Http\Client\Adapter\BananaProtocol ));
653
654
CHAPTER 128
1 2 3 4 5
You can always get the number of redirections done after sending a request using the getRedirectionsCount() method.
1 2 3
655
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
// By directly providing a raw cookie string (name=value) // Note that the value must be already URL encoded $client->addCookie(flavor=chocolate%20chips); // By providing a Zend\Http\Header\SetCookie object $cookie = Zend\Http\Header\SetCookie::fromString(flavor=chocolate%20chips); $client->addCookie($cookie); // Multiple cookies can be set at once by providing an // array of Zend\Http\Header\SetCookie objects $cookies = array( Zend\Http\Header\SetCookie::fromString(flavorOne=chocolate%20chips), Zend\Http\Header\SetCookie::fromString(flavorTwo=vanilla), ); $client->addCookie($cookies);
The setCookies() method works in a similar manner, except that it requires an array of cookie values as its only argument and also clears the cookie container before adding the new cookies:
Setting Cookies Using setCookies() // setCookies accepts an array of cookie values, which // can be in either of the following formats: $client->setCookies(array( // A raw cookie string (name=value) // Note that the value must be already URL encoded flavor=chocolate%20chips, // A Zend\Http\Header\SetCookie object Zend\Http\Header\SetCookie::fromString(flavor=chocolate%20chips), ));
1 2 3 4 5 6 7 8 9 10 11 12
For more information about Zend\Http\Header\SetCookie objects, see this section. Zend\Http\Client also provides a means for simplifying cookie stickiness - that is having the client internally store all sent and received cookies, and resend them on subsequent requests: Zend\Http\Client\Cookies. This is useful, for example when you need to log in to a remote site rst and receive and authentication or session ID cookie before sending further requests.
Enabling Cookie Stickiness $cookies = new Zend\Http\Cookies(); // First request: log in and start a session $client->setUri(http://example.com/login.php); $client->setParameterPost(array(user => h4x0r, password => l33t)); $response = $client->request(POST); $cookies->addCookiesFromResponse($response, $client->getUri()); // Now we can send our next request $client->setUri(http://example.com/read_member_news.php); $client->addCookies($cookies->getMatchingCookies($client->getUri()); $client->request(GET);
1 2 3 4 5 6 7 8 9 10 11 12
656
For more information about the Zend\Http\Client\Cookies class, see this section.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
Zend\Http\Client also provides a convenience method for setting request headers, setHeaders. This method will create a new header container, add the specied headers and then store the new header container in its Zend\Http\Request object. As a consequence, any pre-existing headers will be erased.
Setting Multiple Custom Request Headers // Setting multiple headers. Will remove all existing // headers and add new ones to the Request header container $client->setHeaders(array( Zend\Http\Header\Host::fromString(Host: www.example.com), Accept-encoding => gzip,deflate, X-Powered-By: Zend Framework ));
1 2 3 4 5 6 7
657
1 2 3 4 5 6 7 8 9 10
In the rst example, the $text variable is uploaded and will be available as $_FILES[upload] on the server side. In the second example, the existing le /tmp/Backup.tar.gz is uploaded to the server and will be available as $_FILES[bufile]. The content type will be guessed automatically if possible - and if not, the content type will be set to application/octet-stream. Note: Uploading les When uploading les, the HTTP request content-type is automatically set to multipart/form-data. Keep in mind that you must send a POST or PUT request in order to upload les. Most servers will ignore the request body on other request methods.
1 2 3 4 5 6
658
7 8 9
The data should be available on the server side through PHPs $HTTP_RAW_POST_DATA variable or through the php://input stream. Note: Using raw POST data Setting raw POST data for a request will override any POST parameters or le uploads. You should not try to use both on the same request. Keep in mind that most servers will ignore the request body unless you send a POST request.
1 2 3 4 5 6 7 8
659
Another feature designed specically for consecutive requests is the Zend\Http\Client\Cookies object. This Cookie Jar allow you to save cookies set by the server in a request, and send them back on consecutive requests transparently. This allows, for example, going through an authentication request before sending the actual datafetching request. If your application requires one authentication request per user, and consecutive requests might be performed in more than one script in your application, it might be a good idea to store the Cookies object in the users session. This way, you will only need to authenticate the user once every session.
Performing consecutive requests with one client // First, instantiate the client $client = new Zend\Http\Client(http://www.example.com/fetchdata.php, array( keepalive => true )); // Do we have the cookies stored in our session? if (isset($_SESSION[cookiejar]) && $_SESSION[cookiejar] instanceof Zend\Http\Client\Cookies) { $cookieJar = $_SESSION[cookiejar]; } else { // If we dont, authenticate and store cookies $client->setUri(http://www.example.com/login.php); $client->setParameterPost(array( user => shahar, pass => somesecret )); $response = $client->setMethod(POST)->send(); $cookieJar = Zend\Http\Client\Cookies::fromResponse($response); // Now, clear parameters and set the URI to the original one // (note that the cookies that were set by the server are now // stored in the jar) $client->resetParameters(); $client->setUri(http://www.example.com/fetchdata.php); } // Add the cookies to the new request $client->setCookies($cookieJar->getMatchingCookies($client->getUri())); $response = $client->setMethod(GET)->send(); // Store cookies in session, for next page $_SESSION[cookiejar] = $cookieJar;
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
660
When using streaming, send() method will return object of class Zend\Http\Response\Stream, which has two useful methods: getStreamName() will return the name of the le where the response is stored, and getStream() will return stream from which the response could be read. You can either write the response to pre-dened le, or use temporary le for storing it and send it out or write it to another le using regular stream functions.
Receiving le from HTTP server with streaming $client->setStream(); // will use temp file $response = $client->send(); // copy file copy($response->getStreamName(), "my/downloads/file"); // use stream $fp = fopen("my/downloads/file2", "w"); stream_copy_to_stream($response->getStream(), $fp); // Also can write to known file $client->setStream("my/downloads/myfile")->send();
1 2 3 4 5 6 7 8 9
661
662
CHAPTER 129
129.1 Overview
The Zend\Http component also provides Zend\Http\ClientStatic, a static HTTP client which exposes a simplied API for quickly performing GET and POST operations:
use Zend\Http\ClientStatic; // Simple GET request $response = ClientStatic::get(http://example.org); // More complex GET request, specifying query string foo=bar and adding a // custom header to request JSON data be returned (Accept: application/json) $response = ClientStatic::get( http://example.org, array( foo => bar ), array( Accept => application/json) ); // We can also do a POST request using the same format. Here we POST // login credentials (username/password) to a login page: $response = ClientStatic::post(https://example.org/login.php, array( username => foo, password => bar, ));
663
664
CHAPTER 130
Translating
ZendI18n comes with a complete translation suite which supports all major formats and includes popular features like plural translations and text domains. The Translator component is mostly dependency free, except for the fallback to a default locale, where it relies on the Intl PHP extension. The translator itself is initialized without any parameters, as any conguration to it is optional. A translator without any translations will actually do nothing but just return the given message IDs.
The type given there is a name of one of the format loaders listed in the next section. Filename points to the le containing the translations, and the text domain species a category name for the translations. If the text domain is omitted, it will default to the default value. The locale species which language the translated strings are from and is only required for formats which contain translations for a single locale. Note: For each text domain and locale combination, there can only be one le loaded. Every successive le would override the translations which were loaded prior. When storing one locale per le, you should specify those les via a pattern. This allows you to add new translations to the le system, without touching your code. Patterns are added with the addTranslationFilePattern() method:
1 2 3 4
665
The parameters for adding patterns is pretty similar to adding individual les, except that you dont specify a locale and give the le location as a sprintf pattern. The locale is passed to the sprintf call, so you can either use %s or %1$s where it should be substituted. So when your translation les are located in /var/messages/LOCALE/messages.mo, you would specify your pattern as /var/messages/%s/messages.mo.
The message is the ID of your message to translate. If it does not exist in the loader translations or is empty, the original message ID will be returned. The text domain parameter is the one you specied when adding translations. If omitted, the default text domain will be used. The locale parameter will usually not be used in this context, as by default the locale is taken from the locale set in the translator. To translate plural messages, you can use the translatePlural() method. It works similar to translate(), but instead of a single message it takes a singular and a plural value and an additional integer number on which the returned plural form is based on:
1
Plural translations are only available if the underlying format supports the transport of plural messages and plural rule denitions.
130.5 Caching
In production it makes sense to cache your translations. This not only saves you from loading and parsing the individual formats each time, but also guarantees an optimized loading procedure. To enable caching, simply pass a Zend\Cache\Storage\Adapter to the setCache() method. To disable the cache, you can just pass a null value to it.
666
CHAPTER 131
131.1 Introduction
Zend Framework comes with an initial set of helper classes related to Internationalization: e.g., formatting a date, formatting currency, or displaying translated content. You can use helper, or plugin, classes to perform these behaviors for you. See the section on view helpers for more information.
// Within your view echo $this->currencyFormat(1234.56, "USD", "en_US"); // This returns: "$1,234.56" echo $this->currencyFormat(1234.56, "EUR", "de_DE"); // This returns: "1.234,56 C"
currencyFormat(oat $number, string $currencyCode[, string $locale ]) Parameters $number The numeric currency value. $currencyCode The 3-letter ISO 4217 currency code indicating the currency to use. $locale (Optional) Locale in which the currency would be formatted (locale name, e.g. en_US). If unset, it will use the default locale (Locale::getDefault()) Public Methods The $currencyCode and $locale options can be set prior to formatting and will be applied each time the helper is used:
667
1 2 3 4 5
// Within your view $this->plugin("currencyformat")->setCurrencyCode("USD")->setLocale("en_US"); echo $this->currencyFormat(1234.56); echo $this->currencyFormat(5678.90); // "$1,234.56" // "$5,678.90"
// Within your view // Date and Time echo $this->dateFormat( new DateTime(), IntlDateFormatter::MEDIUM, // date IntlDateFormatter::MEDIUM, // time "en_US" ); // This returns: "Jul 2, 2012 6:44:03 PM" // Date Only echo $this->dateFormat( new DateTime(), IntlDateFormatter::LONG, // date IntlDateFormatter::NONE, // time "en_US" ); // This returns: "July 2, 2012" // Time Only echo $this->dateFormat( new DateTime(), IntlDateFormatter::NONE, // date IntlDateFormatter::SHORT, // time "en_US" ); // This returns: "6:44 PM"
dateFormat(mixed $date[, int $dateType[, int $timeType[, string $locale ]]]) Parameters $date The value to format. This may be a DateTime object, an integer representing a Unix timestamp value or an array in the format output by localtime(). $dateType (Optional) Date type to use (none, short, medium, long, full). This is one of the IntlDateFormatter constants. Defaults to IntlDateFormatter::NONE. $timeType (Optional) Time type to use (none, short, medium, long, full). This is one of the IntlDateFormatter constants. Defaults to IntlDateFormatter::NONE. $locale (Optional) Locale in which the date would be formatted (locale name, e.g. en_US). If unset, it will use the default locale (Locale::getDefault()) Public Methods
668
The $locale option can be set prior to formatting with the setLocale() method and will be applied each time the helper is used. By default, the systems default timezone will be used when formatting. This overrides any timezone that may be set inside a DateTime object. To change the timezone when formatting, use the setTimezone method.
1 2 3 4 5
// Within your view $this->plugin("dateFormat")->setTimezone("America/New_York")->setLocale("en_US"); echo $this->dateFormat(new DateTime(), IntlDateFormatter::MEDIUM); echo $this->dateFormat(new DateTime(), IntlDateFormatter::SHORT); // "Jul 2, 2012" // "7/2/12"
// Within your view // Example of Decimal formatting: echo $this->numberFormat( 1234567.891234567890000, NumberFormatter::DECIMAL, NumberFormatter::TYPE_DEFAULT, "de_DE" ); // This returns: "1.234.567,891" // Example of Percent formatting: echo $this->numberFormat( 0.80, NumberFormatter::PERCENT, NumberFormatter::TYPE_DEFAULT, "en_US" ); // This returns: "80%" // Example of Scientific notation formatting: echo $this->numberFormat( 0.00123456789, NumberFormatter::SCIENTIFIC, NumberFormatter::TYPE_DEFAULT, "fr_FR" ); // This returns: "1,23456789E-3"
numberFormat(number $number[, int $formatStyle[, int $formatType[, string $locale ]]]) Parameters $number The numeric value. $formatStyle (Optional) Style of the formatting, one of the format style constants. If unset, it will use NumberFormatter::DECIMAL as the default style. $formatType (Optional) The formatting type to use. NumberFormatter::TYPE_DEFAULT as the default type. If unset, it will use
669
$locale (Optional) Locale in which the number would be formatted (locale name, e.g. en_US). If unset, it will use the default locale (Locale::getDefault()) Public Methods The $formatStyle, $formatType, and $locale options can be set prior to formatting and will be applied each time the helper is used.
1 2 3 4 5 6 7 8
// Within your view $this->plugin("numberformat") ->setFormatStyle(NumberFormatter::PERCENT) ->setFormatType(NumberFormatter::TYPE_DOUBLE) ->setLocale("en_US"); echo $this->numberFormat(0.56); echo $this->numberFormat(0.90); // "56%" // "90%"
// Get the ViewHelperPlugin Manager from Service manager, so we can fetch the Plural // helper and add the plural rule for the applications language $viewHelperManager = $serviceManager->get(ViewHelperManager); $pluralHelper = $viewHelperManager->get(Plural); // Here is the rule for French $pluralHelper->setPluralRule(nplurals=2; plural=(n==0 || n==1 ? 0 : 1));
The string reads like that: 1. First, we specify how many plurals form do we have. For French, only two (singular/plural). 2. Then, we specify the rule. Here, if the count is 0 or 1, this is rule n0 (singular) while its rule n1 otherwise.
670
As we said earlier, English consider 1 as singular, and 0/other as plural. Here is such a rule:
1 2
Now that we have dened the rule, we can use it in our views:
1 2 3 4 5 6 7 8 9 10 11
<?php // If the rule defined in Module.php is the English one: echo $this->plural(array(car, cars), 0); // prints "cars" echo $this->plural(array(car, cars), 1); // prints "car" // If the rule defined in Module.php is the French one: echo $this->plural(array(voiture, voitures), 0); // prints "voiture" echo $this->plural(array(voiture, voitures), 1); // prints "voiture" echo $this->plural(array(voiture, voitures), 2); // prints "voitures" ?>
Before using the Translate view helper, you must have rst created a Translator object and have attached it to the view helper. If you use the Zend\View\HelperPluginManager to invoke the view helper, this will be done automatically for you. Basic Usage
1 2 3 4 5 6 7 8 9
// Within your view echo $this->translate("Some translated text."); echo $this->translate("Translated text from a custom text domain.", "customDomain"); echo sprintf($this->translate("The current time is %s."), $currentTime); echo $this->translate("Translate in a specific locale", "default", "de_DE");
translate(string $message[, string $textDomain[, string $locale ]]) Parameters $message The message to be translated. $textDomain (Optional) The text domain where this translation lives. Defaults to the value default. $locale (Optional) Locale in which the message would be translated (locale name, e.g. en_US). If unset, it will use the default locale (Locale::getDefault()) Gettext The xgettext utility can be used to compile *.po les from PHP source les containing the translate view helper.
xgettext --language=php --add-location --keyword=translate my-view-file.phtml
See the Gettext Wikipedia page for more information. Public Methods Public methods for setting a Zend\I18n\Translator\Translator and a default text domain are inherited from Zend\I18n\View\Helper\AbstractTranslatorHelper. 131.6. Translate Helper 671
// Within your view echo $this->translatePlural("car", "cars", $num); // Use a custom domain echo $this->translatePlural("monitor", "monitors", $num, "customDomain"); // Change locale echo $this->translatePlural("locale", "locales", $num, "default", "de_DE");
translatePlural(string $singular, string $plural, int $number[, string $textDomain[, string $locale ]]) Parameters $singular The singular message to be translated. $plural The plural message to be translated. $number The number to evaluate and determine which message to use. $textDomain (Optional) The text domain where this translation lives. Defaults to the value default. $locale (Optional) Locale in which the message would be translated (locale name, e.g. en_US). If unset, it will use the default locale (Locale::getDefault()) Public Methods Public methods for setting a Zend\I18n\Translator\Translator and a default text domain are inherited from Zend\I18n\View\Helper\AbstractTranslatorHelper.
672
Return type boolean setTranslatorEnabled(boolean $enabled) Sets whether translations should be enabled or disabled. isTranslatorEnabled() Returns true if translations are enabled, and false if disabled. Return type boolean setTranslatorTextDomain(string $textDomain) Set the translation text domain to use in helper when translating. getTranslatorTextDomain() Returns the translation text domain used in the helper. Return type string
673
674
CHAPTER 132
I18n Filters
132.1 Alnum
The Alnum lter can be used to return only alphabetic characters and digits in the unicode letter and number categories, respectively. All other characters are suppressed.
Supported Options for Alnum Filter
The following options are supported for Alnum: Alnum([ boolean $allowWhiteSpace [, string $locale ]]) $allowWhiteSpace: If set to true then whitespace characters are allowed. Otherwise they are suppressed. Default is false (whitespace is not allowed). Methods for getting/setting the allowWhiteSpace option are also available: getAllowWhiteSpace() and setAllowWhiteSpace() $locale: The locale string used in identifying the characters to lter (locale name, e.g. en_US). If unset, it will use the default locale (Locale::getDefault()). Methods for getting/setting the locale are also available: getLocale() and setLocale()
Alnum Filter Usage // Default settings, deny whitespace $filter = new \Zend\I18n\Filter\Alnum(); echo $filter->filter("This is (my) content: 123"); // Returns "Thisismycontent123" // First param in constructor is $allowWhiteSpace $filter = new \Zend\I18n\Filter\Alnum(true); echo $filter->filter("This is (my) content: 123"); // Returns "This is my content 123"
1 2 3 4 5 6 7 8 9
675
Note: Alnum works on almost all languages, except: Chinese, Japanese and Korean. Within these languages the english alphabet is used instead of the characters from these languages. The language itself is detected using the Locale.
132.2 Alpha
The Alpha lter can be used to return only alphabetic characters in the unicode letter category. All other characters are suppressed.
Supported Options for Alpha Filter
The following options are supported for Alpha: Alpha([ boolean $allowWhiteSpace [, string $locale ]]) $allowWhiteSpace: If set to true then whitespace characters are allowed. Otherwise they are suppressed. Default is false (whitespace is not allowed). Methods for getting/setting the allowWhiteSpace option are also available: getAllowWhiteSpace() and setAllowWhiteSpace() $locale: The locale string used in identifying the characters to lter (locale name, e.g. en_US). If unset, it will use the default locale (Locale::getDefault()). Methods for getting/setting the locale are also available: getLocale() and setLocale()
Alpha Filter Usage // Default settings, deny whitespace $filter = new \Zend\I18n\Filter\Alpha(); echo $filter->filter("This is (my) content: 123"); // Returns "Thisismycontent" // Allow whitespace $filter = new \Zend\I18n\Filter\Alpha(true); echo $filter->filter("This is (my) content: 123"); // Returns "This is my content "
1 2 3 4 5 6 7 8 9
Note: Alpha works on almost all languages, except: Chinese, Japanese and Korean. Within these languages the english alphabet is used instead of the characters from these languages. The language itself is detected using the Locale.
132.3 NumberFormat
The NumberFormat lter can be used to return locale-specic number and percentage strings. It extends the NumberParse lter, which acts as wrapper for the NumberFormatter class within the Internationalization extension (Intl).
676
The following options are supported for NumberFormat: NumberFormat([ string $locale [, int $style [, int $type ]]]) $locale: (Optional) Locale in which the number would be formatted (locale name, e.g. en_US). If unset, it will use the default locale (Locale::getDefault()) Methods for getting/setting the locale are also available: getLocale() and setLocale() $style: (Optional) Style of the formatting, one of the format style constants. NumberFormatter::DEFAULT_STYLE as the default style. If unset, it will use
Methods for getting/setting the format style are also available: getStyle() and setStyle() $type: (Optional) The formatting type to use. If unset, it will use NumberFormatter::TYPE_DOUBLE as the default type. Methods for getting/setting the format type are also available: getType() and setType()
NumberFormat Filter Usage $filter = new \Zend\I18n\Filter\NumberFormat("de_DE"); echo $filter->filter(1234567.8912346); // Returns "1.234.567,891" $filter = new \Zend\I18n\Filter\NumberFormat("en_US", NumberFormatter::PERCENT); echo $filter->filter(0.80); // Returns "80%" $filter = new \Zend\I18n\Filter\NumberFormat("fr_FR", NumberFormatter::SCIENTIFIC); echo $filter->filter(0.00123456789); // Returns "1,23456789E-3"
1 2 3 4 5 6 7 8 9 10 11
132.4 NumberParse
The NumberParse lter can be used to parse a number from a string. NumberFormatter class within the Internationalization extension (Intl).
Supported Options for NumberParse Filter
The following options are supported for NumberParse: NumberParse([ string $locale [, int $style [, int $type ]]]) $locale: (Optional) Locale in which the number would be parsed (locale name, e.g. en_US). If unset, it will use the default locale (Locale::getDefault()) Methods for getting/setting the locale are also available: getLocale() and setLocale() $style: (Optional) Style of the parsing, one of the format style constants. NumberFormatter::DEFAULT_STYLE as the default style. If unset, it will use
Methods for getting/setting the parse style are also available: getStyle() and setStyle()
132.4. NumberParse
677
$type: (Optional) The parsing type_ to use. If unset, it will use NumberFormatter::TYPE_DOUBLE as the default type. Methods for getting/setting the parse type are also available: getType() and setType()
NumberParse Filter Usage $filter = new \Zend\I18n\Filter\NumberParse("de_DE"); echo $filter->filter("1.234.567,891"); // Returns 1234567.8912346 $filter = new \Zend\I18n\Filter\NumberParse("en_US", NumberFormatter::PERCENT); echo $filter->filter("80%"); // Returns 0.80 $filter = new \Zend\I18n\Filter\NumberParse("fr_FR", NumberFormatter::SCIENTIFIC); echo $filter->filter("1,23456789E-3"); // Returns 0.00123456789
1 2 3 4 5 6 7 8 9 10 11
678
CHAPTER 133
I18n Validators
679
680
CHAPTER 134
Float
Zend\I18n\Validator\Float allows you to validate if a given value contains a oating-point value. This validator validates also localized input.
$validator = new Zend\I18n\Validator\Float(); $validator->isValid(1234.5); // returns true $validator->isValid(10a01); // returns false $validator->isValid(1,234.5); // returns true
681
1 2 3 4 5
$validator = new Zend\I18n\Validator\Float(array(locale => de)); $validator->isValid(1234.5); // returns true $validator->isValid("1 234,5"); // returns false $validator->isValid("1.234"); // returns true
As you can see, by using a locale, your input is validated localized. Using a different notation you get a FALSE when the locale forces a different notation. The locale can also be set afterwards by using setLocale() and retrieved by using getLocale().
682
CHAPTER 135
Int
Zend\I18n\Validator\Int validates if a given value is an integer. Also localized integer values are recognised and can be validated.
$validator = new Zend\I18n\Validator\Int(); $validator->isValid(1234); // returns true $validator->isValid(1234.5); // returns false $validator->isValid(1,234); // returns true
In the above example we expected that our environment is set to en as locale. As you can see in the third example also grouping is recognised.
683
1 2 3 4 5
$validator = new Zend\I18n\Validator\Int(array(locale => de)); $validator->isValid(1234); // returns true $validator->isValid("1,234"); // returns false $validator->isValid("1.234"); // returns true
As you can see, by using a locale, your input is validated localized. Using the english notation you get a FALSE when the locale forces a different notation. The locale can also be set afterwards by using setLocale() and retrieved by using getLocale().
684
CHAPTER 136
Introduction to Zend\InputFilter
The Zend\InputFilter component can be used to lter and validate generic sets of input data. For instance, you could use it to lter $_GET or $_POST values, CLI arguments, etc. To pass input data to the InputFilter, you can use the setData() method. The data must be specied using an associative array. Below is an example on how to validate the data coming from a form using the POST method.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
use Zend\InputFilter\InputFilter; use Zend\InputFilter\Input; use Zend\Validator; $email = new Input(email); $email->getValidatorChain() ->attach(new Validator\EmailAddress()); $password = new Input(password); $password->getValidatorChain() ->attach(new Validator\StringLength(8)); $inputFilter = new InputFilter(); $inputFilter->add($email) ->add($password) ->setData($_POST); if ($inputFilter->isValid()) { echo "The form is valid\n"; } else { echo "The form is not valid\n"; foreach ($inputFilter->getInvalidInput() as $error) { print_r($error->getMessages()); } }
In this example we validated the email and password values. The email must be a valid address and the password must be composed with at least 8 characters. If the input data are not valid, we report the list of invalid input using the getInvalidInput() method. You can add one or more validators to each input using the attach() method for each validator. It is also possible to specify a validation group, a subset of the data to be validated; this may be done using the setValidationGroup() method. You can specify the list of the input names as an array or as individual parameters.
685
1 2 3 4 5
You can validate and/or lter the data using the InputFilter. To lter data, use the getFilterChain() method of individual Input instances, and attach lters to the returned lter chain. Below is an example that uses ltering without validation.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
use Zend\InputFilter\Input; use Zend\InputFilter\InputFilter; $input = new Input(foo); $input->getFilterChain() ->attachByName(stringtrim) ->attachByName(alpha); $inputFilter = new InputFilter(); $inputFilter->add($input) ->setData(array( foo => Bar3 , )); echo echo echo echo "Before:\n"; $inputFilter->getRawValue(foo) . "\n"; // the output is Bar3 "After:\n"; $inputFilter->getValue(foo) . "\n"; // the output is Bar
The getValue() method returns the ltered value of the foo input, while getRawValue() returns the original value of the input. We provide also Zend\InputFilter\Factory, to allow initialization of the InputFilter based on a conguration array (or Traversable object). Below is an example where we create a password input value with the same constraints proposed before (a string with at least 8 characters):
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
use Zend\InputFilter\Factory; $factory = new Factory(); $inputFilter = $factory->createInputFilter(array( password => array( name => password, required => true, validators => array( array( name => not_empty, ), array( name => string_length, options => array( min => 8 ), ), ), ), )); $inputFilter->setData($_POST); echo $inputFilter->isValid() ? "Valid form" : "Invalid form";
686
The factory may be used to create not only Input instances, but also nested InputFilters, allowing you to create validation and ltering rules for hierarchical data sets. Finally, the default InputFilter implementation is backed by a Factory. This means that when calling add(), you can provide a specication that the Factory would understand, and it will create the appropriate object. You may create either Input or InputFilter objects in this fashion.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
use Zend\InputFilter\InputFilter; $filter = new InputFilter(); // Adding a single input $filter->add(array( name => username, required => true, validators => array( array( name => not_empty, ), array( name => string_length, options => array( min => 5 ), ), ), )); // Adding another input filter what also contains a single input. Merging both. $filter->add(array( type => Zend\InputFilter\InputFilter, password => array( name => password, required => true, validators => array( array( name => not_empty, ), array( name => string_length, options => array( min => 8 ), ), ), ), ));
687
688
CHAPTER 137
The Zend\FileInput class is a special Input type for uploaded les found in the $_FILES array. While FileInput uses the same interface as Input, it differs in a few ways: 1. It expects the raw value to be in the $_FILES array format. 2. The validators are run before the lters (which is the opposite behavior of Input). This is so that any is_uploaded_file() validation can be run prior to any lters that may rename/move/modify the le. 3. Instead of adding a NotEmpty validator, Zend\Validator\File\UploadFile validator. it will (by default) automatically add a
The biggest thing to be concerned about is that if you are using a <input type="file"> element in your form, you will need to use the FileInput instead of Input or else you will encounter issues. Usage of FileInput is essentially the same as Input:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
// Description text input $description = new Input(description); // Standard Input type $description->getFilterChain() // Filters are run first w/ Input ->attach(new Filter\StringTrim()); $description->getValidatorChain() // Validators are run second w/ Input ->attach(new Validator\StringLength(array(max => 140))); // File upload input $file = new FileInput(file); // Special File Input type $file->getValidatorChain() // Validators are run first w/ FileInput ->attach(new Validator\File\UploadFile()); $file->getFilterChain() // Filters are run second w/ FileInput ->attach(new Filter\File\RenameUpload(array( target => ./data/tmpuploads/file, randomize => true, ))); // Merge $_POST and $_FILES data together
689
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
$request = new Request(); $postData = array_merge_recursive($request->getPost(), $request->getFiles()); $inputFilter = new InputFilter(); $inputFilter->add($description) ->add($file) ->setData($postData); if ($inputFilter->isValid()) { // FileInput validators are run, but not the filters... echo "The form is valid\n"; $data = $inputFilter->getValues(); // This is when the FileInput filters are run. } else { echo "The form is not valid\n"; foreach ($inputFilter->getInvalidInput() as $error) { print_r ($error->getMessages()); } }
690
CHAPTER 138
Introduction to Zend\Json
Zend\Json provides convenience methods for serializing native PHP to JSON and decoding JSON to native PHP. For more information on JSON, visit the JSON project site. JSON, JavaScript Object Notation, can be used for data interchange between JavaScript and other languages. Since JSON can be directly evaluated by JavaScript, it is a more efcient and lightweight format than XML for exchanging data with JavaScript clients. In addition, Zend\Json provides a useful way to convert any arbitrary XML formatted string into a JSON formatted string. This built-in feature will enable PHP developers to transform the enterprise data encoded in XML format into JSON format before sending it to browser-based Ajax client applications. It provides an easy way to do dynamic data conversion on the server-side code thereby avoiding unnecessary XML parsing in the browser-side applications. It offers a nice utility function that results in easier application-specic data processing techniques.
691
692
CHAPTER 139
Basic Usage
Usage of Zend\Json involves using the two public static methods available: Zend\Json\Json::encode() and Zend\Json\Json::decode().
1 2 3 4 5
// Retrieve a value: $phpNative = Zend\Json\Json::decode($encodedValue); // Encode it to return to the client: $json = Zend\Json\Json::encode($phpNative);
// Encode it to return to the client: $json = Zend\Json\Json::encode($phpNative); if ($debug) { echo Zend\Json\Json::prettyPrint($json, array("indent" => " ")); }
Second optional argument of Zend\Json\Json::prettyPrint() is an option array. Option indent allows to set indentation string - by default its a single tab character.
693
694
CHAPTER 140
Any objects thus decoded are returned as stdClass objects with properties corresponding to the key/value pairs in the JSON notation. The recommendation of Zend Framework is that the individual developer should decide how to decode JSON objects. If an object of a specied type should be created, it can be created in the developer code and populated with the values decoded using Zend\Json.
695
When doing recursive encoding of objects, as JSON does not support cycles, an Zend\Json\Exception\RecursionException will be thrown. If you wish, you can silence these exceptions by passing the silenceCyclicalExceptions option:
1 2 3 4 5
Zend\Json\Json::$useBuiltinEncoderDecoder = true;
$data = array( onClick => new Zend\Json\Expr(function() { . alert("I am a valid JavaScript callback . created by Zend\Json"); }), other => no expression, ); $jsonObjectWithExpression = Zend\Json\Json::encode( $data, false, array(enableJsonExprFinder => true) );
696
CHAPTER 141
Zend\Json provides a convenience method for transforming XML formatted data into JSON format. This feature was inspired from an IBM developerWorks article. Zend\Json includes a static function called Zend\Json\Json::fromXml(). This function will generate JSON from a given XML input. This function takes any arbitrary XML string as an input parameter. It also takes an optional boolean input parameter to instruct the conversion logic to ignore or not ignore the XML attributes during the conversion process. If this optional input parameter is not given, then the default behavior is to ignore the XML attributes. This function call is made as shown below:
1 2 3
// fromXml function simply takes a String containing XML contents // as input. $jsonContents = Zend\Json\Json::fromXml($xmlStringContents, true);
Zend\Json\Json::fromXml() function does the conversion of the XML formatted string input parameter and returns the equivalent JSON formatted string output. In case of any XML input format error or conversion logic error, this function will throw an exception. The conversion logic also uses recursive techniques to traverse the XML tree. It supports recursion upto 25 levels deep. Beyond that depth, it will throw a Zend\Json\Exception. There are several XML les with varying degree of complexity provided in the tests directory of Zend Framework. They can be used to test the functionality of the xml2json feature. The following is a simple example that shows both the XML input string passed to and the JSON output string returned as a result from the Zend\Json\Json::fromXml() function. This example used the optional function parameter as not to ignore the XML attributes during the conversion. Hence, you can notice that the resulting JSON string includes a representation of the XML attributes present in the XML input string. XML input string passed to Zend\Json\Json::fromXml() function:
1 2 3 4 5 6 7 8 9 10 11 12 13
<?xml version="1.0" encoding="UTF-8"?> <books> <book id="1"> <title>Code Generation in Action</title> <author><first>Jack</first><last>Herrington</last></author> <publisher>Manning</publisher> </book> <book id="2"> <title>PHP Hacks</title> <author><first>Jack</first><last>Herrington</last></author> <publisher>OReilly</publisher> </book>
697
14 15 16 17 18 19 20
{ "books" : { "book" : [ { "@attributes" : { "id" : "1" }, "title" : "Code Generation in Action", "author" : { "first" : "Jack", "last" : "Herrington" }, "publisher" : "Manning" }, { "@attributes" : { "id" : "2" }, "title" : "PHP Hacks", "author" : { "first" : "Jack", "last" : "Herrington" }, "publisher" : "OReilly" }, { "@attributes" : { "id" : "3" }, "title" : "Podcasting Hacks", "author" : { "first" : "Jack", "last" : "Herrington" }, "publisher" : "OReilly" } ]} }
More details about this xml2json feature can be found in the original proposal itself. Take a look at the Zend_xml2json proposal.
698
CHAPTER 142
Zend\Json\Server is a JSON-RPC server implementation. It supports both the JSON-RPC version 1 specication as well as the version 2 specication; additionally, it provides a PHP implementation of the Service Mapping Description (SMD) specication for providing service metadata to service consumers. JSON-RPC is a lightweight Remote Procedure Call protocol that utilizes JSON for its messaging envelopes. This JSON-RPC implementation follows PHPs SoapServer API. This means, in a typical situation, you will simply: Instantiate the server object Attach one or more functions and/or classes/objects to the server object handle() the request Zend\Json\Server utilizes Zend\Server\Reection to perform reection on any attached classes or functions, and uses that information to build both the SMD and enforce method call signatures. As such, it is imperative that any attached functions and/or class methods have full PHP docblocks documenting, minimally: All parameters and their expected variable types The return value variable type Zend\Json\Server listens for POST requests only at this time; fortunately, most JSON-RPC client implementations in the wild at the time of this writing will only POST requests as it is. This makes it simple to utilize the same server end point to both handle requests as well as to deliver the service SMD, as is shown in the next example.
Zend\Json\Server Usage
First, lets dene a class we wish to expose via the JSON-RPC server. Well call the class Calculator, and dene methods for add, subtract, multiply, and divide:
1 2 3 4 5 6 7 8 9 10
/** * Calculator - sample class to expose via JSON-RPC */ class Calculator { /** * Return sum of two variables * * @param int $x * @param int $y
699
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
* @return int */ public function add($x, $y) { return $x + $y; } /** * Return difference of two variables * * @param int $x * @param int $y * @return int */ public function subtract($x, $y) { return $x - $y; } /** * Return product of two variables * * @param int $x * @param int $y * @return int */ public function multiply($x, $y) { return $x * $y; } /** * Return the division of two variables * * @param int $x * @param int $y * @return float */ public function divide($x, $y) { return $x / $y; } }
Note that each method has a docblock with entries indicating each parameter and its type, as well as an entry for the return value. This is absolutely critical when utilizing Zend\Json\Server or any other server component in Zend Framework, for that matter. Now well create a script to handle the requests:
1 2 3 4 5 6 7
$server = new Zend\Json\Server\Server(); // Indicate what functionality is available: $server->setClass(Calculator); // Handle the request: $server->handle();
However, this will not address the issue of returning an SMD so that the JSON-RPC client can autodiscover methods. 700 Chapter 142. Zend\Json\Server - JSON-RPC server
That can be accomplished by determining the HTTP request method, and then specifying some server metadata:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
$server = new Zend\Json\Server\Server(); $server->setClass(Calculator); if (GET == $_SERVER[REQUEST_METHOD]) { // Indicate the URL endpoint, and the JSON-RPC version used: $server->setTarget(/json-rpc.php) ->setEnvelope(Zend\Json\Server\Smd::ENV_JSONRPC_2); // Grab the SMD $smd = $server->getServiceMap(); // Return the SMD to the client header(Content-Type: application/json); echo $smd; return; } $server->handle();
If utilizing the JSON-RPC server with Dojo toolkit, you will also need to set a special compatibility ag to ensure that the two interoperate properly:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
$server = new Zend\Json\Server\Server(); $server->setClass(Calculator); if (GET == $_SERVER[REQUEST_METHOD]) { $server->setTarget(/json-rpc.php) ->setEnvelope(Zend\Json\Server\Smd::ENV_JSONRPC_2); $smd = $server->getServiceMap(); // Set Dojo compatibility: $smd->setDojoCompatible(true); header(Content-Type: application/json); echo $smd; return; } $server->handle();
142.1.1 Zend\Json\Server\Server
Zend\Json\Server\Server is the core class in the JSON-RPC offering; it handles all requests and returns the response payload. It has the following methods: addFunction($function): Specify a userland function to attach to the server. setClass($class): Specify a class or object to attach to the server; all public methods of that item will be exposed as JSON-RPC methods. 142.1. Advanced Details 701
Create
and optionally,
return pass
a a
handle($request = false): Handle a JSON-RPC request; Zend\Json\Server\Request object to utilize (creates one by default). getFunctions(): Return a list of all attached methods.
setRequest(Zend\Json\Server\Request $request): Specify a request object for the server to utilize. getRequest(): Retrieve the request object used by the server. setResponse(Zend\Json\Server\Response $response): Set the response object for the server to utilize. getResponse(): Retrieve the response object used by the server. setAutoEmitResponse($flag): Indicate whether the server should automatically emit the response and all headers; by default, this is TRUE. autoEmitResponse(): Determine if auto-emission of the response is enabled. getServiceMap(): Retrieve the service map description in the form of a Zend\Json\Server\Smd object
142.1.2 Zend\Json\Server\Request
The JSON-RPC request environment is encapsulated in the Zend\Json\Server\Request object. This object allows you to set necessary portions of the JSON-RPC request, including the request ID, parameters, and JSON-RPC specication version. It has the ability to load itself via JSON or a set of options, and can render itself as JSON via the toJson() method. The request object has the following methods available: setOptions(array $options): Specify object conguration. $options may contain keys matching any set method: setParams(), setMethod(), setId(), and setVersion(). addParam($value, $key = null): Add a parameter to use with the method call. Parameters can be just the values, or can optionally include the parameter name. addParams(array $params): Add multiple parameters at once; proxies to addParam() setParams(array $params): Set all parameters at once; overwrites any existing parameters. getParam($index): Retrieve a parameter by position or name. getParams(): Retrieve all parameters at once. setMethod($name): Set the method to call. getMethod(): Retrieve the method that will be called. isMethodError(): Determine whether or not the request is malformed and would result in an error. setId($name): Set the request identier (used by the client to match requests to responses). getId(): Retrieve the request identier. setVersion($version): Set the JSON-RPC specication version the request conforms to. May be either 1.0 or 2.0. getVersion(): Retrieve the JSON-RPC specication version used by the request. loadJson($json): Load the request object from a JSON string.
702
toJson(): Render the request as a JSON string. An HTTP specic version is available via Zend\Json\Server\Request\Http. This class will retrieve the request via php://input, and allows access to the raw JSON via the getRawJson() method.
142.1.3 Zend\Json\Server\Response
The JSON-RPC response payload is encapsulated in the Zend\Json\Server\Response object. This object allows you to set the return value of the request, whether or not the response is an error, the request identier, the JSON-RPC specication version the response conforms to, and optionally the service map. The response object has the following methods available: setResult($value): Set the response result. getResult(): Retrieve the response result. setError(Zend\Json\Server\Error $error): Set an error object. If set, this will be used as the response when serializing to JSON. getError(): Retrieve the error object, if any. isError(): Whether or not the response is an error response. setId($name): Set the request identier (so the client may match the response with the original request). getId(): Retrieve the request identier. setVersion($version): Set the JSON-RPC version the response conforms to. getVersion(): Retrieve the JSON-RPC version the response conforms to. toJson(): Serialize the response to JSON. If the response is an error response, serializes the error object. setServiceMap($serviceMap): Set the service map object for the response. getServiceMap(): Retrieve the service map object, if any. An HTTP specic version is available via Zend\Json\Server\Response\Http. This class will send the appropriate HTTP headers as well as serialize the response as JSON.
142.1.4 Zend\Json\Server\Error
JSON-RPC has a special format for reporting error conditions. All errors need to provide, minimally, an error message and error code; optionally, they can provide additional data, such as a backtrace. Error codes are derived from those recommended by the XML-RPC EPI project. Zend\Json\Server appropriately assigns the code based on the error condition. For application exceptions, the code -32000 is used. Zend\Json\Server\Error exposes the following methods: setCode($code): Set the error code; if the code is not in the accepted XML-RPC error code range, -32000 will be assigned. getCode(): Retrieve the current error code. setMessage($message): Set the error message. getMessage(): Retrieve the current error message. setData($data): Set auxiliary data further qualifying the error, such as a backtrace. getData(): Retrieve any current auxiliary error data.
703
toArray(): Cast the error to an array. The array will contain the keys code, message, and data. toJson(): Cast the error to a JSON-RPC error representation.
142.1.5 Zend\Json\Server\Smd
SMD stands for Service Mapping Description, a JSON schema that denes how a client can interact with a particular web service. At the time of this writing, the specication has not yet been formally ratied, but it is in use already within Dojo toolkit as well as other JSON-RPC consumer clients. At its most basic, a Service Mapping Description indicates the method of transport (POST, GET, TCP/IP, etc), the request envelope type (usually based on the protocol of the server), the target URL of the service provider, and a map of services available. In the case of JSON-RPC, the service map is a list of available methods, which each method documenting the available parameters and their types, as well as the expected return value type. Zend\Json\Server\Smd provides an object-oriented way to build service maps. At its most basic, you pass it metadata describing the service using mutators, and specify services (methods and functions). The service descriptions themselves are typically instances of Zend\Json\Server\Smd\Service; you can also pass all information as an array to the various service mutators in Zend\Json\Server\Smd, and it will instantiate a service for you. The service objects contain information such as the name of the service (typically the function or method name), the parameters (names, types, and position), and the return value type. Optionally, each service can have its own target and envelope, though this functionality is rarely used. Zend\Json\Server\Server actually does all of this behind the scenes for you, by using reection on the attached classes and functions; you should create your own service maps only if you need to provide custom functionality that class and function introspection cannot offer. Methods available in Zend\Json\Server\Smd include: setOptions(array $options): Setup an SMD object from an array of options. All mutators (methods beginning with set) can be used as keys. setTransport($transport): Set the transport used to access the service; only POST is currently supported. getTransport(): Get the current service transport. setEnvelope($envelopeType): Set the request envelope that should be used to access the service. Currently, supports the constants Zend\Json\Server\Smd::ENV_JSONRPC_1 and Zend\Json\Server\Smd::ENV_JSONRPC_2. getEnvelope(): Get the current request envelope. setContentType($type): Set the content type requests should use (by default, this is application/json). getContentType(): Get the current content type for requests to the service. setTarget($target): Set the URL endpoint for the service. getTarget(): Get the URL endpoint for the service. setId($id): Typically, this is the URL endpoint of the service (same as the target). getId(): Retrieve the service ID (typically the URL endpoint of the service). setDescription($description): Set a service description (typically narrative information describing the purpose of the service). getDescription(): Get the service description.
704
setDojoCompatible($flag): Set a ag indicating whether or not the SMD is compatible with Dojo toolkit. When TRUE, the generated JSON SMD will be formatted to comply with the format that Dojos JSONRPC client expects. isDojoCompatible(): Returns the value of the Dojo compatibility ag (FALSE, by default). addService($service): Add a service to the map. May be an array of information to pass to the constructor of Zend\Json\Server\Smd\Service, or an instance of that class. addServices(array $services): Add multiple services at once. setServices(array $services): Add multiple services at once, overwriting any previously set services. getService($name): Get a service by its name. getServices(): Get all attached services. removeService($name): Remove a service from the map. toArray(): Cast the service map to an array. toDojoArray(): Cast the service map to an array compatible with Dojo Toolkit. toJson(): Cast the service map to a JSON representation. Zend\Json\Server\Smd\Service has the following methods: setOptions(array $options): Set object state from an array. Any mutator (methods beginning with set) may be used as a key and set via this method. setName($name): Set the service name (typically, the function or method name). getName(): Retrieve the service name. setTransport($transport): Set the service transport (currently, only transports supported by Zend\Json\Server\Smd are allowed). getTransport(): Retrieve the current transport. setTarget($target): Set the URL endpoint of the service (typically, this will be the same as the overall SMD to which the service is attached). getTarget(): Get the URL endpoint of the service. setEnvelope($envelopeType): Set the service envelope (currently, only envelopes supported by Zend\Json\Server\Smd are allowed). getEnvelope(): Retrieve the service envelope type. addParam($type, array $options = array(), $order = null): Add a parameter to the service. By default, only the parameter type is necessary. However, you may also specify the order, as well as options such as: name: the parameter name optional: whether or not the parameter is optional default: a default value for the parameter description: text describing the parameter addParams(array $params): Add several parameters at once; each param should be an assoc array containing minimally the key type describing the parameter type, and optionally the key order; any other keys will be passed as $options to addOption(). setParams(array $params): Set many parameters at once, overwriting any existing parameters.
705
getParams(): Retrieve all currently set parameters. setReturn($type): Set the return value type of the service. getReturn(): Get the return value type of the service. toArray(): Cast the service to an array. toJson(): Cast the service to a JSON representation.
706
CHAPTER 143
Introduction to Zend\Ldap
Zend\Ldap\Ldap is a class for performing LDAP operations including but not limited to binding, searching and modifying entries in an LDAP directory.
$options = array( host => s0.foo.net, username => CN=user1,DC=foo,DC=net, password => pass1, bindRequiresDn => true, accountDomainName => foo.net, baseDn => OU=Sales,DC=foo,DC=net, ); $ldap = new Zend\Ldap\Ldap($options); $acctname = $ldap->getCanonicalAccountName(abaker, Zend\Ldap\Ldap::ACCTNAME_FORM_DN); echo "$acctname\n";
707
$options = array( host => dc1.w.net, useStartTls => true, username => user1@w.net, password => pass1, accountDomainName => w.net, accountDomainNameShort => W, baseDn => CN=Users,DC=w,DC=net, ); $ldap = new Zend\Ldap\Ldap($options); $acctname = $ldap->getCanonicalAccountName(bcarter, Zend\Ldap\Ldap::ACCTNAME_FORM_DN); echo "$acctname\n";
Note that we use the getCanonicalAccountName() method to retrieve the account DN here only because that is what exercises the most of what little code is currently present in this class.
$options = array( host => s0.foo.net, username => CN=user1,DC=foo,DC=net, password => pass1, bindRequiresDn => true, accountDomainName => foo.net, baseDn => OU=Sales,DC=foo,DC=net, ); $ldap = new Zend\Ldap\Ldap($options); $ldap->bind(abaker, moonbike55); $acctname = $ldap->getCanonicalAccountName(abaker, Zend\Ldap\Ldap::ACCTNAME_FORM_DN); echo "$acctname\n";
The bind() call in this example sees that the username abaker is not in DN form, nds bindRequiresDn is TRUE, uses CN=user1,DC=foo,DC=net and pass1 to bind, retrieves the DN for abaker, unbinds and then rebinds with the newly discovered CN=Alice Baker,OU=Sales,DC=foo,DC=net.
708
Table 143.1: Options for accountCanonicalForm Name ACCTNAME_FORM_DN ACCTNAME_FORM_USERNAME ACCTNAME_FORM_BACKSLASH ACCTNAME_FORM_PRINCIPAL Value 1 2 3 4 Example CN=Alice Baker,CN=Users,DC=example,DC=com abaker EXAMPLE\abaker abaker@example.com
The default canonicalization depends on what account domain name options were supplied. If accountDomainNameShort was supplied, the default accountCanonicalForm value is ACCTNAME_FORM_BACKSLASH. Otherwise, if accountDomainName was supplied, the default is ACCTNAME_FORM_PRINCIPAL. Account name canonicalization ensures that the string used to identify an account is consistent regardless of what was supplied to bind(). For example, if the user supplies an account name of abaker@example.com or just abaker and the accountCanonicalForm is set to 3, the resulting canonicalized name would be EXAMPLEabaker.
$acctname = W\\user2; $password = pass2; $multiOptions = array( server1 => array( host username password bindRequiresDn accountDomainName accountDomainNameShort accountCanonicalForm baseDn ), server2 => array( host useSsl username password accountDomainName accountDomainNameShort accountCanonicalForm baseDn ), ); $ldap = new Zend\Ldap\Ldap(); foreach ($multiOptions as $name => $options) {
709
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
echo "Trying to bind using server options for $name\n"; $ldap->setOptions($options); try { $ldap->bind($acctname, $password); $acctname = $ldap->getCanonicalAccountName($acctname); echo "SUCCESS: authenticated $acctname\n"; return; } catch (Zend\Ldap\Exception\LdapException $zle) { echo . $zle->getMessage() . "\n"; if ($zle->getCode() === Zend\Ldap\Exception\LdapException::LDAP_X_DOMAIN_MISMATCH) { continue; } } }
If the bind fails for any reason, the next set of server options is tried. The getCanonicalAccountName() call gets the canonical account name that the application would presumably use to associate data with such as preferences. The accountCanonicalForm = 4 in all server options ensures that the canonical form is consistent regardless of which server was ultimately used. The special LDAP_X_DOMAIN_MISMATCH exception occurs when an account name with a domain component was supplied (e.g., abaker@foo.net or FOOabaker and not just abaker) but the domain component did not match either domain in the currently selected server options. This exception indicates that the server is not an authority for the account. In this case, the bind will not be performed, thereby eliminating unnecessary communication with the server. Note that the continue instruction has no effect in this example, but in practice for error handling and debugging purposes, you will probably want to check for LDAP_X_DOMAIN_MISMATCH as well as LDAP_NO_SUCH_OBJECT and LDAP_INVALID_CREDENTIALS. The above code is very similar to code used within Zend\Authentication\Adapter\Ldap. In fact, we recommend that you simply use that authentication adapter for multi-domain + failover LDAP based authentication (or copy the code).
710
CHAPTER 144
API overview
711
Table 144.1: Zend\Ldap\Ldap Options Name host Description The default hostname of LDAP server if not supplied to connect() (also may be used when trying to canonicalize usernames in bind()). port Default port of LDAP server if not supplied to connect(). useStartTls Whether or not the LDAP client should use TLS (aka SSLv2) encrypted transport. A value of TRUE is strongly favored in production environments to prevent passwords from be transmitted in clear text. The default value is FALSE, as servers frequently require that a certicate be installed separately after installation. The useSsl and useStartTls options are mutually exclusive. The useStartTls option should be favored over useSsl but not all servers support this newer mechanism. useSsl Whether or not the LDAP client should use SSL encrypted transport. The useSsl and useStartTls options are mutually exclusive. username The default credentials username. Some servers require that this be in DN form. This must be given in DN form if the LDAP server requires a DN to bind and binding should be possible with simple usernames. password The default credentials password (used only with username above). bindRequiresDn If TRUE, this instructs Zend\Ldap\Ldap to retrieve the DN for the account used to bind if the username is not already in DN form. The default value is FALSE. baseDn The default base DN used for searching (e.g., for accounts). This option is required for most account related operations and should indicate the DN under which accounts are located. accountCanon- A small integer indicating the form to which account names should be canonicalized. See the icalForm Account Name Canonicalization section below. accountDoThe FQDN domain for which the target LDAP server is an authority (e.g., example.com). mainName accountDoThe short domain for which the target LDAP server is an authority. This is usually used to mainspecify the NetBIOS domain name for Windows networks but may also be used by non-AD NameShort servers. accountFilterThe LDAP search lter used to search for accounts. This string is a sprintf() style expression Format that must contain one %s to accommodate the username. The default value is (&(objectClass=user)(sAMAccountName=%s)) unless bindRequiresDn is set to TRUE, in which case the default is (&(objectClass=posixAccount)(uid=%s)). Users of custom schemas may need to change this option. allowEmptySome LDAP servers can be congured to accept an empty string password as an anonymous Password bind. This behavior is almost always undesirable. For this reason, empty passwords are explicitly disallowed. Set this value to TRUE to allow an empty string password to be submitted during the bind. optReferrals If set to TRUE, this option indicates to the LDAP client that referrals should be followed. The default value is FALSE. tryUsernameS- If set to FALSE, this option indicates that the given username should not be split at the rst @ plit or \ character to separate the username from the domain during the binding-procedure. This allows the user to use usernames that contain an @ or \ character that do not inherit some domain-information, e.g. using email-addresses for binding. The default value is TRUE. networkTimeNumber of seconds to wait for LDAP connection before fail. If not set the default value is the out system value.
712
CHAPTER 145
Zend\Ldap\Ldap
Zend\Ldap\Ldap is the base interface into a LDAP server. It provides connection and binding methods as well as methods to operate on the LDAP tree.
Method __construct($options) resource getResource() integer getLastErrorCode() string getLastError(integer &$errorCode, array &$errorMessages) Zend\Ldap\Ldap setOptions($options) array getOptions() string getBaseDn() string getCanonicalAccountName(string $acctname, integer $form) Zend\Ldap\Ldap disconnect() Zend\Ldap\Ldap connect(string $host, integer $port, boolean $useSsl, boolean $useStartTls, integer $networkTimeout) Zend\Ldap\Ldap bind(string $username, string $password) Zend\Ldap\Collection search(string|Zend\Ldap\Filter\AbstractFilter $lter, string|Zend\Ldap\Dn $basedn, integer $scope, array $attrib integer count(string|Zend\Ldap\Filter\AbstractFilter $lter, string|Zend\Ldap\Dn $basedn, integer $scope) integer countChildren(string|Zend\Ldap\Dn $dn) boolean exists(string|Zend\Ldap\Dn $dn) array searchEntries(string|Zend\Ldap\Filter\AbstractFilter $lter, string|Zend\Ldap\Dn $basedn, integer $scope, array $attributes, strin array getEntry(string|Zend\Ldap\Dn $dn, array $attributes, boolean $throwOnNotFound) void prepareLdapEntryArray(array &$entry) Zend\Ldap\Ldap add(string|Zend\Ldap\Dn $dn, array $entry) Zend\Ldap\Ldap update(string|Zend\Ldap\Dn $dn, array $entry) Zend\Ldap\Ldap save(string|Zend\Ldap\Dn $dn, array $entry) Zend\Ldap\Ldap delete(string|Zend\Ldap\Dn $dn, boolean $recursively) Zend\Ldap\Ldap moveToSubtree(string|Zend\Ldap\Dn $from, string|Zend\Ldap\Dn $to, boolean $recursively, boolean $alwaysEmula Zend\Ldap\Ldap move(string|Zend\Ldap\Dn $from, string|Zend\Ldap\Dn $to, boolean $recursively, boolean $alwaysEmulate) Zend\Ldap\Ldap rename(string|Zend\Ldap\Dn $from, string|Zend\Ldap\Dn $to, boolean $recursively, boolean $alwaysEmulate) Zend\Ldap\Ldap copyToSubtree(string|Zend\Ldap\Dn $from, string|Zend\Ldap\Dn $to, boolean $recursively) Zend\Ldap\Ldap copy(string|Zend\Ldap\Dn $from, string|Zend\Ldap\Dn $to, boolean $recursively) Zend\Ldap\Node getNode(string|Zend\Ldap\Dn $dn)
713
145.1 Zend\Ldap\Collection
Zend\Ldap\Collection implements Iterator to allow for item traversal using foreach() and Countable to be able to respond to count(). With its protected createEntry() method it provides a simple extension point for developers needing custom result objects. Table 145.2: Zend\Ldap\Collection API Method Description __conConstructor. The constructor must be provided by a struct(Zend\Ldap\Collection\Iterator\Interface Zend\Ldap\Collection\Iterator\Interface which does the real result iteration. $iterator) Zend\Ldap\Collection\Iterator\Default is the default implementation for iterating ext/ldap results. boolean close() Closes the internal iterator. This is also called in the destructor. array toArray() Returns all entries as an array. array getFirst() Returns the rst entry in the collection or NULL if the collection is empty.
714
CHAPTER 146
Zend\Ldap\Attribute
Zend\Ldap\Attribute is a helper class providing only static methods to manipulate arrays suitable to the structure used in Zend\Ldap\Ldap data modication methods and to the data format required by the LDAP server. PHP data types are converted using Zend\Ldap\Converter\Converter methods.
715
Table 146.1: Zend\Ldap\Attribute API Method void setAttribute(array &$data, string $attribName, mixed $value, boolean $append) array|mixed getAttribute(array $data, string $attribName, integer|null $index) Description Sets the attribute $attribName in $data to the value $value. If $append is TRUE (FALSE by default) $value will be appended to the attribute. $value can be a scalar value or an array of scalar values. Conversion will take place. Returns the attribute $attribName from $data. If $index is NULL (default) an array will be returned containing all the values for the given attribute. An empty array will be returned if the attribute does not exist in the given array. If an integer index is specied the corresponding value at the given index will be returned. If the index is out of bounds, NULL will be returned. Conversion will take place. Checks if the attribute $attribName in $data has the value(s) given in $value. The method returns TRUE only if all values in $value are present in the attribute. Comparison is done strictly (respecting the data type). Removes all duplicates from the attribute $attribName in $data. Removes the value(s) given in $value from the attribute $attribName in $data. Sets a LDAP password for the attribute $attribName in $data. $attribName defaults to userPassword which is the standard password attribute. The password hash can be specied with $hashType. The default value here is Zend\Ldap\Attribute::PASSWORD_HASH_MD5 with Zend\Ldap\Attribute::PASSWORD_HASH_SHA as the other possibility. Creates a LDAP password. The password hash can be specied with $hashType. The default value here is Zend\Ldap\Attribute::PASSWORD_HASH_MD5 with Zend\Ldap\Attribute::PASSWORD_HASH_SHA as the other possibility. Sets the attribute $attribName in $data to the date/time value $value. if $append is TRUE (FALSE by default) $value will be appended to the attribute. $value can be an integer value or an array of integers. Date-time-conversion according to Zend\Ldap\Converter\Converter::toLdapDateTime() will take place. Returns the date/time attribute $attribName from $data. If $index is NULL (default) an array will be returned containing all the date/time values for the given attribute. An empty array will be returned if the attribute does not exist in the given array. If an integer index is specied the corresponding date/time value at the given index will be returned. If the index is out of bounds, NULL will be returned. Date-time-conversion according to Zend\Ldap\Converter\Converter::fromLdapDateTime() will take place.
void removeDuplicatesFromAttribute(array &$data, string $attribName) void removeFromAttribute(array &$data, string $attribName, mixed|array $value) void setPassword(array &$data, string $password, string $hashType, string $attribName)
void setDateTimeAttribute(array &$data, string $attribName, integer|array $value, boolean $utc, boolean $append)
716
CHAPTER 147
Zend\Ldap\Converter\Converter
Zend\Ldap\Converter\Converter is a helper class providing only static methods to manipulate arrays suitable to the data format required by the LDAP server. PHP data types are converted the following way: string No conversion will be done. integer and oat The value will be converted to a string. boolean TRUE will be converted to TRUE and FALSE to FALSE object and array The value will be converted to a string by using serialize(). Date/Time The value will be converted to a string with the following date() format YmdHisO, UTC timezone (+0000) will be replaced with a Z. For example 01-30-2011 01:17:32 PM GMT-6 will be 201130011317320600 and 30-01-2012 15:17:32 UTC will be 20120130151732Z resource If a stream resource is given, the data will be fetched by calling stream_get_contents(). others All other data types (namely non-stream resources) will be omitted. On reading values the following conversion will take place: TRUE Converted to TRUE. FALSE Converted to FALSE. others All other strings wont be automatically converted and are passed as they are.
717
Table 147.1: Zend\Ldap\Converter\Converter API Method string ascToHex32(string $string) string hex32ToAsc(string $string) string|null toLdap(mixed $value, int $type) Description Convert all Ascii characters with decimal value less than 32 to hexadecimal value. Convert all hexadecimal characters by his Ascii value. Converts a PHP data type into its LDAP representation. $type argument is used to set the conversion method by default Converter::STANDARD where the function will try to guess the conversion method to use, others possibilities are Converter::BOOLEAN and Converter::GENERALIZED_TIME See introduction for details. Converts an LDAP value into its PHP data type. See introduction and toLdap() and toLdapDateTime() for details. Converts a timestamp, a DateTime Object, a string that is parseable by strtotime() or a DateTime into its LDAP date/time representation. If $asUtc is TRUE ( FALSE by default) the resulting LDAP date/time string will be inUTC, otherwise a local date/time string will be returned. Converts LDAP date/time representation into a PHP DateTime object.
mixed fromLdap(string $value, int $type, boolean $dateTimeAsUtc) string|null toLdapDateTime(integer|string|DateTime $date, boolean $asUtc) DateTime fromLdapDateTime(string $date, boolean $asUtc) string toLdapBoolean(boolean|integer|string $value) boolean fromLdapBoolean(string $value) string toLdapSerialize(mixed $value) mixed fromLdapUnserialize(string $value)
Converts a PHP data type into its LDAP boolean representation. By default always return FALSE except if the value is true , true or 1 Converts LDAP boolean representation into a PHP boolean data type. The value will be converted to a string by using serialize(). The value will be converted from a string by using unserialize().
718
CHAPTER 148
Zend\Ldap\Dn
Zend\Ldap\Dn provides an object-oriented interface to manipulating LDAP distinguished names (DN). The parameter $caseFold that is used in several methods determines the way DN attributes are handled regarding their case. Allowed values for this parameter are: ZendLdapDn::ATTR_CASEFOLD_NONE No case-folding will be done. ZendLdapDn::ATTR_CASEFOLD_UPPER All attributes will be converted to upper-case. ZendLdapDn::ATTR_CASEFOLD_LOWER All attributes will be converted to lower-case. The default case-folding is Zend\Ldap\Dn::ATTR_CASEFOLD_NONE and can be set with Zend\Ldap\Dn::setDefaultCaseFold(). Each instance of Zend\Ldap\Dn can have its own casefolding-setting. If the $caseFold parameter is omitted in method-calls it defaults to the instances case-folding setting. The class implements ArrayAccess to allow indexer-access to the different parts of the DN. The ArrayAccess-methods proxy to Zend\Ldap\Dn::get($offset, 1, null) for offsetGet(integer $offset), to Zend\Ldap\Dn::set($offset, $value) for offsetSet() and to Zend\Ldap\Dn::remove($offset, 1) for offsetUnset(). offsetExists() simply checks if the index is within the bounds.
719
Table 148.1: Zend\Ldap\Dn API Method Zend\Ldap\Dn factory(string|array $dn, string|null $caseFold) Zend\Ldap\Dn fromString(string $dn, string|null $caseFold) Zend\Ldap\Dn fromArray(array $dn, string|null $caseFold) array getRdn(string|null $caseFold) string getRdnString(string|null $caseFold) Zend\Ldap\Dn getParentDn(integer $levelUp) array get(integer $index, integer $length, string|null $caseFold) Zend\Ldap\Dn set(integer $index, array $value) Zend\Ldap\Dn remove(integer $index, integer $length) Zend\Ldap\Dn append(array $value) Zend\Ldap\Dn prepend(array $value) Zend\Ldap\Dn insert(integer $index, array $value) void setCaseFold(string|null $caseFold) Description Creates a Zend\Ldap\Dn instance from an array or a string. The array must conform to the array structure detailed under Zend\Ldap\Dn::implodeDn(). Creates a Zend\Ldap\Dn instance from a string. Creates a Zend\Ldap\Dn instance from an array. The array must conform to the array structure detailed under Zend\Ldap\Dn::implodeDn(). Gets the RDN of the current DN. The return value is an array with the RDN attribute names its keys and the RDN attribute values. Gets the RDN of the current DN. The return value is a string. Gets the DN of the current DNs ancestor $levelUp levels up the tree. $levelUp defaults to 1. Returns a slice of the current DN determined by $index and $length. $index starts with 0 on the DN part from the left. Replaces a DN part in the current DN. This operation manipulates the current instance. Removes a DN part from the current DN. This operation manipulates the current instance. $length defaults to 1 Appends a DN part to the current DN. This operation manipulates the current instance. Prepends a DN part to the current DN. This operation manipulates the current instance. Inserts a DN part after the index $index to the current DN. This operation manipulates the current instance. Sets the case-folding option to the current DN instance. If $caseFold is NULL the default case-folding setting (Zend\Ldap\Dn::ATTR_CASEFOLD_NONE by default or set via Zend\Ldap\Dn::setDefaultCaseFold() will be set for the current instance. Returns DN as a string. Returns DN as an array. Returns DN as a string - proxies to Zend\Ldap\Dn::toString(null). Sets the default case-folding option used by all instances on creation by default. Already existing instances are not affected by this setting. Escapes a DN value according to RFC 2253. Undoes the conversion done by Zend\Ldap\Dn::escapeValue(). Explodes the DN $dn into an array containing all parts of the given DN. $keys optionally receive DN keys (e.g. CN, OU, DC, ...). $vals optionally receive DN values. The resulting array will be of type array( array(cn => name1, uid => user), array(cn => name2), array(dc => example), array(dc => org) ) for a DN of cn=name1+uid=user,cn=name2,dc=example,dc=org. Checks if a given DN $dn is malformed. If $keys or $keys and $vals are given, these arrays will be lled with the appropriate DN keys and values. Returns a DN part in the form $attribute=$value Implodes an array in the form delivered by Zend\Ldap\Dn::explodeDn() to a DN string. $separator defaults to , but some LDAP servers also understand ;. $dnArray must of type array( array(cn => name1, uid => user), array(cn => name2),Chapter array(dc => example), 148. Zend\Ldap\Dn array(dc => org) ) Checks if given $childDn is beneath $parentDn subtree.
string toString(string|null $caseFold) array toArray(string|null $caseFold) string __toString() void setDefaultCaseFold(string $caseFold) array escapeValue(string|array $values) array unescapeValue(string|array $values) array explodeDn(string $dn, array &$keys, array &$vals, string|null $caseFold)
boolean checkDn(string $dn, array &$keys, array &$vals, string|null $caseFold) string implodeRdn(array $part, string|null $caseFold) string implodeDn(array $dnArray, string|null $caseFold, string $separator) 720 boolean isChildOf(string|Zend\Ldap\Dn
721
CHAPTER 149
Zend\Ldap\Filter
Table 149.1: Zend\Ldap\Filter API Method Zend\Ldap\Filter equals(string $attr, string $value) Zend\Ldap\Filter begins(string $attr, string $value) Zend\Ldap\Filter ends(string $attr, string $value) Zend\Ldap\Filter contains(string $attr, string $value) Zend\Ldap\Filter greater(string $attr, string $value) Zend\Ldap\Filter greaterOrEqual(string $attr, string $value) Zend\Ldap\Filter less(string $attr, string $value) Zend\Ldap\Filter lessOrEqual(string $attr, string $value) Zend\Ldap\Filter approx(string $attr, string $value) Zend\Ldap\Filter any(string $attr) Zend\Ldap\Filter string(string $lter) Zend\Ldap\Filter mask(string $mask, string $value,...) Zend\Ldap\Filter andFilter(Zend\Ldap\Filter\AbstractFilter $lter,...) Zend\Ldap\Filter orFilter(Zend\Ldap\Filter\AbstractFilter $lter,...) __construct(string $attr, string $value, string $ltertype, string|null $prepend, string|null $append) string toString() string __toString() 722 Zend\Ldap\Filter\AbstractFilter negate() Zend\Ldap\Filter\AbstractFilter addAnd(Zend\Ldap\Filter\AbstractFilter Description Creates an equals lter: (attr=value). Creates an begins with lter: (attr=value*). Creates an ends with lter: (attr=*value). Creates an contains lter: (attr=*value*). Creates an greater lter: (attr>value). Creates an greater or equal lter: (attr>=value). Creates an less lter: (attr<value). Creates an less or equal lter: (attr<=value). Creates an approx lter: (attr~=value). Creates an any lter: (attr=*). Creates a simple custom string lter. The user is responsible for all value-escaping as the lter is used as is. Creates a lter from a string mask. All $value parameters will be escaped and substituted into $mask by using sprintf() Creates an and lter from all arguments given.
Constructor. Creates an arbitrary lter according to the parameters supplied. The resulting lter will be a concatenation $attr . $ltertype . $prepend . $value . $append. Normally this constructor is not needed as all lters can be created by using the appropriate factory methods. Returns a string representation of the lter. Returns a string representation of the lter. Proxies to Chapter 149. Zend\Ldap\Filter Zend\Ldap\Filter::toString(). Negates the current lter. Creates an and lter from the current lter and all lters passed in as the arguments.
CHAPTER 150
Zend\Ldap\Node
Zend\Ldap\Node includes the magic property accessors __set(), __get(), __unset() and __isset() to access the attributes by their name. They proxy to Zend\Ldap\Node::setAttribute(), Zend\Ldap\Node::getAttribute(), Zend\Ldap\Node::deleteAttribute() and Zend\Ldap\Node::existsAttribute() respectively. Furthermore the class implements ArrayAccess for array-style-access to the attributes. Zend\Ldap\Node also implements Iterator and RecursiveIterator to allow for recursive tree-traversal.
Method Zend\Ldap\Ldap getLdap() Zend\Ldap\Node attachLdap(Zend\Ldap\Ldap $ldap) Zend\Ldap\Node detachLdap() boolean isAttached() Zend\Ldap\Node create(string|array|Zend\Ldap\Dn $dn, array $objectClass) Zend\Ldap\Node fromLdap(string|array|Zend\Ldap\Dn $dn, Zend\Ldap\Ldap $ldap) Zend\Ldap\Node fromArray((array $data, boolean $fromDataSource) boolean isNew() boolean willBeDeleted() Zend\Ldap\Node delete() boolean willBeMoved() Zend\Ldap\Node update(Zend\Ldap\Ldap $ldap) Zend\Ldap\Dn getCurrentDn() Zend\Ldap\Dn getDn() string getDnString(string $caseFold) array getDnArray(string $caseFold) string getRdnString(string $caseFold) array getRdnArray(string $caseFold) Zend\Ldap\Node setDn(Zend\Ldap\Dn|string|array $newDn) Zend\Ldap\Node move(Zend\Ldap\Dn|string|array $newDn) Zend\Ldap\Node rename(Zend\Ldap\Dn|string|array $newDn) array getObjectClass() Zend\Ldap\Node setObjectClass(array|string $value) Zend\Ldap\Node appendObjectClass(array|string $value) string toLdif(array $options)
Description Returns the cu Attach the cur Detach node f Checks if the Factory metho Factory metho Factory metho Tells if the no Tells if this no Marks this no Tells if this no Sends all pend Gets the curre Gets the origin Gets the origin Gets the origin Gets the RDN Gets the RDN Sets the new D This is an alia This is an alia Returns the ob Sets the objec Appends to th Returns a LDI
723
Method array getChangedData() array getChanges() string toString() string __toString() array toArray(boolean $includeSystemAttributes) string toJson(boolean $includeSystemAttributes) array getData(boolean $includeSystemAttributes) boolean existsAttribute(string $name, boolean $emptyExists) boolean attributeHasValue(string $name, mixed|array $value) integer count() mixed getAttribute(string $name, integer|null $index) array getAttributes(boolean $includeSystemAttributes) Zend\Ldap\Node setAttribute(string $name, mixed $value) Zend\Ldap\Node appendToAttribute(string $name, mixed $value) array|integer getDateTimeAttribute(string $name, integer|null $index) Zend\Ldap\Node setDateTimeAttribute(string $name, integer|array $value, boolean $utc) Zend\Ldap\Node appendToDateTimeAttribute(string $name, integer|array $value, boolean $utc) Zend\Ldap\Node setPasswordAttribute(string $password, string $hashType, string $attribName) Zend\Ldap\Node deleteAttribute(string $name) void removeDuplicatesFromAttribute(string$name) void removeFromAttribute(string $attribName, mixed|array $value) boolean exists(Zend\Ldap\Ldap $ldap) Zend\Ldap\Node reload(Zend\Ldap\Ldap $ldap) Zend\Ldap\Node\Collection searchSubtree(string|Zend\Ldap\Filter\AbstractFilter $lter, integer $scope, string $sort) integer countSubtree(string|Zend\Ldap\Filter\AbstractFilter $lter, integer $scope) integer countChildren() Zend\Ldap\Node\Collection searchChildren(string|Zend\Ldap\Filter\AbstractFilter $lter, string $sort) boolean hasChildren() Zend\Ldap\Node\ChildrenIterator getChildren() Zend\Ldap\Node getParent(Zend\Ldap\Ldap $ldap)
Description Gets changed Returns all ch Returns the D Casts to string Returns an arr Returns a JSO Returns the no Checks wheth Checks if the Returns the nu Gets a LDAP Gets all attribu Sets a LDAP a Appends to a Gets a LDAP Sets a LDAP d Appends to a Sets a LDAP p Deletes a LDA Removes dupl Removes the g Checks if the Reloads the cu Searches the n Count the nod Count the nod Searches the n Returns wheth Returns all ch Returns the pa
724
CHAPTER 151
Zend\Ldap\Node\RootDse
The following methods are available on all vendor-specic subclasses. Zend\Ldap\Node\RootDse includes the magic property accessors __get() and __isset() to access the attributes by their name. They proxy to Zend\Ldap\Node\RootDse::getAttribute() and Zend\Ldap\Node\RootDse::existsAttribute() respectively. __set() and __unset() are also implemented but they throw a BadMethodCallException as modications are not allowed on RootDSE nodes. Furthermore the class implements ArrayAccess for array-style-access to the attributes. offsetSet() and offsetUnset() also throw a BadMethodCallException due ro obvious reasons.
725
Table 151.1: Zend\Ldap\Node\RootDse API Method Zend\Ldap\Dn getDn() string getDnString(string $caseFold) array getDnArray(string $caseFold) string getRdnString(string $caseFold) array getRdnArray(string $caseFold) array getObjectClass() string toString() string __toString() array toArray(boolean $includeSystemAttributes) Description Gets the DN of the current node as a Zend\Ldap\Dn. Gets the DN of the current node as a string. Gets the DN of the current node as an array. Gets the RDN of the current node as a string. Gets the RDN of the current node as an array. Returns the objectClass of the node. Returns the DN of the current node - proxies to Zend\Ldap\Dn::getDnString(). Casts to string representation - proxies to Zend\Ldap\Dn::toString(). Returns an array representation of the current node. If $includeSystemAttributes is FALSE (defaults to TRUE) the system specic attributes are stripped from the array. Unlike Zend\Ldap\Node\RootDse::getAttributes() the resulting array contains the DN with key dn. Returns a JSON representation of the current node using Zend\Ldap\Node\RootDse::toArray(). Returns the nodes attributes. The array contains all attributes in its internal format (no conversion). Checks whether a given attribute exists. If $emptyExists is FALSE, empty attributes (containing only array()) are treated as non-existent returning FALSE. If $emptyExists is TRUE, empty attributes are treated as existent returning TRUE. In this case the method returns FALSE only if the attribute name is missing in the key-collection. Checks if the given value(s) exist in the attribute. The method returns TRUE only if all values in $value are present in the attribute. Comparison is done strictly (respecting the data type). Returns the number of attributes in the node. Implements Countable. Gets a LDAP attribute. Data conversion is applied using Zend\Ldap\Attribute::getAttribute(). Gets all attributes of node. If $includeSystemAttributes is FALSE (defaults to TRUE) the system specic attributes are stripped from the array. Gets a LDAP date/time attribute. Data conversion is applied using Zend\Ldap\Attribute::getDateTimeAttribute(). Reloads the current nodes attributes from the given LDAP server. Factory method to create the RootDSE. Gets the namingContexts. Gets the subschemaSubentry. Determines if the LDAP version is supported.
string toJson(boolean $includeSystemAttributes) array getData(boolean $includeSystemAttributes) boolean existsAttribute(string $name, boolean $emptyExists)
boolean attributeHasValue(string $name, mixed|array $value) integer count() mixed getAttribute(string $name, integer|null $index) array getAttributes(boolean $includeSystemAttributes) array|integer getDateTimeAttribute(string $name, integer|null $index) Zend\Ldap\Node\RootDse reload(Zend\Ldap\Ldap $ldap) Zend\Ldap\Node\RootDse create(Zend\Ldap\Ldap $ldap) array getNamingContexts() string|null getSubschemaSubentry() boolean supportsVersion(string|int|array $versions) boolean supportsSaslMechanism(string|array $mechlist) integer getServerType() 726
Gets the server type. Returns Zend\Ldap\Node\RootDse::SERVER_TYPE_GENERICfor unknown LDAP serversZend\Ldap\Node\RootDse::SERVER_TYPE_OPENLDAPfor Chapter 151. Zend\Ldap\Node\RootDse OpenLDAP serversZend\Ldap\Node\RootDse::SERVER_TYPE_ACTIVEDIRECTORYfor Microsoft ActiveDirectory
151.1 OpenLDAP
Additionally the common methods above apply to instances of Zend\Ldap\Node\RootDse\OpenLdap. Note: Refer to LDAP Operational Attributes and Objects for information on the attributes of OpenLDAP RootDSE.
Table 151.2: Zend\Ldap\Node\RootDse\OpenLdap API Method integer getServerType() string|null getCongContext() string|null getMonitorContext() boolean supportsControl(string|array $oids) boolean supportsExtension(string|array $oids) boolean supportsFeature(string|array $oids) Description Gets the server type. Returns Zend\Ldap\Node\RootDse::SERVER_TYPE_OPENLDAP Gets the congContext. Gets the monitorContext. Determines if the control is supported. Determines if the extension is supported. Determines if the feature is supported.
151.2 ActiveDirectory
Additionally the common methods above apply to instances of Zend\Ldap\Node\RootDse\ActiveDirectory. Note: Refer to RootDSE for information on the attributes of Microsoft ActiveDirectory RootDSE.
151.1. OpenLDAP
727
Table 151.3: Zend\Ldap\Node\RootDse\ActiveDirectory API Method integer getServerType() string|null getCongurationNamingContext() string|null getCurrentTime() string|null getDefaultNamingContext() string|null getDnsHostName() string|null getDomainControllerFunctionality() string|null getDomainFunctionality() string|null getDsServiceName() string|null getForestFunctionality() string|null getHighestCommittedUSN() string|null getIsGlobalCatalogReady() string|null getIsSynchronized() string|null getLdapServiceName() string|null getRootDomainNamingContext() string|null getSchemaNamingContext() string|null getServerName() boolean supportsCapability(string|array $oids) boolean supportsControl(string|array $oids) boolean supportsPolicy(string|array $policies) Description Gets the server type. Returns Zend\Ldap\Node\RootDse::SERVER_TYPE_ACTIVEDIRECTORY Gets the congurationNamingContext. Gets the currentTime. Gets the defaultNamingContext. Gets the dnsHostName. Gets the domainControllerFunctionality. Gets the domainFunctionality. Gets the dsServiceName. Gets the forestFunctionality. Gets the highestCommittedUSN. Gets the isGlobalCatalogReady. Gets the isSynchronized. Gets the ldapServiceName. Gets the rootDomainNamingContext. Gets the schemaNamingContext. Gets the serverName. Determines if the capability is supported.
151.3 eDirectory
Additionally the common methods above apply to instances of ZendLdapNodeRootDseeDirectory. Note: Refer to Getting Information about the LDAP Server for information on the attributes of Novell eDirectory RootDSE.
728
Table 151.4: Zend\Ldap\Node\RootDse\eDirectory API Method integer getServerType() boolean supportsExtension(string|array $oids) string|null getVendorName() string|null getVendorVersion() string|null getDsaName() string|null getStatisticsErrors() string|null getStatisticsSecurityErrors() string|null getStatisticsChainings() string|null getStatisticsReferralsReturned() string|null getStatisticsExtendedOps() string|null getStatisticsAbandonOps() string|null getStatisticsWholeSubtreeSearchOps() Description Gets the server type. Returns Zend\Ldap\Node\RootDse::SERVER_TYPE_EDIRECTORY Determines if the extension is supported. Gets the vendorName. Gets the vendorVersion. Gets the dsaName. Gets the server statistics errors. Gets the server statistics securityErrors. Gets the server statistics chainings. Gets the server statistics referralsReturned. Gets the server statistics extendedOps. Gets the server statistics abandonOps. Gets the server statistics wholeSubtreeSearchOps.
151.3. eDirectory
729
730
CHAPTER 152
Zend\Ldap\Node\Schema
The following methods are available on all vendor-specic subclasses. ZendLdapNodeSchema includes the magic property accessors __get() and __isset() to access the attributes by their name. They proxy to ZendLdapNodeSchema::getAttribute() and ZendLdapNodeSchema::existsAttribute() respectively. __set() and __unset() are also implemented, but they throw a BadMethodCallException as modications are not allowed on RootDSE nodes. Furthermore the class implements ArrayAccess for array-style-access to the attributes. offsetSet() and offsetUnset() also throw a BadMethodCallException due to obvious reasons.
731
Table 152.1: Zend\Ldap\Node\Schema API Method Zend\Ldap\Dn getDn() string getDnString(string $caseFold) array getDnArray(string $caseFold) string getRdnString(string $caseFold) array getRdnArray(string $caseFold) array getObjectClass() string toString() string __toString() array toArray(boolean $includeSystemAttributes) Description Gets the DN of the current node as a Zend\Ldap\Dn. Gets the DN of the current node as a string. Gets the DN of the current node as an array. Gets the RDN of the current node as a string. Gets the RDN of the current node as an array. Returns the objectClass of the node. Returns the DN of the current node - proxies to Zend\Ldap\Dn::getDnString(). Casts to string representation - proxies to Zend\Ldap\Dn::toString(). Returns an array representation of the current node. If $includeSystemAttributes is FALSE (defaults to TRUE), the system specic attributes are stripped from the array. Unlike Zend\Ldap\Node\Schema::getAttributes(), the resulting array contains the DN with key dn. Returns a JSON representation of the current node using Zend\Ldap\Node\Schema::toArray(). Returns the nodes attributes. The array contains all attributes in its internal format (no conversion). Checks whether a given attribute exists. If $emptyExists is FALSE, empty attributes (containing only array()) are treated as non-existent returning FALSE. If $emptyExists is TRUE, empty attributes are treated as existent returning TRUE. In this case the method returns FALSE only if the attribute name is missing in the key-collection. Checks if the given value(s) exist in the attribute. The method returns TRUE only if all values in $value are present in the attribute. Comparison is done strictly (respecting the data type). Returns the number of attributes in the node. Implements Countable. Gets a LDAP attribute. Data conversion is applied using Zend\Ldap\Attribute::getAttribute(). Gets all attributes of node. If $includeSystemAttributes is FALSE (defaults to TRUE) the system specic attributes are stripped from the array. Gets a LDAP date/time attribute. Data conversion is applied using Zend\Ldap\Attribute::getDateTimeAttribute(). Reloads the current nodes attributes from the given LDAP server. Factory method to create the Schema node. Gets the attribute types as an array of . Gets the object classes as an array of Zend\Ldap\Node\Schema\ObjectClass\Interface.
string toJson(boolean $includeSystemAttributes) array getData(boolean $includeSystemAttributes) boolean existsAttribute(string $name, boolean $emptyExists)
boolean attributeHasValue(string $name, mixed|array $value) integer count() mixed getAttribute(string $name, integer|null $index) array getAttributes(boolean $includeSystemAttributes) array|integer getDateTimeAttribute(string $name, integer|null $index) Zend\Ldap\Node\Schema reload(Zend\Ldap\Ldap $ldap) Zend\Ldap\Node\Schema create(Zend\Ldap\Ldap $ldap) array getAttributeTypes() array getObjectClasses()
732
Table 152.2: Zend\Ldap\Node\Schema\AttributeType\Interface API Method string getName() string getOid() string getSyntax() int|null getMaxLength() boolean isSingleValued() string getDescription() Description Gets the attribute name. Gets the attribute OID. Gets the attribute syntax. Gets the attribute maximum length. Returns if the attribute is single-valued. Gets the attribute description
Table 152.3: Zend\Ldap\Node\Schema\ObjectClass\Interface API Method string getName() string getOid() array getMustContain() array getMayContain() string getDescription() integer getType() Description Returns the objectClass name. Returns the objectClass OID. Returns the attributes that this objectClass must contain.
Returns the attribute description Returns the objectClass type. The method returns one of the following values: Zend\Ldap\Node\Schema::OBJECTCLASS_TYPE_UNKNOWNfor unknown class typesZend\Ldap\Node\Schema::OBJECTCLASS_TYPE_STRUCTURALfor structural classesZend\Ldap\Node\Schema::OBJECTCLASS_TYPE_ABSTRACTfor abstract classesZend\Ldap\Node\Schema::OBJECTCLASS_TYPE_AUXILIARYfor auxiliary classes Returns the parent objectClasses of this class. This includes structural, abstract and auxiliary objectClasses.
array getParentClasses()
Classes representing attribute types and object classes extend ZendLdapNodeSchemaAbstractItem which provides some core methods to access arbitrary attributes on the underlying LDAP node. ZendLdapNodeSchemaAbstractItem includes the magic property accessors __get() and __isset() to access the attributes by their name. Furthermore the class implements ArrayAccess for array-style-access to the attributes. offsetSet() and offsetUnset() throw a BadMethodCallException as modications are not allowed on schema information nodes. Table 152.4: Zend\Ldap\Node\Schema\AbstractItem API Method array getData() integer count() Description Gets all the underlying data from the schema information node. Returns the number of attributes in this schema information node. Implements Countable.
152.1 OpenLDAP
Additionally the common methods above apply to instances of ZendLdapNodeSchemaOpenLDAP.
152.1. OpenLDAP
733
Table 152.5: Zend\Ldap\Node\Schema\OpenLDAP API Method array getLdapSyntaxes() array getMatchingRules() array getMatchingRuleUse() Description Gets the LDAP syntaxes. Gets the matching rules. Gets the matching rule use.
Table 152.6: Zend\Ldap\Node\Schema\AttributeType\OpenLDAP API Method Zend\Ldap\Node\Schema\AttributeType\OpenLdap|null getParent() Description Returns the parent attribute type in the inheritance tree if one exists.
Table 152.7: Zend\Ldap\Node\Schema\ObjectClass\OpenLDAP API Method array getParents() Description Returns the parent object classes in the inheritance tree if one exists. The returned array is an array of Zend\Ldap\Node\Schema\ObjectClass\OpenLdap.
152.2 ActiveDirectory
Note: Schema browsing on ActiveDirectory servers Due to restrictions on Microsoft ActiveDirectory servers regarding the number of entries returned by generic search routines and due to the structure of the ActiveDirectory schema repository, schema browsing is currently not available for Microsoft ActiveDirectory servers. ZendLdapNodeSchemaActiveDirectory does not provide any additional methods. Table 152.8: Zend\Ldap\Node\Schema\AttributeType\ActiveDirectory API Zend\Ldap\Node\Schema\AttributeType\ActiveDirectory does not provide any additional methods. Table 152.9: Zend\Ldap\Node\Schema\ObjectClass\ActiveDirectory API Zend\Ldap\Node\Schema\ObjectClass\ActiveDirectory does not provide any additional methods.
734
CHAPTER 153
Zend\Ldap\Ldif\Encoder
Table 153.1: Zend\Ldap\Ldif\Encoder API Method Description array decode(string $string) Decodes the string $string into an array of LDIF items. string enEncode $value into a LDIF representation. $options is an array that may code(scalar|array|Zend\Ldap\Nodecontain the following keys: sort Sort the given attributes with dn following $value, array $options) objectClass and following all other attributes sorted alphabetically. TRUE by default. version The LDIF format version. 1 by default. wrap The line-length. 78 by default to conform to the LDIF specication.
735
736
CHAPTER 154
Usage Scenarios
1 2 3 4 5 6 7 8 9 10 11 12 13 14
Check for the existence of a given DN $options = array(/* ... */); $ldap = new Zend\Ldap\Ldap($options); $ldap->bind(); $isThere = $ldap->exists(cn=Hugo Mller,ou=People,dc=my,dc=local);
1 2 3 4
737
Count children of a given DN $options = array(/* ... */); $ldap = new Zend\Ldap\Ldap($options); $ldap->bind(); $childrenCount = $ldap->countChildren( cn=Hugo Mller,ou=People,dc=my,dc=local);
1 2 3 4 5
Searching the LDAP tree $options = array(/* ... */); $ldap = new Zend\Ldap\Ldap($options); $ldap->bind(); $result = $ldap->search((objectclass=*), ou=People,dc=my,dc=local, Zend\Ldap\Ldap::SEARCH_SCOPE_ONE); foreach ($result as $item) { echo $item["dn"] . : . $item[cn][0] . PHP_EOL; }
1 2 3 4 5 6 7 8 9
1 2 3 4 5 6 7 8
1 2 3 4
1 2 3
738
4 5 6 7 8 9
$hm = $ldap->getEntry(cn=Hugo Mller,ou=People,dc=my,dc=local); Zend\Ldap\Attribute::setAttribute($hm, mail, mueller@my.local); Zend\Ldap\Attribute::setPassword($hm, newPa$$w0rd, Zend\Ldap\Attribute::PASSWORD_HASH_SHA1); $ldap->update(cn=Hugo Mller,ou=People,dc=my,dc=local, $hm);
1 2 3 4 5 6
Move a LDAP entry recursively with all its descendants to a different subtree $options = array(/* ... */); $ldap = new Zend\Ldap\Ldap($options); $ldap->bind(); $ldap->moveToSubtree(cn=Hugo Mller,ou=People,dc=my,dc=local, ou=Dismissed,dc=my,dc=local, true);
1 2 3 4 5 6
739
740
CHAPTER 155
Tools
155.1 Creation and modication of DN strings 155.2 Using the lter API to create search lters
Create simple LDAP lters $f1 $f2 $f3 $f4 $f5 $f6 $f7 $f8 $f9 $f10 = = = = = = = = = = Zend\Ldap\Filter::equals(name, value); Zend\Ldap\Filter::begins(name, value); Zend\Ldap\Filter::ends(name, value); Zend\Ldap\Filter::contains(name, value); Zend\Ldap\Filter::greater(name, value); Zend\Ldap\Filter::greaterOrEqual(name, value); Zend\Ldap\Filter::less(name, value); Zend\Ldap\Filter::lessOrEqual(name, value); Zend\Ldap\Filter::approx(name, value); Zend\Ldap\Filter::any(name); // // // // // // // // // // (name=value) (name=value*) (name=*value) (name=*value*) (name>value) (name>=value) (name<value) (name<=value) (name~=value) (name=*)
1 2 3 4 5 6 7 8 9 10
Create more complex LDAP lters $f1 = Zend\Ldap\Filter::ends(name, value)->negate(); // (!(name=*value)) $f2 = Zend\Ldap\Filter::equals(name, value); $f3 = Zend\Ldap\Filter::begins(name, value); $f4 = Zend\Ldap\Filter::ends(name, value); // (&(name=value)(name=value*)(name=*value)) $f5 = Zend\Ldap\Filter::andFilter($f2, $f3, $f4); // (|(name=value)(name=value*)(name=*value)) $f6 = Zend\Ldap\Filter::orFilter($f2, $f3, $f4);
1 2 3 4 5 6 7 8 9 10 11
742
CHAPTER 156
1 2 3 4 5 6
743
7 8
var_dump($n); }
744
CHAPTER 157
157.1 RootDSE
See the following documents for more information on the attributes contained within the RootDSE for a given LDAP server. OpenLDAP Microsoft ActiveDirectory Novell eDirectory
Getting hands on the RootDSE $options = array(/* ... */); $ldap = new Zend\Ldap\Ldap($options); $rootdse = $ldap->getRootDse(); $serverType = $rootdse->getServerType();
1 2 3 4
1 2 3 4
745
746
CHAPTER 158
=> uid=rogasawara,ou=,o=Airius, => array(top, person, organizationalPerson, inetOrgPerson), uid => array(rogasawara), mail => array(rogasawara@airius.co.jp), givenname;lang-ja => array(), sn;lang-ja => array(), cn;lang-ja => array( ), title;lang-ja => array( ), preferredlanguage => array(ja), givenname => array(), sn => array(), cn => array( ), title => array( ), givenname;lang-ja;phonetic => array(), sn;lang-ja;phonetic => array(), cn;lang-ja;phonetic => array( ), title;lang-ja;phonetic => array( ), givenname;lang-en => array(Rodney), sn;lang-en => array(Ogasawara), cn;lang-en => array(Rodney Ogasawara), title;lang-en => array(Sales, Director),
); $ldif = Zend\Ldap\Ldif\Encoder::encode($data, array(sort => false, version => null)); /* $ldif contains: dn:: dWlkPXJvZ2FzYXdhcmEsb3U95Za25qWt6YOoLG89QWlyaXVz objectclass: top objectclass: person objectclass: organizationalPerson objectclass: inetOrgPerson uid: rogasawara
747
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
mail: rogasawara@airius.co.jp givenname;lang-ja:: 44Ot44OJ44OL44O8 sn;lang-ja:: 5bCP56yg5Y6f cn;lang-ja:: 5bCP56yg5Y6fIOODreODieODi+ODvA== title;lang-ja:: 5Za25qWt6YOoIOmDqOmVtw== preferredlanguage: ja givenname:: 44Ot44OJ44OL44O8 sn:: 5bCP56yg5Y6f cn:: 5bCP56yg5Y6fIOODreODieODi+ODvA== title:: 5Za25qWt6YOoIOmDqOmVtw== givenname;lang-ja;phonetic:: 44KN44Gp44Gr44O8 sn;lang-ja;phonetic:: 44GK44GM44GV44KP44KJ cn;lang-ja;phonetic:: 44GK44GM44GV44KP44KJIOOCjeOBqeOBq+ODvA== title;lang-ja;phonetic:: 44GI44GE44GO44KH44GG44G2IOOBtuOBoeOCh+OBhg== givenname;lang-en: Rodney sn;lang-en: Ogasawara cn;lang-en: Rodney Ogasawara title;lang-en: Sales, Director */
$ldif = "dn:: dWlkPXJvZ2FzYXdhcmEsb3U95Za25qWt6YOoLG89QWlyaXVz objectclass: top objectclass: person objectclass: organizationalPerson objectclass: inetOrgPerson uid: rogasawara mail: rogasawara@airius.co.jp givenname;lang-ja:: 44Ot44OJ44OL44O8 sn;lang-ja:: 5bCP56yg5Y6f cn;lang-ja:: 5bCP56yg5Y6fIOODreODieODi+ODvA== title;lang-ja:: 5Za25qWt6YOoIOmDqOmVtw== preferredlanguage: ja givenname:: 44Ot44OJ44OL44O8 sn:: 5bCP56yg5Y6f cn:: 5bCP56yg5Y6fIOODreODieODi+ODvA== title:: 5Za25qWt6YOoIOmDqOmVtw== givenname;lang-ja;phonetic:: 44KN44Gp44Gr44O8 sn;lang-ja;phonetic:: 44GK44GM44GV44KP44KJ cn;lang-ja;phonetic:: 44GK44GM44GV44KP44KJIOOCjeOBqeOBq+ODvA== title;lang-ja;phonetic:: 44GI44GE44GO44KH44GG44G2IOOBtuOBoeOCh+OBhg== givenname;lang-en: Rodney sn;lang-en: Ogasawara cn;lang-en: Rodney Ogasawara title;lang-en: Sales, Director"; $data = Zend\Ldap\Ldif\Encoder::decode($ldif); /* $data = array( dn => uid=rogasawara,ou=,o=Airius, objectclass => array(top, person, organizationalPerson, inetOrgPerson), uid => array(rogasawara), mail => array(rogasawara@airius.co.jp),
748
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
givenname;lang-ja sn;lang-ja cn;lang-ja title;lang-ja preferredlanguage givenname sn cn title givenname;lang-ja;phonetic sn;lang-ja;phonetic cn;lang-ja;phonetic title;lang-ja;phonetic givenname;lang-en sn;lang-en cn;lang-en title;lang-en ); */
=> => => => => => => => => => => => => => => => =>
array(), array(), array( ), array( ), array(ja), array(), array(), array( ), array( ), array(), array(), array( ), array( ), array(Rodney), array(Ogasawara), array(Rodney Ogasawara), array(Sales, Director),
749
750
CHAPTER 159
The AutoloaderFactory
159.1 Overview
Starting with version 2.0, Zend Framework now offers multiple autoloader strategies. Often, it will be useful to employ multiple autoloading strategies; as an example, you may have a class map for your most used classes, but want to use a PSR-0 style autoloader for 3rd party libraries. While you could potentially manually congure these, it may be more useful to dene the autoloader conguration somewhere and cache it. For these cases, the AutoloaderFactory will be useful.
$config = array( Zend\Loader\ClassMapAutoloader => array( application => APPLICATION_PATH . /.classmap.php, zf => APPLICATION_PATH . /../library/Zend/.classmap.php, ), Zend\Loader\StandardAutoloader => array( namespaces => array( Phly\Mustache => APPLICATION_PATH . /../library/Phly/Mustache, Doctrine => APPLICATION_PATH . /../library/Doctrine, ), ), );
Zend\Loader\ClassMapAutoloader.application = APPLICATION_PATH "/.classmap.php" Zend\Loader\ClassMapAutoloader.zf = APPLICATION_PATH "/../library/Zend/.classmap.php" Zend\Loader\StandardAutoloader.namespaces.Phly\Mustache = APPLICATION_PATH "/../library/Phly/Mustache Zend\Loader\StandardAutoloader.namespaces.Doctrine = APPLICATION_PATH "/../library/Doctrine"
Once you have your conguration in a PHP array, you simply pass it to the AutoloaderFactory.
751
1 2 3 4 5
// This example assumes ZF is on your include_path. // You could also load the factory class from a path relative to the // current script, or via an absolute path. require_once Zend/Loader/AutoloaderFactory.php; Zend\Loader\AutoloaderFactory::factory($config);
The AutoloaderFactory will instantiate each autoloader with the given options, and also call its register() method to register it with the SPL autoloader.
$options The AutoloaderFactory expects an associative array or Traversable object. Keys should be valid autoloader class names, and the values should be the options that should be passed to the class constructor. Internally, the AutoloaderFactory checks to see if the autoloader class referenced exists. If not, it will use the StandardAutoloader to attempt to load the class via the include_path (or, in the case of Zendnamespaced classes, using the Zend Framework library path). If the class is not found, or does not implement the SplAutoloader interface, an exception will be raised.
getRegisteredAutoloaders() This method is static, and may be used to retrieve a list of all autoloaders registered via the factory() method. It returns simply an array of autoloader instances. getRegisteredAutoloader Retrieve an autoloader by class name getRegisteredAutoloader($class) getRegisteredAutoloader() This method is static, and is used to retrieve a specic autoloader. It expects a string with the autoloader class name. If the autoloader is not registered, an exception will be thrown. unregisterAutoloaders Unregister all autoloaders registered via the factory. unregisterAutoloaders() unregisterAutoloaders() This method is static, and can be used to unregister all autoloaders that were registered via the factory. Note that this will not unregister autoloaders that were registered outside of the factory. unregisterAutoloader Unregister an autoloader registered via the factory. unregisterAutoloader($class) unregisterAutoloader() This method is static, and can be used to unregister an autoloader that was registered via the factory. Note that this will not unregister autoloaders that were registered outside of the factory. If the autoloader is registered via the factory, after unregistering it will return TRUE, otherwise FALSE.
159.5 Examples
Please see the Quick Start for a detailed example.
752
CHAPTER 160
The StandardAutoloader
160.1 Overview
Zend\Loader\StandardAutoloader is designed as a PSR-0-compliant autoloader. It assumes a 1:1 mapping of the namespace+classname to the lesystem, wherein namespace separators and underscores are translated to directory separators. A simple statement that illustrates how resolution works is as follows:
1 2
Previous incarnations of PSR-0-compliant autoloaders in Zend Framework have relied upon the include_path for le lookups. This has led to a number of issues: Due to the use of include, if the le is not found, a warning is raised even if another autoloader is capable of resolving the class later. Documenting how to setup the include_path has proven to be a difcult concept to convey. If multiple Zend Framework installations exist on the include_path, the rst one on the path wins even if that was not the one the developer intended. To solve these problems, the StandardAutoloader by default requires that you explicitly register namespace/path pairs (or vendor prex/path pairs), and will only load a le if it exists within the given path. Multiple pairs may be provided. As a measure of last resort, you may also use the StandardAutoloader as a fallback autoloader one that will look for classes of any namespace or vendor prex on the include_path. This practice is not recommended, however, due to performance implications. Finally, as with all autoloaders in Zend Framework, the StandardAutoloader is capable of registering itself with PHPs SPL autoloader registry. Note: Vocabulary: Namespaces vs. Vendor Prexes In terms of autloading, a namespace corresponds to PHPs own denition of namespaces in PHP versions 5.3 and above. A vendor prex refers to the practice, popularized in PHP versions prior to 5.3, of providing a pseudo-namespace in the form of underscore-separated words in class names. As an example, the class Phly_Couch_Document uses a vendor prex of Phly, and a component prex of Phly_Couch but it is a class sitting in the global namespace within PHP 5.3. 753
The StandardAutoloader is capable of loading either namespaced or vendor prexed class names, but treats them separately when attempting to match them to an appropriate path.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
Conguration at Instantiation
The StandardAutoloader may also be congured at instantiation. Please note: The argument passed may be either an array or a Traversable object. The argument passed is also a valid argument for passing to the setOptions() method. The following is equivalent to the previous example.
1 2 3 4 5 6 7 8 9 10 11
require_once Zend/Loader/StandardAutoloader.php; $loader = new Zend\Loader\StandardAutoloader(array( autoregister_zf => true, namespaces => array( Phly => APPLICATION_PATH . /../library/Phly, ), prefixes => array( Scapi => APPLICATION_PATH . /../library/Scapi, ), fallback_autoloader => true, ));
754
12 13 14
namespaces An associative array of namespace/path pairs. The path should be an absolute path or path relative to the calling script, and contain only classes that live in that namespace (or its subnamespaces). By default, the Zend namespace is registered, pointing to the parent directory of the le dening the StandardAutoloader. prexes An associative array of vendor prex/path pairs. The path should be an absolute path or path relative to the calling script, and contain only classes that begin with the provided vendor prex. fallback_autoloader A boolean value indicating whether or not this instance should act as a fallback autoloader (i.e., look for classes of any namespace or vendor prex on the include_path). By default, false. autoregister_zf An boolean value indicating that the class should register the Zend namespace to the directory above where its own classle is located on the lesystem.
755
registerNamespaces Register multiple namespaces with the autoloader registerNamespaces($namespaces) registerNamespaces() Accepts either an array or Traversable object. It will then iterate through the argument, and pass each item to registerNamespace(). registerPrex Register a vendor prex with the autoloader. registerPrefix($prefix, $directory) registerPrex() Register a vendor prex with the autoloader, pointing it to a specic directory on the lesystem for class resolution. For classes matching that initial vendor prex, the autoloader will then perform lookups within that directory. registerPrexes Register many vendor prexes with the autoloader registerPrefixes($prefixes) registerPrexes() Accepts either an array or Traversable object. It will then iterate through the argument, and pass each item to registerPrex(). autoload Attempt to load a class. autoload($class) autoload() Attempts to load the class specied. Returns a boolean false on failure, or a string indicating the class loaded on success. register Register with spl_autoload. register() register() Registers the autoload() method of the current instance with spl_autoload_register().
160.5 Examples
Please review the examples in the quick start for usage.
756
CHAPTER 161
The ClassMapAutoloader
161.1 Overview
The ClassMapAutoloader is designed with performance in mind. The idea behind it is simple: when asked to load a class, see if its in the map, and, if so, load the le associated with the class in the map. This avoids unnecessary lesystem operations, and can also ensure the autoloader plays nice with opcode caches and PHPs realpath cache. Zend Framework provides a tool for generating these class maps; you can nd it in bin/classmap_generator.php of the distribution. Full documentation of this is provided in the Class Map generator section.
This will create a le named Some/Directory/autoload_classmap.php, which is a PHP le returning an associative array that represents the class map. Within your code, you will now instantiate the ClassMapAutoloader, and provide it the location of the map.
1 2 3 4 5 6 7 8 9 10 11
// This example assumes ZF is on your include_path. // You could also load the autoloader class from a path relative to the // current script, or via an absolute path. require_once Zend/Loader/ClassMapAutoloader.php; $loader = new Zend\Loader\ClassMapAutoloader(); // Register the class map: $loader->registerAutoloadMap(Some/Directory/autoload_classmap.php); // Register with spl_autoload: $loader->register();
At this point, you may now use any classes referenced in your class map.
757
$options The ClassMapAutoloader expects an array of options, where each option is either a lename referencing a class map, or an associative array of class name/lename pairs. As an example:
1 2 3 4 5 6 7 8
// Configuration defining both a file-based class map, and an array map $config = array( __DIR__ . /library/autoloader_classmap.php, // file-based class map array( // array class map Application\Bootstrap => __DIR__ . /application/Bootstrap.php, Test\Bootstrap => __DIR__ . /tests/Bootstrap.php, ), );
758
161.5 Examples
Using conguration to seed ClassMapAutoloader
Often, you will want to congure your ClassMapAutoloader. These values may come from a conguration le, a cache (such as ShMem or memcached), or a simple PHP array. The following is an example of a PHP array that could be used to congure the autoloader:
1 2 3 4 5 6 7 8
// Configuration defining both a file-based class map, and an array map $config = array( APPLICATION_PATH . /../library/autoloader_classmap.php, // file-based class map array( // array class map Application\Bootstrap => APPLICATION_PATH . /Bootstrap.php, Test\Bootstrap => APPLICATION_PATH . /../tests/Bootstrap.php, ), );
Once you have your conguration, you can pass it either to the constructor of the ClassMapAutoloader, to its setOptions() method, or to registerAutoloadMaps().
1 2 3 4 5 6 7 8 9 10 11 12
/* The following are all equivalent */ // To the constructor: $loader = new Zend\Loader\ClassMapAutoloader($config); // To setOptions(): $loader = new Zend\Loader\ClassMapAutoloader(); $loader->setOptions($config); // To registerAutoloadMaps(): $loader = new Zend\Loader\ClassMapAutoloader(); $loader->registerAutoloadMaps($config);
161.5. Examples
759
760
CHAPTER 162
The ModuleAutoloader
162.1 Overview
Zend\Loader\ModuleAutoloader is a special implementation of the Zend\Loader\SplAutoloader interface, used by Zend\ModuleManager to autoload Module classes from different sources. Apart from being able to autoload modules from directories, the ModuleAutoloader can also autoload modules packaged as Phar archives, which allows for packaging your modules in a single le for easier distribution. Supported archive formats are: .phar, .phar.gz, .phar.bz2, .phar.tar, .phar.tar.gz, .phar.tar.bz2, .phar.zip, .tar, tar.gz, .tar.bz2 and .zip. It is, however, recommended to avoid compressing your packages (be it either gz, bz2 or zip compression), as it introduces additional CPU overhead to every request.
162.2 Quickstart
As the ModuleAutoloader is meant to be used with the ModuleManager, for examples of its usage and how to congure it, please see the Module Autoloader Usage section of the ModuleManager documentation.
$options The ModuleAutoloader expects an array of options, where each option is either a path to scan for modules, or a key/value pair of explicit module paths. In the case of explicit module paths, the key is the modules name, and the value is the path to that module.
1 2 3 4 5
761
registerPaths Register multiple paths with the autoloader. registerPaths($paths) registerPaths() Register a paths to modules. Expects an array or Traversable object. For an example array, please see the Conguration options section. registerPath Register a single path with the autoloader. registerPath($path, $moduleName=false) registerPath() Register a single path with the autoloader. The rst parameter, $path, is expected to be a string. The second parameter, $moduleName, is expected to be a module name, which allows for registering an explicit path to that module. getPaths Get all paths registered with the autoloader. getPaths() getPaths() Returns an array of all the paths registered with the current instance of the autoloader.
162.5 Examples
Please review the examples in the quick start for usage.
762
CHAPTER 163
163.1 Overview
While any valid PHP callback may be registered with spl_autoload_register(), Zend Framework autoloaders often provide more exibility by being stateful and allowing conguration. To provide a common interface, Zend Framework provides the SplAutoloader interface. Objects implementing this interface provide a standard mechanism for conguration, a method that may be invoked to attempt to load a class, and a method for registering with the SPL autoloading mechanism.
namespace Custom; use Zend\Loader\SplAutoloader; class ModifiedIncludePathAutoloader implements SplAutoloader { protected $paths = array(); public function __construct($options = null) { if (null !== $options) { $this->setOptions($options); } } public function setOptions($options) { if (!is_array($options) && !($options instanceof \Traversable)) { throw new \InvalidArgumentException(); }
763
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
foreach ($options as $path) { if (!in_array($path, $this->paths)) { $this->paths[] = $path; } } return $this; } public function autoload($classname) { $filename = $classname . .php; foreach ($this->paths as $path) { $test = $path . DIRECTORY_SEPARATOR . $filename; if (file_exists($test)) { return include($test); } } return false; } public function register() { spl_autoload_register(array($this, autoload)); } }
register Register the autoloader with the SPL autoloader register() register() Should be used to register the autoloader instance with spl_autoload_register(). Invariably, the method should look like the following:
1 2 3 4
163.5 Examples
Please see the Quick Start for a complete example.
163.5. Examples
765
766
CHAPTER 164
The PluginClassLoader
164.1 Overview
Resolving plugin names to class names is a common requirement within Zend Framework applications. The PluginClassLoader implements the interfaces PluginClassLocator, ShortNameLocator, and IteratorAggregate, providing a simple mechanism for aliasing plugin names to classnames for later retrieval. While it can act as a standalone class, it is intended that developers will extend the class to provide a per-component plugin map. This allows seeding the map with the most often-used plugins, while simultaneously allowing the end-user to overwrite existing or register new plugins. Additionally, PluginClassLoader provides the ability to statically seed all new instances of a given PluginClassLoader or one of its extensions (via Late Static Binding). If your application will always call for dening or overriding particular plugin maps on given PluginClassLoader extensions, this is a powerful capability.
use Zend\Http\HeaderLoader; // Provide a global map, or override defaults: HeaderLoader::addStaticMap(array( xrequestedfor => My\Http\Header\XRequestedFor, )); // Instantiate the loader: $loader = new Zend\Http\HeaderLoader(); // Register a new plugin: $loader->registerPlugin(xForwardedFor, My\Http\Header\XForwardedFor); // Load/retrieve the associated plugin class: $class = $loader->load(xrequestedfor); // My\Http\Header\XRequestedFor
767
Note: Case Sensitivity The PluginClassLoader is designed to do case-insensitive plugin name lookups. While the above example denes a xForwardedFor plugin name, internally, this will be stored as simply xforwardedfor. If another plugin is registered with simply a different word case, it will overwrite this entry.
$map The constructor may take a single option, an array or Traversable object of key/value pairs corresponding to a plugin name and class name, respectively.
getRegisteredPlugins Return the complete plugin class map getRegisteredPlugins() getRegisteredPlugins() Dened by the PluginClassLocator interface; return the entire plugin class map as an array. isLoaded Determine if a given plugin name resolves isLoaded($name) isLoaded() Dened by the ShortNameLocator interface; determine if the given plugin has been resolved to a class name. getClassName Return the class name to which a plugin resolves getClassName($name) getClassName() Dened by the ShortNameLocator interface; return the class name to which a plugin name resolves. load Resolve a plugin name load($name) load() Dened by the ShortNameLocator interface; attempt to resolve a plugin name to a class name. If successful, returns the class name; otherwise, returns a boolean false. getIterator Return iterator capable of looping over plugin class map getIterator() getIterator() Dened by the IteratorAggregate interface; allows iteration over the plugin class map. This can come in useful for using PluginClassLoader instances to other PluginClassLoader instances in order to merge maps.
164.5 Examples
Using Static Maps
Its often convenient to provide global overrides or additions to the maps in a PluginClassLoader instance. This can be done using the addStaticMap() method:
1 2 3 4 5
Any later instances created will now have this map dened, allowing you to load that plugin.
1 2 3 4
In many cases, you know exactly which plugins you may be drawing upon on a regular basis, and which classes they will refer to. In this case, simply extend the PluginClassLoader and dene the map within the extending class.
1 2 3 4 5 6
164.5. Examples
769
7 8 9 10 11 12 13 14 15
/** * @var array Plugin map */ protected $plugins = array( foo => My\Plugins\Foo, bar => My\Plugins\Bar, foobar => My\Plugins\FooBar, ); }
At this point, you can simply instantiate the map and use it.
1 2
PluginClassLoader makes use of late static binding, allowing per-class static maps. If you want to allow dening a static map specic to this extending class, simply declare a protected static $staticMap property:
1 2 3 4 5 6 7 8 9 10
namespace My\Plugins; use Zend\Loader\PluginClassLoader; class PluginLoader extends PluginClassLoader { protected static $staticMap = array(); // ... }
To inject the static map, use the extending class name to call the static addStaticMap() method.
1 2 3
In some cases, a general map class may already exist; as an example, most components in Zend Framework that utilize a plugin broker have an associated PluginClassLoader extension dening the plugins available for that component within the framework. What if you want to dene some additions to these? Where should that code go? One possibility is to dene the map in a conguration le, and then inject the conguration into an instance of the plugin loader. This is certainly trivial to implement, but removes the code dening the plugin map from the library. An alternate solution is to dene a new plugin map class. The class name or an instance of the class may then be passed to the constructor or registerPlugins().
1 2 3 4 5 6 7 8 9 10 11
namespace My\Plugins; use Zend\Loader\PluginClassLoader; use Zend\Http\HeaderLoader; class PluginLoader extends PluginClassLoader { /** * @var array Plugin map */ protected $plugins = array(
770
12 13 14 15 16 17 18 19 20 21 22 23 24
foo => My\Plugins\Foo, bar => My\Plugins\Bar, foobar => My\Plugins\FooBar, ); } // Inject in constructor: $loader = new HeaderLoader(My\Plugins\PluginLoader); $loader = new HeaderLoader(new PluginLoader()); // Or via registerPlugins(): $loader->registerPlugins(My\Plugins\PluginLoader); $loader->registerPlugins(new PluginLoader());
164.5. Examples
771
772
CHAPTER 165
165.1 Overview
Within Zend Framework applications, its often expedient to provide a mechanism for using class aliases instead of full class names to load adapters and plugins, or to allow using aliases for the purposes of slipstreaming alternate implementations into the framework. In the rst case, consider the adapter pattern. Its often unwieldy to utilize a full class name (e.g., Zend\Cloud\DocumentService\Adapter\SimpleDb); using the short name of the adapter, SimpleDb, would be much simpler. In the second case, consider the case of helpers. Let us assume we have a url helper; you may nd that while the shipped helper does 90% of what you need, youd like to extend it or provide an alternate implementation. At the same time, you dont want to change your code to reect the new helper. In this case, a short name allows you to alias an alternate class to utilize. Classes implementing the ShortNameLocator interface provide a mechanism for resolving a short name to a fully qualied class name; how they do so is left to the implementers, and may combine strategies dened by other interfaces, such as PluginClassLocator.
namespace Zend\Loader; interface ShortNameLocator { public function isLoaded($name); public function getClassName($name); public function load($name); }
773
165.5 Examples
Please see the Quick Start for the interface specication.
774
CHAPTER 166
166.1 Overview
The PluginClassLocator interface describes a component capable of maintaining an internal map of plugin names to actual class names. Classes implementing this interface can register and unregister plugin/class associations, and return the entire map.
namespace Zend\Loader; interface PluginClassLocator { public function registerPlugin($shortName, $className); public function unregisterPlugin($shortName); public function getRegisteredPlugins(); }
775
unregisterPlugin Remove a plugin/class name association unregisterPlugin($shortName) unregisterPlugin() Implement this to allow removing an existing plugin mapping corresponding to $shortName. getRegisteredPlugins Retrieve the map of plugin name/class name associations getRegisteredPlugins() getRegisteredPlugins() Implement this to allow returning the plugin name/class name map.
166.5 Examples
Please see the Quick Start for the interface specication.
776
CHAPTER 167
167.1 Overview
The script bin/classmap_generator.php can be used to generate class map les for use with the ClassMapAutoloader. Internally, it consumes both Zend\Console\Getopt (for parsing command-line options) and Zend\File\ClassFileLocator for recursively nding all PHP class les in a given tree.
help or -h Returns the usage message. If any other options are provided, they will be ignored. library or -l Expects a single argument, a string specifying the library directory to parse. If this option is not specied, it will assume the current working directory. output or -o Where to write the autoload class map le. If not provided, assumes autoload_classmap.php in the library directory. append or -a Append to autoload le if it exists. overwrite or -w If an autoload class map le already exists with the name as specied via the --output option, you can overwrite it by specifying this ag. Otherwise, the script will not write the class map and return a warning. 777
778
CHAPTER 168
Overview of Zend\Log
Zend\Log\Logger is a component for general purpose logging. It supports multiple log backends, formatting messages sent to the log, and ltering messages from being logged. These functions are divided into the following objects: A Logger (instance of Zend\Log\Logger) is the object that your application uses the most. You can have as many Logger objects as you like; they do not interact. A Logger object must contain at least one Writer, and can optionally contain one or more Filters. A Writer (inherits from Zend\Log\Writer\AbstractWriter) is responsible for saving data to storage. A Filter (implements Zend\Log\Filter\FilterInterface) blocks log data from being saved. A lter is applied to an individual writer. Filters can be chained. A Formatter (implements Zend\Log\Formatter\FormatterInterface) can format the log data before it is written by a Writer. Each Writer has exactly one Formatter.
It is important to note that the Logger must have at least one Writer. You can add any number of Writers using the Logs addWriter() method. You can also add a priority to each writer. The priority is specied as number and passed as second argument in the addWriter() method. Another way to add a writer to a Logger is to use the name of the writer as follow:
1 2 3
779
The rst parameter of the log() method is an integer priority and the second parameter is a string message. The priority must be one of the priorities recognized by the Logger instance. This is explained in the next section. There is also an optional third parameter used to pass extra informations to the writers log. A shortcut is also available. Instead of calling the log() method, you can call a method by the same name as the priority:
1 2 3 4 5
$logger->log(Zend\Log\Logger::INFO, Informational message); $logger->info(Informational message); $logger->log(Zend\Log\Logger::EMERG, Emergency message); $logger->emerg(Emergency message);
$logger = null;
Explicitly destroying the log in this way is optional and is performed automatically at PHP shutdown.
= = = = = = = =
0; 1; 2; 3; 4; 5; 6; 7;
// // // // // // // //
Emergency: system is unusable Alert: action must be taken immediately Critical: critical conditions Error: error conditions Warning: warning conditions Notice: normal but significant condition Informational: informational messages Debug: debug messages
These priorities are always available, and a convenience method of the same name is available for each one. The priorities are not arbitrary. They come from the BSD syslog protocol, which is described in RFC-3164. The names and corresponding priority numbers are also compatible with another PHP logging system, PEAR Log, which perhaps promotes interoperability between it and Zend\Log\Logger. Priority numbers descend in order of importance. EMERG (0) is the most important priority. DEBUG (7) is the least important priority of the built-in priorities. You may dene priorities of lower importance than DEBUG. When selecting the priority for your log message, be aware of this priority hierarchy and choose appropriately.
780
If you want to unregister the error handler you can use the unregisterErrorHandler() static method. Table 168.1: Zend\Log\Logger events from PHP errors elds matching handler ( int $errno , string $errstr [, string $errle [, int $errline [, array $errcontext ]]] ) from set_error_handler Name Error Handler Parameter mes- errstr sage ererrno rno le errle line errline con- errcontext text Description
Contains the error message, as a string. Contains the level of the error raised, as an integer. Contains the lename that the error was raised in, as a string. Contains the line number the error was raised at, as an integer. (optional) An array that points to the active symbol table at the point the error occurred. In other words, errcontext will contain an array of every variable that existed in the scope the error was triggered in. User error handler must not modify error context. intercept Exceptions using the static method
781
782
CHAPTER 169
Writers
A Writer is an object that inherits from Zend\Log\Writer\AbstractWriter. A Writers responsibility is to record log data to a storage backend.
By default, the stream opens in the append mode (a). To open it with a different mode, the Zend\Log\Writer\Stream constructor accepts an optional second parameter for the mode. The constructor of Zend\Log\Writer\Stream also accepts an existing stream resource:
1 2 3 4 5 6 7 8 9 10
$stream = @fopen(/path/to/logfile, a, false); if (! $stream) { throw new Exception(Failed to open stream); } $writer = new Zend\Log\Writer\Stream($stream); $logger = new Zend\Log\Logger(); $logger->addWriter($writer); $logger->info(Informational message);
783
You cannot specify the mode for existing stream resources. Doing so causes a Zend\Log\Exception to be thrown.
$dbconfig = array( // Sqlite Configuration driver => Pdo, dsn => sqlite: . __DIR__ . /tmp/sqlite.db, ); $db = new Zend\Db\Adapter\Adapter($dbconfig); $writer = new Zend\Log\Writer\Db($db, log_table_name); $logger = new Zend\Log\Logger(); $logger->addWriter($writer); $logger->info(Informational message);
The example above writes a single row of log data to the database table named log_table_name table. The database column will be created according to the event array generated by the Zend\Log\Logger instance. If we specify the mapping of the events with the database columns the log will store in the database only the selected elds.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
$dbconfig = array( // Sqlite Configuration driver => Pdo, dsn => sqlite: . __DIR__ . /tmp/sqlite.db, ); $db = new Zend\Db\Adapter\Adapter($dbconfig); $mapping = array( timestamp => date, priority => type, message => event ); $writer = new Zend\Log\Writer\Db($db, log_table_name, $mapping); $logger = new Zend\Log\Logger(); $logger->addWriter($writer); $logger->info(Informational message);
The previous example will store only the log information timestamp, priority and message in the database elds date, type and event. The Zend\Log\Writer\Db has a fourth optional parameter in the constructor. This parameter is the character separator for the log events managed by an array. For instance, if we have a log that contains an array extra elds, this will be translated in extra-eld, where - is the character separator (default) and eld is the subname of the specic extra eld.
784
$writer = new Zend\Log\Writer\Null; $logger = new Zend\Log\Logger(); $logger->addWriter($writer); // goes nowhere $logger->info(Informational message);
$mock = new Zend\Log\Writer\Mock; $logger = new Zend\Log\Logger(); $logger->addWriter($mock); $logger->info(Informational message); var_dump($mock->events[0]); // Array // ( // [timestamp] => 2007-04-06T07:16:37-07:00 // [message] => Informational message // [priority] => 6 // [priorityName] => INFO // )
To clear the events logged by the mock, simply set $mock->events = array().
785
4 5 6 7 8 9
$logger = new Zend\Log\Logger(); $logger->addWriter($writer1); $logger->addWriter($writer2); // goes to both writers $logger->info(Informational message);
You can also specify the priority number for each writer to change the order of writing. The priority number is an integer number (greater or equal to 1) passed as second parameter in the addWriter() method.
786
CHAPTER 170
Filters
A Filter object blocks a message from being written to the log. You can add a lter to a specic Writer using addFilter() method of that Writer:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
use Zend\Log\Logger; $logger = new Logger(); $writer1 = new Zend\Log\Writer\Stream(/path/to/first/logfile); $logger->addWriter($writer1); $writer2 = new Zend\Log\Writer\Stream(/path/to/second/logfile); $logger->addWriter($writer2); // add a filter only to writer2 $filter = new Zend\Log\Filter\Priority(Logger::CRIT); $writer2->addFilter($filter); // logged to writer1, blocked from writer2 $logger->info(Informational message); // logged by both writers $logger->emerg(Emergency message);
787
788
CHAPTER 171
Formatters
A Formatter is an object that is responsible for taking an event array describing a log event and outputting a string with a formatted log line. Some Writers are not line-oriented and cannot use a Formatter. An example is the Database Writer, which inserts the event items directly into database columns. For Writers that cannot support a Formatter, an exception is thrown if you attempt to set a Formatter.
A formatter is set on an individual Writer object using the Writers setFormatter() method:
1 2 3 4 5 6 7 8 9 10
$writer = new Zend\Log\Writer\Stream(php://output); $formatter = new Zend\Log\Formatter\Simple(hello %message% . PHP_EOL); $writer->setFormatter($formatter); $logger = new Zend\Log\Logger(); $logger->addWriter($writer); $logger->info(there); // outputs "hello there"
The constructor of Zend\Log\Formatter\Simple accepts a single parameter: the format string. This string contains keys surrounded by percent signs (e.g. %message%). The format string may contain any key from the event data array. You can retrieve the default keys by using the DEFAULT_FORMAT constant from Zend\Log\Formatter\Simple.
789
$writer = new Zend\Log\Writer\Stream(php://output); $formatter = new Zend\Log\Formatter\Xml(); $writer->setFormatter($formatter); $logger = new Zend\Log\Logger(); $logger->addWriter($writer); $logger->info(informational message);
The code above outputs the following XML (space added for clarity):
1 2 3 4 5 6
Its possible to customize the root element as well as specify a mapping of XML elements to the items in the event data array. The constructor of Zend\Log\Formatter\Xml accepts a string with the name of the root element as the rst parameter and an associative array with the element mapping as the second parameter:
1 2 3 4 5 6 7 8 9 10 11
$writer = new Zend\Log\Writer\Stream(php://output); $formatter = new Zend\Log\Formatter\Xml(log, array(msg => message, level => priorityName) ); $writer->setFormatter($formatter); $logger = new Zend\Log\Logger(); $logger->addWriter($writer); $logger->info(informational message);
The code above changes the root element from its default of logEntry to log. It also maps the element msg to the event data item message. This results in the following output:
1 2 3 4
790
CHAPTER 172
Introduction to Zend\Mail
A simple email consists of one or more recipients, a subject, a body and a sender. To send such a mail using Zend\Mail\Transport\Sendmail, do the following:
1 2 3 4 5 6 7 8 9 10
use Zend\Mail; $mail = new Mail\Message(); $mail->setBody(This is the text of the email.); $mail->setFrom(Freeaqingme@example.org, Sender\s name); $mail->addTo(Matthew@example.com, Name o. recipient); $mail->setSubject(TestSubject); $transport = new Mail\Transport\Sendmail(); $transport->send($mail);
Note: Minimum denitions In order to send an email using Zend\Mail you have to specify at least one recipient as well as a message body. Please note that each Transport may require additional parameters to be set. For most mail attributes there are get methods to read the information stored in the message object. for further details, please refer to the API documentation. You also can use most methods of the Mail\Message object with a convenient uent interface.
1 2 3
791
4 5 6 7
$mail->setBody(This is the text of the mail.) ->setFrom(somebody@example.com, Some Sender) ->addTo(somebody_else@example.com, Some Recipient) ->setSubject(TestSubject);
This example shows how to change the Return-Path of the mail() function.
1 2 3 4 5 6 7 8 9 10
use Zend\Mail; $mail = new Mail\Message(); $mail->setBody(This is the text of the email.); $mail->setFrom(Freeaqingme@example.org, Dolf); $mail->addTo(matthew@example.com, Matthew); $mail->setSubject(TestSubject); $transport = new Mail\Transport\Sendmail(-freturn_to_me@example.com); $transport->send($mail);
Note: Safe mode restrictions Supplying additional parameters to the transport will cause the mail() function to fail if PHP is running in safe mode.
Note: Choosing your transport wisely Although the sendmail transport is the transport that requires only minimal conguration, it may not be suitable for your production environment. This is because emails sent using the sendmail transport will be more often delivered to SPAM-boxes. This can partly be remedied by using the SMTP Transport combined with an SMTP server that has an overall good reputation. Additionally, techniques such as SPF and DKIM may be employed to ensure even more email messages are delivered as should. Warning: Sendmail Transport and Windows As the PHP manual states the mail() function has different behaviour on Windows and on *nix based systems. Using the Sendmail Transport on Windows will not work in combination with addBcc(). The mail() function will sent to the BCC recipient such that all the other recipients can see him as recipient! Therefore if you want to use BCC on a windows server, use the SMTP transport for sending!
792
CHAPTER 173
Zend\Mail\Message
173.1 Overview
The Message class encapsulates a single email message as described in RFCs 822 and 2822. It acts basically as a value object for setting mail headers and content. If desired, multi-part email messages may also be created. This is as trivial as creating the message body using the Zend\Mime component, assigning it to the mail message body. The Message class is simply a value object. It is not capable of sending or storing itself; for those purposes, you will need to use, respectively, a Transport adapter or Storage adapter.
Once you have your Message instance, you can start adding content or headers. Lets set who the mail is from, who its addressed to, a subject, and some content:
1 2 3 4
$message->addFrom("matthew@zend.com", "Matthew Weier OPhinney") ->addTo("foobar@example.com") ->setSubject("Sending an email from Zend\Mail!"); $message->setBody("This is the message body.");
You can also add recipients to carbon-copy (Cc:) or blind carbon-copy (Bcc:).
1 2
$message->addCc("ralph.schindler@zend.com") ->addBcc("enrico.z@zend.com");
If you want to specify an alternate address to which replies may be sent, that can be done, too.
1
$message->addReplyTo("matthew@weierophinney.net", "Matthew");
Interestingly, RFC822 allows for multiple From: addresses. When you do this, the rst one will be used as the sender, unless you specify a Sender: header. The Message class allows for this. 793
1 2 3 4 5 6 7 8
/* * Mail headers created: * From: Ralph Schindler <ralph.schindler@zend.com>, Enrico Zimuel <enrico.z@zend.com> * Sender: Matthew Weier OPhinney <matthew@zend.com></matthew> */ $message->addFrom("ralph.schindler@zend.com", "Ralph Schindler") ->addFrom("enrico.z@zend.com", "Enrico Zimuel") ->setSender("matthew@zend.com", "Matthew Weier OPhinney");
By default, the Message class assumes ASCII encoding for your email. If you wish to use another encoding, you can do so; setting this will ensure all headers and body content are properly encoded using quoted-printable encoding.
1
$message->setEncoding("UTF-8");
Sometimes you may want to provide HTML content, or multi-part content. To do that, youll rst create a MIME message object, and then set it as the body of your mail message object. When you do so, the Message class will automatically set a MIME-Version header, as well as an appropriate Content-Type header.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
use Zend\Mail\Message; use Zend\Mime\Message as MimeMessage; use Zend\Mime\Part as MimePart; $text = new MimePart($textContent); $text->type = "text/plain"; $html = new MimePart($htmlMarkup); $html->type = "text/html"; $image = new MimePart(fopen($pathToImage, r)); $image->type = "image/jpeg"; $body = new MimeMessage(); $body->setParts(array($text, $html, $image)); $message = new Message(); $message->setBody($body);
If you want a string representation of your email, you can get that:
1
echo $message->toString();
Finally, you can fully introspect the message including getting all addresses of recipients and senders, all headers, and the message body.
1 2 3 4 5 6 7
// Headers // Note: this will also grab all headers for which accessors/mutators exist in // the Message object itself. foreach ($message->getHeaders() as $header) { echo $header->toString(); // or grab values: $header->getFieldName(), $header->getFieldValue() }
794
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
// The logic below also works for the methods cc(), bcc(), to(), and replyTo() foreach ($message->from() as $address) { printf("%s: %s\n", $address->getEmail(), $address->getName()); } // Sender $address = $message->getSender(); printf("%s: %s\n", $address->getEmail(), $address->getName()); // Subject echo "Subject: ", $message->getSubject(), "\n"; // Encoding echo "Encoding: ", $message->getEncoding(), "\n"; // Message body: echo $message->getBody(); // raw body, or MIME object echo $message->getBodyText(); // body as it will be sent
Once your message is shaped to your liking, pass it to a mail transport in order to send it!
1
$transport->send($message);
795
Lazy-loads a Zend\Mail\Headers instance if none is already attached. Returns a Zend\Mail\Headers instance. setFrom setFrom(string|AddressDescription|array|Zend\Mail\AddressList|Traversable $emailOrAddressList, string|null $name) Set (overwrite) From addresses. Implements a uent interface. addFrom addFrom(string|Zend\Mail\Address|array|Zend\Mail\AddressList|Traversable $emailOrAddressOrList, string|null $name) Add a From address. Implements a uent interface. from from() Retrieve list of From senders Returns Zend\Mail\AddressList instance. setTo setTo(string|AddressDescription|array|Zend\Mail\AddressList|Traversable $emailOrAddressList, null|string $name) Overwrite the address list in the To recipients. Implements a uent interface. addTo addTo(string|AddressDescription|array|Zend\Mail\AddressList|Traversable $emailOrAddressOrList, null|string $name) Add one or more addresses to the To recipients. Appends to the list. Implements a uent interface. to to() Access the address list of the To header. Lazy-loads a Zend\Mail\AddressList and populates the To header if not previously done. Returns a Zend\Mail\AddressList instance. setCc setCc(string|AddressDescription|array|Zend\Mail\AddressList|Traversable $emailOrAddressList, string|null $name) Set (overwrite) CC addresses. Implements a uent interface. addCc addCc(string|Zend\Mail\Address|array|Zend\Mail\AddressList|Traversable $emailOrAddressOrList, string|null $name) Add a Cc address. Implements a uent interface. cc cc() Retrieve list of CC recipients Lazy-loads a Zend\Mail\AddressList and populates the Cc header if not previously done. Returns a Zend\Mail\AddressList instance.
796
setBcc setBcc(string|AddressDescription|array|Zend\Mail\AddressList|Traversable $emailOrAddressList, string|null $name) Set (overwrite) BCC addresses. Implements a uent interface. addBcc addBcc(string|Zend\Mail\Address|array|Zend\Mail\AddressList|Traversable $emailOrAddressOrList, string|null $name) Add a Bcc address. Implements a uent interface. bcc bcc() Retrieve list of BCC recipients. Lazy-loads a Zend\Mail\AddressList and populates the Bcc header if not previously done. Returns a Zend\Mail\AddressList instance. setReplyTo setReplyTo(string|AddressDescription|array|Zend\Mail\AddressList|Traversable $emailOrAddressList, null|string $name) Overwrite the address list in the Reply-To recipients. Implements a uent interface. addReplyTo addReplyTo(string|AddressDescription|array|Zend\Mail\AddressList|Traversable $emailOrAddressOrList, null|string $name) Add one or more addresses to the Reply-To recipients. Implements a uent interface. replyTo replyTo() Access the address list of the Reply-To header Lazy-loads a Zend\Mail\AddressList and populates the Reply-To header if not previously done. Returns a Zend\Mail\AddressList instance. setSender setSender(mixed $emailOrAddress, mixed $name) Set the message envelope Sender header. Implements a uent interface. getSender getSender() Retrieve the sender address, if any. Returns null or a Zend\Mail\AddressDescription instance. setSubject setSubject(string $subject) Set the message subject header value. Implements a uent interface. getSubject getSubject() Get the message subject header value. Returns null or a string.
797
setBody setBody(null|string|Zend\Mime\Message|object $body) Set the message body. Implements a uent interface. getBody getBody() Return the currently set message body. Returns null, a string, or an object. getBodyText getBodyText() Get the string-serialized message body text. Returns null or a string. toString toString() Serialize to string. Returns string.
173.5 Examples
Please see the Quick Start section.
798
CHAPTER 174
Zend\Mail\Transport
174.1 Overview
Transports take care of the actual delivery of mail. Typically, you only need to worry about two possibilities: using PHPs native mail() functionality, which uses system resources to deliver mail, or using the SMTP protocol for delivering mail via a remote server. Zend Framework also includes a File transport, which creates a mail le for each message sent; these can later be introspected as logs or consumed for the purposes of sending via an alternate transport mechanism later. The Zend\Mail\Transport interface denes exactly one method, send(). This method accepts a Zend\Mail\Message instance, which it then introspects and serializes in order to send.
1 2 3 4 5 6 7 8 9 10 11
799
SMTP Transport Usage use Zend\Mail\Message; use Zend\Mail\Transport\Smtp as SmtpTransport; use Zend\Mail\Transport\SmtpOptions; $message = new Message(); $message->addTo(matthew@zend.com) ->addFrom(ralph.schindler@zend.com) ->setSubject(Greetings and Salutations!) ->setBody("Sorry, Im going to be late today!"); // Setup SMTP transport using LOGIN authentication $transport = new SmtpTransport(); $options = new SmtpOptions(array( name => localhost.localdomain, host => 127.0.0.1, connection_class => login, connection_config => array( username => user, password => pass, ), )); $transport->setOptions($options); $transport->send($message);
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
File Transport Usage use Zend\Mail\Message; use Zend\Mail\Transport\File as FileTransport; use Zend\Mail\Transport\FileOptions; $message = new Message(); $message->addTo(matthew@zend.com) ->addFrom(ralph.schindler@zend.com) ->setSubject(Greetings and Salutations!) ->setBody("Sorry, Im going to be late today!"); // Setup SMTP transport using LOGIN authentication $transport = new FileTransport(); $options = new FileOptions(array( path => data/mail/, callback => function (FileTransport $transport) { return Message_ . microtime(true) . _ . mt_rand() . .txt; }, )); $transport->setOptions($options); $transport->send($message);
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
800
174.5 Examples
Please see the Quick Start section for examples.
801
802
CHAPTER 175
Zend\Mail\Transport\SmtpOptions
175.1 Overview
This document details the various options available to the Zend\Mail\Transport\Smtp mail transport.
1 2 3 4 5 6 7 8 9 10 11
SMTP Transport Usage with PLAIN AUTH use Zend\Mail\Transport\Smtp as SmtpTransport; use Zend\Mail\Transport\SmtpOptions; // Setup SMTP transport using PLAIN authentication $transport = new SmtpTransport(); $options = new SmtpOptions(array( name => localhost.localdomain, host => 127.0.0.1, connection_class => plain, connection_config => array( username => user,
1 2 3 4 5 6 7 8 9 10 11
803
12 13 14 15
SMTP Transport Usage with LOGIN AUTH use Zend\Mail\Transport\Smtp as SmtpTransport; use Zend\Mail\Transport\SmtpOptions; // Setup SMTP transport using LOGIN authentication $transport = new SmtpTransport(); $options = new SmtpOptions(array( name => localhost.localdomain, host => 127.0.0.1, connection_class => login, connection_config => array( username => user, password => pass, ), )); $transport->setOptions($options);
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
SMTP Transport Usage with CRAM-MD5 AUTH use Zend\Mail\Transport\Smtp as SmtpTransport; use Zend\Mail\Transport\SmtpOptions; // Setup SMTP transport using CRAM-MD5 authentication $transport = new SmtpTransport(); $options = new SmtpOptions(array( name => localhost.localdomain, host => 127.0.0.1, connection_class => crammd5, connection_config => array( username => user, password => pass, ), )); $transport->setOptions($options);
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
SMTP Transport Usage with PLAIN AUTH over TLS use Zend\Mail\Transport\Smtp as SmtpTransport; use Zend\Mail\Transport\SmtpOptions; // Setup SMTP transport using PLAIN authentication over TLS $transport = new SmtpTransport(); $options = new SmtpOptions(array( name => example.com, host => 127.0.0.1, port => 587, // Notice port change for TLS is 587 connection_class => plain,
1 2 3 4 5 6 7 8 9 10
804
11 12 13 14 15 16 17
connection_config => array( username => user, password => pass, ssl => tls, ), )); $transport->setOptions($options);
name Name of the SMTP host; defaults to localhost. host Remote hostname or IP address; defaults to 127.0.0.1. port Port on which the remote host is listening; defaults to 25. connection_class Fully-qualied classname or short name resolvable via Zend\Mail\Protocol\SmtpLoader. Typically, this will be one of smtp, plain, login, or crammd5, and defaults to smtp. Typically, the connection class should extend the Zend\Mail\Protocol\AbstractProtocol class, and specically the SMTP variant. connection_cong Optional associative array of parameters to pass to the connection class in order to congure it. By default this is empty. For connection classes other than the default, you will typically need to dene the username and password options. For secure connections you will use the ssl => tls and port 587 for TLS or ssl => ssl and port 465 for SSL.
805
setConnectionCong setConnectionConfig(array $config) Set conguration for the connection class. Typically, if using anything other than the default connection class, this will be an associative array with the keys username and password. Implements a uent interface. getHost getHost() Returns a string indicating the IP address or host name of the SMTP server via which to send messages. setHost setHost(string $host) Set the SMTP host name or IP address. Implements a uent interface. getPort getPort() Retrieve the integer port on which the SMTP host is listening. setPort setPort(int $port) Set the port on which the SMTP host is listening. Implements a uent interface. __construct __construct(null|array|Traversable $config) Instantiate the class, and optionally congure it with values provided.
175.5 Examples
Please see the Quick Start for examples.
806
CHAPTER 176
Zend\Mail\Transport\FileOptions
176.1 Overview
This document details the various options available to the Zend\Mail\Transport\File mail transport.
1 2 3 4 5 6 7 8 9 10 11 12
path The path under which mail les will be written. callback A PHP callable to be invoked in order to generate a unique name for a message le. By default, the following is used:
1 2 3
807
176.5 Examples
Please see the Quick Start for examples.
808
CHAPTER 177
Introduction to Zend\Math
Zend\Math namespace provides general mathematical functions. So far the supported functionalities are: Zend\Math\Rand, a random number generator; Zend\Math\BigInteger, a library to manage big integers. We expect to add more functionalities in the future.
use Zend\Math\Rand; $bytes = Rand::getBytes(32, true); printf("Random bytes (in Base64): %s\n", base64_encode($bytes)); $boolean = Rand::getBoolean(); printf("Random boolean: %s\n", $boolean ? true : false); $integer = Rand::getInteger(0,1000); printf("Random integer in [0-1000]: %d\n", $integer); $float = Rand::getFloat(); printf("Random float in [0-1): %f\n", $float); $string = Rand::getString(32, abcdefghijklmnopqrstuvwxyz, true); printf("Random string in latin alphabet: %s\n", $string);
810
Below is reported an example using the BC Math adapter to calculate the sum of two integer random numbers with 100 digits.
1 2 3 4 5 6 7 8 9 10 11 12
use Zend\Math\BigInteger\BigInteger; use Zend\Math\Rand; $bigInt = BigInteger::factory(bcmath); $x = Rand::getString(100,0123456789); $y = Rand::getString(100,0123456789); $sum = $bigInt->add($x, $y); $len = strlen($sum); printf("%{$len}s +\n%{$len}s =\n%s\n%s\n", $x, $y, str_repeat(-, $len), $sum);
As you can see in the code the big integers are managed using strings. Even the result of the sum is represented as a string. Below is reported another example using the BC Math adapter to generate the binary representation of a negative big integer of 100 digits.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
use Zend\Math\BigInteger\BigInteger; use Zend\Math\Rand; $bigInt = BigInteger::factory(bcmath); $digit = 100; $x = - . Rand::getString($digit,0123456789); $byte = $bigInt->intToBin($x);
printf("The binary representation of the big integer with $digit digit:\n%s\nis (in Base64 format): % $x, base64_encode($byte)); printf("Length in bytes: %d\n", strlen($byte)); $byte = $bigInt->intToBin($x, true); printf("The twos complement binary representation of the big integer with $digit digit:\n%s\nis (in $x, base64_encode($byte)); printf("Length in bytes: %d\n", strlen($byte));
We generated the binary representation of the big integer number using the default binary format and the twos complement representation (specied with the true parameter in the intToBin function).
811
812
CHAPTER 178
Zend\Mime
178.1 Introduction
Zend\Mime\Mime is a support class for handling multipart MIME messages. Zend\Mime\Message and may be used by applications requiring MIME support. It is used by Zend\Mail and
813
814
CHAPTER 179
Zend\Mime\Message
179.1 Introduction
Zend\Mime\Message represents a MIME compliant message that can contain one or more separate Parts (Represented as Zend\Mime\Part objects). With Zend\Mime\Message, MIME compliant multipart messages can be generated from Zend\Mime\Part objects. Encoding and Boundary handling are handled transparently by the class. Zend\Mime\Message objects can also be reconstructed from given strings. Used by Zend\Mail.
179.2 Instantiation
There is no explicit constructor for Zend\Mime\Message.
815
getMime() returns the instance of Zend\Mime\Mime that will be used to render the message when generateMessage() is called. generateMessage() renders the Zend\Mime\Message content to a string.
816
CHAPTER 180
Zend\Mime\Part
180.1 Introduction
This class represents a single part of a MIME message. It contains the actual content of the message part plus information about its encoding, content type and original lename. It provides a method for generating a string from the stored data. Zend\Mime\Part objects can be added to Zend\Mime\Message to assemble a complete multipart message.
180.2 Instantiation
Zend\Mime\Part is instantiated with a string that represents the content of the new part. The type is assumed to be OCTET-STREAM, encoding is 8Bit. After instantiating a Zend\Mime\Part, meta information can be set by accessing its attributes directly:
1 2 3 4 5 6 7 8 9 10
public public public public public public public public public public
$type = Zend\Mime\Mime::TYPE_OCTETSTREAM; $encoding = Zend\Mime\Mime::ENCODING_8BIT; $id; $disposition; $filename; $description; $charset; $boundary; $location; $language;
817
$id may be set to identify a content-id for inline images in a HTML mail. $filename contains the name the le will get when downloading it. $disposition denes if the le should be treated as an attachment or if it is used inside the (HTML-) mail (inline). $description is only used for informational purposes. $boundary denes string as boundary. $location can be used as resource URI that has relation to the content. $language denes languages in the content.
getRawContent: Get the raw, unencoded for the current Zend\Mime\Part. getHeadersArray($EOL=Zend\Mime\Mime::LINEEND): Create and return the array of headers for the current Zend\Mime\Part. getHeaders($EOL=Zend\Mime\Mime::LINEEND): Zend\Mime\Part as a string. Return the headers for the current
818
CHAPTER 181
Zend Framework 2.0 introduces a new and powerful approach to modules. This new module system is designed with exibility, simplicity, and re-usability in mind. A module may contain just about anything: PHP code, including MVC functionality; library code; view scripts; and/or public assets such as images, CSS, and JavaScript. The possibilities are endless. Note: The module system in ZF2 has been designed to be a generic and powerful foundation from which developers and other projects can build their own module or plugin systems. For a better understanding of the event-driven concepts behind the ZF2 module system, it may be helpful to read the EventManager documentation. The module system is made up of the following: The Module Autoloader - Zend\Loader\ModuleAutoloader is a specialized autoloader that is responsible for the locating and loading of modules Module classes from a variety of sources. The Module Manager - Zend\ModuleManager\ModuleManager simply takes an array of module names and res a sequence of events for each one, allowing the behavior of the module system to be dened entirely by the listeners which are attached to the module manager. ModuleManager Listeners - Event listeners can be attached to the module managers various events. These listeners can do everything from resolving and loading modules to performing complex initialization tasks and introspection into each returned module object. Note: The name of a module in a typical Zend Framework 2 application is simply a PHP namespace and must follow all of the same rules for naming. The recommended structure of a typical MVC-oriented ZF2 module is as follows:
module_root/ Module.php autoload_classmap.php autoload_function.php autoload_register.php config/ module.config.php public/ images/
819
css/ js/ src/ <module_namespace>/ <code files> test/ phpunit.xml bootstrap.php <module_namespace>/ <test code files> view/ <dir-named-after-module-namespace>/ <dir-named-after-a-controller>/ <.phtml files>
The purpose of these three les is to provide reasonable default mechanisms for autoloading the classes contained in the module, thus providing a trivial way to consume the module without requiring Zend\ModuleManager (e.g., for use outside a ZF2 application).
820
CHAPTER 182
The module manager, Zend\ModuleManager\ModuleManager, is a very simple class which is responsible for iterating over an array of module names and triggering a sequence of events for each. Instantiation of module classes, initialization tasks, and conguration are all performed by attached event listeners.
loadModules This event is primarily used internally to help encapsulate the work of loading modules in event listeners, and allow the loadModules.post event to be more user-friendly. Internal listeners will attach to this event with a negative priority instead of loadModules.post so that users can safely assume things like cong merging have been done once loadModules.post is triggered, without having to worry about priorities at all. loadModule.resolve Triggered for each module that is to be loaded. The listener(s) to this event are responsible for taking a module name and resolving it to an instance of some class. The default module resolver shipped with ZF2 simply looks for the class {modulename}\Module, instantiating and returning it if it exists. The name of the module may be retrieved by listeners using the getModuleName() method of the Event object; a listener should then take that name and resolve it to an object instance representing the given module. Multiple listeners can be attached to this event, and the module manager will trigger them in order of their priority until one returns an object. This allows you to attach additional listeners which have alternative methods of resolving modules from a given module name. loadModule Once a module resolver listener has resolved the module name to an object, the module manager then triggers this event, passing the newly created object to all listeners. loadModules.post This event is triggered by the module manager to allow any listeners to perform work after every module has nished loading. For example, the default conguration listener, Zend\ModuleManager\Listener\ConfigListener (covered later), attaches to this event to merge additional user-supplied conguration which is meant to override the default supplied congurations of installed modules.
Zend\ModuleManager\Listener\DefaultListenerAggregate To help simplify the most common use case of the module manager, ZF2 provides this default aggregate listener. In most cases, this will be the only listener you will need to attach to use the module manager, as it will take care of properly attaching the requisite listeners (those listed below) for the module system to function properly. Zend\ModuleManager\Listener\AutoloaderListener This listener checks each module to see if it has implemented Zend\ModuleManager\Feature\AutoloaderProviderInterface or simply dened the getAutoloaderConfig() method. If so, it calls the getAutoloaderConfig() method on the module class and passes the returned array to Zend\Loader\AutoloaderFactory. Zend\ModuleManager\Listener\ModuleDependencyCheckerListener This listener checks each module to verify if all the modules it depends on were loaded. When a module class implements Zend\ModuleManager\Feature\DependencyIndicatorInterface or simply has a dened getDependencyModules() method, the listener will call getDependencyModules(). Each of the values returned by the method is checked against the loaded modules list: if one of the values is not in that list, a Zend\ModuleManager\Exception\MissingDependencyModuleException is be thrown. Zend\ModuleManager\Listener\CongListener If a module class has a getConfig() method, or implements Zend\ModuleManager\Feature\ConfigProviderInterface, this listener will call it and merge the returned array (or Traversable object) into the main application conguration. Zend\ModuleManager\Listener\InitTrigger If a module class either implements Zend\ModuleManager\Feature\InitProviderInterface, or simply denes an init() method, this listener will call init() and pass the current instance of Zend\ModuleManager\ModuleManager as the sole parameter. Like the OnBootstrapListener, the init() method is called for every module implementing this feature, on every page request and should only be used for performing lightweight tasks such as registering event listeners. Zend\ModuleManager\Listener\LocatorRegistrationListener If a module class implements Zend\ModuleManager\Feature\LocatorRegisteredInterface, this listener will inject the module class instance into the ServiceManager using the module class name as the service name. This allows you to later retrieve the module class from the ServiceManager. Zend\ModuleManager\Listener\ModuleResolverListener This is the default module resolver. It attaches to the loadModule.resolve event and simply returns an instance of {moduleName}\Module. Zend\ModuleManager\Listener\OnBootstrapListener If a module class implements Zend\ModuleManager\Feature\BootstrapListenerInterface, or simply denes an onBootstrap() method, this listener will register the onBootstrap() method with the Zend\Mvc\Application bootstrap event. This method will then be triggered during the bootstrap event (and passed an MvcEvent instance). Like the InitTrigger, the onBootstrap() method is called for every module implementing this feature, on every page request, and should only be used for performing lightweight tasks such as registering event listeners. Zend\ModuleManager\Listener\ServiceListener If a module class implements Zend\ModuleManager\Feature\ServiceProviderInterface, or simply denes an getServiceConfig() method, this listener will call that method and aggregate the return values for use in conguring the ServiceManager. The getServiceConfig() method may return either an array of conguration compatible with Zend\ServiceManager\Config, an instance of that class, or the string name of a class that extends it. Values are merged and aggregated on completion, and then merged with any conguration
822
from the ConfigListener falling under the service_manager key. For more information, see the ServiceManager documentation. Unlike the other listeners, this listener is not managed by the DefaultListenerAggregate; instead, it is created and instantiated within the Zend\Mvc\Service\ModuleManagerFactory, where it is injected with the current ServiceManager instance before being registered with the ModuleManager events. Additionally, this listener manages a variety of plugin managers, including view helpers, controllers, and controller plugins. In each case, you may either specify conguration to dene plugins, or provide conguration via a Module class. Conguration follows the same format as for the ServiceManager. The following table outlines the plugin managers that may be congured this way (including the ServiceManager), the conguration key to use, the ModuleManager feature interface to optionally implement (all interfaces specied live in the Zend\ModuleManager\Feature namespace) , and the module method to optionally dene to provide conguration. Plugin Manager Cong Key Interface Module Method Zend\Mvc\Controller\ControllerManager controllers ControllerProviderInterface getControllerConfig Zend\Mvc\Controller\PluginManager controller_plugins ControllerPluginProviderInterface getControllerPluginConfig Zend\Filter\FilterPluginManager filters FilterProviderInterface getFilterConfig Zend\Form\FormElementManager form_elements FormElementProviderInterface getFormElementConfig Zend\Stdlib\Hydrator\HydratorPluginManager hydrators HydratorProviderInterface getHydratorConfig Zend\InputFilter\InputFilterPluginManager input_filters InputFilterProviderInterface getInputFilterConfig Zend\Mvc\Router\RoutePluginManager route_manager RouteProviderInterface getRouteConfig Zend\Serializer\AdapterPluginManager serializers SerializerProviderInterface getSerializerConfig Zend\ServiceManager\ServiceManager service_manager ServiceProviderInterface getServiceConfig Zend\Validator\ValidatorPluginManager validators ValidatorProviderInterface getValidatorConfig Zend\View\HelperPluginManager view_helpersViewHelperProviderInterface getViewHelperConfig Conguration follows the examples in the ServiceManager conguration section. As a brief recap, the following conguration keys and values are allowed: Cong Key services invokables Allowed values service name/instance pairs (these should likely be dened only in Module classes) service name/class name pairs of classes that may be invoked without constructor arguments factories service names pointing to factories. Factories may be any PHP callable, or a string class name of a class implementing Zend\ServiceManager\FactoryInterface, or of a class implementing the __invoke method (if a callable is used, it should be dened only in Module classes) abstract_factories array of either concrete instances of Zend\ServiceManager\AbstractFactoryInterface, or string class names of classes implementing that interface (if an instance is used, it should be dened only in Module classes) initializersarray of PHP callables or string class names of classes implementing Zend\ServiceManager\InitializerInterface (if a callable is used, it should be dened only in Module classes) When working with plugin managers, you will be passed the plugin manager instance to factories, abstract factories, and initializers. If you need access to the application services, you can use the getServiceLocator() method, as in the following example:
1 2 3 4 5 6
public function getViewHelperConfig() { return array(factories => array( foo => function ($helpers) { $services = $helpers->getServiceLocator(); $someService = $services->get(SomeService);
823
7 8 9 10 11
This is a powerful technique, as it allows your various plugins to remain agnostic with regards to where and how dependencies are injected, and thus allows you to use Inversion of Control principals even with plugins.
824
CHAPTER 183
By default, the Zend Framework 2 module system simply expects each module name to be capable of resolving to an object instance. The default module resolver, Zend\ModuleManager\Listener\ModuleResolverListener, simply instantiates an instance of {moduleName}\Module for each enabled module.
Though it will not serve any purpose at this point, this MyModule module now has everything required to be considered a valid module and to be loaded by the module system! This Module class serves as the single entry point for ModuleManager listeners to interact with a module. From within this simple - yet powerful - class, modules can override or provide additional application conguration, perform initialization tasks such as registering autoloader(s), services and event listeners, declaring dependencies, and much more.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
namespace MyModule; class Module { public function getAutoloaderConfig() { return array( Zend\Loader\ClassMapAutoloader => array( __DIR__ . /autoload_classmap.php, ), Zend\Loader\StandardAutoloader => array( namespaces => array( __NAMESPACE__ => __DIR__ . /src/ . __NAMESPACE__, ), ), ); } public function getConfig() { return include __DIR__ . /config/module.config.php; } }
For a list of the provided module manager listeners and the interfaces and methods that Module classes may implement in order to interact with the module manager and application, see the :ref:module manager listeners <zend.module-manager.module-manager.module-manager-listeners> and the module mananger events documentations.
use Zend\EventManager\EventInterface as Event; use Zend\ModuleManager\ModuleManager; class Module { public function init(ModuleManager $moduleManager) { // Remember to keep the init() method as lightweight as possible $events = $moduleManager->getEventManager(); $events->attach(loadModules.post, array($this, modulesLoaded)); }
826
13 14 15 16 17 18 19 20 21
public function modulesLoaded(Event $e) { // This method is called once all modules are loaded. $moduleManager = $e->getTarget(); $loadedModules = $moduleManager->getLoadedModules(); // To get the configuration from another module named FooModule $config = $moduleManager->getModule(FooModule)->getConfig(); } }
Note: The init() method is called for every module implementing this feature, on every page request, and should only be used for performing lightweight tasks such as registering event listeners.
use Zend\EventManager\EventInterface as Event; class Module { public function onBootstrap(Event $e) { // This method is called once the MVC bootstrapping is complete $application = $e->getApplication(); $services = $application->getServiceManager(); } }
Note: The onBootstrap() method is called for every module implementing this feature, on every page request, and should only be used for performing lightweight tasks such as registering event listeners.
827
828
CHAPTER 184
Zend Framework 2 ships with the default module autoloader Zend\Loader\ModuleAutoloader. It is a specialized autoloader responsible for locating and on-demand loading of, the Module classes from a variety of sources.
The following example will search for modules in three different module_paths. Two are local directories of this application and the third is a system-wide shared directory.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
// public/index.php use Zend\ModuleManager\Listener; use Zend\ModuleManager\ModuleManager; chdir(dirname(__DIR__)); // Instantiate and configure the default listener aggregate $listenerOptions = new Listener\ListenerOptions(array( module_paths => array( ./module, ./vendor, /usr/share/zfmodules, ) )); $defaultListeners = new Listener\DefaultListenerAggregate($listenerOptions);
829
17 18 19 20 21 22 23 24 25 26
// Instantiate the module manager $moduleManager = new ModuleManager(array( Application, FooModule, BarModule, )); // Attach the default listener aggregate and load the modules $moduleManager->getEventManager()->attachAggregate($defaultListeners); $moduleManager->loadModules();
Note: Module paths behave very similar to PHPs include_path and are searched in the order they are dened. If you have modules with the same name in more than one registered module path, the module autoloader will return the rst one it nds.
is
instead
of
having
In this example, the autoloader will rst check for MyModule\Module in /path/to/mymoduledir-v1.2/Module.php. If its not found, then it will fall back to searching any other registered module paths.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
// ./public/index.php use Zend\Loader\ModuleAutoloader; use Zend\ModuleManager\Listener; use Zend\ModuleManager\ModuleManager; chdir(dirname(__DIR__)); // Instantiate and configure the default listener aggregate $listenerOptions = new Listener\ListenerOptions(array( module_paths => array( ./module, ./vendor, /usr/share/zfmodules, MyModule => /path/to/mymoduledir-v1.2, ) )); $defaultListeners = new Listener\DefaultListenerAggregate($listenerOptions); /** * Without DefaultListenerAggregate: * * $moduleAutoloader = new ModuleAutoloader(array( ./module, * ./vendor, * /usr/share/zfmodules, * MyModule => /path/to/mymoduledir-v1.2, * * ));
830
28 29 30 31 32 33 34 35 36 37 38 39 40 41
* $moduleAutoloader->register(); * */ // Instantiate the module manager $moduleManager = new ModuleManager(array( MyModule, FooModule, BarModule, )); // Attach the default listener aggregate and load the modules $moduleManager->getEventManager()->attachAggregate($defaultListeners); $moduleManager->loadModules();
This same method works if you provide the path to a phar archive.
831
832
CHAPTER 185
When creating a ZF2 module, there are some best practices you should keep in mind. Keep the init() and onBootstrap() methods lightweight. Be conservative with the actions you perform in the init() and onBootstrap() methods of your Module class. These methods are run for every page request, and should not perform anything heavy. As a rule of thumb, registering event listeners is an appropriate task to perform in these methods. Such lightweight tasks will generally not have a measurable impact on the performance of your application, even with many modules enabled. It is considered bad practice to utilize these methods for setting up or conguring instances of application resources such as a database connection, application logger, or mailer. Tasks such as these are better served through the ServiceManager capabilities of Zend Framework 2. Do not perform writes within a module. You should never code your module to perform or expect any writes within the modules directory. Once installed, the les within a modules directory should always match the distribution verbatim. Any user-provided conguration should be performed via overrides in the Application module or via application-level conguration les. Any other required lesystem writes should be performed in some writeable path that is outside of the modules directory. There are two primary advantages to following this rule. First, any modules which attempt to write within themselves will not be compatible with phar packaging. Second, by keeping the module in sync with the upstream distribution, updates via mechanisms such as Git will be simple and trouble-free. Of course, the Application module is a special exception to this rule, as there is typically no upstream distribution for this module, and its unlikely you would want to run this package from within a phar archive. Utilize a vendor prex for module names. To avoid module naming conicts, you are encouraged to prex your module namespace with a vendor prex. As an example, the (incomplete) developer tools module distributed by Zend is named ZendDeveloperTools instead of simply DeveloperTools. Utilize a module prex for service names. If you dene services in the top-level Service Manager, you are encouraged to prex these services with the name of your module to avoid conicts with other modules services. For example, the database adapter used by MyModule should be called MyModuleDbAdapter rather than simply DbAdapter. If you need to share a service with other modules, remember that the Service Manager alias feature can be used in a merged conguration to override factories dened by individual modules. Ideally, modules should dene their own service dependencies, but aliases can be congured at the application level to ensure that common services in individual modules all refer to the same instance.
833
834
CHAPTER 186
Zend\Mvc is a brand new MVC implementation designed from the ground up for Zend Framework 2, focusing on performance and exibility. The MVC layer is built on top of the following components: Zend\ServiceManager - Zend Framework provides a set of default service denitions set up at Zend\Mvc\Service. The ServiceManager creates and congures your application instance and workow. Zend\EventManager - The MVC is event driven. This component is used everywhere from initial bootstrapping of the application, through returning response and request calls, to setting and retrieving routes and matched routes, as well as render views. Zend\Http - specically the request and response objects, used within: Zend\Stdlib\DispatchableInterface. All controllers are simply dispatchable objects. Within the MVC layer, several sub-components are exposed: Zend\Mvc\Router contains classes pertaining to routing a request. In other words, it matches the request to its respective controller (or dispatchable). Zend\Http\PhpEnvironment provides a set of decorators for the HTTP Request and Response objects that ensure the request is injected with the current environment (including query parameters, POST parameters, HTTP headers, etc.) Zend\Mvc\Controller, a set of abstract controller classes with basic responsibilities such as event wiring, action dispatching, etc. Zend\Mvc\Service provides a set of ServiceManager factories and denitions for the default application workow. Zend\Mvc\View provides default wiring for renderer selection, view script resolution, helper registration, and more; additionally, it provides a number of listeners that tie into the MVC workow, providing features such as automated template name resolution, automated view model creation and injection, and more. The gateway to the MVC is the Zend\Mvc\Application object (referred to as Application henceforth). Its primary responsibilities are to bootstrap resources, route the request, and to retrieve and dispatch the controller matched during routing. Once accomplished, it will render the view, and nish the request, returning and sending the response.
835
The public/index.php marshalls all user requests to your website, retrieving an array of conguration located in config/application.config.php. On return, it run()s the Application, processing the request and returning a response to the user. The config directory as described above contains conguration used by the Zend\ModuleManager to load modules and merge conguration (e.g., database conguration and credentials); we will detail this more later. The vendor sub-directory should contain any third-party modules or libraries on which your application depends. This might include Zend Framework, custom libraries from your organization, or other third-party libraries from other projects. Libraries and modules placed in the vendor sub-directory should not be modied from their original, distributed state. Finally, the module directory will contain one or more modules delivering your applications functionality. Lets now turn to modules, as they are the basic units of a web application.
836
<code files> test/ phpunit.xml bootstrap.php <module_namespace>/ <test code files> view/ <dir-named-after-module-namespace>/ <dir-named-after-a-controller>/ <.phtml files>
Since a module acts as a namespace, the module root directory should be that namespace. This namespace could also include a vendor prex of sorts. As an example a module centered around User functionality delivered by Zend might be named ZendUser, and this is also what the module root directory will be named. The Module.php le directly under the module root directory will be in the module namespace shown below.
1 2 3 4 5
When an init() method is dened, this method will be triggered by a Zend\ModuleManager listener when it loads the module class, and passed an instance of the manager by default. This allows you to perform tasks such as setting up module-specic event listeners. But be cautious, the init() method is called for every module on every page request and should only be used for performing lightweight tasks such as registering event listeners. Similarly, an onBootstrap() method (which accepts an MvcEvent instance) may be dened; it is also triggered for every page request, and should be used for lightweight tasks as well. The three autoload_*.php les are not required, but recommended. They provide the following: Table 186.1: autoload_*.php Files File Description autoload_classmap.php Should return an array classmap of class name/lename pairs (with the lenames resolved via the __DIR__ magic constant). autoload_function.php Should return a PHP callback that can be passed to spl_autoload_register(). Typically, this callback should utilize the map returned by autoload_classmap.php. autoload_register.php should register a PHP callback (is typically returned by autoload_function.php with spl_autoload_register(). The point of these three les is to provide reasonable default mechanisms for autoloading the classes contained in the module, thus providing a trivial way to consume the module without requiring Zend\ModuleManager (e.g., for use outside a ZF2 application). The config directory should contain any module-specic conguration. These les may be in any format Zend\Config supports. We recommend naming the main conguration module.format, and for PHP-based conguration, module.cong.php. Typically, you will create conguration for the router as well as for the dependency injector. The src directory should be a PSR-0 compliant directory structure with your modules source code. Typically, you should at least have one sub-directory named after your module namespace; however, you can ship code from multiple namespaces if desired. The test directory should contain your unit tests. Typically, these are written using PHPUnit, and contain artifacts related to its conguration (e.g., phpunit.xml, bootstrap.php). The public directory can be used for assets that you may want to expose in your applications document root. These
837
might include images, CSS les, JavaScript les, etc. How these are exposed is left to the developer. The view directory contains view scripts related to your controllers.
$config = include config/application.config.php; $serviceManager = new ServiceManager(); $serviceManager->setService(EventManager, new EventManager()); $serviceManager->setService(ModuleManager, new ModuleManager($config)); $serviceManager->setService(Request, new PhpEnvironment\Request()); $serviceManager->setService(Response, new PhpEnvironment\Response()); $application = new Application($config, $serviceManager);
Once youve done this, there are two additional actions you can take. The rst is to bootstrap the application. In the default implementation, this does the following: Attaches the default route listener (Zend\Mvc\RouteListener). Attaches the default dispatch listener (Zend\Mvc\DispatchListener). Attaches the ViewManager listener (Zend\Mvc\View\ViewManager). Creates the MvcEvent, and injects it with the application, request, and response; it also retrieves the router (Zend\Mvc\Router\Http\TreeRouteStack) at this time and attaches it to the event. Triggers the bootstrap event. If you do not want these actions, or want to provide alternatives, you can do so by extending the Application class and/or simply coding what actions you want to occur. The second action you can take with the congured Application is to run() it. Calling this method simply does the following: it triggers the route event, followed by the dispatch event, and, depending on execution, the render event; when done, it triggers the nish event, and then returns the response instance. If an error occurs during either the route or dispatch event, a dispatch.error event is triggered as well.
838
This is a lot to remember in order to bootstrap the application; in fact, we havent covered all the services available by default yet. You can greatly simplify things by using the default ServiceManager conguration shipped with the MVC.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
use Zend\Loader\AutoloaderFactory; use Zend\Mvc\Service\ServiceManagerConfig; use Zend\ServiceManager\ServiceManager; // setup autoloader AutoloaderFactory::factory(); // get application stack configuration $configuration = include config/application.config.php; // setup service manager $serviceManager = new ServiceManager(new ServiceManagerConfig()); $serviceManager->setService(ApplicationConfig, $configuration); // load modules -- which will provide services, configuration, and more $serviceManager->get(ModuleManager)->loadModules(); // bootstrap and run application $application = $serviceManager->get(Application); $application->bootstrap(); $response = $application->run(); $response->send();
You can make this even simpler by using the init() method of the Application. This is a static method for quick and easy initialization of the Application.
1 2 3 4 5 6 7 8 9 10 11 12 13
// setup autoloader AutoloaderFactory::factory(); // get application stack configuration $configuration = include config/application.config.php; // The init() method does something very similar with the previous example. Application::init($configuration)->run();
The init() method will basically do the following: Grabs the application conguration and pulls from the service_manager key, creating a ServiceManager instance with it and with the default services shipped with Zend\Mvc; Create a service named ApplicationConfig with the application conguration array; Grabs the ModuleManager service and load the modules; bootstrap()s the Application and returns its instance; Note: If you use the init() method, you cannot specify a service with the name of ApplicationCong in your service manager cong. This name is reserved to hold the array from application.cong.php. The following services can only be overridden from application.cong.php: ModuleManager 186.3. Bootstrapping an Application 839
SharedEventManager EventManager & Zend\EventManager\EventManagerInterface All other services are congured after module loading, thus can be overridden by modules. Youll note that you have a great amount of control over the workow. Using the ServiceManager, you have ne-grained control over what services are available, how they are instantiated, and what dependencies are injected into them. Using the EventManagers priority system, you can intercept any of the application events (bootstrap, route, dispatch, dispatch.error, render, and nish) anywhere during execution, allowing you to craft your own application workows as needed.
<?php // config/application.config.php return array( modules => array( /* ... */ ), module_listener_options => array( module_paths => array( ./module, ./vendor, ), ), );
As we add modules to the system, well add items to the modules array. Each Module class that has conguration it wants the Application to know about should dene a getConfig() method. That method should return an array or Traversable object such as Zend\Config\Config. As an example:
1 2 3 4 5 6
840
7 8 9
There are a number of other methods you can dene for tasks ranging from providing autoloader conguration, to providing services to the ServiceManager, to listening to the bootstrap event. The ModuleManager documentation goes into more detail on these.
186.5 Conclusion
The ZF2 MVC layer is incredibly exible, offering an opt-in, easy to create modular infrastructure, as well as the ability to craft your own application workows via the ServiceManager and EventManager. The ModuleManager is a lightweight and simple approach to enforcing a modular architecture that encourages clean separation of concerns and code re-use.
186.5. Conclusion
841
842
CHAPTER 187
Quick Start
Now that you have basic knowledge of applications, modules, and how they are each structured, well show you the easy way to get started.
Then run Composers install command to install the ZF library and any other congured dependencies:
1
843
Deate the archive you selected and rename the parent directory according to your project needs; we use myapplication throughout this document. Install Zend Framework, and either have its library on your PHP include_path, symlink the library into your projects library, or install it directly into your application using Pyrus.
return array( view_manager => array( template_path_stack => array( <module-name> => __DIR__ . /../view ), ), );
Fill in module-name with a lowercased, dash-separated version of your module name e.g., ZendUser would become zend-user. Next, edit the Module.php le to read as follows:
844
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
namespace <your module name here>; use Zend\ModuleManager\Feature\AutoloaderProviderInterface; use Zend\ModuleManager\Feature\ConfigProviderInterface; class Module implements AutoloaderProviderInterface, ConfigProviderInterface { public function getAutoloaderConfig() { return array( Zend\Loader\ClassMapAutoloader => array( __DIR__ . /autoload_classmap.php, ), Zend\Loader\StandardAutoloader => array( namespaces => array( __NAMESPACE__ => __DIR__ . /src/ . __NAMESPACE__, ), ), ); } public function getConfig() { return include __DIR__ . /config/module.config.php; } }
At this point, you now have your module congured properly. Lets create a controller!
845
1 2 3 4 5 6 7 8 9 10 11 12 13 14
<?php namespace <module name>\Controller; use Zend\Mvc\Controller\AbstractActionController; use Zend\View\Model\ViewModel; class HelloController extends AbstractActionController { public function worldAction() { $message = $this->params()->fromQuery(message, foo); return new ViewModel(array(message => $message)); } }
So, what are we doing here? Were creating an action controller. Were dening an action, world. Were pulling a message from the query parameters (yes, this is a superbly bad idea in production! Always sanitize your inputs!). Were returning a ViewModel with an array of values to be processed later. We return a ViewModel. The view layer will use this when rendering the view, pulling variables and the template name from it. By default, you can omit the template name, and it will resolve to lowercase-controller-name/lowercaseaction-name. However, you can override this to specify something different by calling setTemplate() on the ViewModel instance. Typically, templates will resolve to les with a .phtml sufx in your modules view directory. So, with that in mind, lets create a view script.
Thats it. Save the le. Note: What is the method escapeHtml()? Its actually a view helper, and its designed to help mitigate XSS attacks. Never trust user input; if you are at all uncertain about the source of a given variable in your view script, escape it using one of the provided escape view helper depending on the type of data you have.
846
Note: ZendSkeletonApplication ships with a default route that will likely get you to this action. That route basically expects /{module}/{controller}/{action}, which allows you to specify this: /zend-user/hello/world. Were going to create a route here mainly for illustration purposes, as creating explicit routes is a recommended practice. The application will look for a Zend\Mvc\Router\RouteStack instance to setup routing. The default generated router is a Zend\Mvc\Router\Http\TreeRouteStack. To use the default route functionality, you will need to have the following route denition in your module. Replace <module-name> with the name of your module.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
// module.config.php return array( <module-name> => array( type => Literal, options => array( route => /<module-name>, defaults => array( controller => <module-namespace>\Controller\Index, action => index, ), ), may_terminate => true, child_routes => array( default => array( type => Segment, options => array( route => /[:controller[/:action]], constraints => array( controller => [a-zA-Z][a-zA-Z0-9_-]*, action => [a-zA-Z][a-zA-Z0-9_-]*, ), defaults => array( ), ), ), ), ), // ... other configuration ... );
// module.config.php return array( controllers => array( invokables => array( <module-namespace>\Controller\Index => <module-namespace>\Controller\IndexControl // Do similar for each other controller in your module ), ), // ... other configuration ... );
Note: We inform the application about controllers we expect to have in the application. This is to prevent somebody requesting any service the ServiceManager knows about in an attempt to break the application. The dispatcher uses a special, scoped container that will only pull controllers that are specically registered with it, either as invokable classes or via factories.
847
Open your config/module.config.php le, and modify it to add to the routes and controller parameters so it reads as follows:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
return array( router => array( routes => array( <module name>-hello-world => array( type => Literal, options => array( route => /hello/world, defaults => array( controller => <module name>\Controller\Hello, action => world, ), ), ), ), ), controllers => array( invokables => array( <module namespace>\Controller\Hello => <module namespace>\Controller\HelloController, ), ), // ... other configuration ... );
<?php return array( modules => array( Application, <module namespace>, ), module_listener_options => array( module_paths => array( ./module, ./vendor, ), ), );
848
Now alter the location to append ?message=bar and load the page. You should now get:
1 2 3
849
850
CHAPTER 188
Default Services
The default and recommended way to write Zend Framework applications uses a set of services dened in the Zend\Mvc\Service namespace. This chapter details what each of those services are, the classes they represent, and the conguration options available. Many of the services are provided by other components, and the factories and abstract factories themselves are dened in the individual components. We will cover those factories in this chapter, however, as usage is generally the same between each.
188.2 ServiceManager
As a quick review, the following service types may be congured: Invokable services, which map a service name to a class that has no constructor or a constructor that accepts no arguments. Factories, which map a service name to a factory which will create and return an object. A factory receives the service manager as an argument, and may be any PHP callable, or a class or object that implements Zend\ServiceManager\FactoryInterface. 851
Abstract factories, which are factories that can create any number of named services that share the same instantiation pattern; examples include database adapters, cache adapters, loggers, etc. The factory receives the service manager as an argument, the resolved service name, and the requested service name; it must be a class or object implementing Zend\ServiceManager\AbstractFactoryInterface. See the section on abstract factories for conguration information. Aliases, which alias one service name to another. Aliases can also reference other aliases. Initializers, which receive the newly created instance and the service manager, and which can be used to perform additional initialization tasks. The most common use case is to test the instance against specic Aware interfaces, and, if matching, inject them with the appropriate service. Plugin managers, which are specialized service managers used to manage objects that are of a related type, such as view helpers, controller plugins, controllers, etc. Plugin managers accept conguration just like service managers, and as such can compose invokable services, factories, abstract factories, aliases, and initializers. They are also ServiceLocatorAware, and will be injected with the application service manager instance, giving factories and abstract factories access to application-level services when needed. See the heading Plugin managers for a list of available plugin managers. The application service manager is referenced directly during bootstrapping, and has the following services congured out of the box. Invokable services DispatchListener, mapping to Zend\Mvc\DispatchListener. RouteListener, mapping to Zend\Mvc\RouteListener. SendResponseListener, mapping to Zend\Mvc\SendResponseListener. SharedEventManager, mapping to Zend\EventManager\SharedEventManager. Factories Application, mapping to Zend\Mvc\Service\ApplicationFactory. Config, mapping to Zend\Mvc\Service\ConfigFactory. Internally, this pulls the ModuleManager service, and calls its loadModules() method, and retrieves the merged conguration from the module event. As such, this service contains the entire, merged application conguration. ControllerLoader, mapping to Zend\Mvc\Service\ControllerLoaderFactory. This creates an instance of Zend\Mvc\Controller\ControllerManager, passing the service manager instance. Additionally, it uses the DiStrictAbstractServiceFactory service effectively allowing you to fall back to DI in order to retrieve your controllers. If you want to use Zend\Di to retrieve your controllers, you must white-list them in your DI conguration under the allowed_controllers key (otherwise, they will just be ignored). The ControllerManager will add an initializer that will do the following: * If the controller implements the Zend\ServiceManager\ServiceLocatorAwareInterface interface, an instance of the ServiceManager will be injected into it. * If the controller implements the Zend\EventManager\EventManagerAwareInterface interface, an instance of the EventManager will be injected into it. * Finally, an initializer will inject it with the ControllerPluginManager service, as long as the setPluginManager method is implemented. ControllerPluginManager, mapping to Zend\Mvc\Service\ControllerPluginManagerFactory. This instantiates the Zend\Mvc\Controller\PluginManager instance, passing it the service
852
manager instance. It also uses the DiAbstractServiceFactory service effectively allowing you to fall back to DI in order to retrieve your controller plugins. It registers a set of default controller plugins, and contains an initializer for injecting plugins with the current controller. ConsoleAdapter, mapping to Zend\Mvc\Service\ConsoleAdapterFactory. This grabs the Config service, pulls from the console key, and do the following: * If the adapter subkey is present, it is used to get the adapter instance, otherwise, Zend\Console\Console::detectBestAdapter() will be called to congure an adapter instance. * If the charset subkey is present, the is used to set the adapter charset. ConsoleRouter, mapping to Zend\Mvc\Service\RouterFactory. This grabs the Config service, and pulls from the console key and router subkey, conguring a Zend\Mvc\Router\Console\SimpleRouteStack instance. ConsoleViewManager, mapping to Zend\Mvc\Service\ConsoleViewManagerFactory. This creates and returns an instance of Zend\Mvc\View\Console\ViewManager, which in turn registers and initializes a number of console-specic view services. DependencyInjector, mapping to Zend\Mvc\Service\DiFactory. This pulls the Config service, and looks for a di key; if found, that value is used to congure a new Zend\Di\Di instance. DiAbstractServiceFactory, mapping to Zend\Mvc\Service\DiAbstractServiceFactoryFactory. This creates an instance of Zend\ServiceManager\Di\DiAbstractServiceFactory injecting the Di service instance. That instance is attached to the service manager as an abstract factory effectively enabling DI as a fallback for providing services. DiServiceInitializer, mapping to Zend\Mvc\Service\DiServiceInitializerFactory. This creates an instance of Zend\ServiceManager\Di\DiServiceInitializer injecting the Di service and the service manager itself.
DiStrictAbstractServiceFactory, mapping to Zend\Mvc\Service\DiStrictAbstractServiceFact This creates an instance of Zend\Mvc\Service\DiStrictAbstractServiceFactoryFactory injecting the Di service instance. EventManager, mapping to Zend\Mvc\Service\EventManagerFactory. This factory returns a new instance of Zend\EventManager\EventManager on each request. This service is not shared by default, allowing the ability to have an EventManager per service, with a shared SharedEventManager injected in each. FilterManager, mapping to Zend\Mvc\Service\FilterManagerFactory. This instantiates the Zend\Filter\FilterPluginManager instance, passing it the service manager instance this is used to manage lters for the lter chains. It also uses the DiAbstractServiceFactory service effectively allowing you to fall back to DI in order to retrieve lters. FormElementManager, mapping to Zend\Mvc\Service\FormElementManagerFactory. This instantiates the Zend\Form\FormElementManager instance, passing it the service manager instance this is used to manage form elements. It also uses the DiAbstractServiceFactory service effectively allowing you to fall back to DI in order to retrieve form elements. HttpRouter, mapping to Zend\Mvc\Service\RouterFactory. This grabs the Config service, and pulls from the router key, conguring a Zend\Mvc\Router\Http\TreeRouteStack instance. HttpViewManager, mapping to Zend\Mvc\Service\HttpViewManagerFactory. This creates and returns an instance of Zend\Mvc\View\Http\ViewManager, which in turn registers and initializes a number of HTTP-specic view services.
188.2. ServiceManager
853
HydratorManager, mapping to Zend\Mvc\Service\HydratorManagerFactory. This creates and returns an instance of Zend\Stdlib\Hydrator\HydratorPluginManager, which can be used to manage and persist hydrator instances. InputFilterManager, mapping to Zend\Mvc\Service\InputFilterManagerFactory. This creates and returns an instance of Zend\InputFilter\InputFilterPluginManager, which can be used to manage and persist input lter instances. ModuleManager, mapping to Zend\Mvc\Service\ModuleManagerFactory. This is perhaps the most complex factory in the MVC stack. It expects that an ApplicationConfig service has been injected, with keys for module_listener_options and modules; see the quick start for samples. It instantiates an instance of Zend\ModuleManager\Listener\DefaultListenerAggregate, using the module_listener_options retrieved. Checks if a service with the name ServiceListener exists, otherwise it sets a factory with that name mapping to Zend\Mvc\Service\ServiceListenerFactory. A bunch of service listeners will be added to the ServiceListener, like listeners for the getServiceConfig, getControllerConfig, getControllerPluginConfig, getViewHelperConfig module methods. Next, it retrieves the EventManager service, and attaches the above listeners. It instantiates a Zend\ModuleManager\ModuleEvent instance, setting the ServiceManager parameter to the service manager object. Finally, it instantiates a Zend\ModuleManager\ModuleManager instance, and injects the EventManager and ModuleEvent. MvcTranslator, mapping to Zend\Mvc\Service\TranslatorServiceFactory, and returning an instance of Zend\Mvc\I18n\Translator, which extends Zend\I18n\Translator\Translator and implements Zend\Validator\Translator\TranslatorInterface, allowing the instance to be used anywhere a translator may be required in the framework. PaginatorPluginManager, mapping to Zend\Mvc\Service\PaginatorPluginManagerFactory. This instantiates the Zend\Paginator\AdapterPluginManager instance, passing it the service manager instance this is used to manage paginator adapters. It also uses the DiAbstractServiceFactory service effectively allowing you to fall back to DI in order to retrieve paginator adapters. Request, mapping to Zend\Mvc\Service\RequestFactory. The factory is used to create and return a request instance, according to the current environment. If the current environment is cli, it will create a Zend\Console\Request, or a Zend\Http\PhpEnvironment\Request if the current environment is HTTP. Response, mapping to Zend\Mvc\Service\ResponseFactory. The factory is used to create and return a response instance, according to the current environment. If the current environment is cli, it will create a Zend\Console\Response, or a Zend\Http\PhpEnvironment\Response if the current environment is HTTP. Router, mapping to Zend\Mvc\Service\RouterFactory. If in a console enviroment, this will behave the same way as the ConsoleRouter service, if not, it will behave the same way as HttpRouter service. RoutePluginManager, mapping to Zend\Mvc\Service\RoutePluginManagerFactory. This instantiates the Zend\Mvc\Router\RoutePluginManager instance, passing it the service manager instance this is used to manage route types. It also uses the DiAbstractServiceFactory service effectively allowing you to fall back to DI in order to retrieve route types.
854
SerializerAdapterManager, mapping to Zend\Mvc\Service\SerializerAdapterPluginManagerFac which returns an instance of Zend\Serializer\AdapterPluginManager. This is a plugin manager for managing serializer adapter instances. ServiceListener, mapping to Zend\Mvc\Service\ServiceListenerFactory. The factory is used to instantiate the ServiceListener, while allowing easy extending. It checks if a service with the name ServiceListenerInterface exists, which must implement Zend\ModuleManager\Listener\ServiceListenerInterface, before instantiating the default ServiceListener. In addition to this, it retrieves the ApplicationConfig and looks for the service_listener_options key. This allows you to register own listeners for module methods and conguration keys to create an own service manager; see the application conguration options for samples. ValidatorManager, mapping to Zend\Mvc\Service\ValidatorManagerFactory. This instantiates the Zend\Validator\ValidatorPluginManager instance, passing it the service manager instance this is used to manage validators. It also uses the DiAbstractServiceFactory service effectively allowing you to fall back to DI in order to retrieve validators. ViewFeedRenderer, mapping to Zend\Mvc\Service\ViewFeedRendererFactory, which returns an instance of Zend\View\Renderer\FeedRenderer, used to render feeds. ViewFeedStrategy, mapping to Zend\Mvc\Service\ViewFeedStrategyFactory, which returns an instance of Zend\View\Strategy\FeedStrategy, used to select the ViewFeedRenderer given the appropriate criteria. ViewHelperManager, mapping to Zend\Mvc\Service\ViewHelperManagerFactory, which returns an instance of Zend\View\HelperManager. This is a plugin manager for managing view helper instances. ViewJsonRenderer, mapping to Zend\Mvc\Service\ViewJsonRendererFactory, which returns an instance of Zend\View\Renderer\JsonRenderer, used to render JSON structures. ViewJsonStrategy, mapping to Zend\Mvc\Service\ViewJsonStrategyFactory, which returns an instance of Zend\View\Strategy\JsonStrategy, used to select the ViewJsonRenderer given the appropriate criteria. ViewManager, mapping to Zend\Mvc\Service\ViewManagerFactory. The factory is used to create and return a view manager, according to the current environment. If the current environment is cli, it will create a Zend\Mvc\View\Console\ViewManager, or a Zend\Mvc\View\Http\ViewManager if the current environment is HTTP. ViewResolver, mapping to Zend\Mvc\Service\ViewResolverFactory, which creates and returns the aggregate view resolver. It also attaches the ViewTemplateMapResolver and ViewTemplatePathStack services to it. ViewTemplateMapResolver, mapping to Zend\Mvc\Service\ViewTemplateMapResolverFactory which creates, congures and returns the Zend\View\Resolver\TemplateMapResolver. ViewTemplatePathStack, mapping to Zend\Mvc\Service\ViewTemplatePathStackFactory which creates, congures and returns the Zend\View\Resolver\TemplatePathStack. Abstract factories Zend\Cache\Service\StorageCacheAbstractServiceFactory (opt-in; registered by default in the skeleton application). Zend\Db\Adapter\AdapterAbstractServiceFactory (opt-in). Zend\Form\FormAbstractServiceFactory is registered by default.
188.2. ServiceManager
855
Zend\Log\LoggerAbstractServiceFactory (opt-in; registered by default in the skeleton application). Aliases Configuration, mapping to the Config service. Console, mapping to the ConsoleAdapter service. Di, mapping to the DependencyInjector service. Zend\Di\LocatorInterface, mapping to the DependencyInjector service. Zend\EventManager\EventManagerInterface, mapping to the EventManager service. This is mainly to ensure that when falling through to DI, classes are still injected via the ServiceManager. Zend\Mvc\Controller\PluginManager, mapping to the ControllerPluginManager service. This is mainly to ensure that when falling through to DI, classes are still injected via the ServiceManager. Zend\View\Resolver\TemplateMapResolver, ViewTemplateMapResolver service. mapping to the
Zend\View\Resolver\TemplatePathStack, mapping to the ViewTemplatePathStack service. Zend\View\Resolver\AggregateResolver, mapping to the ViewResolver service. Zend\View\Resolver\ResolverInterface, mapping to the ViewResolver service. Initializers For objects that implement Zend\EventManager\EventManagerAwareInterface, the EventManager service will be retrieved and injected. This service is not shared, though each instance it creates is injected with a shared instance of SharedEventManager. For objects that implement Zend\ServiceManager\ServiceLocatorAwareInterface, the ServiceManager will inject itself into the object. The ServiceManager registers itself as the ServiceManager service, and aliases itself to the class names Zend\ServiceManager\ServiceLocatorInterface and Zend\ServiceManager\ServiceManager.
188.3.1 Zend\Cache\Service\StorageCacheAbstractServiceFactory
This abstract factory is opt-in, but registered by default in the skeleton application. It uses the top-level conguration key caches.
856
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
return array( caches => array( Cache\Transient => array( adapter => redis, ttl => 60, plugins => array( exception_handler => array( throw_exceptions => false, ), ), ), Cache\Persistence => array( adapter => filesystem, ttl => 86400, ), ), );
188.3.2 Zend\Db\Adapter\AdapterAbstractServiceFactory
This abstract factory is opt-in. It uses the top-level conguration key db, with a subkey adapters.
1 2 3 4 5 6 7 8 9 10 11 12 13 14
return array( db => array(adapters => array( Db\ReadOnly => array( driver => Pdo_Sqlite, database => data/db/users.db, ), Db\Writeable => array( driver => Mysqli, database => users, username => developer, password => developer_password, ), )), );
188.3.3 Zend\Form\FormAbstractServiceFactory
This abstract factory is registered by default. It uses the top-level conguration key forms. It makes use of the FilterManager, FormElementManager, HydratorManager, InputFilterManager, and ValidatorManager plugin managers in order to allow instantiation and creation of form objects and all related objects in the form hierarchy.
1 2 3 4 5 6 7 8
return array( forms => array( Form\Foo => array( hydrator => ObjectProperty, type => Zend\Form\Form, elements => array( array( spec => array(
857
9 10 11 12 13 14 15 16 17 18 19
type => Zend\Form\Element\Email, name => email, options => array( label => Your email address, ), ), ), ), ), ), );
Form conguration follows the same conguration you would use with a form factory; the primary difference is that all plugin managers have already been injected for you, allowing you the possibility of custom objects or substitutions. See the form factory documentation for more conguration options.
188.3.4 Zend\Log\LoggerAbstractServiceFactory
This abstract factory is opt-in, but registered by default in the skeleton application. It uses the top-level conguration key log.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
return array( log => array( Log\App => array( writers => array( array( name => stream, priority => 1000, options => array( stream => data/logs/app.log, ), ), ), ), ), );
858
HydratorManager, corresponding to Zend\Stdlib\Hydrator\HydratorPluginManager, and used to manage hydrator instances. InputFilterManager, corresponding to Zend\InputFilter\InputFilterPluginManager, and used to manage input lter instances. RoutePluginManager, corresponding to Zend\Mvc\Router\RoutePluginManager, and used to manage route instances. SerializerAdapterManager, corresponding to Zend\Serializer\AdapterPluginManager, and used to manage serializer instances. ValidatorManager, corresponding to Zend\Validator\ValidatorPluginManager, and used to manage validator instances. ViewHelperManager, corresponding to Zend\View\HelperManager, and used to manage view helper instances. As noted in the previous section, all plugin managers share the same conguration and service types as the standard service manager; they are simply scoped, and only allow instances of certain types to be created or registered. Default types available are listed in the documentation for each component.
188.5 ViewManager
The View layer within Zend\Mvc consists of a large number of collaborators and event listeners. As such, Zend\Mvc\View\ViewManager was created to handle creation of the various objects, as well as wiring them together and establishing event listeners. The ViewManager itself is an event listener on the bootstrap event. It retrieves the ServiceManager from the Application object, as well as its composed EventManager. Conguration for all members of the ViewManager fall under the view_manager conguration key, and expect values as noted below. The following services are created and managed by the ViewManager: ViewHelperManager, representing and aliased to Zend\View\HelperPluginManager. It is seeded with the ServiceManager. Created via the Zend\Mvc\Service\ViewHelperManagerFactory. The Router service is retrieved, and injected into the Url helper. If the base_path key is present, it is used to inject the BasePath view helper; otherwise, the Request service is retrieved, and the value of its getBasePath() method is used. If the doctype key is present, it will be used to set the value of the Doctype view helper. ViewTemplateMapResolver, representing and aliased to Zend\View\Resolver\TemplateMapResolver. If a template_map key is present, it will be used to seed the template map. ViewTemplatePathStack, representing and aliased to Zend\View\Resolver\TemplatePathStack. If a template_path_stack key is present, it will be used to seed the stack. If a default_template_suffix key is present, it will be used as the default sufx for template scripts resolving. ViewResolver, representing and aliased to Zend\View\Resolver\AggregateResolver and Zend\View\Resolver\ResolverInterface. It is seeded with the ViewTemplateMapResolver and ViewTemplatePathStack services as resolvers. ViewRenderer, representing and aliased to Zend\View\Renderer\RendererInterface. Zend\View\Renderer\PhpRenderer and It is seeded with the ViewResolver and
188.5. ViewManager
859
ViewHelperManager services. Additionally, the ViewModel helper gets seeded with the ViewModel as its root (layout) model. ViewPhpRendererStrategy, representing and aliased to Zend\View\Strategy\PhpRendererStrategy. It gets seeded with the ViewRenderer service. View, representing and aliased to Zend\View\View. It gets seeded with the EventManager service, and attaches the ViewPhpRendererStrategy as an aggregate listener. DefaultRenderingStrategy, representing and aliased to Zend\Mvc\View\DefaultRenderingStrategy. If the layout key is present, it is used to seed the strategys layout template. It is seeded with the View service. ExceptionStrategy, representing and aliased to Zend\Mvc\View\ExceptionStrategy. If the display_exceptions or exception_template keys are present, they are used to congure the strategy. RouteNotFoundStrategy, representing and aliased to Zend\Mvc\View\RouteNotFoundStrategy and 404Strategy. If the display_not_found_reason or not_found_template keys are present, they are used to congure the strategy. ViewModel. In this case, no service is registered; the ViewModel is simply retrieved from the MvcEvent and injected with the layout template name. The ViewManager also creates several other listeners, but does not expose them as services; these include Zend\Mvc\View\CreateViewModelListener, Zend\Mvc\View\InjectTemplateListener, and Zend\Mvc\View\InjectViewModelListener. These, along with RouteNotFoundStrategy, ExceptionStrategy, and DefaultRenderingStrategy are attached as listeners either to the application EventManager instance or the SharedEventManager instance. Finally, if you have a strategies key in your conguration, the ViewManager will loop over these and attach them in order to the View service as listeners, at a priority of 100 (allowing them to execute before the DefaultRenderingStrategy).
<?php return array( // This should be an array of module namespaces used in the application. modules => array( ), // These are various options for the listeners attached to the ModuleManager module_listener_options => array( // This should be an array of paths in which modules reside. // If a string key is provided, the listener will consider that a module // namespace, the value of that key the specific path to that modules // Module class. module_paths => array( ), // An array of paths from which to glob configuration files after // modules are loaded. These effectively override configuration
860
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
// provided by modules themselves. Paths may use GLOB_BRACE notation. config_glob_paths => array( ), // Whether or not to enable a configuration cache. // If enabled, the merged configuration will be cached and used in // subsequent requests. config_cache_enabled => $booleanValue, // The key used to create the configuration cache file name. config_cache_key => $stringKey, // Whether or not to enable a module class map cache. // If enabled, creates a module class map cache which will be used // by in future requests, to reduce the autoloading process. module_map_cache_enabled => $booleanValue, // The key used to create the class map cache file name. module_map_cache_key => $stringKey, // The path in which to cache merged configuration. cache_dir => $stringPath, // Whether or not to enable modules dependency checking. // Enabled by default, prevents usage of modules that depend on other modules // that werent loaded. check_dependencies => $booleanValue, ), // Used to create an own service manager. May contain one or more child arrays. service_listener_options => array( array( service_manager => $stringServiceManagerName, config_key => $stringConfigKey, interface => $stringOptionalInterface, method => $stringRequiredMethodName, ), ) // Initial configuration with which to seed the ServiceManager. // Should be compatible with Zend\ServiceManager\Config. service_manager => array( ), );
861
merge is relevant so you can override a modules conguration with your application conguration. If you have both a config/autoload/my.global.config.php and config/autoload/my.local.config.php, the local conguration le overrides the global conguration. Warning: Local conguration les are intended to keep sensitive information, such as database credentials, and as such, it is highly recommended to keep these local conguration les out of your VCS. The ZendSkeletonApplications config/autoload/.gitignore le ignores *.local.php les by default.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
<?php return array( // The following are used to configure controller loader // Should be compatible with Zend\ServiceManager\Config. controllers => array( // Map of controller "name" to class // This should be used if you do not need to inject any dependencies // in your controller invokables => array( ), // Map of controller "name" to factory for creating controller instance // You may provide either the class name of a factory, or a PHP callback. factories => array( ), ), // The following are used to configure controller plugin loader // Should be compatible with Zend\ServiceManager\Config. controller_plugins => array( ), // The following are used to configure view helper manager // Should be compatible with Zend\ServiceManager\Config. view_helpers => array( ), // The following is used to configure a Zend\Di\Di instance. // The array should be in a format that Zend\Di\Config can understand. di => array( ), // Configuration for the Router service // Can contain any router configuration, but typically will always define // the routes for the application. See the router documentation for details // on route configuration. router => array( routes => array( ), ), // ViewManager configuration view_manager => array( // Base URL path to the application base_path => $stringBasePath, // Doctype with which to seed the Doctype helper doctype => $doctypeHelperConstantString, // e.g. HTML5, XHTML1
862
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
// TemplateMapResolver configuration // template/path pairs template_map => array( ), // TemplatePathStack configuration // module/view script path pairs template_path_stack => array( ), // Default suffix to use when resolving template scripts, if none, phtml is used default_template_suffix => $templateSuffix, // e.g. php // Layout template name layout => $layoutTemplateName, // e.g. layout/layout // ExceptionStrategy configuration display_exceptions => $bool, // display exceptions in template exception_template => $stringTemplateName, // e.g. error // RouteNotFoundStrategy configuration display_not_found_reason => $bool, // display 404 reason in template not_found_template => $stringTemplateName, // e.g. 404 // Additional strategies to attach // These should be class names or service names of View strategy classes // that act as ListenerAggregates. They will be attached at priority 100, // in the order registered. strategies => array( ViewJsonStrategy, // register JSON renderer strategy ViewFeedStrategy, // register Feed renderer strategy ), ), );
863
864
CHAPTER 189
Routing
Routing is the act of matching a request to a given controller. Typically, routing will examine the request URI, and attempt to match the URI path segment against provided constraints. If the constraints match, a set of matches are returned, one of which should be the controller name to execute. Routing can utilize other portions of the request URI or environment as well for example, the host or scheme, query parameters, headers, request method, and more. Routing has been written from the ground up for Zend Framework 2.0. Execution is quite similar, but the internal workings are more consistent, performant, and often simpler. Note: If you are a developer with knowledge of the routing system in Zend Framework 1.x, you should know that some of the old terminology does not apply in Zend Framework 2.x. In the new routing system we dont have a router as such, as every route can match and assemble URIs by themselves, which makes them routers, too. That said, in most cases the developer does not need to worry about this, because Zend Framework 2.x will take care of this under the hood. The work of the router will be done by Zend\Mvc\Router\SimpleRouteStack or Zend\Mvc\Router\Http\TreeRouteStack. The base unit of routing is a Route:
1 2 3 4 5 6 7 8 9 10
namespace Zend\Mvc\Router; use Zend\Stdlib\RequestInterface as Request; interface RouteInterface { public static function factory(array $options = array()); public function match(Request $request); public function assemble(array $params = array(), array $options = array()); }
A Route accepts a Request, and determines if it matches. If so, it returns a RouteMatch object:
1 2 3 4 5 6
namespace Zend\Mvc\Router; class RouteMatch { public function __construct(array $params); public function setMatchedRouteName($name);
865
7 8 9 10 11
Typically, when a Route matches, it will dene one or more parameters. These are passed into the RouteMatch, and objects may query the RouteMatch for their values.
1 2 3 4 5
$id = $routeMatch->getParam(id, false); if (!$id) { throw new Exception(Required identifier is missing!); } $entity = $resource->get($id);
Usually you will have multiple routes you wish to test against. In order to facilitate this, you will use a route aggregate, usually implementing RouteStack:
1 2 3 4 5 6 7 8 9
namespace Zend\Mvc\Router; interface RouteStackInterface extends RouteInterface { public function addRoute($name, $route, $priority = null); public function addRoutes(array $routes); public function removeRoute($name); public function setRoutes(array $routes); }
Typically, routes should be queried in a LIFO order, and hence the reason behind the name RouteStack. Zend Framework provides two implementations of this interface, SimpleRouteStack and TreeRouteStack. In each, you register routes either one at a time using addRoute(), or in bulk using addRoutes().
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
// One at a time: $route = Literal::factory(array( route => /foo, defaults => array( controller => foo-index, action => index, ), )); $router->addRoute(foo, $route); // In bulk: $router->addRoutes(array( // using already instantiated routes: foo => $route, // providing configuration to allow lazy-loading routes: bar => array( type => literal, options => array( route => /bar, defaults => array( controller => bar-index, action => index, ), ), ), ));
866
189.1.1 SimpleRouteStack
This router simply takes individual routes that provide their full matching logic in one go, and loops through them in LIFO order until a match is found. As such, routes that will match most often should be registered last, and least common routes rst. Additionally, you will need to ensure that routes that potentially overlap are registered such that the most specic match will match rst (i.e., register later). Alternatively, you can set priorities by giving the priority as third parameter to the addRoute() method, specifying the priority in the route specications or setting the priority property within a route instance before adding it to the route stack.
189.1.2 TreeRouteStack
Zend\Mvc\Router\Http\TreeRouteStack provides the ability to register trees of routes, and will use a Btree algorithm to match routes. As such, you register a single route with many children. A TreeRouteStack will consist of the following conguration: A base route, which describes the base match needed, the root of the tree. An optional route_plugins, which is a congured Zend\Mvc\Router\RoutePluginManager that can lazy-load routes. The option may_terminate, which hints to the router that no other segments will follow it. An optional child_routes array, which contains additional routes that stem from the base route (i.e., build from it). Each child route can itself be a TreeRouteStack if desired; in fact, the Part route works exactly this way. When a route matches against a TreeRouteStack, the matched parameters from each segment of the tree will be returned. A TreeRouteStack can be your sole route for your application, or describe particular path segments of the application. An example of a TreeRouteStack is provided in the documentation of the Part route.
189.2.1 Zend\Mvc\Router\Http\Hostname
The Hostname route attempts to match the hostname registered in the request against specic criteria. Typically, this will be in one of the following forms: subdomain.domain.tld :subdomain.domain.tld
867
In the above, the second route would return a subdomain key as part of the route match. For any given hostname segment, you may also provide a constraint. As an example, if the subdomain segment needed to match only if it started with fw and contained exactly 2 digits following, the following route would be needed:
1 2 3 4 5 6
$route = Hostname::factory(array( route => :subdomain.domain.tld, constraints => array( subdomain => fw\d{2}, ), ));
In the above example, only a subdomain key will be returned in the RouteMatch. If you wanted to also provide other information based on matching, or a default value to return for the subdomain, you need to also provide defaults.
1 2 3 4 5 6 7 8 9
$route = Hostname::factory(array( route => :subdomain.domain.tld, constraints => array( subdomain => fw\d{2}, ), defaults => array( type => json, ), ));
When matched, the above will return two keys in the RouteMatch, subdomain and type.
189.2.2 Zend\Mvc\Router\Http\Literal
The Literal route is for doing exact matching of the URI path. Conguration therefore is solely the path you want to match, and the defaults, or parameters you want returned on a match.
1 2 3 4 5 6 7
$route = Literal::factory(array( route => /foo, defaults => array( controller => Application\Controller\IndexController, action => foo, ), ));
The above route would match a path /foo, and return the key action in the RouteMatch, with the value foo.
189.2.3 Zend\Mvc\Router\Http\Method
The Method route is used to match the http method or verb specied in the request (See RFC 2616 Sec. 5.1.1). It can optionally be congured to match against multiple methods by providing a comma-separated list of method tokens.
1 2 3 4 5 6 7
$route = Method::factory(array( verb => post,put, defaults => array( controller => Application\Controller\IndexController, action => form-submit, ), ));
868
The above route would match an http POST or PUT request and return a RouteMatch object containing a key action with a value of form-submit.
189.2.4 Zend\Mvc\Router\Http\Part
A Part route allows crafting a tree of possible routes based on segments of the URI path. It actually extends the TreeRouteStack. Part routes are difcult to describe, so well simply provide a sample one here.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
$route = Part::factory(array( route => array( type => literal, options => array( route => /, defaults => array( controller => Application\Controller\IndexController, action => index, ), ), ), route_plugins => $routePlugins, may_terminate => true, child_routes => array( blog => array( type => literal, options => array( route => /blog, defaults => array( controller => Application\Controller\BlogController, action => index, ), ), may_terminate => true, child_routes => array( rss => array( type => literal, options => array( route => /rss, defaults => array( action => rss, ) ), may_terminate => true, child_routes => array( subrss => array( type => literal, options => array( route => /sub, defaults => array( action => subrss, ), ), ), ), ), ), ),
869
49 50 51 52 53 54 55 56 57 58 59 60
forum => array( type => literal, options => array( route => forum, defaults => array( controller => Application\Controller\ForumController, action => index, ), ), ), ), ));
The above would match the following: / would load the Index controller, index action. /blog would load the Blog controller, index action. /blog/rss would load the Blog controller, rss action. /blog/rss/sub would load the Blog controller, subrss action. /forum would load the Forum controller, index action. You may use any route type as a child route of a Part route. Note: Part routes are not meant to be used directly. When you add denitions for child_routes to any route type, that route will become a Part route. As already said, describing Part routes with words is difcult, so hopefully the additional examples at the end will provide further insight.
the
$routePlugins
is
an
instance
of
$routePlugins = new Zend\Mvc\Router\RoutePluginManager(); $plugins = array( hostname => Zend\Mvc\Router\Http\Hostname, literal => Zend\Mvc\Router\Http\Literal, part => Zend\Mvc\Router\Http\Part, regex => Zend\Mvc\Router\Http\Regex, scheme => Zend\Mvc\Router\Http\Scheme, segment => Zend\Mvc\Router\Http\Segment, wildcard => Zend\Mvc\Router\Http\Wildcard, query => Zend\Mvc\Router\Http\Query, method => Zend\Mvc\Router\Http\Method, ); $foreach ($plugins as $name => $class) { $routePlugins->setInvokableClass($name, $class); }
When using Zend\Mvc\Router\Http\TreeRouteStack, the RoutePluginManager is set up by default, and the developer does not need to worry about the autoloading of standard HTTP routes.
870
189.2.5 Zend\Mvc\Router\Http\Regex
A Regex route utilizes a regular expression to match against the URI path. Any valid regular expression is allowed; our recommendation is to use named captures for any values you want to return in the RouteMatch. Since regular expression routes are often complex, you must specify a spec or specication to use when assembling URLs from regex routes. The spec is simply a string; replacements are identied using %keyname% within the string, with the keys coming from either the captured values or named parameters passed to the assemble() method. Just like other routes, the Regex route can accept defaults, parameters to include in the RouteMatch when successfully matched.
1 2 3 4 5 6 7 8 9
$route = Regex::factory(array( regex => /blog/(?<id>[a-zA-Z0-9_-]+)(\.(?<format>(json|html|xml|rss)))?, defaults => array( controller => Application\Controller\BlogController, action => view, format => html, ), spec => /blog/%id%.%format%, ));
The above would match /blog/001-some-blog_slug-here.html, and return four items in the RouteMatch, an id, the controller, the action, and the format. When assembling a URL from this route, the id and format values would be used to ll the specication.
189.2.6 Zend\Mvc\Router\Http\Scheme
The Scheme route matches the URI scheme only, and must be an exact match. As such, this route, like the Literal route, simply takes what you want to match and the defaults, parameters to return on a match.
1 2 3 4 5 6
$route = Scheme::factory(array( scheme => https, defaults => array( https => true, ), ));
The above route would match the https scheme, and return the key https in the RouteMatch with a boolean true value.
189.2.7 Zend\Mvc\Router\Http\Segment
A Segment route allows matching any segment of a URI path. Segments are denoted using a colon, followed by alphanumeric characters; if a segment is optional, it should be surrounded by brackets. As an example, /:foo[/:bar] would match a / followed by text and assign it to the key foo; if any additional / characters are found, any text following the last one will be assigned to the key bar. The separation between literal and named segments can be anything. For example, the above could be done as /:foo{}[-:bar] as well. The {-} after the :foo parameter indicates a set of one or more delimiters, after which matching of the parameter itself ends. Each segment may have constraints associated with it. Each constraint should simply be a regular expression expressing the conditions under which that segment should match. Also, as you can in other routes, you may provide defaults to use; these are particularly useful when using optional segments. 189.2. HTTP Route Types 871
As a complex example:
1 2 3 4 5 6 7 8 9 10 11
$route = Segment::factory(array( route => /:controller[/:action], constraints => array( controller => [a-zA-Z][a-zA-Z0-9_-]+, action => [a-zA-Z][a-zA-Z0-9_-]+, ), defaults => array( controller => Application\Controller\IndexController, action => index, ), ));
$route = Part::factory(array( route => array( type => literal, options => array( route => page, defaults => array( ), ), ), may_terminate => true, route_plugins => $routePlugins, child_routes => array( query => array( type => Query, options => array( defaults => array( foo => bar, ), ), ), ), ));
As you can see, its pretty straight forward to specify the query part. This then allows you to create query strings using the url view helper.
1 2 3 4 5 6 7 8
$this->url( page/query, array( name => my-test-page, format => rss, limit => 10, ) );
872
As you can see above, you must add /query to your route name in order to append a query string. If you do not specify /query in the route name then no query string will be appended. Our example page route has only one dened parameter of name (/page[/:name]), meaning that the remaining parameters of format and limit will then be appended as a query string. The output from our example should then be /page/my-test-page?format=rss&limit=10
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
A complex example with child routes return array( router => array( routes => array( // Literal route named "home" home => array( type => literal, options => array( route => /,
1 2 3 4 5 6 7 8
873
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
defaults => array( controller => Application\Controller\IndexController, action => index, ), ), ), // Literal route named "blog", with child routes blog => array( type => literal, options => array( route => /blog, defaults => array( controller => Application\Controller\BlogController, action => index, ), ), may_terminate => true, child_routes => array( // Segment route for viewing one blog post post => array( type => segment, options => array( route => /[:slug], constraints => array( slug => [a-zA-Z0-9_-]+, ), defaults => array( action => view, ), ), ), // Literal route for viewing blog RSS feed rss => array( type => literal, options => array( route => /rss, defaults => array( action => rss, ), ), ), ), ), ), ), );
When using child routes, naming of the routes follows the parent/child pattern, so to use the child routes from the above example:
1 2 3
echo $this->url(blog); // gives "/blog" echo $this->url(blog/post, array(slug => my-post)); // gives "/blog/my-post" echo $this->url(blog/rss); // gives "/blog/rss"
Warning: When dening child routes pay attention that the may_terminate and child_routes denitions are in same level as the options and type denitions. A common pitfall is to have those two denitions nested in options, which will not result in the desired routes.
874
875
876
CHAPTER 190
The MvcEvent
The MVC layer of Zend Framework 2 incorporates and utilizes a custom Zend\EventManager\Event implementation - Zend\Mvc\MvcEvent. This event is created during Zend\Mvc\Application::bootstrap() and is passed directly to all the events that method triggers. Additionally, if your controllers implement the Zend\Mvc\InjectApplicationEventInterface, MvcEvent will be injected into those controllers. The MvcEvent adds accessors and mutators for the following: Application object. Request object. Response object. Router object. RouteMatch object. Result - usually the result of dispatching a controller. ViewModel object, typically representing the layout view model. The methods it denes are: setApplication($application) getApplication() setRequest($request) getRequest() setResponse($response) getResponse() setRouter($router) getRouter() setRouteMatch($routeMatch) getRouteMatch() setResult($result) getResult()
877
setViewModel($viewModel) getViewModel() isError() setError() getError() getController() setController($name) getControllerClass() setControllerClass($class) The Application, Request, Response, Router, and ViewModel are all injected during the bootstrap event. Following the route event, it will be injected also with the RouteMatch object encapsulating the results of routing. Since this object is passed around throughout the MVC, it is a common location for retrieving the results of routing, the router, and the request and response objects. Additionally, we encourage setting the results of execution in the event, to allow event listeners to introspect them and utilize them within their execution. As an example, the results could be passed into a view renderer.
190.2 MvcEvent::EVENT_BOOTSTRAP
190.2.1 Listeners
The following classes are listening to this event (they are sorted from higher priority to lower priority):
878
Table 190.2: MvcEvent::EVENT_BOOTSTRAP Listeners PriMethod Itself ority Called Triggers Zend\Mvc\View\Http\ViewManager 10000 onBootstrap none Class Description Prepares the view layer (instantiate a Zend\Mvc\View\Http\ViewManager).
190.2.2 Triggerers
This event is triggered by the following classes: Table 190.3: MvcEvent::EVENT_BOOTSTRAP Triggerers Class Zend\Mvc\Application In Method bootstrap
190.3 MvcEvent::EVENT_ROUTE
190.3.1 Listeners
The following classes are listening to this event (they are sorted from higher priority to lower priority): Table 190.4: MvcEvent::EVENT_ROUTE Listeners Pri- Method Itself Triggers or- Called ity Zend\Mvc\ModuleRouteListener 1 onRoute none Class Description
This listener determines if the module namespace should be prepended to the controller name. This is the case if the route match contains a parameter key matching the MODULE_NAMESPACE constant. Zend\Mvc\RouteListener 1 onRoute MvcEvent::EVENT_DISPATCH_ERROR Tries to match the request to the router and return a (if no route is RouteMatch object. matched)
190.3.2 Triggerers
This event is triggered by the following classes: Table 190.5: MvcEvent::EVENT_ROUTE Triggerers In Method Zend\Mvc\Application run Class Description It also has a short circuit callback that allows to stop the propagation of the event if an error is raised during the routing.
190.3. MvcEvent::EVENT_ROUTE
879
190.4 MvcEvent::EVENT_DISPATCH
190.4.1 Listeners
The following classes are listening to this event (they are sorted from higher priority to lower priority): Console context only Those listeners are only attached in a Console context: Table 190.6: MvcEvent::EVENT_DISPATCH Listeners for Console context only Pri- Method Description or- Called ity Zend\Mvc\View\Console\InjectNamedConsoleParamsListener 1000 injectNamedParams Merge all the params (route matched params and params in the command) and add them to the Request object. Zend\Mvc\View\Console\CreateViewModelListener -80 createViewModelFromArray If the controller action returned an associative array, it casts it to a ConsoleModel object. Zend\Mvc\View\Console\CreateViewModelListener -80 createViewModelFromString If the controller action returned a string, it casts it to a ConsoleModel object. Zend\Mvc\View\Console\CreateViewModelListener -80 createViewModelFromNull If the controller action returned null, it casts it to a ConsoleModel object. Zend\Mvc\View\Console\InjectViewModelListener injectViewModel Inserts the ViewModel (in this case, a ConsoleModel) 100 and adds it to the MvcEvent object. It either (a) adds it as a child to the default, composed view model, or (b) replaces it if the result is marked as terminable. Http context only Those listeners are only attached in a Http context: Table 190.7: MvcEvent::EVENT_DISPATCH Listeners for Http context only Pri- Method Description or- Called ity Zend\Mvc\View\Http\CreateViewModelListener -80 createViewModelFromArray If the controller action returned an associative array, it casts it to a ViewModel object. Zend\Mvc\View\Http\CreateViewModelListener -80 createViewModelFromNull If the controller action returned null, it casts it to a ViewModel object. Zend\Mvc\View\Http\RouteNotFoundStrategy -90 prepareNotFoundViewModel It creates and return a 404 ViewModel. Zend\Mvc\View\Http\InjectTemplateListener -90 injectTemplate Inject a template into the view model, if none present. Template is derived from the controller found in the route match, and, optionally, the action, if present. Zend\Mvc\View\Http\InjectViewModelListener injectViewModel Inserts the ViewModel (in this case, a ViewModel) and adds 100 it to the MvcEvent object. It either (a) adds it as a child to the default, composed view model, or (b) replaces it if the result is marked as terminable. Class Class
880
All contexts Those listeners are attached for both contexts: Table 190.8: MvcEvent::EVENT_DISPATCH Listeners for both contexts Pri- Method Itself Triggers Description or- Called ity Zend\Mvc\DispatchListener 1 onDispatch MvcEvent::EVENT_DISPATCH_ERROR Try to load the matched controller from the service (if an exception is raised manager (and throws various exceptions if it does during dispatch processes) not). Zend\Mvc\AbstractController 1 onDispatch none The onDispatch method of the AbstractController is an abstract method. In AbstractActionController for instance, it simply calls the action method. Class
190.4.2 Triggerers
This event is triggered by the following classes: Table 190.9: MvcEvent::EVENT_DISPATCH Triggerers In Description Method Zend\Mvc\Application run It also has a short circuit callback that allows to stop the propagation of the event if an error is raised during the routing. Zend\Mvc\Controller\AbstractController dispatch If a listener returns a Response object, it stops propagation. Note: every AbstractController listen to this event and execute the onBootstrap method when it is triggered. Class
190.5 MvcEvent::EVENT_DISPATCH_ERROR
190.5.1 Listeners
The following classes are listening to this event (they are sorted from higher priority to lower priority):
190.5. MvcEvent::EVENT_DISPATCH_ERROR
881
Console context only Table 190.10: MvcEvent::EVENT_DISPATCH_ERROR Listeners for Console context only Pri- Method Description or- Called ity Zend\Mvc\View\Console\RouteNotFoundStrategy 1 handleRouteNotFoundError Detect if an error is a route not found condition. If a controller not found or invalid controller error type is encountered, sets the response status code to 404. Zend\Mvc\View\Console\ExceptionStrategy 1 prepareExceptionViewModel Create an exception view model and set the status code to 404. Zend\Mvc\View\Console\InjectViewModelListener injectViewModel Inserts the ViewModel (in this case, a ConsoleModel) 100 and adds it to the MvcEvent object. It either (a) adds it as a child to the default, composed view model, or (b) replaces it if the result is marked as terminable. Http context only Those listeners are only attached in a Http context: Table 190.11: MvcEvent::EVENT_DISPATCH_ERROR Listeners for Http context only Pri- Method Description or- Called ity Zend\Mvc\View\Http\RouteNotFoundStrategy 1 detectNotFoundError Detect if an error is a 404 condition. If a controller not found or invalid controller error type is encountered, sets the response status code to 404. Zend\Mvc\View\Http\RouteNotFoundStrategy 1 prepareNotFoundViewModel Create and return a 404 view model. Zend\Mvc\View\Http\ExceptionStrategy 1 prepareExceptionViewModel Create an exception view model and set the status code to 404 Zend\Mvc\View\Http\InjectViewModelListener injectViewModel Inserts the ViewModel (in this case, a ViewModel) and 100 adds it to the MvcEvent object. It either (a) adds it as a child to the default, composed view model, or (b) replaces it if the result is marked as terminable. All contexts Those listeners are attached for both contexts: Table 190.12: MvcEvent::EVENT_DISPATCH_ERROR Listeners for both contexts Priority Zend\Mvc\DispatchListener 1 Class Method Called Description Class Class
882
190.5.2 Triggerers
Table 190.13: MvcEvent::EVENT_DISPATCH_ERROR Triggerers Class Zend\Mvc\DispatchListener Zend\Mvc\DispatchListener Zend\Mvc\DispatchListener In Method onDispatch marshallControllerNotFoundEvent marshallBadControllerEvent
190.6 MvcEvent::EVENT_RENDER
190.6.1 Listeners
The following classes are listening to this event (they are sorted from higher priority to lower priority): Console context only Those listeners are only attached in a Console context: Table 190.14: MvcEvent::EVENT_RENDER Listeners for Console context only Class Zend\Mvc\View\Console\DefaultRenderingStrategy Http context only Those listeners are only attached in a Http context: Table 190.15: MvcEvent::EVENT_RENDER Listeners for Http context only Class Zend\Mvc\View\Http\DefaultRenderingStrategy Priority -10000 Method Called render Description Render the view. Priority -10000 Method Called render Description Render the view.
190.6.2 Triggerers
This event is triggered by the following classes: Table 190.16: MvcEvent::EVENT_RENDER Triggerers Class Zend\Mvc\Application In Method completeRequest Description This event is triggered just before the MvcEvent::FINISH event.
190.7 MvcEvent::EVENT_RENDER_ERROR
190.7.1 Listeners
The following classes are listening to this event (they are sorted from higher priority to lower priority):
190.6. MvcEvent::EVENT_RENDER
883
Console context only Those listeners are only attached in a Console context: Table 190.17: MvcEvent::EVENT_RENDER_ERROR Listeners for Console context only Pri- Method Description or- Called ity Zend\Mvc\View\Console\ExceptionStrategy 1 prepareExceptionViewModel Create an exception view model and set the status code to 404. Zend\Mvc\View\Console\InjectViewModelListener injectViewModel Inserts the ViewModel (in this case, a ConsoleModel) 100 and adds it to the MvcEvent object. It either (a) adds it as a child to the default, composed view model, or (b) replaces it if the result is marked as terminable. Http context only Those listeners are only attached in a Http context: Table 190.18: MvcEvent::EVENT_RENDER_ERROR Listeners for Http context only Pri- Method Description or- Called ity Zend\Mvc\View\Console\ExceptionStrategy 1 prepareExceptionViewModel Create an exception view model and set the status code to 404. Zend\Mvc\View\Console\InjectViewModelListener injectViewModel Inserts the ViewModel (in this case, a ViewModel) and 100 adds it to the MvcEvent object. It either (a) adds it as a child to the default, composed view model, or (b) replaces it if the result is marked as terminable. Class Class
190.7.2 Triggerers
This event is triggered by the following classes: Table 190.19: MvcEvent::EVENT_RENDER_ERROR Triggerers In Description Method Zend\Mvc\View\Http\DefaultRenderingStrategy render This event is triggered if an exception is raised during rendering. Class
190.8 MvcEvent::EVENT_FINISH
190.8.1 Listeners
The following classes are listening to this event (they are sorted from higher priority to lower priority):
884
Table 190.20: MvcEvent::EVENT_FINISH Listeners Pri- Method Description orCalled ity Zend\Mvc\SendResponseListener sendResponse It triggers the SendResponseEvent in order to prepare the 10000 response (see the next page for more information about SendResponseEvent). Class
190.8.2 Triggerers
This event is triggered by the following classes: Table 190.21: MvcEvent::EVENT_FINISH Triggerers Class In Method Zend\Mvc\Application run Description This event is triggered once the MvcEvent::ROUTE event returns a correct ResponseInterface. Zend\Mvc\Application run This event is triggered once the MvcEvent::DISPATCH event returns a correct ResponseInterface. Zend\Mvc\Application completeRequest This event is triggered after the MvcEvent::RENDER (this means that, at this point, the view is already rendered).
190.8. MvcEvent::EVENT_FINISH
885
886
CHAPTER 191
The SendResponseEvent
The MVC layer of Zend Framework 2 also incorporates and utilizes a custom Zend\EventManager\Event implementation located at Zend\Mvc\ResponseSender\SendResponseEvent. This event allows listeners to update the response object, by setting headers and content. The methods it denes are: setResponse($response) getResponse() setContentSent() contentSent() setHeadersSent() headersSent()
191.1 Listeners
Currently, three listeners are listening to this event at different priorities based on which listener is used most. Table 191.1: SendResponseEvent Listeners PriMethod Description ority Called Zend\Mvc\SendResponseListener\PhpEnvironmentResponseSender __invoke This is used in context of HTTP 1000 (this is the most often used). Zend\Mvc\SendResponseListener\ConsoleResponseSender __invoke This is used in context of Console. 2000 Zend\Mvc\SendResponseListener\SimpleStreamResponseSender __invoke 3000 Because all these listeners have negative priorities, adding your own logic to modify Response object is easy: just add a new listener without any priority (it will default to 1) and it will always be executed rst. Class
887
191.2 Triggerers
This event is executed when MvcEvent::FINISH event is triggered, with a priority of -10000.
888
CHAPTER 192
Available Controllers
Controllers in the MVC layer simply need to be objects Zend\Stdlib\DispatchableInterface. That interface describes a single method:
1 2 3 4 5 6 7 8 9 10 11
implementing
use Zend\Stdlib\DispatchableInterface; use Zend\Stdlib\RequestInterface as Request; use Zend\Stdlib\ResponseInterface as Response; class Foo implements DispatchableInterface { public function dispatch(Request $request, Response $response = null) { // ... do something, and preferably return a Response ... } }
While this pattern is simple enough, chances are you dont want to implement custom dispatch logic for every controller (particularly as its not unusual or uncommon for a single controller to handle several related types of requests). The MVC also denes several interfaces that, when implemented, can provide controllers with additional capabilities.
$matches = $this->getEvent()->getRouteMatch(); $id = $matches->getParam(id, false); if (!$id) { $response = $this->getResponse(); $response->setStatusCode(500); $this->getEvent()->setResult(Invalid identifier; cannot complete request);
889
7 8
return; }
192.1.2 ServiceLocatorAware
In most cases, you should dene your controllers such that dependencies are injected by the applications ServiceManager, via either constructor arguments or setter methods. However, occasionally you may have objects you wish to use in your controller that are only valid for certain code paths. Examples include forms, paginators, navigation, etc. In these cases, you may decide that it doesnt make sense to inject those objects every time the controller is used. The ServiceLocatorAwareInterface interface hints to the ServiceManager that it should inject itself into the controller. It denes two simple methods:
1 2 3 4 5
use Zend\ServiceManager\ServiceLocatorInterface; use Zend\ServiceManager\ServiceLocatorAwareInterface; public function setServiceLocator(ServiceLocatorInterface $serviceLocator); public function getServiceLocator();
192.1.3 EventManagerAware
Typically, its nice to be able to tie into a controllers workow without needing to extend it or hardcode behavior into it. The solution for this at the framework level is to use the EventManager. You can hint to the ServiceManager that you want an EventManager injected by implementing the interface EventManagerAwareInterface, which tells the ServiceManager to inject an EventManager. You dene two methods. The rst, a setter, should also set any EventManager identiers you want to listen on, and the second, a getter, should simply return the composed EventManager instance.
1 2 3 4 5
use Zend\EventManager\EventManagerAwareInterface; use Zend\EventManager\EventManagerInterface; public function setEventManager(EventManagerInterface $events); public function getEventManager();
890
Invoking and dispatching additional controllers To facilitate these actions while also making them available to alternate controller implementations, weve created a PluginManager implementation for the controller layer, Zend\Mvc\Controller\PluginManager, building on the Zend\ServiceManager\AbstractPluginManager functionality. To utilize it, you simply need to implement the setPluginManager(PluginManager $plugins) method, and set up your code to use the controller-specic implementation by default:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
use Zend\Mvc\Controller\PluginManager; public function setPluginManager(PluginManager $plugins) { $this->plugins = $plugins; $this->plugins->setController($this); return $this; } public function getPluginManager() { if (!$this->plugins) { $this->setPluginManager(new PluginManager()); } return $this->plugins; } public function plugin($name, array $options = null) { return $this->getPluginManager()->get($name, $options); }
namespace Foo\Controller;
891
3 4 5 6 7 8 9 10 11 12 13 14 15 16
use Zend\Mvc\Controller\AbstractActionController; class BarController extends AbstractActionController { public function bazAction() { return array(title => __METHOD__); } public function batAction() { return array(title => __METHOD__); } }
892
DELETE maps to delete(), and requires that an id parameter exists in the route matches; that value is passed as an argument to the method. It should attempt to delete the given entity, and, if successful, return either a 200 or 204 response status. Additionally, you can map action methods to the AbstractRestfulController, just as you would in the AbstractActionController; these methods will be sufxed with Action, differentiating them from the RESTful methods listed above. This allows you to perform such actions as providing forms used to submit to the various RESTful methods, or to add RPC methods to your RESTful API.
893
894
CHAPTER 193
Controller Plugins
When using the AbstractActionController or AbstractRestfulController, or if you implement the setPluginManager method in your custom controllers, you have access to a number of pre-built plugins. Additionally, you can register your own custom plugins with the manager. The built-in plugins are: Zend\Mvc\Controller\Plugin\AcceptableViewModelSelector Zend\Mvc\Controller\Plugin\FlashMessenger Zend\Mvc\Controller\Plugin\Forward Zend\Mvc\Controller\Plugin\Identity Zend\Mvc\Controller\Plugin\Layout Zend\Mvc\Controller\Plugin\Params Zend\Mvc\Controller\Plugin\PostRedirectGet Zend\Mvc\Controller\Plugin\Redirect Zend\Mvc\Controller\Plugin\Url If your controller implements the setPluginManager, getPluginManager and plugin methods, you can access these using their shortname via the plugin() method:
1
$plugin = $this->plugin(url);
For an extra layer of convenience, both AbstractActionController and AbstractRestfulController have __call() implementations that allow you to retrieve plugins via method calls:
1
$plugin = $this->url();
895
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
use Zend\Mvc\Controller\AbstractActionController; use Zend\View\Model\JsonModel; class SomeController extends AbstractActionController { protected $acceptCriteria = array( Zend\View\Model\JsonModel => array( application/json, ), Zend\View\Model\FeedModel => array( application/rss+xml, ), ); public function apiAction() { $viewModel = $this->acceptableViewModelSelector($this->acceptCriteria); // Potentially vary execution based on model returned if ($viewModel instanceof JsonModel) { // ... } } }
The above would return a standard Zend\View\Model\ViewModel instance if the criteria is not met, and the specied view model types if the specic criteria is met. Rules are matched in order, with the rst match winning.
addMessage(string $message) Allows you to add a message to the current namespace of the session container. Return type Zend\Mvc\Controller\Plugin\FlashMessenger hasMessages() Lets you determine if there are any ash messages from the current namespace in the session container. Return type boolean getMessages() Retrieves the ash messages from the current namespace of the session container Return type array clearMessages() Clears all ash messages in current namespace of the session container. Returns true if messages were cleared, false if none existed. Return type boolean hasCurrentMessages() Indicates whether any messages were added during the current request. Return type boolean getCurrentMessages() Retrieves any messages added during the current request. Return type array clearCurrentMessages() Removes any messages added during the current request. Returns true if current messages were cleared, false if none existed. Return type boolean Additionally, the FlashMessenger implements both IteratorAggregate and Countable, allowing you to iterate over and count the ash messages in the current namespace within the session container.
Examples public function processAction() { // ... do some work ... $this->flashMessenger()->addMessage(You are now logged in.); return $this->redirect()->toRoute(user-success); } public function successAction() { $return = array(success => true); $flashMessenger = $this->flashMessenger(); if ($flashMessenger->hasMessages()) { $return[messages] = $flashMessenger->getMessages(); } return $return; }
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
897
$foo = $this->forward()->dispatch(foo, array(action => process)); return array( somekey => $somevalue, foo => $foo, );
public function testAction() { if ($user = $this->identity()) { // someone is logged ! } else { // not logged in } }
When invoked, the Identity plugin will look for a service by the name or alias Zend\Authentication\AuthenticationService in the ServiceManager. You can provide this service to the ServiceManager in a conguration le:
1 2 3 4 5
// In a configuration file... return array( service_manager => array( aliases => array( Zend\Authentication\AuthenticationService => my_auth_service,
898
6 7 8 9 10 11
The Identity plugin exposes two methods: setAuthenticationService(Zend\Authentication\AuthenticationService $authenticationService) Sets the authentication service instance to be used by the plugin. Return type void getAuthenticationService() Retrieves the current authentication service instance if any is attached. Return type Zend\Authentication\AuthenticationService
$this->layout()->setTemplate(layout/newlayout);
It also implements the __invoke magic method, which allows for even easier setting of the template:
1
$this->layout(layout/newlayout);
fromRoute(string $param = null, mixed $default = null) For retrieving all or one single route parameter. If $param is null, all route parameters will be returned. Return type mixed It also implements the __invoke magic method, which allows for short circuiting to the fromRoute method:
1 2 3
// Pass in the route/url you want to redirect to after the POST $prg = $this->prg(/user/register, true); if ($prg instanceof \Zend\Http\PhpEnvironment\Response) { // returned a response to redirect us return $prg; } elseif ($prg === false) { // this wasnt a POST request, but there were no params in the flash messenger // probably this is the first time the form was loaded return array(form => $myForm); } // $prg is an array containing the POST params from the previous request $form->setData($prg); // ... your form processing code here
Warning: You must attach a Filter for moving the uploaded les to a new location, such as the RenameUpload Filter, or else your les will be removed upon the redirect. This plugin can be invoked with three arguments: $form: the form instance. $redirect: (Optional) a string containing the redirect location which can either be a named route or a URL, based on the contents of the third parameter. If this argument is not provided, it will default to the current matched route. $redirectToUrl: (Optional) a boolean that when set to TRUE, causes the second parameter to be treated as a URL instead of a route name (this is required when redirecting to a URL instead of a route). This argument defaults to false.
Example Usage $myForm = new Zend\Form\Form(my-form); $myForm->add(array( type => Zend\Form\Element\File, name => file, )); // NOTE: Without a filter to move the file, // our files will disappear between the requests $myForm->getInputFilter()->getFilterChain()->attach( new Zend\Filter\File\RenameUpload(array( target => ./data/tmpuploads/file, randomize => true, )) ); // Pass in the route/url you want to redirect to after the POST $prg = $this->prg($myForm, /user/profile-pic, true); if ($prg instanceof \Zend\Http\PhpEnvironment\Response) { // Returned a response to redirect us return $prg; } elseif ($prg === false) { // First time the form was loaded return array(form => $myForm); } // Form was submitted. // $prg is now an array containing the POST params from the previous request, // but we dont have to apply it to the form since that has already been done. // Process the form if ($form->isValid()) { // ...Save the form... return $this->redirect()->toRoute(/user/profile-pic/success); } else { // Form not valid, but file uploads might be valid and uploaded $fileErrors = $form->get(file)->getMessages(); if (empty($fileErrors)) { $tempFile = $form->get(file)->getValue(); } }
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
901
return $this->redirect()->toRoute(login-success);
The fromRoute() method is the only public method dened, and has the following signature:
1
Note: This plugin requires that the controller invoking it implements InjectApplicationEventInterface, and thus has an MvcEvent composed, as it retrieves the router from the event object.
902
CHAPTER 194
Examples
194.1 Controllers
194.1.1 Accessing the Request and Response
When using AbstractActionController or AbstractRestfulController, the request and response object are composed directly into the controller as soon as dispatch() is called. You may access them in the following ways:
1 2 3 4 5 6 7
// Using explicit accessor methods $request = $this->getRequest(); $response = $this->getResponse(); // Using direct property access $request = $this->request; $response = $this->response;
Additionally, if your controller implements InjectApplicationEventInterface (as both AbstractActionController and AbstractRestfulController do), you can access these objects from the attached MvcEvent:
1 2 3
The above can be useful when composing event listeners into your controller.
903
Once you have the RouteMatch object, you can pull parameters from it. The same can be done using the Params plugin.
194.2 Bootstrapping
194.2.1 Registering module-specic listeners
Often you may want module-specic listeners. As an example, this would be a simple and effective way to introduce authorization, logging, or caching into your application. Each Module class can have an optional onBootstrap() method. Typically, youll do module-specic conguration here, or setup event listeners for you module here. The onBootstrap() method is called for every module on every page request and should only be used for performing lightweight tasks such as registering event listeners. The base Application class shipped with the framework has an EventManager associated with it, and once the modules are initialized, it triggers the bootstrap event, with a getApplication() method on the event. So, one way to accomplish module-specic listeners is to listen to that event, and register listeners at that time. As an example:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
namespace SomeCustomModule; class Module { /** * @param \Zend\Mvc\MvcEvent $e The MvcEvent instance * @return void */ public function onBootstrap($e) { $application = $e->getApplication(); $config = $application->getConfig(); $view = $application->getServiceManager()->get(ViewHelperManager); // You must have these keys in you application config $view->headTitle($config[view][base_title]); // This is your custom listener $listener = new Listeners\ViewListener(); $listener->setView($view); $application->getEventManager()->attachAggregate($listener); } }
The above demonstrates several things. First, it demonstrates a listener on the applications bootstrap event (the onBootstrap() method). Second, it demonstrates that listener, and how it can be used to register listeners with
904
the application. It grabs the Application instance; from the Application, it is able to grab the attached service manager and conguration. These are then used to retrieve the view, congure some helpers, and then register a listener aggregate with the application event manager.
194.2. Bootstrapping
905
906
CHAPTER 195
Introduction to Zend\Navigation
Zend\Navigation is a component for managing trees of pointers to web pages. Simply put: It can be used for creating menus, breadcrumbs, links, and sitemaps, or serve as a model for other navigation related purposes.
195.1.1 Pages
A page (Zend\Navigation\AbstractPage) in Zend\Navigation in its most basic form is an object that holds a pointer to a web page. In addition to the pointer itself, the page object contains a number of other properties that are typically relevant for navigation, such as label, title, etc. Read more about pages in the pages section.
195.1.2 Containers
A navigation container (Zend\Navigation\AbstractContainer) is a container class for pages. It has methods for adding, retrieving, deleting and iterating pages. It implements the SPL interfaces RecursiveIterator and Countable, and can thus be iterated with SPL iterators such as RecursiveIteratorIterator. Read more about containers in the containers section. Note: Zend\Navigation\AbstractPage extends Zend\Navigation\AbstractContainer, which means that a page can have sub pages.
907
908
CHAPTER 196
Quick Start
The fastest way to get up and running with Zend\Navigation is by the navigation key in your service manager conguration and the navigation factory will handle the rest for you. After setting up the conguration simply use the key name with the Zend\Navigation view helper to output the container.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
<?php // your configuration file, e.g., config/autoload/global.php return array( // ... navigation => array( default => array( array( label => Home, route => home, ), array( label => Page #1, route => page-1, pages => array( array( label => Child #1, route => page-1-child, ), ), ), array( label => Page #2, route => page-2, ), ), ), service_manager => array( factories => array( navigation => Zend\Navigation\Service\DefaultNavigationFactory, ), ), // ... );
909
1 2 3 4 5 6 7
<!-- in your layout --> <!-- ... --> <body> <?php echo $this->navigation(navigation)->menu(); ?> </body> <!-- ... -->
910
CHAPTER 197
Pages
Zend\Navigation ships with two page types: MVC pages using the class Zend\Navigation\Page\Mvc URI pages using the class Zend\Navigation\Page\Uri MVC pages are link to on-site web pages, and are dened using MVC parameters (action, controller, route, params). URI pages are dened by a single property uri, which give you the full exibility to link off-site pages or do other things with the generated links (e.g. an URI that turns into <a href="#">foo<a>).
911
912
CHAPTER 198
All page classes must extend Zend\Navigation\Page\AbstractPage, and will thus share a common set of features and properties. Most notably they share the options in the table below and the same initialization process. Option keys are mapped to set methods. This means that the option order maps to the method setOrder(), and reset_params maps to the method setResetParams(). If there is no setter method for the option, it will be set as a custom property of the page. Read more on extending Zend\Navigation\Page\AbstractPage in Creating custom page types.
913
Table 198.1: Common page options Key Type laString bel frag- String | NULL ment De- Description fault NULLA page label, such as Home or Blog.
NULLA fragment identier (anchor identier) pointing to an anchor within a resource that is subordinate to another, primary resource. The fragment identier introduced by a hash mark #. Example: http://www.example.org/foo.html#bar (bar is the fragment identier) id String | Integer NULLAn id tag/attribute that may be used when rendering the page, typically in an anchor element. class String NULLA CSS class that may be used when rendering the page, typically in an anchor element. tiString NULLA short page description, typically for using as the title attribute tle in an anchor. tar- String NULLSpecies a target that may be used for the page, typically in an get anchor element. rel Array arSpecies forward relations for the page. Each element in the ray() array is a key-value pair, where the key designates the relation/link type, and the value is a pointer to the linked page. An example of a key-value pair is alternate => format/plain.html. To allow full exibility, there are no restrictions on relation values. The value does not have to be a string. Read more about rel and rev in the section on the Links helper. rev Array arSpecies reverse relations for the page. Works exactly like rel. ray() or- String | Integer | NULL NULLWorks like order for elements in Zend\Form. If specied, the der page will be iterated in a specic order, meaning you can force a page to be iterated before others by setting the order attribute to a low number, e.g. -100. If a String is given, it must parse to a valid int. If NULL is given, it will be reset, meaning the order in which the page was added to the container will be used. reString | NULLACL resource to associate with the page. Read more in the sourceZend\Permissions\Acl\Resource\ResourceInterface section on ACL integration in view helpers. | NULL priv- String | NULL NULLACL privilege to associate with the page. Read more in the isection on ACL integration in view helpers. lege ac- Boolean FALSE Whether the page should be considered active for the current tive request. If active is FALSE or not given, MVC pages will check its properties against the request object upon calling $page->isActive(). vis- Boolean TRUEWhether page should be visible for the user, or just be a part of ithe structure. Invisible pages are skipped by view helpers. ble pages Array | Zend\Config | NULL NULLChild pages of the page. This could be an Array or Zend\Config object containing either page options that can be passed to the factory() method, or actual Zend\Navigation\Page\AbstractPage instances, or a mixture of both.
914
Note: Custom properties All pages support setting and getting of custom properties by use of the magic methods __set($name, $value), __get($name), __isset($name) and __unset($name). Custom properties may have any value, and will be included in the array that is returned from $page->toArray(), which means that pages can be serialized/deserialized successfully even if the pages contains properties that are not native in the page class. Both native and custom properties can be set using $page->set($name, $value) and retrieved using $page->get($name), or by using magic methods.
$page = new Zend\Navigation\Page\Mvc(); $page->foo = bar; $page->meaning = 42; echo $page->foo; if ($page->meaning != 42) { // action should be taken }
915
916
CHAPTER 199
Zend\Navigation\Page\Mvc
MVC pages are dened using MVC parameters known from the Zend\Mvc component. An MVC page will use Zend\Mvc\Router\RouteStackInterface internally in the getHref() method to generate hrefs, and the isActive() method will compare the Zend\Mvc\Router\RouteMatch params with the pages params to determine if the page is active. Note: Starting in version 2.2.0, if you want to re-use any matched route parameters when generating a link, you can do so via the useRouteMatch ag. This is particularly useful when creating segment routes that include the currently selected language or locale as an initial segment, as it ensures the links generated all include the matched value.
Table 199.1: MVC page options DeDescription fault action String NULL Action name to use when generating href to the page. controller String NULL Controller name to use when generating href to the page. params Array arUser params to use when generating href to the page. ray() route String NULL Route name to use when generating href to the page. routeMZend\Mvc\Router\RouteMatch NULL RouteInterface matches used for routing parameters atch and testing validity. useRouteM- Boolean FALSE If true, then getHref method will use the routeMatch atch parameters to assemble the URI router Zend\Mvc\Router\RouteStackInterface NULL Router for assembling URLs Note: The URI returned is relative to the baseUrl in Zend\Mvc\Router\Http\TreeRouteStack. In the examples, the baseUrl is / for simplicity. Key Type
This example show that MVC pages use Zend\Mvc\Router\RouteStackInterface internally to generate URI s when calling $page->getHref().
917
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
// Create route $route = Zend\Mvc\Router\Http\Segment::factory(array( route => /[:controller[/:action][/:id]], constraints => array( controller => [a-zA-Z][a-zA-Z0-9_-]+, action => [a-zA-Z][a-zA-Z0-9_-]+, id => [0-9]+, ), array( controller => Album\Controller\Album, action => index, ) )); $router = new Zend\Mvc\Router\Http\TreeRouteStack(); $router->addRoute(default, $route); // getHref() returns /album/add $page = new Zend\Navigation\Page\Mvc(array( action => add, controller => album, )); // getHref() returns /album/edit/1337 $page = new Zend\Navigation\Page\Mvc(array( action => edit, controller => album, params => array(id => 1337), ));
This example show that MVC pages determine whether they are active by using the params found in the route match object.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/** * Dispatched request: * - controller: album index * - action: */ $page1 = new Zend\Navigation\Page\Mvc(array( action => index, controller => album, )); $page2 = new Zend\Navigation\Page\Mvc(array( action => edit, controller => album, )); $page1->isActive(); // returns true $page2->isActive(); // returns false /** * Dispatched request: * - controller: album edit * - action: 1337 * - id:
918
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
*/ $page = new Zend\Navigation\Page\Mvc(array( action => edit, controller => album, params => array(id => 1337), )); // returns true, because request has the same controller and action $page->isActive(); /** * Dispatched request: * - controller: album edit * - action: / * $page = new Zend\Navigation\Page\Mvc(array( action => edit, controller => album, params => array(id => null), )); // returns false, because page requires the id param to be set in the request $page->isActive(); // returns false
Using routes
Routes can be used with MVC pages. If a page has a route, this route will be used in getHref() to generate the URL for the page. Note: Note that when using the route property in a page, you do not need to specify the default params that the route denes (controller, action, etc.).
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
// the following route is added to the ZF router $route = Zend\Mvc\Router\Http\Segment::factory(array( route => /a/:id, constraints => array( id => [0-9]+, ), array( controller => Album\Controller\Album, action => show, ) )); $router = new Zend\Mvc\Router\Http\TreeRouteStack(); $router->addRoute(albumShow, $route); // a page is created with a route option $page = new Zend\Navigation\Page\Mvc(array( label => Show album, route => albumShow, params => array(id => 42) )); // returns: /a/42 $page->getHref();
919
920
CHAPTER 200
Zend\Navigation\Page\Uri
Pages of type Zend\Navigation\Page\Uri can be used to link to pages on other domains or sites, or to implement custom logic for the page. URI pages are simple; in addition to the common page options, a URI page takes only one option uri. The uri will be returned when calling $page->getHref(), and may be a String or NULL. Note: Zend\Navigation\Page\Uri will not try to determine whether it should be active when calling $page->isActive(). It merely returns what currently is set, so to make a URI page active you have to manually call $page->setActive() or specifying active as a page option when constructing.
Table 200.1: URI page options Key uri Type String Default NULL Description URI to page. This can be any string or NULL.
921
922
CHAPTER 201
When extending Zend\Navigation\Page\AbstractPage, there is usually no need to override the constructor or the methods setOptions() or setConfig(). The page constructor takes a single parameter, an Array or a Zend\Config object, which is passed to setOptions() or setConfig() respectively. Those methods will in turn call set() method, which will map options to native or custom properties. If the option internal_id is given, the method will rst look for a method named setInternalId(), and pass the option to this method if it exists. If the method does not exist, the option will be set as a custom property of the page, and be accessible via $internalId = $page->internal_id; or $internalId = $page->get(internal_id);.
The most simple custom page
The only thing a custom page class needs to implement is the getHref() method.
1 2 3 4 5 6 7
When adding properties to an extended page, there is no need to override/modify setOptions() or setConfig().
1 2 3 4 5 6 7 8 9 10 11
class My\Navigation\Page extends Zend\Navigation\Page\AbstractPage { protected $foo; protected $fooBar; public function setFoo($foo) { $this->foo = $foo; } public function getFoo()
923
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
{ return $this->foo; } public function setFooBar($fooBar) { $this->fooBar = $fooBar; } public function getFooBar() { return $this->fooBar; } public function getHref() { return $this->foo . / . $this->fooBar; } } // can now construct using $page = new My\Navigation\Page(array( label => Property names are mapped to setters, foo => bar, foo_bar => baz )); // ...or $page = Zend\Navigation\Page\AbstractPage::factory(array( type => My\Navigation\Page, label => Property names are mapped to setters, foo => bar, foo_bar => baz ));
924
CHAPTER 202
All pages (also custom classes), can be created using the page factory, Zend\Navigation\Page\AbstractPage::factory(). The factory can take an array with options, or a Zend\Config object. Each key in the array/cong corresponds to a page option, as seen in the section on Pages. If the option uri is given and no MVC options are given (action, controller, route), an URI page will be created. If any of the MVC options are given, an MVC page will be created. If type is given, the factory will assume the value to be the name of the class that should be created. If the value is mvc or uri and MVC/URI page will be created.
Creating an MVC page using the page factory $page = Zend\Navigation\Page\AbstractPage::factory(array( label => My MVC page, action => index, )); $page = Zend\Navigation\Page\AbstractPage::factory(array( label => Search blog, action => index, controller => search, )); $page = Zend\Navigation\Page\AbstractPage::factory(array( label => Home, route => home, )); $page = Zend\Navigation\Page\AbstractPage::factory(array( type => mvc, label => My MVC page, ));
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
Creating a URI page using the page factory $page = Zend\Navigation\Page\AbstractPage::factory(array( label => My URI page,
1 2
925
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
uri ));
=> http://www.example.com/,
$page = Zend\Navigation\Page\AbstractPage::factory(array( label => Search, uri => http://www.example.com/search, active => true, )); $page = Zend\Navigation\Page\AbstractPage::factory(array( label => My URI page, uri => #, )); $page = Zend\Navigation\Page\AbstractPage::factory(array( type => uri, label => My URI page, ));
To create a custom page type using the factory, use the option type to specify a class name to instantiate.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
class My\Navigation\Page extends Zend\Navigation\Page\AbstractPage { protected $_fooBar = ok; public function setFooBar($fooBar) { $this->_fooBar = $fooBar; } } $page = Zend\Navigation\Page\AbstractPage::factory(array( type => My\Navigation\Page, label => My custom page, foo_bar => foo bar, ));
926
CHAPTER 203
Containers
Containers have methods for adding, retrieving, deleting and iterating pages. Containers implement the SPL interfaces RecursiveIterator and Countable, meaning that a container can be iterated using the SPL RecursiveIteratorIterator class.
Zend\Navigation\Navigation can be constructed entirely empty, or take an array or a Zend\Config\Config object with pages to put in the container. Each page in the given array/cong will eventually be passed to the addPage() method of the container class, which means that each element in the array/cong can be an array, a cong object or a Zend\Navigation\Page\AbstractPage instance.
Creating a container using an array
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
/* * Create a container from an array * * Each element in the array will be passed to * Zend\Navigation\Page\AbstractPage::factory() when constructing. */ $container = new Zend\Navigation\Navigation(array( array( label => Page 1, id => home-link, uri => /, ), array( label => Zend, uri => http://www.zend-project.com/, order => 100, ), array( label => Page 2, controller => page2,
927
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
pages => array( array( label => Page 2.1, action => page2_1, controller => page2, class => special-one, title => This element has a special class, active => true, ), array( label => Page 2.2, action => page2_2, controller => page2, class => special-two, title => This element has a special class too, ), ), ), array( label => Page 2 with params, action => index, controller => page2, // specify a param or two, params => array( format => json, foo => bar, ) ), array( label => Page 2 with params and a route, action => index, controller => page2, // specify a route name and a param for the route route => nav-route-example, params => array( format => json, ), ), array( label => Page 3, action => index, controller => index, module => mymodule, reset_params => false, ), array( label => Page 4, uri => #, pages => array( array( label => Page 4.1, uri => /page4, title => Page 4 using uri, pages => array( array( label => Page 4.1.1, title => Page 4 using mvc params, action => index,
928
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
controller => page4, // lets say this page is active active => 1, ) ), ), ), ), array( label => Page 0?, uri => /setting/the/order/option, // setting order to -1 should make it appear first order => -1, ), array( label => Page 5, uri => /, // this page should not be visible visible => false, pages => array( array( label => Page 5.1, uri => #, pages => array( array( label => Page 5.1.1, uri => #, pages => array( array( label => Page 5.1.2, uri => #, // lets say this page is active active => true, ), ), ), ), ), ), ), array( label => ACL page 1 (guest), uri => #acl-guest, resource => nav-guest, pages => array( array( label => ACL page 1.1 (foo), uri => #acl-foo, resource => nav-foo, ), array( label => ACL page 1.2 (bar), uri => #acl-bar, resource => nav-bar, ), array( label => ACL page 1.3 (baz), uri => #acl-baz,
929
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
resource => nav-baz, ), array( label => ACL page 1.4 (bat), uri => #acl-bat, resource => nav-bat, ), ), ), array( label => ACL page 2 (member), uri => #acl-member, resource => nav-member, ), array( label => ACL page 3 (admin, uri => #acl-admin, resource => nav-admin, pages => array( array( label => ACL page 3.1 (nothing), uri => #acl-nada, ), ), ), array( label => Zend Framework, route => zf-route, ), ));
Creating a container using a cong object /* CONTENTS OF /path/to/navigation.xml: <?xml version="1.0" encoding="UTF-8"?> <nav> <zend> <label>Zend</label> <uri>http://www.zend-project.com/</uri> <order>100</order> </zend> <page1> <label>Page 1</label> <uri>page1</uri> <pages> <page1_1> <label>Page 1.1</label> <uri>page1/page1_1</uri> </page1_1> </pages> </page1>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
930
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
<page2> <label>Page 2</label> <uri>page2</uri> <pages> <page2_1> <label>Page 2.1</label> <uri>page2/page2_1</uri> </page2_1> <page2_2> <label>Page 2.2</label> <uri>page2/page2_2</uri> <pages> <page2_2_1> <label>Page 2.2.1</label> <uri>page2/page2_2/page2_2_1</uri> </page2_2_1> <page2_2_2> <label>Page 2.2.2</label> <uri>page2/page2_2/page2_2_2</uri> <active>1</active> </page2_2_2> </pages> </page2_2> <page2_3> <label>Page 2.3</label> <uri>page2/page2_3</uri> <pages> <page2_3_1> <label>Page 2.3.1</label> <uri>page2/page2_3/page2_3_1</uri> </page2_3_1> <page2_3_2> <label>Page 2.3.2</label> <uri>page2/page2_3/page2_3_2</uri> <visible>0</visible> <pages> <page2_3_2_1> <label>Page 2.3.2.1</label> <uri>page2/page2_3/page2_3_2/1</uri> <active>1</active> </page2_3_2_1> <page2_3_2_2> <label>Page 2.3.2.2</label> <uri>page2/page2_3/page2_3_2/2</uri> <active>1</active> <pages> <page_2_3_2_2_1>
931
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
<label>Ignore</label> <uri>#</uri> <active>1</active> </page_2_3_2_2_1> </pages> </page2_3_2_2> </pages> </page2_3_2> <page2_3_3> <label>Page 2.3.3</label> <uri>page2/page2_3/page2_3_3</uri> <resource>admin</resource> <pages> <page2_3_3_1> <label>Page 2.3.3.1</label> <uri>page2/page2_3/page2_3_3/1</uri> <active>1</active> </page2_3_3_1> <page2_3_3_2> <label>Page 2.3.3.2</label> <uri>page2/page2_3/page2_3_3/2</uri> <resource>guest</resource> <active>1</active> </page2_3_3_2> </pages> </page2_3_3> </pages> </page2_3> </pages> </page2> <page3> <label>Page 3</label> <uri>page3</uri> <pages> <page3_1> <label>Page 3.1</label> <uri>page3/page3_1</uri> <resource>guest</resource> </page3_1> <page3_2> <label>Page 3.2</label> <uri>page3/page3_2</uri> <resource>member</resource> <pages> <page3_2_1> <label>Page 3.2.1</label> <uri>page3/page3_2/page3_2_1</uri>
932
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
</page3_2_1> <page3_2_2> <label>Page 3.2.2</label> <uri>page3/page3_2/page3_2_2</uri> <resource>admin</resource> </page3_2_2> </pages> </page3_2> <page3_3> <label>Page 3.3</label> <uri>page3/page3_3</uri> <resource>special</resource> <pages> <page3_3_1> <label>Page 3.3.1</label> <uri>page3/page3_3/page3_3_1</uri> <visible>0</visible> </page3_3_1> <page3_3_2> <label>Page 3.3.2</label> <uri>page3/page3_3/page3_3_2</uri> <resource>admin</resource> </page3_3_2> </pages> </page3_3> </pages> </page3> <home> <label>Home</label> <order>-100</order> <module>default</module> <controller>index</controller> <action>index</action> </home> </nav> */ $reader = new Zend\Config\Reader\Xml(); $config = $reader->fromFile(/path/to/navigation.xml); $container = new Zend\Navigation\Navigation($config);
933
Adding pages to a container // create container $container = new Zend\Navigation\Navigation(); // add page by giving a page instance $container->addPage( Zend\Navigation\Page\AbstractPage::factory( array( uri => http://www.example.com/, ) ) ); // add page by giving an array $container->addPage( array( uri => http://www.example.com/, ) ); // add page by giving a config object $container->addPage( new Zend\Config\Config( array( uri => http://www.example.com/, ) ) ); $pages = array( array( label => action => ), array( label => action => ) );
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
Save, save,
Delete, delete,
// add two pages $container->addPages($pages); // remove existing pages and add the given pages $container->setPages($pages);
934
Removing pages from a container $container = new array( label action ), array( label action order ), array( label action ) )); Zend\Navigation\Navigation(array( => Page 1, => page1,
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
// remove page by implicit page order $container->removePage(0); // removes Page 1 // remove page by instance $page3 = $container->findOneByAction(page3); $container->removePage($page3); // removes Page 3 // remove page by explicit page order $container->removePage(200); // removes Page 2 // remove all pages $container->removePages();
1 2 3 4 5 6 7
935
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
label => Page 1.1, uri => page-1.1, foo => bar, ), array( label => Page 1.2, uri => page-1.2, class => my-class, ), array( type => uri, label => Page 1.3, uri => page-1.3, action => about, ) ) ), array( label id class module controller action ), array( label id module controller ), )); // The id is not required to be unique, but be aware that // having two pages with the same id will render the same id // in menus and breadcrumbs. $found = $container->findBy(id, page_2_and_3); // returns $found = $container->findOneBy(id, page_2_and_3); // returns $found = $container->findBy(id, page_2_and_3, true); // returns $found = $container->findById(page_2_and_3); // returns $found = $container->findOneById(page_2_and_3); // returns $found = $container->findAllById(page_2_and_3); // returns // Find all matching CSS class my-class $found = $container->findAllBy(class, my-class); $found = $container->findAllByClass(my-class); // Find first matching CSS class my-class $found = $container->findOneByClass(my-class);
attribute
Page 2 Page 2
// returns Page 1.2 and Page 2 // returns Page 1.2 and Page 2
// Find all matching CSS class non-existant $found = $container->findAllByClass(non-existant); // returns array()
936
66 67 68 69 70 71 72 73 74 75 76 77 78
// Find first matching CSS class non-existant $found = $container->findOneByClass(non-existant); // returns null // Find all pages with custom property foo = bar $found = $container->findAllBy(foo, bar); // returns Page 1 and Page 1.1 // To achieve the same magically, foo must be in lowercase. // This is because foo is a custom property, and thus the // property name is not normalized to Foo $found = $container->findAllByfoo(bar); // Find all with controller = index $found = $container->findAllByController(index); // returns Page 2 and Page 3
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
937
34 35 36 37 38 39 40 41 42
// Iterate recursively using RecursiveIteratorIterator $it = new RecursiveIteratorIterator( $container, RecursiveIteratorIterator::SELF_FIRST); // Output: Page 1, Page 2, Page 2.1, Page 2.2, Page 3 foreach ($it as $page) { echo $page->label; }
$container = new Zend\Navigation\Navigation(array( array( label => Page 1, uri => #, ), array( label => Page 2, uri => #, pages => array( array( label => Page 2.1, uri => #, ), array( label => Page 2.2, uri => #, ), ), ), )); var_dump($container->toArray()); /* Output: array(2) { [0]=> array(15) { ["label"]=> string(6) "Page 1" ["id"]=> NULL ["class"]=> NULL ["title"]=> NULL ["target"]=> NULL ["rel"]=> array(0) { } ["rev"]=> array(0) {
938
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
} ["order"]=> NULL ["resource"]=> NULL ["privilege"]=> NULL ["active"]=> bool(false) ["visible"]=> bool(true) ["type"]=> string(23) "Zend\Navigation\Page\Uri" ["pages"]=> array(0) { } ["uri"]=> string(1) "#" } [1]=> array(15) { ["label"]=> string(6) "Page 2" ["id"]=> NULL ["class"]=> NULL ["title"]=> NULL ["target"]=> NULL ["rel"]=> array(0) { } ["rev"]=> array(0) { } ["order"]=> NULL ["resource"]=> NULL ["privilege"]=> NULL ["active"]=> bool(false) ["visible"]=> bool(true) ["type"]=> string(23) "Zend\Navigation\Page\Uri" ["pages"]=> array(2) { [0]=> array(15) { ["label"]=> string(8) "Page 2.1" ["id"]=> NULL ["class"]=> NULL ["title"]=> NULL ["target"]=> NULL ["rel"]=> array(0) { } ["rev"]=> array(0) { } ["order"]=> NULL ["resource"]=> NULL ["privilege"]=> NULL ["active"]=> bool(false) ["visible"]=> bool(true) ["type"]=> string(23) "Zend\Navigation\Page\Uri" ["pages"]=> array(0) { } ["uri"]=> string(1) "#" } [1]=> array(15) { ["label"]=> string(8) "Page 2.2" ["id"]=> NULL ["class"]=> NULL ["title"]=> NULL ["target"]=> NULL ["rel"]=> array(0) { } ["rev"]=> array(0) {
939
} ["order"]=> NULL ["resource"]=> NULL ["privilege"]=> NULL ["active"]=> bool(false) ["visible"]=> bool(true) ["type"]=> string(23) "Zend\Navigation\Page\Uri" ["pages"]=> array(0) { } ["uri"]=> string(1) "#" } } ["uri"]=> string(1) "#" } } */
940
CHAPTER 204
View Helpers
The navigation helpers are used for rendering navigational elements from Zend\Navigation\Navigation instances. There are 5 built-in helpers: Breadcrumbs, used for rendering the path to the currently active page. Links, used for rendering navigational head links (e.g. <link rel="next" href="..." />) Menu, used for rendering menus. Sitemap, used for rendering sitemaps conforming to the Sitemaps XML format. Navigation, used for proxying calls to other navigational helpers. All built-in helpers extend Zend\View\Helper\Navigation\AbstractHelper, adds integration with ACL and translation. The abstract class implements the Zend\View\Helper\Navigation\HelperInterface, which denes the following methods: which interface
getContainer() and setContainer() gets and sets the navigation container the helper should operate on by default, and hasContainer() checks if the helper has container registered. getTranslator() and setTranslator() gets and sets the translator used for translating labels and titles. getUseTranslator() and setUseTranslator() controls whether the translator should be enabled. The method hasTranslator() checks if the helper has a translator registered. getAcl(), setAcl(), getRole() and setRole(), (Zend\Permissions\Acl\AclInterface) instance and Zend\Permissions\Acl\Role\RoleInterface) used for ltering getUseAcl() and setUseAcl() controls whether ACL should be enabled. hasRole() checks if the helper has an ACL instance or a role registered. gets and sets ACL role (String or out pages when rendering. The methods hasAcl() and
__toString(), magic method to ensure that helpers can be rendered by echoing the helper instance directly. render(), must be implemented by concrete helpers to do the actual rendering. In addition to the method stubs from the interface, the abstract class also implements the following methods: getIndent() and setIndent() gets and sets indentation. The setter accepts a String or an Integer. In the case of an Integer, the helper will use the given number of spaces for indentation. I.e., setIndent(4) means 4 initial spaces of indentation. Indentation can be specied for all helpers except the Sitemap helper. getMinDepth() and setMinDepth() gets and sets the minimum depth a page must have to be included by the helper. Setting NULL means no minimum depth. 941
getMaxDepth() and setMaxDepth() gets and sets the maximum depth a page can have to be included by the helper. Setting NULL means no maximum depth. getRenderInvisible() and setRenderInvisible() gets and sets whether to render items that have been marked as invisible or not. __call() is used for proxying calls to the container registered in the helper, which means you can call methods on a helper as if it was a container. See example below. findActive($container, $minDepth, $maxDepth) is used for nding the deepest active page in the given container. If depths are not given, the method will use the values retrieved from getMinDepth() and getMaxDepth(). The deepest active page must be between $minDepth and $maxDepth inclusively. Returns an array containing a reference to the found page instance and the depth at which the page was found. htmlify() renders an a HTML element from a Zend\Navigation\Page\AbstractPage instance. accept() is used for determining if a page should be accepted when iterating containers. This method checks for page visibility and veries that the helpers role is allowed access to the pages resource and privilege. The static method setDefaultAcl() is used for setting a default ACL object that will be used by helpers. The static method setDefaultRole() is used for setting a default Role that will be used by helpers If a container is not explicitly set, the helper will create an empty Zend\Navigation\Navigation container when calling $helper->getContainer().
Proxying calls to the navigation container
Navigation view helpers use the magic method __call() to proxy method calls to the navigation container that is registered in the view helper.
1 2 3
The call above will add a page to the container in the Navigation helper.
942
Zend\Permissions\Acl\Role\GenericRole(member)). If ACL is used in the helper, the role in the helper must be allowed by the ACL to access a pages resource and/or have the pages privilege for the page to be included when rendering. If a page is not accepted by ACL, any descendant page will also be excluded from rendering. The proxy helper will inject its own ACL and role to the helper it proxies to if the proxied helper doesnt already have any. The examples below all show how ACL affects rendering.
/* * Navigation container (config/array) * Each element in the array will be passed to * Zend\Navigation\Page\AbstractPage::factory() when constructing * the navigation container below. */ $pages = array( array( label => Home, title => Go Home, module => default, controller => index, action => index, order => -100 // make sure home is the first page ), array( label => Special offer this week only!, module => store, controller => offer, action => amazing, visible => false // not visible ), array( label => Products, module => products, controller => index, action => index, pages => array( array( label => Foo Server, module => products, controller => server,
943
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
action => index, pages => array( array( label => FAQ, module => products, controller => server, action => faq, rel => array( canonical => http://www.example.com/?page=faq, alternate => array( module => products, controller => server, action => faq, params => array(format => xml) ) ) ), array( label => Editions, module => products, controller => server, action => editions ), array( label => System Requirements, module => products, controller => server, action => requirements ) ) ), array( label => Foo Studio, module => products, controller => studio, action => index, pages => array( array( label => Customer Stories, module => products, controller => studio, action => customers ), array( label => Support, module => products, controller => studio, action => support ) ) ) ) ), array( label title module controller
944
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
action => index, pages => array( array( label => Investor Relations, module => company, controller => about, action => investors ), array( label => News, class => rss, // class module => company, controller => news, action => index, pages => array( array( label => Press Releases, module => company, controller => news, action => press ), array( label => Archive, route => archive, // route module => company, controller => news, action => archive ) ) ) ) ), array( label => Community, module => community, controller => index, action => index, pages => array( array( label => My Account, module => community, controller => account, action => index, resource => mvc:community.account // resource ), array( label => Forums, uri => http://forums.example.com/, class => external // class ) ) ), array( label => Administration, module => admin, controller => index, action => index, resource => mvc:admin, // resource
945
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
pages => array( array( label => module => controller => action => ) ) ) );
// Create container from array $container = new Zend\Navigation\Navigation($pages); // Store the container in the proxy helper: $view->plugin(navigation)->setContainer($container); // ...or simply: $view->navigation($container);
<?php // module/MyModule/config/module.config.php return array( /* ... */ router array( routes => array( archive => array( type => Segment, options => array( route => /archive/:year, defaults => array( module => company, controller => news, action => archive, year => (int) date(Y) - 1, ), constraints => array( year => \d+, ), ), ), /* You can have other routes here... */ ), ), /* ... */ ); <?php // module/MyModule/Module.php namespace MyModule; use Zend\View\HelperPluginManager; use Zend\Permissions\Acl\Acl; use Zend\Permissions\Acl\Role\GenericRole;
1 2 3 4 5 6 7 8
946
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
use Zend\Permissions\Acl\Resource\GenericResource; class Module { /* ... */ public function getViewHelperConfig() { return array( factories => array( // This will overwrite the native navigation helper navigation => function(HelperPluginManager $pm) { // Setup ACL: $acl = new Acl(); $acl->addRole(new GenericRole(member)); $acl->addRole(new GenericRole(admin)); $acl->addResource(new GenericResource(mvc:admin)); $acl->addResource(new GenericResource(mvc:community.account)); $acl->allow(member, mvc:community.account); $acl->allow(admin, null); // Get an instance of the proxy helper $navigation = $pm->get(Zend\View\Helper\Navigation); // Store ACL and role in the proxy helper: $navigation->setAcl($acl) ->setRole(member); // Return the new navigation helper instance return $navigation; } ) ); } /* ... */ }
947
948
CHAPTER 205
Breadcrumbs are used for indicating where in a sitemap a user is currently browsing, and are typically rendered like this: You are here: Home > Products > FantasticProduct 1.0. The breadcrumbs helper follows the guidelines from Breadcrumbs Pattern - Yahoo! Design Pattern Library, and allows simple customization (minimum/maximum depth, indentation, separator, and whether the last element should be linked), or rendering using a partial view script. The Breadcrumbs helper works like this; it nds the deepest active page in a navigation container, and renders an upwards path to the root. For MVC pages, the activeness of a page is determined by inspecting the request object, as stated in the section on Zend\Navigation\Page\Mvc. The helper sets the minDepth property to 1 by default, meaning breadcrumbs will not be rendered if the deepest active page is a root page. If maxDepth is specied, the helper will stop rendering when at the specied depth (e.g. stop at level 2 even if the deepest active page is on level 3). Methods in the breadcrumbs helper: {get|set}Separator() gets/sets separator string that is used between breadcrumbs. Default is > . {get|set}LinkLast() gets/sets whether the last breadcrumb should be rendered as an anchor or not. Default is FALSE. {get|set}Partial() gets/sets a partial view script that should be used for rendering breadcrumbs. If a partial view script is set, the helpers render() method will use the renderPartial() method. If no partial is set, the renderStraight() method is used. The helper expects the partial to be a String or an Array with two elements. If the partial is a String, it denotes the name of the partial script to use. If it is an Array, the rst element will be used as the name of the partial view script, and the second element is the module where the script is found. renderStraight() is the default render method. renderPartial() is used for rendering using a partial view script.
Rendering breadcrumbs
In a view script or layout: <?php echo $this->navigation()->breadcrumbs(); ?> The two calls above take advantage of the magic __toString() method, and are equivalent to:
949
6 7 8 9
<?php echo $this->navigation()->breadcrumbs()->render(); ?> Output: <a href="/products">Products</a> > <a href="/products/server">Foo Server</a> > FAQ
Specifying indentation
Rendering with 8 spaces indentation: <?php echo $this->navigation()->breadcrumbs()->setIndent(8);?> Output: <a href="/products">Products</a> > <a href="/products/server">Foo Server</a> > FAQ
This example shows how to customize breadcrumbs output by specifying various options.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
In a view script or layout: <?php echo $this->navigation() ->breadcrumbs() ->setLinkLast(true) // link last page ->setMaxDepth(1) // stop at level 1 ->setSeparator( . PHP_EOL); // cool separator with newline ?> Output: <a href="/products">Products</a> <a href="/products/server">Foo Server</a> ///////////////////////////////////////////////////// Setting minimum depth required to render breadcrumbs: <?php $this->navigation()->breadcrumbs()->setMinDepth(10); echo $this->navigation()->breadcrumbs(); ?> Output: Nothing, because the deepest active page is not at level 10 or deeper.
This example shows how to render customized breadcrumbs using a partial vew script. By calling setPartial(), you can specify a partial view script that will be used when calling render(). When a partial is specied, the renderPartial() method will be called. This method will nd the deepest active page and pass an array of pages that leads to the active page to the partial view script. In a layout:
950
1 2
Contents of module/MyModule/view/my-module/partials/breadcrumbs.phtml:
1 2 3
Output:
1
951
952
CHAPTER 206
The links helper is used for rendering HTML LINK elements. Links are used for describing document relationships of the currently active page. Read more about links and link types at Document relationships: the LINK element (HTML4 W3C Rec.) and Link types (HTML4 W3C Rec.) in the HTML4 W3C Recommendation. There are two types of relations; forward and reverse, indicated by the kewyords rel and rev. Most methods in the helper will take a $rel param, which must be either rel or rev. Most methods also take a $type param, which is used for specifying the link type (e.g. alternate, start, next, prev, chapter, etc). Relationships can be added to page objects manually, or found by traversing the container registered in the helper. The method findRelation($page, $rel, $type) will rst try to nd the given $rel of $type from the $page by calling $page->ndRel($type) or $page->ndRel($type). If the $page has a relation that can be converted to a page instance, that relation will be used. If the $page instance doesnt have the specied $type, the helper will look for a method in the helper named search$rel$type (e.g. searchRelNext() or searchRevAlternate()). If such a method exists, it will be used for determining the $pages relation by traversing the container. Not all relations can be determined by traversing the container. These are the relations that will be found by searching: searchRelStart(), forward start relation: the rst page in the container. searchRelNext(), forward next relation; nds the next page in the container, i.e. the page after the active page. searchRelPrev(), forward prev relation; nds the previous page, i.e. the page before the active page. searchRelChapter(), forward chapter relations; nds all pages on level 0 except the start relation or the active page if its on level 0. searchRelSection(), forward section relations; nds all child pages of the active page if the active page is on level 0 (a chapter). searchRelSubsection(), forward subsection relations; nds all child pages of the active page if the active pages is on level 1 (a section). searchRevSection(), reverse section relation; nds the parent of the active page if the active page is on level 1 (a section). searchRevSubsection(), reverse subsection relation; nds the parent of the active page if the active page is on level 2 (a subsection). Note: When looking for relations in the page instance ($page->getRel($type) or $page->getRev($type)), the helper accepts the values of type String, Array, Zend\Config, or Zend\Navigation\Page\AbstractPage.
953
If a string is found, it will be converted to a Zend\Navigation\Page\Uri. If an array or a cong is found, it will be converted to one or several page instances. If the rst key of the array/cong is numeric, it will be considered to contain several pages, and each element will be passed to the page factory. If the rst key is not numeric, the array/cong will be passed to the page factory directly, and a single page will be returned. The helper also supports magic methods for nding relations. E.g. to nd forward alternate relations, call $helper>ndRelAlternate($page), and to nd reverse section relations, call $helper->ndRevSection($page). Those calls correspond to $helper->ndRelation($page, rel, alternate); and $helper->ndRelation($page, rev, section); respectively. To customize which relations should be rendered, the helper uses a render ag. The render ag is an integer value, and will be used in a bitwise and (&) operation against the helpers render constants to determine if the relation that belongs to the render constant should be rendered. See the example below for more information. Zend\View\Helper\Navigation\Links::RENDER_ALTERNATE Zend\View\Helper\Navigation\Links::RENDER_STYLESHEET Zend\View\Helper\Navigation\Links::RENDER_START Zend\View\Helper\Navigation\Links::RENDER_NEXT Zend\View\Helper\Navigation\Links::RENDER_PREV Zend\View\Helper\Navigation\Links::RENDER_CONTENTS Zend\View\Helper\Navigation\Links::RENDER_INDEX Zend\View\Helper\Navigation\Links::RENDER_GLOSSARY Zend\View\Helper\Navigation\Links::RENDER_COPYRIGHT Zend\View\Helper\Navigation\Links::RENDER_CHAPTER Zend\View\Helper\Navigation\Links::RENDER_SECTION Zend\View\Helper\Navigation\Links::RENDER_SUBSECTION Zend\View\Helper\Navigation\Links::RENDER_APPENDIX Zend\View\Helper\Navigation\Links::RENDER_HELP Zend\View\Helper\Navigation\Links::RENDER_BOOKMARK Zend\View\Helper\Navigation\Links::RENDER_CUSTOM Zend\View\Helper\Navigation\Links::RENDER_ALL The constants from RENDER_ALTERNATE to RENDER_BOOKMARK denote standard HTML link types. RENDER_CUSTOM denotes non-standard relations that specied in pages. RENDER_ALL denotes standard and nonstandard relations. Methods in the links helper: {get|set}RenderFlag() gets/sets the render ag. Default is RENDER_ALL. See examples below on how to set the render ag. findAllRelations() nds all relations of all types for a given page. findRelation() nds all relations of a given type from a given page. searchRel{Start|Next|Prev|Chapter|Section|Subsection}() traverses a container to nd forward relations to the start page, the next page, the previous page, chapters, sections, and subsections. searchRev{Section|Subsection}() traverses a container to nd reverse relations to sections or subsections. 954 Chapter 206. View Helper - Links
$container = new Zend\Navigation\Navigation(array( array( label => Relations using strings, rel => array( alternate => http://www.example.org/ ), rev => array( alternate => http://www.example.net/ ) ), array( label => Relations using arrays, rel => array( alternate => array( label => Example.org, uri => http://www.example.org/ ) ) ), array( label => Relations using configs, rel => array( alternate => new Zend\Config\Config(array( label => Example.org, uri => http://www.example.org/ )) ) ), array( label => Relations using pages instance, rel => array( alternate => Zend\Navigation\Page\AbstractPage::factory(array( label => Example.org, uri => http://www.example.org/ )) ) ) ));
This example shows how to render a menu from a container registered/found in the view helper.
1 2 3 4 5 6 7
In a view script or layout: <?php echo $this->view->navigation()->links(); ?> Output: <link rel="alternate" href="/products/server/faq/format/xml"> <link rel="start" href="/" title="Home"> <link rel="next" href="/products/server/editions" title="Editions">
955
8 9 10 11 12 13
rel="prev" href="/products/server" title="Foo Server"> rel="chapter" href="/products" title="Products"> rel="chapter" href="/company/about" title="Company"> rel="chapter" href="/community" title="Community"> rel="canonical" href="http://www.example.com/?page=server-faq"> rev="subsection" href="/products/server" title="Foo Server">
Render only start, next, and prev: $helper->setRenderFlag(Zend\View\Helper\Navigation\Links::RENDER_START | Zend\View\Helper\Navigation\Links::RENDER_NEXT | Zend\View\Helper\Navigation\Links::RENDER_PREV); Output: <link rel="start" href="/" title="Home"> <link rel="next" href="/products/server/editions" title="Editions"> <link rel="prev" href="/products/server" title="Foo Server"> Render only native link types: $helper->setRenderFlag(Zend\View\Helper\Navigation\Links::RENDER_ALL ^ Zend\View\Helper\Navigation\Links::RENDER_CUSTOM); Output: <link rel="alternate" href="/products/server/faq/format/xml"> <link rel="start" href="/" title="Home"> <link rel="next" href="/products/server/editions" title="Editions"> <link rel="prev" href="/products/server" title="Foo Server"> <link rel="chapter" href="/products" title="Products"> <link rel="chapter" href="/company/about" title="Company"> <link rel="chapter" href="/community" title="Community"> <link rev="subsection" href="/products/server" title="Foo Server"> Render all but chapter: $helper->setRenderFlag(Zend\View\Helper\Navigation\Links::RENDER_ALL ^ Zend\View\Helper\Navigation\Links::RENDER_CHAPTER); Output: <link rel="alternate" href="/products/server/faq/format/xml"> <link rel="start" href="/" title="Home"> <link rel="next" href="/products/server/editions" title="Editions"> <link rel="prev" href="/products/server" title="Foo Server"> <link rel="canonical" href="http://www.example.com/?page=server-faq"> <link rev="subsection" href="/products/server" title="Foo Server">
1 2 3 4 5 6 7 8 9 10 11 12 13
1 2 3 4 5 6 7 8 9 10 11
956
CHAPTER 207
The Menu helper is used for rendering menus from navigation containers. By default, the menu will be rendered using HTML UL and LI tags, but the helper also allows using a partial view script. Methods in the Menu helper: {get|set}UlClass() gets/sets the CSS class used in renderMenu(). {get|set}OnlyActiveBranch() gets/sets a ag specifying whether only the active branch of a container should be rendered. {get|set}RenderParents() gets/sets a ag specifying whether parents should be rendered when only rendering active branch of a container. If set to FALSE, only the deepest active menu will be rendered. {get|set}Partial() gets/sets a partial view script that should be used for rendering menu. If a partial view script is set, the helpers render() method will use the renderPartial() method. If no partial is set, the renderMenu() method is used. The helper expects the partial to be a String or an Array with two elements. If the partial is a String, it denotes the name of the partial script to use. If it is an Array, the rst element will be used as the name of the partial view script, and the second element is the module where the script is found. htmlify() overrides the method from the abstract class to return span elements if the page has no href. renderMenu($container = null, $options = array()) is the default render method, and will render a container as a HTML UL list. If $container is not given, the container registered in the helper will be rendered. $options is used for overriding options specied temporarily without resetting the values in the helper instance. It is an associative array where each key corresponds to an option in the helper. Recognized options: indent; indentation. Expects a String or an int value. minDepth; minimum depth. Expects an int or NULL (no minimum depth). maxDepth; maximum depth. Expects an int or NULL (no maximum depth). ulClass; CSS class for ul element. Expects a String. onlyActiveBranch; whether only active branch should be rendered. Expects a Boolean value. renderParents; whether parents should be rendered if only rendering active branch. Expects a Boolean value.
957
If an option is not given, the value set in the helper will be used. renderPartial() is used for rendering the menu using a partial view script. renderSubMenu() renders the deepest menu level of a containers active branch.
Rendering a menu
This example shows how to render a menu from a container registered/found in the view helper. Notice how pages are ltered out based on visibility and ACL.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
In a view script or layout: <?php echo $this->navigation()->menu()->render() ?> Or simply: <?php echo $this->navigation()->menu() ?> Output: <ul class="navigation"> <li> <a title="Go Home" href="/">Home</a> </li> <li class="active"> <a href="/products">Products</a> <ul> <li class="active"> <a href="/products/server">Foo Server</a> <ul> <li class="active"> <a href="/products/server/faq">FAQ</a> </li> <li> <a href="/products/server/editions">Editions</a> </li> <li> <a href="/products/server/requirements">System Requirements</a> </li> </ul> </li> <li> <a href="/products/studio">Foo Studio</a> <ul> <li> <a href="/products/studio/customers">Customer Stories</a> </li> <li> <a href="/products/studio/support">Support</a> </li> </ul> </li> </ul> </li> <li> <a title="About us" href="/company/about">Company</a> <ul> <li> <a href="/company/about/investors">Investor Relations</a> </li>
958
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
<li> <a class="rss" href="/company/news">News</a> <ul> <li> <a href="/company/news/press">Press Releases</a> </li> <li> <a href="/archive">Archive</a> </li> </ul> </li> </ul> </li> <li> <a href="/community">Community</a> <ul> <li> <a href="/community/account">My Account</a> </li> <li> <a class="external" href="http://forums.example.com/">Forums</a> </li> </ul> </li> </ul>
This example shows how to render a menu that is not registered in the view helper by calling the renderMenu() directly and specifying a few options.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
<?php // render only the Community menu $community = $this->navigation()->findOneByLabel(Community); $options = array( indent => 16, ulClass => community ); echo $this->navigation() ->menu() ->renderMenu($community, $options); ?> Output: <ul class="community"> <li> <a href="/community/account">My Account</a> </li> <li> <a class="external" href="http://forums.example.com/">Forums</a> </li> </ul>
This example shows how the renderSubMenu() will render the deepest sub menu of the active branch.
959
Calling renderSubMenu($container, $ulClass, $indent) renderMenu($container, $options) with the following options:
1 2 3 4 5 6 7 8
is
equivalent
to
calling
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
<?php echo $this->navigation() ->menu() ->renderSubMenu(null, sidebar, 4); ?> The output will be the same if FAQ or Foo Server is active: <ul class="sidebar"> <li class="active"> <a href="/products/server/faq">FAQ</a> </li> <li> <a href="/products/server/editions">Editions</a> </li> <li> <a href="/products/server/requirements">System Requirements</a> </li> </ul>
Rendering a menu with maximum depth <?php echo $this->navigation() ->menu() ->setMaxDepth(1); ?> Output: <ul class="navigation"> <li> <a title="Go Home" href="/">Home</a> </li> <li class="active"> <a href="/products">Products</a> <ul> <li class="active"> <a href="/products/server">Foo Server</a> </li> <li> <a href="/products/studio">Foo Studio</a> </li> </ul> </li> <li> <a title="About us" href="/company/about">Company</a>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
960
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
<ul> <li> <a href="/company/about/investors">Investor Relations</a> </li> <li> <a class="rss" href="/company/news">News</a> </li> </ul> </li> <li> <a href="/community">Community</a> <ul> <li> <a href="/community/account">My Account</a> </li> <li> <a class="external" href="http://forums.example.com/">Forums</a> </li> </ul> </li> </ul>
<?php echo $this->navigation() ->menu() ->setMinDepth(1); ?> Output: <ul class="navigation"> <li class="active"> <a href="/products/server">Foo Server</a> <ul> <li class="active"> <a href="/products/server/faq">FAQ</a> </li> <li> <a href="/products/server/editions">Editions</a> </li> <li> <a href="/products/server/requirements">System Requirements</a> </li> </ul> </li> <li> <a href="/products/studio">Foo Studio</a> <ul> <li> <a href="/products/studio/customers">Customer Stories</a> </li> <li> <a href="/products/studio/support">Support</a> </li> </ul> </li>
961
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
<li> <a href="/company/about/investors">Investor Relations</a> </li> <li> <a class="rss" href="/company/news">News</a> <ul> <li> <a href="/company/news/press">Press Releases</a> </li> <li> <a href="/archive">Archive</a> </li> </ul> </li> <li> <a href="/community/account">My Account</a> </li> <li> <a class="external" href="http://forums.example.com/">Forums</a> </li> </ul>
Rendering only the active branch of a menu <?php echo $this->navigation() ->menu() ->setOnlyActiveBranch(true); ?> Output: <ul class="navigation"> <li class="active"> <a href="/products">Products</a> <ul> <li class="active"> <a href="/products/server">Foo Server</a> <ul> <li class="active"> <a href="/products/server/faq">FAQ</a> </li> <li> <a href="/products/server/editions">Editions</a> </li> <li> <a href="/products/server/requirements">System Requirements</a> </li> </ul> </li> </ul> </li> </ul>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
962
Rendering only the active branch of a menu with minimum depth <?php echo $this->navigation() ->menu() ->setOnlyActiveBranch(true) ->setMinDepth(1); ?> Output: <ul class="navigation"> <li class="active"> <a href="/products/server">Foo Server</a> <ul> <li class="active"> <a href="/products/server/faq">FAQ</a> </li> <li> <a href="/products/server/editions">Editions</a> </li> <li> <a href="/products/server/requirements">System Requirements</a> </li> </ul> </li> </ul>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
Rendering only the active branch of a menu with maximum depth <?php echo $this->navigation() ->menu() ->setOnlyActiveBranch(true) ->setMaxDepth(1); ?> Output: <ul class="navigation"> <li class="active"> <a href="/products">Products</a> <ul> <li class="active"> <a href="/products/server">Foo Server</a> </li> <li> <a href="/products/studio">Foo Studio</a> </li> </ul> </li> </ul>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
963
Rendering only the active branch of a menu with maximum depth and no parents <?php echo $this->navigation() ->menu() ->setOnlyActiveBranch(true) ->setRenderParents(false) ->setMaxDepth(1); ?> Output: <ul class="navigation"> <li class="active"> <a href="/products/server">Foo Server</a> </li> <li> <a href="/products/studio">Foo Studio</a> </li> </ul>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
This example shows how to render a custom menu using a partial view script. By calling setPartial(), you can specify a partial view script that will be used when calling render(). When a partial is specied, the renderPartial() method will be called. This method will assign the container to the view with the key container. In a layout:
1 2
In module/MyModule/view/my-module/partials/menu.phtml:
1 2 3
Output:
1 2 3 4
964
CHAPTER 208
The Sitemap helper is used for generating XML sitemaps, as dened by the Sitemaps XML format. Read more about Sitemaps on Wikipedia. By default, the sitemap helper uses sitemap validators to validate each element that is rendered. This can be disabled by calling $helper->setUseSitemapValidators(false). Note: If you disable sitemap validators, the custom properties (see table) are not validated at all. The sitemap helper also supports Sitemap XSD Schema validation of the generated sitemap. This is disabled by default, since it will require a request to the Schema le. It can be enabled with $helper->setUseSchemaValidation(true).
Absolute URL to page. An absolute URL will be generated by the helper. The date of last modication of the le, in W3C Datetime format. This time portion can be omitted if desired, and only use YYYY-MM-DD. The helper will try to retrieve the lastmod value from the pages custom property lastmod if it is set in the page. If the value is not a valid date, it is ignored. change- How frequently the page is likely to change. This value provides general information to search engines freq and may not correlate exactly to how often they crawl the page. Valid values are: alwayshourlydailyweeklymonthlyyearlynever The helper will try to retrieve the changefreq value from the pages custom property changefreq if it is set in the page. If the value is not valid, it is ignored. priorThe priority of this URL relative to other URLs on your site. Valid values range from 0.0 to 1.0. The ity helper will try to retrieve the priority value from the pages custom property priority if it is set in the page. If the value is not valid, it is ignored. Methods in the sitemap helper: {get|set}FormatOutput() gets/sets a ag indicating whether XML output should be formatted. This corresponds to the formatOutput property of the native DOMDocument class. Read more at PHP: DOMDocument - Manual. Default is FALSE. {get|set}UseXmlDeclaration() gets/sets a ag indicating whether the XML declaration should be included when rendering. Default is TRUE. {get|set}UseSitemapValidators() gets/sets a ag indicating whether sitemap validators should be used when generating the DOM sitemap. Default is TRUE. 965
{get|set}UseSchemaValidation() gets/sets a ag indicating whether the helper should use XML Schema validation when generating the DOM sitemap. Default is FALSE. If TRUE. {get|set}ServerUrl() gets/sets server URL that will be prepended to non-absolute URLs in the url() method. If no server URL is specied, it will be determined by the helper. url() is used to generate absolute URLs to pages. getDomSitemap() generates a DOMDocument from a given container.
Rendering an XML sitemap
This example shows how to render an XML sitemap based on the setup we did further up.
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// In a view script or layout: // format output $this->navigation() ->sitemap() ->setFormatOutput(true); // default is false // // // // other possible methods: ->setUseXmlDeclaration(false); // default is true ->setServerUrl(http://my.otherhost.com); default is to detect automatically
Notice how pages that are invisible or pages with ACL roles incompatible with the view helper are ltered out:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
<?xml version="1.0" encoding="UTF-8"?> <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"> <url> <loc>http://www.example.com/</loc> </url> <url> <loc>http://www.example.com/products</loc> </url> <url> <loc>http://www.example.com/products/server</loc> </url> <url> <loc>http://www.example.com/products/server/faq</loc> </url> <url> <loc>http://www.example.com/products/server/editions</loc> </url> <url> <loc>http://www.example.com/products/server/requirements</loc> </url> <url> <loc>http://www.example.com/products/studio</loc> </url> <url> <loc>http://www.example.com/products/studio/customers</loc> </url> <url> <loc>http://www.example.com/products/studio/support</loc>
966
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
</url> <url> <loc>http://www.example.com/company/about</loc> </url> <url> <loc>http://www.example.com/company/about/investors</loc> </url> <url> <loc>http://www.example.com/company/news</loc> </url> <url> <loc>http://www.example.com/company/news/press</loc> </url> <url> <loc>http://www.example.com/archive</loc> </url> <url> <loc>http://www.example.com/community</loc> </url> <url> <loc>http://www.example.com/community/account</loc> </url> <url> <loc>http://forums.example.com/</loc> </url> </urlset>
Render the sitemap using no ACL role (should lter out /community/account):
1 2 3 4
echo $this->navigation() ->sitemap() ->setFormatOutput(true) ->setRole(); <?xml version="1.0" encoding="UTF-8"?> <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"> <url> <loc>http://www.example.com/</loc> </url> <url> <loc>http://www.example.com/products</loc> </url> <url> <loc>http://www.example.com/products/server</loc> </url> <url> <loc>http://www.example.com/products/server/faq</loc> </url> <url> <loc>http://www.example.com/products/server/editions</loc> </url> <url> <loc>http://www.example.com/products/server/requirements</loc> </url> <url> <loc>http://www.example.com/products/studio</loc> </url> <url> <loc>http://www.example.com/products/studio/customers</loc>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
967
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
</url> <url> <loc>http://www.example.com/products/studio/support</loc> </url> <url> <loc>http://www.example.com/company/about</loc> </url> <url> <loc>http://www.example.com/company/about/investors</loc> </url> <url> <loc>http://www.example.com/company/news</loc> </url> <url> <loc>http://www.example.com/company/news/press</loc> </url> <url> <loc>http://www.example.com/archive</loc> </url> <url> <loc>http://www.example.com/community</loc> </url> <url> <loc>http://forums.example.com/</loc> </url> </urlset>
echo $this->navigation() ->sitemap() ->setFormatOutput(true) ->setMaxDepth(1); <?xml version="1.0" encoding="UTF-8"?> <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"> <url> <loc>http://www.example.com/</loc> </url> <url> <loc>http://www.example.com/products</loc> </url> <url> <loc>http://www.example.com/products/server</loc> </url> <url> <loc>http://www.example.com/products/studio</loc> </url> <url> <loc>http://www.example.com/company/about</loc> </url> <url> <loc>http://www.example.com/company/about/investors</loc> </url> <url> <loc>http://www.example.com/company/news</loc> </url> <url> <loc>http://www.example.com/community</loc>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
968
26 27 28 29 30 31 32 33
Note: UTF-8 encoding used by default By default, Zend Framework uses UTF-8 as its default encoding, and, specic to this case, Zend\View does as well. So if you want to use another encoding with Sitemap, you will have do three things: 1. Create a custom renderer and implement a getEncoding() method; 2. Create a custom rendering strategy that will return an instance of your custom renderer; 3. Attach the custom strategy in the ViewEvent; See the example from **headStile** documentation to see how you can achieve this.
969
970
CHAPTER 209
The Navigation helper is a proxy helper that relays calls to other navigational helpers. It can be considered an entry point to all navigation-related view tasks. The aforementioned navigational helpers are in the namespace Zend\View\Helper\Navigation, and would thus require the path Zend/View/Helper/Navigation to be added as a helper path to the view. With the proxy helper residing in the Zend\View\Helper namespace, it will always be available, without the need to add any helper paths to the view. The Navigation helper nds other helpers that implement the Zend\View\Helper\Navigation\HelperInterface, which means custom view helpers can also be proxied. This would, however, require that the custom helper path is added to the view. When proxying to other helpers, the Navigation helper can inject its container, ACL/role, and translator. This means that you wont have to explicitly set all three in all navigational helpers, nor resort to injecting by means of static methods. findHelper() nds the given helper, veries that it is a navigational helper, and injects container, ACL/role and translator. {get|set}InjectContainer() gets/sets a ag indicating whether the container should be injected to proxied helpers. Default is TRUE. {get|set}InjectAcl() gets/sets a ag indicating whether the ACL/role should be injected to proxied helpers. Default is TRUE. {get|set}InjectTranslator() gets/sets a ag indicating whether the translator should be injected to proxied helpers. Default is TRUE. {get|set}DefaultProxy() gets/sets the default proxy. Default is menu. render() proxies to the render method of the default proxy.
971
972
CHAPTER 210
Introduction to Zend\Paginator
Zend\Paginator is a exible component for paginating collections of data and presenting that data to users. The primary design goals of Zend\Paginator are as follows: Paginate arbitrary data, not just relational databases Fetch only the results that need to be displayed Do not force users to adhere to only one way of displaying data or rendering pagination controls Loosely couple Zend\Paginator to other Zend Framework components so that users who wish to use it independently of Zend\View, Zend\Db, etc. can do so
973
974
CHAPTER 211
Usage
Note: Instead of selecting every matching row of a given query, the DbSelect adapter retrieves only the smallest amount of data necessary for displaying the current page. Because of this, a second query is dynamically generated to determine the total number of matching rows. To create an instance of Zend\Paginator, you must supply an adapter to the constructor:
1
In the case of the Null adapter, in lieu of a data collection you must supply an item count to its constructor. Although the instance is technically usable in this state, in your controller action youll need to tell the paginator what page number the user requested. This allows advancing through the paginated data.
1
$paginator->setCurrentPageNumber($page);
The simplest way to keep track of this value is through a URL parameter. The following is an example route you might use in an Array conguration le:
1 2 3
975
4 5 6 7 8 9 10 11 12 13
type => segment, options => array( route => /list/[page/:page], defaults => array( page => 1, ), ), ), ), );
With the above route (and using Zend Framework MVC components), you might set the current page number in your controller action like so:
1
$paginator->setCurrentPageNumber($this->params()->fromRoute(page));
There are other options available; see Conguration for more on them. Finally, youll need to assign the paginator instance to your view. If youre using Zend Framework MVC component, you can assign the paginator object to your view model:
1 2 3
class MyDbSelect extends Zend\Paginator\Adapter\DbSelect { public function count() { $select = new Zend\Db\Sql\Select(); $select->from(item_counts)->columns(array(c=>post_count)); $statement = $this->sql->prepareStatementForSqlObject($select); $result = $statement->execute(); $row = $result->current(); $this->rowCount = $row[c];
976
12 13 14 15 16 17 18
This approach will probably not give you a huge performance gain on small collections and/or simple select queries. However, with complex queries and large collections, a similar approach could give you a signicant performance boost. The DbSelect adapter also supports returning of fetched records using the Zend\Db\ResultSet component of Zend\Db. You can override the concrete RowSet implementation by passing an object implementing Zend\Db\ResultSet\ResultSetInterface as the third constructor argument to the DbSelect adapter:
1 2 3 4 5 6
// $objectPrototype is an instance of our custom entity // $hydrator is a custom hydrator for our entity (implementing Zend\Stdlib\Hydrator\HydratorInterface $resultSet = new Zend\Db\ResultSet\HydratingResultSet($hydrator, $objectPrototype); $adapter = new Zend\Paginator\Adapter\DbSelect($query, $dbAdapter, $resultSet) $paginator = new Zend\Paginator\Paginator($adapter);
Now when we iterate over $paginator we will get instances of our custom entity instead of key-value-pair arrays.
<html> <body> <h1>Example</h1> <?php if (count($this->paginator)): ?> <ul> <?php foreach ($this->paginator as $item): ?> <li><?php echo $item; ?></li> <?php endforeach; ?> </ul> <?php endif; ?>
<?php echo $this->paginationControl($this->paginator, Sliding, my_pagination_control, array(route => application/paginator </body> </html>
Notice the view helper call near the end. PaginationControl accepts up to four parameters: the paginator instance, a scrolling style, a view script name, and an array of additional parameters. The second and third parameters are very important. Whereas the view script name is used to determine how the pagination control should look, the scrolling style is used to control how it should behave. Say the view script is in the style of a search pagination control, like the one below:
977
What happens when the user clicks the next link a few times? Well, any number of things could happen. The current page number could stay in the middle as you click through (as it does on Yahoo!), or it could advance to the end of the page range and then appear again on the left when the user clicks next one more time. The page numbers might even expand and contract as the user advances (or scrolls) through them (as they do on Google). There are four scrolling styles packaged with Zend Framework: Table 211.2: Scrolling styles for Zend\Paginator Scrolling style All Elastic Jumping Sliding Description Returns every page. This is useful for dropdown menu pagination controls with relatively few pages. In these cases, you want all pages available to the user at once. A Google-like scrolling style that expands and contracts as a user scrolls through the pages. As users scroll through, the page number advances to the end of a given range, then starts again at the beginning of the new range. A Yahoo!-like scrolling style that positions the current page number in the center of the page range, or as close as possible. This is the default style.
The fourth and nal parameter is reserved for an optional associative array of additional variables that you want available in your view (available via $this). For instance, these values could include extra URL parameters for pagination links. By setting the default view script name, default scrolling style, and view instance, you can eliminate the calls to PaginationControl completely:
1 2 3 4
When all of these values are set, you can render the pagination control inside your view script with a simple echo statement:
1
Note: Of course, its possible to use Zend\Paginator with other template engines. For example, with Smarty you might do the following:
1
$smarty->assign(pages, $paginator->getPages());
You could then access paginator values from a template like so:
1
{$pages->pageCount}
978
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
<!-See http://developer.yahoo.com/ypatterns/pattern.php?pattern=searchpagination --> <?php if ($this->pageCount): ?> <div class="paginationControl"> <!-- Previous page link --> <?php if (isset($this->previous)): ?> <a href="<?php echo $this->url($this->route, array(page => $this->previous)); ?>"> < Previous </a> | <?php else: ?> <span class="disabled">< Previous</span> | <?php endif; ?> <!-- Numbered page links --> <?php foreach ($this->pagesInRange as $page): ?> <?php if ($page != $this->current): ?> <a href="<?php echo $this->url($this->route, array(page => $page)); ?>"> <?php echo $page; ?> </a> | <?php else: ?> <?php echo $page; ?> | <?php endif; ?> <?php endforeach; ?> <!-- Next page link --> <?php if (isset($this->next)): ?> <a href="<?php echo $this->url($this->route, array(page => $this->next)); ?>"> Next > </a> <?php else: ?> <span class="disabled">Next ></span> <?php endif; ?> </div> <?php endif; ?>
Item pagination:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
<!-See http://developer.yahoo.com/ypatterns/pattern.php?pattern=itempagination --> <?php if ($this->pageCount): ?> <div class="paginationControl"> <?php echo $this->firstItemNumber; ?> - <?php echo $this->lastItemNumber; ?> of <?php echo $this->totalItemCount; ?> <!-- First page link --> <?php if (isset($this->previous)): ?> <a href="<?php echo $this->url($this->route, array(page => $this->first)); ?>"> First </a> | <?php else: ?> <span class="disabled">First</span> | <?php endif; ?> <!-- Previous page link --> <?php if (isset($this->previous)): ?>
979
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
<a href="<?php echo $this->url($this->route, array(page => $this->previous)); ?>"> < Previous </a> | <?php else: ?> <span class="disabled">< Previous</span> | <?php endif; ?> <!-- Next page link --> <?php if (isset($this->next)): ?> <a href="<?php echo $this->url($this->route, array(page => $this->next)); ?>"> Next > </a> | <?php else: ?> <span class="disabled">Next ></span> | <?php endif; ?> <!-- Last page link --> <?php if (isset($this->next)): ?> <a href="<?php echo $this->url($this->route, array(page => $this->last)); ?>"> Last </a> <?php else: ?> <span class="disabled">Last</span> <?php endif; ?> </div> <?php endif; ?>
Dropdown pagination:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
<?php if ($this->pageCount): ?> <select id="paginationControl" size="1"> <?php foreach ($this->pagesInRange as $page): ?> <?php $selected = ($page == $this->current) ? selected="selected" : ; ?> <option value="<?php echo $this->url($this->route, array(page => $page));?>"<?php echo $selected ?>> <?php echo $page; ?> </option> <?php endforeach; ?> </select> <?php endif; ?> <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/prototype/1.6.0.2/prototype.js"> </script> <script type="text/javascript"> $(paginationControl).observe(change, function() { window.location = this.options[this.selectedIndex].value; }) </script>
980
Table 211.3: Properties available to view partials Property rst rstItemNumber rstPageInRange current currentItemCount itemCountPerPage last lastItemNumber lastPageInRange next pageCount pagesInRange previous totalItemCount Type integer integer integer integer integer integer integer integer integer integer integer array integer integer Description First page number (i.e., 1) Absolute number of the rst item on this page First page in the range returned by the scrolling style Current page number Number of items on this page Maximum number of items available to each page Last page number Absolute number of the last item on this page Last page in the range returned by the scrolling style Next page number Number of pages Array of pages returned by the scrolling style Previous page number Total number of items
981
982
CHAPTER 212
Conguration
Zend\Paginator has several conguration methods that can be called: Table 212.1: Conguration methods for Zend\Paginator\Paginator Method setCurrentPageNumber setItemCountPerPage setPageRange setView Description Sets the current page number (default 1). Sets the maximum number of items to display on a page (default 10).
Sets the number of items to display in the pagination control (default 10). Note: Most of the time this number will be adhered to exactly, but scrolling styles do have the option of only using it as a guideline or starting value (e.g., Elastic). Sets the view instance, for rendering convenience.
983
984
CHAPTER 213
Advanced usage
Take a look at the packaged adapters (all of which implement the Zend\Paginator\Adapter\AdapterInterface) for ideas of how you might go about implementing your own.
Creating your own scrolling style requires that you implement Zend\Paginator\ScrollingStyle\ScrollingStyleInterf which denes a single method, getPages(). Specically,
1
This method should calculate a lower and upper bound for page numbers within the range of so-called local pages (that is, pages that are nearby the current page).
985
Unless it extends another scrolling style (see Zend\Paginator\ScrollingStyle\Elastic for an example), your custom scrolling style will inevitably end with something similar to the following line of code:
1
Theres nothing special about this call; its merely a convenience method to check the validity of the lower and upper bound and return an array of the range to the paginator. When youre ready to use your new scrolling style, youll need to tell Zend\Paginator\Paginator what directory to look in. To do that, do the following:
1 2
$cache = StorageFactory::adapterFactory(filesystem, array( cache_dir => /tmp, ttl => 3600, plugins => array( serializer ), )); Zend\Paginator\Paginator::setCache($cache);
As long as Zend\Paginator\Paginator has been seeded with a cache storage object the data it generates will be cached. Sometimes you would like not to cache data even if you already passed a cache instance. You should then use setCacheEnable() for that.
1 2 3 4 5
// $cache is a Zend\Cache\Storage\StorageInterface instance Zend\Paginator\Paginator::setCache($cache); // ... later on the script $paginator->setCacheEnable(false); // cache is now disabled
When a cache is set, data are automatically stored in it and pulled out from it. It then can be useful to empty the cache manually. You can get this done by calling clearPageItemCache($pageNumber). If you dont pass any parameter, the whole cache will be empty. You can optionally pass a parameter representing the page number to empty in the cache:
1 2 3 4 5 6 7 8 9 10 11 12 13
// $cache is a Zend\Cache\Storage\StorageInterface instance Zend\Paginator\Paginator::setCache($cache); // $paginator is a fully configured Zend\Paginator\Paginator instance $items = $paginator->getCurrentItems(); // page 1 is now in cache $page3Items = $paginator->getItemsByPage(3); // page 3 is now in cache // clear the cache of the results for page 3 $paginator->clearPageItemCache(3); // clear all the cache data $paginator->clearPageItemCache();
986
Changing the item count per page will empty the whole cache as it would have become invalid:
1 2 3 4 5 6 7 8
// $cache is a Zend\Cache\Storage\StorageInterface instance Zend\Paginator\Paginator::setCache($cache); // fetch some items // $paginator is a fully configured Zend\Paginator\Paginator instance $items = $paginator->getCurrentItems(); // all the cache data will be flushed: $paginator->setItemCountPerPage(2);
It is also possible to see the data in cache and ask for them directly. getPageItemCache() can be used for that:
1 2 3 4 5 6 7 8 9 10
// $cache is a Zend\Cache\Storage\StorageInterface instance Zend\Paginator\Paginator::setCache($cache); // $paginator is a fully configured Zend\Paginator\Paginator instance $paginator->setItemCountPerPage(3); // fetch some items $items = $paginator->getCurrentItems(); $otherItems = $paginator->getItemsPerPage(4); // see the cached items as a two-dimension array: var_dump($paginator->getPageItemCache());
987
988
CHAPTER 214
Introduction to Zend\Permissions\Acl
The Zend\Permissions\Acl component provides a lightweight and exible access control list (ACL) implementation for privileges management. In general, an application may utilize such ACLs to control access to certain protected objects by other requesting objects. For the purposes of this documentation: a resource is an object to which access is controlled. a role is an object that may request access to a Resource. Put simply, roles request access to resources. For example, if a parking attendant requests access to a car, then the parking attendant is the requesting role, and the car is the resource, since access to the car may not be granted to everyone. Through the specication and use of an ACL, an application may control how roles are granted access to resources.
214.1 Resources
Creating a resource using Zend\Permissions\Acl\Acl is very simple. A resource interface Zend\Permissions\Acl\Resource\ResourceInterface is provided to facilitate creating resources in an application. A class need only implement this interface, which consists of a single method, getResourceId(), for Zend\Permissions\Acl\Acl to recognize the object as a resource. Additionally, Zend\Permissions\Acl\Resource\GenericResource is provided as a basic resource implementation for developers to extend as needed. Zend\Permissions\Acl\Acl provides a tree structure to which multiple resources can be added. Since resources are stored in such a tree structure, they can be organized from the general (toward the tree root) to the specic (toward the tree leaves). Queries on a specic resource will automatically search the resources hierarchy for rules assigned to ancestor resources, allowing for simple inheritance of rules. For example, if a default rule is to be applied to each building in a city, one would simply assign the rule to the city, instead of assigning the same rule to each building. Some buildings may require exceptions to such a rule, however, and this can be achieved in Zend\Permissions\Acl\Acl by assigning such exception rules to each building that requires such an exception. A resource may inherit from only one parent resource, though this parent resource can have its own parent resource, etc. Zend\Permissions\Acl\Acl also supports privileges on resources (e.g., create, read, update, delete), so the developer can assign rules that affect all privileges or specic privileges on one or more resources.
989
214.2 Roles
As with resources, creating a role is also very simple. All roles must implement Zend\Permissions\Acl\Role\RoleInterface. This interface consists of a single method, getRoleId(), Additionally, Zend\Permissions\Acl\Role\GenericRole is provided by the Zend\Permissions\Acl component as a basic role implementation for developers to extend as needed. In Zend\Permissions\Acl\Acl, a role may inherit from one or more roles. This is to support inheritance of rules among roles. For example, a user role, such as sally, may belong to one or more parent roles, such as editor and administrator. The developer can assign rules to editor and administrator separately, and sally would inherit such rules from both, without having to assign rules directly to sally. Though the ability to inherit from multiple roles is very useful, multiple inheritance also introduces some degree of complexity. The following example illustrates the ambiguity condition and how Zend\Permissions\Acl\Acl solves it.
Multiple Inheritance among Roles
The following code denes three base roles - guest, member, and admin - from which other roles may inherit. Then, a role identied by someUser is established and inherits from the three other roles. The order in which these roles appear in the $parents array is important. When necessary, Zend\Permissions\Acl\Acl searches for access rules dened not only for the queried role (herein, someUser), but also upon the roles from which the queried role inherits (herein, guest, member, and admin):
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
use Zend\Permissions\Acl\Acl; use Zend\Permissions\Acl\Role\GenericRole as Role; use Zend\Permissions\Acl\Resource\GenericResource as Resource; $acl = new Acl(); $acl->addRole(new Role(guest)) ->addRole(new Role(member)) ->addRole(new Role(admin)); $parents = array(guest, member, admin); $acl->addRole(new Role(someUser), $parents); $acl->addResource(new Resource(someResource)); $acl->deny(guest, someResource); $acl->allow(member, someResource); echo $acl->isAllowed(someUser, someResource) ? allowed : denied;
Since there is no rule specically dened for the someUser role and someResource, Zend\Permissions\Acl\Acl must search for rules that may be dened for roles that someUser inherits. First, the admin role is visited, and there is no access rule dened for it. Next, the member role is visited, and Zend\Permissions\Acl\Acl nds that there is a rule specifying that member is allowed access to someResource. If Zend\Permissions\Acl\Acl were to continue examining the rules dened for other parent roles, however, it would nd that guest is denied access to someResource. This fact introduces an ambiguity because now someUser is both denied and allowed access to someResource, by reason of having inherited conicting rules from different parent roles. Zend\Permissions\Acl\Acl resolves this ambiguity by completing a query when it nds the rst rule that is
990
directly applicable to the query. In this case, since the member role is examined before the guest role, the example code would print allowed. Note: When specifying multiple parents for a role, keep in mind that the last parent listed is the rst one searched for rules applicable to an authorization query.
Note: Until a developer species an allow rule, Zend\Permissions\Acl\Acl denies access to every privilege upon every resource by every role.
For this example, Zend\Permissions\Acl\Role\GenericRole is used, but any object that implements Zend\Permissions\Acl\Role\RoleInterface is acceptable. These groups can be added to the role registry as follows:
1 2 3 4 5 6 7 8 9 10
use Zend\Permissions\Acl\Acl; use Zend\Permissions\Acl\Role\GenericRole as Role; $acl = new Acl(); // Add groups to the Role registry using Zend\Permissions\Acl\Role\GenericRole // Guest does not inherit access controls $roleGuest = new Role(guest); $acl->addRole($roleGuest);
991
11 12 13 14 15 16 17 18 19 20 21 22 23
// Staff inherits from guest $acl->addRole(new Role(staff), $roleGuest); /* Alternatively, the above could be written: $acl->addRole(new Role(staff), guest); */ // Editor inherits from staff $acl->addRole(new Role(editor), staff); // Administrator does not inherit access controls $acl->addRole(new Role(administrator));
use Zend\Permissions\Acl\Acl; use Zend\Permissions\Acl\Role\GenericRole as Role; $acl = new Acl(); $roleGuest = new Role(guest); $acl->addRole($roleGuest); $acl->addRole(new Role(staff), $roleGuest); $acl->addRole(new Role(editor), staff); $acl->addRole(new Role(administrator)); // Guest may only view content $acl->allow($roleGuest, null, view); /* Alternatively, the above could be written: $acl->allow(guest, null, view); //*/ // Staff inherits view privilege from guest, but also needs additional // privileges $acl->allow(staff, null, array(edit, submit, revise)); // Editor inherits view, edit, submit, and revise privileges from // staff, but also needs additional privileges $acl->allow(editor, null, array(publish, archive, delete));
992
27 28 29
The NULL values in the above allow() calls are used to indicate that the allow rules apply to all resources.
echo $acl->isAllowed(guest, null, view) ? "allowed" : "denied"; // allowed echo $acl->isAllowed(staff, null, publish) ? "allowed" : "denied"; // denied echo $acl->isAllowed(staff, null, revise) ? "allowed" : "denied"; // allowed echo $acl->isAllowed(editor, null, view) ? "allowed" : "denied"; // allowed because of inheritance from guest echo $acl->isAllowed(editor, null, update) ? "allowed" : "denied"; // denied because no allow rule for update echo $acl->isAllowed(administrator, null, view) ? "allowed" : "denied"; // allowed because administrator is allowed all privileges echo $acl->isAllowed(administrator) ? "allowed" : "denied"; // allowed because administrator is allowed all privileges echo $acl->isAllowed(administrator, null, update) ? "allowed" : "denied"; // allowed because administrator is allowed all privileges
993
994
CHAPTER 215
// The new marketing group inherits permissions from staff use Zend\Permissions\Acl\Acl; use Zend\Permissions\Acl\Role\GenericRole as Role; use Zend\Permissions\Acl\Resource\GenericResource as Resource; $acl = new Acl(); $acl->addRole(new Role(marketing), staff);
Next, note that the above access controls refer to specic resources (e.g., newsletter, latest news, announcement news). Now we add these resources:
1 2 3 4 5 6 7 8 9
// Create Resources for the rules // newsletter $acl->addResource(new Resource(newsletter)); // news $acl->addResource(new Resource(news)); // latest news
995
10 11 12 13
Then it is simply a matter of dening these more specic rules on the target areas of the ACL:
1 2 3 4 5 6 7 8 9 10 11 12 13
// Marketing must be able to publish and archive newsletters and the // latest news $acl->allow(marketing, array(newsletter, latest), array(publish, archive)); // Staff (and marketing, by inheritance), are denied permission to // revise the latest news $acl->deny(staff, latest, revise); // Everyone (including administrators) are denied permission to // archive news announcements $acl->deny(null, announcement, archive);
We can now query the ACL with respect to the latest changes:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
echo $acl->isAllowed(staff, newsletter, publish) ? "allowed" : "denied"; // denied echo $acl->isAllowed(marketing, newsletter, publish) ? "allowed" : "denied"; // allowed echo $acl->isAllowed(staff, latest, publish) ? "allowed" : "denied"; // denied echo $acl->isAllowed(marketing, latest, publish) ? "allowed" : "denied"; // allowed echo $acl->isAllowed(marketing, latest, archive) ? "allowed" : "denied"; // allowed echo $acl->isAllowed(marketing, latest, revise) ? "allowed" : "denied"; // denied echo $acl->isAllowed(editor, announcement, archive) ? "allowed" : "denied"; // denied echo $acl->isAllowed(administrator, announcement, archive) ? "allowed" : "denied"; // denied
996
// Remove the denial of revising latest news to staff (and marketing, // by inheritance) $acl->removeDeny(staff, latest, revise); echo $acl->isAllowed(marketing, latest, revise) ? "allowed" : "denied"; // allowed // Remove the allowance of publishing and archiving newsletters to // marketing $acl->removeAllow(marketing, newsletter, array(publish, archive)); echo $acl->isAllowed(marketing, newsletter, publish) ? "allowed" : "denied"; // denied echo $acl->isAllowed(marketing, newsletter, archive) ? "allowed" : "denied"; // denied
Privileges may be modied incrementally as indicated above, but a NULL value for the privileges overrides such incremental changes:
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// Allow marketing all permissions upon the latest news $acl->allow(marketing, latest); echo $acl->isAllowed(marketing, latest, publish) ? "allowed" : "denied"; // allowed echo $acl->isAllowed(marketing, latest, archive) ? "allowed" : "denied"; // allowed echo $acl->isAllowed(marketing, latest, anything) ? "allowed" : "denied"; // allowed
997
998
CHAPTER 216
Advanced Usage
class CleanIPAssertion implements Zend\Permissions\Acl\Assertion\AssertionInterface { public function assert(Zend\Permissions\Acl\Acl $acl, Zend\Permissions\Acl\Role\RoleInterface $role = null, Zend\Permissions\Acl\Resource\ResourceInterface $resource = null, $privilege = null) { return $this->_isCleanIP($_SERVER[REMOTE_ADDR]); }
999
11 12 13 14 15
Once an assertion class is available, the developer must supply an instance of the assertion class when assigning conditional rules. A rule that is created with an assertion only applies when the assertion method returns TRUE.
1 2 3 4
use Zend\Permissions\Acl\Acl; $acl = new Acl(); $acl->allow(null, null, null, new CleanIPAssertion());
The above code creates a conditional allow rule that allows access to all privileges on everything by everyone, except when the requesting IP is blacklisted. If a request comes in from an IP that is not considered clean, then the allow rule does not apply. Since the rule applies to all roles, all resources, and all privileges, an unclean IP would result in a denial of access. This is a special case, however, and it should be understood that in all other cases (i.e., where a specic role, resource, or privilege is specied for the rule), a failed assertion results in the rule not applying, and other rules would be used to determine whether access is allowed or denied. The assert() method of an assertion object is passed the ACL, role, resource, and privilege to which the authorization query (i.e., isAllowed()) applies, in order to provide a context for the assertion class to determine its conditions where needed.
1000
CHAPTER 217
Introduction to Zend\Permissions\Rbac
The Zend\Permissions\Rbac component provides a lightweight role-based access control implementation based around PHP 5.3s SPL RecursiveIterator and RecursiveIteratorIterator. RBAC differs from access control lists (ACL) by putting the emphasis on roles and their permissions rather than objects (resources). For the purposes of this documentation: an identity has one or more roles. a role requests access to a permission. a permission is given to a role. Thus, RBAC has the following model: many to many relationship between identities and roles. many to many relationship between roles and permissions. roles can have a parent role.
217.1 Roles
The easiest way to create a role is by extending the abstract class Zend\Permission\Rbac\AbstractRole or simply using the default class provided in Zend\Permission\Rbac\Role. You can instantiate a role and add it to the RBAC container or add a role directly using the RBAC container addRole() method.
217.2 Permissions
Each role can have zero or more permissions and can be set directly to the role or by rst retrieving the role from the RBAC container. Any parent role will inherit the permissions of their children.
1001
assertions which allow you to specify extra runtime credentials that must pass for access to be granted.
1002
CHAPTER 218
Methods
Zend\Permissions\Rbac\AbstractIterator current getChildren hasChildren key next rewind valid Zend\Permissions\Rbac\AbstractRole addChild addPermission getName hasPermission setParent getParent Zend\Permissions\Rbac\AssertionInterface assert Zend\Permissions\Rbac\Rbac addRole getCreateMissingRoles getRole hasRole isGranted setCreateMissingRoles
1003
Zend\Permissions\Rbac\Role __construct
1004
CHAPTER 219
Examples
219.1 Roles
Extending and adding roles via instantiation.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
<?php use Zend\Permissions\Rbac\Rbac; use Zend\Permissions\Rbac\AbstractRole; class MyRole extends AbstractRole { // .. implementation } // Creating roles manually $foo = new MyRole(foo); $rbac = new Rbac(); $rbac->addRole($foo); var_dump($rbac->hasRole(foo)); // true
1005
4 5 6 7 8 9 10 11 12 13 14 15
$rbac = new Rbac(); $foo = new Role(foo); $bar = new Role(bar); // 1 - Add a role with child role directly with instantiated classes. $foo->addChild($bar); $rbac->addRole($foo); // 2 - Same as one, only via rbac container. $rbac->addRole(boo, baz); // baz is a parent of boo $rbac->addRole(baz, array(out, of, roles)); // create several parents of baz
219.2 Permissions
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
<?php use Zend\Permissions\Rbac\Rbac; use Zend\Permissions\Rbac\Role; $rbac = new Rbac(); $foo = new Role(foo); $foo->addPermission(bar); var_dump($foo->hasPermission(bar)); // true $rbac->addRole($foo); $rbac->isGranted(foo, bar); // true $rbac->isGranted(foo, baz); // false $rbac->getRole(foo)->addPermission(baz); $rbac->isGranted(foo, baz); // true
<?php use Zend\Permissions\Rbac\AssertionInterface; use Zend\Permissions\Rbac\Rbac; class AssertUserIdMatches implements AssertionInterface { protected $userId; protected $article; public function __construct($userId) { $this->userId = $userId; } public function setArticle($article) { $this->article = $article; }
1006
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
public function assert(Rbac $rbac) { if (!$this->article) { return false; } return $this->userId == $article->getUserId(); } } // User is assigned the foo role with id 5 // News article belongs to userId 5 // Jazz article belongs to userId 6 $rbac $user $news $jazz = = = = new Rbac(); $mySessionObject->getUser(); $articleService->getArticle(5); $articleService->getArticle(6);
$rbac->addRole($user->getRole()); $rbac->getRole($user->getRole())->addPermission(edit.article); $assertion = new AssertUserIdMatches($user->getId()); $assertion->setArticle($news); // true always - bad! if ($rbac->isGranted($user->getRole(), edit.article)) { // hacks another users article } // true for user id 5, because he belongs to write group and user id matches if ($rbac->isGranted($user->getRole(), edit.article, $assertion)) { // edits his own article } $assertion->setArticle($jazz); // false for user id 5 if ($rbac->isGranted($user->getRole(), edit.article, $assertion)) { // can not edit another users article }
<?php // assume same variables from previous example $assertion = function($rbac) use ($user, $news) { return $user->getId() == $news->getUserId(); }; // true if ($rbac->isGranted($user->getRole(), edit.article, $assertion)) { // edits his own article }
1007
1008
CHAPTER 220
Progress Bars
220.1 Introduction
Zend\ProgressBar is a component to create and update progress bars in different environments. It consists of a single backend, which outputs the progress through one of the multiple adapters. On every update, it takes an absolute value and optionally a status message, and then calls the adapter with some precalculated values like percentage and estimated time left.
In the rst step, an instance of Zend\ProgressBar is created, with a specic adapter, a min-value of 0 and a max-value of the total lesize. Then a le is processed and in every loop the progressbar is updated with the current byte count. At the end of the loop, the progressbar status is set to nished. You can also call the update() method of Zend\ProgressBar without arguments, which just recalculates ETA and noties the adapter. This is useful when there is no data update but you want the progressbar to be updated.
but only when you call update() or finish(). Also the current value, the status text and the start time for ETA calculation will be fetched in the next request run again.
1010
nishMethodName: The JavaScript method which should be called after nish status was set. Default value is NULL, which means nothing is done. The usage of this adapter is quite simple. First you create a progressbar in your browser, either with JavaScript or previously created with plain HTML. Then you dene the update method and optionally the nish method in JavaScript, both taking a json object as single argument. Then you call a webpage with the long-running process in a hidden iframe or object tag. While the process is running, the adapter will call the update method on every update with a json object, containing the following parameters: current: The current absolute value max: The max absolute value percent: The calculated percentage timeTaken: The time how long the process ran yet timeRemaining: The expected time for the process to nish text: The optional status message, if given
Basic example for the client-side stuff
This example illustrates a basic setup of HTML, CSS and JavaScript for the JsPush adapter
1 2 3 4 5
<div id="zend-progressbar-container"> <div id="zend-progressbar-done"></div> </div> <iframe src="long-running-process.php" id="long-running-process"></iframe> #long-running-process { position: absolute; left: -100px; top: -100px; width: 1px; height: 1px; } #zend-progressbar-container { width: 100px; height: 30px; border: 1px solid #000000; background-color: #ffffff; }
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
1011
18 19 20 21 22 23
#zend-progressbar-done { width: 0; height: 30px; background-color: #000000; } function Zend\ProgressBar\Update(data) { document.getElementById(zend-progressbar-done).style.width = data.percent + %; }
This will create a simple container with a black border and a block which indicates the current process. You should not hide the iframe or object by display: none;, as some browsers like Safari 2 will not load the actual content then. Instead of creating your custom progressbar, you may want to use one of the available JavaScript libraries like Dojo, jQuery etc. For example, there are: Dojo: http://dojotoolkit.org/reference-guide/dijit/ProgressBar.html jQuery: http://t.wits.sg/2008/06/20/jquery-progress-bar-11/ MooTools: http://davidwalsh.name/dw-content/progress-bar.php Prototype: http://livepipe.net/control/progressbar Note: Interval of updates You should take care of not sending too many updates, as every update has a min-size of 1kb. This is a requirement for the Safari browser to actually render and execute the function call. Internet Explorer has a similar limitation of 256 bytes.
1012
CHAPTER 221
221.1 Introduction
Zend\ProgressBar\Upload provides handlers that can give you the actual state of a le upload in progress. To use this feature you need to choose one of the upload progress handlers (APC, uploadprogress, or Session) and ensure that your server setup has the appropriate extension or feature enabled. All of the progress handlers use the same interface. When uploading a le with a form POST, you must also include the progress identier in a hidden input. The File Upload Progress View Helpers provide a convenient way to add the hidden input based on your handler type.
$adapter = new \Zend\ProgressBar\Adapter\JsPush(); $progress = new \Zend\ProgressBar\Upload\SessionProgress(); $filter $id = new \Zend\I18n\Filter\Alnum(false, en_US); = $filter->filter($_GET[id]);
Each time the getProgress() method is called, the ProgressBar adapter will be updated.
1013
// In a Controller... public function sessionProgressAction() { $id = $this->params()->fromQuery(id, null); $progress = new \Zend\ProgressBar\Upload\SessionProgress(); return new \Zend\View\Model\JsonModel($progress->getProgress($id)); } // Returns JSON //{ // "total" // "current" // "rate" // "message" // "done" //}
: : : : :
1014
This handler is best used with the FormFileApcProgress view helper, to provide a hidden element with the upload progress identier.
1015
1016
CHAPTER 222
Introduction to Zend\Serializer
The Zend\Serializer component provides an adapter based interface to simply generate storable representation of PHP types by different facilities, and recover. For more information what a serializer is read the wikipedia page of Serialization.
use Zend\Serializer\Serializer; // Via factory: $serializer = Zend\Serializer\Serializer::factory(PhpSerialize); // Alternately: $serializer = new Zend\Serializer\Adapter\PhpSerialize(); // Now $serializer is an instance of Zend\Serializer\Adapter\AdapterInterface, // specifically Zend\Serializer\Adapter\PhpSerialize try { $serialized = $serializer->serialize($data); // now $serialized is a string $unserialized = $serializer->unserialize($serialized); // now $data == $unserialized } catch (Zend\Serializer\Exception\ExceptionInterface $e) { echo $e; }
The method serialize() generates a storable string. To regenerate this serialized data you can simply call the method unserialize(). Any time an error is encountered serializing or unserializing, Zend\Serializer\Exception\ExceptionInterface. Zend\Serializer will throw a
1017
Because of an application often uses internally only one serializer it is possible to dene and use a default serializer. That serializer will be used by default by other components like Zend\Cache\Storage\Plugin\Serializer. To use the default serializer you can simply use the static serialization methods of the basic Zend\Serializer\Serializer:
1 2 3 4 5 6 7 8 9 10 11
use Zend\Serializer\Serializer; try { $serialized = Serializer::serialize($data); // now $serialized is a string $unserialized = Serializer::unserialize($serialized); // now $data == $unserialized } catch (Zend\Serializer\Exception\ExceptionInterface $e) { echo $e; }
factory(string|Zend\Serializer\Adapter\AdapterInterface $adapterName, Zend\Serializer\Adapter\AdapterOptions|array|Traversable $adapterOptions = null) Create a serializer adapter instance. Return type Zend\Serializer\Adapter\AdapterInterface setAdapterPluginManager(Zend\Serializer\AdapterPluginManager $adapters) Change the adapter plugin manager.
1018
Return type void getAdapterPluginManager() Get the adapter plugin manager. Return type Zend\Serializer\AdapterPluginManager resetAdapterPluginManager() Resets the internal adapter plugin manager. Return type void setDefaultAdapter(string|Zend\Serializer\Adapter\AdapterInterface $adapter, Zend\Serializer\Adapter\AdapterOptions|array|Traversable|null $adapterOptions = null) Change the default adapter. Return type void getDefaultAdapter() Get the default adapter. Return type Zend\Serializer\Adapter\AdapterInterface serialize(mixed $value, string|Zend\Serializer\Adapter\AdapterInterface|null $adapter = null, Zend\Serializer\Adapter\AdapterOptions|array|Traversable|null $adapterOptions = null) Generates a storable representation of a value using the default adapter. Optionally different adapter could be provided as second argument. Return type string unserialize(string $value, string|Zend\Serializer\Adapter\AdapterInterface|null $adapter = null, Zend\Serializer\Adapter\AdapterOptions|array|Traversable|null $adapterOptions = null) Creates a PHP value from a stored representation using the default adapter. Optionally different adapter could be provided as second argument. Return type mixed
1019
1020
CHAPTER 223
Zend\Serializer\Adapter
Zend\Serializer adapters create a bridge for different methods of serializing with very little effort. Every adapter has different pros and cons. In some cases, not every PHP datatype (e.g., objects) can be converted to a string representation. In most such cases, the type will be converted to a similar type that is serializable. As an example, PHP objects will often be cast to arrays. Zend\Serializer\Exception\ExceptionInterface will be thrown. If this fails, a
1021
Additionally, the SimpleXML PHP extension is used to check if a returned NULL value from wddx_unserialize() is based on a serialized NULL or on invalid data. Available options include: Table 223.1: ZendSerializerAdapterWddx Options Option comment Data Type string Default Value Description An optional comment that appears in the packet header.
Table 223.4: Datatype merging (PHP to Python Pickle) PHP Type NULL boolean integer float string array list array map object Python Pickle Type None boolean integer float string list dictionary dictionary
1022
Table 223.5: Datatype merging (Python Pickle to PHP) Python Pickle Type None boolean integer long oat string bytes unicode string list tuple dictionary All other types PHP Type NULL boolean integer integer or float or string or Zend\Serializer\Exception\ExceptionInterface float string string string UTF-8 array list array list array map Zend\Serializer\Exception\ExceptionInterface
1023
1024
CHAPTER 224
Introduction to Zend\Server
The Zend\Server family of classes provides functionality for the various server classes, including Zend\XmlRpc\Server and Zend\Json\Server. Zend\Server\Server provides an interface that mimics PHP 5s SoapServer class; all server classes should implement this interface in order to provide a standard server API. The Zend\Server\Reflection tree provides a standard mechanism for performing function and class introspection for use as callbacks with the server classes, and provides data suitable for use with Zend\Server\Servers getFunctions() and loadFunctions() methods.
1025
1026
CHAPTER 225
Zend\Server\Reection
225.1 Introduction
Zend\Server\Reflection provides a standard mechanism for performing function and class introspection for use with server classes. It is based on PHP 5s Reection API, augmenting it with methods for retrieving parameter and return value types and descriptions, a full list of function and method prototypes (i.e., all possible valid calling combinations), and function or method descriptions. Typically, this functionality will only be used by developers of server classes for the framework.
225.2 Usage
Basic usage is simple:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
$class = Zend\Server\Reflection::reflectClass(My\Class); $function = Zend\Server\Reflection::reflectFunction(my_function); // Get prototypes $prototypes = $function->getPrototypes(); // Loop through each prototype for the function foreach ($prototypes as $prototype) { // Get prototype return type echo "Return type: ", $prototype->getReturnType(), "\n"; // Get prototype parameters $parameters = $prototype->getParameters(); echo "Parameters: \n"; foreach ($parameters as $parameter) { // Get parameter type echo " ", $parameter->getType(), "\n"; } } // Get namespace for a class, function, or method.
1027
24 25 26
// Namespaces may be set at instantiation time (second argument), or using // setNamespace() $class->getNamespace();
reflectFunction() returns a Zend\Server\Reflection\Function object; reflectClass() returns a Zend\Server\Reflection\Class object. Please refer to the API documentation to see what methods are available to each.
1028
CHAPTER 226
Zend\ServiceManager
The Service Locator design pattern is implemented by the Zend\ServiceManager component. The Service Locator is a service/object locator, tasked with retrieving other objects. Following is the Zend\ServiceManager\ServiceLocatorInterface API:
namespace Zend\ServiceManager; interface ServiceLocatorInterface { public function get($name); public function has($name); }
has($name), tests whether the ServiceManager has a named service; get($name), retrieves a service by the given name. A Zend\ServiceManager\ServiceManager is an implementation of the ServiceLocatorInterface. In addition to the above described methods, the ServiceManager provides additional API: Service registration. ServiceManager::setService allows you to register an object as a service:
$serviceManager->setService(my-foo, new stdClass()); $serviceManager->setService(my-settings, array(password => super-secret)); var_dump($serviceManager->get(my-foo)); // an instance of stdClass var_dump($serviceManager->get(my-settings)); // array(password => super-secret)
Lazy-loaded service objects. ServiceManager::setInvokableClass allows you to tell the ServiceManager what class to instantiate when a particular service is requested:
$serviceManager->setInvokableClass(foo-service-name, Fully\Qualified\Classname); var_dump($serviceManager->get(foo-service-name)); // an instance of Fully\Qualified\Classname
Service factories. Instead of an actual object instance or a class name, you can tell the ServiceManager to invoke a provided factory in order to get the object instance. Factories may be either a PHP callback, an object implementing Zend\ServiceManager\FactoryInterface, or the name of a class implementing that interface:
use Zend\ServiceManager\FactoryInterface; use Zend\ServiceManager\ServiceLocatorInterface;
1029
class MyFactory implements FactoryInterface { public function createService(ServiceLocatorInterface $serviceLocator) { return new \stdClass(); } } // registering a factory instance $serviceManager->setFactory(foo-service-name, new MyFactory()); // registering a factory by factory class name $serviceManager->setFactory(bar-service-name, MyFactory); // registering a callback as a factory $serviceManager->setFactory(baz-service-name, function () { return new \stdClass(); }); var_dump($serviceManager->get(foo-service-name)); // stdClass(1) var_dump($serviceManager->get(bar-service-name)); // stdClass(2) var_dump($serviceManager->get(baz-service-name)); // stdClass(3)
Service aliasing. With ServiceManager::setAlias you can create aliases of any registered service, factory or invokable, or even other aliases:
$foo = new \stdClass(); $foo->bar = baz!; $serviceManager->setService(my-foo, $foo); $serviceManager->setAlias(my-bar, my-foo); $serviceManager->setAlias(my-baz, my-bar); var_dump($serviceManager->get(my-foo)->bar); // baz! var_dump($serviceManager->get(my-bar)->bar); // baz! var_dump($serviceManager->get(my-baz)->bar); // baz!
Abstract factories. An abstract factory can be considered as a fallback factory. If the service manager was not able to nd a service for the requested name, it will check the registered abstract factories:
use Zend\ServiceManager\ServiceLocatorInterface; use Zend\ServiceManager\AbstractFactoryInterface;
class MyAbstractFactory implements AbstractFactoryInterface { public function canCreateServiceWithName(ServiceLocatorInterface $serviceLocator, $name, $re { // this abstract factory only knows about foo and bar return $requestedName === foo || $requestedName === bar; }
public function createServiceWithName(ServiceLocatorInterface $serviceLocator, $name, $reque { $service = new \stdClass(); $service->name = $requestedName; return $service; } }
1030
$serviceManager->addAbstractFactory(MyAbstractFactory);
Initializers. You may want certain injection points to be always called. As an example, any object you load via the service manager that implements Zend\EventManager\EventManagerAwareInterface should likely receive an EventManager instance. Initializers are PHP callbacks or classes implementing Zend\ServiceManager\InitializerInterface. They receive the new instance, and can then manipulate it:
use Zend\ServiceManager\ServiceLocatorInterface; use Zend\ServiceManager\InitializerInterface; class MyInitializer implements InitializerInterface { public function initialize($instance, ServiceLocatorInterface $serviceLocator) { if ($instance instanceof \stdClass) { $instance->initialized = initialized!; } } } $serviceManager->setInvokableClass(my-service, stdClass); var_dump($serviceManager->get(my-service)->initialized); // initialized!
In addition to the above, the ServiceManager also provides optional ties to Zend\Di, allowing Di to act as an initializer or an abstract factory for the service manager.
1031
1032
CHAPTER 227
By default, Zend Framework utilizes Zend\ServiceManager within the MVC layer and in various other components. As such, in most cases youll be providing services, invokable classes, aliases, and factories either via conguration or via your module classes. By default, the module manager listener Zend\ModuleManager\Listener\ServiceListener will do the following: For modules implementing Zend\ModuleManager\Feature\ServiceProviderInterface, or the getServiceConfig() method, it will call that method and merge the retrieved conguration. After all modules have been processed, it will grab the conguration from the registered Zend\ModuleManager\Listener\ConfigListener, and merge any conguration under the service_manager key. Finally, it will use the merged conguration to congure the ServiceManager instance. In most cases, you wont interact with the ServiceManager, other than to providing services to it; your application will typically rely on the conguration of the ServiceManager to ensure that services are congured correctly with their dependencies. When creating factories, however, you may want to interact with the ServiceManager to retrieve other services to inject as dependencies. Additionally, there are some cases where you may want to receive the ServiceManager to lazy-retrieve dependencies; as such, you may want to implement ServiceLocatorAwareInterface and know more details about the API of the ServiceManager.
1033
services, an array of service name/object pairs. Clearly, this will only work with PHP conguration. shared, an array of service name/boolean pairs, indicating whether or not a service should be shared. By default, the ServiceManager assumes all services are shared, but you may specify a boolean false value here to indicate a new instance should be returned.
As noted previously, this conguration will be merged with the conguration returned from other modules as well as conguration les, prior to being passed to the ServiceManager; this allows overriding conguration from modules easily.
227.3 Examples
227.3.1 Sample Conguration
The following is valid conguration for any conguration being merged in your application, and demonstrates each of the possible conguration keys. Conguration is merged in the following order: Conguration returned from Module classes via the getServiceConfig() method, in the order in which modules are processed. Module conguration under the service_manager key, in the order in which modules are processed. Application conguration under the config/autoload/ directory, in the order in which they are processed. As such, you have a variety of ways to override service manager conguration settings.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
<?php // a module configuration, "module/SomeModule/config/module.config.php" return array( service_manager => array( abstract_factories => array( // Valid values include names of classes implementing // AbstractFactoryInterface, instances of classes implementing // AbstractFactoryInterface, or any PHP callbacks SomeModule\Service\FallbackFactory, ), aliases => array( // Aliasing a FQCN to a service name SomeModule\Model\User => User, // Aliasing a name to a known service name AdminUser => User, // Aliasing to an alias
1034
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
SuperUser => AdminUser, ), factories => array( // Keys are the service names. // Valid values include names of classes implementing // FactoryInterface, instances of classes implementing // FactoryInterface, or any PHP callbacks User => SomeModule\Service\UserFactory, UserForm => function ($serviceManager) { $form = new SomeModule\Form\User(); // Retrieve a dependency from the service manager and inject it! $form->setInputFilter($serviceManager->get(UserInputFilter)); return $form; }, ), invokables => array( // Keys are the service names // Values are valid class names to instantiate. UserInputFiler => SomeModule\InputFilter\User, ), services => array( // Keys are the service names // Values are objects Auth => new SomeModule\Authentication\AuthenticationService(), ), shared => array( // Usually, youll only indicate services that should **NOT** be // shared -- i.e., ones where you want a different instance // every time. UserForm => false, ), ), );
Note: Conguration and PHP Typically, you should not have your conguration les create new instances of objects or even closures for factories; at the time of conguration, not all autoloading may be in place, and if another conguration overwrites this one later, youre now spending CPU and memory performing work that is ultimately lost. For instances that require factories, write a factory. If youd like to inject specic, congured instances, use the Module class to do so, or a listener. Additionally you will lose the ability to use the caching feature of the conguration les when you use closures within them. This is a limitation of PHP which cant (de)serialize closures.
Note: Service names good practices When dening a new service, it is usually a good idea to use the fully qualied class name of the produced instance or of one of the interfaces it implements as service name. Using a FQCN as service name makes collisions with other services very hard if the class is part of your own code base, and also aids the developer that consumes that service to have a clear overview on what the API of the service looks like. If the service is not an instance of a class/interface of your own code base, you should always consider using a prex for it, so that collisions with other services are avoided. 227.3. Examples 1035
namespace SomeModule; // you may eventually want to implement Zend\ModuleManager\Feature\ServiceProviderInterface class Module { public function getServiceConfig() { return array( abstract_factories => array(), aliases => array(), factories => array(), invokables => array(), services => array(), shared => array(), ); } }
By default, the Zend Framework MVC registers an initializer that will inject the ServiceManager instance, which is an implementation of Zend\ServiceManager\ServiceLocatorInterface, into any class implementing Zend\ServiceManager\ServiceLocatorAwareInterface. A simple implementation looks like following:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
namespace SomeModule\Controller; use use use use use Zend\ServiceManager\ServiceLocatorAwareInterface; Zend\ServiceManager\ServiceLocatorInterface; Zend\Stdlib\DispatchableInterface as Dispatchable; Zend\Stdlib\RequestInterface as Request; Zend\Stdlib\ResponseInterface as Response;
class BareController implements Dispatchable, ServiceLocatorAwareInterface { protected $services; public function setServiceLocator(ServiceLocatorInterface $serviceLocator) { $this->services = $serviceLocator; } public function getServiceLocator() { return $this->services; }
1036
24 25 26 27 28 29 30 31 32 33 34
public function dispatch(Request $request, Response $response = null) { // ... // Retrieve something from the service manager $router = $this->getServiceLocator()->get(Router); // ... } }
227.3. Examples
1037
1038
CHAPTER 228
Zend\ServiceManager can instantiate delegators of requested services, decorating them as specied in a delegate factory implementing the delegator factory interface. The delegate pattern is useful in cases when you want to wrap a real service in a decorator, or generally intercept actions being performed on the delegate in an AOP fashioned way.
The parameters passed to the DelegatorFactoryInterface#createDelegatorWithName factory are the following: $serviceLocator is the service locator that is used while creating the delegator for the requested service $name is the canonical name of the service being requested $requestedName is the name of the service as originally requested to the service locator $callback is a callable that is responsible of instantiating the delegated service (the real service instance)
1039
1 2 3 4 5 6 7
use Zend\EventManager\EventManagerInterface; class BuzzerDelegator extends Buzzer { protected $realBuzzer; protected $eventManager; public function __construct(Buzzer $realBuzzer, EventManagerInterface $eventManager) { $this->realBuzzer = $realBuzzer; $this->eventManager = $eventManager; } public function buzz() { $this->eventManager->trigger(buzz, $this); return $this->realBuzzer->buzz(); } }
$wrappedBuzzer = new Buzzer(); $eventManager = new Zend\EventManager\EventManager(); $eventManager->attach(buzz, function () { echo "Stare at the art!\n"; }); $buzzer = new BuzzerDelegator($wrappedBuzzer, $eventManager); echo $buzzer->buzz(); // "Stare at the art!\nBuzz!"
This logic is fairly simple as long as you have access to the instantiation logic of the $wrappedBuzzer object. You may not always be able to dene how $wrappedBuzzer is created, since a factory for it may be dened by some code to which you dont have access, or which you cannot modify without introducing further complexity. Delegator factories solve this specic problem by allowing you to wrap, decorate or modify any existing service. A simple delegator factory for the buzzer service can be implemented as following:
1 2 3 4 5 6 7 8 9
class BuzzerDelegatorFactory implements DelegatorFactoryInterface { public function createDelegatorWithName(ServiceLocatorInterface $serviceLocator, $name, $requeste { $realBuzzer = call_user_func($callback); $eventManager = $serviceLocator->get(EventManager);
1040
10 11 12 13 14 15
$eventManager->attach(buzz, function () { echo "Stare at the art!\n"; }); return new BuzzerDelegator($realBuzzer, $eventManager); } }
You can then instruct the service manager to handle the service buzzer as a delegate:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
$serviceManager = new Zend\ServiceManager\ServiceManager(); $serviceManager->setInvokableClass(buzzer, Buzzer); // usually not under our control // as opposed to normal factory classes, a delegator factory is a // service like any other, and must be registered: $serviceManager->setInvokableClass(buzzer-delegator-factory, BuzzerDelegatorFactory); // telling the service manager to use a delegator factory to handle service buzzer $serviceManager->addDelegator(buzzer, buzzer-delegator-factory); // now, when fetching buzzer, we get a BuzzerDelegator instead $buzzer = $serviceManager->get(buzzer); $buzzer->buzz(); // "Stare at the art!\nBuzz!"
You can also call $serviceManager->addDelegator() multiple times, with the same or different delegator factory service names. Each call will add one decorator around the instantiation logic of that particular service. Another way of conguring the service manager to use delegator factories is via conguration:
1 2 3 4 5 6 7 8 9 10 11 12
$config = array( invokables => array( buzzer => Buzzer, buzzer-delegator-factory => BuzzerDelegatorFactory, ), delegators => array( buzzer => array( buzzer-delegator-factory // eventually add more delegators here ), ), );
1041
1042
CHAPTER 229
Lazy Services
Zend\ServiceManager can use delegator factories to generate lazy references to your services. Lazy services are proxies that get lazily instantiated, and keep a reference to the real instance of the proxied service.
229.2 Setup
Zend\ServiceManager\Proxy\LazyServiceFactory is a delegator factory capable of generating lazy loading proxies for your services. The LazyServiceFactory depends on ProxyManager, so be sure to install it before going through the following steps:
php composer.phar require ocramius/proxy-manager:0.3.*
1043
5 6 7 8 9 10 11 12 13 14 15
public function __construct() { // deliberately halting the application for 5 seconds sleep(5); } public function buzz() { return Buzz!; } }
You can then proceed and congure the service manager to generate proxies instead of real services:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
$serviceManager = new \Zend\ServiceManager\ServiceManager(); $config = array( lazy_services => array( // mapping services to their class names is required // since the ServiceManager is not a declarative DIC map => array( buzzer => MyApp\Buzzer, ), ), );
This will tell the service manager to use the LazyServiceFactory delegator factory to instantiate the buzzer service. As you may have noticed, the standard setup for the LazyServiceFactory requires you to dene a Config service. Thats because the functionality was thought to be easily integrated into Zend\Mvc. You can now simply retrieve the buzzer:
1 2 3
To verify that the proxying occurred correctly, you can simply run the following code, which should delay the 5 seconds wait time hardcoded in Buzzer::__construct until Buzzer::buzz is invoked:
1 2 3 4 5 6 7
for ($i = 0; $i < 100; $i += 1) { $buzzer = $serviceManager->create(buzzer); echo "created buzzer $i\n"; } echo $buzzer->buzz();
The setup above can also be represented via conguration in an MVC applications context:
1 2 3 4
return array( service_manager => array( invokables => array( buzzer => MyApp\Buzzer,
1044
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
), delegators => array( buzzer => array( LazyServiceFactory ), ), factories => array( LazyServiceFactory => Zend\ServiceManager\Proxy\LazyServiceFactoryFactory, ), ), lazy_services => array( map => array( buzzer => MyApp\Buzzer, ), ), );
229.4 Conguration
This is the cong structure expected by Zend\ServiceManager\Proxy\LazyServiceFactoryFactory:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
return array( lazy_services => array( // map of service names and their relative class names - this // is required since the service manager cannot know the // class name of defined services upfront map => array( // foo => MyApplication\Foo, ), // directory where proxy classes will be written - default to system_get_tmp_dir() proxies_target_dir => null, // boolean flag to indicate whether to generate proxies // proxies are auto-generated by default auto_generate_proxies => null, // namespace of the generated proxies, default to "ProxyManagerGeneratedProxy" proxies_namespace => null, // whether the generated proxy classes should be written to disk write_proxy_files => false, ), );
229.4. Conguration
1045
1046
CHAPTER 230
Session Cong
Zend Framework comes with a standard set of cong classes which are ready for you to use. Cong handles setting various conguration such as where a cookie lives, lifetime, including several bits to congure ext/session when using Zend\Session\Config\SessionConfig.
1047
1048
CHAPTER 231
Standard Cong
Zend\Session\Config\StandardConfig provides you a basic interface for implementing sessions when not leveraging ext/session. This is utilized more for specialized cases such as when you might have session management done by another system.
1049
1050
CHAPTER 232
Basic Usage
use Zend\Session\Config\StandardConfig; use Zend\Session\SessionManager; $config = new StandardConfig(); $config->setOptions(array( remember_me_seconds => 1800, name => zf2, )); $manager = new SessionManager($config);
1051
1052
CHAPTER 233
Session Cong
Zend\Session\Config\SessionConfig provides you a basic interface for implementing sessions when that leverage PHPs ext/session. Most conguration options congure either the Zend\Session\Storage OR congure ext/session directly.
1053
1054
CHAPTER 234
Basic Usage
use Zend\Session\Config\SessionConfig; use Zend\Session\SessionManager; $config = new SessionConfig(); $config->setOptions(array( phpSaveHandler => redis, savePath => tcp://127.0.0.1:6379?weight=1&timeout=1, )); $manager = new SessionManager($config);
1055
1056
CHAPTER 235
Session Container
Zend\Session\Container instances provide the primary API for manipulating session data in the Zend Framework. Containers are used to segregate all session data, although a default namespace exists for those who only want one namespace for all their session data. Each instance of Zend\Session\Container corresponds to an entry of the Zend\Session\Storage, where the namespace is used as the key. Zend\Session\Container itself is an instance of an ArrayObject.
1057
1058
CHAPTER 236
Session Manager
The session manager, Zend\Session\SessionManager, is a class that is responsible for all aspects of session management. It initializes and congures conguration, storage and save handling. Additionally the session manager can be injected into the session container to provide a wrapper or namespace around your session data. The session manager is responsible for session start, session exists, session write, regenerate id, time to live and session destroy. The session manager can validate sessions from a validator chain to ensure that the session data is indeed correct.
return array( session => array( config => array( class => Zend\Session\Config\SessionConfig, options => array( name => myapp, ), ), storage => Zend\Session\Storage\SessionArrayStorage, validators => array( Zend\Session\Validator\RemoteAddr, Zend\Session\Validator\HttpUserAgent, ), ), );
The following illustrates how you might utilize the above conguration to create the session manager:
1 2
1059
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
class Module { public function onBootstrap($e) { $eventManager = $e->getApplication()->getEventManager(); $serviceManager = $e->getApplication()->getServiceManager(); $moduleRouteListener = new ModuleRouteListener(); $moduleRouteListener->attach($eventManager); $this->bootstrapSession($e); } public function bootstrapSession($e) { $session = $e->getApplication() ->getServiceManager() ->get(Zend\Session\SessionManager); $session->start(); $container = new Container(initialized); if (!isset($container->init)) { $session->regenerateId(true); $container->init = 1; } } public function getServiceConfig() { return array( factories => array( Zend\Session\SessionManager => function ($sm) { $config = $sm->get(config); if (isset($config[session])) { $session = $config[session];
$sessionConfig = null; if (isset($session[config])) { $class = isset($session[config][class]) ? $session[config][class $options = isset($session[config][options]) ? $session[config][opt $sessionConfig = new $class(); $sessionConfig->setOptions($options); } $sessionStorage = null; if (isset($session[storage])) { $class = $session[storage]; $sessionStorage = new $class(); }
$sessionSaveHandler = null; if (isset($session[save_handler])) { // class should be fetched from service manager since it will require con $sessionSaveHandler = $sm->get($session[save_handler]); }
1060
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
$chain = $sessionManager->getValidatorChain(); foreach ($session[validators] as $validator) { $validator = new $validator(); $chain->attach(session.validate, array($validator, isValid)); } } } else { $sessionManager = new SessionManager(); } Container::setDefaultManager($sessionManager); return $sessionManager; }, ), ); } }
When you create a new Zend\Session\Container (see Session Container page) in a controller for example, it will use the session congured above.
1061
1062
CHAPTER 237
Zend Framework comes with a standard set of save handler classes which are ready for you to use. Save Handlers themselves are decoupled from PHPs save handler functions and are only implemented as a PHP save handler when utilized in conjunction with Zend\Session\SessionManager.
1063
1064
CHAPTER 238
Cache
Zend\Session\SaveHandler\Cache allows you to provide an instance of Zend\Cache to be utilized as a session save handler. Generally if you are utilizing the Cache save handler; you are likely using products such as memcached.
use Zend\Cache\StorageFactory; use Zend\Session\SaveHandler\Cache; use Zend\Session\SessionManager; $cache = StorageFactory::factory(array( name => memcached, options => array( server => 127.0.0.1, ), )); $saveHandler = new Cache($cache); $manager = new SessionManager(); $manager->setSaveHandler($saveHandler);
1065
1066
CHAPTER 239
DbTableGateway
Zend\Session\SaveHandler\DbTableGateway allows you to utilize Zend\Db as a session save handler. Setup of the DbTableGateway requires an instance of Zend\Db\TableGateway\TableGateway and an instance of Zend\Session\SaveHandler\DbTableGatewayOptions. In the most basic setup, a TableGateway object and using the defaults of the DbTableGatewayOptions will provide you with what you need.
CREATE TABLE session ( id char(32), name char(32), modified int, lifetime int, data text, PRIMARY KEY (id, name) );
$tableGateway = new TableGateway(session, $adapter); $saveHandler = new DbTableGateway($tableGateway, new DbTableGatewayOptions()); $manager = new SessionManager(); $manager->setSaveHandler($saveHandler);
1067
1068
CHAPTER 240
MongoDB
Zend\Session\SaveHandler\MongoDB allows you to provide a MongoDB instance to be utilized as a session save handler. You provide the options in the Zend\Session\SaveHandler\MongoDBOptions class.
$mongo = new Mongo(); $options = new MongoDBOptions(array( database => myapp, collection => sessions, )); $saveHandler = new MongoDB($mongo, $options); $manager = new SessionManager(); $manager->setSaveHandler($saveHandler);
1069
1070
CHAPTER 241
Session Storage
Zend Framework comes with a standard set of storage classes which are ready for you to use. Storage handlers is the intermediary between when the session starts and when the session writes and closes. The default session storage is Zend\Session\Storage\SessionArrayStorage.
1071
1072
CHAPTER 242
Array Storage
Zend\Session\Storage\ArrayStorage provides a facility to store all information in an ArrayObject. This storage method is likely incompatible with 3rd party libraries and all properties will be inaccessible through the $_SESSION property. Additionally ArrayStorage will not automatically repopulate the storage container in the case of each new request and would have to manually be re-populated.
use Zend\Session\Storage\ArrayStorage; use Zend\Session\SessionManager; $populateStorage = array(foo => bar); $storage = new ArrayStorage($populateStorage); $manager = new SessionManager(); $manager->setStorage($storage);
1073
1074
CHAPTER 243
Session Storage
Zend\Session\Storage\SessionStorage replaces $_SESSION providing a facility to store all information in an ArrayObject. This means that it may not be compatible with 3rd party libraries. Although information stored in the $_SESSION superglobal should be available in other scopes.
1075
1076
CHAPTER 244
Zend\Session\Storage\SessionArrayStorage provides a facility to store all information directly in the $_SESSION superglobal. This storage class provides the most compatibility with 3rd party libraries and allows for directly storing information into $_SESSION.
1077
1078
CHAPTER 245
Session Validators
Session validators provide various protection against session hijacking. Session hijacking in particular has various drawbacks when you are protecting against it. Such as an IP address may change from the end user depending on their ISP; or a browsers user agent may change during the request either by a web browser extension OR an upgrade that retains session cookies.
1079
1080
CHAPTER 246
Zend\Session\Validator\HttpUserAgent provides a validator to check the session against the originally stored $_SERVER[HTTP_USER_AGENT] variable. Validation will fail in the event that this does not match and throws an exception in Zend\Session\SessionManager after session_start() has been called.
use Zend\Session\Validator\HttpUserAgent; use Zend\Session\SessionManager; $manager = new SessionManager(); $manager->getValidatorChain()->attach(session.validate, array(new HttpUserAgent(), isValid));
1081
1082
CHAPTER 247
Remote Addr
Zend\Session\Validator\RemoteAddr provides a validator to check the session against the originally stored $_SERVER[REMOTE_ADDR] variable. Validation will fail in the event that this does not match and throws an exception in Zend\Session\SessionManager after session_start() has been called.
use Zend\Session\Validator\RemoteAddr; use Zend\Session\SessionManager; $manager = new SessionManager(); $manager->getValidatorChain()->attach(session.validate, array(new RemoteAddr(), isValid));
1083
1084
CHAPTER 248
Zend\Soap\Server
Zend\Soap\Server class is intended to simplify Web Services server part development for PHP programmers. It may be used in WSDL or non-WSDL mode, and using classes or functions to dene Web Service API. When Zend\Soap\Server component works in the WSDL mode, it uses already prepared WSDL document to dene server object behavior and transport layer options. WSDL document may be auto-generated with functionality provided by Zend\Soap\AutoDiscovery component or should be constructed manually using Zend\Soap\Wsdl class or any other XML generating tool. If the non-WSDL mode is used, then all protocol options have to be set using options mechanism.
May be set later using setWsdl($wsdl) method. Options may be set later using setOptions($options) method.
1085
... class MyClass { /** * This method takes ... * * @param integer $inputParam * @return string */ public function method1($inputParam) { ... } /** * This method takes ... * * @param integer $inputParam1 * @param string $inputParam2 * @return float */ public function method2($inputParam1, $inputParam2) { ... } ... } ... $server = new Zend\Soap\Server(null, $options); // Bind Class to Soap Server $server->setClass(MyClass);
3
1086
30 31 32 33
// Bind already initialized object to Soap Server $server->setObject(new MyClass()); ... $server->handle();
Note: Important! You should completely describe each method using method docblock if you plan to use autodiscover functionality to prepare corresponding Web Service WSDL. The second method of dening Web Service API is using set of functions and addFunction() or loadFunctions() methods:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
... /** * This function ... * * @param integer $inputParam * @return string */ function function1($inputParam) { ... } /** * This function ... * * @param integer $inputParam1 * @param string $inputParam2 * @return float */ function function2($inputParam1, $inputParam2) { ... } ... $server = new Zend\Soap\Server(null, $options); $server->addFunction(function1); $server->addFunction(function2); ... $server->handle();
1087
... $server = new Zend\Soap\Server(...); ... // Set request using optional $request parameter $server->handle($request); ... // Set request using setRequest() method $server->setRequest(); $server->handle();
Request object may be represented using any of the following: DOMDocument (casted to XML) DOMNode (owner document is grabbed and casted to XML) SimpleXMLElement (casted to XML) stdClass (__toString() is called and veried to be valid XML) string (veried to be valid XML) Last processed request may be retrieved using getLastRequest() method as an XML string:
1 2 3 4 5
... $server = new Zend\Soap\Server(...); ... // Get a response as a return value of handle() method // instead of emitting it to the standard output $server->setReturnResponse(true); ... $response = $server->handle(); if ($response instanceof \SoapFault) { ... } else { ...
4
Current state of the Return Response ag may be requested with setReturnResponse() method.
1088
13 14
} ...
Last response may be also retrieved by getLastResponse() method for some post-processing:
1 2 3 4 5 6 7 8 9 10 11
... $server = new Zend\Soap\Server(...); ... $server->handle(); $response = $server->getLastResponse(); if ($response instanceof \SoapFault) { ... } else { ... } ...
1089
1090
CHAPTER 249
Zend\Soap\Client
The Zend\Soap\Client class simplies SOAP client development for PHP programmers. It may be used in WSDL or non-WSDL mode. Under the WSDL mode, the Zend\Soap\Client component uses a WSDL document to dene transport layer options. The WSDL description is usually provided by the web service the client will access. If the WSDL description is not made available, you may want to use Zend\Soap\Client in non-WSDL mode. Under this mode, all SOAP protocol options have to be set explicitly on the Zend\Soap\Client class.
uri - target namespace for the SOAP service (required for non-WSDL-mode, doesnt work for WSDL mode).
1091
location - the URL to request (required for non-WSDL-mode, doesnt work for WSDL mode). style - request style (doesnt work for WSDL mode): SOAP_RPC or SOAP_DOCUMENT. use - method to encode messages (doesnt work for WSDL mode): SOAP_ENCODED or SOAP_LITERAL. login and password - login and password for an HTTP authentication. proxy_host, proxy_port, proxy_login, and proxy_password - an HTTP connection through a proxy server. local_cert and passphrase -HTTPS client certicate authentication options. compression - compression options; its a combination of SOAP_COMPRESSION_ACCEPT, SOAP_COMPRESSION_GZIP and SOAP_COMPRESSION_DEFLATE options which may be used like this:
1 2 3 4 5 6 7 8 9 10 11 12 13
// Accept response compression $client = new Zend\Soap\Client("some.wsdl", array(compression => SOAP_COMPRESSION_ACCEPT)); ... // Compress requests using gzip with compression level 5 $client = new Zend\Soap\Client("some.wsdl", array(compression => SOAP_COMPRESSION_ACCEPT | SOAP_COMPRESSION_GZIP | 5)); ... // Compress requests using deflate compression $client = new Zend\Soap\Client("some.wsdl", array(compression => SOAP_COMPRESSION_ACCEPT | SOAP_COMPRESSION_DEFLATE));
//**************************************************************** // Server code //**************************************************************** // class MyClass { // /** // * This method takes ... // * // * @param integer $inputParam // * @return string // */ // public function method1($inputParam) { // ... // } // // /** // * This method takes ... // * // * @param integer $inputParam1 // * @param string $inputParam2 // * @return float
1092
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
// */ // public function method2($inputParam1, $inputParam2) { // ... // } // // ... // } // ... // $server = new Zend\Soap\Server(null, $options); // $server->setClass(MyClass); // ... // $server->handle(); // //**************************************************************** // End of server code //**************************************************************** $client = new Zend\Soap\Client("MyService.wsdl"); ... // $result1 is a string $result1 = $client->method1(10); ... // $result2 is a float $result2 = $client->method2(22, some string);
1093
1094
CHAPTER 250
WSDL Accessor
Note: Zend\Soap\Wsdl class is used by Zend\Soap\Server component internally to operate with WSDL documents. Nevertheless, you could also use functionality provided by this class for your own needs. The Zend\Soap\Wsdl package contains both a parser and a builder of WSDL documents. If you dont plan to do this, you can skip this documentation section.
1095
element attribute must refer to a corresponding element of data type denition. type attribute refers to a corresponding complexType entry. All standard XSD types have http://schemas.xmlsoap.org/soap/encoding/). both element and complexType denitions (see
All non-standard types, which may be added using Zend\Soap\Wsdl::addComplexType() method, are described using complexType node of /denitions/types/schema/ section of WSDL document. So addMessage() method always uses type attribute to describe types.
1096
1097
script URI 2 as a service URI for Web Service denition using classes. where $name is a class name for the Web Service denition mode using class and script name for the Web Service denition mode using set of functions. See http://www.w3.org/TR/wsdl#_services for the details.
... $wsdl = new Zend\Soap\Wsdl(My_Web_Service, $myWebServiceUri); ... $soapIntType = $wsdl->getType(int); ... class MyClass { ... } ... $soapMyClassType = $wsdl->getType(MyClass);
http:// .$_SERVER[HTTP_HOST] . $_SERVER[SCRIPT_NAME] By default Zend\Soap\Wsdl will be created with the Zend\Soap\Wsdl\ComplexTypeStrategy\DefaultComplexType class as detection algorithm for complex types. The rst parameter of the AutoDiscover constructor takes any complex type strategy implementing Zend\Soap\Wsdl\ComplexTypeStrategy\ComplexTypeStrategyInterface or a string with the name of the class. For backwards compatibility with $extractComplexType boolean variables are parsed the following way: If TRUE, Zend\Soap\Wsdl\ComplexTypeStrategy\DefaultComplexType, if FALSE Zend\Soap\Wsdl\ComplexTypeStrategy\AnyType.
3 2
1098
1099
1100
CHAPTER 251
AutoDiscovery
1101
4 5 6 7 8 9 10 11 12
$autodiscover = new Zend\Soap\AutoDiscover(); $autodiscover->setClass(MySoapServerClass) ->setUri(http://localhost/server.php) ->setServiceName(MySoapService); $wsdl = $autodiscover->generate(); echo $wsdl->toXml(); $wsdl->dump("/path/to/file.wsdl"); $dom = $wsdl->toDomDocument();
Note: ZendSoapAutodiscover is not a Soap Server It is very important to note, that the class Zend\Soap\AutoDiscover does not act as a SOAP Server on its own.
1 2 3 4 5 6 7 8 9 10 11
if (isset($_GET[wsdl])) { $autodiscover = new Zend\Soap\AutoDiscover(); $autodiscover->setClass(HelloWorldService) ->setUri(http://example.com/soap.php); echo $autodiscover->toXml(); } else { // pointing to the current file here $soap = new Zend\Soap\Server("http://example.com/soap.php?wsdl"); $soap->setClass(HelloWorldService); $soap->handle(); }
The following rules are used while WSDL generation: Generated WSDL describes an RPC/Encoded style Web Service. If you want to use a document/literal server use the setBindingStyle() and setOperationBodyStyle() methods. Class name is used as a name of the Web Service being described unless setServiceName() is used explicitly to set the name. When only functions are used for generation the service name has to be set explicitly or an exception is thrown during generation of the WSDL document. You can set the endpoint of the actual SOAP Server via the setUri() method. This is a required option. Its also used as a target namespace for all service related names (including described complex types). Class methods are joined into one Port Type. $serviceName . Port is used as Port Type name. Each class method/function is registered as a corresponding port operation. Only the longest available method prototype is used for generation of the WSDL. WSDL autodiscover utilizes the PHP docblocks provided by the developer to determine the parameter and return types. In fact, for scalar types, this is the only way to determine the parameter types, and for return types, this 1102 Chapter 251. AutoDiscovery
is the only way to determine them. That means, providing correct and fully detailed docblocks is not only best practice, but is required for discovered class.
The same rules apply to generation as described in the class autodiscover section above.
1103
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
$autodiscover = new Zend\Soap\AutoDiscover(); // Default is use => encoded and // encodingStyle => http://schemas.xmlsoap.org/soap/encoding/ $autodiscover->setOperationBodyStyle( array(use => literal, namespace => http://framework.zend.com) ); // Default is style => rpc and // transport => http://schemas.xmlsoap.org/soap/http $autodiscover->setBindingStyle( array(style => document, transport => http://framework.zend.com) ); ... $autodiscover->addFunction(myfunc1); $wsdl = $autodiscover->generate();
1104
CHAPTER 252
Zend\Stdlib\Hydrator
Hydration is the act of populating an object from a set of data. The Hydrator is a simple component to provide mechanisms both for hydrating objects, as well as extracting data sets from them. The component consists of an interface, and several implementations for common use cases.
252.1 HydratorInterface
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
namespace Zend\Stdlib\Hydrator; interface HydratorInterface { /** * Extract values from an object * * @param object $object * @return array */ public function extract($object); /** * Hydrate $object with the provided $data. * * @param array $data * @param object $object * @return void */ public function hydrate(array $data, $object); }
252.2 Usage
Usage is quite simple: simply instantiate the hydrator, and then pass information to it.
1105
1 2 3 4 5 6 7 8 9
use Zend\Stdlib\Hydrator; $hydrator = new Hydrator\ArraySerializable(); $object = new ArrayObject(array()); $hydrator->hydrate($someData, $object); // or, if the object has data we want as an array: $data = $hydrator->extract($object);
1106
CHAPTER 253
Zend\Stdlib\Hydrator\Filter
The hydrator lters, allows you to manipulate the behavior, when you want to extract() your stuff to arrays. This is especially useful, if you want to extract() your objects to the userland and strip some internals (e.g. getServiceManager()). It comes with a helpful Composite Implementation and a few lters for common use cases. The lters are implemented on the AbstractHydrator, so you can directly start using them if you extend it - even on custom hydrators.
1 2 3 4 5 6 7 8 9 10 11 12 13
namespace Zend\Stdlib\Hydrator\Filter; interface FilterInterface { /** * Should return true, if the given filter * does not match * * @param string $property The name of the property * @return bool */ public function filter($property); }
If it returns true, the key / value pairs will be in the extracted arrays - if it will return false, youll not see them again.
1107
Zend\Stdlib\Hydrator\Filter\MethodMatchFilter This lter allows you to strip methods from the extraction with the correct condition in the composite. It checks, if the key that should be extracted matches a method name. Either getServiceLocator or Zend\Foo::getServicelocator. The name of the method is specied in the constructor of this lter. The 2nd parameter decides whether to use white or blacklisting to decide. Default is blacklisting - pass false to change it. Zend\Stdlib\Hydrator\Filter\NumberOfParameterFilter This lter is used in the ClassMethods hydrator, to check the number of parameters. By convention, the get, has and is methods do not get any parameters - but it may happen. You can add your own number of needed parameters, simply add the number to the constructor. The default value is 0
The key / value pairs for is methods will not end up in your extracted array anymore. The lters can be used in any hydrator, but the ClassMethods hydrator is the only one, that has pre-registered lters:
1 2 3 4
$this->filterComposite->addFilter("is", new IsFilter()); $this->filterComposite->addFilter("has", new HasFilter()); $this->filterComposite->addFilter("get", new GetFilter()); $this->filterComposite->addFilter("parameter", new NumberOfParameterFilter(), FilterComposite::CONDIT
If youre not ne with this, you can unregister them as above. Note: The parameter for Zend\Foo\Bar::methodName the lter on the ClassMethods looks like this by default
By default, every lter you add will be added with a conditional or. If you want to add it with and (as the NumberOfParameterFilter that is added to the ClassMethods hydrator by default) you can do that too:
1 2 3 4
1108
5 6
The example above will exclude the getServiceManager method or the key from the extraction, even if the get lter wants to add it.
$composite = new FilterComposite(); $composite->addFilter("one", $condition1); $composite->addFilter("two", $condition2); $composite->addFilter("three", $condition3); $composite->addFilter("four", $condition4, FilterComposite::CONDITION_AND); $composite->addFilter("five", $condition5, FilterComposite::CONDITION_AND); // This is whats happening internally if ( ( $condition1 || $condition2 || $condition3 ) && ( $condition4 && $condition5 ) ) { //do extraction }
If youve only one condition (only and or or) block, the other one will be completely ignored. A bit more complex lter can look like this:
1109
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
$composite = new FilterComposite(); $composite->addFilter( "servicemanager", new MethodMatchFilter("getServiceManager"), FilterComposite::CONDITION_AND ); $composite->addFilter( "eventmanager", new MethodMatchFilter("getEventManager"), FilterComposite::CONDITION_AND ); $hydrator->addFilter("excludes", $composite, FilterComposite::CONDITION_AND); // Internal if ( ( // default composite inside the hydrator ( $getFilter || $hasFilter || $isFilter ) && ( $numberOfParameterFilter ) ) && ( // new composite, added to the one above $serviceManagerFilter && $eventManagerFilter ) ) { // do extraction }
If you perform this on the ClassMethods hydrator, all getters will get extracted, but not getServiceManager and getEventManager.
namespace Zend\Stdlib\Hydrator\Filter; interface FilterProviderInterface { /** * Provides a filter for hydration * * @return FilterInterface */ public function getFilter(); }
The getFilter() method is getting automatically excluded from extract(). If the extracted object implements the Zend\Stdlib\Hydrator\Filter\FilterProviderInterface, the returned FilterInterface instance can also be a FilterComposite. For example:
1110
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
Class Foo implements FilterProviderInterface { public function getFoo() { return "foo"; } public function hasFoo() { return true; } public function getServiceManager() { return "servicemanager"; } public function getEventManager() { return "eventmanager"; } public function getFilter() { $composite = new FilterComposite(); $composite->addFilter("get", new GetFilter()); $exclusionComposite = new FilterComposite(); $exclusionComposite->addFilter( "servicemanager", new MethodMatchFilter("getServiceManager"), FilterComposite::CONDITION_AND ); $exclusionComposite->addFilter( "eventmanager", new MethodMatchFilter("getEventManager"), FilterComposite::CONDITION_AND ); $composite->addFilter("excludes", $exclusionComposite, FilterComposite::CONDITION_AND); return $composite; } } $hydrator = new ClassMethods(false); $extractedArray = $hydrator->extract(new Foo());
The $extractedArray does only have foo => foo in. All of the others are excluded from the extraction. Note: All pre-registered lters from the ClassMethods hydrator are ignored if this interface is used.
1111
1112
CHAPTER 254
Zend\Stdlib\Hydrator\Strategy
You can add a Zend\Stdlib\Hydrator\Strategy\StrategyInterface to any of the hydrators (expect it extends Zend\Stdlib\Hydrator\AbstractHydrator or implements Zend\Stdlib\Hydrator\HydratorInterface and Zend\Stdlib\Hydrator\Strategy\StrategyEnabledInter to manipulate the way how they behave on extract() and hydrate() for specic key / value pairs. This is the interface that needs to be implemented:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
namespace Zend\Stdlib\Hydrator\Strategy; interface StrategyInterface { /** * Converts the given value so that it can be extracted by the hydrator. * * @param mixed $value The original value. * @return mixed Returns the value that should be extracted. */ public function extract($value); /** * Converts the given value so that it can be hydrated by the hydrator. * * @param mixed $value The original value. * @return mixed Returns the value that should be hydrated. */ public function hydrate($value); }
As you can see, this interface is similar to Zend\Stdlib\Hydrator\HydratorInterface. The reason why is, that the strategies provide a proxy implementation for hydrate() and extract().
1113
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
interface StrategyEnabledInterface { /** * Adds the given strategy under the given name. * * @param string $name The name of the strategy to register. * @param StrategyInterface $strategy The strategy to register. * @return HydratorInterface */ public function addStrategy($name, StrategyInterface $strategy); /** * Gets the strategy with the given name. * * @param string $name The name of the strategy to get. * @return StrategyInterface */ public function getStrategy($name); /** * Checks if the strategy with the given name exists. * * @param string $name The name of the strategy to check for. * @return bool */ public function hasStrategy($name); /** * Removes the strategy with the given name. * * @param string $name The name of the strategy to remove. * @return HydratorInterface */ public function removeStrategy($name); }
Every hydrator, that is shipped by default, provides this functionality. The AbstractHydrator has it fully functional implemented. If you want to use this functionality in your own hydrators, you should extend the AbstractHydrator.
1114
class Rot13Strategy implements StrategyInterface { public function extract($value) { return str_rot13($value); } public function hydrate($value) { return str_rot13($value); } }
This is the example class, we want to use for the hydrator example:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
class Foo { protected $foo = null; protected $bar = null; public function getFoo() { return $this->foo; } public function setFoo($foo) { $this->foo = $foo; } public function getBar() { return $this->bar; } public function setBar($bar) { $this->bar = $bar; } }
Now, we want to add the rot13 strategy to the method getFoo() and setFoo($foo):
1 2 3 4 5 6
$foo = new Foo(); $foo->setFoo("bar"); $foo->setBar("foo"); $hydrator = new ClassMethods(); $hydrator->addStrategy("foo", new Rot13Strategy());
When you now use the hydrator, to get an array of the object $foo, this is the array youll get:
1115
1 2 3 4 5 6 7 8
$hydrator->hydrate($extractedArray, $foo) // object(Foo)#2 (2) { // ["foo":protected]=> // string(3) "bar" // ["bar":protected]=> // string(3) "foo" // }
1116
CHAPTER 255
Zend\Stdlib\Hydrator\Aggregate\AggregateHyd
Zend\Stdlib\Hydrator\Aggregate\AggregateHydrator is an implementation Zend\Stdlib\Hydrator\HydratorInterface that composes multiple hydrators via event listeners.
of
You typically want to use an aggregate hydrator when you want to hydrate or extract data from complex objects that implement multiple interfaces, and therefore need multiple hydrators to handle that in subsequent steps.
use Zend\Stdlib\Hydrator\Aggregate\AggregateHydrator; $hydrator = new AggregateHydrator(); // attach the various hydrators capable of handling simpler interfaces $hydrator->add(new My\BlogPostHydrator()); $hydrator->add(new My\UserAwareObjectHydrator()); $hydrator->add(new My\TimestampedObjectHydrator()); $hydrator->add(new My\PublishableObjectHydrator()); // ... // Now retrieve the BlogPost object // ... // you can now extract complex data from a blogpost $data = $hydrator->extract($blogPost); // or you can fill the object with complex data $blogPost = $hydrator->hydrate($data, $blogPost);
1117
Note: Hydrator priorities AggregateHydrator::add has a second optional argument $priority. If you have two or more hydrators that conict with each other for same data keys, you may decide which one has to be executed rst or last by passing a higher or lower integer priority to the second argument of AggregateHydrator::add In order to work with this logic, each of the hydrators that are attached should just ignore any unknown object type passed in, such as in following example:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
namespace My; use Zend\Stdlib\Hydrator\HydratorInterface class BlogPostHydrator implements HydratorInterface { public function hydrate($data, $object) { if (!$object instanceof BlogPost) { return $object; } // ... continue hydration ... } public function extract($object) { if (!$object instanceof BlogPost) { return array(); } // ... continue extraction ... } }
use Zend\Stdlib\Hydrator\Aggregate\AggregateHydrator; use Zend\Stdlib\Hydrator\Aggregate\ExtractEvent; use Zend\Cache\Storage\Adapter\Memory; $hydrator = new AggregateHydrator(); // attach the various hydrators $hydrator->add(new My\BlogPostHydrator());
1118
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
$hydrator->add(new My\UserAwareObjectHydrator()); $hydrator->add(new My\TimestampedObjectHydrator()); $hydrator->add(new My\PublishableObjectHydrator()); // ... $cache = new Memory(); $cacheReadListener = function (ExtractEvent $event) use ($cache) { $object = $event->getExtractionObject(); if (!$object instanceof BlogPost) { return; } if ($cache->hasItem($object->getId())) { $event->setExtractedData($cache->getItem($object->getId())); $event->stopPropagation(); } }; $cacheWriteListener = function (ExtractEvent $event) use ($cache) { $object = $event->getExtractionObject(); if (!$object instanceof BlogPost) { return; } $cache->setItem($object->getId(), $event->getExtractedData()); }; // attaching a high priority listener executed before extraction logic $hydrator->getEventManager()->attach(ExtractEvent::EVENT_EXTRACT, $cacheReadListener, 1000); // attaching a low priority listener executed after extraction logic $hydrator->getEventManager()->attach(ExtractEvent::EVENT_EXTRACT, $cacheWriteListener, -1000);
With an aggregate hydrator congured in this way, any $hydrator->extract($blogPost) operation will be cached
1119
1120
CHAPTER 256
Introduction to Zend\Tag
Zend\Tag is a component suite which provides a facility to work with taggable Items. As its base, it provides two classes to work with Tags, Zend\Tag\Item and Zend\Tag\ItemList. Additionally, it comes with the interface Zend\Tag\TaggableInterface, which allows you to use any of your models as a taggable item in conjunction with Zend\Tag. Zend\Tag\Item is a basic taggable item implementation which comes with the essential functionality required to work with the Zend\Tag suite. A taggable item always consists of a title and a relative weight (e.g. number of occurrences). It also stores parameters which are used by the different sub-components of Zend\Tag. To group multiple items together, Zend\Tag\ItemList exists as an array iterator and provides additional functionality to calculate absolute weight values based on the given relative weights of each item in it.
Using Zend\Tag
This example illustrates how to create a list of tags and spread absolute weight values on them.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
// Create the item list $list = new Zend\Tag\ItemList(); // Assign $list[] = $list[] = $list[] = tags to it new Zend\Tag\Item(array(title => Code, weight => 50)); new Zend\Tag\Item(array(title => Zend Framework, weight => 1)); new Zend\Tag\Item(array(title => PHP, weight => 5));
// Spread absolute values on the items $list->spreadWeightValues(array(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)); // Output the items with their absolute values foreach ($list as $item) { printf("%s: %d\n", $item->getTitle(), $item->getParam(weightValue)); }
This will output the three items Code, Zend Framework and PHP with the absolute values 10, 1 and 2.
Code: 10 Zend Framework: 1 PHP: 2
1121
1122
CHAPTER 257
Zend\Tag\Cloud is the rendering part of Zend\Tag. By default it comes with a set of HTML decorators, which allow you to create tag clouds for a website, but also supplies you with two abstract classes to create your own decorators, to create tag clouds in PDF documents for example. You can instantiate and congure Zend\Tag\Cloud either programmatically or completely via an array or an instance of Traversable. The available options are: Table 257.1: Zend\Tag\Cloud Options Option Description cloudDecorator Denes the decorator for the cloud. Can either be the name of the class which should be loaded by the plugin manager, an instance of Zend\Tag\Cloud\Decorator\AbstractCloud or an array containing the decorator under the key decorator and optionally an array under the key options, which will be passed to the decorators constructor. tagDecorator Denes the decorator for individual tags. This can either be the name of the class which should be loaded by the plugin manager, an instance of Zend\Tag\Cloud\Decorator\AbstractTag or an array containing the decorator under the key decorator and optionally an array under the key options, which will be passed to the decorators constructor. decoratorPluginManager A different plugin manager to use. Must be an instance of Zend\ServiceManager\AbstractPluginManager. itemList A different item list to use. Must be an instance of Zend\Tag\ItemList. tags A array of tags to assign to the cloud. Each tag must either implement Zend\Tag\TaggableInterface or be an array which can be used to instantiate Zend\Tag\Item.
Using Zend\Tag\Cloud
This example illustrates a basic example of how to create a tag cloud, add multiple tags to it and nally render it.
1 2 3
// Create the cloud and assign static tags to it $cloud = new Zend\Tag\Cloud(array( tags => array(
1123
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
array( title => Code, weight => 50, params => array(url => /tag/code), ), array( title => Zend Framework, weight => 1, params => array(url => /tag/zend-framework), ), array( title => PHP, weight => 5, params => array(url => /tag/php), ), ), )); // Render the cloud echo $cloud;
This will output the tag cloud with the three tags, spread with the default font-sizes:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
<ul class="zend-tag-cloud"> <li> <a href="/tag/code" style="font-size: 20px;"> Code </a> </li> <li> <a href="/tag/zend-framework" style="font-size: 10px;"> Zend Framework </a> </li> <li> <a href="/tag/php" style="font-size: 11px;"> PHP </a> </li> </ul>
Note: The HTML code examples are preformatted for a better visualization in the documentation. You can dene a output separator for the HTML Cloud decorator. The following example shows how create the same tag cloud from a Zend\Config\Config object.
1 2 3 4 5 6 7 8 9 10
# An example tags.ini file tags.1.title = "Code" tags.1.weight = 50 tags.1.params.url = "/tag/code" tags.2.title = "Zend Framework" tags.2.weight = 1 tags.2.params.url = "/tag/zend-framework" tags.3.title = "PHP" tags.3.weight = 2 tags.3.params.url = "/tag/php"
1124
1 2 3 4 5 6
// Create the cloud from a Zend\Config\Config object $config = Zend\Config\Factory::fromFile(tags.ini); $cloud = new Zend\Tag\Cloud($config); // Render the cloud echo $cloud;
257.1 Decorators
Zend\Tag\Cloud requires two types of decorators to be able to render a tag cloud. This includes a decorator which renders the single tags as well as a decorator which renders the surrounding cloud. Zend\Tag\Cloud ships a default decorator set for formatting a tag cloud in HTML. This set will, by default, create a tag cloud as ul/li -list, spread with different font-sizes according to the weight values of the tags assigned to them.
$cloud = new Zend\Tag\Cloud(array( tagDecorator => array( decorator => htmltag, options => array( minFontSize => 20, maxFontSize => 50, htmlTags => array( li => array(class => my_custom_class), ), ), ),
257.1. Decorators
1125
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
tags => array( array( title => weight => params => ), array( title => weight => params => ), array( title => weight => params => ), ), )); // Render the cloud echo $cloud;
The output:
1 2 3 4 5 6 7 8 9 10 11
<ul class="zend-tag-cloud"> <li class="my_custom_class"> <a href="/tag/code" style="font-size: 50px;">Code</a> </li> <li class="my_custom_class"> <a href="/tag/zend-framework" style="font-size: 20px;">Zend Framework</a> </li> <li class="my_custom_class"> <a href="/tag/php" style="font-size: 23px;">PHP</a> </li> </ul>
Description Denes the separator which is placed between all tags. An array of HTML tags surrounding all tags. Each element can either be a string, which is used as element type, or an array containing an attribute list for the element, dened as key/value pair. In this case, the array key is used as element type.
// Create the cloud and assign static tags to it $cloud = new Zend\Tag\Cloud(array( cloudDecorator => array( decorator => htmlcloud, options => array(
1126
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
separator => "\n\n", htmlTags => array( ul => array( class => my_custom_class, id => tag-cloud, ), ), ), ), tags => array( array( title => Code, weight => 50, params => array(url => /tag/code), ), array( title => Zend Framework, weight => 1, params => array(url => /tag/zend-framework), ), array( title => PHP, weight => 5, params => array(url => /tag/php), ), ), )); // Render the cloud echo $cloud;
The ouput:
1 2 3 4 5
<ul class="my_custom_class" id="tag-cloud"><li><a href="/tag/code" style="font-size: 20px;">Code</a>< <li><a href="/tag/zend-framework" style="font-size: 10px;">Zend Framework</a></li> <li><a href="/tag/php" style="font-size: 11px;">PHP</a></li></ul>
257.1. Decorators
1127
1128
CHAPTER 258
Introduction to Zend\Test
The Zend\Test component provides tools to facilitate unit testing of your Zend Framework applications. At this time, we offer facilities to enable testing of your Zend Framework MVC applications. PHPUnit is the only library supported currently.
1129
1130
CHAPTER 259
Zend\Test\PHPUnit provides a TestCase for MVC applications that contains assertions for testing against a variety of responsibilities. Probably the easiest way to understand what it can do is to see an example. The following is a simple test case for a IndexController to verify things like HTTP code, controller and action name :
<?php namespace ApplicationTest\Controller; use Zend\Test\PHPUnit\Controller\AbstractHttpControllerTestCase; class IndexControllerTest extends AbstractHttpControllerTestCase { public function setUp() { $this->setApplicationConfig( include /path/to/application/config/test/application.config.php ); parent::setUp(); } public function testIndexActionCanBeAccessed() { $this->dispatch(/); $this->assertResponseStatusCode(200); $this->assertModuleName(application); $this->assertControllerName(application_index); $this->assertControllerClass(IndexController); $this->assertMatchedRouteName(home); } }
The setup of the test case can to dene the application cong. You can use several cong to test modules dependencies or your current application cong.
1131
1132
CHAPTER 260
As noted in the previous example, all MVC test cases should extend AbstractHttpControllerTestCase. This class in turn extends PHPUnit_Framework_TestCase, and gives you all the structure and assertions youd expect from PHPUnit as well as some scaffolding and assertions specic to Zend Frameworks MVC implementation. In order to test your MVC application, you will need to setup the application cong. setApplicationConfig method : Use simply the the
Once the application is set up, you can write your tests. To help debug tests, you can activate the ag traceError to throw MVC exception during the tests writing :
<?php namespace ApplicationTest\Controller; use Zend\Test\PHPUnit\Controller\AbstractHttpControllerTestCase; class IndexControllerTest extends AbstractHttpControllerTestCase { protected $traceError = true; }
1133
1134
CHAPTER 261
Once you have your application cong in place, you can begin testing. Testing is basically as you would expect in an PHPUnit test suite, with a few minor differences. First, you will need to dispatch a URL to test, using the dispatch method of the TestCase:
public function testIndexAction() { $this->dispatch(/); }
There will be times, however, that you need to provide extra information GET and POST variables, COOKIE information, etc. You can populate the request with that information:
public function testIndexAction() { $this->getRequest() ->setMethod(POST) ->setPost(new Parameters(array(argument => value))); $this->dispatch(/); }
You can populate GET or POST variables directly with the dispatch method :
public function testIndexAction() { $this->dispatch(/, POST, array(argument => value)); }
Now that the request is made, its time to start making assertions against it.
1135
1136
CHAPTER 262
Assertions
Assertions are at the heart of Unit Testing; you use them to verify that the results are what you expect. To this end, Zend\Test\PHPUnit\AbstractControllerTestCase provides a number of assertions to make testing your MVC apps and controllers simpler.
1137
1138
CHAPTER 263
Request Assertions
Its often useful to assert against the last run action, controller, and module; additionally, you may want to assert against the route that was matched. The following assertions can help you in this regard: assertModulesLoaded(array $modules): Assert that the given modules was loaded by the application. assertModuleName($module): Assert that the given module was used in the last dispatched action. assertControllerName($controller): Assert that the given controller identier was selected in the last dispatched action. assertControllerClass($controller): Assert that the given controller class was selected in the last dispatched action. assertActionName($action): Assert that the given action was last dispatched. assertMatchedRouteName($route): Assert that the given named route was matched by the router. Each also has a Not variant for negative assertions.
1139
1140
CHAPTER 264
CSS selectors are an easy way to verify that certain artifacts are present in the response content. They also make it trivial to ensure that items necessary for Javascript UIs and/or AJAX integration will be present; most JS toolkits provide some mechanism for pulling DOM elements based on CSS selectors, so the syntax would be the same. This functionality is provided via Zend\Dom\Query, and integrated into a set of Query assertions. Each of these assertions takes as their rst argument a CSS selector, with optionally additional arguments and/or an error message, based on the assertion type. You can nd the rules for writing the CSS selectors in the Zend\Dom\Query Theory of Operation chapter. Query assertions include: assertQuery($path): assert that one or more DOM elements matching the given CSS selector are present. assertQueryContentContains($path, $match): assert that one or more DOM elements matching the given CSS selector are present, and that at least one contains the content provided in $match. assertQueryContentRegex($path, $pattern): assert that one or more DOM elements matching the given CSS selector are present, and that at least one matches the regular expression provided in $pattern. If a $message is present, it will be prepended to any failed assertion message. assertQueryCount($path, $count): assert that there are exactly $count DOM elements matching the given CSS selector present. assertQueryCountMin($path, $count): assert that there are at least $count DOM elements matching the given CSS selector present. assertQueryCountMax($path, $count): assert that there are no more than $count DOM elements matching the given CSS selector present. Additionally, each of the above has a Not variant that provides a negative assertion: assertNotQuery(), assertNotQueryContentContains(), assertNotQueryContentRegex(), and assertNotQueryCount(). (Note that the min and max counts do not have these variants, for what should be obvious reasons.)
1141
1142
CHAPTER 265
XPath Assertions
Some developers are more familiar with XPath than with CSS selectors, and thus XPath variants of all the Query assertions are also provided. These are: assertXpathQuery($path) assertNotXpathQuery($path) assertXpathQueryCount($path, $count) assertNotXpathQueryCount($path, $count) assertXpathQueryCountMin($path, $count) assertXpathQueryCountMax($path, $count) assertXpathQueryContentContains($path, $match) assertNotXpathQueryContentContains($path, $match) assertXpathQueryContentRegex($path, $pattern) assertNotXpathQueryContentRegex($path, $pattern)
1143
1144
CHAPTER 266
Redirect Assertions
Often an action will redirect. Instead of following the redirect, Zend\Test\PHPUnit\ControllerTestCase allows you to test for redirects with a handful of assertions. assertRedirect(): assert simply that a redirect has occurred. assertRedirectTo($url): assert that a redirect has occurred, and that the value of the Location header is the $url provided. assertRedirectRegex($pattern): assert that a redirect has occurred, and that the value of the Location header matches the regular expression provided by $pattern. Each also has a Not variant for negative assertions.
1145
1146
CHAPTER 267
In addition to checking for redirect headers, you will often need to check for specic HTTP response codes and headers for instance, to determine whether an action results in a 404 or 500 response, or to ensure that JSON responses contain the appropriate Content-Type header. The following assertions are available. assertResponseCode($code): assert that the response resulted in the given HTTP response code. assertResponseHeader($header): assert that the response contains the given header. assertResponseHeaderContains($header, $match): assert that the response contains the given header and that its content contains the given string. assertResponseHeaderRegex($header, $pattern): assert that the response contains the given header and that its content matches the given regex. Additionally, each of the above assertions have a Not variant for negative assertions.
1147
1148
CHAPTER 268
Zend\Text\Figlet
Zend\Text\Figlet is a component which enables developers to create a so called FIGlet text. A FIGlet text is a string, which is represented as ASCII art. FIGlets use a special font format, called FLT (FigLet Font). By default, one standard font is shipped with Zend\Text\Figlet, but you can download additional fonts at http://www.glet.org. Note: Compressed fonts Zend\Text\Figlet supports gzipped fonts. This means that you can take an .flf le and gzip it. To allow Zend\Text\Figlet to recognize this, the gzipped font must have the extension .gz. Further, to be able to use gzipped fonts, you have to have enabled the GZIP extension of PHP.
Note: Encoding Zend\Text\Figlet expects your strings to be UTF-8 encoded by default. If this is not the case, you can supply the character encoding as second parameter to the render() method. You can dene multiple options for a FIGlet. When instantiating Zend\Text\Figlet\Figlet, you can supply an array or an instance of Zend\Config. font- Denes the font which should be used for rendering. If not denes, the built-in font will be used. outputWidth- Denes the maximum width of the output string. This is used for word-wrap as well as justication. Beware of too small values, they may result in an undened behaviour. The default value is 80. handleParagraphs- A boolean which indicates, how new lines are handled. When set to TRUE, single new lines are ignored and instead treated as single spaces. Only multiple new lines will be handled as such. The default value is FALSE. justification- May be one of the values of Zend\Text\Figlet\Figlet::JUSTIFICATION_*. There is JUSTIFICATION_LEFT, JUSTIFICATION_CENTER and JUSTIFICATION_RIGHT The default justication is dened by the rightToLeft value. rightToLeftDenes in which direction the text is written. May be either Zend\Text\Figlet\Figlet::DIRECTION_LEFT_TO_RIGHT or Zend\Text\Figlet\Figlet::DIRECTION_RIGHT_TO_LEFT. By default the setting of the font le is used. When justication is not dened, a text written from right-to-left is automatically right-aligned. smushMode- An integer biteld which denes, how the single characters are smushed together. Can be the sum of multiple values from Zend\Text\Figlet\Figlet::SM_*. There are the following smush modes: SM_EQUAL, SM_LOWLINE, SM_HIERARCHY, SM_PAIR, SM_BIGX, SM_HARDBLANK, SM_KERN 1149
and SM_SMUSH. A value of 0 doesnt disable the entire smushing, but forces SM_KERN to be applied, while a value of -1 disables it. An explanation of the different smush modes can be found here. By default the setting of the font le is used. The smush mode option is normally used only by font designers testing the various layoutmodes with a new font.
Using Zend\Text\Figlet
This example illustrates the basic use of Zend\Text\Figlet to create a simple FIGlet text:
1 2
Assuming you are using a monospace font, this would look as follows:
1 2 3 4 5 6
_ __ | \| || | || | . || |_|\_|| - -
1150
CHAPTER 269
Zend\Text\Table
Zend\Text\Table is a component to create text based tables on the y with different decorators. This can be helpful, if you either want to send structured data in text emails, which are used to have mono-spaced fonts, or to display table information in a CLI application. Zend\Text\Table supports multi-line columns, colspan and align as well. Note: Encoding Zend\Text\Table expects your strings to be UTF-8 encoded by default. If this is not the case, you can either supply the character encoding as a parameter to the constructor() or the setContent() method of Zend\Text\Table\Column. Alternatively if you have a different encoding in the entire process, you can dene the standard input charset with Zend\Text\Table\Table::setInputCharset($charset). In case you need another output charset for the table, you can set this with Zend\Text\Table\Table::setOutputCharset($charset). A Zend\Text\Table\Table object consists of rows, which contain columns, represented by Zend\Text\Table\Row and Zend\Text\Table\Column. When creating a table, you can supply an array with options for the table. Those are: columnWidths (required): An array dening all columns width their widths in characters. decorator: The decorator to use for the table borders. The default is unicode, but you may also specify ascii or give an instance of a custom decorator object. padding: The left and right padding withing the columns in characters. The default padding is zero. AutoSeparate: The way how the rows are separated with horizontal lines. The default is a separation between all rows. This is dened as a bitmask containing one ore more of the following constants of Zend\Text\Table: Zend\Text\Table\Table::AUTO_SEPARATE_NONE Zend\Text\Table\Table::AUTO_SEPARATE_HEADER Zend\Text\Table\Table::AUTO_SEPARATE_FOOTER Zend\Text\Table\Table::AUTO_SEPARATE_ALL Where header is always the rst row, and the footer is always the last row. Rows are simply added to the table by creating a new instance of Zend\Text\Table\Row, and appending it to the table via the appendRow() method. Rows themselves have no options. You can also give an array to directly
1151
to the appendRow() method, which then will automatically converted to a row object, containing multiple column objects. The same way you can add columns to the rows. Create a new instance of Zend\Text\Table\Column and then either set the column options in the constructor or later with the set*() methods. The rst parameter is the content of the column which may have multiple lines, which in the best case are separated by just the \n character. The second parameter denes the align, which is left by default and can be one of the class constants of Zend\Text\Table\Column: ALIGN_LEFT ALIGN_CENTER ALIGN_RIGHT The third parameter is the colspan of the column. For example, when you choose 2 as colspan, the column will span over two columns of the table. The last parameter denes the encoding of the content, which should be supplied, if the content is neither ASCII nor UTF-8. To append the column to the row, you simply call appendColumn() in your row object with the column object as parameter. Alternatively you can directly give a string to the appendColumn() method. To nally render the table, you can either use the render() method of the table, or use the magic method __toString() by doing echo $table; or $tableString = (string) $table.
Using Zend\Text\Table
This example illustrates the basic use of Zend\Text\Table to create a simple table:
1 2 3 4 5 6 7 8 9 10 11 12 13 14
$table = new Zend\Text\Table\Table(array(columnWidths => array(10, 20))); // Either simple $table->appendRow(array(Zend, Framework)); // Or verbose $row = new Zend\Text\Table\Row(); $row->appendColumn(new Zend\Text\Table\Column(Zend)); $row->appendColumn(new Zend\Text\Table\Column(Framework)); $table->appendRow($row); echo $table;
1152
CHAPTER 270
Zend\Uri
270.1 Overview
Zend\Uri is a component that aids in manipulating and validating Uniform Resource Identiers (URIs) 1 . Zend\Uri exists primarily to service other components, such as Zend\Http\, but is also useful as a standalone utility. URI s always begin with a scheme, followed by a colon. The construction of the many different schemes varies signicantly. The Zend\Uri component provides the Zend\Uri\UriFactory that returns a class implementing the Zend\Uri\UriInterface which specializes in the scheme if such a class is registered with the Factory.
1 2 3 4 5
To create a new URI from scratch, pass only the scheme followed by a colon to Zend\Uri\UriFactory::factory() 2 . If an unsupported scheme is passed and no scheme-specic class is specied, a Zend\Uri\Exception\InvalidArgumentException will be thrown. If the scheme or URI passed is supported, Zend\Uri\UriFactory::factory() will return a class implementing Zend\Uri\UriInterface that specializes in the scheme to be created.
1 2
See http://www.ietf.org/rfc/rfc3986.txt for more information on URIs At the time of writing, Zend\Uri provides built-in support for the following schemes: HTTP, HTTPS, MAILTO and FILE
1153
1 2 3 4 5 6 7 8 9 10 11
1 2 3 4
The URI will be parsed and validated. If it is found to be invalid, a Zend\Uri\Exception\InvalidArgumentException will be thrown immediately. Otherwise, Zend\Uri\UriFactory::factory() will return a class implementing Zend\Uri\UriInterface that specializes in the scheme to be manipulated.
1154
Getting the Scheme from a Zend\Uri\UriInterface Object $uri = Zend\Uri\UriFactory::factory(mailto:john.doe@example.com); $scheme = $uri->getScheme(); // "mailto"
1 2 3
The getScheme() instance method returns only the scheme part of the URI object.
1 2 3
The getUserinfo() method returns only the userinfo part of the URI object.
1 2 3
The getHost() method returns only the host part of the URI object.
1 2 3
1155
Getting a default port from a Zend\Uri\UriInterface Object $uri = Zend\Uri\UriFactory::factory(http://example.com); $scheme = $uri->getPort(); // "80"
1 2 3
The getHost() method returns only the port part of the URI object.
1 2 3
The getPath() method returns only the path of the URI object.
1 2 3
The getQuery() method returns only the query-part of the URI object.
Getting the query as array from a Zend\Uri\UriInterface Object $uri = Zend\Uri\UriFactory::factory(http://example.com:80/my/path?a=b&c=d#token); $scheme = $uri->getQueryAsArray(); // array( // a => b, // c => d, // )
1 2 3 4 5 6 7
The query-part often contains key=value pairs and therefore can be split into an associative array. This array can be retrieved using getQueryAsArray()
1156
1 2 3
The getFragment() method returns only the fragment-part of the URI object.
1 2 3 4 5 6
// "http://www.zend.com"
The toString() method returns the string representation of the entire URI. The Zend\Uri\UriInterface denes also a magic __toString() method that returns the string representation of the URI when the Object is cast to a string.
1 2 3
The isValid() instance method provides a means to check that the URI object is still valid.
1157
1158
CHAPTER 271
Introduction to Zend\Validator
The Zend\Validator component provides a set of commonly needed validators. It also provides a simple validator chaining mechanism by which multiple validators may be applied to a single datum in a user-dened order.
1159
1 2 3 4 5 6 7 8 9 10
$validator = new Zend\Validator\EmailAddress(); if ($validator->isValid($email)) { // email appears to be valid } else { // email is invalid; print the reasons foreach ($validator->getMessages() as $messageId => $message) { echo "Validation failure $messageId : $message\n"; } }
$validator = new Zend\Validator\StringLength(8); $validator->setMessage( The string \%value%\ is too short; it must be at least %min% . characters, Zend\Validator\StringLength::TOO_SHORT); if (!$validator->isValid(word)) { $messages = $validator->getMessages(); echo current($messages); // "The string word is too short; it must be at least 8 characters" }
You can set multiple messages using the setMessages() method. Its argument is an array containing key/message pairs.
1 2 3 4 5 6 7 8
$validator = new Zend\Validator\StringLength(array(min => 8, max => 12)); $validator->setMessages( array( Zend\Validator\StringLength::TOO_SHORT => The string \%value%\ is too short, Zend\Validator\StringLength::TOO_LONG => The string \%value%\ is too long ));
If your application requires even greater exibility with which it reports validation failures, you can access properties by the same name as the message tokens supported by a given validation class. The value property is always available
1160
in a validator; it is the value you specied as the argument of isValid(). Other properties may be supported on a case-by-case basis in each validation class.
1 2 3 4 5 6 7 8 9 10 11
$validator = new Zend\Validator\StringLength(array(min => 8, max => 12)); if (!$validator->isValid(word)) { echo Word failed: . $validator->value . ; its length is not between . $validator->min . and . $validator->max . "\n"; }
$validator = new Zend\Validator\StringLength(array(min => 8, max => 12)); $translate = new Zend\Mvc\Translator\Translator(); // configure the translator... $validator->setTranslator($translate);
With the static setDefaultTranslator() method you can set a instance of Zend\Validator\Translator\TranslatorInterface which will be used for all validation classes, and can be retrieved with getDefaultTranslator(). This prevents you from setting a translator manually for all validator classes, and simplies your code.
1161
1 2 3 4
Sometimes it is necessary to disable the translator within a validator. To archive this you can use the setDisableTranslator() method, which accepts a boolean parameter, and isTranslatorDisabled() to get the set value.
1 2 3 4
It is also possible to use a translator instead of setting own messages with setMessage(). But doing so, you should keep in mind, that the translator works also on messages you set your own.
1162
CHAPTER 272
Zend Framework comes with a standard set of validation classes, which are ready for you to use.
1163
1164
CHAPTER 273
Alnum
Zend\I18n\Validator\Alnum allows you to validate if a given value contains only alphabetical characters and digits. There is no length limitation for the input you want to validate.
$validator = new Zend\Validator\Alnum(); if ($validator->isValid(Abcd12)) { // value contains only allowed chars } else { // false }
$validator = new Zend\Validator\Alnum(array(allowWhiteSpace => true)); if ($validator->isValid(Abcd and 12)) { // value contains only allowed chars } else {
1165
5 6
// false }
1166
CHAPTER 274
Alpha
Zend\Validator\Alpha allows you to validate if a given value contains only alphabetical characters. There is no length limitation for the input you want to validate. This validator is related to the Zend\Validator\Alnum validator with the exception that it does not accept digits.
$validator = new Zend\Validator\Alpha(); if ($validator->isValid(Abcd)) { // value contains only allowed chars } else { // false }
$validator = new Zend\Validator\Alpha(array(allowWhiteSpace => true)); if ($validator->isValid(Abcd and efg)) { // value contains only allowed chars
1167
4 5 6
} else { // false }
1168
CHAPTER 275
Barcode
Zend\Validator\Barcode allows you to check if a given value can be represented as barcode. Zend\Validator\Barcode supports multiple barcode standards and can be extended with proprietary barcode implementations very easily. The following barcode standards are supported: CODABAR: Also known as Code-a-bar. This barcode has no length limitation. It supports only digits, and 6 special chars. Codabar is a self-checking barcode. This standard is very old. Common use cases are within airbills or photo labs where multi-part forms are used with dot-matrix printers. CODE128: CODE128 is a high density barcode. This barcode has no length limitation. It supports the rst 128 ascii characters. When used with printing characters it has an checksum which is calculated modulo 103. This standard is used worldwide as it supports upper and lowercase characters. CODE25: Often called two of ve or Code25 Industrial. This barcode has no length limitation. It supports only digits, and the last digit can be an optional checksum which is calculated with modulo 10. This standard is very old and nowadays not often used. Common use cases are within the industry. CODE25INTERLEAVED: Often called Code 2 of 5 Interleaved. This standard is a variant of CODE25. It has no length limitation, but it must contain an even amount of characters. It supports only digits, and the last digit can be an optional checksum which is calculated with modulo 10. It is used worldwide and common on the market. CODE39: CODE39 is one of the oldest available codes. This barcode has a variable length. It supports digits, upper cased alphabetical characters and 7 special characters like whitespace, point and dollar sign. It can have an optional checksum which is calculated with modulo 43. This standard is used worldwide and common within the industry. CODE39EXT: CODE39EXT is an extension of CODE39. This barcode has the same properties as CODE39. Additionally it allows the usage of all 128 ASCII characters. This standard is used worldwide and common within the industry. CODE93: CODE93 is the successor of CODE39.
1169
This barcode has a variable length. It supports digits, alphabetical characters and 7 special characters. It has an optional checksum which is calculated with modulo 47 and contains 2 characters. This standard produces a denser code than CODE39 and is more secure. CODE93EXT: CODE93EXT is an extension of CODE93. This barcode has the same properties as CODE93. Additionally it allows the usage of all 128 ASCII characters. This standard is used worldwide and common within the industry. EAN2: EAN is the shortcut for European Article Number. These barcode must have 2 characters. It supports only digits and does not have a checksum. This standard is mainly used as addition to EAN13 (ISBN) when printed on books. EAN5: EAN is the shortcut for European Article Number. These barcode must have 5 characters. It supports only digits and does not have a checksum. This standard is mainly used as addition to EAN13 (ISBN) when printed on books. EAN8: EAN is the shortcut for European Article Number. These barcode can have 7 or 8 characters. It supports only digits. When it has a length of 8 characters it includes a checksum. This standard is used worldwide but has a very limited range. It can be found on small articles where a longer barcode could not be printed. EAN12: EAN is the shortcut for European Article Number. This barcode must have a length of 12 characters. It supports only digits, and the last digit is always a checksum which is calculated with modulo 10. This standard is used within the USA and common on the market. It has been superseded by EAN13. EAN13: EAN is the shortcut for European Article Number. This barcode must have a length of 13 characters. It supports only digits, and the last digit is always a checksum which is calculated with modulo 10. This standard is used worldwide and common on the market. EAN14: EAN is the shortcut for European Article Number. This barcode must have a length of 14 characters. It supports only digits, and the last digit is always a checksum which is calculated with modulo 10. This standard is used worldwide and common on the market. It is the successor for EAN13. EAN18: EAN is the shortcut for European Article Number. This barcode must have a length of 18 characters. It support only digits. The last digit is always a checksum digit which is calculated with modulo 10. This code is often used for the identication of shipping containers. GTIN12: GTIN is the shortcut for Global Trade Item Number. This barcode uses the same standard as EAN12 and is its successor. Its commonly used within the USA. GTIN13: GTIN is the shortcut for Global Trade Item Number. This barcode uses the same standard as EAN13 and is its successor. It is used worldwide by industry. GTIN14: GTIN is the shortcut for Global Trade Item Number. This barcode uses the same standard as EAN14 and is its successor. It is used worldwide and common on the market. IDENTCODE: Identcode is used by Deutsche Post and DHL. Its an specialized implementation of Code25. This barcode must have a length of 12 characters. It supports only digits, and the last digit is always a checksum which is calculated with modulo 10. This standard is mainly used by the companies DP and DHL.
1170
INTELLIGENTMAIL: Intelligent Mail is a postal barcode. This barcode can have a length of 20, 25, 29 or 31 characters. It supports only digits, and contains no checksum. This standard is the successor of PLANET and POSTNET. It is mainly used by the United States Postal Services. ISSN: ISSN is the abbreviation for International Standard Serial Number. This barcode can have a length of 8 or 13 characters. It supports only digits, and the last digit must be a checksum digit which is calculated with modulo 11. It is used worldwide for printed publications. ITF14: ITF14 is the GS1 implementation of an Interleaved Two of Five bar code. This barcode is a special variant of Interleaved 2 of 5. It must have a length of 14 characters and is based on GTIN14. It supports only digits, and the last digit must be a checksum digit which is calculated with modulo 10. It is used worldwide and common within the market. LEITCODE: Leitcode is used by Deutsche Post and DHL. Its an specialized implementation of Code25. This barcode must have a length of 14 characters. It supports only digits, and the last digit is always a checksum which is calculated with modulo 10. This standard is mainly used by the companies DP and DHL. PLANET: Planet is the abbreviation for Postal Alpha Numeric Encoding Technique. This barcode can have a length of 12 or 14 characters. It supports only digits, and the last digit is always a checksum. This standard is mainly used by the United States Postal Services. POSTNET: Postnet is used by the US Postal Service. This barcode can have a length of 6, 7, 10 or 12 characters. It supports only digits, and the last digit is always a checksum. This standard is mainly used by the United States Postal Services. ROYALMAIL: Royalmail is used by Royal Mail. This barcode has no dened length. It supports digits, uppercase letters, and the last digit is always a checksum. This standard is mainly used by Royal Mail for their Cleanmail Service. It is also called RM4SCC. SSCC: SSCC is the shortcut for Serial Shipping Container Code. This barcode is a variant of EAN barcode. It must have a length of 18 characters and supports only digits. The last digit must be a checksum digit which is calculated with modulo 10. It is commonly used by the transport industry. UPCA: UPC is the shortcut for Universal Product Code. This barcode preceded EAN13. It must have a length of 12 characters and supports only digits. The last digit must be a checksum digit which is calculated with modulo 10. It is commonly used within the USA. UPCE: UPCE is the short variant from UPCA. This barcode is a smaller variant of UPCA. It can have a length of 6, 7 or 8 characters and supports only digits. When the barcode is 8 chars long it includes a checksum which is calculated with modulo 10. It is commonly used with small products where a UPCA barcode would not t.
1171
$valid = new Zend\Validator\Barcode(EAN13); if ($valid->isValid($input)) { // input appears to be valid } else { // input is invalid }
$valid = new Zend\Validator\Barcode(array( adapter => EAN13, checksum => false, )); if ($valid->isValid($input)) { // input appears to be valid } else { // input is invalid }
Note: Reduced security by disabling checksum validation By switching off checksum validation you will also reduce the security of the used barcodes. Additionally you should note that you can also turn off the checksum validation for those barcode types which must contain a checksum value. Barcodes which would not be valid could then be returned as valid even if they are not.
1172
Characters: A string which contains all allowed characters for this barcode. Also the integer value 128 is allowed, which means the rst 128 characters of the ASCII table. Checksum: A string which will be used as callback for a method which does the checksum validation. Your custom barcode validator must extend Zend\Validator\Barcode\AbstractAdapter or implement Zend\Validator\Barcode\AdapterInterface. As an example, lets create a validator that expects an even number of characters that include all digits and the letters ABCDE, and which requires a checksum.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
class My\Barcode\MyBar extends Zend\Validator\Barcode\AbstractAdapter { protected $length = even; protected $characters = 0123456789ABCDE; protected $checksum = mod66; protected function mod66($barcode) { // do some validations and return a boolean } } $valid = new Zend\Validator\Barcode(My\Barcode\MyBar); if ($valid->isValid($input)) { // input appears to be valid } else { // input is invalid }
1173
1174
CHAPTER 276
Between
Zend\Validator\Between allows you to validate if a given value is between two other values. Note: Zend\Validator\Between supports only number validation It should be noted that Zend\Validator\Between supports only the validation of numbers. Strings or dates can not be validated with this validator.
$valid = new Zend\Validator\Between(array(min => 0, max => 10)); $value = 10; $result = $valid->isValid($value); // returns true
In the above example the result is TRUE due to the reason that per default the search is inclusively the border values. This means in our case that any value from 0 to 10 is allowed. And values like -1 and 11 will return FALSE.
1175
1 2 3 4 5 6 7 8 9 10
$valid = new Zend\Validator\Between( array( min => 0, max => 10, inclusive => false ) ); $value = 10; $result = $valid->isValid($value); // returns false
The example is almost equal to our rst example but we excluded the border value. Now the values 0 and 10 are no longer allowed and will return FALSE.
1176
CHAPTER 277
Callback
Zend\Validator\Callback allows you to provide a callback with which to validate a given value.
$valid = new Zend\Validator\Callback(myMethod); if ($valid->isValid($input)) { // input appears to be valid } else { // input is invalid }
1177
1 2 3 4 5 6 7 8 9 10
$valid = new Zend\Validator\Callback(function($value){ // some validation return true; }); if ($valid->isValid($input)) { // input appears to be valid } else { // input is invalid }
The denition of the callback is in this case almost the same. You have just to create an instance of the class before the method and create an array describing the callback:
1 2 3 4 5 6 7
$object = new MyClass; $valid = new Zend\Validator\Callback(array($object, myMethod)); if ($valid->isValid($input)) { // input appears to be valid } else { // input is invalid }
You may also dene a static method as a callback. Consider the following class denition and validator usage:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
class MyClass { public static function test($value) { // some validation return true; } } $valid = new Zend\Validator\Callback(array(MyClass, test)); if ($valid->isValid($input)) { // input appears to be valid } else { // input is invalid }
Finally, if you are using PHP 5.3, you may dene the magic method __invoke() in your class. If you do so, simply providing an instance of the class as the callback will also work:
1178
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
class MyClass { public function __invoke($value) { // some validation return true; } } $object = new MyClass(); $valid = new Zend\Validator\Callback($object); if ($valid->isValid($input)) { // input appears to be valid } else { // input is invalid }
class MyClass { function myMethod($value, $option) { // some validation return true; } //if a context is present function myMethod($value, $context, $option) { // some validation return true; } }
There are two ways to inform the validator of additional options: pass them in the constructor, or pass them to the setOptions() method. To pass them to the constructor, you would need to pass an array containing two keys, callback and options:
1 2 3 4 5 6 7 8 9 10
$valid = new Zend\Validator\Callback(array( callback => array(MyClass, myMethod), options => $option, )); if ($valid->isValid($input)) { // input appears to be valid } else { // input is invalid }
1179
$valid = new Zend\Validator\Callback(array(MyClass, myMethod)); $valid->setOptions($option); if ($valid->isValid($input)) { // input appears to be valid } else { // input is invalid }
When there are additional values given to isValid() then these values will be added immediately after $value.
1 2 3 4 5 6 7 8
$valid = new Zend\Validator\Callback(array(MyClass, myMethod)); $valid->setOptions($option); if ($valid->isValid($input, $additional)) { // input appears to be valid } else { // input is invalid }
When making the call to the callback, the value to be validated will always be passed as the rst argument to the callback followed by all other values given to isValid(); all other options will follow it. The amount and type of options which can be used is not limited.
1180
CHAPTER 278
CreditCard
Zend\Validator\CreditCard allows you to validate if a given value could be a credit card number. A credit card contains several items of metadata, including a hologram, account number, logo, expiration date, security code and the card holder name. The algorithms for verifying the combination of metadata are only known to the issuing company, and should be veried with them for purposes of payment. However, its often useful to know whether or not a given number actually falls within the ranges of possible numbers prior to performing such verication, and, as such, Zend\Validator\CreditCard simply veries that the credit card number provided is well-formed. For those cases where you have a service that can perform comprehensive verication, Zend\Validator\CreditCard also provides the ability to attach a service callback to trigger once the credit card number has been deemed valid; this callback will then be triggered, and its return value will determine overall validity. The following issuing institutes are accepted: American Express China UnionPay Diners Club Card Blanche Diners Club International Diners Club US & Canada Discover Card JCB Laser Maestro MasterCard Solo Visa Visa Electron Note: Invalid institutes The institutes Bankcard and Diners Club enRoute do not exist anymore. Therefore they are treated as invalid.
1181
Switch has been rebranded to Visa and is therefore also treated as invalid.
$valid = new Zend\Validator\CreditCard(); if ($valid->isValid($input)) { // input appears to be valid } else { // input is invalid }
The above example would validate against all known credit card institutes.
When you want to allow multiple institutes, then you can provide them as array:
1 2 3 4
And as with all validators, you can also pass an associative array of options or an instance of Traversable. In this case you have to provide the institutes with the type array key as simulated here:
1 2 3
1182
Table 278.1: Constants for credit card institutes Institute American Express China UnionPay Diners Club Card Blanche Diners Club International Diners Club US & Canada Discover Card JCB Laser Maestro MasterCard Solo Visa Visa Electron Constant ZendValidatorCreditCard::AMERICAN_EXPRESS ZendValidatorCreditCard::UNIONPAY ZendValidatorCreditCard::DINERS_CLUB ZendValidatorCreditCard::DINERS_CLUB ZendValidatorCreditCard::DINERS_CLUB_US ZendValidatorCreditCard::DISCOVER ZendValidatorCreditCard::JCB ZendValidatorCreditCard::LASER ZendValidatorCreditCard::MAESTRO ZendValidatorCreditCard::MASTERCARD ZendValidatorCreditCard::SOLO ZendValidatorCreditCard::VISA ZendValidatorCreditCard::VISA
You can also set or add institutes afterward instantiation by using the methods setType(), addType() and getType().
1 2 3 4 5
Note: Default institute When no institute is given at initiation then ALL will be used, which sets all institutes at once. In this case the usage of addType() is useless because all institutes are already added.
// Your service class class CcService { public function checkOnline($cardnumber, $types) { // some online validation } }
1183
9 10 11 12 13
// The validation $service = new CcService(); $valid = new Zend\Validator\CreditCard(Zend\Validator\CreditCard::VISA); $valid->setService(array($service, checkOnline));
As you can see the callback method will be called with the credit card number as the rst parameter, and the accepted types as the second parameter.
278.5 Ccnum
Note: The Ccnum validator has been deprecated in favor of the CreditCard validator. For security reasons you should use CreditCard instead of Ccnum.
1184
CHAPTER 279
Date
Zend\Validator\Date allows you to validate if a given value contains a date. This validator validates also localized input.
$validator = new Zend\Validator\Date(array(locale => de)); $validator->isValid(10.Feb.2010); // returns true $validator->isValid(10.May.2010); // returns false
1185
The locale option sets the default date format. In the above example this is j.M.Y which is dened as default date format for de.
$validator = new Zend\Validator\Date(array(format => Y)); $validator->isValid(2010); // returns true $validator->isValid(May); // returns false
Of course you can combine format and locale. In this case you can also use localized month or day names.
1 2 3 4
$validator = new Zend\Validator\Date(array(format => Y F, locale => de)); $validator->isValid(2010 Dezember); // returns true $validator->isValid(2010 June); // returns false
1186
CHAPTER 280
Zend\Validator\Db\RecordExists and Zend\Validator\Db\NoRecordExists provide a means to test whether a record exists in a given table of a database, with a given value.
adapter: The database adapter that will be used for the search. exclude: Sets records that will be excluded from the search. eld: The database eld within this table that will be searched for the record. schema: Sets the schema that will be used for the search. table: The table that will be searched for the record. Note: In ZF1 it was possible to set an application wide default database adapter that was consumed by this class. As this is not possible in ZF2, it is now always required to supply an adapter.
//Check that the email address exists in the database $validator = new Zend\Validator\Db\RecordExists( array( table => users, field => emailaddress, adapter => $dbAdapter ) );
1187
9 10 11 12 13 14 15 16 17
if ($validator->isValid($emailaddress)) { // email address appears to be valid } else { // email address is invalid; print the reasons foreach ($validator->getMessages() as $message) { echo "$message\n"; } }
The above will test that a given email address is in the database table. If no record is found containing the value of $emailaddress in the specied column, then an error message is displayed.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
//Check that the username is not present in the database $validator = new Zend\Validator\Db\NoRecordExists( array( table => users, field => username, adapter => $dbAdapter ) ); if ($validator->isValid($username)) { // username appears to be valid } else { // username is invalid; print the reason $messages = $validator->getMessages(); foreach ($messages as $message) { echo "$message\n"; } }
The above will test that a given username is not in the database table. If a record is found containing the value of $username in the specied column, then an error message is displayed.
//Check no other users have the username $user_id = $user->getId(); $validator = new Zend\Validator\Db\NoRecordExists( array( table => users, field => username, exclude => array( field => id, value => $user_id ) ) ); if ($validator->isValid($username)) {
1188
15 16 17 18 19 20 21 22
// username appears to be valid } else { // username is invalid; print the reason $messages = $validator->getMessages(); foreach ($messages as $message) { echo "$message\n"; } }
The above example will check the table to ensure no records other than the one where id = $user_id contains the value $username. You can also provide a string to the exclude clause so you can use an operator other than !=. This can be useful for testing against composite keys.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
$email = user@example.com; $clause = $dbAdapter->quoteIdentifier(email) . = . $dbAdapter->quoteValue($email); $validator = new Zend\Validator\Db\RecordExists( array( table => users, field => username, adapter => $dbAdapter, exclude => $clause ) ); if ($validator->isValid($username)) { // username appears to be valid } else { // username is invalid; print the reason $messages = $validator->getMessages(); foreach ($messages as $message) { echo "$message\n"; } }
The above example will check the users table to ensure that only a record with both the username $username and with the email $email is valid.
1189
$select = new Zend\Db\Sql\Select(); $select->from(users) ->where->equalTo(id, $user_id) ->where->equalTo(email, $email); $validator = new Zend\Validator\Db\RecordExists($select); // We still need to set our database adapter $validator->setAdapter($dbAdapter); // Validation is then performed as usual if ($validator->isValid($username)) { // username appears to be valid } else { // username is invalid; print the reason $messages = $validator->getMessages(); foreach ($messages as $message) { echo "$message\n"; } }
The above example will check the users table to ensure that only a record with both the username and with the email $email is valid.
1190
CHAPTER 281
Digits
$validator = new Zend\Validator\Digits(); $validator->isValid("1234567890"); // returns true $validator->isValid(1234); // returns true $validator->isValid(1a234); // returns false
Note: Validating numbers When you want to validate numbers or numeric values, be aware that this validator only validates digits. This means that any other sign like a thousand separator or a comma will not pass this validator. In this case you should use Zend\I18n\Validator\Int or Zend\I18n\Validator\Float.
1191
1192
CHAPTER 282
EmailAddress
Zend\Validator\EmailAddress allows you to validate an email address. The validator rst splits the email address on local-part @ hostname and attempts to match these against known specications for email addresses and hostnames.
$validator = new Zend\Validator\EmailAddress(); if ($validator->isValid($email)) { // email appears to be valid } else { // email is invalid; print the reasons foreach ($validator->getMessages() as $message) { echo "$message\n"; } }
This will match the email address $email and on failure populate getMessages() with useful error messages.
hostname: Sets the hostname validator with which the domain part of the email address will be validated. mx: Denes if the MX records from the server should be detected. If this option is dened to TRUE then the MX records are used to verify if the server accepts emails. This option defaults to FALSE.
1 2
$validator = new Zend\Validator\EmailAddress( Zend\Validator\Hostname::ALLOW_DNS | Zend\Validator\Hostname::ALLOW_LOCAL); if ($validator->isValid($email)) { // email appears to be valid } else { // email is invalid; print the reasons foreach ($validator->getMessages() as $message) { echo "$message\n"; } }
1194
for the emails hostname. This tells you that the hostname accepts email, but doesnt tell you the exact email address itself is valid. MX checking is not enabled by default. To enable MX checking you can pass a second parameter to the Zend\Validator\EmailAddress constructor.
1 2 3 4 5 6
$validator = new Zend\Validator\EmailAddress( array( allow => Zend\Validator\Hostname::ALLOW_DNS, useMxCheck => true ) );
Note: MX Check under Windows Within Windows environments MX checking is only available when PHP 5.3 or above is used. Below PHP 5.3 MX checking will not be used even if its activated within the options. Alternatively you can either pass TRUE or FALSE to setValidateMx() to enable or disable MX validation. By enabling this setting network functions will be used to check for the presence of an MX record on the hostname of the email address you wish to validate. Please be aware this will likely slow your script down. Sometimes validation for MX records returns FALSE, even if emails are accepted. The reason behind this behaviour is, that servers can accept emails even if they do not provide a MX record. In this case they can provide A, A6 or AAAA records. To allow Zend\Validator\EmailAddress to check also for these other records, you need to set deep MX validation. This can be done at initiation by setting the deep option or by using setOptions().
1 2 3 4 5 6 7
$validator = new Zend\Validator\EmailAddress( array( allow => Zend\Validator\Hostname::ALLOW_DNS, useMxCheck => true, useDeepMxCheck => true ) );
Sometimes it can be useful to get the servers MX information which have been used to do further processing. Simply use getMXRecord() after validation. This method returns the received MX record including weight and sorted by it. Warning: Performance warning You should be aware that enabling MX check will slow down you script because of the used network functions. Enabling deep check will slow down your script even more as it searches the given server for 3 additional types.
Note: Disallowed IP addresses You should note that MX validation is only accepted for external servers. When deep MX validation is enabled, then local IP addresses like 192.168.* or 169.254.* are not accepted.
1195
able this by changing the setting via the internal Zend\Validator\Hostname object that exists within Zend\Validator\EmailAddress.
1
$validator->getHostnameValidator()->setValidateIdn(false);
More information on the usage of setValidateIdn() appears in the Zend\Validator\Hostname documentation. Please note IDNs are only validated if you allow DNS hostnames to be validated.
$validator->getHostnameValidator()->setValidateTld(false);
More information on the usage of setValidateTld() appears in the Zend\Validator\Hostname documentation. Please note TLDs are only validated if you allow DNS hostnames to be validated.
$validator = new Zend\Validator\EmailAddress(); $validator->setMessages( array( Zend\Validator\Hostname::UNKNOWN_TLD => I don\t know the TLD you gave ) );
Before Zend Framework 1.10 you had to attach the messages to your own Zend\Validator\Hostname, and then set this validator within Zend\Validator\EmailAddress to get your own messages returned.
1196
CHAPTER 283
GreaterThan
Zend\Validator\GreaterThan allows you to validate if a given value is greater than a minimum border value. Note: Zend\Validator\GreaterThan supports only number validation It should be noted that Zend\Validator\GreaterThan supports only the validation of numbers. Strings or dates can not be validated with this validator.
$valid = new Zend\Validator\GreaterThan(array(min => 10)); $value = 8; $return = $valid->isValid($value); // returns false
The above example returns TRUE for all values which are greater than 10.
1197
4 5 6 7 8 9
The example is almost equal to our rst example but we included the border value. Now the value 10 is allowed and will return TRUE.
1198
CHAPTER 284
Hex
Zend\Validator\Hex allows you to validate if a given value contains only hexadecimal characters. These are all characters from 0 to 9 and A to F case insensitive. There is no length limitation for the input you want to validate.
1 2 3 4 5 6
$validator = new Zend\Validator\Hex(); if ($validator->isValid(123ABC)) { // value contains only hex chars } else { // false }
Note: Invalid characters All other characters will return false, including whitespace and decimal point. Also unicode zeros and numbers from other scripts than latin will not be treated as valid.
1199
1200
CHAPTER 285
Hostname
Zend\Validator\Hostname allows you to validate a hostname against a set of known specications. It is possible to check for three different types of hostnames: a DNS Hostname (i.e. domain.com), IP address (i.e. 1.2.3.4), and Local hostnames (i.e. localhost). By default only DNS hostnames are matched.
$validator = new Zend\Validator\Hostname(); if ($validator->isValid($hostname)) { // hostname appears to be valid } else { // hostname is invalid; print the reasons foreach ($validator->getMessages() as $message) { echo "$message\n"; } }
This will match the hostname $hostname and on failure populate getMessages() with useful error messages.
1201
$validator = new Zend\Validator\Hostname(Zend\Validator\Hostname::ALLOW_IP); if ($validator->isValid($hostname)) { // hostname appears to be valid } else { // hostname is invalid; print the reasons foreach ($validator->getMessages() as $message) { echo "$message\n"; } }
As well as using ALLOW_ALL to accept all common hostnames types you can combine these types to allow for combinations. For example, to accept DNS and Local hostnames instantiate your Zend\Validator\Hostname class as so:
1 2
1202
3 4 5 6 7
Alternatively you can either pass TRUE or FALSE to setValidateIdn() to enable or disable IDN validation. If you are trying to match an IDN hostname which isnt currently supported it is likely it will fail validation if it has any international characters in it. Where a ccTLD le doesnt exist in Zend/Validator/Hostname specifying the additional characters a normal hostname validation is performed. Note: IDN validation Please note that IDN s are only validated if you allow DNS hostnames to be validated.
$validator = new Zend\Validator\Hostname( array( allow => Zend\Validator\Hostname::ALLOW_DNS, useIdnCheck => true, useTldCheck => false ) );
Alternatively you can either pass TRUE or FALSE to setValidateTld() to enable or disable TLD validation. Note: TLD validation Please note TLDs are only validated if you allow DNS hostnames to be validated.
1203
1204
CHAPTER 286
Iban
Zend\Validator\Iban validates if a given value could be a IBAN number. IBAN is the abbreviation for International Bank Account Number.
$validator = new Zend\Validator\Iban(array(country_code => false)); // Note: you can also set a FALSE as single parameter if ($validator->isValid(AT611904300234573201)) { // IBAN appears to be valid } else { // IBAN is not valid }
So any IBAN number will be valid. Note that this should not be done when you accept only accounts from a single country.
1205
$validator = new Zend\Validator\Iban(array(country_code => AT)); if ($validator->isValid(AT611904300234573201)) { // IBAN appears to be valid } else { // IBAN is not valid }
1206
CHAPTER 287
Identical
Zend\Validator\Identical allows you to validate if a given value is identical with a set token.
The validation will only then return TRUE when both values are 100% identical. In our example, when $value is origin. You can set the wished token also afterwards by using the method setToken() and getToken() to get the actual set token.
1207
1 2 3 4 5 6
$valid = new Zend\Validator\Identical(123); if ($valid->isValid($input)) { // input appears to be valid } else { // input is invalid }
Note: Type comparison You should be aware that also the type of a variable is used for validation. This means that the string 3 is not identical with the integer 3. When you want such a non strict validation you must set the strict option to false.
$form->add(array( name => elementOne, type => Password, )); $form->add(array( name => elementTwo, type => Password, validators => array( array( name => Identical, options => array( token => elementOne, ), ), ), ));
By using the elements name from the rst element as token for the second element, the validator validates if the second element is equal with the rst element. In the case your user does not enter two identical values, you will get a validation error.
$userFieldset = new Fieldset(user); // (1) $userFieldset->add(array( name => email, // (2) type => Email,
1208
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
)); // Lets add one fieldset inside the user fieldset, // so we can see how to manage the token in a different deepness $deeperFieldset = new Fieldset(deeperFieldset); // (3) $deeperFieldset->add(array( name => deeperFieldsetInput, // (4) type => Text, options => array( label => What validator are we testing?, ), )); $userFieldset->add($deeperFieldset); $signUpForm = new Form(signUp); $signUpForm->add($userFieldset); // Add an input that will validate the email input from user fieldset $signUpForm->add(array( name => confirmEmail, // (5) type => Email, )); // Add an input that will validate the deeperFieldsetInput from deeperFieldset // that lives inside the user fieldset $signUpForm->add(array( name => confirmTestingValidator, // (6) type => Text, )); $inputFilter = new InputFilter(); // This will ensure the user enter the same email in email (2) and confirmEmail (5) $inputFilter->add(array( name => confirmEmail, // references (5) validators => array( array( name => Identical, options => array( // user key references user fieldset (1), and email references email element // user fieldset (2) token => array(user => email), ), ), ), )); // This will ensure the user enter the same string in deeperFieldsetInput (4) // and confirmTestingValidator (6) $inputFilter->add(array( name => confirmTestingValidator, // references (6) validators => array( array( name => Identical, options => array( token => array( user => array( // references user fieldset (1) // deeperFieldset key references deeperFieldset fieldset (3) // deeperFieldsetInput references deeperFieldsetInput element (4) deeperFieldset => deeperFieldsetInput ) ),
1209
69 70 71 72 73 74
), ), ), )); $signUpForm->setInputFilter($inputFilter);
Note: Aways make sure that your token array have just one key per level all the way till the leaf, otherwise you can end up with unexpected results.
$valid = new Zend\Validator\Identical(array(token => 123, strict => FALSE)); $input = 123; if ($valid->isValid($input)) { // input appears to be valid } else { // input is invalid }
The difference to the previous example is that the validation returns in this case TRUE, even if you compare a integer with string value as long as the content is identical but not the type. For convenience you can also use setStrict() and getStrict().
287.6 Conguration
As all other validators, Zend\Validator\Identical also supports the usage of conguration settings as input parameter. This means that you can congure this validator with a Traversable object. There is a case which you should be aware of. If you are using an array as token, and it contains a token key, you should wrap it within another token key. See the examples below to undestand this situation.
1 2 3 4 5 6 7
// This will not validate array(token => 123), it will actually validate the integer 123 $valid = new Zend\Validator\Identical(array(token => 123)); if ($valid->isValid($input)) { // input appears to be valid } else { // input is invalid }
The reason for this special case is that you can congure the token which has to be used by giving the token key. So, when you are using an array as token, and it contains one element with a token key, then you have to wrap it like shown in the example below.
1 2 3 4
// Unlike the previous example, this will validate array(token => 123) $valid = new Zend\Validator\Identical(array(token => array(token => 123))); if ($valid->isValid($input)) { // input appears to be valid
1210
5 6 7
If the array you are willing to validate does not have a token key, you do not need to wrap it.
287.6. Conguration
1211
1212
CHAPTER 288
InArray
Zend\Validator\InArray allows you to validate if a given value is contained within an array. It is also able to validate multidimensional arrays.
1213
$validator = new Zend\Validator\InArray(array(haystack => array(value1, value2,...valueN))); if ($validator->isValid(value)) { // value found } else { // no value found }
This will behave exactly like PHPs in_array() method. Note: Per default this validation is not strict nor can it validate multidimensional arrays. Alternatively, you can dene the array to validate against after object construction by using the setHaystack() method. getHaystack() returns the actual set haystack array.
1 2 3 4 5 6 7 8
$validator = new Zend\Validator\InArray(); $validator->setHaystack(array(value1, value2,...valueN)); if ($validator->isValid(value)) { // value found } else { // no value found }
// defaults to InArray::COMPARE_NOT_STRICT_AND_PREVENT_STR_TO_INT_VULNERABILITY $validator = new Zend\Validator\InArray( array( haystack => array(value1, value2,...valueN), ) ); // set strict mode $validator = new Zend\Validator\InArray( array( haystack => array(value1, value2,...valueN), strict => InArray::COMPARE_STRICT // equates to true ) ); // set non-strict mode $validator = new Zend\Validator\InArray( array(
1214
19 20 21 22 23 24 25 26 27 28
haystack => array(value1, value2,...valueN), strict => InArray:COMPARE_NOT_STRICT // equates to false ) ); // or $validator->setStrict(InArray::COMPARE_STRICT); $validator->setStrict(InArray::COMPARE_NOT_STRICT); $validator->setStrict(InArray::COMPARE_NOT_STRICT_AND_PREVENT_STR_TO_INT_VULNERABILITY);
$validator = new Zend\Validator\InArray( array( haystack => array( firstDimension => array(value1, value2,...valueN), secondDimension => array(foo1, foo2,...fooN)), recursive => true ) ); if ($validator->isValid(value)) { // value found } else { // no value found }
Your array will then be validated recursively to see if the given value is contained. Additionally you could use setRecursive() to set this option afterwards and getRecursive() to retrieve it.
1 2 3 4 5 6 7 8 9 10 11 12 13 14
$validator = new Zend\Validator\InArray( array( firstDimension => array(value1, value2,...valueN), secondDimension => array(foo1, foo2,...fooN) ) ); $validator->setRecursive(true); if ($validator->isValid(value)) { // value found } else { // no value found }
Note: Default setting for recursion Per default the recursive validation is turned off. 288.4. Recursive array validation 1215
Note: Option keys within the haystack When you are using the keys haystack, strict or recursive within your haystack, then you must wrap the haystack key.
1216
CHAPTER 289
Ip
Zend\Validator\Ip allows you to validate if a given value is an IP address. It supports the IPv4, IPv6 and IPvFeature denitions.
$validator = new Zend\Validator\Ip(); if ($validator->isValid($ip)) { // ip appears to be valid } else { // ip is invalid; print the reasons }
Note: Invalid IP addresses Keep in mind that Zend\Validator\Ip only validates IP addresses. Addresses like mydomain.com or 192.168.50.1/index.html are no valid IP addresses. They are either hostnames or valid URLs but not IP addresses.
1217
Zend\Validator\Ip validates IPv6/IPvFuture addresses with regex. The reason is that the lters and methods from PHP itself dont follow the RFC. Many other available classes also dont follow it.
$validator = new Zend\Validator\Ip(array(allowipv6 => false)); if ($validator->isValid($ip)) { // ip appears to be valid ipv4 address } else { // ip is no ipv4 address }
Note: Default behaviour The default behaviour which Zend\Validator\Ip follows is to allow both standards.
1218
Chapter 289. Ip
CHAPTER 290
Isbn
$validator = new Zend\Validator\Isbn(); if ($validator->isValid($isbn)) { // isbn is valid } else { // isbn is not valid }
$validator = new Zend\Validator\Isbn(); $validator->setType(Zend\Validator\Isbn::ISBN13); // OR $validator = new Zend\Validator\Isbn(array( type => Zend\Validator\Isbn::ISBN13, ));
1219
7 8 9 10 11 12
if ($validator->isValid($isbn)) { // this is a valid ISBN-13 value } else { // this is an invalid ISBN-13 value }
The above will validate only ISBN-13 values. Valid types include: Zend\Validator\Isbn::AUTO (default) Zend\Validator\Isbn::ISBN10 Zend\Validator\Isbn::ISBN13
$validator = new Zend\Validator\Isbn(); $validator->setSeparator(-); // OR $validator = new Zend\Validator\Isbn(array( separator => -, )); if ($validator->isValid($isbn)) { // this is a valid ISBN with separator } else { // this is an invalid ISBN with separator }
Note: Values without separator This will return FALSE if $isbn doesnt contain a separator or if its an invalid ISBN value. Valid separators include: (empty) (default) - (hyphen) (space)
1220
CHAPTER 291
LessThan
Zend\Validator\LessThan allows you to validate if a given value is less than a maximum border value. Note: Zend\Validator\LessThan supports only number validation It should be noted that Zend\Validator\LessThan supports only the validation of numbers. Strings or dates can not be validated with this validator.
$valid = new Zend\Validator\LessThan(array(max => 10)); $value = 12; $return = $valid->isValid($value); // returns false
The above example returns TRUE for all values which are lower than 10.
1221
4 5 6 7 8 9
The example is almost equal to our rst example but we included the border value. Now the value 10 is allowed and will return TRUE.
1222
CHAPTER 292
NotEmpty
This validator allows you to validate if a given value is not empty. This is often useful when working with form elements or other user input, where you can use it to ensure required elements have values associated with them.
Note: Default behaviour differs from PHP Without providing conguration, Zend\Validator\NotEmptys behaviour differs from PHP.
integer: Returns FALSE when an integer 0 value is given. Per default this validation is not activated and returns TRUE on any integer values. oat: Returns FALSE when an oat 0.0 value is given. Per default this validation is not activated and returns TRUE on any oat values. string: Returns FALSE when an empty string is given. zero: Returns FALSE when the single character zero (0) is given. empty_array: Returns FALSE when an empty array is given. null: Returns FALSE when an NULL value is given. php: Returns FALSE on the same reasons where PHP method empty() would return TRUE. space: Returns FALSE when an string is given which contains only whitespaces. object: Returns TRUE. FALSE will be returned when object is not allowed but an object is given. object_string: Returns FALSE when an object is given and its __toString() method returns an empty string. object_count: Returns FALSE when an object is given, it has an Countable interface and its count is 0. all: Returns FALSE on all above types. All other given values will return TRUE per default. There are several ways to select which of the above types are validated. You can give one or multiple types and add them, you can give an array, you can use constants, or you can give a textual string. See the following examples:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
// Returns false on 0 $validator = new Zend\Validator\NotEmpty(Zend\Validator\NotEmpty::INTEGER); // Returns false on 0 or 0 $validator = new Zend\Validator\NotEmpty( Zend\Validator\NotEmpty::INTEGER + Zend\Validator\NotEmpty::ZERO ); // Returns false on 0 or 0 $validator = new Zend\Validator\NotEmpty(array( Zend\Validator\NotEmpty::INTEGER, Zend\Validator\NotEmpty::ZERO )); // Returns false on 0 or 0 $validator = new Zend\Validator\NotEmpty(array( integer, zero, ));
You can also provide an instance of Traversable to set the desired types. To set types after instantiation, use the setType() method.
1224
CHAPTER 293
PostCode
Zend\Validator\PostCode allows you to determine if a given value is a valid postal code. Postal codes are specic to cities, and in some locales termed ZIP codes. Zend\Validator\PostCode knows more than 160 different postal code formats. To select the correct format there are 2 ways. You can either use a fully qualied locale or you can set your own format manually. Using a locale is more convenient as Zend Framework already knows the appropriate postal code format for each locale; however, you need to use the fully qualied locale (one containing a region specier) to do so. For instance, the locale de is a locale but could not be used with Zend\Validator\PostCode as it does not include the region; de_AT, however, would be a valid locale, as it species the region code (AT, for Austria).
1
When you dont set a locale yourself, then Zend\Validator\PostCode will use the application wide set locale, or, when there is none, the locale returned by Locale.
1 2 3 4
// application wide locale within your bootstrap Locale::setDefault(de_AT); $validator = new Zend\Validator\PostCode();
You can also change the locale afterwards by calling setLocale(). And of course you can get the actual used locale by calling getLocale().
1 2
Postal code formats are simply regular expression strings. When the international postal code format, which is used by setting the locale, does not t your needs, then you can also manually set a format by calling setFormat().
1 2
Note: Conventions for self dened formats When using self dened formats you should omit the starting (/^) and ending tags ($/). They are attached automatically. You should also be aware that postcode values are always be validated in a strict way. This means that they have to be written standalone without additional characters when they are not covered by the format.
1225
Additionally, you may pass either an array or a Traversable instance to the constructor. When you do so, you must include either the key locale or format; these will be used to set the appropriate values in the validator object.
1 2 3 4
$validator = new Zend\Validator\PostCode(array( locale => de_AT, format => AT_\d+ ));
1226
CHAPTER 294
Regex
This validator allows you to validate if a given string conforms a dened regular expression.
$validator = new Zend\Validator\Regex(array(pattern => /^Test/)); $validator->isValid("Test"); // returns true $validator->isValid("Testing"); // returns true $validator->isValid("Pest"); // returns false
As you can see, the pattern has to be given using the same syntax as for preg_match(). For details about regular expressions take a look into PHPs manual about PCRE pattern syntax.
$validator = new Zend\Validator\Regex(array(pattern => /^Test/)); $validator->setPattern(ing$/); $validator->isValid("Test"); // returns false $validator->isValid("Testing"); // returns true $validator->isValid("Pest"); // returns false
1227
1228
CHAPTER 295
Sitemap Validators
295.1 Sitemap\Changefreq
Validates whether a string is valid for using as a changefreq element in a Sitemap XML document. Valid values are: always, hourly, daily, weekly, monthly, yearly, or never. Returns TRUE if and only if the value is a string and is equal to one of the frequencies specied above.
295.2 Sitemap\Lastmod
Validates whether a string is valid for using as a lastmod element in a Sitemap XML document. The lastmod element should contain a W3C date string, optionally discarding information about time. Returns TRUE if and only if the given value is a string and is valid according to the protocol.
Sitemap Lastmod Validator $validator = new Zend\Validator\Sitemap\Lastmod(); $validator->isValid(1999-11-11T22:23:52-02:00); // true $validator->isValid(2008-05-12T00:42:52+02:00); // true $validator->isValid(1999-11-11); // true $validator->isValid(2008-05-12); // true $validator->isValid(1999-11-11t22:23:52-02:00); // false $validator->isValid(2008-05-12T00:42:60+02:00); // false $validator->isValid(1999-13-11); // false $validator->isValid(2008-05-32); // false $validator->isValid(yesterday); // false
1 2 3 4 5 6 7 8 9 10 11 12
1229
295.3 Sitemap\Loc
Validates whether a string is valid for using as a loc element in a Sitemap XML document. Zend\Uri\Uri::isValid() internally. Read more at URI Validation. This uses
295.4 Sitemap\Priority
Validates whether a value is valid for using as a priority element in a Sitemap XML document. The value should be a decimal between 0.0 and 1.0. This validator accepts both numeric values and string values.
Sitemap Priority Validator $validator = new Zend\Validator\Sitemap\Priority(); $validator->isValid(0.1); // true $validator->isValid(0.789); // true $validator->isValid(0.8); // true $validator->isValid(1.0); // true $validator->isValid(1.1); // false $validator->isValid(-0.4); // false $validator->isValid(1.00001); // false $validator->isValid(0xFF); // false $validator->isValid(foo); // false
1 2 3 4 5 6 7 8 9 10 11 12
1230
CHAPTER 296
Step
Zend\Validator\Step allows you to validate if a given value is a valid step value. This validator requires the value to be a numeric value (either string, int or oat).
$validator = new Zend\Validator\Step(); if ($validator->isValid(1)) { // value is a valid step value } else { // false }
$validator = new Zend\Validator\Step(array( baseValue => 1.1, step => 2.2 )); echo $validator->isValid(1.1); // prints true echo $validator->isValid(3.3); // prints true
1231
8 9
1232
CHAPTER 297
StringLength
This validator allows you to validate if a given string is between a dened length. Note: Zend\Validator\StringLength supports only string validation It should be noted that Zend\Validator\StringLength supports only the validation of strings. Integers, oats, dates or objects can not be validated with this validator.
$validator = new Zend\Validator\StringLength(array(max => 6)); $validator->isValid("Test"); // returns true $validator->isValid("Testing"); // returns false
1233
You can set the maximum allowed length also afterwards by using the setMax() method. And getMax() to retrieve the actual maximum border.
1 2 3 4 5
$validator = new Zend\Validator\StringLength(); $validator->setMax(6); $validator->isValid("Test"); // returns true $validator->isValid("Testing"); // returns false
$validator = new Zend\Validator\StringLength(array(min => 5)); $validator->isValid("Test"); // returns false $validator->isValid("Testing"); // returns true
You can set the minimal requested length also afterwards by using the setMin() method. And getMin() to retrieve the actual minimum border.
1 2 3 4 5
$validator = new Zend\Validator\StringLength(); $validator->setMin(5); $validator->isValid("Test"); // returns false $validator->isValid("Testing"); // returns true
$validator = new Zend\Validator\StringLength(array(min => 3, max => 30)); $validator->isValid("."); // returns false $validator->isValid("Test"); // returns true $validator->isValid("Testing"); // returns true
Note: Setting a lower maximum border than the minimum border When you try to set a lower maximum value as the actual minimum value, or a higher minimum value as the actual maximum value, then an exception will be raised.
1234
You can set your own encoding at initiation with the encoding option, or by using the setEncoding() method. We assume that your installation uses ISO and your application it set to ISO. In this case you will see the below behaviour.
1 2 3 4 5 6 7 8 9 10 11 12
$validator = new Zend\Validator\StringLength( array(min => 6) ); $validator->isValid("rger"); // returns false $validator->setEncoding("UTF-8"); $validator->isValid("rger"); // returns true $validator2 = new Zend\Validator\StringLength( array(min => 6, encoding => UTF-8) ); $validator2->isValid("rger"); // returns true
So when your installation and your application are using different encodings, then you should always set an encoding yourself.
1235
1236
CHAPTER 298
Zend Framework comes with a set of classes for validating les, such as le size validation and CRC checking. Note: All of the File validators filter() methods support both a le path string or a $_FILES array as the supplied argument. When a $_FILES array is passed in, the tmp_name is used for the le path.
298.1 Crc32
Zend\Validator\File\Crc32 allows you to validate if a given les hashed contents matches the supplied crc32 hash(es). It is subclassed from the Hash validator to provide a convenient validator that only supports the crc32 algorithm. Note: This validator requires the Hash extension from PHP with the crc32 algorithm.
Supported Options
The following set of options are supported: hash (string) Hash to test the le against.
Usage Examples // Does file have the given hash? $validator = new \Zend\Validator\File\Crc32(3b3652f); // Or, check file against multiple hashes $validator = new \Zend\Validator\File\Crc32(array(3b3652f, e612b69)); // Perform validation with file path if ($validator->isValid(./myfile.txt)) { // file is valid }
1 2 3 4 5 6 7 8 9 10
1237
Public Methods
getCrc32() Returns the current set of crc32 hashes. Return type array addCrc32(string|array $options) Adds a crc32 hash for one or multiple les to the internal set of hashes. Parameters $options See Supported Options section for more information. setCrc32(string|array $options) Sets a crc32 hash for one or multiple les. Removes any previously set hashes. Parameters $options See Supported Options section for more information.
298.2 ExcludeExtension
Zend\Validator\File\ExcludeExtension checks the extension of les. It will assert false when a given le has one the a dened extensions. This validator is inversely related to the Extension validator. Please refer to the Extension validator for options and usage examples.
298.3 ExcludeMimeType
Zend\Validator\File\ExcludeMimeType checks the MIME type of les. It will assert false when a given le has one the a dened MIME types. This validator is inversely related to the MimeType validator. Please refer to the MimeType validator for options and usage examples.
298.4 Exists
Zend\Validator\File\Exists checks for the existence of les in specied directories. This validator is inversely related to the NotExists validator.
Supported Options
The following set of options are supported: directory (string|array) Comma-delimited string (or array) of directories.
Usage Examples
1238
1 2 3 4 5 6 7 8 9 10
// Only allow files that exist in ~both~ directories $validator = new \Zend\Validator\File\Exists(/tmp,/var/tmp); // ...or with array notation $validator = new \Zend\Validator\File\Exists(array(/tmp, /var/tmp)); // Perform validation if ($validator->isValid(/tmp/myfile.txt)) { // file is valid }
Note: This validator checks whether the specied le exists in all of the given directories. The validation will fail if the le does not exist in one (or more) of the given directories.
298.5 Extension
Zend\Validator\File\Extension checks the extension of les. It will assert true when a given le has one the a dened extensions. This validator is inversely related to the ExcludeExtension validator.
Supported Options
The following set of options are supported: extension (string|array) Comma-delimited string (or array) of extensions to test against. case (boolean) default:
Usage Examples // Allow files with php or exe extensions $validator = new \Zend\Validator\File\Extension(php,exe); // ...or with array notation $validator = new \Zend\Validator\File\Extension(array(php, exe)); // Test with case-sensitivity on $validator = new \Zend\Validator\File\Extension(array(php, exe), true); // Perform validation if ($validator->isValid(./myfile.php)) { // file is valid }
1 2 3 4 5 6 7 8 9 10 11 12 13
Public Methods
298.5. Extension
1239
298.6 Hash
Zend\Validator\File\Hash allows you to validate if a given les hashed contents matches the supplied hash(es) and algorithm(s). Note: This validator requires the Hash extension from PHP. A list of supported hash algorithms can be found with the hash_algos() function.
Supported Options
The following set of options are supported: hash (string) Hash to test the le against. algorithm (string) default:
Usage Examples // Does file have the given hash? $validator = new \Zend\Validator\File\Hash(3b3652f, crc32); // Or, check file against multiple hashes $validator = new \Zend\Validator\File\Hash(array(3b3652f, e612b69), crc32); // Perform validation with file path if ($validator->isValid(./myfile.txt)) { // file is valid }
1 2 3 4 5 6 7 8 9 10
Public Methods
getHash() Returns the current set of hashes. Return type array addHash(string|array $options) Adds a hash for one or multiple les to the internal set of hashes. Parameters $options See Supported Options section for more information. setHash(string|array $options) Sets a hash for one or multiple les. Removes any previously set hashes. Parameters $options See Supported Options section for more information.
298.7 ImageSize
Zend\Validator\File\ImageSize checks the size of image les. Minimum and/or maximum dimensions can be set to validate against.
1240
Supported Options
The following set of options are supported: minWidth (int|null) default: minHeight (int|null) default: maxWidth (int|null) default: maxHeight (int|null) default: option should be set to null.
Usage Examples // Is image size between 320x200 (min) and 640x480 (max)? $validator = new \Zend\Validator\File\ImageSize(320, 200, 640, 480); // ...or with array notation $validator = new \Zend\Validator\File\ImageSize(array( minWidth => 320, minHeight => 200, maxWidth => 640, maxHeight => 480, )); // Is image size equal to or larger than 320x200? $validator = new \Zend\Validator\File\ImageSize(array( minWidth => 320, minHeight => 200, )); // Is image size equal to or smaller than 640x480? $validator = new \Zend\Validator\File\ImageSize(array( maxWidth => 640, maxHeight => 480, )); // Perform validation with file path if ($validator->isValid(./myfile.jpg)) { // file is valid }
null null null null To bypass validation of a particular dimension, the relevant
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
Public Methods
getImageMin() Returns the minimum dimensions (width and height) Return type array getImageMax() Returns the maximum dimensions (width and height) Return type array
298.8 IsCompressed
Zend\Validator\File\IsCompressed checks if a le is a compressed archive, such as zip or gzip. This validator is based on the MimeType validator and supports the same methods and options.
298.8. IsCompressed
1241
The default list of compressed le MIME types can be found in the source code. Please refer to the MimeType validator for options and public methods.
Usage Examples $validator = new \Zend\Validator\File\IsCompressed(); if ($validator->isValid(./myfile.zip)) { // file is valid }
1 2 3 4
298.9 IsImage
Zend\Validator\File\IsImage checks if a le is an image, such as jpg or png. This validator is based on the MimeType validator and supports the same methods and options. The default list of image le MIME types can be found in the source code. Please refer to the MimeType validator for options and public methods.
Usage Examples $validator = new \Zend\Validator\File\IsImage(); if ($validator->isValid(./myfile.jpg)) { // file is valid }
1 2 3 4
298.10 Md5
Zend\Validator\File\Md5 allows you to validate if a given les hashed contents matches the supplied md5 hash(es). It is subclassed from the Hash validator to provide a convenient validator that only supports the md5 algorithm. Note: This validator requires the Hash extension from PHP with the md5 algorithm.
Supported Options
The following set of options are supported: hash (string) Hash to test the le against.
Usage Examples // Does file have the given hash? $validator = new \Zend\Validator\File\Md5(3b3652f336522365223); // Or, check file against multiple hashes $validator = new \Zend\Validator\File\Md5(array(
1 2 3 4 5
1242
6 7 8 9 10 11 12
3b3652f336522365223, eb3365f3365ddc65365 )); // Perform validation with file path if ($validator->isValid(./myfile.txt)) { // file is valid }
Public Methods
getMd5() Returns the current set of md5 hashes. Return type array addMd5(string|array $options) Adds a md5 hash for one or multiple les to the internal set of hashes. Parameters $options See Supported Options section for more information. setMd5(string|array $options) Sets a md5 hash for one or multiple les. Removes any previously set hashes. Parameters $options See Supported Options section for more information.
298.11 MimeType
Zend\Validator\File\MimeType checks the MIME type of les. It will assert true when a given le has one the a dened MIME types. This validator is inversely related to the ExcludeMimeType validator. Note: This component will use the FileInfo extension if it is available. If its not, it will degrade to the mime_content_type() function. And if the function call fails it will use the MIME type which is given by HTTP. You should be aware of possible security problems when you do not have FileInfo or mime_content_type() available. The MIME type given by HTTP is not secure and can be easily manipulated.
Supported Options
The following set of options are supported: mimeType (string|array) Comma-delimited string (or array) of MIME types to test against. magicFile (string|null) default: "MAGIC" constant Specify the location of the magicle to use. By default the MAGIC constant value will be used. enableHeaderCheck (boolean) default: "false" Check the HTTP Information for the le type when the leInfo or mimeMagic extensions can not be found.
298.11. MimeType
1243
Usage Examples // Only allow gif or jpg files $validator = new \Zend\Validator\File\MimeType(image/gif,image/jpg); // ...or with array notation $validator = new \Zend\Validator\File\MimeType(array(image/gif, image/jpg)); // ...or restrict an entire group of types $validator = new \Zend\Validator\File\MimeType(array(image, audio)); // Use a different magicFile $validator = new \Zend\Validator\File\MimeType(array( image/gif, image/jpg, magicFile => /path/to/magicfile.mgx )); // Use the HTTP information for the file type $validator = new \Zend\Validator\File\MimeType(array( image/gif, image/jpg, enableHeaderCheck => true )); // Perform validation if ($validator->isValid(./myfile.jpg)) { // file is valid }
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
Warning: Allowing groups of MIME types will accept all members of this group even if your application does not support them. When you allow image you also allow image/xpixmap and image/vasa which could be problematic.
298.12 NotExists
Zend\Validator\File\NotExists checks for the existence of les in specied directories. This validator is inversely related to the Exists validator.
Supported Options
The following set of options are supported: directory (string|array) Comma-delimited string (or array) of directories.
Usage Examples // Only allow files that do not exist in ~either~ directories $validator = new \Zend\Validator\File\NotExists(/tmp,/var/tmp); // ...or with array notation $validator = new \Zend\Validator\File\NotExists(array(/tmp, /var/tmp));
1 2 3 4 5 6
1244
7 8 9 10
Note: This validator checks whether the specied le does not exist in any of the given directories. The validation will fail if the le exists in one (or more) of the given directories.
298.13 Sha1
Zend\Validator\File\Sha1 allows you to validate if a given les hashed contents matches the supplied sha1 hash(es). It is subclassed from the Hash validator to provide a convenient validator that only supports the sha1 algorithm. Note: This validator requires the Hash extension from PHP with the sha1 algorithm.
Supported Options
The following set of options are supported: hash (string) Hash to test the le against.
Usage Examples // Does file have the given hash? $validator = new \Zend\Validator\File\Sha1(3b3652f336522365223); // Or, check file against multiple hashes $validator = new \Zend\Validator\File\Sha1(array( 3b3652f336522365223, eb3365f3365ddc65365 )); // Perform validation with file path if ($validator->isValid(./myfile.txt)) { // file is valid }
1 2 3 4 5 6 7 8 9 10 11 12
Public Methods
getSha1() Returns the current set of sha1 hashes. Return type array addSha1(string|array $options) Adds a sha1 hash for one or multiple les to the internal set of hashes. Parameters $options See Supported Options section for more information.
298.13. Sha1
1245
setSha1(string|array $options) Sets a sha1 hash for one or multiple les. Removes any previously set hashes. Parameters $options See Supported Options section for more information.
298.14 Size
Zend\Validator\File\Size checks for the size of a le.
Supported Options
The following set of options are supported: min (integer|string) default: max (integer|string) default: 1kB, 2MB, 0.2GB). null null The integer number of bytes, or a string in SI notation (ie.
The accepted SI notation units are: kB, MB, GB, TB, PB, and EB. All sizes are converted using 1024 as the base value (ie. 1kB == 1024 bytes, 1MB == 1024kB). useByteString (boolean) default: or with the plain byte size.
Usage Examples // Limit the file size to 40000 bytes $validator = new \Zend\Validator\File\Size(40000); // Limit the file size to between 10kB and 4MB $validator = new \Zend\Validator\File\Size(array( min => 10kB, max => 4MB )); // Perform validation with file path if ($validator->isValid(./myfile.txt)) { // file is valid }
1 2 3 4 5 6 7 8 9 10 11 12
298.15 UploadFile
Zend\Validator\File\UploadFile checks whether a single le has been uploaded via a form POST and will return descriptive messages for any upload errors. Note: Zend\InputFilter\FileInput will automatically prepend this validator in its validation chain.
Usage Examples
1246
1 2 3 4 5 6 7 8 9 10
use Zend\Http\PhpEnvironment\Request; $request = new Request(); $files = $request->getFiles(); // i.e. $files[my-upload][error] == 0 $validator = \Zend\Validator\File\UploadFile(); if ($validator->isValid($files[my-upload])) { // file is valid }
298.16 WordCount
Zend\Validator\File\WordCount checks for the number of words within a le.
Supported Options
The following set of options are supported: min (integer) default: max (integer) default:
Usage Examples // Limit the amount of words to a maximum of 2000 $validator = new \Zend\Validator\File\WordCount(2000); // Limit the amount of words to between 100 and 5000 $validator = new \Zend\Validator\File\WordCount(100, 5000); // ... or with array notation $validator = new \Zend\Validator\File\WordCount(array( min => 1000, max => 5000 )); // Perform validation with file path if ($validator->isValid(./myfile.txt)) { // file is valid }
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
298.16. WordCount
1247
1248
CHAPTER 299
Validator Chains
Often multiple validations should be applied to some value in a particular order. The following code demonstrates a way to solve the example from the introduction, where a username must be between 6 and 12 alphanumeric characters:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
// Create a validator chain and add validators to it $validatorChain = new Zend\Validator\ValidatorChain(); $validatorChain->attach( new Zend\Validator\StringLength(array(min => 6, max => 12))) ->attach(new Zend\Validator\Alnum()); // Validate the username if ($validatorChain->isValid($username)) { // username passed validation } else { // username failed validation; print reasons foreach ($validatorChain->getMessages() as $message) { echo "$message\n"; } }
Validators are run in the order they were added to Zend\Validator\ValidatorChain. In the above example, the username is rst checked to ensure that its length is between 6 and 12 characters, and then it is checked to ensure that it contains only alphanumeric characters. The second validation, for alphanumeric characters, is performed regardless of whether the rst validation, for length between 6 and 12 characters, succeeds. This means that if both validations fail, getMessages() will return failure messages from both validators. In some cases it makes sense to have a validator break the chain if its validation process fails. Zend\Validator\ValidatorChain supports such use cases with the second parameter to the attach() method. By setting $breakChainOnFailure to TRUE, the added validator will break the chain execution upon failure, which avoids running any other validations that are determined to be unnecessary or inappropriate for the situation. If the above example were written as follows, then the alphanumeric validation would not occur if the string length validation fails:
1 2 3 4 5
$validatorChain->attach( new Zend\Validator\StringLength(array(min => 6, max => 12)), true) ->attach(new Zend\Validator\Alnum());
Any object that implements Zend\Validator\ValidatorInterface may be used in a validator chain. 1249
1250
CHAPTER 300
Writing Validators
Zend\Validator supplies a set of commonly needed validators, but inevitably, developers will wish to write custom validators for their particular needs. The task of writing a custom validator is described in this section. Zend\Validator\ValidatorInterface denes two methods, isValid() and getMessages(), that may be implemented by user classes in order to create custom validation objects. An object that implements Zend\Validator\AbstractValidator interface may be added to a validator chain with Zend\Validator\ValidatorChain::addValidator(). Such objects may also be used with Zend\Filter\Input. As you may already have inferred from the above description of Zend\Validator\ValidatorInterface, validation classes provided with Zend Framework return a boolean value for whether or not a value validates successfully. They also provide information about why a value failed validation. The availability of the reasons for validation failures may be valuable to an application for various purposes, such as providing statistics for usability analysis. Basic validation failure message functionality is implemented in Zend\Validator\AbstractValidator. To include this functionality when creating a validation class, simply extend Zend\Validator\AbstractValidator. In the extending class you would implement the isValid() method logic and dene the message variables and message templates that correspond to the types of validation failures that can occur. If a value fails your validation tests, then isValid() should return FALSE. If the value passes your validation tests, then isValid() should return TRUE. In general, the isValid() method should not throw any exceptions, except where it is impossible to determine whether or not the input value is valid. A few examples of reasonable cases for throwing an exception might be if a le cannot be opened, an LDAP server could not be contacted, or a database connection is unavailable, where such a thing may be required for validation success or failure to be determined.
Creating a Simple Validation Class
The following example demonstrates how a very simple custom validator might be written. In this case the validation rules are simply that the input value must be a oating point value.
1 2 3 4 5 6 7
class MyValid\Float extends Zend\Validator\AbstractValidator { const FLOAT = float; protected $messageTemplates = array( self::FLOAT => "%value% is not a floating point value" );
1251
8 9 10 11 12 13 14 15 16 17 18 19 20
public function isValid($value) { $this->setValue($value); if (!is_float($value)) { $this->error(self::FLOAT); return false; } return true; } }
The class denes a template for its single validation failure message, which includes the built-in magic parameter, %value%. The call to setValue() prepares the object to insert the tested value into the failure message automatically, should the value fail validation. The call to error() tracks a reason for validation failure. Since this class only denes one failure message, it is not necessary to provide error() with the name of the failure message template.
Writing a Validation Class having Dependent Conditions
The following example demonstrates a more complex set of validation rules, where it is required that the input value be numeric and within the range of minimum and maximum boundary values. An input value would fail validation for exactly one of the following reasons: The input value is not numeric. The input value is less than the minimum allowed value. The input value is more than the maximum allowed value. These validation failure reasons are then translated to denitions in the class:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
class MyValid\NumericBetween extends Zend\Validator\AbstractValidator { const MSG_NUMERIC = msgNumeric; const MSG_MINIMUM = msgMinimum; const MSG_MAXIMUM = msgMaximum; public $minimum = 0; public $maximum = 100; protected $messageVariables = array( min => minimum, max => maximum ); protected $messageTemplates = array( self::MSG_NUMERIC => "%value% is not numeric", self::MSG_MINIMUM => "%value% must be at least %min%", self::MSG_MAXIMUM => "%value% must be no more than %max%" ); public function isValid($value) { $this->setValue($value); if (!is_numeric($value)) {
1252
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
$this->error(self::MSG_NUMERIC); return false; } if ($value < $this->minimum) { $this->error(self::MSG_MINIMUM); return false; } if ($value > $this->maximum) { $this->error(self::MSG_MAXIMUM); return false; } return true; } }
The public properties $minimum and $maximum have been established to provide the minimum and maximum boundaries, respectively, for a value to successfully validate. The class also denes two message variables that correspond to the public properties and allow min and max to be used in message templates as magic parameters, just as with value. Note that if any one of the validation checks in isValid() fails, an appropriate failure message is prepared, and the method immediately returns FALSE. These validation rules are therefore sequentially dependent. That is, if one test should fail, there is no need to test any subsequent validation rules. This need not be the case, however. The following example illustrates how to write a class having independent validation rules, where the validation object may return multiple reasons why a particular validation attempt failed.
Validation with Independent Conditions, Multiple Reasons for Failure
Consider writing a validation class for password strength enforcement - when a user is required to choose a password that meets certain criteria for helping secure user accounts. Let us assume that the password security criteria enforce that the password: is at least 8 characters in length, contains at least one uppercase letter, contains at least one lowercase letter, and contains at least one digit character. The following class implements these validation criteria:
1 2 3 4 5 6 7 8 9 10 11 12 13
class MyValid\PasswordStrength extends Zend\Validator\AbstractValidator { const LENGTH = length; const UPPER = upper; const LOWER = lower; const DIGIT = digit; protected $messageTemplates = array( self::LENGTH => "%value% must be at least 8 characters in length", self::UPPER => "%value% must contain at least one uppercase letter", self::LOWER => "%value% must contain at least one lowercase letter", self::DIGIT => "%value% must contain at least one digit character" );
1253
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
public function isValid($value) { $this->setValue($value); $isValid = true; if (strlen($value) < 8) { $this->error(self::LENGTH); $isValid = false; } if (!preg_match(/[A-Z]/, $value)) { $this->error(self::UPPER); $isValid = false; } if (!preg_match(/[a-z]/, $value)) { $this->error(self::LOWER); $isValid = false; } if (!preg_match(/\d/, $value)) { $this->error(self::DIGIT); $isValid = false; } return $isValid; } }
Note that the four criteria tests in isValid() do not immediately return FALSE. This allows the validation class to provide all of the reasons that the input password failed to meet the validation requirements. if, for example, a user were to input the string #$% as a password, isValid() would cause all four validation failure messages to be returned by a subsequent call to getMessages().
1254
CHAPTER 301
Validation Messages
Each validator which is based on Zend\Validator\ValidatorInterface provides one or multiple messages in the case of a failed validation. You can use this information to set your own messages, or to translate existing messages which a validator could return to something different. These validation messages are constants which can be found at top of each validator class. Zend\Validator\GreaterThan for an descriptive example:
1 2 3
protected $messageTemplates = array( self::NOT_GREATER => "%value% is not greater than %min%", );
As you can see the constant self::NOT_GREATER refers to the failure and is used as key, and the message itself is used as value of the message array. You can retrieve all message templates from a validator by using the getMessageTemplates() method. It returns you the above array which contains all messages a validator could return in the case of a failed validation.
1 2
Using the setMessage() method you can set another message to be returned in case of the specied failure.
1 2 3 4 5
The second parameter denes the failure which will be overridden. When you omit this parameter, then the given message will be set for all possible failures of this validator.
1255
Note: Used path The resource les are outside of the library path because all of your translations should also be outside of this path. So to translate all validation messages to German for example, all you have to do is to attach a translator to Zend\Validator\AbstractValidator using these resource les.
1 2 3 4 5 6 7 8
Note: Supported languages This feature is very young, so the amount of supported languages may not be complete. New languages will be added with each release. Additionally feel free to use the existing resource les to make your own translations. You could also use these resource les to rewrite existing translations. So you are not in need to create these les manually yourself.
Zend\Validator\AbstractValidator::setMessageLength(100);
Note: Where is this parameter used? The set message length is used for all validators, even for self dened ones, as long as they extend Zend\Validator\AbstractValidator.
1256
CHAPTER 302
Zend\Version provides a class constant Zend\Version\Version::VERSION that contains a string identifying the version number of your Zend Framework installation. Zend\Version\Version::VERSION might contain 1.7.4, for example. The static method Zend\Version\Version::compareVersion($version) is based on the PHP function version_compare(). This method returns -1 if the specied version is older than the installed Zend Framework version, 0 if they are the same and +1 if the specied version is newer than the version of the Zend Framework installation.
Example of the compareVersion() Method // returns -1, 0 or 1 $cmp = Zend\Version\Version::compareVersion(2.0.0);
1 2
The static method Zend\Version\Version::getLatest() provides the version number of the last stable release available for download on the site Zend Framework.
Example of the getLatest() Method // returns 1.11.0 (or a later version) echo Zend\Version\Version::getLatest();
1 2
1257
1258
CHAPTER 303
1259
1260
CHAPTER 304
Overview
Zend\View provides the View layer of Zend Framework 2s MVC system. It is a multi-tiered system allowing a variety of mechanisms for extension, substitution, and more. The components of the view layer are as follows: Variables Containers hold variables and callbacks that you wish to represent in the view. Often-times, a Variables Container will also provide mechanisms for context-specic escaping of variables and more. View Models hold Variables Containers, specify the template to use (if any), and optionally provide rendering options (more on that below). View Models may be nested in order to represent complex structures. Renderers take View Models and provide a representation of them to return. Zend Framework 2 ships with three renderers by default: a PhpRenderer which utilizes PHP templates in order to generate markup, a JsonRenderer, and a FeedRenderer for generating RSS and Atom feeds. Resolvers utilizes Resolver Strategies to resolve a template name to a resource a Renderer may consume. As an example, a Resolver may take the name blog/entry and resolve it to a PHP view script. The View consists of strategies that map the current Request to a Renderer, and strategies for injecting the result of rendering to the Response. Rendering Strategies listen to the Zend\View\ViewEvent::EVENT_RENDERER event of the View and decide which Renderer should be selected based on the Request or other criteria. Response Strategies are used to inject the Response object with the results of rendering. That may also include taking actions such as setting Content-Type headers. Additionally, Zend Framework 2 provides integration with the MVC via a number of event listeners in the Zend\Mvc\View namespace.
1261
1262
CHAPTER 305
Usage
This section of the manual is designed to show you typical usage patterns of the view layer when using it within the Zend Framework 2 MVC. The assumptions are that you are using Dependency Injection and the default MVC view strategies.
305.1 Conguration
The default conguration will typically work out-of-the-box. However, you will still need to select Resolver Strategies and congure them, as well as potentially indicate alternate template names for things like the site layout, 404 (not found) pages, and error pages. The code snippets below can be added to your conguration to accomplish this. We recommend adding it to a site-specic module, such as the Application module from the frameworks ZendSkeletonApplication, or to one of your autoloaded congurations within the config/autoload/ directory.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
return array( view_manager => array( // The TemplateMapResolver allows you to directly map template names // to specific templates. The following map would provide locations // for a home page template ("application/index/index"), as well as for // the layout ("layout/layout"), error pages ("error/index"), and // 404 page ("error/404"), resolving them to view scripts. template_map => array( application/index/index => __DIR__ . /../view/application/index/index.phtml, site/layout => __DIR__ . /../view/layout/layout.phtml, error/index => __DIR__ . /../view/error/index.phtml, error/404 => __DIR__ . /../view/error/404.phtml, ), // The TemplatePathStack takes an array of directories. Directories // are then searched in LIFO order (its a stack) for the requested // view script. This is a nice solution for rapid application // development, but potentially introduces performance expense in // production due to the number of static calls necessary. // // The following adds an entry pointing to the view directory // of the current module. Make sure your keys differ between modules // to ensure that they are not overwritten -- or simply omit the key! template_path_stack => array( application => __DIR__ . /../view,
1263
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
),
// This will be used as the default suffix for template scripts resolving, it defaults to ph default_template_suffix => php, // Set the template name for the sites layout. // // By default, the MVCs default Rendering Strategy uses the // template name "layout/layout" for the sites layout. // Here, we tell it to use the "site/layout" template, // which we mapped via the TemplateMapResolver above. layout => site/layout, // By default, the MVC registers an "exception strategy", which is // triggered when a requested action raises an exception; it creates // a custom view model that wraps the exception, and selects a // template. Well set it to "error/index". // // Additionally, well tell it that we want to display an exception // stack trace; youll likely want to disable this by default. display_exceptions => true, exception_template => error/index, // Another strategy the MVC registers by default is a "route not // found" strategy. Basically, this gets triggered if (a) no route // matches the current request, (b) the controller specified in the // route match cannot be found in the service locator, (c) the controller // specified in the route match does not implement the DispatchableInterface // interface, or (d) if a response from a controller sets the // response status to 404. // // The default template used in such situations is "error", just // like the exception strategy. Here, we tell it to use the "error/404" // template (which we mapped via the TemplateMapResolver, above). // // You can opt in to inject the reason for a 404 situation; see the // various Application\:\:ERROR_*_ constants for a list of values. // Additionally, a number of 404 situations derive from exceptions // raised during routing or dispatching. You can opt-in to display // these. display_not_found_reason => true, not_found_template => error/404, ), );
1264
5 6 7 8 9 10 11 12 13 14 15 16
class BazBatController extends AbstractActionController { public function doSomethingCrazyAction() { $view = new ViewModel(array( message => Hello world, )); $view->setTemplate(foo/baz-bat/do-something-crazy); return $view; } }
This sets a message variable in the View Model, and sets the template name foo/baz-bat/do-something-crazy. The View Model is then returned. In most cases, youll likely have a template name based on the module namespace, controller, and action. Considering that, and if youre simply passing some variables, could this be made simpler? Denitely. The MVC registers a couple of listeners for controllers to automate this. The rst will look to see if you returned an associative array from your controller; if so, it will create a View Model and make this associative array the Variables Container; this View Model then replaces the MvcEvents result. It will also look to see if you returned nothing or null; if so, it will create a View Model without any variables attached; this View Model also replaces the MvcEvents result. The second listener checks to see if the MvcEvent result is a View Model, and, if so, if it has a template associated with it. If not, it will inspect the controller matched during routing to determine the module namespace and the controller class name, and, if available, its action parameter in order to create a template name. This will be module/controller/action, all normalized to lowercase, dash-separated words. As an example, the controller Foo\Controller\BazBatController with action doSomethingCrazyAction, would be mapped to the template foo/baz-bat/do-something-crazy. As you can see, the words Controller and Action are omitted. In practice, that means our previous example could be re-written as follows:
1 2 3 4 5 6 7 8 9 10 11 12 13
namespace Foo\Controller; use Zend\Mvc\Controller\AbstractActionController; class BazBatController extends AbstractActionController { public function doSomethingCrazyAction() { return array( message => Hello world, ); } }
The above method will likely work for the majority of use cases. When you need to specify a different template, explicitly create and return a View Model and specify the template manually, as in the rst example.
1265
As an example, you may want the View from an action to be one primary section that includes both an article and a couple of sidebars; one of the sidebars may include content from multiple Views as well:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
namespace Content\Controller; use Zend\Mvc\Controller\AbstractActionController; use Zend\View\Model\ViewModel; class ArticleController extends AbstractActionController { public function viewAction() { // get the article from the persistence layer, etc... $view = new ViewModel(); // this is not needed since it matches "module/controller/action" $view->setTemplate(content/article/view); $articleView = new ViewModel(array(article => $article)); $articleView->setTemplate(content/article); $primarySidebarView = new ViewModel(); $primarySidebarView->setTemplate(content/main-sidebar); $secondarySidebarView = new ViewModel(); $secondarySidebarView->setTemplate(content/secondary-sidebar); $sidebarBlockView = new ViewModel(); $sidebarBlockView->setTemplate(content/block); $secondarySidebarView->addChild($sidebarBlockView, block); $view->addChild($articleView, article) ->addChild($primarySidebarView, sidebar_primary) ->addChild($secondarySidebarView, sidebar_secondary); return $view; } }
The above will create and return a View Model specifying the template content/article/view. When the View is rendered, it will render three child Views, the $articleView, $primarySidebarView, and $secondarySidebarView; these will be captured to the $views article, sidebar_primary, and sidebar_secondary variables, respectively, so that when it renders, you may include that content. Additionally, the $secondarySidebarView will include an additional View Model, $sidebarBlockView, which will be captured to its block view variable. To better visualize this, lets look at what the nal content might look like, with comments detailing where each nested view model is injected. Here are the templates, rendered based on a 12-column grid:
1 2 3 4 5 6
<?php // "content/article/view" template ?> <!-- This is from the $view View Model, and the "content/article/view" template --> <div class="row content"> <?php echo $this->article ?> <?php echo $this->sidebar_primary ?>
1266
7 8 9
<?php echo $this->sidebar_secondary ?> </div> <?php // "content/article" template ?> <!-- This is from the $articleView View Model, and the "content/article" template --> <article class="span8"> <?php echo $this->escapeHtml(article) ?> </article> <?php // "content/main-sidebar" template ?> <!-- This is from the $primarySidebarView View Model, and the "content/main-sidebar" template --> <div class="span2 sidebar"> sidebar content... </div> <?php // "content/secondary-sidebar template ?> <!-- This is from the $secondarySidebarView View Model, and the "content/secondary-sidebar" template --> <div class="span2 sidebar pull-right"> <?php echo $this->block ?> </div> <?php // "content/block template ?> <!-- This is from the $sidebarBlockView View Model, and the "content/block" template --> <div class="block"> block content... </div>
1 2 3 4 5 6
1 2 3 4 5 6
1 2 3 4 5 6
1 2 3 4 5 6
<!-- This is from the $view View Model, and the "content/article/view" template --> <div class="row content"> <!-- This is from the $articleView View Model, and the "content/article" template --> <article class="span8"> Lorem ipsum .... </article> <!-- This is from the $primarySidebarView View Model, and the "content/main-sidebar" template --> <div class="span2 sidebar"> sidebar content... </div> <!-- This is from the $secondarySidebarView View Model, and the "content/secondary-sidebar" template --> <div class="span2 sidebar pull-right"> <!-- This is from the $sidebarBlockView View Model, and the "content/block" template --> <div class="block"> block content... </div> </div> </div>
1267
As you can see, you can achieve very complex markup using nested Views, while simultaneously keeping the details of rendering isolated from the Request/Response lifecycle of the controller.
<html> <head> <title><?php echo $this->headTitle() ?></title> </head> <body> <?php echo $this->content; ?> </body> </html>
If you want to specify a different View variable for which to capture, explicitly create a view model in your controller, and set its capture to value:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
namespace Foo\Controller; use Zend\Mvc\Controller\AbstractActionController; use Zend\View\Model\ViewModel; class BazBatController extends AbstractActionController { public function doSomethingCrazyAction() { $view = new ViewModel(array( message => Hello world, )); // Capture to the layout views "article" variable $view->setCaptureTo(article); return $view; } }
There will be times you dont want to render a layout. For example, you might be answering an API call which expects JSON or an XML payload, or you might be answering an XHR request that expects a partial HTML payload. The simplest way to do this is to explicitly create and return a view model from your controller, and mark it as terminal,
1268
which will hint to the MVC listener that normally injects the returned View Model into the layout View Model, to instead replace the layout view model.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
namespace Foo\Controller; use Zend\Mvc\Controller\AbstractActionController; use Zend\View\Model\ViewModel; class BazBatController extends AbstractActionController { public function doSomethingCrazyAction() { $view = new ViewModel(array( message => Hello world, )); // Disable layouts; MvcEvent will use this View Model instead $view->setTerminal(true); return $view; } }
When discussing nesting View Models, we detailed a nested View Model which contained an article and sidebars. Sometimes, you may want to provide additional View Models to the layout, instead of nesting in the returned layout. This may be done by using the layout controller plugin, which returns the root View Model. You can then call the same addChild() method on it as we did in that previous example.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
namespace Content\Controller; use Zend\Mvc\Controller\AbstractActionController; use Zend\View\Model\ViewModel; class ArticleController extends AbstractActionController { public function viewAction() { // get the article from the persistence layer, etc... // Get the "layout" view model and inject a sidebar $layout = $this->layout(); $sidebarView = new ViewModel(); $sidebarView->setTemplate(content/sidebar); $layout->addChild($sidebarView, sidebar); // Create and return a view model for the retrieved article $view = new ViewModel(array(article => $article)); $view->setTemplate(content/article); return $view; } }
You could also use this technique to select a different layout, by simply calling the setTemplate() method of the layout View Model:
1 2 3 4
1269
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
use Zend\View\Model\ViewModel; class ArticleController extends AbstractActionController { public function viewAction() { // get the article from the persistence layer, etc... // Get the "layout" view model and set an alternate template $layout = $this->layout(); $layout->setTemplate(article/layout); // Create and return a view model for the retrieved article $view = new ViewModel(array(article => $article)); $view->setTemplate(content/article); return $view; } }
Sometimes, you may want to access the layout from within your actual view scripts when using the PhpRenderer. Reasons might include wanting to change the layout template or wanting to either access or inject layout view variables. Similar to the layout controller plugin, you can use the layout View Helper. If you provide a string argument to it, you will change the template; if you provide no arguments, the root layout View Model is returned. Commonly, you may want to alter the layout based on the current module. This requires (a) detecting if the controller matched in routing belongs to this module, and then (b) changing the template of the View Model. The place to do these actions is in a listener. It should listen either to the route event at low (negative) priority, or on the dispatch event, at any priority. Typically, you will register this during the bootstrap event.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
namespace Content; class Module { /** * @param \Zend\Mvc\MvcEvent $e The MvcEvent instance * @return void */ public function onBootstrap($e) { // Register a dispatch event $app = $e->getParam(application); $app->getEventManager()->attach(dispatch, array($this, setLayout)); } /** * @param \Zend\Mvc\MvcEvent $e The MvcEvent instance * @return void */ public function setLayout($e) { $matches = $e->getRouteMatch(); $controller = $matches->getParam(controller); if (false === strpos($controller, __NAMESPACE__)) { // not a controller from this module return; } // Set the layout template
1270
30 31 32 33
namespace Application; class Module { /** * @param \Zend\Mvc\MvcEvent $e The MvcEvent instance * @return void */ public function onBootstrap($e) { // Register a "render" event, at high priority (so it executes prior // to the view attempting to render) $app = $e->getApplication(); $app->getEventManager()->attach(render, array($this, registerJsonStrategy), 100); } /** * @param \Zend\Mvc\MvcEvent $e The MvcEvent instance * @return void */ public function registerJsonStrategy($e)
1271
22 23 24 25 26 27 28 29 30 31
The above will register the JsonStrategy with the render event, such that it executes prior to the PhpRendererStrategy, and thus ensure that a JSON payload is created when requested. What if you want this to happen only in specic modules, or specic controllers? One way is similar to the last example in the previous section on layouts, where we detailed changing the layout for a specic module:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
namespace Content; class Module { /** * @param \Zend\Mvc\MvcEvent $e The MvcEvent instance * @return void */ public function onBootstrap($e) { // Register a render event $app = $e->getParam(application); $app->getEventManager()->attach(render, array($this, registerJsonStrategy), 100); } /** * @param \Zend\Mvc\MvcEvent $e The MvcEvent instance * @return void */ public function registerJsonStrategy($e) { $matches = $e->getRouteMatch(); $controller = $matches->getParam(controller); if (false === strpos($controller, __NAMESPACE__)) { // not a controller from this module return; } // Potentially, you could be even more selective at this point, and test // for specific controller classes, and even specific actions or request // methods. // Set the JSON $app = $locator = $view = $jsonStrategy = strategy when controllers from this module are selected $e->getTarget(); $app->getServiceManager(); $locator->get(Zend\View\View); $locator->get(ViewJsonStrategy);
1272
While the above examples detail using the JsonStrategy, the same could be done for the FeedStrategy. What if you want to use a custom renderer? Or if your app might allow a combination of JSON, Atom feeds, and HTML? At this point, youll need to create your own custom strategies. Below is an example that appropriately loops through the HTTP Accept header, and selects the appropriate Renderer based on what is matched rst.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
namespace Content\View; use use use use use use Zend\EventManager\EventManagerInterface; Zend\EventManager\ListenerAggregateInterface; Zend\Feed\Writer\Feed; Zend\View\Renderer\FeedRenderer; Zend\View\Renderer\JsonRenderer; Zend\View\Renderer\PhpRenderer;
class AcceptStrategy implements ListenerAggregateInterface { protected $feedRenderer; protected $jsonRenderer; protected $listeners = array(); protected $phpRenderer; public function __construct( PhpRenderer $phpRenderer, JsonRenderer $jsonRenderer, FeedRenderer $feedRenderer ) { $this->phpRenderer = $phpRenderer; $this->jsonRenderer = $jsonRenderer; $this->feedRenderer = $feedRenderer; }
public function attach(EventManagerInterface $events, $priority = null) { if (null === $priority) { $this->listeners[] = $events->attach(renderer, array($this, selectRenderer)); $this->listeners[] = $events->attach(response, array($this, injectResponse)); } else { $this->listeners[] = $events->attach(renderer, array($this, selectRenderer), $priorit $this->listeners[] = $events->attach(response, array($this, injectResponse), $priorit } } public function detach(EventManagerInterface $events) { foreach ($this->listeners as $index => $listener) { if ($events->detach($listener)) { unset($this->listeners[$index]); } } } /** * @param \Zend\Mvc\MvcEvent $e The MvcEvent instance * @return \Zend\View\Renderer\RendererInterface */ public function selectRenderer($e) { $request = $e->getRequest();
1273
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
$headers = $request->getHeaders(); // No Accept header? return PhpRenderer if (!$headers->has(accept)) { return $this->phpRenderer; } $accept = $headers->get(accept); foreach ($accept->getPrioritized() as $mediaType) { if (0 === strpos($mediaType, application/json)) { return $this->jsonRenderer; } if (0 === strpos($mediaType, application/rss+xml)) { $this->feedRenderer->setFeedType(rss); return $this->feedRenderer; } if (0 === strpos($mediaType, application/atom+xml)) { $this->feedRenderer->setFeedType(atom); return $this->feedRenderer; } } // Nothing matched; return PhpRenderer. Technically, we should probably // return an HTTP 415 Unsupported response. return $this->phpRenderer; } /** * @param \Zend\Mvc\MvcEvent $e The MvcEvent instance * @return void */ public function injectResponse($e) { $renderer = $e->getRenderer(); $response = $e->getResponse(); $result = $e->getResult(); if ($renderer === $this->jsonRenderer) { // JSON Renderer; set content-type header $headers = $response->getHeaders(); $headers->addHeaderLine(content-type, application/json); } elseif ($renderer === $this->feedRenderer) { // Feed Renderer; set content-type header, and export the feed if // necessary $feedType = $this->feedRenderer->getFeedType(); $headers = $response->getHeaders(); $mediatype = application/ . ((rss == $feedType) ? rss : atom) . +xml; $headers->addHeaderLine(content-type, $mediatype); // If the $result is a feed, export it if ($result instanceof Feed) { $result = $result->export($feedType); } } elseif ($renderer !== $this->phpRenderer) { // Not a renderer we support, therefor not our strategy. Return return;
1274
This strategy would be registered just as we demonstrated registering the JsonStrategy earlier. You would also need to dene DI conguration to ensure the various renderers are injected when you retrieve the strategy from the applications locator instance.
1275
1276
CHAPTER 306
The PhpRenderer
Zend\View\Renderer\PhpRenderer renders view scripts written in PHP, capturing and returning the output. It composes Variable containers and/or View Models, a helper plugin manager for helpers, and optional ltering of the captured output. The PhpRenderer is template system agnostic; you may use PHP as your template language, or create instances of other template systems and manipulate them within your view script. Anything you can do with PHP is available to you.
306.1 Usage
Basic usage consists of instantiating or otherwise obtaining an instance of the PhpRenderer, providing it with a resolver which will resolve templates to PHP view scripts, and then calling its render() method. Instantiating a renderer is trivial:
1 2 3
Zend Framework ships with several types of resolvers, which are used to resolve a template name to a resource a renderer can consume. The ones we will usually use with the PhpRenderer are: Zend\View\Resolver\TemplateMapResolver, which simply maps template names directly to view scripts. Zend\View\Resolver\TemplatePathStack, which creates a LIFO stack of script directories in which to search for a view script. By default, it appends the sufx .phtml to the requested template name, and then loops through the script directories; if it nds a le matching the requested template, it returns the full le path. Zend\View\Resolver\AggregateResolver, which allows attaching a FIFO queue of resolvers to consult. We suggest using the AggregateResolver, as it allows you to create a multi-tiered strategy for resolving template names. Programmatically, you would then do something like this:
1 2
1277
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
$renderer = new PhpRenderer(); $resolver = new Resolver\AggregateResolver(); $renderer->setResolver($resolver); $map = new Resolver\TemplateMapResolver(array( layout => __DIR__ . /view/layout.phtml, index/index => __DIR__ . /view/index/index.phtml, )); $stack = new Resolver\TemplatePathStack(array( script_paths => array( __DIR__ . /view, $someOtherPath ) )); $resolver->attach($map) // this will be consulted first ->attach($stack);
You can also specify a specic priority value when registering resolvers, with high, positive integers getting higher priority, and low, negative integers getting low priority, when resolving. In an MVC application, you can congure this via DI quite easily:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
return array( di => array( instance => array( Zend\View\Resolver\AggregateResolver => array( injections => array( Zend\View\Resolver\TemplateMapResolver, Zend\View\Resolver\TemplatePathStack, ), ), Zend\View\Resolver\TemplateMapResolver => array( parameters => array( map => array( layout => __DIR__ . /view/layout.phtml, index/index => __DIR__ . /view/index/index.phtml, ), ), ), Zend\View\Resolver\TemplatePathStack => array( parameters => array( paths => array( application => __DIR__ . /view, elsewhere => $someOtherPath, ), ), ), Zend\View\Renderer\PhpRenderer => array( parameters => array( resolver => Zend\View\Resolver\AggregateResolver, ), ), ), ),
1278
34
);
Now that we have our PhpRenderer instance, and it can nd templates, lets inject some variables. This can be done in 4 different ways. Pass an associative array (or ArrayAccess instance, or Zend\View\Variables instance) of items as the second argument to render(): $renderer->render($templateName, array(foo => bar)) Assign a Zend\View\Variables instance, associative array, or ArrayAccess instance to the setVars() method. Assign variables as instance properties of the renderer: $renderer->foo = bar. This essentially proxies to an instance of Variables composed internally in the renderer by default. Create a ViewModel instance, assign variables to that, and pass the ViewModel to the render() method:
1 2 3 4 5 6 7 8 9 10 11 12
use Zend\View\Model\ViewModel; use Zend\View\Renderer\PhpRenderer; $renderer = new PhpRenderer(); $model = new ViewModel(); $model->setVariable(foo, bar); // or $model = new ViewModel(array(foo => bar)); $model->setTemplate($templateName); $renderer->render($model);
Now, lets render something. As a simple example, let us say you have a list of book data.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
// use a model to get the data for book authors and titles. $data = array( array( author => Hernando de Soto, title => The Mystery of Capitalism ), array( author => Henry Hazlitt, title => Economics in One Lesson ), array( author => Milton Friedman, title => Free to Choose ) ); // now assign the book data to a renderer instance $renderer->books = $data; // and render the template "booklist" echo $renderer->render(booklist);
More often than not, youll likely be using the MVC layer. As such, you should be thinking in terms of view models. Lets consider the following code from within an action method of a controller.
1 2 3 4
306.1. Usage
1279
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
class BookController extends AbstractActionController { public function listAction() { // do some work... // Assume $data is the list of books from the previous example $model = new ViewModel(array(books => $data)); // Optionally specify a template; if we dont, by default it will be // auto-determined based on the module name, controller name and this action. // In this example, the template would resolve to "bookstore/book/list", // and thus the file "bookstore/book/list.phtml"; the following overrides // that to set the template to "booklist", and thus the file "booklist.phtml" // (note the lack of directory preceding the filename). $model->setTemplate(booklist); return $model } }
$renderer->render($model);
Now we need the associated view script. At this point, well assume that the template booklist resolves to the le booklist.phtml. This is a PHP script like any other, with one exception: it executes inside the scope of the PhpRenderer instance, which means that references to $this point to the PhpRenderer instance properties and methods. Thus, a very basic view script could look like this:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
<?php if ($this->books): ?> <!-- A table of some books. --> <table> <tr> <th>Author</th> <th>Title</th> </tr> <?php foreach ($this->books as $key => $val): ?> <tr> <td><?php echo $this->escapeHtml($val[author]) ?></td> <td><?php echo $this->escapeHtml($val[title]) ?></td> </tr> <?php endforeach; ?> </table> <?php else: ?> <p>There are no books to display.</p> <?php endif;?>
Note: Escape Output The security mantra is Filter input, escape output. If you are unsure of the source of a given variable which is likely most of the time you should escape it based on which HTML context it is being injected into. The primary
1280
contexts to be aware of are HTML Body, HTML Attribute, Javascript, CSS and URI. Each context has a dedicated helper available to apply the escaping strategy most appropriate to each context. You should be aware that escaping does vary signicantly between contexts - there is no one single escaping strategy that can be globally applied. In the example above, there are calls to an escapeHtml() method. The method is actually a helper, a plugin available via method overloading. Additional escape helpers provide the escapeHtmlAttr(), escapeJs(), escapeCss(), and escapeUrl() methods for each of the HTML contexts you are most likely to encounter. By using the provided helpers and being aware of your variables contexts, you will prevent your templates from running afoul of Cross-Site Scripting (XSS) vulnerabilities. Weve now toured the basic usage of the PhpRenderer. By now you should know how to instantiate the renderer, provide it with a resolver, assign variables and/or create view models, create view scripts, and render view scripts.
1281
during rendering, and will replace whatever variable container previously was in the renderer; however, the previous variable container will be reset when done. If $values is empty, the current variables container (see setVars()) will be injected when rendering. If $nameOrModel is a Model instance, the template name will be retrieved from it and used. Additionally, if the model contains any variables, these will be used when rendering; otherwise, the variables container already present, if any, will be used. It will return the script output. Return type string resolver() Retrieves the Resolver instance. Return type string|Zend\View\Resolver\ResolverInterface vars(string $key = null) Retrieve a single variable from the container if a key is provided, otherwise it will return the variables container. Return type mixed plugin(string $name, array $options = null) Get a plugin/helper instance. Proxies to the plugin managers get() method; as such, any $options you pass will be passed to the plugins constructor if this is the rst time the plugin has been retrieved. See the section on helpers for more information. Return type Zend\View\Helper\HelperInterface addTemplate(string $template) Add a template to the stack. When used, the next call to render() will loop through all template added using this method, rendering them one by one; the output of the last will be returned. Return type Zend\View\Renderer\PhpRenderer
1282
CHAPTER 307
Once you call render(), Zend\View\Renderer\PhpRenderer then include()s the requested view script and executes it inside the scope of the PhpRenderer instance. Therefore, in your view scripts, references to $this actually point to the PhpRenderer instance itself. Variables assigned to the view either via a View Model, Variables container, or simply by passing an array of variables to render() may be retrieved in three ways: Explicitly, by retrieving them from the Variables container composed in the PhpRenderer: $this->vars()>varname. As instance properties of the PhpRenderer instance: $this->varname. (In this situation, instance property access is simply proxying to the composed Variables instance.) As local PHP variables: $varname. The PhpRenderer extracts the members of the Variables container locally. We generally recommend using the second notation, as its less verbose than the rst, but differentiates between variables in the view script scope and those assigned to the renderer from elsewhere. By way of reminder, here is the example view script from the PhpRenderer introduction.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
<?php if ($this->books): ?> <!-- A table of some books. --> <table> <tr> <th>Author</th> <th>Title</th> </tr> <?php foreach ($this->books as $key => $val): ?> <tr> <td><?php echo $this->escapeHtml($val[author]) ?></td> <td><?php echo $this->escapeHtml($val[title]) ?></td> </tr> <?php endforeach; ?> </table> <?php else: ?>
1283
21 22 23
// bad view-script practice: echo $this->variable; // good view-script practice: echo $this->escapeHtml($this->variable); // and remember context is always relevant! <script type="text/javascript"> var foo = "<?php echo $this->escapeJs($variable) ?>"; </script>
1284
CHAPTER 308
The ViewEvent
The view layer of Zend Framework 2 incorporates and utilizes a custom Zend\EventManager\Event implementation - Zend\View\ViewEvent. This event is created during Zend\View\View::getEvent() and is passed directly to all the events that method triggers. The ViewEvent adds accessors and mutators for the following: Model object, typically representing the layout view model. Renderer object. Request object. Response object. Result object. The methods it denes are: setModel(Model $model) getModel() setRequest($request) getRequest() setResponse($response) getResponse() setRenderer($renderer) getRenderer() setResult($result) getResult()
1285
Table 308.1: ViewEvent Events Name renderer renderer.post response Constant ViewEvent::EVENT_RENDERER ViewEvent::EVENT_RENDERER_POST ViewEvent::EVENT_RESPONSE Description Render the view, with the help of renderers. Triggers after the view is rendered. Populate the response from the view.
308.2 ViewEvent::EVENT_RENDERER
308.2.1 Listeners
The following classes are listening to this event (they are sorted from higher priority to lower priority): For PhpStrategy This listener is added when the strategy used for rendering is PhpStrategy: Table 308.2: ViewEvent::EVENT_RENDERER Listeners for PhpStrategy Class Zend\View\Strategy\PhpStrategy For JsonStrategy This listener is added when the strategy used for rendering is JsonStrategy: Table 308.3: ViewEvent::EVENT_RENDERER Listeners for JsonStrategy Class Zend\View\Strategy\JsonStrategy For FeedStrategy This listener is added when the strategy used for rendering is FeedStrategy: Table 308.4: ViewEvent::EVENT_RENDERER Listeners for FeedStrategy Class Zend\View\Strategy\FeedStrategy Priority 1 Method Called selectRenderer Description Return a FeedRenderer Priority 1 Method Called selectRenderer Description Return a JsonRenderer Priority 1 Method Called selectRenderer Description Return a PhpRenderer
308.2.2 Triggerers
This event is triggered by the following classes:
1286
Table 308.5: ViewEvent::EVENT_RENDERER Triggerers In Method Zend\View\View render Class Description It has a short circuit callback that stops propagation once one result return an instance of a Renderer.
308.3 ViewEvent::EVENT_RENDERER_POST
308.3.1 Listeners
There are currently no built-in listeners for this event.
308.3.2 Triggerers
This event is triggered by the following classes: Table 308.6: ViewEvent::EVENT_RENDERER_POST Triggerers In Method Zend\View\View render Class Description This event is triggered after ViewEvent::EVENT_RENDERER and before ViewEvent::EVENT_RESPONSE.
308.4 ViewEvent::EVENT_RESPONSE
308.4.1 Listeners
The following classes are listening to this event (they are sorted from higher priority to lower priority): For PhpStrategy This listener is added when the strategy used for rendering is PhpStrategy: Table 308.7: ViewEvent::EVENT_RESPONSE Listeners for PhpStrategy Priority Zend\View\Strategy\PhpStrategy 1 Class Method Called Description
For JsonStrategy This listener is added when the strategy used for rendering is JsonStrategy:
308.3. ViewEvent::EVENT_RENDERER_POST
1287
Table 308.8: ViewEvent::EVENT_RESPONSE Listeners for JsonStrategy Priority Zend\View\Strategy\JsonStrategy 1 Class Method Called Description
For FeedStrategy This listener is added when the strategy used for rendering is FeedStrategy: Table 308.9: ViewEvent::EVENT_RESPONSE Listeners for FeedStrategy Priority Zend\View\Strategy\FeedStrategy 1 Class Method Called Description
308.4.2 Triggerers
This event is triggered by the following classes: Table 308.10: ViewEvent::EVENT_RESPONSE Triggerers In Method Zend\View\View render Class Description This event is triggered after ViewEvent::EVENT_RENDERER and ViewEvent::EVENT_RENDERER_POST.
1288
CHAPTER 309
View Helpers
In your view scripts, often it is necessary to perform certain complex functions over and over: e.g., formatting a date, generating form elements, or displaying action links. You can use helper, or plugin, classes to perform these behaviors for you. A helper is simply a class that implements Zend\View\Helper\HelperInterface and it simply denes two methods, setView(), which accepts a Zend\View\Renderer\RendererInterface instance/implementation, and getView(), used to retrieve that instance. Zend\View\Renderer\PhpRenderer composes a plugin manager, allowing you to retrieve helpers, and also provides some method overloading capabilities that allow proxying method calls to helpers. As an example, lets say we have a helper class named MyModule\View\Helper\LowerCase, which we register in our plugin manager with the name lowercase. We can retrieve it in one of the following ways:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
// $view is a PhpRenderer instance // Via the plugin manager: $pluginManager = $view->getHelperPluginManager(); $helper = $pluginManager->get(lowercase); // Retrieve the helper instance, via the method "plugin", // which proxies to the plugin manager: $helper = $view->plugin(lowercase); // If the helper does not define __invoke(), the following also retrieves it: $helper = $view->lowercase(); // If the helper DOES define __invoke, you can call the helper // as if it is a method: $filtered = $view->lowercase(some value);
The last two examples demonstrate how the PhpRenderer uses method overloading to retrieve and/or invoke helpers directly, offering a convenience API for end users. A large number of helpers are provided in the standard distribution of Zend Framework. You can also register helpers by adding them to the plugin manager.
1289
1290
CHAPTER 310
Included Helpers
Zend Framework comes with an initial set of helper classes. In particular, there are helpers for creating route-based URLs and HTML lists, as well as declaring variables. Additionally, there are a rich set of helpers for providing values for, and rendering, the various HTML <head> tags, such as HeadTitle, HeadLink, and HeadScript. The currently shipped helpers include: BasePath Cycle Doctype HeadLink HeadMeta HeadScript HeadStyle HeadTitle HtmlList HTML Object Plugins Identity InlineScript JSON Partial Placeholder Url Note: View helpers related to Internationalization are documented in the I18n View Helpers chapter.
Note: View helpers related to form are documented in the Form View Helpers chapter.
Note: View helpers related to navigation are documented in the Navigation View Helpers chapter. 1291
Note: View helpers related to paginator are documented in the Paginator Usage chapter.
Note: For documentation on writing custom view helpers see the Advanced usage chapter.
1292
CHAPTER 311
<table> <?php foreach ($this->books as $book): ?> <tr style="background-color: <?php echo $this->cycle(array(#F0F0F0, #FFF)) ->next() ?>"> <td><?php echo $this->escapeHtml($book[author]) ?></td> </tr> <?php endforeach ?> </table>
The output:
1 2 3 4 5 6 7 8
<table> <tr style="background-color: #F0F0F0"> <td>First</td> </tr> <tr style="background-color: #FFF"> <td>Second</td> </tr> </table>
<?php $this->cycle()->assign(array(#F0F0F0, #FFF)) ?> <table> <?php foreach ($this->books as $book): ?> <tr style="background-color: <?php echo $this->cycle()->prev() ?>"> <td><?php echo $this->escapeHtml($book[author]) ?></td> </tr> <?php endforeach ?> </table>
The output:
1293
1 2 3 4 5 6 7 8
<table> <tr style="background-color: #FFF"> <td>First</td> </tr> <tr style="background-color: #F0F0F0"> <td>Second</td> </tr> </table>
To use two cycles you have to specify the names of cycles. Just set second parameter in cycle method: $this->cycle(array(#F0F0F0, #FFF), cycle2)
1 2 3 4 5 6 7 8 9
<table> <?php foreach ($this->books as $book): ?> <tr style="background-color: <?php echo $this->cycle(array(#F0F0F0, #FFF)) ->next() ?>"> <td><?php echo $this->cycle(array(1, 2, 3), number)->next() ?></td> <td><?php echo $this->escapeHtml($book[author]) ?></td> </tr> <?php endforeach ?> </table>
<?php $this->cycle()->assign(array(#F0F0F0, #FFF), colors); $this->cycle()->assign(array(1, 2, 3), numbers); ?> <table> <?php foreach ($this->books as $book): ?> <tr style="background-color: <?php echo $this->cycle()->setName(colors)->next() ?>"> <td><?php echo $this->cycle()->setName(numbers)->next() ?></td> <td><?php echo $this->escapeHtml($book[author]) ?></td> </tr> <?php endforeach ?> </table>
1294
CHAPTER 312
Valid HTML and XHTML documents should include a DOCTYPE declaration. Besides being difcult to remember, these can also affect how certain elements in your document should be rendered (for instance, CDATA escaping in <script> and <style> elements. The Doctype helper allows you to specify one of the following types: XHTML11 XHTML1_STRICT XHTML1_TRANSITIONAL XHTML1_FRAMESET XHTML1_RDFA XHTML1_RDFA11 XHTML_BASIC1 XHTML5 HTML4_STRICT HTML4_LOOSE HTML4_FRAMESET HTML5 CUSTOM_XHTML CUSTOM You can also specify a custom doctype as long as it is well-formed. The Doctype helper is a concrete implementation of the Placeholder helper.
Doctype Helper Basic Usage
You may specify the doctype at any time. However, helpers that depend on the doctype for their output will recognize it only after you have set it, so the easiest approach is to specify it in your bootstrap:
1295
1 2
If you need to know the doctype, you can do so by calling getDoctype() on the object, which is returned by invoking the helper.
1
$doctype = $view->doctype()->getDoctype();
Typically, youll simply want to know if the doctype is XHTML or not; for this, the isXhtml() method will sufce:
1 2 3
To implement the Open Graph Protocol, you may specify the XHTML1_RDFA doctype. This doctype allows a developer to use the Resource Description Framework within an XHTML document.
1 2
The RDFa doctype allows XHTML to validate when the property meta tag attribute is used per the Open Graph Protocol spec. Example within a view script:
1 2 3 4 5
<?php echo $this->doctype(XHTML1_RDFA); ?> <html xmlns="http://www.w3.org/1999/xhtml" xmlns:og="http://opengraphprotocol.org/schema/"> <head> <meta property="og:type" content="musician" />
In the previous example, we set the property to og:type. The og references the Open Graph namespace we specied in the html tag. The content identies the page as being about a musician. See the Open Graph Protocol documentation for supported properties. The HeadMeta helper may be used to programmatically set these Open Graph Protocol meta tags. Here is how you check if the doctype is set to XHTML1_RDFA:
1 2 3 4 5 6 7
<?php echo $this->doctype() ?> <html xmlns="http://www.w3.org/1999/xhtml" <?php if ($view->doctype()->isRdfa()): ?> xmlns:og="http://opengraphprotocol.org/schema/" xmlns:fb="http://www.facebook.com/2008/fbml" <?php endif; ?> >
1296
If youre running a ZendMvc application, you should specify doctype via the ViewManager service.
1297
1298
CHAPTER 313
The Identity helper allows for getting the identity from the AuthenticationService. For the Identity helper to work, a Zend\Authentication\AuthenticationService name or alias must be dened and recognized by the ServiceManager. Identity returns the identity in the AuthenticationService or null if no identity is available. As an example:
1 2 3 4 5 6 7
<?php if ($user = $this->identity()) { echo Logged in as . $this->escapeHtml($user->getUsername()); } else { echo Not logged in; } ?>
When invoked, the Identity plugin will look for a service by the name or alias Zend\Authentication\AuthenticationService in the ServiceManager. You can provide this service to the ServiceManager in a conguration le:
1 2 3 4 5 6 7 8 9 10 11 12
// In a configuration file... return array( service_manager => array( alias => array( Zend\Authentication\AuthenticationService => my_auth_service, ), invokables => array( my_auth_service => Zend\Authentication\AuthenticationService; }, ), ), );
1299
1300
CHAPTER 314
When creating views that return JSON, its important to also set the appropriate response header. The JSON view helper does exactly that. In addition, by default, it disables layouts (if currently enabled), as layouts generally arent used with JSON responses. The JSON helper sets the following header:
1
Content-Type: application/json
Most AJAX libraries look for this header when parsing responses to determine how to handle the content. Usage of the JSON helper is very straightforward:
1
Note: Keeping layouts and enabling encoding using Zend\Json\Expr Each method in the JSON helper accepts a second, optional argument. This second argument can be a boolean ag to enable or disable layouts, or an array of options that will be passed to Zend\Json\Json::encode() and used internally to encode data. To keep layouts, the second parameter needs to be boolean TRUE. When the second parameter is an array, keeping layouts can be achieved by including a keepLayouts key with a value of a boolean TRUE.
1 2 3 4 5
// Boolean true as second argument enables layouts: echo $this->json($this->data, true); // Or boolean true as "keepLayouts" key: echo $this->json($this->data, array(keepLayouts => true));
Zend\Json\Json::encode allows the encoding of native JSON expressions using Zend\Json\Expr objects. This option is disabled by default. To enable this option, pass a boolean TRUE to the enableJsonExprFinder key of the options array:
1 2 3 4
<?php echo $this->json($this->data, array( enableJsonExprFinder => true, keepLayouts => true, )) ?>
1301
1302
CHAPTER 315
The Partial view helper is used to render a specied template within its own variable scope. The primary use is for reusable template fragments with which you do not need to worry about variable name clashes. Additionally, they allow you to specify partial view scripts from specic modules. A sibling to the Partial, the PartialLoop view helper allows you to pass iterable data, and render a partial for each item. Note: PartialLoop Counter The PartialLoop view helper gives access to the current position of the array within the view script via $this->partialLoop()->getPartialCounter(). This provides an easy way to have alternating colors on table rows for example.
Basic usage of partials is to render a template fragment in its own view scope. Consider the following partial script:
1 2 3 4 5
<?php // partial.phtml ?> <ul> <li>From: <?php echo $this->escapeHtml($this->from) ?></li> <li>Subject: <?php echo $this->escapeHtml($this->subject) ?></li> </ul>
You would then call it from your view script using the following:
1 2 3
<?php echo $this->partial(partial.phtml, array( from => Team Framework, subject => view partials)); ?>
1303
A model used with the Partial view helper can be one of the following: Array. If an array is passed, it should be associative, as its key/value pairs are assigned to the view with keys as view variables. Object implementing toArray() method. If an object is passed an has a toArray() method, the results of toArray() will be assigned to the view object as view variables. Standard object. Any other object will assign the results of get_object_vars() (essentially all public properties of the object) to the view object. If your model is an object, you may want to have it passed as an object to the partial script, instead of serializing it to an array of variables. You can do this by setting the objectKey property of the appropriate helper:
1 2 3 4 5 6
// Tell partial to pass objects as model variable $view->partial()->setObjectKey(model); // Tell partial to pass objects from partialLoop as model variable // in final partial view script: $view->partialLoop()->setObjectKey(model);
This technique is particularly useful when passing Zend\Db\ResultSet\ResultSets to partialLoop(), as you then have full access to your row objects within the view scripts, allowing you to call methods on them (such as retrieving values from parent or dependent rows).
Typically, youll want to use partials in a loop, to render the same content fragment many times; this way you can put large blocks of repeated content or complex display logic into a single location. However this has a performance impact, as the partial helper needs to be invoked once for each iteration. The PartialLoop view helper helps solve this issue. It allows you to pass an iterable item (array or object implementing Iterator) as the model. It then iterates over this, passing, the items to the partial script as the model. Items in the iterator may be any model the Partial view helper allows. Lets assume the following partial view script:
1 2 3
<?php // partialLoop.phtml ?> <dt><?php echo $this->key ?></dt> <dd><?php echo $this->value ?></dd>
Mammal, value => Camel), Bird, value => Penguin), Reptile, value => Asp), Fish, value => Flounder),
In your view script, you could then invoke the PartialLoop helper:
1 2 3
<dl> <?php echo $this->partialLoop(partialLoop.phtml, $model) ?> </dl> <dl> <dt>Mammal</dt> <dd>Camel</dd>
1 2 3
1304
4 5 6 7 8 9 10 11 12 13
Sometime a partial will exist in a different module. If you know the name of the module, you can pass it as the second argument to either partial() or partialLoop(), moving the $model argument to third position. For instance, if theres a pager partial you wish to use thats in the list module, you could grab it as follows:
1
In this way, you can re-use partials created specically for other modules. That said, its likely a better practice to put re-usable partials in shared view script paths.
1305
1306
CHAPTER 316
The Placeholder view helper is used to persist content between view scripts and view instances. It also offers some useful features such as aggregating content, capturing view script content for later use, and adding pre- and post-text to content (and custom separators for aggregated content).
Basic Usage of Placeholders
Basic usage of placeholders is to persist view data. Each invocation of the Placeholder helper expects a placeholder name; the helper then returns a placeholder container object that you can either manipulate or simply echo out.
1 2 3 4 5 6
<?php $this->placeholder(foo)->set("Some text for later") ?> <?php echo $this->placeholder(foo); // outputs "Some text for later" ?>
Aggregating content via placeholders can be useful at times as well. For instance, your view script may have a variable array from which you wish to retrieve messages to display later; a later view script can then determine how those will be rendered. The Placeholder view helper uses containers that extend ArrayObject, providing a rich feature set for manipulating arrays. In addition, it offers a variety of methods for formatting the content stored in the container: setPrefix($prefix) sets text with which to prex the content. Use getPrefix() at any time to determine what the current setting is. setPostfix($prefix) sets text with which to append the content. Use getPostfix() at any time to determine what the current setting is. setSeparator($prefix) sets text with which to separate aggregated content. Use getSeparator() at any time to determine what the current setting is. setIndent($prefix) can be used to set an indentation value for content. If an integer is passed, that number of spaces will be used; if a string is passed, the string will be used. Use getIndent() at any time to determine what the current setting is. 1307
1 2
<!-- first view script --> <?php $this->placeholder(foo)->exchangeArray($this->data) ?> <!-- later view script --> <?php $this->placeholder(foo)->setPrefix("<ul>\n <li>") ->setSeparator("</li><li>\n") ->setIndent(4) ->setPostfix("</li></ul>\n"); ?> <?php echo $this->placeholder(foo); // outputs as unordered list with pretty indentation ?>
1 2 3 4 5 6 7 8 9 10 11 12
Because the Placeholder container objects extend ArrayObject, you can also assign content to a specic key in the container easily, instead of simply pushing it into the container. Keys may be accessed either as object properties or as array keys.
1 2 3 4 5 6 7
<?php $this->placeholder(foo)->bar = $this->data ?> <?php echo $this->placeholder(foo)->bar ?> <?php $foo = $this->placeholder(foo); echo $foo[bar]; ?>
Occasionally you may have content for a placeholder in a view script that is easiest to template; the Placeholder view helper allows you to capture arbitrary content for later rendering using the following API. captureStart($type, $key) begins capturing content. $type should be one of the Placeholder constants APPEND or SET. If APPEND, captured content is appended to the list of current content in the placeholder; if SET, captured content is used as the sole value of the placeholder (potentially replacing any previous content). By default, $type is APPEND. $key can be used to specify a specic key in the placeholder container to which you want content captured. captureStart() locks capturing until captureEnd() is called; you cannot nest capturing with the same placeholder container. Doing so will raise an exception. captureEnd() stops capturing content, and places it in the container object according to how captureStart() was called.
1 2 3 4 5 6 7 8 9 10 11
<!-- Default capture: append --> <?php $this->placeholder(foo)->captureStart(); foreach ($this->data as $datum): ?> <div class="foo"> <h2><?php echo $datum->title ?></h2> <p><?php echo $datum->content ?></p> </div> <?php endforeach; ?> <?php $this->placeholder(foo)->captureEnd() ?> <?php echo $this->placeholder(foo) ?>
1308
1 2 3 4 5 6 7 8 9 10 11
<!-- Capture to key --> <?php $this->placeholder(foo)->captureStart(SET, data); foreach ($this->data as $datum): ?> <div class="foo"> <h2><?php echo $datum->title ?></h2> <p><?php echo $datum->content ?></p> </div> <?php endforeach; ?> <?php $this->placeholder(foo)->captureEnd() ?> <?php echo $this->placeholder(foo)->data ?>
1309
1310
CHAPTER 317
url($name, $urlParams, $routeOptions, $reuseMatchedParams): Creates a URL string based on a named route. $urlParams should be an associative array of key/value pairs used by the particular route.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
// In a configuration array (e.g. returned by some modules module.config.php) router => array( routes => array( auth => array( type => segment, options => array( route => /auth[/:action][/:id], constraints => array( action => [a-zA-Z][a-zA-Z0-9_-]*, ), defaults => array( controller => auth, action => index, ), ) ) ) ), // In a view script: <a href="<?php echo $this->url(auth, array(action => logout, id => 100)); ?>">Logout</a>
Output:
1
<a href="/auth/logout/100">Logout</a>
1311
1312
CHAPTER 318
// $view is an instance of PhpRenderer $pluginManager = $view->getHelperPluginManager(); // Register as a invokable class: $pluginManager->setInvokableClass(lowercase, MyModule\View\Helper\LowerCase); // Register as a factory: $pluginManager->setFactory(lowercase, function ($pluginManager) { $lowercaseHelper = new MyModule\View\Helper\LowerCase; // ...do some configuration or dependency injection... return $lowercaseHelper; });
Within an MVC application, you will typically simply pass a map of plugins to the class via your conguration.
1 2 3 4 5 6 7 8 9
// From within a configuration file return array( view_helpers => array( invokables => array( lowercase => MyModule\View\Helper\LowerCase, uppercase => MyModule\View\Helper\UpperCase, ), ), );
1313
If your module class implements Zend\ModuleManager\Feature\ViewHelperProviderInterface, or just the method getViewHelperConfig(), you could do the following (its the same as the previous example).
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
namespace MyModule; class Module { public function getAutoloaderConfig(){ /*common code*/ } public function getConfig(){ /*common code*/ } public function getViewHelperConfig() { return array( invokables => array( lowercase => MyModule\View\Helper\LowerCase, uppercase => MyModule\View\Helper\UpperCase, ), ); } }
The two latter examples can be done in each module that needs to register helpers with the PhpRenderer; however, be aware that another module can register helpers with the same name, so order of modules can impact which helper class will actually be registered!
namespace Zend\View\Helper; use Zend\View\Renderer\RendererInterface as Renderer; interface HelperInterface { /** * Set the View object * * @param Renderer $view * @return HelperInterface */ public function setView(Renderer $view); /** * Get the View object * * @return Renderer */ public function getView(); }
If you want your helper to be capable of being invoked as if it were a method call of the PhpRenderer, you should also implement an __invoke() method within your helper. As previously noted, we recommend extending Zend\View\Helper\AbstractHelper, as it implements the methods dened in HelperInterface, giving you a headstart in your development.
1314
Once you have dened your helper class, make sure you can autoload it, and then register it with the plugin manager. Here is an example helper, which were titling SpecialPurpose
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
// /module/src/MyModule/View/Helper/SpecialPurpose.php namespace MyModule\View\Helper; use Zend\View\Helper\AbstractHelper; class SpecialPurpose extends AbstractHelper { protected $count = 0; public function __invoke() { $this->count++; $output = sprintf("I have seen The Jerk %d time(s).", $this->count); return htmlspecialchars($output, ENT_QUOTES, UTF-8); } }
Then assume that we register it with the plugin manager, by the name specialpurpose. Within a view script, you can call the SpecialPurpose helper as many times as you like; it will be instantiated once, and then it persists for the life of that PhpRenderer instance.
1 2 3 4
// remember, in a view script, $this refers to the Zend\View\Renderer\PhpRenderer instance. echo $this->specialPurpose(); echo $this->specialPurpose(); echo $this->specialPurpose();
I have seen The Jerk 1 time(s). I have seen The Jerk 2 time(s). I have seen The Jerk 3 time(s).
Sometimes you will need access to the calling PhpRenderer object for instance, if you need to use the registered encoding, or want to render another view script as part of your helper. This is why we dene the setView() and getView() methods. As an example, we could rewrite the SpecialPurpose helper as follows to take advantage of the EscapeHtml helper:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
namespace MyModule\View\Helper; use Zend\View\Helper\AbstractHelper; class SpecialPurpose extends AbstractHelper { protected $count = 0; public function __invoke() { $this->count++; $output = sprintf("I have seen The Jerk %d time(s).", $this->count); $escaper = $this->getView()->plugin(escapehtml); return $escaper($output); } }
1315
// $view is a PhpRenderer instance $helper = new MyModule\View\Helper\LowerCase; // ...do some configuration or dependency injection... $view->getHelperPluginManager()->setService(lowercase, $helper);
The plugin manager will validate the helper/plugin, and if the validation passes, the helper/plugin will be registered.
1316
CHAPTER 319
Introduction to Zend\XmlRpc
From its home page, XML-RPC is described as a ...remote procedure calling using HTTP as the transport and XML as the encoding. XML-RPC is designed to be as simple as possible, while allowing complex data structures to be transmitted, processed and returned. Zend Framework provides support for both consuming remote XML-RPC services and building new XML-RPC servers.
class Greeter { /** * Say hello to someone. * * @param string $name Who to greet * @return string */ public function sayHello($name=Stranger) { return sprintf("Hello %s!", $name); } } $server = new Zend\XmlRpc\Server; // Our Greeter class will be called // greeter from the client $server->setClass(Greeter, greeter); $server->handle();
Note: It is necessary to write function and method docblocks for the services which are to be exposed via Zend\XmlRpc\Server, as it will be used to validate parameters provided to the methods, and also to determine the method help text and method signatures.
1317
An example of a client consuming this XML-RPC service would be something like this:
1 2 3 4 5 6 7
$client = new Zend\XmlRpc\Client(http://example.com/xmlrpcserver.php); echo $client->call(greeter.sayHello); // will output "Hello Stranger!" echo $client->call(greeter.sayHello, array(Dude)); // will output "Hello Dude!"
1318
CHAPTER 320
Zend\XmlRpc\Client
320.1 Introduction
Zend Framework provides support for consuming remote XML-RPC services as a client in the Zend\XmlRpc\Client package. Its major features include automatic type conversion between PHP and XML-RPC, a server proxy object, and access to server introspection capabilities.
1 2 3 4 5
The XML-RPC value returned from the remote method call will be automatically unmarshaled and cast to the equivalent PHP native type. In the example above, a PHP String is returned and is immediately ready to be used. The rst parameter of the call() method receives the name of the remote method to call. If the remote method requires any parameters, these can be sent by supplying a second, optional parameter to call() with an Array of values to pass to the remote method:
1319
XML-RPC Method Call with Parameters $client = new Zend\XmlRpc\Client(http://framework.zend.com/xmlrpc); $arg1 = 1.1; $arg2 = foo; $result = $client->call(test.sayHello, array($arg1, $arg2)); // $result is a native PHP type
1 2 3 4 5 6 7 8
If the remote method doesnt require parameters, this optional parameter may either be left out or an empty array() passed to it. The array of parameters for the remote method can contain native PHP types, Zend\XmlRpc\Value objects, or a mix of each. The call() method will automatically convert the XML-RPC response and return its equivalent PHP native type. A Zend\XmlRpc\Response object for the return value will also be available by calling the getLastResponse() method after the call.
Note: What type do empty arrays get cast to? Passing an empty array to an XML-RPC method is problematic, as it could represent either an array or a struct. Zend\XmlRpc\Client detects such conditions and makes a request to the servers system.methodSignature method to determine the appropriate XML-RPC type to cast to.
1320
However, this in itself can lead to issues. First off, servers that do not support system.methodSignature will log failed requests, and Zend\XmlRpc\Client will resort to casting the value to an XML-RPC array type. Additionally, this means that any call with array arguments will result in an additional call to the remote server. To disable the lookup entirely, you can call the setSkipSystemLookup() method prior to making your XML-RPC call:
1 2
Note: Automatic Conversion When building a new Zend\XmlRpc\Value object, its value is set by a PHP type. The PHP type will be converted to the specied type using PHP casting. For example, if a string is given as a value to the Zend\XmlRpc\Value\Integer object, it will be converted using (int)$value.
1321
1 2 3 4 5
The getProxy() method receives an optional argument specifying which namespace of the remote server to proxy. If it does not receive a namespace, the default namespace will be proxied. In the next example, the test namespace will be proxied:
Proxy Any Namespace $client = new Zend\XmlRpc\Client(http://framework.zend.com/xmlrpc); $test = $client->getProxy(test); // Proxy the "test" namespace // test.Hello(1,2) returns "hello"
1 2 3 4 5
If the remote server supports nested namespaces of any depth, these can also be used through the server proxy. For example, if the server in the example above had a method test.foo.bar(), it could be called as $test->foo->bar().
a 404
Not
Found,
1 2 3 4
1322
5 6 7 8 9 10 11 12
$client->call(bar, array($arg1, $arg2)); } catch (Zend\XmlRpc\Client\Exception\HttpException $e) { // $e->getCode() returns 404 // $e->getMessage() returns "Not Found" }
Regardless of how the XML-RPC client is used, the Zend\XmlRpc\Client\Exception\HttpException will be thrown whenever an HTTP error occurs.
1 2 3 4 5 6 7 8 9 10 11 12
When the call() method is used to make the request, the Zend\XmlRpc\Client\Exception\FaultException will be thrown on fault. A Zend\XmlRpc\Response object containing the fault will also be available by calling getLastResponse(). When the doRequest() method is used to make the request, it will not throw the exception. Instead, it will return a Zend\XmlRpc\Response object returned will containing the fault. This can be checked with isFault() instance method of Zend\XmlRpc\Response.
1323
1 2 3 4 5
$client = new Zend\XmlRpc\Client(http://example.com/xmlrpcserver.php); $introspector = $client->getIntrospector(); foreach ($introspector->listMethods() as $method) { echo "Method: " . $method . "\n"; }
The following methods are available for introspection: getSignatureForEachMethod: Returns the signature for each method on the server getSignatureForEachMethodByMulticall($methods=null): Attempt to get the method signatures in one request via system.multicall(). Optionally pass an array of method names. getSignatureForEachMethodByLooping($methods=null): Get the method signatures for every method by successively calling system.methodSignature. Optionally pass an array of method names getMethodSignature($method): Get the methods signature for $method listMethods: List all methods on the server
1 2 3 4 5 6 7 8 9 10
Whenever an XML-RPC method call is made by the client through any means, either the call() method, doRequest() method, or server proxy, the last request object and its resultant response object will always be available through the methods getLastRequest() and getLastResponse() respectively.
1324
The setHttpClient() is particularly useful for unit testing. When combined with the Zend\Http\Client\Adapter\Test, remote services can be mocked out for testing. See the unit tests for Zend\XmlRpc\Client for examples of how to do this.
1325
1326
CHAPTER 321
Zend\XmlRpc\Server
321.1 Introduction
Zend\XmlRpc\Server is intended as a fully-featured XML-RPC server, following the specications outlined at www.xmlrpc.com. Additionally, it implements the system.multicall() method, allowing boxcarring of requests.
1327
321.5 Conventions
Zend\XmlRpc\Server allows the developer to attach functions and class method calls as dispatchable XML-RPC methods. Via Zend\Server\Reflection, it does introspection on all attached methods, using the function and method docblocks to determine the method help text and method signatures. XML-RPC types do not necessarily map one-to-one to PHP types. However, the code will do its best to guess the appropriate type based on the values listed in @param and @return lines. Some XML-RPC types have no immediate PHP equivalent, however, and should be hinted using the XML-RPC type in the PHPDoc. These include: dateTime.iso8601, a string formatted as YYYYMMDDTHH:mm:ss base64, base64 encoded data struct, any associative array An example of how to hint follows:
1 2 3 4 5 6 7 8 9 10 11
/** * This is a sample function * * @param base64 $val1 Base64-encoded data * @param dateTime.iso8601 $val2 An ISO date * @param struct $val3 An associative array * @return struct */ function myFunc($val1, $val2, $val3) { }
PhpDocumentor does no validation of the types specied for params or return values, so this will have no impact on your API documentation. Providing the hinting is necessary, however, when the server is validating the parameters provided to the method call. 1328 Chapter 321. Zend\XmlRpc\Server
It is perfectly valid to specify multiple types for both params and return values; the XML-RPC specication even suggests that system.methodSignature should return an array of all possible method signatures (i.e., all possible combinations of param and return values). You may do so just as you normally would with PhpDocumentor, using the | operator:
1 2 3 4 5 6 7 8 9 10 11
/** * This is a sample function * * @param string|base64 $val1 String or base64-encoded data * @param string|dateTime.iso8601 $val2 String or an ISO date * @param array|struct $val3 Normal indexed array or an associative array * @return boolean|struct */ function myFunc($val1, $val2, $val3) { }
Note: Allowing multiple signatures can lead to confusion for developers using the services; to keep things simple, a XML-RPC service method should only have a single signature.
// All public methods in My_Service_Class will be accessible as // myservice.METHODNAME $server->setClass(My\Service\Class, myservice); // Function somefunc will be accessible as funcs.somefunc $server->addFunction(somefunc, funcs);
1329
Zend\XmlRpc\Server\Fault::attachFaultException(My\Project\Exception);
If you utilize an exception class that your other project exceptions inherit, you can then whitelist a whole family of exceptions at a time. Zend\XmlRpc\Server\Exceptions are always whitelisted, to allow reporting specic internal errors (undened methods, etc.). Any exception not specically whitelisted will generate a fault response with a code of 404 and a message of Unknown error.
use Zend\XmlRpc\Server as XmlRpcServer; // Register the "My\Services" namespace $loader = new Zend\Loader\StandardAutoloader(); $loader->registerNamespace(My\Services, path to My/Services); $loader->register(); $cacheFile = dirname(__FILE__) . /xmlrpc.cache; $server = new XmlRpcServer(); if (!XmlRpcServer\Cache::get($cacheFile, $server)) { $server->setClass(My\Services\Glue, glue); // glue. namespace $server->setClass(My\Services\Paste, paste); // paste. namespace
1330
15 16 17 18 19 20
// tape. namespace
The above example attempts to retrieve a server denition from xmlrpc.cache in the same directory as the script. If unsuccessful, it loads the service classes it needs, attaches them to the server instance, and then attempts to create a new cache le with the server denition.
The example below attaches a function as a dispatchable XML-RPC method and handles incoming calls.
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/** * Return the MD5 sum of a value * * @param string $value Value to md5sum * @return string MD5 sum of value */ function md5Value($value) { return md5($value); } $server = new Zend\XmlRpc\Server(); $server->addFunction(md5Value); echo $server->handle();
Attaching a class
The example below illustrates attaching a class public methods as dispatchable XML-RPC methods.
1 2 3 4 5
The following example illustrates how to attach a class public methods and passing arguments to its methods. This can be used to specify certain defaults when registering service classes.
1331
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
namespace Services; class PricingService { /** * Calculate current price of product with $productId * * @param ProductRepository $productRepository * @param PurchaseRepository $purchaseRepository * @param integer $productId */ public function calculate(ProductRepository $productRepository, PurchaseRepository $purchaseRepository, $productId) { ... } } $server = new Zend\XmlRpc\Server(); $server->setClass(Services\PricingService, pricing, new ProductRepository(), new PurchaseRepository());
The arguments passed at setClass() at server construction time are injected into the method call pricing.calculate() on remote invokation. In the example above, only the argument $purchaseId is expected from the client.
Passing arguments only to constructor
Zend\XmlRpc\Server allows to restrict argument passing to constructors only. This can be used for constructor dependency injection. To limit injection to constructors, call sendArgumentsToAllMethods and pass FALSE as an argument. This disables the default behavior of all arguments being injected into the remote method. In the example below the instance of ProductRepository and PurchaseRepository is only injected into the constructor of Services_PricingService2.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
class Services\PricingService2 { /** * @param ProductRepository $productRepository * @param PurchaseRepository $purchaseRepository */ public function __construct(ProductRepository $productRepository, PurchaseRepository $purchaseRepository) { ... } /** * Calculate current price of product with $productId * * @param integer $productId * @return double */ public function calculate($productId) {
1332
21 22 23 24 25 26 27 28 29 30
... } } $server = new Zend\XmlRpc\Server(); $server->sendArgumentsToAllMethods(false); $server->setClass(Services\PricingService2, pricing, new ProductRepository(), new PurchaseRepository());
setClass() allows to register a previously instantiated class at the server. Just pass an instance instead of the class name. Obviously passing arguments to the constructor is not possible with pre-instantiated classes.
Attaching several classes using namespaces
The example below illustrates attaching several classes, each with their own namespace.
1 2 3 4 5 6 7 8 9
require_once Services/Comb.php; require_once Services/Brush.php; require_once Services/Pick.php; $server = new Zend\XmlRpc\Server(); $server->setClass(Services\Comb, comb); // methods called as comb.* $server->setClass(Services\Brush, brush); // methods called as brush.* $server->setClass(Services\Pick, pick); // methods called as pick.* echo $server->handle();
The example below allows any Services\Exception-derived class to report its code and message in the fault response.
1 2 3 4 5 6 7 8 9 10 11 12 13
// Allow Services_Exceptions to report as fault responses Zend\XmlRpc\Server\Fault::attachFaultException(Services\Exception); $server = new Zend\XmlRpc\Server(); $server->setClass(Services\Comb, comb); // methods called as comb.* $server->setClass(Services\Brush, brush); // methods called as brush.* $server->setClass(Services\Pick, pick); // methods called as pick.* echo $server->handle();
Some use cases require to utilize a custom request object. For example, XML/RPC is not bound to HTTP as a transfer protocol. It is possible to use other transfer protocols like SSH or telnet to send the request and response data over the 321.11. Usage Examples 1333
wire. Another use case is authentication and authorization. In case of a different transfer protocol, one need to change the implementation to read request data. The example below instantiates a custom request class and passes it to the server to handle.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
// Allow Services_Exceptions to report as fault responses Zend\XmlRpc\Server\Fault::attachFaultException(Services\Exception); $server = new Zend\XmlRpc\Server(); $server->setClass(Services\Comb, comb); // methods called as comb.* $server->setClass(Services\Brush, brush); // methods called as brush.* $server->setClass(Services\Pick, pick); // methods called as pick.* // Create a request object $request = new Services\Request(); echo $server->handle($request);
The example below illustrates specifying a custom response class for the returned response.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
// Allow Services_Exceptions to report as fault responses Zend\XmlRpc\Server\Fault::attachFaultException(Services\Exception); $server = new Zend\XmlRpc\Server(); $server->setClass(Services\Comb, comb); // methods called as comb.* $server->setClass(Services\Brush, brush); // methods called as brush.* $server->setClass(Services\Pick, pick); // methods called as pick.* // Create a request object $request = new Services\Request(); // Utilize a custom response $server->setResponseClass(Services\Response); echo $server->handle($request);
1334
use Zend\XmlRpc\Server as XmlRpcServer; // Register the "Services" namespace $loader = new Zend\Loader\StandardAutoloader(); $loader->registerNamespace(Services, path to Services); $loader->register(); // Specify a cache file $cacheFile = dirname(__FILE__) . /xmlrpc.cache; // Allow Services\Exceptions to report as fault responses XmlRpcServer\Fault::attachFaultException(Services\Exception); $server = new XmlRpcServer(); // Attempt to retrieve server definition from cache if (!XmlRpcServer\Cache::get($cacheFile, $server)) { $server->setClass(Services\Comb, comb); // methods called as comb.* $server->setClass(Services\Brush, brush); // methods called as brush.* $server->setClass(Services\Pick, pick); // methods called as pick.* // Save cache XmlRpcServer\Cache::save($cacheFile, $server); } // Create a request object $request = new Services\Request(); // Utilize a custom response $server->setResponseClass(Services\Response); echo $server->handle($request);
Note: The server cache le should be located outside the document root.
Zend\XmlRpc\Server uses DOMDocument of PHP extension ext/dom to generate its XML output. While ext/dom is available on a lot of hosts it is not exactly the fastest. Benchmarks have shown, that XmlWriter from ext/xmlwriter performs better. If ext/xmlwriter is available on your host, you can select a the XmlWriter-based generator to leverage the performance differences.
1 2 3 4
1335
5 6
Note: Benchmark your application Performance is determined by a lot of parameters and benchmarks only apply for the specic test case. Differences come from PHP version, installed extensions, webserver and operating system just to name a few. Please make sure to benchmark your application on your own and decide which generator to use based on your numbers.
Note: Benchmark your client This optimization makes sense for the client side too. Just select the alternate XML generator before doing any work with Zend\XmlRpc\Client.
1336
CHAPTER 322
ZendServiceAkismet
322.1 Introduction
ZendService\Akismet provides a client for the Akismet API. The Akismet service is used to determine if incoming data is potentially spam. It also exposes methods for submitting data as known spam or as false positives (ham). It was originally intended to help categorize and identify spam for Wordpress, but it can be used for any type of data. Akismet requires an API key for usage. You can get one by signing up for a WordPress.com account. You do not need to activate a blog. Simply acquiring the account will provide you with the API key. Akismet requires that all requests contain a URL to the resource for which data is being ltered. Because of Akismets origins in WordPress, this resource is called the blog URL. This value should be passed as the second argument to the constructor, but may be reset at any time using the setBlogUrl() method, or overridden by specifying a blog key in the various method calls.
// Instantiate with the API key and a URL to the application or // resource being used $akismet = new ZendService\Akismet\Akismet($apiKey, http://framework.zend.com/wiki/); if ($akismet->verifyKey($apiKey)) { echo "Key is valid.\n"; } else { echo "Key is not valid\n"; }
If called with no arguments, verifyKey() uses the API key provided to the constructor. verifyKey() implements Akismets verify-key REST method.
1337
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
=> 111.222.111.222, => Mozilla/5.0 . (Windows; U; Windows NT . 5.2; en-GB; rv:1.8.1) Gecko/20061010 . Firefox/2.0, comment_type => contact, comment_author => John Doe, comment_author_email => nospam@myhaus.net, comment_content => "Im not a spammer, honest!"
); if ($akismet->isSpam($data)) { echo "Sorry, but we think youre a spammer."; } else { echo "Welcome to our site!"; }
ZendService\Akismet\Akismet::submitSpam() takes the same data array as passed to isSpam(), but does not return a value. An exception will be raised if the API key used is invalid.
submitSpam() Usage $data = array( user_ip user_agent
1 2 3 4 5 6 7 8 9 10
=> 111.222.111.222, => Mozilla/5.0 (Windows; U; Windows NT 5.2; . en-GB; rv:1.8.1) Gecko/20061010 Firefox/2.0, comment_type => contact, comment_author => John Doe, comment_author_email => nospam@myhaus.net, comment_content => "Im not a spammer, honest!"
); $akismet->submitSpam($data));
1 2 3 4 5 6 7 8 9 10
=> 111.222.111.222, => Mozilla/5.0 (Windows; U; Windows NT 5.2; . en-GB; rv:1.8.1) Gecko/20061010 Firefox/2.0, comment_type => contact, comment_author => John Doe, comment_author_email => nospam@myhaus.net, comment_content => "Im not a spammer, honest!"
); $akismet->submitHam($data));
1339
getCharset() and setCharset() allow you to retrieve and modify the character set used to make the request. getPort() and setPort() allow you to retrieve and modify the TCP port used to make the request. getUserAgent() and setUserAgent() allow you to retrieve and modify the HTTP user agent used to make the request. Note: this is not the user_agent used in data submitted to the service, but rather the value provided in the HTTP User-Agent header when making a request to the service. The value used to set the user agent should be of the form some user agent/version | Akismet/version. The default is Zend Framework/ZF-VERSION | Akismet/1.11, where ZF-VERSION is the current Zend Framework version as stored in the Zend\Version\Version::VERSION constant.
1340
CHAPTER 323
ZendServiceAmazon
323.1 Introduction
ZendService\Amazon is a simple API for using Amazon web services. ZendService\Amazon has two API s: a more traditional one that follows Amazons own API, and a simpler Query API for constructing even complex search queries easily. ZendService\Amazon enables developers to retrieve information appearing throughout Amazon.com web sites directly through the Amazon Web Services API. Examples include: Store item information, such as images, descriptions, pricing, and more Customer and editorial reviews Similar products and accessories Amazon.com offers ListMania lists In order to use ZendService\Amazon, you should already have an Amazon developer API key as well as a secret key. To get a key and for more information, please visit the Amazon Web Services web site. As of August 15th, 2009 you can only use the Amazon Product Advertising API through ZendService\Amazon, when specifying the additional secret key. Note: Attention Your Amazon developer API and secret keys are linked to your Amazon identity, so take appropriate measures to keep them private.
In this example, we search for PHP books at Amazon and loop through the results, printing them.
1 2 3 4
$amazon = new ZendService\Amazon\Amazon(AMAZON_API_KEY, US, AMAZON_SECRET_KEY); $results = $amazon->itemSearch(array(SearchIndex => Books, Keywords => php)); foreach ($results as $result) {
1341
5 6
Here, we also search for PHP books at Amazon, but we instead use the Query API, which resembles the Fluent Interface design pattern.
1 2 3 4 5 6 7 8
$query = new ZendService\Amazon\Query(AMAZON_API_KEY, US, AMAZON_SECRET_KEY); $query->category(Books)->Keywords(PHP); $results = $query->search(); foreach ($results as $result) { echo $result->Title . <br />; }
1 2
Note: Country codes Valid country codes are: CA, DE, FR, JP, UK, and US.
1 2
The itemLookup() method also accepts an optional second parameter for handling search options. For full details, including a list of available options, please see the relevant Amazon documentation. Note: Image information To retrieve images information for your search results, you must set ResponseGroup option to Medium or Large.
1342
1 2 3 4 5 6
The ResponseGroup option is used to control the specic information that will be returned in the response.
1 2 3 4 5 6 7 8 9 10
$amazon = new ZendService\Amazon\Amazon(AMAZON_API_KEY, US, AMAZON_SECRET_KEY); $results = $amazon->itemSearch(array( SearchIndex => Books, Keywords => php, ResponseGroup => Small,ItemAttributes,Images,SalesRank,Reviews, . EditorialReview,Similarities,ListmaniaLists )); foreach ($results as $result) { echo $result->Title . <br />; }
The itemSearch() method accepts a single array parameter for handling search options. For full details, including a list of available options, please see the relevant Amazon documentation Tip: The ZendServiceAmazonQuery class is an easy to use wrapper around this method.
In this example, the alternative query API is used as a uent interface to specify options and their respective values:
1343
1 2 3 4 5 6
$query = new ZendService\Amazon\Query(MY_API_KEY, US, AMAZON_SECRET_KEY); $query->Category(Books)->Keywords(PHP); $results = $query->search(); foreach ($results as $result) { echo $result->Title . <br />; }
This sets the option Category to Books and Keywords to PHP. For more information on the available options, please refer to the relevant Amazon documentation.
323.6.1 ZendServiceAmazonItem
ZendService\Amazon\Item is the class type used to represent an Amazon item returned by the web service. It encompasses all of the items attributes, including title, description, reviews, etc.
323.6.2 ZendServiceAmazonItem::asXML()
string:asXML() Return the original XML for the item
323.6.3 Properties
ZendService\Amazon\Item has a number of properties directly related to their standard Amazon API counterparts. Back to Class List
323.6.4 ZendServiceAmazonImage
ZendService\Amazon\Image represents a remote Image for a product.
1344
323.6.5 Properties
Table 323.1: ZendServiceAmazonImage Properties Name Url Height Width Type ZendUriUri int int Description Remote URL for the Image The Height of the image in pixels The Width of the image in pixels
323.6.6 ZendServiceAmazonResultSet
ZendService\Amazon\ResultSet objects are returned by ZendServiceAmazon::itemSearch() and allow you to easily handle the multiple results returned. Note: SeekableIterator Implements the SeekableIterator for easy iteration (e.g. using foreach), as well as direct access to a specic result using seek().
323.6.7 ZendServiceAmazonResultSet::totalResults()
int:totalResults() Returns the total number of results returned by the search Back to Class List
323.6.8 ZendServiceAmazonOfferSet
Each result returned by ZendServiceAmazon::itemSearch() and ZendServiceAmazon::itemLookup() contains a ZendService\Amazon\OfferSet object through which pricing information for the item can be retrieved.
323.6.9 Properties
Back to Class List
323.6.10 ZendServiceAmazonOffer
Each offer for an item is returned as an ZendService\Amazon\Offer object.
1345
323.6.12 ZendServiceAmazonSimilarProduct
When searching for items, Amazon also returns a list of similar products that the searcher may nd to their liking. Each of these is returned as a ZendService\Amazon\SimilarProduct object. Each object contains the information to allow you to make sub-sequent requests to get the full information on the item.
323.6.13 Properties
Table 323.3: ZendServiceAmazonSimilarProduct Properties Name ASIN Title Type string string Description Products Amazon Unique ID (ASIN) Products Title
323.6.14 ZendServiceAmazonAccessories
Accessories for the returned item are represented as ZendService\Amazon\Accessories objects
323.6.15 Properties
Table 323.4: ZendServiceAmazonAccessories Properties Name ASIN Title Type string string Description Products Amazon Unique ID (ASIN) Products Title
1346
323.6.16 ZendServiceAmazonCustomerReview
Each Customer Review is returned as a ZendService\Amazon\CustomerReview object.
323.6.17 Properties
Table 323.5: ZendServiceAmazonCustomerReview Properties Name Rating HelpfulVotes CustomerId TotalVotes Date Summary Content Type string string string string string string string Description Item Rating Votes on how helpful the review is Customer ID Total Votes Date of the Review Review Summary Review Content
323.6.18 ZendServiceAmazonEditorialReview
Each items Editorial Reviews are returned as a ZendService\Amazon\EditorialReview object
323.6.19 Properties
Table 323.6: Properties Name Source Content ZendServiceAmazonEditorialReview Description Source of the Editorial Review Review Content
323.6.20 ZendServiceAmazonListmania
Each results List Mania List items are returned as ZendService\Amazon\Listmania objects.
323.6.21 Properties
Table 323.7: ZendServiceAmazonListmania Properties Name ListId ListName Type string string Description List ID List Name
1347
1348
CHAPTER 324
ZendService\Apple\Apns
324.1 Introduction
ZendService\Apple\Apns provides a client for the Apple Push Notication Service. ZendService\Apple\Apns\Client allows you to send data from servers to your iOS Applications. In order to leverage APNS you must follow the Provisioning and deployments steps outlined by Apple. The service is composed of 3 distinct parts: The Clients: * Feedback: ZendService\Apple\Apns\Client\Feedback ZendService\Apple\Apns\Client\Message The Message: ZendService\Apple\Apns\Message\Alert The Responses: * Feedback: ZendService\Apple\Apns\Response\Feedback * Message: ZendService\Apple\Apns\Response\Message The Clients is the broker that sends the message to the APNS server and returns the response. The Message is where you dene all of the message specic data that you would like to send for the alert. The Response is the feedback given back from the APNS server. * Message:
1349
So now that we have the client setup and available, it is time to dene out the message that we intend to send to our iOS tokens that have registered for push notications on our server. Note that many of the methods specied are not required but are here to give an inclusive look into the message.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
$message = new Message(); $message->setId(my_unique_id); $message->setToken(DEVICE_TOKEN); $message->setBadge(5); $message->setSound(bingbong.aiff); // simple alert: $message->setAlert(Bob wants to play poker); // complex alert: $alert = new Alert(); $alert->setBody(Bob wants to play poker); $alert->setActionLocKey(PLAY); $alert->setLocKey(GAME_PLAY_REQUEST_FORMAT); $alert->setLocArgs(array(Jenna, Frank)); $alert->setLaunchImage(Play.png); $message->setAlert($alert);
Now that we have the message taken care of, all we need to do next is send out the message. Each message comes back with a set of data that allows us to understand what happened with our push notication as well as throwing exceptions in the cases of server failures.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
try { $response = $client->send($message); } catch (RuntimeException $e) { echo $e->getMessage() . PHP_EOL; exit(1); } $client->close(); if ($response->getCode() != Response::RESULT_OK) { switch ($response->getCode()) { case Response::RESULT_PROCESSING_ERROR: // you may want to retry break; case Response::RESULT_MISSING_TOKEN: // you were missing a token break; case Response::RESULT_MISSING_TOPIC: // you are missing a message id break; case Response::RESULT_MISSING_PAYLOAD: // you need to send a payload break; case Response::RESULT_INVALID_TOKEN_SIZE: // the token provided was not of the proper size break; case Response::RESULT_INVALID_TOPIC_SIZE: // the topic was too long break; case Response::RESULT_INVALID_PAYLOAD_SIZE: // the payload was too large break; case Response::RESULT_INVALID_TOKEN: // the token was invalid; remove it from your system break;
1350
35 36 37 38 39
use ZendService\Apple\Apns\Client\Feedback as Client; use ZendService\Apple\Apns\Response\Feedback as Response; use ZendService\Apple\Apns\Exception\RuntimeException; $client = new Client(); $client->open(Client::SANDBOX_URI, /path/to/push-certificate.pem, optionalPassPhrase); $reponses = $client->feedback(); $client->close(); foreach ($responses as $response) { echo $response->getTime() . : . $response->getToken(); }
1351
1352
CHAPTER 325
ZendServiceAudioscrobbler
325.1 Introduction
ZendService\Audioscrobbler is a simple API for using the Audioscrobbler REST Web Service. The Audioscrobbler Web Service provides access to its database of Users, Artists, Albums, Tracks, Tags, Groups, and Forums. The methods of the ZendService\Audioscrobbler class begin with one of these terms. The syntax and namespaces of the Audioscrobbler Web Service are mirrored in ZendService\Audioscrobbler. For more information about the Audioscrobbler REST Web Service, please visit the Audioscrobbler Web Service site.
325.2 Users
In order to retrieve information for a specic user, the setUser() method is rst used to select the user for which data are to be retrieved. ZendService\Audioscrobbler provides several methods for retrieving data specic to a single user: userGetProfileInformation(): Returns a SimpleXML object containing the current users prole information. userGetTopArtists(): Returns a SimpleXML object containing a list of the current users most listened to artists. userGetTopAlbums(): Returns a SimpleXML object containing a list of the current users most listened to albums. userGetTopTracks(): Returns a SimpleXML object containing a list of the current users most listened to tracks. userGetTopTags(): Returns a SimpleXML object containing a list of tags most applied by the current user. userGetTopTagsForArtist(): Requires that an artist be set via setArtist(). Returns a SimpleXML object containing the tags most applied to the current artist by the current user. userGetTopTagsForAlbum(): Requires that an album be set via setAlbum(). Returns a SimpleXML object containing the tags most applied to the current album by the current user. userGetTopTagsForTrack(): Requires that a track be set via setTrack(). Returns a SimpleXML object containing the tags most applied to the current track by the current user. userGetFriends(): Returns a SimpleXML object containing the user names of the current users friends.
1353
userGetNeighbours(): Returns a SimpleXML object containing the user names of people with similar listening habits to the current user. userGetRecentTracks(): Returns a SimpleXML object containing the 10 tracks most recently played by the current user. userGetRecentBannedTracks(): Returns a SimpleXML object containing a list of the 10 tracks most recently banned by the current user. userGetRecentLovedTracks(): Returns a SimpleXML object containing a list of the 10 tracks most recently loved by the current user. userGetRecentJournals(): Returns a SimpleXML object containing a list of the current users most recent journal entries. userGetWeeklyChartList(): Returns a SimpleXML object containing a list of weeks for which there exist Weekly Charts for the current user. userGetRecentWeeklyArtistChart(): Returns a SimpleXML object containing the most recent Weekly Artist Chart for the current user. userGetRecentWeeklyAlbumChart(): Returns a SimpleXML object containing the most recent Weekly Album Chart for the current user. userGetRecentWeeklyTrackChart(): Returns a SimpleXML object containing the most recent Weekly Track Chart for the current user. userGetPreviousWeeklyArtistChart($fromDate, $toDate): Returns a SimpleXML object containing the Weekly Artist Chart from $fromDate to $toDate for the current user. userGetPreviousWeeklyAlbumChart($fromDate, $toDate): Returns a SimpleXML object containing the Weekly Album Chart from $fromDate to $toDate for the current user. userGetPreviousWeeklyTrackChart($fromDate, $toDate): Returns a SimpleXML object containing the Weekly Track Chart from $fromDate to $toDate for the current user.
Retrieving User Prole Information
In this example, we use the setUser() and userGetProfileInformation() methods to retrieve a specic users prole information:
1 2 3 4 5 6 7 8
$as = new ZendService\Audioscrobbler\Audioscrobbler(); // Set the user whose profile information we want to retrieve $as->setUser(BigDaddy71); // Retrieve BigDaddy71s profile information $profileInfo = $as->userGetProfileInformation(); // Display some of it print "Information for $profileInfo->realname " . "can be found at $profileInfo->url";
Retrieving a Users Weekly Artist Chart $as = new ZendService\Audioscrobbler\Audioscrobbler(); // Set the user whose profile weekly artist chart we want to retrieve $as->setUser(lo_fye); // Retrieves a list of previous weeks for which there are chart data $weeks = $as->userGetWeeklyChartList(); if (count($weeks) < 1) {
1 2 3 4 5 6
1354
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
echo No data available; } sort($weeks); // Order the list of weeks $as->setFromDate($weeks[0]); // Set the starting date $as->setToDate($weeks[0]); // Set the ending date $previousWeeklyArtists = $as->userGetPreviousWeeklyArtistChart(); echo Artist Chart For Week Of . date(Y-m-d h:i:s, $as->from_date) . <br />; foreach ($previousWeeklyArtists as $artist) { // Display the artists names with links to their profiles print <a href=" . $artist->url . "> . $artist->name . </a><br />; }
325.3 Artists
ZendService\Audioscrobbler\Audioscrobbler provides several methods for retrieving data about a specic artist, specied via the setArtist() method: artistGetRelatedArtists(): Returns a SimpleXML object containing a list of Artists similar to the current Artist. artistGetTopFans(): Returns a SimpleXML object containing a list of Users who listen most to the current Artist. artistGetTopTracks(): Returns a SimpleXML object containing a list of the current Artists top-rated Tracks. artistGetTopAlbums(): Returns a SimpleXML object containing a list of the current Artists top-rated Albums. artistGetTopTags(): Returns a SimpleXML object containing a list of the Tags most frequently applied to current Artist.
Retrieving Related Artists $as = new ZendService\Audioscrobbler\Audioscrobbler(); // Set the artist for whom you would like to retrieve related artists $as->setArtist(LCD Soundsystem); // Retrieve the related artists $relatedArtists = $as->artistGetRelatedArtists(); foreach ($relatedArtists as $artist) { // Display the related artists print <a href=" . $artist->url . "> . $artist->name . </a><br />; }
1 2 3 4 5 6 7 8 9
325.3. Artists
1355
325.4 Tracks
ZendService\Audioscrobbler\Audioscrobbler provides two methods for retrieving data specic to a single track, specied via the setTrack() method: trackGetTopFans(): Returns a SimpleXML object containing a list of Users who listen most to the current Track. trackGetTopTags(): Returns a SimpleXML object containing a list of the Tags most frequently applied to the current Track.
325.5 Tags
ZendService\Audioscrobbler\Audioscrobbler provides several methods for retrieving data specic to a single tag, specied via the setTag() method: tagGetOverallTopTags(): Returns a SimpleXML object containing a list of Tags most frequently used on Audioscrobbler. tagGetTopArtists(): Returns a SimpleXML object containing a list of Artists to whom the current Tag was most frequently applied. tagGetTopAlbums(): Returns a SimpleXML object containing a list of Albums to which the current Tag was most frequently applied. tagGetTopTracks(): Returns a SimpleXML object containing a list of Tracks to which the current Tag was most frequently applied.
325.6 Groups
ZendService\Audioscrobbler\Audioscrobbler provides several methods for retrieving data specic to a single group, specied via the setGroup() method: groupGetRecentJournals(): Returns a SimpleXML object containing a list of recent journal posts by Users in the current Group. groupGetWeeklyChart(): Returns a SimpleXML object containing a list of weeks for which there exist Weekly Charts for the current Group. groupGetRecentWeeklyArtistChart(): Returns a SimpleXML object containing the most recent Weekly Artist Chart for the current Group. groupGetRecentWeeklyAlbumChart(): Returns a SimpleXML object containing the most recent Weekly Album Chart for the current Group. groupGetRecentWeeklyTrackChart(): Returns a SimpleXML object containing the most recent Weekly Track Chart for the current Group. groupGetPreviousWeeklyArtistChart($fromDate, $toDate): Requires setFromDate() and setToDate(). Returns a SimpleXML object containing the Weekly Artist Chart from the current fromDate to the current toDate for the current Group. groupGetPreviousWeeklyAlbumChart($fromDate, $toDate): Requires setFromDate() and setToDate(). Returns a SimpleXML object containing the Weekly Album Chart from the current fromDate to the current toDate for the current Group.
1356
groupGetPreviousWeeklyTrackChart($fromDate, $toDate): Returns a SimpleXML object containing the Weekly Track Chart from the current fromDate to the current toDate for the current Group.
325.7 Forums
ZendService\Audioscrobbler\Audioscrobbler provides a method for retrieving data specic to a single forum, specied via the setForum() method: forumGetRecentPosts(): Returns a SimpleXML object containing a list of recent posts in the current forum.
325.7. Forums
1357
1358
CHAPTER 326
ZendServiceDelicious
326.1 Introduction
ZendService\Delicious is simple API for using del.icio.us XML and JSON web services. This component gives you read-write access to posts at del.icio.us if you provide credentials. It also allows read-only access to public data of all users.
Get all posts $delicious = new ZendService\Delicious\Delicious(username, password); $posts = $delicious->getAllPosts(); foreach ($posts as $post) { echo "--\n"; echo "Title: {$post->getTitle()}\n"; echo "Url: {$post->getUrl()}\n"; }
1 2 3 4 5 6 7 8
/** * Get posts matching the arguments. If no date or url is given, * most recent date will be used. * * @param string $tag Optional filtering by tag * @param DateTime $dt Optional filtering by date * @param string $url Optional filtering by url * @return ZendService\Delicious\PostList */ public function getPosts($tag = null, $dt = null, $url = null);
1359
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
/** * Get recent posts * Optional filtering by tag * @param string $tag * @param string $count Maximal number of posts to be returned (default 15) * @return ZendService\Delicious\PostList * */ public function getRecentPosts($tag = null, $count = 15); /** * Get all posts * * @param string $tag Optional filtering by tag * @return ZendService\Delicious\PostList */ public function getAllPosts($tag = null);
326.3 ZendServiceDeliciousPostList
Instances of this class are returned by the getPosts(), getAllPosts(), getRecentPosts(), and getUserPosts() methods of ZendService\Delicious. For easier data access this class implements the Countable, Iterator, and ArrayAccess interfaces.
Accessing post lists $delicious = new ZendService\Delicious\Delicious(username, password); $posts = $delicious->getAllPosts(); // count posts echo count($posts); // iterate over posts foreach ($posts as $post) { echo "--\n"; echo "Title: {$post->getTitle()}\n"; echo "Url: {$post->getUrl()}\n"; } // get post using array access echo $posts[0]->getTitle();
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
Note: The ArrayAccess::offsetSet() and ArrayAccess::offsetUnset() methods throw exceptions in this implementation. Thus, code like unset($posts[0]); and $posts[0] = A; will throw exceptions because these properties are read-only. Post list objects have two built-in ltering capabilities. Post lists may be ltered by tags and by URL.
1360
Posts may be ltered by specic tags using withTags(). As a convenience, withTag() is also provided for when only a single tag needs to be specied.
1 2 3 4 5 6 7 8
$delicious = new ZendService\Delicious\Delicious(username, password); $posts = $delicious->getAllPosts(); // Print posts having "php" and "zend" tags foreach ($posts->withTags(array(php, zend)) as $post) { echo "Title: {$post->getTitle()}\n"; echo "Url: {$post->getUrl()}\n"; }
Posts may be ltered by URL matching a specied regular expression using the withUrl() method:
1 2 3 4 5 6 7 8
$delicious = new ZendService\Delicious\Delicious(username, password); $posts = $delicious->getAllPosts(); // Print posts having "help" in the URL foreach ($posts->withUrl(/help/) as $post) { echo "Title: {$post->getTitle()}\n"; echo "Url: {$post->getUrl()}\n"; }
1 2 3 4 5 6 7
Every setter method returns the post object so that you can chain method calls using a uent interface.
1 2 3 4 5 6
$delicious = new ZendService\Delicious\Delicious(username, password); $posts = $delicious->getPosts(); $posts[0]->setTitle(New title) ->setNotes(New notes) ->save();
1361
1 2 3 4 5 6 7 8 9 10 11
1 2 3 4 5 6 7 8 9 10 11 12
326.7 Tags
Tags $delicious = new ZendService\Delicious\Delicious(username, password); // get all tags print_r($delicious->getTags());
1 2 3 4 5
1362
6 7
326.8 Bundles
Bundles $delicious = new ZendService\Delicious\Delicious(username, password); // get all bundles print_r($delicious->getBundles()); // delete bundle someBundle $delicious->deleteBundle(someBundle); // add bundle $delicious->addBundle(newBundle, array(tag1, tag2));
1 2 3 4 5 6 7 8 9 10
Retrieving public data // username and password are not required $delicious = new ZendService\Delicious\Delicious(); // get fans of user someUser print_r($delicious->getUserFans(someUser)); // get network of user someUser print_r($delicious->getUserNetwork(someUser)); // get tags of user someUser print_r($delicious->getUserTags(someUser));
1 2 3 4 5 6 7 8 9 10 11
326.8. Bundles
1363
Table 326.1: Methods of the ZendServiceDeliciousSimplePost class Name getNotes() getTags() getTitle() getUrl() Description Returns notes of a post Returns tags of a post Returns title of a post Returns URL of a post Return type String Array String String
1 2
When you are making more than one request with ZendService\Delicious to speed your requests, its better to congure your HTTP client to keep connections alive.
Conguring your HTTP client to keep connections alive Zend\Rest\Client::getHttpClient()->setConfig(array( keepalive => true ));
1 2 3
Note: When a ZendService\Delicious object is constructed, the SSL transport of Zend\Rest\Client is set to ssl rather than the default of ssl2. This is because del.icio.us has some problems with ssl2, such as requests taking a long time to complete (around 2 seconds).
1364
CHAPTER 327
Zend_Service_DeveloperGarden
1365
sandbox: In the Sandbox mode you can use the same features (with limitations) as in the production without to paying for them. This environment is suitable for testing your prototype. mock: The Mock environment allows you to build your application and have results but you do not initiate any action on the API side. This environment is intended for testing during development. For every environment and service, there are some special features (options) available for testing. Please look here for details.
1 2 3 4 5 6 7
327.2 BaseUserService
The class can be used to set and get quota values for the services and to fetch account details. The getAccountBalance() method fetches an array of account ids with the current balance status (credits).
Get account balance example $service = new Zend_Service_DeveloperGarden_BaseUserService($config); print_r($service->getAccountBalance());
1 2
1 2 3 4 5
1366
6 7 8
echo Max Quota: , $result->getMaxQuota(), <br />; echo Max User Quota: , $result->getMaxUserQuota(), <br />; echo Quota Level: , $result->getQuotaLevel(), <br />;
You get a result object that contains all the information you need, optional you can pass to the QuotaInformation method the environment constant to fetch the quota for the specic environment. Here a list of all getQuotaInformation methods: getConferenceCallQuotaInformation() getIPLocationQuotaInformation() getLocalSearchQuotaInformation() getSmsQuotaInformation() getVoiceCallQuotaInformation()
1 2 3 4 5 6 7 8
Here a list of all changeQuotaPool methods: changeConferenceCallQuotaPool() changeIPLocationQuotaPool() changeLocalSearchQuotaPool() changeSmsQuotaPool() changeVoiceCallQuotaPool()
327.3 IP Location
This service allows you to retrieve location information for a given IP address. There are some limitations: The IP address must be in the T-Home network Just the next big city will be resolved IPv6 is not supported yet
327.3. IP Location
1367
Locate a given IP $service = new Zend_Service_DeveloperGarden_IpLocation($config); $service->setEnvironment( Zend_Service_DeveloperGarden_IpLocation::ENV_MOCK ); $ip = new Zend_Service_DeveloperGarden_IpLocation_IpAddress(127.0.0.1); print_r($service->locateIp($ip));
1 2 3 4 5 6
1 2 3 4 5 6 7 8
1368
Sending an SMS $service = new Zend_Service_DeveloperGarden_SendSms($config); $sms = $service->createSms( +49-172-123456; +49-177-789012, your test message, yourname ); print_r($service->send($sms));
1 2 3 4 5 6 7
1 2
1 2
1369
Call two numbers $service = new Zend_Service_DeveloperGarden_VoiceCall($config); $aNumber = +49-30-000001; $bNumber = +49-30-000002; $expiration = 30; // seconds $maxDuration = 300; // 5 mins $newCall = $service->newCall($aNumber, $bNumber, $expiration, $maxDuration); echo $newCall->getSessionId();
1 2 3 4 5 6 7
If the call is initiated, you can ask the result object for the session ID and use this session ID for an additional call to the callStatus or tearDownCall() methods. The second parameter on the callStatus() method call extends the expiration for this call.
Call two numbers, ask for status, and cancel $service = new Zend_Service_DeveloperGarden_VoiceCall($config); $aNumber = +49-30-000001; $bNumber = +49-30-000002; $expiration = 30; // seconds $maxDuration = 300; // 5 mins $newCall = $service->newCall($aNumber, $bNumber, $expiration, $maxDuration); $sessionId = $newCall->getSessionId(); $service->callStatus($sessionId, true); // extend the call sleep(10); // sleep 10s and then tearDown $service->tearDownCall($sessionId);
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
327.8 ConferenceCall
Conference Call allows you to setup and start a phone conference. The following features are available: Conferences with an immediate start Conferences with a dened start date Recurring conference series Adding, removing, and muting of participants from a conference Templates for conferences Here is a list of currently implemented API methods: createConference() creates a new conference updateConference() updates an existing conference commitConference() saves the conference, and, if no date is congured, immediately starts the conference removeConference() removes a conference
1370
getConferenceList() returns a list of all congured conferences getConferenceStatus() displays information for an existing conference getParticipantStatus() displays status information about a conference participant newParticipant() creates a new participant addParticipant() adds a participant to a conference updateParticipant() updates a participant, usually to mute or redial the participant removeParticipant() removes a participant from a conference getRunningConference() requests the running instance of a planned conference createConferenceTemplate() creates a new conference template getConferenceTemplate() requests an existing conference template updateConferenceTemplate() updates existing conference template details removeConferenceTemplate() removes a conference template getConferenceTemplateList() requests all conference templates of an owner addConferenceTemplateParticipant() adds a conference participant to conference template getConferenceTemplateParticipant() displays details of a participant of a conference template updateConferenceTemplateParticipant() updates participant details within a conference template removeConferenceTemplateParticipant() removes a participant from a conference template
Ad-Hoc conference $client = new Zend_Service_DeveloperGarden_ConferenceCall($config); $conferenceDetails = new Zend_Service_DeveloperGarden_ConferenceCall_ConferenceDetail( Zend-Conference, // name for the conference this is my private zend conference, // description 60 // duration in seconds ); $conference = $client->createConference(MyName, $conferenceDetails); $part1 = new Zend_Service_DeveloperGarden_ConferenceCall_ParticipantDetail( Jon, Doe, +49-123-4321, your.name@example.com, true ); $client->newParticipant($conference->getConferenceId(), $part1); // add a second, third ... participant $client->commitConference($conference->getConferenceId());
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
327.8. ConferenceCall
1371
1 2 3
The [PHP CONSTANT] can be one of the following values: WSDL_CACHE_DISC: enabled disc caching WSDL_CACHE_MEMORY: enabled memory caching WSDL_CACHE_BOTH: enabled disc and memory caching WSDL_CACHE_NONE: disabled both caching If you also want to cache the result for calls to the SecurityTokenServer you can setup a Zend_Cache instance and pass it to the setCache().
SecurityTokenServer cache option $cache = Zend_Cache::factory(Core, ...); Zend_Service_DeveloperGarden_SecurityTokenServer_Cache::setCache($cache);
1 2
1372
CHAPTER 328
ZendServiceFlickr
328.1 Introduction
ZendService\Flickr is a simple API for using the Flickr REST Web Service. In order to use the Flickr web services, you must have an API key. To obtain a key and for more information about the Flickr REST Web Service, please visit the Flickr API Documentation. In the following example, we use the tagSearch() method to search for photos having php in the tags.
Simple Flickr Photo Search $flickr = new ZendService\Flickr\Flickr(MY_API_KEY); $results = $flickr->tagSearch("php"); foreach ($results as $result) { echo $result->title . <br />; }
1 2 3 4 5 6 7
Note: Optional parameter tagSearch() accepts an optional second parameter as an array of options.
1373
In this example, we have a Flickr users e-mail address, and we search for the users public photos by using the userSearch() method:
1 2 3 4 5 6 7
$flickr = new ZendService\Flickr(MY_API_KEY); $results = $flickr->userSearch($userEmail); foreach ($results as $result) { echo $result->title . <br />; }
1 2 3 4 5 6 7
Note: Optional parameter groupPoolGetPhotos() accepts an optional second parameter as an array of options.
Once you have a Flickr image ID, it is a simple matter to fetch information about the image:
1 2 3 4 5 6
$flickr = new ZendService\Flickr\Flickr(MY_API_KEY); $image = $flickr->getImageDetails($imageId); echo "Image ID $imageId is $image->width x $image->height pixels.<br />\n"; echo "<a href=\"$image->clickUri\">Click for Image</a>\n";
1374
328.5.1 ZendServiceFlickrResultSet
Represents a set of Results from a Flickr search. Note: Implements the SeekableIterator interface for easy iteration (e.g., using foreach()), as well as direct access to a specic result using seek().
328.5.2 Properties
Table 328.1: ZendServiceFlickrResultSet Properties Name totalResultsAvailable totalResultsReturned rstResultPosition Type int int int Description Total Number of Results available Total Number of Results returned The offset in the total result set of this result set
328.5.3 ZendServiceFlickrResultSet::totalResults()
int:totalResults() Returns the total number of results in this result set. Back to Class List
328.5.4 ZendServiceFlickrResult
A single Image result from a Flickr query
328.5.5 Properties
Back to Class List
328.5.6 ZendServiceFlickrImage
Represents an Image returned by a Flickr search.
1375
328.5.7 Properties
Table 328.2: ZendServiceFlickrImage Properties Name uri clickUri width height Type string string int int Description URI for the original image Clickable URI (i.e. the Flickr page) for the image Width of the Image Height of the Image
1376
CHAPTER 329
ZendService\LiveDocx
1378
TIFF- Tagged Image File Format WMF- Windows Meta File format
329.2 ZendService\LiveDocx\MailMerge
MailMerge is the mail-merge object in the ZendService\LiveDocx family.
Data is inserted into template to create a document. A template, created in a word processing application, such as Microsoft Word, is loaded into LiveDocx. Data is then inserted into the template and the resulting document is saved to any supported format.
329.2. ZendService\LiveDocx\MailMerge
1379
Microsoft Word 2007 Field dialog box. Using this dialog, you can insert the required merge elds into your document. Below is a screenshot of a license agreement in Microsoft Word 2007. The merge elds are marked as { MERGEFIELD FieldName }:
1380
Template in Microsoft Word 2007. Now, save the template as template.docx. In the next step, we are going to populate the merge elds with textual data from PHP.
Cropped template in Microsoft Word 2007. To populate the merge elds in the above cropped screenshot of the template in Microsoft Word, all we have to code is as follows:
1 2 3 4 5 6 7 8
use ZendService\LiveDocx\MailMerge; $locale = Locale::getDefault(); $timestamp = time(); $intlTimeFormatter = new IntlDateFormatter($locale, IntlDateFormatter::NONE, IntlDateFormatter::SHORT);
329.2. ZendService\LiveDocx\MailMerge
1381
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
$intlDateFormatter = new IntlDateFormatter($locale, IntlDateFormatter::LONG, IntlDateFormatter::NONE); $mailMerge = new MailMerge(); $mailMerge->setUsername(myUsername) ->setPassword(myPassword) ->setService (MailMerge::SERVICE_FREE);
$mailMerge->setLocalTemplate(license-agreement-template.docx); $mailMerge->assign(software, ->assign(licensee, ->assign(company, ->assign(date, ->assign(time, ->assign(city, ->assign(country, $mailMerge->createDocument(); $document = $mailMerge->retrieveDocument(pdf); file_put_contents(license-agreement-document.pdf, $document); unset($mailMerge); Magic Graphical Compression Suite v1.9) Henry Dner-Meyer) Co-Operation) $intlDateFormatter->format($timestamp)) $intlTimeFormatter->format($timestamp)) Lyon) France);
The resulting document is written to disk in the le license-agreement-document.pdf. This le can now be postprocessed, sent via e-mail or simply displayed, as is illustrated below in Document Viewer 2.26.1 on Ubuntu 9.04:
1382
Resulting document as PDF in Document Viewer 2.26.1. For executable demo applications, which illustrate the above, please take a look at /demos/ZendService/LiveDocx/MailMerge/license-agreement.
329.2. ZendService\LiveDocx\MailMerge
1383
For example:
blockStart_block1 blockEnd_block1
The content of a block is repeated, until all data assigned in the block elds has been injected into the template. The data for block elds is specied in PHP as a multi-assoc array. The following screenshot of a template in Microsoft Word 2007 shows how block elds are used:
Template, illustrating blocks in Microsoft Word 2007. The following code populates the above template with data.
1384
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
use ZendService\LiveDocx\MailMerge; $locale = Locale::getDefault(); $timestamp = time(); $intlDateFormatter1 = new IntlDateFormatter($locale, IntlDateFormatter::LONG, IntlDateFormatter::NONE); $intlDateFormatter2 = new IntlDateFormatter($locale, null, null, null, null, LLLL yyyy); $mailMerge = new MailMerge(); $mailMerge->setUsername(myUsername) ->setPassword(myPassword) ->setService (MailMerge::SERVICE_FREE);
$mailMerge->setLocalTemplate(telephone-bill-template.doc); $mailMerge->assign(customer_number, sprintf("#%10s", rand(0,1000000000))) ->assign(invoice_number, sprintf("#%10s", rand(0,1000000000))) ->assign(account_number, sprintf("#%10s", rand(0,1000000000))); $billData = array ( phone date name service_phone service_fax month monthly_fee total_net tax tax_value total );
=> => => => => => => => => => =>
+22 (0)333 444 555, $intlDateFormatter1->format($timestamp), James Henry Brown, +22 (0)333 444 559, +22 (0)333 444 558, $intlDateFormatter2->format($timestamp), 15.00, 19.60, 19.00, 3.72, 23.32
$mailMerge->assign($billData); $billConnections = array( array( connection_number connection_duration fee ), array( connection_number connection_duration fee ), array( connection_number connection_duration fee ), array( connection_number connection_duration
329.2. ZendService\LiveDocx\MailMerge
1385
59 60 61 62 63 64 65 66 67 68 69 70 71
fee ) );
=> 1.15
The data, which is specied in the array $billConnections is repeated in the template in the block connection. The keys of the array (connection_number, connection_duration and fee) are the block eld names their data is inserted, one row per iteration. The resulting document is written to disk in the le telephone-bill-document.pdf. This le can now be post-processed, sent via e-mail or simply displayed, as is illustrated below in Document Viewer 2.26.1 on Ubuntu 9.04:
Resulting document as PDF in Document Viewer 2.26.1. You can download the DOC template le and the resulting PDF document.
1386
NOTE: blocks may not be nested. For executable demo applications, which illustrate the above, /demos/ZendService/LiveDocx/MailMerge/telephone-bill. please take a look at
use ZendService\LiveDocx\MailMerge; $locale = Locale::getDefault(); $timestamp = time(); $intlDateFormatter = new IntlDateFormatter($locale, IntlDateFormatter::LONG, IntlDateFormatter::NONE); $mailMerge = new MailMerge(); $mailMerge->setUsername(myUsername) ->setPassword(myPassword) ->setService (MailMerge::SERVICE_FREE); $photoFilename = __DIR__ . /dailemaitre.jpg; $photoFile = basename($photoFilename); if (!$mailMerge->imageExists($photoFile)) { $mailMerge->uploadImage($photoFilename); } // pass image file *without* path // pass image file *with* path
$mailMerge->setLocalTemplate(conference-pass-template.docx); $mailMerge->assign(name, ->assign(company, ->assign(date, ->assign(image:photo, $mailMerge->createDocument(); $document = $mailMerge->retrieveDocument(pdf); file_put_contents(conference-pass-document.pdf, $document); $mailMerge->deleteImage($photoFilename); unset($mailMerge); Da Lemaitre) Megasoft Co-operation) $intlDateFormatter->format($timestamp)) $photoFile); // pass image file *without* path
please
take
look
at
329.2. ZendService\LiveDocx\MailMerge
1387
use ZendService\LiveDocx\MailMerge; $locale = Locale::getDefault(); $timestamp = time(); $intlTimeFormatter = new IntlDateFormatter($locale, IntlDateFormatter::NONE, IntlDateFormatter::SHORT); $intlDateFormatter = new IntlDateFormatter($locale, IntlDateFormatter::LONG, IntlDateFormatter::NONE); $mailMerge = new MailMerge(); $mailMerge->setUsername(myUsername) ->setPassword(myPassword) ->setService (MailMerge::SERVICE_FREE);
$mailMerge->setLocalTemplate(license-agreement-template.docx); $mailMerge->assign(software, ->assign(licensee, ->assign(company, ->assign(date, ->assign(time, ->assign(city, ->assign(country, $mailMerge->createDocument(); // Get all bitmaps // (zoomFactor, format) $bitmaps = $mailMerge->getAllBitmaps(100, png); // Get just bitmaps in specified range // (fromPage, toPage, zoomFactor, format) //$bitmaps = $mailMerge->getBitmaps(2, 2, 100, png); foreach ($bitmaps as $pageNumber => $bitmapData) { $filename = sprintf(license-agreement-page-%d.png, $pageNumber); file_put_contents($filename, $bitmapData); } unset($mailMerge); Magic Graphical Compression Suite v1.9) Henry Dner-Meyer) Co-Operation) $intlDateFormatter->format($timestamp)) $intlTimeFormatter->format($timestamp)) Lyon) France);
This produces two les (license-agreement-page-1.png and license-agreement-page-2.png) and writes them to disk in the same directory as the executable PHP le.
1388
license-agreement-page-1.png.
329.2. ZendService\LiveDocx\MailMerge
1389
license-agreement-page-2.png. For executable demo applications, which illustrate the above, please take a look at /demos/ZendService/LiveDocx/MailMerge/bitmaps.
1390
use ZendService\LiveDocx\MailMerge; $mailMerge = new MailMerge(); $mailMerge->setUsername(myUsername) ->setPassword(myPassword) ->setService (MailMerge::SERVICE_FREE); $mailMerge->setLocalTemplate(template.docx); // assign data and create document unset($mailMerge);
In the case that a template is stored remotely, it is uploaded once to LiveDocx and then simply referenced on all subsequent requests. Obviously, this is much quicker than using a local template, as the template does not have to be transferred on every request. For speed critical applications, it is recommended to use the remote template method. The following code illustrates how to upload a template to the server:
1 2 3 4 5 6 7 8 9 10 11
use ZendService\LiveDocx\MailMerge; $mailMerge = new MailMerge(); $mailMerge->setUsername(myUsername) ->setPassword(myPassword) ->setService (MailMerge::SERVICE_FREE); $mailMerge->uploadTemplate(template.docx); unset($mailMerge);
The following code illustrates how to reference the remotely stored template on all subsequent requests:
1 2 3 4 5 6 7 8 9 10 11 12 13
use ZendService\LiveDocx\MailMerge; $mailMerge = new MailMerge(); $mailMerge->setUsername(myUsername) ->setPassword(myPassword) ->setService (MailMerge::SERVICE_FREE); $mailMerge->setRemoteTemplate(template.docx); // assign data and create document unset($mailMerge);
329.2. ZendService\LiveDocx\MailMerge
1391
above,
please
take
look
at
The following code returns and displays an array of all eld names in the specied template. This functionality is useful, in the case that you create an application, in which an end-user can update a template.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
use ZendService\LiveDocx\MailMerge; $mailMerge = new MailMerge(); $mailMerge->setUsername(myUsername) ->setPassword(myPassword) ->setService (MailMerge::SERVICE_FREE); $templateName = template-1-text-field.docx; $mailMerge->setLocalTemplate($templateName); $fieldNames = $mailMerge->getFieldNames(); foreach ($fieldNames as $fieldName) { printf(- %s%s, $fieldName, PHP_EOL); } unset($mailMerge);
please
take
look
at
The following code returns and displays an array of all block eld names in the specied template. This functionality is useful, in the case that you create an application, in which an end-user can update a template. Before such templates can be populated, it is necessary to nd out the names of the contained block elds.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
use ZendService\LiveDocx\MailMerge; $mailMerge = new MailMerge(); $mailMerge->setUsername(myUsername) ->setPassword(myPassword) ->setService (MailMerge::SERVICE_FREE); $templateName = template-block-fields.doc; $mailMerge->setLocalTemplate($templateName); $blockNames = $mailMerge->getBlockNames(); foreach ($blockNames as $blockName) { $blockFieldNames = $mailMerge->getBlockFieldNames($blockName); foreach ($blockFieldNames as $blockFieldName) {
1392
16 17 18 19 20
please
take
look
at
The following code returns and displays an array of all fonts installed on the server. You can use this method to present a list of fonts which may be used in a template. It is important to inform the end-user about the fonts installed on the server, as only these fonts may be used in a template. In the case that a template contains fonts, which are not available on the server, font-substitution will take place. This may lead to undesirable results.
1 2 3 4 5 6 7 8 9 10 11 12
use ZendService\LiveDocx\MailMerge; use Zend\Debug\Debug; $mailMerge = new MailMerge(); $mailMerge->setUsername(myUsername) ->setPassword(myPassword) ->setService (MailMerge::SERVICE_FREE); Debug::dump($mailMerge->getFontNames()); unset($mailMerge);
NOTE: As the return value of this method changes very infrequently, it is highly recommended to use a cache, such as Zend\Cache\Cache- this will considerably speed up your application. For executable demo applications, which illustrate the above, /demos/ZendService/LiveDocx/MailMerge/supported-fonts.
Get Array of Supported Template File Formats
please
take
look
at
The following code returns and displays an array of all supported template le formats. This method is particularly useful in the case that a combo list should be displayed that allows the end-user to select the input format of the documentation generation process.
1 2 3 4 5 6 7 8 9 10 11 12
use ZendService\LiveDocx\MailMerge; use Zend\Debug\Debug; $mailMerge = new MailMerge() $mailMerge->setUsername(myUsername) ->setPassword(myPassword) ->setService (MailMerge::SERVICE_FREE); Debug::dump($mailMerge->getTemplateFormats()); unset($mailMerge);
NOTE: As the return value of this method changes very infrequently, it is highly recommended to use a cache, such as Zend\Cache\Cache- this will considerably speed up your application. 329.2. ZendService\LiveDocx\MailMerge 1393
please
take
look
at
The following code returns and displays an array of all supported document le formats. This method is particularly useful in the case that a combo list should be displayed that allows the end-user to select the output format of the documentation generation process.
1 2 3 4 5 6 7 8 9 10 11 12
use ZendService\LiveDocx\MailMerge; use Zend\Debug\Debug; $mailMerge = new MailMerge(); $mailMerge->setUsername(myUsername) ->setPassword(myPassword) ->setService (MailMerge::SERVICE_FREE); Debug::dump($mailMerge->getDocumentFormats()); unset($mailMerge);
please
take
look
at
The following code returns and displays an array of all supported image le formats. This method is particularly useful in the case that a combo list should be displayed that allows the end-user to select the output format of the documentation generation process.
1 2 3 4 5 6 7 8 9 10 11 12
use ZendService\LiveDocx\MailMerge; use Zend\Debug\Debug; $mailMerge = new MailMerge(); $mailMerge->setUsername(myUsername) ->setPassword(myPassword) ->setService (MailMerge::SERVICE_FREE); Debug::dump($mailMerge->getImageExportFormats()); unset($mailMerge);
NOTE: As the return value of this method changes very infrequently, it is highly recommended to use a cache, such as Zend\Cache\Cache- this will considerably speed up your application. For executable demo applications, which illustrate the above, /demos/ZendService/LiveDocx/MailMerge/supported-formats. please take a look at
created faster than LiveDocx Free permits. For such scenarios, Text Control GmbH offers LiveDocx Premium, a paid service with a number of benets. For an overview of the benets, please take a look at LiveDocx pricing. This section of the manual offers a technical overview of how to upgrade from LiveDocx Free to LiveDocx Premium. All you have to do, is make a very small change to the code that runs with LiveDocx Free. Your instantiation and initialization of LiveDocx Free probably looks as follows:
1 2 3 4 5 6 7 8 9 10 11
use ZendService\LiveDocx\MailMerge; $mailMerge = new MailMerge() $mailMerge->setUsername(myUsername) ->setPassword(myPassword) ->setService (MailMerge::SERVICE_FREE); // rest of your application here unset($mailMerge);
To use LiveDocx Premium, you simply need to change the service value from MailMerge::SERVICE_FREE to MailMerge::SERVICE_PREMIUM, and set the username and password assigned to you for Livedocx Premium. This may, or may not be the same as the credentials for LiveDocx Free. For example:
1 2 3 4 5 6 7 8 9 10 11
use ZendService\LiveDocx\MailMerge; $mailMerge = new MailMerge() $mailMerge->setUsername(myPremiumUsername) ->setPassword(myPremiumPassword) ->setService (MailMerge::SERVICE_PREMIUM); // rest of your application here unset($mailMerge);
And that is all there is to it. The assignment of the premium WSDL to the component is handled internally and automatically. You are now using LiveDocx Premium. For executable demo applications, which illustrate the above, /demos/ZendService/LiveDocx/MailMerge/instantiation. please take a look at
329.2.9 Upgrading From LiveDocx Free or LiveDocx Premium to LiveDocx Fully Licensed
LiveDocx Free and Livedocx Premium are provided by Text Control GmbH as a service. They are addressed over the Internet. However, for certain applications, for example, ones that process very sensitive data (banking, health or nancial), you may not want to send your data across the Internet to a third party service, regardless of the SSL encryption that both LiveDocx Free and Livedocx Premium offer as standard. For such scenarios, you can license LiveDocx and install an entire LiveDocx server in your own network. As such, you completely control the ow of data between your application and the backend LiveDocx server. For an overview of the benets of LiveDocx Fully Licensed, please take a look at LiveDocx pricing. This section of the manual offers a technical overview of how to upgrade from LiveDocx Free or LiveDocx Premium to LiveDocx Fully Licensed. All you have to do, is make a very small change to the code that runs with LiveDocx Free or LiveDocx Premium. Your instantiation and initialization of LiveDocx Free or LiveDocx Premium probably looks as follows:
329.2. ZendService\LiveDocx\MailMerge
1395
1 2 3 4 5 6 7 8 9 10 11 12 13
use ZendService\LiveDocx\MailMerge; $mailMerge = new MailMerge() $mailMerge->setUsername(myUsername) ->setPassword(myPassword) ->setService (MailMerge::SERVICE_FREE); // or // ->setService (MailMerge::SERVICE_PREMIUM); // rest of your application here unset($mailMerge);
To use LiveDocx Fully Licensed, you simply need to set the WSDL of the backend LiveDocx server in your own network. You can do this as follows:
1 2 3 4 5 6 7 8 9 10 11
use ZendService\LiveDocx\MailMerge; $mailMerge = new MailMerge() $mailMerge->setUsername(myFullyLicensedUsername) ->setPassword(myFullyLicensedPassword) ->setWsdl (http://api.example.com/2.1/mailmerge.asmx?wsdl); // rest of your application here unset($mailMerge);
And that is all there is to it. You are now using LiveDocx Fully Licensed. For executable demo applications, which illustrate the above, /demos/ZendService/LiveDocx/MailMerge/instantiation. please take a look at
1396
CHAPTER 330
ZendServiceNirvanix
330.1 Introduction
Nirvanix provides an Internet Media File System (IMFS), an Internet storage service that allows applications to upload, store and organize les and subsequently access them using a standard Web Services interface. An IMFS is distributed clustered le system, accessed over the Internet, and optimized for dealing with media les (audio, video, etc). The goal of an IMFS is to provide massive scalability to deal with the challenges of media storage growth, with guaranteed access and availability regardless of time and location. Finally, an IMFS gives applications the ability to access data securely, without the large xed costs associated with acquiring and maintaining physical storage assets.
330.4 Features
Nirvanixs REST service can be used effectively with PHP using the SimpleXML extension and Zend\Http\Client alone. However, using it this way is somewhat inconvenient due to repetitive operations 1397
like passing the session token on every request and repeatedly checking the response body for error codes. ZendService\Nirvanix provides the following functionality: A single point for conguring your Nirvanix authentication credentials that can be used across the Nirvanix namespaces. A proxy object that is more convenient to use than an HTTP client alone, mostly removing the need to manually construct HTTP POST requests to access the REST service. A response wrapper that parses each response body and throws an exception if an error occurred, alleviating the need to repeatedly check the success of many commands. Additional convenience methods for some of the more common operations.
$auth = array(username => your-username, password => your-password, appKey => your-app-key); $nirvanix = new ZendService\Nirvanix\Nirvanix($auth); $imfs = $nirvanix->getService(IMFS); $imfs->putContents(/foo.txt, contents to store); echo $imfs->getContents(/foo.txt); $imfs->unlink(/foo.txt);
The rst step to using ZendService\Nirvanix is always to authenticate against the service. This is done by passing your credentials to the ZendService\Nirvanix constructor above. The associative array is passed directly to Nirvanix as POST parameters. Nirvanix divides its web services into namespaces. Each namespace encapsulates a group of related operations. After getting an instance of ZendService\Nirvanix, call the getService() method to create a proxy for the namespace you want to use. Above, a proxy for the IMFS namespace is created. After you have a proxy for the namespace you want to use, call methods on it. The proxy will allow you to use any command available on the REST API. The proxy may also make convenience methods available, which wrap web service commands. The example above shows using the IMFS convenience methods to create a new le, retrieve and display that le, and nally delete the le.
1398
getContents(), and unlink() do not have direct equivalents in the REST API. They are convenience methods provided by ZendService\Nirvanix that abstract more complicated operations on the REST API. For all other method calls to the proxy object, the proxy will dynamically convert the method call to the equivalent HTTP POST request to the REST API. It does this by using the method name as the API command, and an associative array in the rst argument as the POST parameters. Lets say you want to call the REST API method RenameFile, which does not have a convenience method in ZendService\Nirvanix:
1 2 3 4 5 6 7 8 9
$auth = array(username => your-username, password => your-password, appKey => your-app-key); $nirvanix = new ZendService\Nirvanix\Nirvanix($auth); $imfs = $nirvanix->getService(IMFS); $result = $imfs->renameFile(array(filePath => /path/to/foo.txt, newFileName => bar.txt));
Above, a proxy for the IMFS namespace is created. A method, renameFile(), is then called on the proxy. This method does not exist as a convenience method in the PHP code, so it is trapped by __call() and converted into a POST request to the REST API where the associative array is used as the POST parameters. Notice in the Nirvanix API documentation that sessionToken is required for this method but we did not give it to the proxy object. It is added automatically for your convenience. The result of this operation will either be a ZendService\Nirvanix\Response object wrapping the XML returned by Nirvanix, or a ZendService\Nirvanix\Exception if an error occurred.
<?php $auth = array(username => your-username, password => your-password, appKey => your-app-key); $nirvanix = new ZendService\Nirvanix\Nirvanix($auth); $imfs = $nirvanix->getService(IMFS); $result = $imfs->putContents(/foo.txt, fourteen bytes); print_r($result); ?> ZendService\Nirvanix\Response Object ( [_sxml:protected] => SimpleXMLElement Object ( [ResponseCode] => 0 [FilesUploaded] => 1 [BytesUploaded] => 14
1399
20 21
) )
You can access any property or method of the decorated SimpleXMLElement. In the above example, $result>BytesUploaded could be used to see the number of bytes received. Should you want to access the SimpleXMLElement directly, just use $result->getSxml(). The most common response from Nirvanix is success (ResponseCode of zero). It is not normally necessary to check ResponseCode because any non-zero result will throw a ZendService\Nirvanix\Exception. See the next section on handling errors.
When the ResponseCode is zero such as in the example above, the operation was successful. When the operation is not successful, the ResponseCode is non-zero and an ErrorMessage element should be present. To alleviate the need to repeatedly check if the ResponseCode is non-zero, ZendService\Nirvanix automatically checks each response returned by Nirvanix. If the ResponseCode indicates an error, a ZendService\Nirvanix\Exception will be thrown.
1 2 3 4 5 6 7 8 9 10 11 12 13 14
$auth = array(username => your-username, password => your-password, appKey => your-app-key); $nirvanix = new ZendService\Nirvanix\Nirvanix($auth); try { $imfs = $nirvanix->getService(IMFS); $imfs->unlink(/a-nonexistant-path); } catch (ZendService\Nirvanix\Exception\DomainException $e) { echo $e->getMessage() . "\n"; echo $e->getCode(); }
In the example above, unlink() is a convenience method that wraps the DeleteFiles command on the REST API. The lePath parameter required by the DeleteFiles command contains a path that does not exist. This will result in a ZendService\Nirvanix exception being thrown with the message Invalid path and code 70005. The Nirvanix API Documentation describes the errors associated with each command. Depending on your needs, you may wrap each command in a try block or wrap many commands in the same try block for convenience.
1400
CHAPTER 331
Zend\Service\Rackspace
331.1 Introduction
The ZendService\Rackspace is a class that provides a simple API to manage the Rackspace services Cloud Files and Cloud Servers. Note: Load balancers service The load balancers service of Rackspace is not implemented yet. We are planning to release it in the next future.
1401
1402
getManagementUrl getManagementUrl() Get the URL for the management services. Returns a string. getStorageUrl getStorageUrl() Get the URL for the storage (les) service. Returns a string. getToken getToken() Get the token returned after a successful authentication. Returns a string. getUser getUser() Get the user authenticated with the Rackspace service. Returns a string. isSuccessful isSuccessful() Return true if the last service call was successful, false otherwise. setAuthUrl setAuthUrl(string $url) Set the authentication URL to be used. $url is the URL for the authentication setKey setKey(string $key) Set the key for the API authentication. $key is the key string for the authentication setUser setUser(string $user) Set the user for the API authentication. $user is the user string for the authentication
1403
1404
CHAPTER 332
ZendServiceReCaptcha
332.1 Introduction
ZendService\ReCaptcha provides a client for the reCAPTCHA Web Service. Per the reCAPTCHA site, reCAPTCHA is a free CAPTCHA service that helps to digitize books. Each reCAPTCHA requires the user to input two words, the rst of which is the actual CAPTCHA, and the second of which is a word from some scanned text that Optical Character Recognition (OCR) software has been unable to identify. The assumption is that if a user correctly provides the rst word, the second is likely correctly entered as well, and can be used to improve OCR software for digitizing books. In order to use the reCAPTCHA service, you will need to sign up for an account and register one or more domains with the service in order to generate public and private keys.
When the form is submitted, you should receive two elds, recaptcha_challenge_eld and recaptcha_response_eld. Pass these to the reCAPTCHA objects verify() method:
1405
1 2 3 4
Once you have the result, test against it to see if it is valid. The result is a ZendService\ReCaptcha\Response object, which provides an isValid() method.
Validating the reCAPTCHA if (!$result->isValid()) { // Failed validation }
1 2 3
It is even simpler to use the reCAPTCHA Zend\Captcha adapter, or to use that adapter as a backend for the CAPTCHA form element. In each case, the details of rendering and validating the reCAPTCHA are automated for you.
1 2 3 4 5 6 7 8 9 10 11 12
The example above will display m...@example.com where ... has a link that opens up a popup window with a reCAPTCHA challenge. The public key, private key, and the email address can also be specied in the constructor of the class. A fourth argument also exists that enables you to set some options for the component. The available options are listed in the following table:
1406
Table 332.1: ZendServiceReCaptchaMailHide options Option linkTitle linkHiddenText popupWidth popupHeight Description The title attribute of the link The text that includes the popup link The width of the popup window The height of the popup window Expected Values string string int int Default Value Reveal this e=mail address ... 500 300
The conguration options can be set by sending them as the fourth argument to the constructor or by calling setOptions($options), which takes an associative array or an instance of ZendCongCong.
Generating many hidden email addresses // Create an instance of the mailhide component, passing it your public // and private keys, as well as some configuration options $mailHide = new ZendService\ReCaptcha\Mailhide(); $mailHide->setPublicKey($pubKey); $mailHide->setPrivateKey($privKey); $mailHide->setOptions(array( linkTitle => Click me, linkHiddenText => +++++, )); // The mail addresses we want to hide $mailAddresses = array( mail@example.com, johndoe@example.com, janedoe@example.com, ); foreach ($mailAddresses as $mail) { $mailHide->setEmail($mail); print($mailHide); }
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
1407
1408
CHAPTER 333
ZendServiceSlideShare
The ZendService\SlideShare component is used to interact with the slideshare.net web services for hosting slide shows online. With this component, you can embed slide shows which are hosted on this web site within a web site and even upload new slide shows to your account.
// Create a new instance of the component $ss = new ZendService\SlideShare\SlideShare(APIKEY, SHAREDSECRET, USERNAME, PASSWORD);
class ZendService\SlideShare\SlideShow { /** * Retrieves the location of the slide show */ public function getLocation() { return $this->_location; } /**
1409
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
* Gets the transcript for this slide show */ public function getTranscript() { return $this->_transcript; } /** * Adds a tag to the slide show */ public function addTag($tag) { $this->_tags[] = (string)$tag; return $this; } /** * Sets the tags for the slide show */ public function setTags(Array $tags) { $this->_tags = $tags; return $this; } /** * Gets all of the tags associated with the slide show */ public function getTags() { return $this->_tags; } /** * Sets the filename on the local filesystem of the slide show * (for uploading a new slide show) */ public function setFilename($file) { $this->_slideShowFilename = (string)$file; return $this; } /** * Retrieves the filename on the local filesystem of the slide show * which will be uploaded */ public function getFilename() { return $this->_slideShowFilename; } /** * Gets the ID for the slide show */ public function getId() { return $this->_slideShowId; } /** * Retrieves the HTML embed code for the slide show */ public function getEmbedCode() { return $this->_embedCode;
1410
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
} /** * Retrieves the Thumbnail URi for the slide show */ public function getThumbnailUrl() { return $this->_thumbnailUrl; } /** * Sets the title for the Slide show */ public function setTitle($title) { $this->_title = (string)$title; return $this; } /** * Retrieves the Slide show title */ public function getTitle() { return $this->_title; } /** * Sets the description for the Slide show */ public function setDescription($desc) { $this->_description = (string)$desc; return $this; } /** * Gets the description of the slide show */ public function getDescription() { return $this->_description; } /** * Gets the numeric status of the slide show on the server */ public function getStatus() { return $this->_status; } /** * Gets the textual description of the status of the slide show on * the server */ public function getStatusDescription() { return $this->_statusDescription; } /** * Gets the permanent link of the slide show */ public function getPermaLink() {
1411
127 128 129 130 131 132 133 134 135 136
return $this->_permalink; } /** * Gets the number of views the slide show has received */ public function getNumViews() { return $this->_numViews; } }
Note: The above pseudo-class only shows those methods which should be used by end-user developers. Other available methods are internal to the component. When using the ZendService\SlideShare component, this data class will be used frequently to browse or add new slide shows to or from the web service.
// Create a new instance of the component $ss = new ZendService\SlideShare\SlideShare(APIKEY, SHAREDSECRET, USERNAME, PASSWORD); $slideshow = $ss->getSlideShow(123456); print "Slide Show Title: {$slideshow->getTitle()}<br/>\n"; print "Number of views: {$slideshow->getNumViews()}<br/>\n";
Each of the above methods of retrieving multiple slide shows a similar approach is used. An example of using each method is shown below:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
// Create a new instance of the component $ss = new ZendService\SlideShare\SlideShare(APIKEY, SHAREDSECRET, USERNAME, PASSWORD); $starting_offset = 0; $limit = 10; // Retrieve the first 10 of each type $ss_user = $ss->getSlideShowsByUser(username, $starting_offset, $limit); $ss_tags = $ss->getSlideShowsByTag(zend, $starting_offset, $limit); $ss_group = $ss->getSlideShowsByGroup(mygroup, $starting_offset, $limit); // Iterate over the slide shows foreach ($ss_user as $slideshow) { print "Slide Show Title: {$slideshow->getTitle}<br/>\n"; }
$frontendOptions = array( lifetime => 7200, automatic_serialization => true); $backendOptions = array( cache_dir => /webtmp/); $cache = Zend\Cache\Cache::factory(Core, File, $frontendOptions, $backendOptions); $ss = new ZendService\SlideShare\SlideShare(APIKEY, SHAREDSECRET, USERNAME, PASSWORD); $ss->setCacheObject($cache); $ss_user = $ss->getSlideShowsByUser(username, $starting_offset, $limit);
1413
1 2 3 4 5 6 7 8 9
$client = new Zend\Http\Client(); $client->setConfig(array(timeout => 5)); $ss = new ZendService\SlideShare\SlideShare(APIKEY, SHAREDSECRET, USERNAME, PASSWORD); $ss->setHttpClient($client); $ss_user = $ss->getSlideShowsByUser(username, $starting_offset, $limit);
1414
CHAPTER 334
ZendServiceStrikeIron
ZendService\StrikeIron provides a PHP 5 client to StrikeIron web services. See the following sections: ZendServiceStrikeIron Bundled Services Advanced Use
334.1 Overview
StrikeIron offers hundreds of commercial data services (Data as a Service) such as Online Sales Tax, Currency Rates, Stock Quotes, Geocodes, Global Address Verication, Yellow/White Pages, MapQuest Driving Directions, Dun & Bradstreet Business Credit Checks, and much, much more. Each StrikeIron web service shares a standard SOAP (and REST) API, making it easy to integrate and manage multiple services. StrikeIron also manages customer billing for all services in a single account, making it perfect for solution providers. Get started with free web services at http://www.strikeiron.com/sdp. StrikeIrons services may be used through the PHP 5 SOAP extension alone. However, using StrikeIron this way does not give an ideal PHP-like interface. The ZendService\StrikeIron component provides a lightweight layer on top of the SOAP extension for working with StrikeIron services in a more convenient, PHP-like manner. Note: The PHP 5 SOAP extension must be installed and enabled to use ZendService\StrikeIron. The ZendService\StrikeIron component provides: A single point for conguring your StrikeIron authentication credentials that can be used across many StrikeIron services. A standard way of retrieving your StrikeIron subscription information such as license status and the number of hits remaining to a service. The ability to use any StrikeIron service from its WSDL without creating a PHP wrapper class, and the option of creating a wrapper for a more convenient interface. Wrappers for three popular StrikeIron services.
1415
$strikeIron = new ZendService\StrikeIron\StrikeIron(array(username => your-username, password => your-password)); $taxBasic = $strikeIron->getService(array(class => SalesUseTaxBasic));
The getService() method will return a client for any StrikeIron service by the name of its PHP wrapper class. In this case, the name SalesUseTaxBasic refers to the wrapper class ZendService\StrikeIron\SalesUseTaxBasic. Wrappers are included for three services and described in Bundled Services. The getService() method can also return a client for a StrikeIron service that does not yet have a PHP wrapper. This is explained in Using Services by WSDL.
$strikeIron = new ZendService\StrikeIron\StrikeIron(array(username => your-username, password => your-password)); // Get a client for the Sales & Use Tax Basic service $taxBasic = $strikeIron->getService(array(class => SalesUseTaxBasic)); // Query tax rate for Ontario, Canada $rateInfo = $taxBasic->getTaxRateCanada(array(province => ontario)); echo $rateInfo->province;
1416
10 11
In the example above, the getService() method is used to return a client to the Sales & Use Tax Basic service. The client object is stored in $taxBasic. The getTaxRateCanada() method is then called on the service. An associative array is used to supply keyword parameters to the method. This is the way that all StrikeIron methods are called. The result from getTaxRateCanada() is stored in $rateInfo and has properties like province and GST. Many of the StrikeIron services are as simple to use as the example above. See Bundled Services for detailed information on three StrikeIron services.
<?php $strikeIron = new ZendService\StrikeIron\StrikeIron(array(username => your-username, password => your-password)); $taxBasic = $strikeIron->getService(array(class => SalesUseTaxBasic)); $rateInfo = $taxBasic->getTaxRateCanada(array(province => ontario)); print_r($rateInfo); ?> ZendService\StrikeIron\Decorator Object ( [_name:protected] => GetTaxRateCanadaResult [_object:protected] => stdClass Object ( [abbreviation] => ON [province] => ONTARIO [GST] => 0.06 [PST] => 0.08 [total] => 0.14 [HST] => Y ) )
In the output above, we see that the decorator ($rateInfo) wraps an object named GetTaxRateCanadaResult, the result of the call to getTaxRateCanada(). This means that $rateInfo has public properties like abbreviation, province>, and GST. These are accessed like $rateInfo->province. Tip: StrikeIron result properties sometimes start with an uppercase letter such as Foo or Bar where most PHP object properties normally start with a lowercase letter as in foo or bar. The decorator will automatically do this inection so you may read a property Foo as foo.
1417
If you ever need to get the original object or its name out of the decorator, use the respective methods getDecoratedObject() and getDecoratedObjectName().
$strikeIron = new ZendService\StrikeIron\StrikeIron(array(username => your-username, password => your-password)); $taxBasic = $strikeIron->getService(array(class => SalesUseTaxBasic)); try { $taxBasic->getTaxRateCanada(array(province => ontario)); } catch (ZendService\StrikeIron\Exception\RuntimeException $e) { // error handling for events like connection // problems or subscription errors }
The exceptions thrown will always be ZendService\StrikeIron\Exception. Its important to understand the difference between exceptions and normal failed method calls. Exceptions occur for exceptional conditions, such as the network going down or your subscription expiring. Failed method calls that are a common occurrence, such as getTaxRateCanada() not nding the province you supplied, will not result an in exception. Note: Every time you make a method call to a StrikeIron service, you should check the response object for validity and also be prepared to catch an exception.
// Get a client for the Sales & Use Tax Basic service $strikeIron = new ZendService\StrikeIron\StrikeIron(array(username => your-username, password => your-password)); $taxBasic = $strikeIron->getService(array(class => SalesUseTaxBasic));
1418
7 8 9
// Check remaining hits for the Sales & Use Tax Basic service $subscription = $taxBasic->getSubscriptionInfo(); echo $subscription->remainingHits;
The getSubscriptionInfo() method will return an object that typically has a remainingHits property. Its important to check the status on each service that you are using. If a method call is made to StrikeIron after the remaining hits have been used up, an exception will occur. Checking your subscription to a service does not use any remaining hits to the service. Each time any method call to the service is made, the number of hits remaining will be cached and this cached value will be returned by getSubscriptionInfo() without connecting to the service again. To force getSubscriptionInfo() to override its cache and query the subscription information again, use getSubscriptionInfo(true).
1419
1420
CHAPTER 335
ZendServiceTechnorati
335.1 Introduction
ZendService\Technorati provides an easy, intuitive and object-oriented interface for using the Technorati API. It provides access to all available Technorati API queries and returns the original XML response as a friendly PHP object. Technorati is one of the most popular blog search engines. The API interface enables developers to retrieve information about a specic blog, search blogs matching a single tag or phrase and get information about a specic author (blogger). For a full list of available queries please see the Technorati API documentation or the Available Technorati queries section of this document.
1421
Sending your rst query // create a new ZendService\Technorati // with a valid API_KEY $technorati = new ZendService\Technorati\Technorati(VALID_API_KEY); // search Technorati for PHP keyword $resultSet = $technorati->search(PHP);
1 2 3 4 5 6
Each query method accepts an array of optional parameters that can be used to rene your query.
Rening your query // create a new ZendService\Technorati // with a valid API_KEY $technorati = new ZendService\Technorati\Technorati(VALID_API_KEY); // filter your query including only results // with some authority (Results from blogs with a handful of links) $options = array(authority => a4); // search Technorati for PHP keyword $resultSet = $technorati->search(PHP, $options);
1 2 3 4 5 6 7 8 9 10
A ZendService\Technorati instance is not a single-use object. That is, you dont need to create a new instance for each query call; simply use your current ZendService\Technorati object as long as you need it.
Sending multiple queries with the same ZendServiceTechnorati instance // create a new ZendService\Technorati // with a valid API_KEY $technorati = new ZendService\Technorati\Technorati(VALID_API_KEY); // search Technorati for PHP keyword $search = $technorati->search(PHP); // get top tags indexed by Technorati $topTags = $technorati->topTags();
1 2 3 4 5 6 7 8 9
1422
Consuming a result set object // create a new ZendService\Technorati // with a valid API_KEY $technorati = new ZendService\Technorati\Technorati(VALID_API_KEY); // search Technorati for PHP keyword // $resultSet is an instance of ZendService\Technorati\SearchResultSet $resultSet = $technorati->search(PHP); // loop over all result objects foreach ($resultSet as $result) { // $result is an instance of ZendService\Technorati\SearchResult }
1 2 3 4 5 6 7 8 9 10 11 12
Because ZendService\Technorati\ResultSet implements the SeekableIterator interface, you can seek a specic result object using its position in the result collection.
Seeking a specic result set object // create a new ZendService\Technorati\Technorati // with a valid API_KEY $technorati = new ZendService\Technorati\Technorati(VALID_API_KEY); // search Technorati for PHP keyword // $resultSet is an instance of ZendService\Technorati\SearchResultSet $resultSet = $technorati->search(PHP); // $result is an instance of ZendService\Technorati\SearchResult $resultSet->seek(1); $result = $resultSet->current();
1 2 3 4 5 6 7 8 9 10 11
Note: SeekableIterator works as an array and counts positions starting from index 0. Fetching position number 1 means getting the second result in the collection. The second group is represented by special standalone result objects. ZendService\Technorati\GetInfoResult, ZendService\Technorati\BlogInfoResult and ZendService\Technorati\KeyInfoResult act as wrappers for additional objects, such as ZendService\Technorati\Author and ZendService\Technorati\Weblog.
Consuming a standalone result object // create a new ZendService\Technorati\Technorati // with a valid API_KEY $technorati = new ZendService\Technorati\Technorati(VALID_API_KEY); // get info about weppos author $result = $technorati->getInfo(weppos); $author = $result->getAuthor(); echo <h2>Blogs authored by . $author->getFirstName() . " " . $author->getLastName() . </h2>; echo <ol>;
1 2 3 4 5 6 7 8 9 10 11
1423
12 13 14 15
Please read the ZendServiceTechnorati Classes section for further details about response classes.
catch block.
1 2 3 4 5 6
1 2 3 4 5 6
1424
1 2 3 4 5 6 7 8 9 10 11
1 2 3 4 5 6 7
1425
8 9 10 11
1 2 3 4 5 6 7 8 9 10 11
1 2 3 4 5 6 7 8
1426
TopTags Query $technorati = new ZendService\Technorati\Technorati(VALID_API_KEY); $resultSet = $technorati->topTags(); echo "<p>Reading " . $resultSet->totalResults() . " of " . $resultSet->totalResultsAvailable() . " available results</p>"; echo "<ol>"; foreach ($resultSet as $result) { echo "<li>" . $result->getTag() . "</li>"; } echo "</ol>";
1 2 3 4 5 6 7 8 9 10 11
1 2 3 4 5
1 2 3 4 5 6 7 8 9 10 11
1427
1 2 3 4 5 6 7 8 9 10 11
ZendServiceTechnoratiGetInfoResult ZendServiceTechnoratiBlogInfoResult ZendServiceTechnoratiKeyInfoResult Note: ZendService\Technorati\GetInfoResult, ZendService\Technorati\BlogInfoResult and ZendService\Technorati\KeyInfoResult represent exceptions to the above because they dont belong to a result set and they dont implement any interface. They represent a single response object and they act as a wrapper for additional ZendService\Technorati objects, such as ZendService\Technorati\Author and ZendService\Technorati\Weblog. The ZendService\Technorati library includes additional convenient classes representing specic response objects. ZendService\Technorati\Author represents a single Technorati account, also known as a blog author or blogger. ZendService\Technorati\Weblog represents a single weblog object, along with all specic weblog properties such as feed URLs or blog name. For full details please see ZendService\Technorati in the API reference guide.
335.8.1 ZendServiceTechnoratiResultSet
ZendService\Technorati\ResultSet is the most essential result set. The scope of this class is to be extended by a query-specic child result set class, and it should never be used to initialize a standalone object. Each of the specic result sets represents a collection of query-specic ZendServiceTechnoratiResult objects. ZendService\Technorati\ResultSet implements the PHP SeekableIterator interface, and you can iterate all result objects via the PHP foreach() statement.
Iterating result objects from a resultset collection // run a simple query $technorati = new ZendService\Technorati\Technorati(VALID_API_KEY); $resultSet = $technorati->search(php); // $resultSet is now an instance of // ZendService\Technorati\SearchResultSet // it extends ZendService\Technorati\ResultSet foreach ($resultSet as $result) { // do something with your // ZendService\Technorati\SearchResult object }
1 2 3 4 5 6 7 8 9 10 11
335.8.2 ZendServiceTechnoratiCosmosResultSet
ZendService\Technorati\CosmosResultSet represents a Technorati Cosmos query result set. Note: ZendService\Technorati\CosmosResultSet extends ZendServiceTechnoratiResultSet.
335.8.3 ZendServiceTechnoratiSearchResultSet
ZendService\Technorati\SearchResultSet represents a Technorati Search query result set.
1429
335.8.4 ZendServiceTechnoratiTagResultSet
ZendService\Technorati\TagResultSet represents a Technorati Tag query result set. Note: ZendService\Technorati\TagResultSet extends ZendServiceTechnoratiResultSet.
335.8.5 ZendServiceTechnoratiDailyCountsResultSet
ZendService\Technorati\DailyCountsResultSet represents a Technorati DailyCounts query result set. Note: ZendService\Technorati\DailyCountsResultSet extends ZendServiceTechnoratiResultSet.
335.8.6 ZendServiceTechnoratiTagsResultSet
ZendService\Technorati\TagsResultSet represents a Technorati TopTags or BlogPostTags queries result set. Note: ZendService\Technorati\TagsResultSet extends ZendServiceTechnoratiResultSet.
335.8.7 ZendServiceTechnoratiResult
ZendService\Technorati\Result is the most essential result object. The scope of this class is to be extended by a query specic child result class, and it should never be used to initialize a standalone object.
335.8.8 ZendServiceTechnoratiCosmosResult
ZendService\Technorati\CosmosResult represents a single Technorati Cosmos query result object. It is never returned as a standalone object, but it always belongs to a valid ZendServiceTechnoratiCosmosResultSet object. Note: ZendService\Technorati\CosmosResult extends ZendServiceTechnoratiResult.
335.8.9 ZendServiceTechnoratiSearchResult
ZendService\Technorati\SearchResult represents a single Technorati Search query result object. It is never returned as a standalone object, but it always belongs to a valid ZendServiceTechnoratiSearchResultSet object. Note: ZendService\Technorati\SearchResult extends ZendServiceTechnoratiResult.
1430
335.8.10 ZendServiceTechnoratiTagResult
ZendService\Technorati\TagResult represents a single Technorati Tag query result object. It is never returned as a standalone object, but it always belongs to a valid ZendServiceTechnoratiTagResultSet object. Note: ZendService\Technorati\TagResult extends ZendServiceTechnoratiResult.
335.8.11 ZendServiceTechnoratiDailyCountsResult
ZendService\Technorati\DailyCountsResult represents a single Technorati DailyCounts query result object. It is never returned as a standalone object, but it always belongs to a valid ZendServiceTechnoratiDailyCountsResultSet object. Note: ZendService\Technorati\DailyCountsResult extends ZendServiceTechnoratiResult.
335.8.12 ZendServiceTechnoratiTagsResult
ZendService\Technorati\TagsResult represents a single Technorati TopTags or BlogPostTags query result object. It is never returned as a standalone object, but it always belongs to a valid ZendServiceTechnoratiTagsResultSet object. Note: ZendService\Technorati\TagsResult extends ZendServiceTechnoratiResult.
335.8.13 ZendServiceTechnoratiGetInfoResult
ZendService\Technorati\GetInfoResult represents a single Technorati GetInfo query result object.
335.8.14 ZendServiceTechnoratiBlogInfoResult
ZendService\Technorati\BlogInfoResult represents a single Technorati BlogInfo query result object.
335.8.15 ZendServiceTechnoratiKeyInfoResult
ZendService\Technorati\KeyInfoResult represents a single Technorati KeyInfo query result object. It provides information about your Technorati API Key daily usage.
1431
1432
CHAPTER 336
ZendServiceTwitter
336.1 Introduction
ZendService\Twitter provides a client for the Twitter API. ZendService\Twitter allows you to query the public timeline. If you provide a username and OAuth details for Twitter, or your access token and secret, it will allow you to get and update your status, reply to friends, direct message friends, mark tweets as favorites, and much more. ZendService\Twitter wraps all web service operations, including OAuth, and all methods return an instance of ZendService\Twitter\Response. ZendService\Twitter is broken up into subsections so you can easily identify which type of call is being requested. account allows you to check that your account credentials are valid application allows you to check your API rate limits. blocks blocks and unblocks users from following you. directMessages retrieves the authenticated users received direct messages, deletes direct messages, and sends new direct messages. favorites lists, creates, and removes favorite tweets. friendships creates and removes friendships for the authenticated user. search allows you to search statuses for specic criteria. statuses retrieves the public and user timelines and shows, updates, destroys, and retrieves replies for the authenticated user. users retrieves friends and followers for the authenticated user and returns extended information about a passed user.
Go to https://dev.twitter.com/apps Either create a new application, or select an existing one. On the applications settings page, grab the following information: From the header OAuth settings, grab the Consumer key and Consumer secret values. From the header Your access token, grab the Access token and Access token secret values. Armed with this information, you can ZendService_Twitter\Twitter\Twitter instance:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
now
congure
and
create
your
$config = array( access_token => array( token => twitter-access-token-here, secret => twitter-access-secret-here, ), oauth_options => array( consumerKey => twitter-consumer-key-here, consumerSecret => twitter-consumer-secret-here, ), http_client_options => array( adapter => Zend\Http\Client\Adapter\Curl, curloptions => array( CURLOPT_SSL_VERIFYHOST => false, CURLOPT_SSL_VERIFYPEER => false, ), ), ); $twitter = new Twitter($config);
Make sure you substitute the values you discovered earlier in the conguration before attempting to connect. Note: Twitter has a known issue with the SSL certicate for their API endpoints, which requires that you use insecure settings for the SSL certicate verication. Once you have the client congured, you can start consuming it:
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// Verify your credentials: $response = $twitter->account->verifyCredentials(); if (!$response->isSuccess()) { die(Something is wrong with my credentials!); } // Search for something: $response = $twitter->search->tweets(#zf2); foreach ($response->toValue() as $tweet) { printf("%s\n- (%s)\n", $tweet->text, $tweet->user->name); } // Tweet something: $twitter->statuses->update(Hello world!);
Every action you take returns a ZendService_Twitter\Twitter\Response object. This object contains some general purpose methods for determining the status of the response (isSuccess(), isError()), and otherwise acts as a value object containing the data returned. Essentially, if the response returns an object, you will be able to access the members listed by the Twitter API documentation. In the case of responses that return arrays, such
1434
as the $twitter->search->tweets() example shown earlier, you should use the toValue() method of the response to retrieve the array. If you wish to dive in more into how authentication works, and what methods are exposed, keep reading!
336.3 Authentication
With the exception of fetching the public timeline, ZendService\Twitter requires authentication as a valid user. This is achieved using the OAuth authentication protocol. OAuth is the only supported authentication mode for Twitter as of August 2010. The OAuth implementation used by ZendService\Twitter is ZendOAuth.
Creating the Twitter Class
ZendService\Twitter must authorize itself, on behalf of a user, before use with the Twitter API (except for public timeline). This must be accomplished using OAuth since Twitter has disabled its basic HTTP authentication as of August 2010. There are two options to establishing authorization. The rst is to implement the workow of ZendOAuth via ZendService\Twitter which proxies to an internal ZendOAuth\Consumer object. Please refer to the ZendOAuth documentation for a full example of this workow - you can call all documented ZendOAuth\Consumer methods on ZendService\Twitter including constructor options. You may also use ZendOAuth directly and only pass the resulting access token into ZendService\Twitter. This is the normal workow once you have established a reusable access token for a particular Twitter user. The resulting OAuth access token should be stored to a database for future use (otherwise you will need to authorize for every new instance of ZendService\Twitter). Bear in mind that authorization via OAuth results in your user being redirected to Twitter to give their consent to the requested authorization (this is not repeated for stored access tokens). This will require additional work (i.e. redirecting users and hosting a callback URL) over the previous HTTP authentication mechanism where a user just needed to allow applications to store their username and password. The following example demonstrates setting up ZendService\Twitter which is given an already established OAuth access token. Please refer to the ZendOAuth documentation to understand the workow involved. The access token is a serializable object, so you may store the serialized object to a database, and unserialize it at retrieval time before passing the objects into ZendService\Twitter. The ZendOAuth documentation demonstrates the workow and objects involved.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
/** * We assume $serializedToken is the serialized token retrieved from a database * or even $_SESSION (if following the simple ZendOAuth documented example) */ $token = unserialize($serializedToken); $twitter = new ZendService\Twitter\Twitter(array( accessToken => $token, oauth_options => array( username => johndoe, ), )); // verify users credentials with Twitter $response = $twitter->account->verifyCredentials();
Note: In order to authenticate with Twitter, ALL applications MUST be registered with Twitter in order to receive a Consumer Key and Consumer Secret to be used when authenticating with OAuth. This can not be reused across multiple applications - you must register each new application separately. Twitter access tokens have no expiry date, 336.3. Authentication 1435
so storing them to a database is advised (they can, of course, be refreshed simply be repeating the OAuth authorization process). This can only be done while interacting with the user associated with that access token. The previous pre-OAuth version of ZendService\Twitter allowed passing in a username as the rst parameter rather than within an array. This is no longer supported. If you have registered an application with Twitter, you can also use the access token and access token secret they provide you in order to setup the OAuth consumer. This can be done as follows:
1 2 3 4 5 6 7 8 9 10
$twitter = new Zend_Service_Twitter(array( access_token => array( // or use "accessToken" as the key; both work token => your-access-token, secret => your-access-token-secret, ), oauth_options => array( // or use "oauthOptions" as the key; both work consumerKey => your-consumer-key, consumerSecret => your-consumer-secret, ), ));
If desired, you can also specify a specic HTTP client instance to use, or provide conguration for the HTTP client. To provide the HTTP client, use the http_client or httpClient key, and provide an instance. To provide HTTP client conguration for setting up an instance, use the key http_client_options or httpClientOptions. As a full example:
1 2 3 4 5 6 7 8 9 10 11 12 13
$twitter = new Zend_Service_Twitter(array( access_token => array( // or use "accessToken" as the key; both work token => your-access-token, secret => your-access-token-secret, ), oauth_options => array( // or use "oauthOptions" as the key; both work consumerKey => your-consumer-key, consumerSecret => your-consumer-secret, ), http_client_options => array( adapter => Zend_Http_Client_Adapter_Curl, ), ));
1 2
1436
Rating limit status $twitter = new ZendService\Twitter\Twitter($options); $response = $twitter->application->rateLimitStatus(); $userTimelineLimit = $response->resources->statuses->{/statuses/user_timeline}->remaining;
1 2 3
1 2
destroy() un-blocks the user specied in the id parameter for the authenticating user. Returns the un-blocked user in the requested format when successful.
Removing a block $twitter = new ZendService\Twitter\Twitter($options); $response = $twitter->blocks->destroy(blockeduser);
1 2
ids() returns an array of user identiers that the authenticating user is blocking.
Who are you blocking (identiers only) $twitter = new ZendService\Twitter\Twitter($options); $response = $twitter->blocks->ids();
1 2
list() returns an array of user objects that the authenticating user is blocking.
Who are you blocking $twitter = new ZendService\Twitter\Twitter($options); $response = $twitter->blocks->list();
1 2
1437
1 2
The message() method accepts an array of optional parameters to modify the query. since_id narrows the returned results to just those statuses after the specied identier (up to 24 hours old). max_id narrows the returned results to just those statuses earlier than the specied identier. count species the number of statuses to return, up to 200. skip_status, when set to boolean true, t, or 1 will skip including a users most recent status in the results. include_entities controls whether or not entities, which includes URLs, mentioned users, and hashtags, will be returned. sent() returns a list of the 20 most recent direct messages sent by the authenticating user.
Retrieving recent direct messages sent $twitter = new ZendService\Twitter\Twitter($options); $response = $twitter->directMessages->sent();
1 2
The sent() method accepts an array of optional parameters to modify the query. count species the number of statuses to return, up to 20. page species the page of results to return, based on the count provided. since_id narrows the returned results to just those statuses after the specied identier (up to 24 hours old). max_id narrows the returned results to just those statuses earlier than the specied identier. include_entities controls whether or not entities, which includes URLs, mentioned users, and hashtags, will be returned. new() sends a new direct message to the specied user from the authenticating user. Requires both the user and text parameters below.
Sending a direct message $twitter = new ZendService\Twitter\Twitter($options); $response = $twitter->directMessages->new(myfriend, mymessage);
1 2
destroy() destroys the direct message specied in the required id parameter. The authenticating user must be the recipient of the specied direct message.
Deleting a direct message $twitter = new ZendService\Twitter\Twitter($options); $response = $twitter->directMessages->destroy(123548);
1 2
1 2
The list() method accepts an array of optional parameters to modify the query. user_id species the ID of the user for whom to return the timeline. screen_name species the screen name of the user for whom to return the timeline. since_id narrows the returned results to just those statuses after the specied identier (up to 24 hours old). max_id narrows the returned results to just those statuses earlier than the specied identier. count species the number of statuses to return, up to 200. include_entities controls whether or not entities, which includes URLs, mentioned users, and hashtags, will be returned. create() favorites the status specied in the id parameter as the authenticating user.
Creating favorites $twitter = new ZendService\Twitter\Twitter($options); $response = $twitter->favorites->create(12351);
1 2
destroy() un-favorites the status specied in the id parameter as the authenticating user.
Deleting a favorite $twitter = new ZendService\Twitter\Twitter($options); $response = $twitter->favorites->destroy(12351);
1 2
1 2
destroy() discontinues friendship with the user specied in the id parameter and the authenticating user.
Deleting a friend $twitter = new ZendService\Twitter\Twitter($options); $response = $twitter->friendships->destroy(myoldfriend);
1 2
1439
1 2
The tweets() method accepts an optional second argument, array of optional parameters to modify the query. since_id narrows the returned results to just those statuses after the specied identier (up to 24 hours old). max_id narrows the returned results to just those statuses earlier than the specied identier. count species the number of statuses to return, up to 200. include_entities controls whether or not entities, which includes URLs, mentioned users, and hashtags, will be returned. lang indicates which two-letter language code to restrict results to. locale indicates which two-letter language code is being used in the query. geocode can be used to indicate the geographical radius in which tweets should originate; the string should be in the form latitude,longitude,radius, with radius being a unit followed by one of mi or km. result_type indicates what type of results to retrieve, and should be one of mixed, recent, or popular. until can be used to specify a the latest date for which to return tweets.
1 2
homeTimeline() returns the 20 most recent statuses posted by the authenticating user and that users friends.
1 2
The homeTimeline() method accepts an array of optional parameters to modify the query. since_id narrows the returned results to just those statuses after the specied identier (up to 24 hours old). max_id narrows the returned results to just those statuses earlier than the specied identier. 1440 Chapter 336. ZendServiceTwitter
count species the number of statuses to return, up to 200. trim_user, when set to boolean true, t, or 1, will list the author identier only in embedded user objects in the statuses returned. contributor_details, when set to boolean true, will return the screen name of any contributors to a status (instead of only the contributor identier). include_entities controls whether or not entities, which includes URLs, mentioned users, and hashtags, will be returned. exclude_replies controls whether or not status updates that are in reply to other statuses will be returned. userTimeline() returns the 20 most recent statuses posted from the authenticating user.
Retrieving the user timeline $twitter = new ZendService\Twitter\Twitter($options); $response = $twitter->statuses->userTimeline();
1 2
The userTimeline() method accepts an array of optional parameters to modify the query. user_id species the ID of the user for whom to return the timeline. screen_name species the screen name of the user for whom to return the timeline. since_id narrows the returned results to just those statuses after the specied identier (up to 24 hours old). max_id narrows the returned results to just those statuses earlier than the specied identier. count species the number of statuses to return, up to 200. trim_user, when set to boolean true, t, or 1, will list the author identier only in embedded user objects in the statuses returned. contributor_details, when set to boolean true, will return the screen name of any contributors to a status (instead of only the contributor identier). include_rts controls whether or not to include native retweets in the returned list. exclude_replies controls whether or not status updates that are in reply to other statuses will be returned. show() returns a single status, specied by the id parameter below. The status author will be returned inline.
Showing user status $twitter = new ZendService\Twitter\Twitter($options); $response = $twitter->statuses->show(1234);
1 2
update() updates the authenticating users status. This method requires that you pass in the status update that you want to post to Twitter.
Updating user status $twitter = new ZendService\Twitter\Twitter($options); $response = $twitter->statuses->update(My Great Tweet);
1 2
The update() method accepts a second additional parameter. inReplyTo_StatusId species the ID of an existing status that the status to be posted is in reply to. 336.11. Status Methods 1441
mentionsTimeline() returns the 20 most recent @replies (status updates prexed with @username) for the authenticating user.
Showing user replies $twitter = new ZendService\Twitter\Twitter($options); $response = $twitter->statuses->mentionsTimeline();
1 2
The mentionsTimeline() method accepts an array of optional parameters to modify the query. since_id narrows the returned results to just those statuses after the specied identier (up to 24 hours old). max_id narrows the returned results to just those statuses earlier than the specied identier. count species the number of statuses to return, up to 200. trim_user, when set to boolean true, t, or 1, will list the author identier only in embedded user objects in the statuses returned. contributor_details, when set to boolean true, will return the screen name of any contributors to a status (instead of only the contributor identier). include_entities controls whether or not entities, which includes URLs, mentioned users, and hashtags, will be returned. destroy() destroys the status specied by the required id parameter.
Deleting user status $twitter = new ZendService\Twitter\Twitter($options); $response = $twitter->statuses->destroy(12345);
1 2
1 2
1 2
The search() method accepts an array of optional parameters to modify the query. count species the number of statuses to return, up to 20.
1442
page species the page of results to return, based on the count provided. include_entities controls whether or not entities, which includes URLs, mentioned users, and hashtags, will be returned.
1443
1444
CHAPTER 337
ZendServiceWindowsAzure
337.1 Introduction
Windows Azure is the name for Microsofts Software + Services platform, an operating system in the cloud providing services for hosting, management, scalable storage with support for simple blobs, tables, and queues, as well as a management infrastructure for provisioning and geo-distribution of cloud-based services, and a development platform for the Azure Services layer.
337.4 Features
ZendService\WindowsAzure provides the following functionality: 1445
PHP classes for Windows Azure Blobs, Tables and Queues (for CRUD operations) Helper Classes for HTTP transport, AuthN, AuthZ, REST and Error Management Manageability, Instrumentation and Logging support
337.5 Architecture
ZendService\WindowsAzure provides access to Windows Azures storage, computation and management interfaces by abstracting the REST -XML interface Windows Azure provides into a simple PHP API. An application built using ZendService\WindowsAzure can access Windows Azures features, no matter if it is hosted on the Windows Azure platform or on an in-premise web server.
1446
CHAPTER 338
ZendServiceWindowsAzureStorageBlob
Blob Storage stores sets of binary data. Blob storage offers the following three resources: the storage account, containers, and blobs. Within your storage account, containers provide a way to organize sets of blobs within your storage account. Blob Storage is offered by Windows Azure as a REST API which is wrapped by the ZendService\WindowsAzure\Storage\Blob class in order to provide a native PHP interface to the storage account.
1 2 3 4
1447
1 2
1 2 3 4 5 6 7 8
1 2 3 4 5 6 7 8
1 2 3
1448
4 5 6
1 2 3 4 5 6 7
1 2 3 4 5
In order to do this, the Windows Azure SDK for PHP blob storage client must be registered as a stream wrapper. This can be done by calling the registerStreamWrapper() method:
1449
Registering the blob storage stream wrapper $storageClient = new ZendService\WindowsAzure\Storage\Blob(); // registers azure:// on this storage client $storageClient->registerStreamWrapper();
1 2 3 4 5 6 7 8 9
http://phpstorage.blob.core.windows.net/phpazuretestshared1?st=2009-08-17T09%3A06%3A17Z&se=2009-08-17
The above signature gives write access to the phpazuretestshared1 container of the phpstorage account.
1 2 3 4 5 6 7 8 9
The following example code will generate a Shared Access Signature for read access in a blob named test.txt in a container named container1 within a time frame of 3000 seconds.
1450
Generating a Shared Access Signature for a blob $storageClient = $sharedAccessUrl = container1, test.txt, b, r, $storageClient $storageClient ); new ZendService\WindowsAzure\Storage\Blob(); $storageClient->generateSharedAccessUrl(
1 2 3 4 5 6 7 8 9
http://phpstorage.blob.core.windows.net/phpazuretestshared1?st=2009-08-17T09%3A06%3A17Z&se=2009-08-17
The above signature gives write access to the phpazuretestshared1 container of the phpstorage account. Since the shared key for the account is not known, the Shared Access Signature can be used to work with the authorized resource.
Consuming a Shared Access Signature for a container
1 2 3 4 5 6 7 8 9 10 11 12
$storageClient = new ZendService\WindowsAzure\Storage\Blob( blob.core.windows.net, phpstorage, ); $storageClient->setCredentials( new ZendService\WindowsAzure\Credentials\SharedAccessSignature() ); $storageClient->getCredentials()->setPermissionSet(array( http://phpstorage.blob.core.windows.net/phpazuretestshared1?st=2009-08-17T09%3A06%3A17Z&se=2009)); $storageClient->putBlob( phpazuretestshared1, NewBlob.txt, C:\Files\dataforazure.txt );
Note that there was no explicit permission to write to a specic blob. Instead, the Windows Azure SDK for PHP determined that a permission was required to either write to that specic blob, or to write to its container. Since only a signature was available for the latter, the Windows Azure SDK for PHP chose those credentials to perform the request on Windows Azure blob storage.
1451
1452
CHAPTER 339
ZendServiceWindowsAzureStorageTable
The Table service offers structured storage in the form of tables. Table Storage is offered by Windows Azure as a REST API which is wrapped by the ZendService\WindowsAzure\Storage\Table class in order to provide a native PHP interface to the storage account. This topic lists some examples of using the ZendService\WindowsAzure\Storage\Table class. Other features are available in the download package, as well as a detailed API documentation of those features. Note that development table storage (in the Windows Azure SDK ) does not support all features provided by the API. Therefore, the examples listed on this page are to be used on Windows Azure production table storage.
1 2 3 4 5 6
1453
Listing all tables $storageClient = new ZendService\WindowsAzure\Storage\Table( table.core.windows.net, myaccount, myauthkey ); $result = $storageClient->listTables(); foreach ($result as $table) { echo Table name is: . $table->Name . "\r\n"; }
1 2 3 4 5 6 7
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
Note that if no schema class is passed into table storage methods, ZendService\WindowsAzure\Storage\Table automatically works with ZendService\WindowsAzure\Storage\DynamicTableEntity.
1454
vides some basic functionality for the ZendService\WindowsAzure\Storage\Table class to work with a client-side schema. Base properties provided by ZendService\WindowsAzure\Storage\TableEntity are: PartitionKey (exposed through getPartitionKey() and setPartitionKey()) RowKey (exposed through getRowKey() and setRowKey()) Timestamp (exposed through getTimestamp() and setTimestamp()) Etag value (exposed through getEtag() and setEtag()) Heres a sample class inheriting ZendService\WindowsAzure\Storage\TableEntity:
Sample enforced schema class class SampleEntity extends ZendService\WindowsAzure\Storage\TableEntity { /** * @azure Name */ public $Name; /** * @azure Age Edm.Int64 */ public $Age; /** * @azure Visible Edm.Boolean */ public $Visible = false; }
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
The ZendService\WindowsAzure\Storage\Table class will map any class inherited from ZendService\WindowsAzure\Storage\TableEntity to Windows Azure table storage entities with the correct data type and property name. All there is to storing a property in Windows Azure is adding a docblock comment to a public property or public getter/setter, in the following format:
Enforced property /** * @azure <property name in Windows Azure> <optional property type> */ public $<property name in PHP>;
1 2 3 4
Lets see how to dene a property Age as an integer on Windows Azure table storage:
Sample enforced property /** * @azure Age Edm.Int64 */ public $Age;
1 2 3 4
1455
Note that a property does not necessarily have to be named the same on Windows Azure table storage. The Windows Azure table storage property name can be dened as well as the type. The following data types are supported: Edm.Binary- An array of bytes up to 64 KB in size. Edm.Boolean- A boolean value. Edm.DateTime- A 64-bit value expressed as Coordinated Universal Time (UTC). The supported DateTime range begins from 12:00 midnight, January 1, 1601 A.D. (C.E.), Coordinated Universal Time (UTC). The range ends at December 31st, 9999. Edm.Double- A 64-bit oating point value. Edm.Guid- A 128-bit globally unique identier. Edm.Int32- A 32-bit integer. Edm.Int64- A 64-bit integer. Edm.String- A UTF-16-encoded value. String values may be up to 64 KB in size.
1 2 3 4 5
1 2 3 4 5
1456
6 7 8
The ZendService\WindowsAzure\Storage\Table class automatically works with ZendService\WindowsAzure\Storage\TableEntity if no specic class is passed into Table Storage methods.
1 2 3 4 5 6 7 8 9 10 11 12 13
1 2 3 4 5 6
1457
Updating an entity $storageClient = new ZendService\WindowsAzure\Storage\Table( table.core.windows.net, myaccount, myauthkey ); $entity = $storageClient->retrieveEntityById( testtable, partition1, row1, SampleEntity ); $entity->Name = New name; $result = $storageClient->updateEntity(testtable, $entity);
1 2 3 4 5 6 7 8 9
If you want to make sure the entity has not been updated before, you can make sure the Etag of the entity is checked. If the entity already has had an update, the update will fail to make sure you do not overwrite any newer data.
Updating an entity (with Etag check) $storageClient = new ZendService\WindowsAzure\Storage\Table( table.core.windows.net, myaccount, myauthkey ); $entity = $storageClient->retrieveEntityById( testtable, partition1, row1, SampleEntity ); $entity->Name = New name; // last parameter instructs the Etag check: $result = $storageClient->updateEntity(testtable, $entity, true);
1 2 3 4 5 6 7 8 9 10 11
1 2 3 4 5 6 7
Performing queries using a lter condition $storageClient = new ZendService\WindowsAzure\Storage\Table( table.core.windows.net, myaccount, myauthkey ); $entities = $storageClient->storageClient->retrieveEntities( testtable, Name eq \Maarten\ and PartitionKey eq \partition1\, SampleEntity ); foreach ($entities as $entity) { echo Name: . $entity->Name . "\n"; }
1 2 3 4 5 6 7 8 9 10 11 12
Using the following code, a table can be queried using a uent interface. Note that the table and entities have already been created before.
Performing queries using a uent interface $storageClient = new ZendService\WindowsAzure\Storage\Table( table.core.windows.net, myaccount, myauthkey ); $entities = $storageClient->storageClient->retrieveEntities( testtable, $storageClient->select() ->from($tableName) ->where(Name eq ?, Maarten) ->andWhere(PartitionKey eq ?, partition1), SampleEntity ); foreach ($entities as $entity) { echo Name: . $entity->Name . "\n"; }
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
1 2 3 4 5 6
1459
7 8 9 10 11 12 13 14 15
// Insert entities in batch $entities = generateEntities(); foreach ($entities as $entity) { $storageClient->insertEntity($tableName, $entity); } // Commit $batch->commit();
1 2 3 4 5 6 7 8
The above classname registers the ZendService\WindowsAzure\SessionHandler session handler and will store sessions in a table called sessionstable. After registration of the ZendService\WindowsAzure\SessionHandler session handler, sessions can be started and used in the same way as a normal PHP session:
Using table storage session handler $storageClient = new ZendService\WindowsAzure\Storage\Table( table.core.windows.net, myaccount, myauthkey ); $sessionHandler = new ZendService\WindowsAzure\SessionHandler( $storageClient , sessionstable ); $sessionHandler->register(); session_start(); if (!isset($_SESSION[firstVisit])) { $_SESSION[firstVisit] = time(); }
1 2 3 4 5 6 7 8 9 10 11 12 13 14
1460
15 16
// ...
Warning: The ZendService\WindowsAzure\SessionHandler session handler should be registered before a call to session_start() is made!
1461
1462
CHAPTER 340
ZendServiceWindowsAzureStorageQueue
The Queue service stores messages that may be read by any client who has access to the storage account. A queue can contain an unlimited number of messages, each of which can be up to 8 KB in size. Messages are generally added to the end of the queue and retrieved from the front of the queue, although rst in/rst out (FIFO) behavior is not guaranteed. If you need to store messages larger than 8 KB, you can store message data as a queue or in a table and then store a reference to the data as a message in a queue. Queue Storage is offered by Windows Azure as a REST API which is wrapped by the ZendService\WindowsAzure\Storage\Queue class in order to provide a native PHP interface to the storage account.
1 2 3 4
1463
1 2
1 2 3 4
1 2 3 4 5 6 7 8
The messages that are read using getMessages() will be invisible in the queue for 30 seconds, after which the messages will re-appear in the queue. To mark a message as processed and remove it from the queue, use the deleteMessage() method.
Marking a message as processed $storageClient = new ZendService\WindowsAzure\Storage\Queue(); // retrieve 10 messages at once $messages = $storageClient->getMessages(testqueue, 10); foreach ($messages as $message) { echo $message . "\r\n"; // Mark the message as processed $storageClient->deleteMessage(testqueue, $message); }
1 2 3 4 5 6 7 8 9 10 11
1464
1 2 3 4 5 6 7 8
Note that messages that are read using peekMessages() will not become invisible in the queue, nor can they be marked as processed using the deleteMessage() method. To do this, use getMessages() instead.
1465
1466
CHAPTER 341
Copyright Information
The following copyrights are applicable to portions of Zend Framework. Copyright 2005-2013 Zend Technologies Inc. (http://www.zend.com)
1467
1468
CHAPTER 342
Overview Installation
1469
1470
CHAPTER 343
User Guide
The user guide is provided to take you through a non-trivial example, showing you various techniques and features of the framework in order to build an application. Getting Started with Zend Framework 2 Getting started: A skeleton application Modules Routing and controllers Database and models Styling and Translations Forms and actions Conclusion
1471
1472
CHAPTER 344
1473
1474
CHAPTER 345
Learning Dependency Injection Unit Testing a Zend Framework 2 application Advanced Conguration Tricks Using the EventManager Using Zend\Navigation in your Album Module Using Zend\Paginator in your Album Module Setting up a database adapter
1475
1476
CHAPTER 346
Migration
Migration from Zend Framework 1 Namespacing Old Classes Running Zend Framework 2 and Zend Framework 1 in parallel
1477
1478
CHAPTER 347
347.1 Zend\Authentication
Introduction to Zend\Authentication Database Table Authentication Digest Authentication HTTP Authentication Adapter LDAP Authentication Authentication Validator
347.2 Zend\Barcode
Introduction to Zend\Barcode Barcode creation using Zend\Barcode\Barcode class Zend\Barcode\Barcode Objects Zend\Barcode Renderers
347.3 Zend\Cache
Zend\Cache\Storage\Adapter Zend\Cache\Storage\Capabilities Zend\Cache\Storage\Plugin Zend\Cache\Pattern Zend\Cache\Pattern\CallbackCache Zend\Cache\Pattern\ClassCache Zend\Cache\Pattern\ObjectCache
1479
Zend\Cache\Pattern\OutputCache Zend\Cache\Pattern\CaptureCache
347.4 Zend\Captcha
Introduction to Zend\Captcha Captcha Operation CAPTCHA Adapters
347.5 Zend\Cong
Introduction to Zend\Cong Theory of Operation Zend\Cong\Reader Zend\Cong\Writer Zend\Cong\Processor The Factory
347.6 Zend\Console
Introduction to Zend\Console Console routes and routing Console-aware modules Console-aware action controllers Console adapters Console prompts
347.7 Zend\Crypt
Introduction to Zend\Crypt Encrypt/decrypt using block ciphers Key derivation function Password Public key cryptography
1480
347.8 Zend\Db
Zend\Db\Adapter Zend\Db\ResultSet Zend\Db\Sql Zend\Db\Sql\Ddl Zend\Db\TableGateway Zend\Db\RowGateway Zend\Db\Metadata
347.9 Zend\Di
Introduction to Zend\Di Zend\Di Quickstart Zend\Di Denition Zend\Di InstanceManager Zend\Di Conguration Zend\Di Debugging & Complex Use Cases
347.10 Zend\Dom
Introduction to Zend\Dom Zend\Dom\Query
347.11 Zend\Escaper
Introduction to Zend\Escaper Theory of Operation Conguring Zend\Escaper Escaping HTML Escaping HTML Attributes Escaping Javascript Escaping Cascading Style Sheets Escaping URLs
347.8. Zend\Db
1481
347.12 Zend\EventManager
The EventManager
347.13 Zend\Feed
Introduction to Zend\Feed Importing Feeds Retrieving Feeds from Web Pages Consuming an RSS Feed Consuming an Atom Feed Consuming a Single Atom Entry Zend\Feed and Security Zend\Feed\Reader\Reader Zend\Feed\Writer\Writer Zend\Feed\PubSubHubbub
347.14 Zend\File
Zend\File\ClassFileLocator
347.15 Zend\Filter
Introduction to Zend\Filter Standard Filter Classes Word Filters File Filter Classes Filter Chains Zend\Filter\Inector Writing Filters
347.16 Zend\Form
Introduction to Zend\Form Form Quick Start Form Collections File Uploading
1482
347.17 Zend\Http
Overview of Zend\Http The Request Class The Response Class The Headers Class HTTP Client - Overview HTTP Client - Connection Adapters HTTP Client - Advanced Usage HTTP Client - Static Usage
347.18 Zend\I18n
Translating I18n View Helpers I18n Filters I18n Validators
347.19 Zend\InputFilter
Introduction to Zend\InputFilter File Upload Input
347.20 Zend\Json
Introduction to Zend\Json Basic Usage Advanced Usage of Zend\Json XML to JSON conversion Zend\Json\Server - JSON-RPC server
347.17. Zend\Http
1483
347.21 Zend\Ldap
Introduction to Zend\Ldap API overview Usage Scenarios Tools Object-oriented access to the LDAP tree using Zend\Ldap\Node Getting information from the LDAP server Serializing LDAP data to and from LDIF
347.22 Zend\Loader
The AutoloaderFactory The StandardAutoloader The ClassMapAutoloader The ModuleAutoloader The SplAutoloader Interface The PluginClassLoader The ShortNameLocator Interface The PluginClassLocator interface The Class Map Generator utility: bin/classmap_generator.php
347.23 Zend\Log
Overview of Zend\Log Writers Filters Formatters
347.24 Zend\Mail
Introduction to Zend\Mail Zend\Mail\Message Zend\Mail\Transport Zend\Mail\Transport\SmtpOptions Zend\Mail\Transport\FileOptions
1484
347.25 Zend\Math
Introduction to Zend\Math
347.26 Zend\Mime
Zend\Mime Zend\Mime\Message Zend\Mime\Part
347.27 Zend\ModuleManager
Introduction to the Module System The Module Manager The Module Class The Module Autoloader Best Practices when Creating Modules
347.28 Zend\Mvc
Introduction to the MVC Layer Quick Start Default Services Routing The MvcEvent The SendResponseEvent Available Controllers Controller Plugins Examples
347.29 Zend\Navigation
Introduction to Zend\Navigation Quick Start Pages Containers View Helpers
347.25. Zend\Math
1485
View Helper - Breadcrumbs View Helper - Links View Helper - Menu View Helper - Sitemap View Helper - Navigation Proxy
347.30 Zend\Paginator
Introduction to Zend\Paginator Usage Conguration Advanced usage
347.31 Zend\Permissions\Acl
Introduction to Zend\Permissions\Acl Rening Access Controls Advanced Usage
347.32 Zend\Permissions\Rbac
Introduction to Zend\Permissions\Rbac Methods Examples
347.33 Zend\ProgressBar
Progress Bars File Upload Handlers
347.34 Zend\Serializer
Introduction to Zend\Serializer Zend\Serializer\Adapter
1486
347.35 Zend\Server
Introduction to Zend\Server Zend\Server\Reection
347.36 Zend\ServiceManager
Zend\ServiceManager Zend\ServiceManager Quick Start Delegator service factories Lazy Services
347.37 Zend\Session
Session Cong Session Container Session Manager Session Save Handlers Session Storage Session Validators
347.38 Zend\Soap
Zend\Soap\Server Zend\Soap\Client WSDL Accessor AutoDiscovery
347.39 Zend\Stdlib
Zend\Stdlib\Hydrator Zend\Stdlib\Hydrator\Filter Zend\Stdlib\Hydrator\Strategy Zend\Stdlib\Hydrator\Aggregate\AggregateHydrator
347.35. Zend\Server
1487
347.40 Zend\Tag
Introduction to Zend\Tag Creating tag clouds with Zend\Tag\Cloud
347.41 Zend\Test
Introduction to Zend\Test Unit testing with PHPUnit
347.42 Zend\Text
Zend\Text\Figlet Zend\Text\Table
347.43 Zend\Uri
Zend\Uri
347.44 Zend\Validator
Introduction to Zend\Validator Standard Validation Classes File Validation Classes Validator Chains Writing Validators Validation Messages
347.45 Zend\Version
Getting the Zend Framework Version
347.46 Zend\View
Zend\View Quick Start The PhpRenderer PhpRenderer View Scripts The ViewEvent 1488 Chapter 347. Zend Framework 2 Reference
View Helpers modules/zend.view.helpers.base-path View Helper - Cycle View Helper - Doctype modules/zend.view.helpers.head-link modules/zend.view.helpers.head-meta modules/zend.view.helpers.head-script modules/zend.view.helpers.head-style modules/zend.view.helpers.head-title modules/zend.view.helpers.html-list modules/zend.view.helpers.html-object View Helper - Identity modules/zend.view.helpers.inline-script View Helper - JSON View Helper - Partial View Helper - Placeholder View Helper - URL Advanced usage of helpers
347.47 Zend\XmlRpc
Introduction to Zend\XmlRpc Zend\XmlRpc\Client Zend\XmlRpc\Server
347.47. Zend\XmlRpc
1489
1490
CHAPTER 348
348.1 ZendService\Akismet
ZendServiceAkismet
348.2 ZendService\Amazon
ZendServiceAmazon
348.3 ZendService\AppleApns
ZendService\Apple\Apns
348.4 ZendService\Audioscrobbler
ZendServiceAudioscrobbler
348.5 ZendService\Del.icio.us
ZendServiceDelicious
1491
348.7 ZendService\Flickr
ZendServiceFlickr
348.8 ZendService\Google\Gcm
modules/zendservice.google.gcm
348.9 ZendService\LiveDocx
ZendService\LiveDocx
348.10 ZendService\Nirvanix
ZendServiceNirvanix
348.11 ZendService\Rackspace
Zend\Service\Rackspace
348.12 ZendService\ReCaptcha
ZendServiceReCaptcha
348.13 ZendService\SlideShare
ZendServiceSlideShare
348.14 ZendService\StrikeIron
ZendServiceStrikeIron
348.15 ZendService\Technorati
ZendServiceTechnorati
348.16 ZendService\Twitter
ZendServiceTwitter 1492 Chapter 348. Services for Zend Framework 2 Reference
1493
1494
CHAPTER 349
Copyright
Copyright Information
1495
1496
CHAPTER 350
1497