p. 1

programmer s reference guide zend framework 1.10.x

[close]

p. 2

programmer s reference guide zend framework 1.10.x publication date 01/27/2010 by mikaelkael svn 20684 copyright © 2005-2010 zend technologies inc http www.zend.com

[close]

p. 3

table of contents i introduction to zend framework 1 overview 3 installation 4 ii learning zend framework 5 zend framework quick start 8 1 zend framework mvc introduction 8 1.1 zend framework 8 1.2 model-view-controller 8 2 create your project 10 2.1 install zend framework 10 2.2 create your project 10 2.3 the bootstrap 11 2.4 configuration 12 2.5 action controllers 12 2.6 views 13 2.7 checkpoint 15 3 create a layout 15 4 create a model and database table 18 5 create a form 28 6 congratulations 31 autoloading in zend framework 33 1 introduction 33 2 goals and design 33 2.1 class naming conventions 33 2.2 autoloader conventions and design 33 3 basic autoloader usage 34 4 resource autoloading 36 5 conclusion 37 plugins in zend framework 38 1 introduction 38 2 using plugins 38 3 conclusion 40 getting started with zend_layout 42 1 introduction 42 2 using zend_layout 42 2.1 layout configuration 42 2.2 create a layout script 43 2.3 accessing the layout object 43 2.4 other operations 44 3 zend_layout conclusions 45 getting started zend_view placeholders 46 1 introduction 46 2 basic placeholder usage 46 3 standard placeholders 49 3.1 setting the doctype 49 3.2 specifying the page title 50 3.3 specifying stylesheets with headlink 51 3.4 aggregating scripts using headscript 52 4 view placeholders conclusion 54 understanding and using zend form decorators 55 1 introduction 55 iii

[close]

p. 4

programmer s reference guide 2 decorator basics 55 2.1 overview of the decorator pattern 55 2.2 creating your first decorator 57 3 layering decorators 58 4 rendering individual decorators 62 5 creating and rendering composite elements 66 5.1 the element 66 5.2 the decorator 68 5.3 conclusion 70 6 conclusion 70 getting started with zend_session zend_auth and zend_acl 72 1 building multi-user applications with zend framework 72 1.1 zend framework 72 2 managing user sessions in zf 72 2.1 introduction to sessions 72 2.2 basic usage of zend_session 73 2.3 advanced usage of zend_session 74 3 authenticating users in zend framework 74 3.1 introduction to authentication 74 3.2 basic usage of zend_auth 74 4 building an authorization system in zend framework 76 4.1 introduction to authorization 76 4.2 basic usage of zend_acl 77 getting started with zend_search_lucene 80 1 zend_search_lucene introduction 80 2 lucene index structure 81 3 index opening and creation 82 4 indexing 82 4.1 indexing policy 82 5 searching 83 6 supported queries 84 7 search result pagination 86 getting started with zend_paginator 88 1 introduction 88 2 simple examples 88 3 pagination control and scrollingstyles 90 4 putting it all together 91 iii zend framework reference 93 zend_acl 124 1 introduction 124 1.1 resources 124 1.2 roles 124 1.3 creating the access control list 125 1.4 registering roles 126 1.5 defining access controls 127 1.6 querying an acl 127 2 refining access controls 128 2.1 precise access controls 128 2.2 removing access controls 130 3 advanced usage 130 3.1 storing acl data for persistence 130 3.2 writing conditional acl rules with assertions 131 zend_amf 132 1 introduction 132 iv

[close]

p. 5

