Skip to content

Commit 82f6b36

Browse files
author
Mike Willbanks
committed
Merge pull request zendframework#1079
2 parents 1a8348c + 53974ae commit 82f6b36

7 files changed

+26
-40
lines changed

docs/languages/en/modules/zend.cache.storage.adapter.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -985,8 +985,6 @@ The ZendServerShm Adapter
985985
Examples
986986
--------
987987

988-
.. _zend.cache.storage.adapter.examples.basic:
989-
990988
.. rubric:: Basic usage
991989

992990
.. code-block:: php
@@ -1010,8 +1008,6 @@ Examples
10101008
$cache->setItem($key, $result);
10111009
}
10121010
1013-
.. _zend.cache.storage.adapter.examples.basic:
1014-
10151011
.. rubric:: Get multiple rows from db
10161012

10171013
.. code-block:: php

docs/languages/en/modules/zend.code.generator.reference.rst

Lines changed: 20 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -8,62 +8,55 @@ Zend\Code\Generator Reference
88
Abstract Classes and Interfaces
99
-------------------------------
1010

11-
.. _zend.code.generator.reference.abstracts.abstract:
11+
.. _zend.code.generator.reference.interface.generator:
1212

13-
Zend\Code\Generator\AbstractGenerator
14-
^^^^^^^^^^^^^^^^^^^^^^^^^^^
13+
Zend\Code\Generator\GeneratorInterface
14+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1515

16-
The base class from which all CodeGenerator classes inherit provides the minimal functionality necessary. It's
16+
The base interface from which all CodeGenerator classes implement provides the minimal functionality necessary. It's
1717
*API* is as follows:
1818

1919
.. code-block:: php
2020
:linenos:
2121
22-
abstract class Zend\Code\Generator\AbstractGenerator
22+
interface Zend\Code\Generator\GeneratorInterface
2323
{
24-
final public function __construct(Array $options = array())
25-
public function setOptions(Array $options)
26-
public function setSourceContent($sourceContent)
27-
public function getSourceContent()
28-
protected function _init()
29-
protected function _prepare()
30-
abstract public function generate();
31-
final public function __toString()
24+
public function generate();
3225
}
3326
34-
The constructor first calls ``_init()`` (which is left empty for the concrete extending class to implement), then
35-
passes the ``$options`` parameter to ``setOptions()``, and finally calls ``_prepare()`` (again, to be implemented
36-
by an extending class).
37-
38-
Like most classes in Zend Framework, ``setOptions()`` compares an option key to existing setters in the class, and
39-
passes the value on to that method if found.
40-
41-
``__toString()`` is marked as final, and proxies to ``generate()``.
42-
43-
``setSourceContent()`` and ``getSourceContent()`` are intended to either set the default content for the code being
44-
generated, or to replace said content once all generation tasks are complete.
45-
4627
.. _zend.code.generator.reference.abstracts.abstract:
4728

4829
Zend\Code\Generator\AbstractGenerator
4930
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5031

51-
``Zend\Code\Generator\AbstractGenerator`` extends ``Zend\Code\Generator\AbstractGenerator``, and adds some properties for tracking
32+
``Zend\Code\Generator\AbstractGenerator`` implements ``Zend\Code\Generator\GeneratorInterface``, and adds some properties for tracking
5233
whether content has changed as well as the amount of indentation that should appear before generated content. Its
5334
*API* is as follows:
5435

5536
.. code-block:: php
5637
:linenos:
5738
5839
abstract class Zend\Code\Generator\AbstractGenerator
59-
extends Zend\Code\Generator\AbstractGenerator
40+
implements Zend\Code\Generator\GeneratorInterface
6041
{
42+
public function __construct(Array|Traversable $options = array())
43+
public function setOptions(Array $options)
44+
public function setSourceContent($sourceContent)
45+
public function getSourceContent()
6146
public function setSourceDirty($isSourceDirty = true)
6247
public function isSourceDirty()
6348
public function setIndentation($indentation)
6449
public function getIndentation()
6550
}
6651
52+
The constructor passes the ``$options`` parameter to ``setOptions()``.
53+
54+
Like most classes in Zend Framework, ``setOptions()`` compares an option key to existing setters in the class, and
55+
passes the value on to that method if found.
56+
57+
``setSourceContent()`` and ``getSourceContent()`` are intended to either set the default content for the code being
58+
generated, or to replace said content once all generation tasks are complete.
59+
6760
.. _zend.code.generator.reference.abstracts.member-abstract:
6861

6962
Zend\Code\Generator\AbstractMemberGenerator

docs/languages/en/modules/zend.filter.file.rename-upload.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ RenameUpload
66
``Zend\Filter\File\RenameUpload`` can be used to rename or move an uploaded file
77
to a new path.
88

9-
.. _zend.filter.file.rename.options:
9+
.. _zend.filter.file.rename-upload.options:
1010

1111
.. rubric:: Supported Options
1212

@@ -47,7 +47,7 @@ The following set of options are supported:
4747
When filtering HTML5 file uploads with the ``multiple`` attribute set, all files will
4848
be filtered with the same option settings.
4949

50-
.. _zend.filter.file.rename.usage:
50+
.. _zend.filter.file.rename-upload.usage:
5151

5252
.. rubric:: Usage Examples
5353

docs/languages/en/modules/zend.form.view.helper.form-file-upload-progress.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ See the `PECL uploadprogress extension`_ for more information.
2020

2121
``FormFileUploadProgress`` extends from :ref:`Zend\\Form\\View\\Helper\\FormInput <zend.form.view.helper.form-input>`.
2222

23-
.. _zend.form.view.helper.form-file-session-progress.usage:
23+
.. _zend.form.view.helper.form-file-upload-progress.usage:
2424

2525
Basic usage:
2626

docs/languages/en/modules/zend.i18n.filter.number.parse.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ NumberParse
66
The ``NumberParse`` filter can be used to parse a number from a string. It acts as a
77
wrapper for the ``NumberFormatter`` class within the Internationalization extension (Intl).
88

9-
.. _zend.i18n.filter.number-format.options:
9+
.. _zend.i18n.filter.number-parse.options:
1010

1111
.. rubric:: Supported Options for NumberParse Filter
1212

@@ -29,7 +29,7 @@ The following options are supported for ``NumberParse``:
2929

3030
Methods for getting/setting the parse type are also available: ``getType()`` and ``setType()``
3131

32-
.. _zend.i18n.filter.number-format.usage:
32+
.. _zend.i18n.filter.number-parse.usage:
3333

3434
.. rubric:: NumberParse Filter Usage
3535

docs/languages/en/modules/zend.uri.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -136,9 +136,6 @@ example, the scheme of ``http://johndoe@example.com/my/path?query#token`` is 'ht
136136
The ``getScheme()`` instance method returns only the scheme part of the *URI*
137137
object.
138138

139-
.. _zend.uri.instance-methods.geturi:
140-
141-
142139
.. _zend.uri.instance-methods.getuserinfo:
143140

144141
Getting the Userinfo of the URI

docs/languages/en/modules/zend.view.helpers.flash-messenger.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ The output of this example, using the default ``HTML`` rendering settings, would
6464
<li>You, the developer, are AWESOME!</li>
6565
</ul>
6666

67-
.. _zend.view.helpers.initial.flashmessenger.css-layout:
67+
.. _zend.view.helpers.initial.flashmessenger.html-layout:
6868

6969
HTML Layout
7070
-----------

0 commit comments

Comments
 (0)