Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Dmitriy Zayceff committed Jun 20, 2014
1 parent b5dc4e9 commit 5141628
Show file tree
Hide file tree
Showing 33 changed files with 723 additions and 0 deletions.
1 change: 1 addition & 0 deletions api_en/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ API (English)
:maxdepth: 3

php/concurrent/index
php/format/index
php/io/index
php/lang/index
php/lib/index
Expand Down
56 changes: 56 additions & 0 deletions api_en/php/format/JsonProcessor.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
JsonProcessor
------------------------

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

.. php:class:: php\\format\\JsonProcessor
**extends**: :doc:`php\\format\\Processor </api_en/php/format/Processor>`


Class JsonProcessor



**Constants**

----------

.. php:const:: SERIALIZE_PRETTY_PRINT
.. php:const:: DESERIALIZE_AS_ARRAYS
**Methods**

----------

.. php:method:: __construct($flags = 0)
:param $flags: :doc:`int </api_en/.types/int>`

.. php:method:: parse($jsonString)
:param $jsonString: :doc:`string </api_en/.types/string>`
:returns: :doc:`mixed </api_en/.types/mixed>`

.. php:method:: format($value)
:param $value: :doc:`mixed </api_en/.types/mixed>`
:returns: :doc:`string </api_en/.types/string>`

.. php:method:: onSerialize($nameOfType, $handler = null)
:param $nameOfType: :doc:`string </api_en/.types/string>` - - null, int, float, string, bool, object, array
:param $handler: :doc:`callable </api_en/.types/callable>` - (mixed $value) -> mixed

.. php:method:: onClassSerialize($className, $handler = null)
:param $className: :doc:`string </api_en/.types/string>`
:param $handler: :doc:`callable </api_en/.types/callable>`



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

39 changes: 39 additions & 0 deletions api_en/php/format/Processor.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
Processor
--------------------

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

.. php:class:: php\\format\\Processor
**abstract** class

**Children**

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

* **class** :doc:`php\\format\\JsonProcessor </api_en/php/format/JsonProcessor>`



**Methods**

----------

.. php:method:: format($value)
**abstract**


:param $value:

.. php:method:: parse($string)
**abstract**


:param $string:



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

14 changes: 14 additions & 0 deletions api_en/php/format/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
format
------------------------------


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

.. toctree::
:maxdepth: 3

JsonProcessor.rst
Processor.rst

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

1 change: 1 addition & 0 deletions api_en/php/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ php
:maxdepth: 3

concurrent/index
format/index
io/index
lang/index
lib/index
Expand Down
8 changes: 8 additions & 0 deletions api_en/php/lang/System.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,14 @@ System
.. php:staticmethod:: gc()
.. php:staticmethod:: getProperty($name, $def = '')
Gets a system property by name

:param $name:
:param $def: :doc:`string </api_en/.types/string>`
:returns: :doc:`string </api_en/.types/string>`



.. include:: /api_en.desc/php/lang/System.footer.rst
Expand Down
47 changes: 47 additions & 0 deletions api_en/php/net/HttpClient.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
HttpClient
------------------

.. include:: /api_en.desc/php/net/HttpClient.header.rst

.. php:class:: php\\net\\HttpClient
Class HttpClient



**Methods**

----------

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

.. php:method:: setHeaders($headers)
:param $headers: :doc:`array </api_en/.types/array>`

.. php:method:: get($url)
:param $url:
:returns: :doc:`php\\net\\HttpRequest </api_en/php/net/HttpRequest>`

.. php:method:: post($url)
:param $url:
:returns: :doc:`php\\net\\HttpRequest </api_en/php/net/HttpRequest>`

.. php:method:: put($url)
:param $url:
:returns: :doc:`php\\net\\HttpRequest </api_en/php/net/HttpRequest>`

.. php:method:: delete($url)
:param $url:
:returns: :doc:`php\\net\\HttpRequest </api_en/php/net/HttpRequest>`



.. include:: /api_en.desc/php/net/HttpClient.footer.rst

56 changes: 56 additions & 0 deletions api_en/php/net/HttpEntity.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
HttpEntity
------------------

.. include:: /api_en.desc/php/net/HttpEntity.header.rst

.. php:class:: php\\net\\HttpEntity
Class HttpEntity



