Skip to content

Commit

Permalink
Updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
dim-s committed Apr 3, 2016
1 parent 8b08055 commit 846fb90
Show file tree
Hide file tree
Showing 41 changed files with 925 additions and 73 deletions.
1 change: 0 additions & 1 deletion api_en/php/android/app/Activity.rst
Expand Up @@ -41,7 +41,6 @@ Activity

.. php:method:: onCreate()
:returns: :doc:`php\\android\\app\\Activity </api_en/php/android/app/Activity>`
Expand Down
41 changes: 41 additions & 0 deletions api_en/php/compress/ArchiveEntry.rst
@@ -0,0 +1,41 @@
ArchiveEntry
-------------------------

.. include:: /api_en.desc/php/compress/ArchiveEntry.header.rst

.. php:class:: php\\compress\\ArchiveEntry
jphp-compress-ext

Class ArchiveEntry



**Methods**

----------

.. php:method:: getName()
:returns: :doc:`string </api_en/.types/string>`

.. php:method:: isDirectory()
:returns: :doc:`bool </api_en/.types/bool>`

.. php:method:: getSize()
:returns: :doc:`int </api_en/.types/int>`

.. php:method:: setSize($size)
:param $size: :doc:`int </api_en/.types/int>`

.. php:method:: getLastModifiedDate()
:returns: :doc:`int </api_en/.types/int>`



.. include:: /api_en.desc/php/compress/ArchiveEntry.footer.rst

33 changes: 33 additions & 0 deletions api_en/php/compress/ArchiveInputStream.rst
@@ -0,0 +1,33 @@
ArchiveInputStream
-------------------------------

.. include:: /api_en.desc/php/compress/ArchiveInputStream.header.rst

.. php:class:: php\\compress\\ArchiveInputStream
**extends**: :doc:`php\\io\\MiscStream </api_en/php/io/MiscStream>`


jphp-compress-ext

Class ArchiveInputStream for reading archive



**Methods**

----------

.. php:method:: __construct($format, $source)
:param $format: :doc:`string </api_en/.types/string>` - zip, tar, jar
:param $source: :doc:`php\\io\\File </api_en/php/io/File>`, :doc:`php\\io\\Stream </api_en/php/io/Stream>`

.. php:method:: nextEntry()
:returns: :doc:`php\\compress\\ArchiveEntry </api_en/php/compress/ArchiveEntry>`



.. include:: /api_en.desc/php/compress/ArchiveInputStream.footer.rst

52 changes: 52 additions & 0 deletions api_en/php/compress/ArchiveOutputStream.rst
@@ -0,0 +1,52 @@
ArchiveOutputStream
--------------------------------

.. include:: /api_en.desc/php/compress/ArchiveOutputStream.header.rst

.. php:class:: php\\compress\\ArchiveOutputStream
**extends**: :doc:`php\\io\\MiscStream </api_en/php/io/MiscStream>`


jphp-compress-ext

Class ArchiveOutputStream for creating archives



**Methods**

----------

.. php:method:: __construct($format, $source)
:param $format: :doc:`string </api_en/.types/string>` - zip, tar, jar, ar
:param $source: :doc:`php\\io\\File </api_en/php/io/File>`, :doc:`php\\io\\Stream </api_en/php/io/Stream>`

.. php:method:: createEntry($file, $name)
:param $file: :doc:`string </api_en/.types/string>`
:param $name: :doc:`string </api_en/.types/string>`
:returns: :doc:`php\\compress\\ArchiveEntry </api_en/php/compress/ArchiveEntry>`

.. php:method:: addFile($file, $name)
:param $file: :doc:`string </api_en/.types/string>`
:param $name: :doc:`string </api_en/.types/string>`
:returns: :doc:`php\\compress\\ArchiveEntry </api_en/php/compress/ArchiveEntry>`

.. php:method:: addEntry($entry)
:param $entry: :doc:`php\\compress\\ArchiveEntry </api_en/php/compress/ArchiveEntry>`

.. php:method:: canAddEntry($entry)
:param $entry: :doc:`php\\compress\\ArchiveEntry </api_en/php/compress/ArchiveEntry>`

.. php:method:: closeEntry()
.. include:: /api_en.desc/php/compress/ArchiveOutputStream.footer.rst

