Skip to content

Commit

Permalink
update Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@abbadon1334
abbadon1334 committed Jul 15, 2019
1 parent ad5a765 commit 2eea83a
Show file tree
Hide file tree
Showing 24 changed files with 995 additions and 960 deletions.
Binary file modified docs/.doctrees/api/I18Next/Exception/LanguagePathNotDefined.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/api/I18Next/Exception/NotFoundKey.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/api/I18Next/Exception/TranslationSyntaxError.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/api/I18Next/Locale.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/api/I18Next/Locale/Processor/AbstractProcessor.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/api/I18Next/Locale/Processor/Key.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/api/I18Next/Locale/Translations.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/api/I18Next/atk4/index.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/api/index-namespaces-all.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/api/index.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/environment.pickle
View file
Binary file not shown.
1 change: 1 addition & 0 deletions docs/_sources/api/I18Next/Locale/Processor/Key.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Methods
~~~~~~~

* :php:meth:`public processKey\($key, $context, $counter\)<I18Next\\Locale\\Processor\\Key::processKey\(\)>`
* :php:meth:`private processDirectPipedKey\($key, $counter\)<I18Next\\Locale\\Processor\\Key::processDirectPipedKey\(\)>`
* :php:meth:`private processWithCounter\($key, $counter\)<I18Next\\Locale\\Processor\\Key::processWithCounter\(\)>`
* :php:meth:`private process\($key\)<I18Next\\Locale\\Processor\\Key::process\(\)>`
* :php:meth:`private processWithNamespaceWithCounter\($key, $counter\)<I18Next\\Locale\\Processor\\Key::processWithNamespaceWithCounter\(\)>`
Expand Down
16 changes: 8 additions & 8 deletions docs/_sources/api/I18Next/Locale/Translations.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Translations
:Source:
`src/I18Next/Locale/Translations.php#19 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L19>`_
`src/I18Next/Locale/Translations.php#16 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L16>`_

:Used traits:
:php:trait:`atk4\\core\\ConfigTrait`
Expand Down Expand Up @@ -48,15 +48,15 @@ Properties
.. php:attr:: protected static namespace_priority
:Source:
`src/I18Next/Locale/Translations.php#27 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L27>`_
`src/I18Next/Locale/Translations.php#24 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L24>`_

:Type: string[]


.. php:attr:: protected static use_filename_as_namespace
:Source:
`src/I18Next/Locale/Translations.php#30 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L30>`_
`src/I18Next/Locale/Translations.php#27 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L27>`_

:Type: bool

Expand All @@ -69,7 +69,7 @@ Methods
.. php:method:: public load( $path, $use_filename_as_namespace, ...$namespace_priority)
:Source:
`src/I18Next/Locale/Translations.php#45 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L45>`_
`src/I18Next/Locale/Translations.php#42 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L42>`_


:Parameters:
Expand All @@ -87,7 +87,7 @@ Methods
.. php:method:: public useFilenameAsNamespace( $enabled)
:Source:
`src/I18Next/Locale/Translations.php#97 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L97>`_
`src/I18Next/Locale/Translations.php#95 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L95>`_


:Parameters:
Expand All @@ -102,7 +102,7 @@ Methods
.. php:method:: public useNamespaces()
:Source:
`src/I18Next/Locale/Translations.php#197 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L197>`_
`src/I18Next/Locale/Translations.php#190 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L190>`_


:Returns: bool
Expand All @@ -114,7 +114,7 @@ Methods
.. php:method:: public getNamespaceRanked()
:Source:
`src/I18Next/Locale/Translations.php#205 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L205>`_
`src/I18Next/Locale/Translations.php#198 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L198>`_


:Returns: string[]
Expand All @@ -126,7 +126,7 @@ Methods
.. php:method:: public setLoaderFormat( $format)
:Source:
`src/I18Next/Locale/Translations.php#213 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L213>`_
`src/I18Next/Locale/Translations.php#206 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L206>`_