programmer s reference guide 2 zend_amf_server 2.1 connecting to the server from flex 2.2 error handling 2.3 amf responses 2.4 typed objects 2.5 resources 2.6 connecting to the server from flash 2.7 authentication zend_application 1 introduction 2 zend_application quick start 2.1 using zend_tool 2.2 adding zend_application to your application 2.3 adding and creating resources 2.4 next steps with zend_application 3 theory of operation 3.1 bootstrapping 3.2 resource plugins 4 examples 5 core functionality 5.1 zend_application 5.2 zend_application_bootstrap_bootstrapper 5.3 zend_application_bootstrap_resourcebootstrapper 5.4 zend_application_bootstrap_bootstrapabstract 5.5 zend_application_bootstrap_bootstrap 5.6 zend_application_resource_resource 5.7 zend_application_resource_resourceabstract 6 available resource plugins 6.1 zend_application_resource_cachemanager 6.2 zend_application_resource_db 6.3 zend_application_resource_frontcontroller 6.4 zend_application_resource_layout 6.5 zend_application_resource_locale 6.6 zend_application_resource_log 6.7 zend_application_resource_mail 6.8 zend_application_resource_modules 6.9 zend_application_resource_multidb 6.10 zend_application_resource_navigation 6.11 zend_application_resource_router 6.12 zend_application_resource_session 6.13 zend_application_resource_view zend_auth 1 introduction 1.1 adapters 1.2 results 1.3 identity persistence 1.4 usage 2 database table authentication 2.1 introduction 2.2 advanced usage persisting a dbtable result object 2.3 advanced usage by example 3 digest authentication 3.1 introduction 3.2 specifics 132 134 136 136 136 138 138 140 142 142 142 142 144 145 147 147 148 152 153 156 156 159 160 161 164 165 166 168 168 168 169 170 170 171 172 172 174 175 175 176 176 178 178 178 179 180 183 184 184 186 186 188 188 188 v

[close]

p. 6

programmer s reference guide 3.3 identity 4 http authentication adapter 4.1 introduction 4.2 design overview 4.3 configuration options 4.4 resolvers 4.5 basic usage 5 ldap authentication 5.1 introduction 5.2 usage 5.3 the api 5.4 server options 5.5 collecting debugging messages 5.6 common options for specific servers 6 open id authentication 6.1 introduction 6.2 specifics zend_barcode 1 introduction 2 barcode creation using zend_barcode class 2.1 using zend_barcode factory 2.2 drawing a barcode 2.3 renderering a barcode 3 zend_barcode objects 3.1 common options 3.2 common additional getters 3.3 description of shipped barcodes 4 zend_barcode renderers 4.1 common options 4.2 zend_barcode_renderer_image 4.3 zend_barcode_renderer_pdf zend_cache 1 introduction 2 the theory of caching 2.1 the zend_cache factory method 2.2 tagging records 2.3 cleaning the cache 3 zend_cache frontends 3.1 zend_cache_core 3.2 zend_cache_frontend_output 3.3 zend_cache_frontend_function 3.4 zend_cache_frontend_class 3.5 zend_cache_frontend_file 3.6 zend_cache_frontend_page 4 zend_cache backends 4.1 zend_cache_backend_file 4.2 zend_cache_backend_sqlite 4.3 zend_cache_backend_memcached 4.4 zend_cache_backend_apc 4.5 zend_cache_backend_xcache 4.6 zend_cache_backend_zendplatform 4.7 zend_cache_backend_twolevels 4.8 zend_cache_backend_zendserver_disk and zend_cache_backend_zendserver_shmem 188 189 189 189 189 190 191 192 192 192 193 195 198 199 200 200 201 203 203 203 203 204 204 205 206 208 208 215 215 216 217 218 218 220 221 221 222 222 222 226 226 227 229 229 234 234 235 236 237 237 237 238 239 vi

[close]

p. 7

