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_Translate_Yaml Component Proposal

Proposed Component Name Zend_Translate_Yaml
Developer Notes http://framework.zend.com/wiki/display/ZFDEV/Zend_Translate_Yaml
Proposers thomas
Revision 1.0 - 3 November 2007: Finished initial proposal (wiki revision: 8)

Table of Contents

1. Overview

Zend_Translate_Yaml is an additional adapter for Zend_Translate which adds the YAML Format as translation source. YAML is easy to maintain and offers therefor advantage for customers.

2. References

  • none

3. Component Requirements, Constraints, and Acceptance Criteria

  • Zend_Translate_Adapter_Yaml is an additional source format for Zend_Translate
  • It will integrate the useage of Yaml files for translation into the Zend_Framework
  • This component can not create new Yaml files, it only can parse them for framework integration

4. Dependencies on Other Framework Components

  • Zend_Translate_Abstract
  • Zend_Exception

5. Theory of Operation

This component integrates Yaml source files into the Zend_Framework.
It derives from Zend_Translate_Abstract and can be used by Zend_Translate to serve source files for translation.

Yaml Files are simple from the point of creation.
They can be processed by customers with a simple text editor.

6. Milestones / Tasks

  • Milestone 1: [DONE] proposal written
  • Milestone 2: [DONE] Zend_Translate - Thomas Weidner
  • Milestone 3: Code class based on Zend_Translate_Abstract
  • Milestone 4: Unit tests and debugging
  • Milestone 5: Documentation done

7. Class Index

  • Zend_Translate_Adapter_Yaml

8. Use Cases

UC-01

Use of translation - HTTP_ACCEPT_LANGUAGE: de_AT

Example yaml file:

9. Class Skeletons

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

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

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

    <p>Does this adapter depend on a YAML extension or lib, such as Syck? If not, do you plan to parse a very specific subset of YAML or all YAML? Can we get a sample YAML file to see the format?<br />
    Also, very small suggestion here: I think YAML files typically have an extension of .yml or .yaml. It might be clearer in your first use case if you used a YAML file extension.</p>

  2. Dec 16, 2007

    <p>No, it does not depend on a extention or lib.<br />
    And it does not support all YAML because it is a derivat for usage of translation purposes.</p>

    <p>It's meant for those who do not use ini files but instead yaml files.</p>

  3. Jan 02, 2008

    <p>The Zend core team has discussed this component, and feel that having YAML support for Zend_Translate does not make sense until a Zend_Yaml component is available; the first question users will ask when they see it available is, "Why is there a Zend_Translate_Yaml and no Zend_Yaml?"</p>

    <p>We feel there are two options:</p>

    <ul>
    <li>Work with Padraic Brady to ensure that Zend_Translate_Yaml's syntax will be supported by Zend_Yaml.</li>
    <li>If Padraic is unable to move Zend_Yaml forward, create Zend_Yaml with support for parsing the syntax subset necessary for Zend_Translate_Yaml; future development could then take care of any other portion of the syntax we wish to support.</li>
    </ul>

    <p>Once a decision regarding development of Zend_Yaml has been resolved (i.e., who will develop the funtionality, and its timeframe and scope), we would be ready to approve this component for incubator development.</p>

    1. Jan 06, 2008

      <p>I have much work to do, and the code for this adapter has already been attached to the related issue ZF-2152 2 weeks ago. It is simple and streightfull as all other text adapters.</p>

      <p>I'm sorry but I will have the time for working on a component which I will not use. And I am not familiar that much with YAML... <ac:emoticon ac:name="sad" /></p>

      <p>This proposal is no must, it was just an implementation-wish from the community.<br />
      We can eighter throw it back to "Ready for review" or delete it.<br />
      Depends on the dev-team's decision.</p>

  4. Feb 03, 2008

    <p>I erased this proposal due to the fact that it must depend on Zend_Yaml and since 10 months there is no decision or work on it.</p>

    <p>As the already existing and working code for this adapter has not been accepted I erased it.</p>

    1. Feb 03, 2008

      <p>See <a class="external-link" href="http://framework.zend.com/issues/browse/ZF-2152">http://framework.zend.com/issues/browse/ZF-2152</a> for already working but not accepted code</p>

  5. Feb 04, 2008

    <p>I was reading across this proposal and I figured I should mention this since there seems to some sort of confusion of where Zend_Yaml is.</p>

    <p>On the 15th November I received an email from an Alexander Veremyev stating the Zend_Yaml had been reviewed. He raised concerns over performance, and that Zend_Yaml would only support YAML 1.0 without a native PHP parser for YAML 1.1, esp. since the ext/syck only supports YAML 1.0. I replied with a counter argument for a lighter parser for a common subset of YAML on systems without ext/syck.</p>

    <p>To date I have not heard back from Alexander.</p>

    <p>On the 20th December, Eric Coleman inquired into the status of Zend_Yaml on the mailing lists. Wil Sinclair responded back that a team meeting to go over them hadn't yet been scheduled (makes me wonder who the review team for Alexander were...ahem...) and that if I were a "squeekier wheel" it might go through faster. I replied that the component had been reviewed (or so Alexander seemed to have said) and I had made suggestions for a lighter parser, and that I had not received a definitive response yet.</p>

    <p>To date I have not heard back from Wil. Maybe I wasn't "squeeky" enough? I'll tell you what, I'll add my protest to yours. As of one hour from now, the Zend_Yaml proposal will be deleted from my proposal list. Might wake someone up.</p>

  6. Feb 04, 2008

    <p>Zend_Yaml has been erased. I'll note the January review eas effectively off the mark since Zend_Yaml does not exist, and has not been an active proposal since the November review. The review should be revisited perhaps so the existing work is not simply ignored out of some bad assumptions.</p>

  7. Apr 04, 2009

    <p>Greetings All,</p>

    <p>I've banged out a version of Zend_Config_Yml; will it suffice for your needs? You can view the code here:</p>

    <p><a class="external-link" href="http://www.emanaton.com/code/php/zendconfigyml">http://www.emanaton.com/code/php/zendconfigyml</a></p>

    <p>Regards,</p>

    <p>Sean P. O. MacCath-Moran<br />
    www.emanaton.com</p>