**Methods**

----------

.. php:method:: __construct($source)
:param $source: :doc:`php\\io\\Stream </api_en/php/io/Stream>`, :doc:`string </api_en/.types/string>`

.. php:method:: getContent()
:returns: :doc:`php\\io\\Stream </api_en/php/io/Stream>`

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

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

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

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

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

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

.. php:method:: toString($encoding = null)
:param $encoding: :doc:`null </api_en/.types/null>`, :doc:`string </api_en/.types/string>`
:returns: :doc:`string </api_en/.types/string>`



.. include:: /api_en.desc/php/net/HttpEntity.footer.rst

27 changes: 27 additions & 0 deletions api_en/php/net/HttpFileEntity.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
HttpFileEntity
----------------------

.. include:: /api_en.desc/php/net/HttpFileEntity.header.rst

.. php:class:: php\\net\\HttpFileEntity
**extends**: :doc:`php\\net\\HttpEntity </api_en/php/net/HttpEntity>`


Class HttpFileEntity



**Methods**

----------

.. php:method:: __construct($file, $contentType = null)
:param $file: :doc:`string </api_en/.types/string>`, :doc:`php\\io\\File </api_en/php/io/File>`
:param $contentType: :doc:`null </api_en/.types/null>`



.. include:: /api_en.desc/php/net/HttpFileEntity.footer.rst

24 changes: 24 additions & 0 deletions api_en/php/net/HttpRequest.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
HttpRequest
-------------------

.. include:: /api_en.desc/php/net/HttpRequest.header.rst

.. php:class:: php\\net\\HttpRequest
Class HttpRequest



**Methods**

----------

.. php:method:: execute($entity = null)
:param $entity: :doc:`php\\net\\HttpEntity </api_en/php/net/HttpEntity>`
:returns: :doc:`php\\net\\HttpResponse </api_en/php/net/HttpResponse>`



.. include:: /api_en.desc/php/net/HttpRequest.footer.rst

38 changes: 38 additions & 0 deletions api_en/php/net/HttpResponse.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
HttpResponse
--------------------

.. include:: /api_en.desc/php/net/HttpResponse.header.rst

.. php:class:: php\\net\\HttpResponse
Class HttpResponse



**Methods**

----------

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

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

.. php:method:: setEntity($entity = null)
:param $entity: :doc:`php\\net\\HttpEntity </api_en/php/net/HttpEntity>`

.. php:method:: getEntity()
:returns: :doc:`php\\net\\HttpEntity </api_en/php/net/HttpEntity>`



.. include:: /api_en.desc/php/net/HttpResponse.footer.rst

27 changes: 27 additions & 0 deletions api_en/php/net/HttpUrlEncodingFormEntity.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
HttpUrlEncodingFormEntity
---------------------------------

.. include:: /api_en.desc/php/net/HttpUrlEncodingFormEntity.header.rst

.. php:class:: php\\net\\HttpUrlEncodingFormEntity
**extends**: :doc:`php\\net\\HttpEntity </api_en/php/net/HttpEntity>`


Class HttpEncodingFormEntity



**Methods**

----------

.. php:method:: __construct($args, $encoding = null)
:param $args: :doc:`array </api_en/.types/array>`
:param $encoding: :doc:`null </api_en/.types/null>`, :doc:`string </api_en/.types/string>`



.. include:: /api_en.desc/php/net/HttpUrlEncodingFormEntity.footer.rst

6 changes: 6 additions & 0 deletions api_en/php/net/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ net
.. toctree::
:maxdepth: 3

HttpClient.rst
HttpEntity.rst
HttpFileEntity.rst
HttpRequest.rst
HttpResponse.rst
HttpUrlEncodingFormEntity.rst
ServerSocket.rst
Socket.rst
SocketException.rst
Expand Down
6 changes: 6 additions & 0 deletions api_en/php/swing/SwingUtilities.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@ SwingUtilities



.. php:staticmethod:: getScreenSize()
Returns screen size as an array [width, height]

:returns: :doc:`array </api_en/.types/array>`

.. php:staticmethod:: setExceptionHandler($handler)
:param $handler: :doc:`callable </api_en/.types/callable>` - (Exception|JavaObject $exception)
Expand Down
Loading

0 comments on commit 5141628

Please sign in to comment.