:Parameters:
Expand Down
1 change: 0 additions & 1 deletion docs/_sources/api/index-namespaces-all.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,5 @@ Namespaces
\I18Next\Locale\Processor <I18Next/Locale/Processor/index>
\I18Next\Locale\Processor\Key <I18Next/Locale/Processor/Key/index>
\I18Next\atk4 <I18Next/atk4/index>
\atk4\core <atk4/core/index>


1 change: 1 addition & 0 deletions docs/api/I18Next/Locale/Processor/Key.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@ <h2>Summary<a class="headerlink" href="#summary" title="Permalink to this headli
<h3>Methods<a class="headerlink" href="#methods" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><a class="reference internal" href="#I18Next\Locale\Processor\Key::processKey" title="I18Next\Locale\Processor\Key::processKey"><code class="xref php php-meth docutils literal notranslate"><span class="pre">public</span> <span class="pre">processKey($key,</span> <span class="pre">$context,</span> <span class="pre">$counter)</span></code></a></li>
<li><code class="xref php php-meth docutils literal notranslate"><span class="pre">private</span> <span class="pre">processDirectPipedKey($key,</span> <span class="pre">$counter)</span></code></li>
<li><code class="xref php php-meth docutils literal notranslate"><span class="pre">private</span> <span class="pre">processWithCounter($key,</span> <span class="pre">$counter)</span></code></li>
<li><code class="xref php php-meth docutils literal notranslate"><span class="pre">private</span> <span class="pre">process($key)</span></code></li>
<li><code class="xref php php-meth docutils literal notranslate"><span class="pre">private</span> <span class="pre">processWithNamespaceWithCounter($key,</span> <span class="pre">$counter)</span></code></li>
Expand Down
16 changes: 8 additions & 8 deletions docs/api/I18Next/Locale/Translations.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Source:</th><td class="field-body"><a class="reference external" href="https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L19">src/I18Next/Locale/Translations.php#19</a></td>
<tr class="field-odd field"><th class="field-name">Source:</th><td class="field-body"><a class="reference external" href="https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L16">src/I18Next/Locale/Translations.php#16</a></td>
</tr>
<tr class="field-even field"><th class="field-name">Used traits:</th><td class="field-body"><a class="reference internal" href="../../atk4/core/ConfigTrait.html#atk4\core\ConfigTrait" title="atk4\core\ConfigTrait"><code class="xref php php-trait docutils literal notranslate"><span class="pre">atk4\core\ConfigTrait</span></code></a></td>
</tr>
Expand Down Expand Up @@ -200,7 +200,7 @@ <h2>Properties<a class="headerlink" href="#properties" title="Permalink to this
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Source:</th><td class="field-body"><a class="reference external" href="https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L27">src/I18Next/Locale/Translations.php#27</a></td>
<tr class="field-odd field"><th class="field-name">Source:</th><td class="field-body"><a class="reference external" href="https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L24">src/I18Next/Locale/Translations.php#24</a></td>
</tr>
<tr class="field-even field"><th class="field-name">Type:</th><td class="field-body">string[]</td>
</tr>
Expand All @@ -215,7 +215,7 @@ <h2>Properties<a class="headerlink" href="#properties" title="Permalink to this
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Source:</th><td class="field-body"><a class="reference external" href="https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L30">src/I18Next/Locale/Translations.php#30</a></td>
<tr class="field-odd field"><th class="field-name">Source:</th><td class="field-body"><a class="reference external" href="https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L27">src/I18Next/Locale/Translations.php#27</a></td>
</tr>
<tr class="field-even field"><th class="field-name">Type:</th><td class="field-body">bool</td>
</tr>
Expand All @@ -233,7 +233,7 @@ <h2>Methods<a class="headerlink" href="#id1" title="Permalink to this headline">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Source:</th><td class="field-body"><p class="first"><a class="reference external" href="https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L45">src/I18Next/Locale/Translations.php#45</a></p>
<tr class="field-odd field"><th class="field-name">Source:</th><td class="field-body"><p class="first"><a class="reference external" href="https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L42">src/I18Next/Locale/Translations.php#42</a></p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
Expand All @@ -257,7 +257,7 @@ <h2>Methods<a class="headerlink" href="#id1" title="Permalink to this headline">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Source:</th><td class="field-body"><p class="first"><a class="reference external" href="https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L97">src/I18Next/Locale/Translations.php#97</a></p>
<tr class="field-odd field"><th class="field-name">Source:</th><td class="field-body"><p class="first"><a class="reference external" href="https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L95">src/I18Next/Locale/Translations.php#95</a></p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
Expand All @@ -276,7 +276,7 @@ <h2>Methods<a class="headerlink" href="#id1" title="Permalink to this headline">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Source:</th><td class="field-body"><a class="reference external" href="https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L197">src/I18Next/Locale/Translations.php#197</a></td>
<tr class="field-odd field"><th class="field-name">Source:</th><td class="field-body"><a class="reference external" href="https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L190">src/I18Next/Locale/Translations.php#190</a></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">bool</td>
</tr>
Expand All @@ -291,7 +291,7 @@ <h2>Methods<a class="headerlink" href="#id1" title="Permalink to this headline">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Source:</th><td class="field-body"><a class="reference external" href="https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L205">src/I18Next/Locale/Translations.php#205</a></td>
<tr class="field-odd field"><th class="field-name">Source:</th><td class="field-body"><a class="reference external" href="https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L198">src/I18Next/Locale/Translations.php#198</a></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">string[]</td>
</tr>
Expand All @@ -306,7 +306,7 @@ <h2>Methods<a class="headerlink" href="#id1" title="Permalink to this headline">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Source:</th><td class="field-body"><p class="first"><a class="reference external" href="https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L213">src/I18Next/Locale/Translations.php#213</a></p>
<tr class="field-odd field"><th class="field-name">Source:</th><td class="field-body"><p class="first"><a class="reference external" href="https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L206">src/I18Next/Locale/Translations.php#206</a></p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
Expand Down
1 change: 0 additions & 1 deletion docs/api/index-namespaces-all.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,6 @@
<li class="toctree-l1"><a class="reference internal" href="I18Next/Locale/Processor/index.html">\I18Next\Locale\Processor</a></li>
<li class="toctree-l1"><a class="reference internal" href="I18Next/Locale/Processor/Key/index.html">\I18Next\Locale\Processor\Key</a></li>
<li class="toctree-l1"><a class="reference internal" href="I18Next/atk4/index.html">\I18Next\atk4</a></li>
<li class="toctree-l1"><a class="reference internal" href="atk4/core/index.html">\atk4\core</a></li>
</ul>
</div>
</div>
Expand Down
17 changes: 17 additions & 0 deletions docs/md/I18Next-Locale-Processor-Key.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,23 @@ Methods