programmer s reference guide 5 the cache manager zend_captcha 1 introduction 2 captcha operation 3 captcha adapters 3.1 zend_captcha_word 3.2 zend_captcha_dumb 3.3 zend_captcha_figlet 3.4 zend_captcha_image 3.5 zend_captcha_recaptcha zend_codegenerator 1 introduction 1.1 theory of operation 2 zend_codegenerator examples 3 zend_codegenerator reference 3.1 abstract classes and interfaces 3.2 concrete codegenerator classes zend_config 1 introduction 2 theory of operation 3 zend_config_ini 4 zend_config_xml zend_config_writer 1 zend_config_writer zend_console_getopt 1 introduction 2 declaring getopt rules 2.1 declaring options with the short syntax 2.2 declaring options with the long syntax 3 fetching options and arguments 3.1 handling getopt exceptions 3.2 fetching options by name 3.3 reporting options 3.4 fetching non-option arguments 4 configuring zend_console_getopt 4.1 adding option rules 4.2 adding help messages 4.3 adding option aliases 4.4 adding argument lists 4.5 adding configuration zend_controller 1 zend_controller quick start 1.1 introduction 1.2 quick start 2 zend_controller basics 3 the front controller 3.1 overview 3.2 primary methods 3.3 environmental accessor methods 3.4 front controller parameters 3.5 extending the front controller 4 the request object 4.1 introduction 4.2 http requests 239 243 243 243 244 244 245 245 245 246 247 247 247 249 253 253 255 261 261 262 263 265 270 270 273 273 274 274 274 275 275 276 276 277 277 277 277 278 278 279 281 281 281 281 284 287 287 288 289 291 291 292 292 292 vii

[close]

p. 8

programmer s reference guide 4.3 subclassing the request object 5 the standard router 5.1 introduction 5.2 using a router 5.3 basic rewrite router operation 5.4 default routes 5.5 base url and subdirectories 5.6 global parameters 5.7 route types 5.8 using zend_config with the rewriterouter 5.9 subclassing the router 6 the dispatcher 6.1 overview 6.2 subclassing the dispatcher 7 action controllers 7.1 introduction 7.2 object initialization 7.3 pre and post-dispatch hooks 7.4 accessors 7.5 view integration 7.6 utility methods 7.7 subclassing the action controller 8 action helpers 8.1 introduction 8.2 helper initialization 8.3 the helper broker 8.4 built-in action helpers 8.5 writing your own helpers 9 the response object 9.1 usage 9.2 manipulating headers 9.3 named segments 9.4 testing for exceptions in the response object 9.5 subclassing the response object 10 plugins 10.1 introduction 10.2 writing plugins 10.3 using plugins 10.4 retrieving and manipulating plugins 10.5 plugins included in the standard distribution 11 using a conventional modular directory structure 11.1 introduction 11.2 specifying module controller directories 11.3 routing to modules 11.4 module or global default controller 12 mvc exceptions 12.1 introduction 12.2 handling exceptions 12.3 mvc exceptions you may encounter zend_currency 1 introduction to zend_currency 1.1 why should you use zend_currency 2 using zend_currency 2.1 generic usage 295 297 297 298 298 300 301 301 301 314 315 315 315 317 320 320 321 321 322 323 324 325 327 327 327 328 329 357 357 357 359 360 361 362 362 362 362 363 364 364 369 369 370 371 371 371 371 372 373 376 376 376 376 376 viii

[close]

p. 9

programmer s reference guide 2.2 currency creation based on a locale options for currencies what makes a currency where is the currency how does the currency look like how much is my currency 7.1 working with currency values 7.2 using precision on currencies 8 calculating with currencies 9 exchanging currencies 10 additional informations on zend_currency 10.1 currency informations 10.2 currency performance optimization zend_date 1 introduction 1.1 always set a default timezone 1.2 why use zend_date 2 theory of operation 2.1 internals 3 basic methods 3.1 current date 3.2 zend_date by example 4 zend_date api overview 4.1 zend_date options 4.2 working with date values 4.3 basic zend_date operations common to many date parts 4.4 comparing dates 4.5 getting dates and date parts 4.6 working with fractions of seconds 4.7 sunrise sunset 5 creation of dates 5.1 create the actual date 5.2 create a date from database 5.3 create dates from an array 6 constants for general date functions 6.1 using constants 6.2 list of all constants 6.3 self-defined output formats with iso 6.4 self-defined output formats using php s date format specifiers 7 working examples 7.1 checking dates 7.2 sunrise and sunset 7.3 time zones zend_db 1 zend_db_adapter 1.1 connecting to a database using an adapter 1.2 example database 1.3 reading query results 1.4 writing changes to the database 1.5 quoting values and identifiers 1.6 controlling database transactions 1.7 listing and describing tables 1.8 closing a connection 3 4 5 6 7 377 377 378 380 381 382 383 383 384 385 386 386 387 388 388 388 388 389 389 390 390 390 392 392 393 394 397 399 400 400 401 401 401 402 402 402 403 407 410 413 413 414 416 419 419 419 424 425 428 432 434 435 436 ix

