Skip to end of metadata
Go to start of metadata

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

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

Zend Framework: Zend_Microformat_Hcard Component Proposal

Proposed Component Name Zend_Microformat_Hcard
Developer Notes
Proposers Pádraic Brady
Matthew Weier O'Phinney (Zend Liaison)
Revision 1.0 - Awaiting Community Comment (wiki revision: 5)

Table of Contents

1. Overview

hCard is a simple microformat for representing people, groups, companies and even places. It is quite simply a publishable representation of a vCard for embedding in HTML/XHTML. If you need an example, check the source HTML for your Flickr profile.

The purpose of Zend_Microformat_Hcard is to both to collect and generate hCard data. You may collect the data from any URL, or HTML/XHTML source code, and generate hCard output using inputted data.

2. References

3. Component Requirements, Constraints, and Acceptance Criteria

  • This component will parse hCard data from any given URL.
  • This component will parse hCard data from any given HTML/XHTML source.
  • This component will generate hCard output for embedding in HTML based on user input.
  • This component will present and accept data using an iterable and countable OO API.

4. Dependencies on Other Framework Components

  • Zend_Microformat
  • Zend_Microformat_Exception

5. Theory of Operation

The operation of this component is covered in the related Zend_Microformat proposal. In short, when supplied with a URL or HTML source, this component will parse out hCard data into a results object for use. It will also generate similar embeddable output.

Although this component can be used directly for specific purposes, or for implementing custom hCard forms, the majority of use cases work perfectly fine using the API supplied with Zend_Microformat.

6. Milestones / Tasks

  • Milestone 1: Assemble some initial use cases to explore desired API
  • Milestone 2: Commence proof-of-concept coding (will discard after)
  • Milestone 3: Pending review, complete initial development using TDD
  • Milestone 4: Complete acceptance testing, verify unit test coverage
  • Milestone 5: Let's assume documentation is written during development

7. Class Index

  • Zend_Microformat_Hcard
  • Zend_Microformat_Hcard_Entity
  • Zend_Microformat_Hcard_Result
  • Zend_Microformat_Hcard_Exception

8. Use Cases


Fetch hCard data using default Zend_Microformat API


Fetch hCard data using hCard class directly


Generating hCard embeddable output

9. Class Skeletons

Please see the above use cases. Based on these, source code will be developed following Test-Driven Development and therefore class skeletons will not be presented in this proposal prematurely. The TDD process will implement Zend_Microformat specifically to enable the use cases presented above.



Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. Jun 02, 2008

    <ac:macro ac:name="note"><ac:parameter ac:name="title">Zend Comments</ac:parameter><ac:rich-text-body>
    <p>The Zend Framework team accepts this proposal for immediate development in the extras incubator. Please see <a href="">the comment on the main Zend_Microformat proposal</a> for further acceptance criteria and suggestions.</p></ac:rich-text-body></ac:macro>

  2. Mar 18, 2009

    <p>Paddy, status?</p>