Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version. Compare with Current  |   View Page History

<ac:macro ac:name="unmigrated-inline-wiki-markup"><ac:plain-text-body><![CDATA[

Zend Framework: Zend_Grid Component Proposal

Proposed Component Name Zend_Grid
Developer Notes http://framework.zend.com/wiki/display/ZFDEV/Zend_Grid
Proposers Bento Vilas Boas
Zend Liaison TBD
Revision 1.0 - 26 June 2010: Initial Draft. (wiki revision: 33)

Table of Contents

1. Overview

Zend_Grid is a component for display/manage data with source abstraction. Although it can be used anywhere in your application, it has a comprehensive feature list that fits the needs for an administrative grid where we need to easily display and edit data, create reports and even create WebServices to access information.

2. References

  • Community

3. Component Requirements, Constraints, and Acceptance Criteria

Must Support:

  • Zend_Config
  • Multiples sources
  • CRUD operations with bulk add/edit/remove options and auto-validation from tables definition
  • PRG Form Processing
  • Templates
  • Multiples renders (Table, PDF, Print, Xml, Excel, etc, etc)
  • Extra columns
  • Extra rows
  • Aggregate Expressions
  • Horizontal splitting of records
  • Multiple instances per page
  • Custom Filters
  • Auto-filters based on field definition (enum, set, etc, etc)
  • Mass actions
  • Cache
  • Content format plugins
  • Ajax
  • Conditional Field Rendering
  • Render specific parts of grid
  • Sorting results
  • Auto-paging. Change number of results per page
  • Save params in session (Filters, Order, Page, Records per page)
  • Detailed view of records
  • Internationalization
  • Decorators
  • Callbacks
  • Routing

4. Dependencies on Other Framework Components

  • Zend_View
  • Zend_Config
  • Zend_Form
  • Zend_Session
  • Zend_Controller
  • Zend_Registry
  • Zend_Cache
  • Zend_Exception

5. Theory of Operation

  • User instantiates Zend_Grid
  • Deploy class is loaded
  • User config is applied, after merged with global config
  • User defines a data source
  • User calls deploy after setting all params they want
  • Zend_Grid builds additional source params like where, limit, order...
  • Data is fetched from source
  • Data is converted to an array
  • User options are applied to data (decorators, callbacks, helpers, )
  • Information presented to user in desired format

6. Milestones / Tasks

Milestone 1: [DONE] Working prototype written and tested. Demos
Milestone 2: [DONE] Create initial documentation. Project Code
Milestone 3: [DONE] Working code checked into SVN.Units in progress.
Milestone 4: [DONE] Submitted to Ready for Review.

7. Class Index

  • Zend_Grid
  • Zend_Grid_Column
  • Zend_Grid_Deploy_Csv
  • Zend_Grid_Deploy_DeployInterface
  • Zend_Grid_Deploy_Jqgrid
  • Zend_Grid_Deploy_Json
  • Zend_Grid_Deploy_Ods
  • Zend_Grid_Deploy_Odt
  • Zend_Grid_Deploy_Ofc
  • Zend_Grid_Deploy_Pdf
  • Zend_Grid_Deploy_Print
  • Zend_Grid_Deploy_Table
  • Zend_Grid_Deploy_Word
  • Zend_Grid_Deploy_Wordx
  • Zend_Grid_Deploy_Xml
  • Zend_Grid_Exception
  • Zend_Grid_Extra_Column
  • Zend_Grid_Extra_Row
  • Zend_Grid_Filters_Render_Date
  • Zend_Grid_Filters_Render_Number
  • Zend_Grid_Filters_Render_RenderAbstract
  • Zend_Grid_Filters_Render_RenderInterface
  • Zend_Grid_Filters_Render_Select
  • Zend_Grid_Filters_Render_Text
  • Zend_Grid_Filters
  • Zend_Grid_Form
  • Zend_Grid_Formatter_Array
  • Zend_Grid_Formatter_Currency
  • Zend_Grid_Formatter_Date
  • Zend_Grid_Formatter_FormatterInterface
  • Zend_Grid_Formatter_Image
  • Zend_Grid_GridInterface
  • Zend_Grid_Source_Array
  • Zend_Grid_Source_Csv
  • Zend_Grid_Source_Db_DbAbstract
  • Zend_Grid_Source_Doctrine
  • Zend_Grid_Source_Json
  • Zend_Grid_Source_SourceInterface
  • Zend_Grid_Source_Xml
  • Zend_Grid_Source_Zend_Select
  • Zend_Grid_Source_Zend_Table
  • Zend_Grid_Template_Ods_Ods
  • Zend_Grid_Template_Odt_Odt
  • Zend_Grid_Template_Print_Print
  • Zend_Grid_Template_Table_Table
  • Zend_Grid_Template_Word_Word
  • Zend_Grid_Template_Wordx_Wordx
  • Zend_Grid_Translator

8. Use Cases

9. Class Skeletons

]]></ac:plain-text-body></ac:macro>

Labels:
None
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.