15 changes: 15 additions & 0 deletions api_en/php/compress/index.rst
@@ -0,0 +1,15 @@
compress
------------------------------


.. include:: /api_en.desc/php/compress/index.header.rst

.. toctree::
:maxdepth: 3

ArchiveEntry.rst
ArchiveInputStream.rst
ArchiveOutputStream.rst

.. include:: /api_en.desc/php/compress/index.footer.rst

1 change: 0 additions & 1 deletion api_en/php/concurrent/index.rst
Expand Up @@ -7,7 +7,6 @@ concurrent
.. toctree::
:maxdepth: 3

ExecutorService.rst
Future.rst
TimeoutException.rst

Expand Down
6 changes: 6 additions & 0 deletions api_en/php/format/JsonProcessor.rst
Expand Up @@ -32,16 +32,22 @@ JsonProcessor

.. php:method:: parse($json)
**throws** :doc:`php\\format\\ProcessorException </api_en/php/format/ProcessorException>`

:param $json: :doc:`string </api_en/.types/string>`, :doc:`php\\io\\Stream </api_en/php/io/Stream>`
:returns: :doc:`mixed </api_en/.types/mixed>`

.. php:method:: format($value)
**throws** :doc:`php\\format\\ProcessorException </api_en/php/format/ProcessorException>`

:param $value: :doc:`mixed </api_en/.types/mixed>`
:returns: :doc:`string </api_en/.types/string>`

.. php:method:: formatTo($value, $output)
**throws** :doc:`php\\format\\ProcessorException </api_en/php/format/ProcessorException>`

:param $value: :doc:`mixed </api_en/.types/mixed>`
:param $output: :doc:`php\\io\\Stream </api_en/php/io/Stream>`

Expand Down
16 changes: 16 additions & 0 deletions api_en/php/format/ProcessorException.rst
@@ -0,0 +1,16 @@
ProcessorException
-----------------------------

.. include:: /api_en.desc/php/format/ProcessorException.header.rst

.. php:class:: php\\format\\ProcessorException
**extends**: :doc:`Exception </api_en/Exception>`


Class ProcessorException



.. include:: /api_en.desc/php/format/ProcessorException.footer.rst

1 change: 1 addition & 0 deletions api_en/php/format/index.rst
Expand Up @@ -9,6 +9,7 @@ format

JsonProcessor.rst
Processor.rst
ProcessorException.rst

.. include:: /api_en.desc/php/format/index.footer.rst

2 changes: 2 additions & 0 deletions api_en/php/index.rst
Expand Up @@ -8,6 +8,7 @@ php
:maxdepth: 3

android/index
compress/index
concurrent/index
format/index
gdx/index
Expand All @@ -17,6 +18,7 @@ php
lib/index
mail/index
net/index
orientdb/index
sql/index
swing/index
time/index
Expand Down
14 changes: 14 additions & 0 deletions api_en/php/io/File.rst
Expand Up @@ -106,6 +106,11 @@ File
:returns: :doc:`bool </api_en/.types/bool>`

.. php:method:: matches($pattern)
:param $pattern: :doc:`string </api_en/.types/string>` - the "glob" and "regex" syntaxes, and may support others.
:returns: :doc:`bool </api_en/.types/bool>`

.. php:method:: delete()
:returns: :doc:`bool </api_en/.types/bool>`
Expand All @@ -127,6 +132,15 @@ File
:returns: :doc:`int </api_en/.types/int>`

.. php:method:: crc32()
:returns: :doc:`int </api_en/.types/int>`, :doc:`null </api_en/.types/null>` null if not exists or io exception

.. php:method:: hash($algorithm = 'MD5')
:param $algorithm: :doc:`string </api_en/.types/string>`
:returns: :doc:`string </api_en/.types/string>`, :doc:`null </api_en/.types/null>` if not exists or io exception

.. php:method:: renameTo($newName)
:param $newName: :doc:`string </api_en/.types/string>`
Expand Down
2 changes: 2 additions & 0 deletions api_en/php/io/MiscStream.rst
Expand Up @@ -11,6 +11,8 @@ MiscStream

----------------------