[close]

p. 10

programmer s reference guide 2 3 4 5 6 7 8 9 1.9 running other database statements 1.10 retrieving server version 1.11 notes on specific adapters zend_db_statement 2.1 creating a statement 2.2 executing a statement 2.3 fetching results from a select statement zend_db_profiler 3.1 introduction 3.2 using the profiler 3.3 advanced profiler usage 3.4 specialized profilers zend_db_select 4.1 introduction 4.2 creating a select object 4.3 building select queries 4.4 executing select queries 4.5 other methods zend_db_table 5.1 introduction 5.2 using zend_db_table as a concrete class 5.3 defining a table class 5.4 creating an instance of a table 5.5 inserting rows to a table 5.6 updating rows in a table 5.7 deleting rows from a table 5.8 finding rows by primary key 5.9 querying for a set of rows 5.10 querying for a single row 5.11 retrieving table metadata information 5.12 caching table metadata 5.13 customizing and extending a table class zend_db_table_row 6.1 introduction 6.2 fetching a row 6.3 writing rows to the database 6.4 serializing and unserializing rows 6.5 extending the row class zend_db_table_rowset 7.1 introduction 7.2 fetching a rowset 7.3 retrieving rows from a rowset 7.4 retrieving a rowset as an array 7.5 serializing and unserializing a rowset 7.6 extending the rowset class zend_db_table relationships 8.1 introduction 8.2 defining relationships 8.3 fetching a dependent rowset 8.4 fetching a parent row 8.5 fetching a rowset via a many-to-many relationship 8.6 cascading write operations zend_db_table_definition 9.1 introduction 437 438 438 441 441 442 442 444 444 446 447 448 449 449 450 450 463 464 466 466 466 466 469 471 473 473 474 475 479 479 480 482 485 485 485 487 489 490 493 493 493 493 495 496 497 498 498 498 500 502 503 505 507 507 x

[close]

p. 11

programmer s reference guide 9.2 basic usage 9.3 advanced usage zend_debug 1 dumping variables zend_dojo 1 introduction 2 zend_dojo_data dojo.data envelopes 2.1 zend_dojo_data usage 2.2 adding metadata to your containers 2.3 advanced use cases 3 dojo view helpers 3.1 dojo view helper 3.2 dijit-specific view helpers 4 dojo form elements and decorators 4.1 dijit-specific form decorators 4.2 dijit-specific form elements 4.3 dojo form examples 5 zend_dojo build layer support 5.1 introduction 5.2 generating custom module layers with zend_dojo_buildlayer 5.3 generating build profiles with zend_dojo_buildlayer zend_dom 1 introduction 2 zend_dom_query 2.1 theory of operation 2.2 methods available zend_exception 1 using exceptions 2 basic usage 3 previous exceptions zend_feed 1 introduction 2 importing feeds 2.1 custom feeds 3 retrieving feeds from web pages 4 consuming an rss feed 5 consuming an atom feed 6 consuming a single atom entry 7 modifying feed and entry structures 8 custom feed and entry classes 9 zend_feed_reader 9.1 introduction 9.2 importing feeds 9.3 retrieving underlying feed and entry sources 9.4 cache support and intelligent requests 9.5 locating feed uris from websites 9.6 attribute collections 9.7 retrieving feed information 9.8 retrieving entry/item information 9.9 extending feed and entry apis 10 zend_feed_writer 10.1 introduction 10.2 architecture 10.3 getting started 507 509 511 511 512 512 512 512 514 514 516 516 521 534 535 537 554 555 555 556 558 561 561 561 561 562 564 564 564 564 566 566 567 567 571 572 573 574 575 575 577 577 577 578 579 580 581 582 585 588 592 592 592 593 xi

