Version 1 by Geoffrey Tran
on Feb 12, 2009 14:00.

compared with
Key
This line was removed.
This word was removed. This word was added.
This line was added.

Changes (29)

View Page History
{info:title=New Proposal Template}
This page has been created from a template that uses "zones." To proceed:

# Edit the page
# Replace sample content within each zone-data tag with your own content
# Remove this notice
# Save the page
# When you are ready for community review, move this page to the [Ready for Review] section on the edit page.

{note:title=No placeholders allowed!}
Please do not create placeholders. Wait until you have sufficient content to replace all sample data in the proposal template before creating your proposal document.
{note}
{info}

{zone-template-instance:ZFPROP:Proposal Zone Template}

{zone-data:component-name}
Zend_Magic Zend_View_Helper_XmlDeclaration
{zone-data}

{zone-data:proposer-list}
[My Name|mailto:noreply@zend.com]
[Geoffrey Tran]
{zone-data}


{zone-data:overview}
Zend_Magic is a simple component that reads my mind and generates code dynamically to do what I want.
The xml declaration helper generates xml declarations (<?xml version="1.0" ?>) just like its name suggests. Whenever you are using PHP for templates, you should use the xmlDeclaration helper because of inconsistencies between environments. You'll never know if short tags is enabled or not which can cause errors with xml declarations.
{zone-data}

{zone-data:references}
* [Harry Houdini Wikipedia Entry|http://en.wikipedia.org/wiki/Harry_Houdini]
* [MagicTricks.com|http://www.magictricks.com/]
* [Zym Project XmlDeclaration Helper|http://www.zym-project.com/docs/reference/zym.view.html#zym.view.helpers.xmldeclaration]
* [XmlDeclaration Helper| http://code.google.com/p/zym/source/browse/trunk/library/Zym/View/Helper/XmlDeclaration.php?r=740]
{zone-data}

{zone-data:requirements}
Most requirements take the form of "foo will do ...." or "foo will not support ...", although different words and sentence structure might be used. Adding functionality to your proposal is requirements creep (bad), unless listed below. Discuss major changes with your team first, and then open a "feature improvement" issue against this component.

* This component *will* correctly reads a developers mind for intent and generate the right configuration file.
* The generated config file *will not* support XML, but will provide an extension point in the API.
* This component *will* use no more memory than twice the size of all data it contains.
* This component *will* include a factory method. output an xml declaration
* This component *will not* allow subclassing. (i.e. when reviewed, we expect to see "final" keyword in code)
* This component *will* only generate data exports strictly complying with RFC 12345.
* This component *will* validate input data against formats supported by ZF component Foo.
* This component *will not* save any data using Zend_Cache or the filesystem. All transient data *will be* saved using Zend_Session.
* This component *will* allow specification of version, encoding and standalone attributes
{zone-data}

{zone-data:dependencies}
* Zend_Exception
{zone-data}

{zone-data:operation}
The component is instantiated with a mind-link that ...
Simply echo's an xml declaration
{zone-data}

{zone-data:milestones}
Describe some intermediate state of this component in terms of design notes, additional material added to this page, and / code. Note any significant dependencies here, such as, "Milestone #3 can not be completed until feature Foo has been added to ZF component XYZ." Milestones will be required for acceptance of future proposals. They are not hard, and many times you will only need to think of the first three below.
* Milestone 1: [design notes will be published here|http://framework.zend.com/wiki/x/sg]
* Milestone 2: Working prototype checked into the incubator supporting use cases #1, #2, ...
* Milestone 1: [DONE] Create proposal
* Milestone 2: [DONE] Working prototype, Documentation, Unit Tests
* Milestone 3: Working prototype checked into the incubator supporting use cases #3 and #4.
* Milestone 4: Unit tests exist, work, and are checked into SVN.
* Milestone 5: Initial documentation exists.

If a milestone is already done, begin the description with "\[DONE\]", like this:
* Milestone #: \[DONE\] Unit tests ...
{zone-data}

{zone-data:class-list}
* Zend_Magic_Exception Zend_View_Helper_XmlDeclaration
* Zend_Magic (factory class)
* Zend_Magic_MindProbe
* Zend_Magic_MindProbe_Intent
* Zend_Magic_Action
* Zend_Magic_CodeGen
{zone-data}

||UC-01||

... (see good use cases book)
Since it is not always known whether shorttags is enabled or not.
{code}
<?= $this->xmlDeclaration() ?>
<html>
[<?xml version="1.0" encoding="UTF-8" ?>]

<?= $this->xmlDeclaration('1.0') ?>
<html>
[<?xml version="1.0" encoding="UTF-8" ?>]

<?= $this->xmlDeclaration('1.1', 'UTF-16') ?>
<html>
[<?xml version="1.0" encoding="UTF-16" ?>]

<?= $this->xmlDeclaration('1.1', 'UTF-16', 'yes') ?>
<html>
[<?xml version="1.0" encoding="UTF-16" standalone="yes" ?>]
{code}
{zone-data}

{zone-data:skeletons}
{code}
class Zend_Magic_Exception extends Zend_Exception {}
class Zend_View_Helper_XmlDeclaration
{
class Zend_Magic {
public function xmlDeclaration($version = '1.0', $encoding = 'UTF-8', $standalone = null)
{}
... }
{code}
{zone-data}