### processDirectPipedKey

mixed I18Next\Locale\Processor\Key::processDirectPipedKey(key, ?int counter)





* Visibility: **private**


#### Arguments
* key **mixed**
* counter **?int**



### processWithCounter

mixed|null I18Next\Locale\Processor\Key::processWithCounter(string key, int|null counter)
Expand Down
4 changes: 2 additions & 2 deletions docs/md/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ API Index
* [Processor](I18Next-Locale-Processor.md)
* [Value](I18Next-Locale-Processor-Value.md)
* [Key](I18Next-Locale-Processor-Key.md)
* [AbstractProcessorKey](I18Next-Locale-Processor-Key-AbstractProcessorKey.md)
* [KeyPlural](I18Next-Locale-Processor-Key-KeyPlural.md)
* [KeyCounter](I18Next-Locale-Processor-Key-KeyCounter.md)
* [AbstractProcessorKey](I18Next-Locale-Processor-Key-AbstractProcessorKey.md)
* [KeyInterval](I18Next-Locale-Processor-Key-KeyInterval.md)
* [KeyPlural](I18Next-Locale-Processor-Key-KeyPlural.md)
* [AbstractProcessor](I18Next-Locale-Processor-AbstractProcessor.md)
* [Translations](I18Next-Locale-Translations.md)
* [Translator](I18Next-Translator.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js
View file

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/source/api/I18Next/Locale/Processor/Key.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Methods
~~~~~~~

* :php:meth:`public processKey\($key, $context, $counter\)<I18Next\\Locale\\Processor\\Key::processKey\(\)>`
* :php:meth:`private processDirectPipedKey\($key, $counter\)<I18Next\\Locale\\Processor\\Key::processDirectPipedKey\(\)>`
* :php:meth:`private processWithCounter\($key, $counter\)<I18Next\\Locale\\Processor\\Key::processWithCounter\(\)>`
* :php:meth:`private process\($key\)<I18Next\\Locale\\Processor\\Key::process\(\)>`
* :php:meth:`private processWithNamespaceWithCounter\($key, $counter\)<I18Next\\Locale\\Processor\\Key::processWithNamespaceWithCounter\(\)>`
Expand Down
16 changes: 8 additions & 8 deletions docs/source/api/I18Next/Locale/Translations.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Translations
:Source:
`src/I18Next/Locale/Translations.php#19 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L19>`_
`src/I18Next/Locale/Translations.php#16 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L16>`_

:Used traits:
:php:trait:`atk4\\core\\ConfigTrait`
Expand Down Expand Up @@ -48,15 +48,15 @@ Properties
.. php:attr:: protected static namespace_priority
:Source:
`src/I18Next/Locale/Translations.php#27 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L27>`_
`src/I18Next/Locale/Translations.php#24 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L24>`_

:Type: string[]


.. php:attr:: protected static use_filename_as_namespace
:Source:
`src/I18Next/Locale/Translations.php#30 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L30>`_
`src/I18Next/Locale/Translations.php#27 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L27>`_

:Type: bool

Expand All @@ -69,7 +69,7 @@ Methods
.. php:method:: public load( $path, $use_filename_as_namespace, ...$namespace_priority)
:Source:
`src/I18Next/Locale/Translations.php#45 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L45>`_
`src/I18Next/Locale/Translations.php#42 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L42>`_


:Parameters:
Expand All @@ -87,7 +87,7 @@ Methods
.. php:method:: public useFilenameAsNamespace( $enabled)
:Source:
`src/I18Next/Locale/Translations.php#97 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L97>`_
`src/I18Next/Locale/Translations.php#95 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L95>`_


:Parameters:
Expand All @@ -102,7 +102,7 @@ Methods
.. php:method:: public useNamespaces()
:Source:
`src/I18Next/Locale/Translations.php#197 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L197>`_
`src/I18Next/Locale/Translations.php#190 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L190>`_


:Returns: bool
Expand All @@ -114,7 +114,7 @@ Methods
.. php:method:: public getNamespaceRanked()
:Source:
`src/I18Next/Locale/Translations.php#205 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L205>`_
`src/I18Next/Locale/Translations.php#198 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L198>`_


:Returns: string[]
Expand All @@ -126,7 +126,7 @@ Methods
.. php:method:: public setLoaderFormat( $format)
:Source:
`src/I18Next/Locale/Translations.php#213 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L213>`_
`src/I18Next/Locale/Translations.php#206 <https://github.com/abbadon1334/atk4-i18next-php/blob/master/src/I18Next/Locale/Translations.php#L206>`_


:Parameters:
Expand Down
1 change: 0 additions & 1 deletion docs/source/api/index-namespaces-all.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,5 @@ Namespaces
\I18Next\Locale\Processor <I18Next/Locale/Processor/index>
\I18Next\Locale\Processor\Key <I18Next/Locale/Processor/Key/index>
\I18Next\atk4 <I18Next/atk4/index>
\atk4\core <atk4/core/index>


Loading

0 comments on commit 2eea83a

Please sign in to comment.