[close]

p. 12

programmer s reference guide 10.4 setting feed data points 10.5 setting entry data points 11 zend_feed_pubsubhubbub 11.1 what is pubsubhubbub 11.2 architecture 11.3 zend_feed_pubsubhubbub_publisher 11.4 zend_feed_pubsubhubbub_subscriber zend_file 1 zend_file_transfer 1.1 supported adapters for zend_file_transfer 1.2 options for zend_file_transfer 1.3 checking files 1.4 additional file informations 1.5 progress for file uploads 2 validators for zend_file_transfer 2.1 using validators with zend_file_transfer 2.2 count validator 2.3 crc32 validator 2.4 excludeextension validator 2.5 excludemimetype validator 2.6 exists validator 2.7 extension validator 2.8 filessize validator 2.9 imagesize validator 2.10 iscompressed validator 2.11 isimage validator 2.12 hash validator 2.13 md5 validator 2.14 mimetype validator 2.15 notexists validator 2.16 sha1 validator 2.17 size validator 2.18 wordcount validator 3 filters for zend_file_transfer 3.1 using filters with zend_file_transfer 3.2 decrypt filter 3.3 encrypt filter 3.4 lowercase filter 3.5 rename filter 3.6 uppercase filter zend_filter 1 introduction 1.1 what is a filter 1.2 basic usage of filters 1.3 using the static staticfilter method 2 standard filter classes 2.1 alnum 2.2 alpha 2.3 basename 2.4 boolean 2.5 callback 2.6 compress and decompress 2.7 decrypt 2.8 digits 594 596 598 598 599 599 600 608 608 609 609 610 610 612 614 615 617 618 618 619 620 620 621 622 623 623 624 624 625 626 627 627 628 628 629 630 630 631 631 632 634 634 634 634 634 635 635 636 636 636 638 639 645 647 xii

[close]

p. 13

programmer s reference guide 2.9 dir 2.10 encrypt 2.11 htmlentities 2.12 int 2.13 localizedtonormalized 2.14 normalizedtolocalized 2.15 null 2.16 pregreplace 2.17 realpath 2.18 stringtolower 2.19 stringtoupper 2.20 stringtrim 2.21 stripnewlines 2.22 striptags 3 filter chains 3.1 changing filter chain order 4 writing filters 5 zend_filter_input 5.1 declaring filter and validator rules 5.2 creating the filter and validator processor 5.3 retrieving validated fields and other reports 5.4 using metacommands to control filter or validator rules 5.5 adding filter class namespaces 6 zend_filter_inflector 6.1 operation 6.2 setting paths to alternate filters 6.3 setting the inflector target 6.4 inflection rules 6.5 utility methods 6.6 using zend_config with zend_filter_inflector zend_form 1 zend_form 2 zend_form quick start 2.1 create a form object 2.2 add elements to the form 2.3 render a form 2.4 check if a form is valid 2.5 get error status 2.6 putting it together 2.7 using a zend_config object 2.8 conclusion 3 creating form elements using zend_form_element 3.1 plugin loaders 3.2 filters 3.3 validators 3.4 decorators 3.5 metadata and attributes 3.6 standard elements 3.7 zend_form_element methods 3.8 configuration 3.9 custom elements 4 creating forms using zend_form 4.1 plugin loaders 4.2 elements 647 647 650 650 650 651 653 654 655 655 656 656 656 656 656 657 657 658 658 660 660 663 668 669 669 670 670 671 673 673 675 675 675 675 675 677 678 679 679 681 682 682 682 684 685 690 692 693 693 695 696 697 698 699 xiii

[close]

p. 14