* **class** :doc:`php\\compress\\ArchiveInputStream </api_en/php/compress/ArchiveInputStream>`
* **class** :doc:`php\\compress\\ArchiveOutputStream </api_en/php/compress/ArchiveOutputStream>`
* **class** :doc:`php\\io\\MemoryStream </api_en/php/io/MemoryStream>`

Class MiscStream
Expand Down
4 changes: 4 additions & 0 deletions api_en/php/io/ResourceStream.rst
Expand Up @@ -62,6 +62,10 @@ ResourceStream
:returns: :doc:`mixed </api_en/.types/mixed>`

.. php:method:: toExternalForm()
:returns: :doc:`string </api_en/.types/string>`

.. php:staticmethod:: getResources($name)
:param $name: :doc:`string </api_en/.types/string>`
Expand Down
6 changes: 6 additions & 0 deletions api_en/php/jsoup/Connection.rst
Expand Up @@ -39,6 +39,12 @@ Connection
:param $data: :doc:`array </api_en/.types/array>`
:returns: :doc:`php\\jsoup\\Connection </api_en/php/jsoup/Connection>`

.. php:method:: header($name, $value)
:param $name: :doc:`string </api_en/.types/string>`
:param $value: :doc:`string </api_en/.types/string>`
:returns: :doc:`php\\jsoup\\Connection </api_en/php/jsoup/Connection>`

.. php:method:: url($url)
:param $url: :doc:`string </api_en/.types/string>`
Expand Down
8 changes: 8 additions & 0 deletions api_en/php/jsoup/ConnectionResponse.rst
Expand Up @@ -14,6 +14,14 @@ ConnectionResponse

----------

.. php:method:: headers()
:returns: :doc:`array </api_en/.types/array>`

.. php:method:: cookies()
:returns: :doc:`array </api_en/.types/array>`

.. php:method:: statusCode()
Get the status code of the response.
Expand Down
5 changes: 5 additions & 0 deletions api_en/php/lang/ClassLoader.rst
Expand Up @@ -7,6 +7,11 @@ ClassLoader
**abstract** class

**Children**

----------------------

* **class** :doc:`php\\util\\LauncherClassLoader </api_en/php/util/LauncherClassLoader>`



Expand Down
17 changes: 17 additions & 0 deletions api_en/php/lang/Environment.rst
Expand Up @@ -28,6 +28,14 @@ Environment
:param $parent: :doc:`php\\lang\\Environment </api_en/php/lang/Environment>`
:param $flags: :doc:`int </api_en/.types/int>` - Environment::HOT_RELOAD, Environment::CONCURRENT

.. php:method:: registerSourceMap($sourceMap)
:param $sourceMap: :doc:`php\\lang\\SourceMap </api_en/php/lang/SourceMap>`

.. php:method:: unregisterSourceMap($sourceMap)
:param $sourceMap: :doc:`php\\lang\\SourceMap </api_en/php/lang/SourceMap>`

.. php:method:: execute($runnable)
Executes $runnable in the environment
Expand Down Expand Up @@ -84,13 +92,22 @@ Environment

:param $callback: :doc:`callable </api_en/.types/callable>`

.. php:method:: onOutput($callback)
:param $callback: :doc:`callable </api_en/.types/callable>`

.. php:method:: sendMessage($message)
Send message to the environment

:param $message: :doc:`mixed </api_en/.types/mixed>`
:returns: :doc:`mixed </api_en/.types/mixed>`

.. php:method:: findModule($path)
:param $path: :doc:`string </api_en/.types/string>`
:returns: :doc:`php\\lang\\Module </api_en/php/lang/Module>`, :doc:`null </api_en/.types/null>`

.. php:staticmethod:: current()
Get environment of current execution
Expand Down
16 changes: 16 additions & 0 deletions api_en/php/lang/NotImplementedException.rst
@@ -0,0 +1,16 @@
NotImplementedException
--------------------------------

.. include:: /api_en.desc/php/lang/NotImplementedException.header.rst

.. php:class:: php\\lang\\NotImplementedException
**extends**: :doc:`Exception </api_en/Exception>`


Class NotImplementedException



.. include:: /api_en.desc/php/lang/NotImplementedException.footer.rst

0 comments on commit 846fb90

Please sign in to comment.