programmer s reference guide 4.3 display groups 4.4 sub forms 4.5 metadata and attributes 4.6 decorators 4.7 validation 4.8 methods 4.9 configuration 4.10 custom forms 5 creating custom form markup using zend_form_decorator 5.1 operation 5.2 standard decorators 5.3 custom decorators 5.4 rendering individual decorators 6 standard form elements shipped with zend framework 6.1 zend_form_element_button 6.2 zend_form_element_captcha 6.3 zend_form_element_checkbox 6.4 zend_form_element_file 6.5 zend_form_element_hidden 6.6 zend_form_element_hash 6.7 zend_form_element_image 6.8 zend_form_element_multicheckbox 6.9 zend_form_element_multiselect 6.10 zend_form_element_password 6.11 zend_form_element_radio 6.12 zend_form_element_reset 6.13 zend_form_element_select 6.14 zend_form_element_submit 6.15 zend_form_element_text 6.16 zend_form_element_textarea 7 standard form decorators shipped with zend framework 7.1 zend_form_decorator_callback 7.2 zend_form_decorator_captcha 7.3 zend_form_decorator_description 7.4 zend_form_decorator_dtddwrapper 7.5 zend_form_decorator_errors 7.6 zend_form_decorator_fieldset 7.7 zend_form_decorator_file 7.8 zend_form_decorator_form 7.9 zend_form_decorator_formelements 7.10 zend_form_decorator_formerrors 7.11 zend_form_decorator_htmltag 7.12 zend_form_decorator_image 7.13 zend_form_decorator_label 7.14 zend_form_decorator_prepareelements 7.15 zend_form_decorator_viewhelper 7.16 zend_form_decorator_viewscript 8 internationalization of zend_form 8.1 initializing i18n in forms 8.2 standard i18n targets 9 advanced zend_form usage 9.1 array notation 9.2 multi-page forms zend_gdata 703 707 708 709 711 713 716 717 719 719 720 720 723 723 723 723 724 725 728 728 728 728 729 730 730 730 731 731 731 732 732 732 732 732 733 733 733 733 733 733 734 734 734 735 735 735 736 737 737 738 739 739 741 743 xiv

[close]

p. 15

programmer s reference guide 1 introduction 1.1 structure of zend_gdata 1.2 interacting with google services 1.3 obtaining instances of zend_gdata classes 1.4 google data client authentication 1.5 dependencies 1.6 creating a new gdata client 1.7 common query parameters 1.8 fetching a feed 1.9 working with multi-page feeds 1.10 working with data in feeds and entries 1.11 updating entries 1.12 posting entries to google servers 1.13 deleting entries on google servers 2 authenticating with authsub 2.1 creating an authsub authenticated http client 2.2 revoking authsub authentication 3 using the book search data api 3.1 authenticating to the book search service 3.2 searching for books 3.3 using community features 3.4 book collections and my library 4 authenticating with clientlogin 4.1 creating a clientlogin authenticated http client 4.2 terminating a clientlogin authenticated http client 5 using google calendar 5.1 connecting to the calendar service 5.2 retrieving a calendar list 5.3 retrieving events 5.4 creating events 5.5 modifying events 5.6 deleting events 5.7 accessing event comments 6 using google documents list data api 6.1 get a list of documents 6.2 upload a document 6.3 searching the documents feed 7 using google health 7.1 connect to the health service 7.2 profile feed 7.3 profile list feed 7.4 sending notices to the register feed 8 using google spreadsheets 8.1 create a spreadsheet 8.2 get a list of spreadsheets 8.3 get a list of worksheets 8.4 interacting with list-based feeds 8.5 interacting with cell-based feeds 9 using google apps provisioning 9.1 setting the current domain 9.2 interacting with users 9.3 interacting with nicknames 9.4 interacting with email lists 9.5 interacting with email list recipients 743 743 744 744 745 745 745 746 747 747 748 748 749 749 750 750 751 751 752 752 753 755 757 757 758 758 758 761 761 763 766 767 767 768 768 768 769 770 770 773 774 775 776 776 776 776 776 779 780 780 781 784 786 787 xv

[close]