Implemented Hi Availability for OrientDB Distributed Configuration

Ostico · Sep 28, 2015 · 12a160a · 12a160a
1 parent 641b46e
commit 12a160a
Show file tree

Hide file tree

Showing 55 changed files with 1,938 additions and 652 deletions.
diff --git a/docs/ApiIndex.md b/docs/ApiIndex.md
@@ -52,10 +52,12 @@ API Index
             * PhpOrient\Protocols\Binary\Transaction
                 * [TxCommit](PhpOrient-Protocols-Binary-Transaction-TxCommit)
         * PhpOrient\Protocols\Common
+            * [OrientVersion](PhpOrient-Protocols-Common-OrientVersion)
             * [AbstractTransport](PhpOrient-Protocols-Common-AbstractTransport)
             * [ConfigurableInterface](PhpOrient-Protocols-Common-ConfigurableInterface)
-            * [ClusterMap](PhpOrient-Protocols-Common-ClusterMap)
+            * [OrientNode](PhpOrient-Protocols-Common-OrientNode)
             * [TransportInterface](PhpOrient-Protocols-Common-TransportInterface)
+            * [ClustersMap](PhpOrient-Protocols-Common-ClustersMap)
             * [Constants](PhpOrient-Protocols-Common-Constants)
     * [PhpOrient](PhpOrient-PhpOrient)
 
diff --git a/docs/Home.md b/docs/Home.md
@@ -52,10 +52,12 @@ API Index
             * PhpOrient\Protocols\Binary\Transaction
                 * [TxCommit](PhpOrient-Protocols-Binary-Transaction-TxCommit)
         * PhpOrient\Protocols\Common
+            * [OrientVersion](PhpOrient-Protocols-Common-OrientVersion)
             * [AbstractTransport](PhpOrient-Protocols-Common-AbstractTransport)
             * [ConfigurableInterface](PhpOrient-Protocols-Common-ConfigurableInterface)
-            * [ClusterMap](PhpOrient-Protocols-Common-ClusterMap)
+            * [OrientNode](PhpOrient-Protocols-Common-OrientNode)
             * [TransportInterface](PhpOrient-Protocols-Common-TransportInterface)
+            * [ClustersMap](PhpOrient-Protocols-Common-ClustersMap)
             * [Constants](PhpOrient-Protocols-Common-Constants)
     * [PhpOrient](PhpOrient-PhpOrient)
 
diff --git a/docs/PhpOrient-Configuration-Constants.md b/docs/PhpOrient-Configuration-Constants.md
@@ -17,7 +17,7 @@ Constants
 
 ### VERSION
 ```php
-    const VERSION = "v1.1.2"
+    const VERSION = "v1.2.1"
 ```
 
 
@@ -33,15 +33,15 @@ Constants
 
 ### NAME
 ```php
-    const NAME = "PhpOrient - PHP binary client for OrientDB"
+    const NAME = "PhpOrient - Php driver based on the binary protocol of OrientDB."
 ```
 
 
 
 
 ### SUPPORTED_PROTOCOL
 ```php
-    const SUPPORTED_PROTOCOL = 28
+    const SUPPORTED_PROTOCOL = 32
 ```
 
 

diff --git a/docs/PhpOrient-PhpOrient b/docs/PhpOrient-PhpOrient
@@ -461,7 +461,7 @@ A callback function is needed
 
 ### dbReload
 ```php
-    \PhpOrient\Protocols\Common\ClusterMap PhpOrient\PhpOrient::dbReload()
+    \PhpOrient\Protocols\Common\ClustersMap PhpOrient\PhpOrient::dbReload()
 ```
 ##### Reload the structure of a Database
 
@@ -491,7 +491,7 @@ A callback function is needed
 
 ### dbOpen
 ```php
-    \PhpOrient\Protocols\Common\ClusterMap PhpOrient\PhpOrient::dbOpen(string $database, string $username, string $password, array $params)
+    \PhpOrient\Protocols\Common\ClustersMap PhpOrient\PhpOrient::dbOpen(string $database, string $username, string $password, array $params)
 ```
 ##### Open a Database and perform a connection<br />
 if it is not established before

diff --git a/docs/PhpOrient-PhpOrient.md b/docs/PhpOrient-PhpOrient.md
@@ -146,6 +146,18 @@ Properties
 * Visibility: **protected**
 
 
+#### $fetchClass
+```php
+    protected boolean $fetchClass = null
+```
+
+
+
+
+* Visibility: **protected**
+* This property is **static**.
+
+
 Methods
 -------
 
@@ -461,7 +473,7 @@ A callback function is needed
 
 ### dbReload
 ```php
-    \PhpOrient\Protocols\Common\ClusterMap PhpOrient\PhpOrient::dbReload()
+    \PhpOrient\Protocols\Common\ClustersMap PhpOrient\PhpOrient::dbReload()
 ```
 ##### Reload the structure of a Database
 
@@ -491,7 +503,7 @@ A callback function is needed
 
 ### dbOpen
 ```php
-    \PhpOrient\Protocols\Common\ClusterMap PhpOrient\PhpOrient::dbOpen(string $database, string $username, string $password, array $params)
+    \PhpOrient\Protocols\Common\ClustersMap PhpOrient\PhpOrient::dbOpen(string $database, string $username, string $password, array $params)
 ```
 ##### Open a Database and perform a connection<br />
 if it is not established before
@@ -686,6 +698,36 @@ Flushes all cached content to the disk storage and allows to perform only read c
 
 
 
+### setFetchClass
+```php
+    \PhpOrient\PhpOrient PhpOrient\PhpOrient::setFetchClass(boolean|string $className)
+```
+##### Allow the next query to be fetched in a custom class
+
+
+
+* Visibility: **public**
+
+
+##### Arguments
+* $className **boolean|string**
+
+
+
+### getFetchClass
+```php
+    string|boolean PhpOrient\PhpOrient::getFetchClass()
+```
+##### Get the current value of the fetch custom class name
+
+
+
+* Visibility: **public**
+* This method is **static**.
+
+
+
+
 ### configure
 ```php
     \PhpOrient\Protocols\Common\ConfigurableInterface PhpOrient\Protocols\Common\ConfigurableInterface::configure(array $options)

diff --git a/docs/PhpOrient-Protocols-Binary-Abstracts-Operation.md b/docs/PhpOrient-Protocols-Binary-Abstracts-Operation.md
@@ -86,13 +86,13 @@ Properties
 
 #### $_callback
 ```php
-    public \Closure $_callback
+    protected \Closure $_callback
 ```
-
+ Callback function to apply on Async records when they are fetched
 
 
 
-* Visibility: **public**
+* Visibility: **protected**
 
 
 Methods
@@ -185,6 +185,36 @@ Methods
 
 
 
+### _pushReceived
+```php
+    mixed PhpOrient\Protocols\Binary\Abstracts\Operation::_pushReceived($command_id, $payload)
+```
+##### Default callback for received push Notices
+
+
+
+* Visibility: **protected**
+
+
+##### Arguments
+* $command_id **mixed**
+* $payload **mixed**
+
+
+
+### _readError
+```php
+    \PhpOrient\Exceptions\PhpOrientException PhpOrient\Protocols\Binary\Abstracts\Operation::_readError()
+```
+##### Read an error from the remote server and turn it into an exception.
+
+
+
+* Visibility: **protected**
+
+
+
+
 ### prepare
 ```php
     \PhpOrient\Protocols\Binary\Abstracts\Operation PhpOrient\Protocols\Binary\Abstracts\Operation::prepare()
@@ -469,19 +499,6 @@ Methods
 
 
 
-### _readError
-```php
-    \PhpOrient\Exceptions\PhpOrientException PhpOrient\Protocols\Binary\Abstracts\Operation::_readError()
-```
-##### Read an error from the remote server and turn it into an exception.
-
-
-
-* Visibility: **protected**
-
-
-
-
 ### _readSerialized
 ```php
     mixed PhpOrient\Protocols\Binary\Abstracts\Operation::_readSerialized()

diff --git a/docs/PhpOrient-Protocols-Binary-Data-Bag.md b/docs/PhpOrient-Protocols-Binary-Data-Bag.md
@@ -8,7 +8,7 @@ PhpOrient\Protocols\Binary\Data\Bag
 
 * Class name: Bag
 * Namespace: PhpOrient\Protocols\Binary\Data
-* This class implements: Countable, ArrayAccess, Iterator
+* This class implements: Countable, ArrayAccess, Iterator, JsonSerializable
 
 
 Constants
@@ -35,9 +35,9 @@ Properties
 ----------
 
 
-#### $serialized
+#### $base64Content
 ```php
-    protected string $serialized
+    protected string $base64Content
 ```
 
 
@@ -46,9 +46,9 @@ Properties
 * Visibility: **protected**
 
 
-#### $deserialized
+#### $binaryContent
 ```php
-    protected string $deserialized
+    protected string $binaryContent
 ```
 
 
@@ -184,7 +184,7 @@ Methods
 
 ### __construct
 ```php
-    mixed PhpOrient\Protocols\Binary\Data\Bag::__construct(string $serialized)
+    mixed PhpOrient\Protocols\Binary\Data\Bag::__construct(string $base64Content)
 ```
 ##### # RIDBag Constructor
 
@@ -194,7 +194,7 @@ Methods
 
 
 ##### Arguments
-* $serialized **string** <p>the base64 encoded bag</p>
+* $base64Content **string** <p>the base64 encoded bag</p>
 
 
 
@@ -224,6 +224,46 @@ Methods
 
 
 
+### getRids
+```php
+    array PhpOrient\Protocols\Binary\Data\Bag::getRids()
+```
+##### Get the list of contained RIDs
+
+
+
+* Visibility: **public**
+
+
+
+
+### getRawBagContent
+```php
+    string PhpOrient\Protocols\Binary\Data\Bag::getRawBagContent()
+```
+##### Get the original raw content for the Bag
+
+
+
+* Visibility: **public**
+
+
+
+
+### jsonSerialize
+```php
+    mixed PhpOrient\Protocols\Binary\Data\Bag::jsonSerialize()
+```
+##### (PHP 5 &gt;= 5.4.0)<br/>
+Specify data which should be serialized to JSON
+
+
+
+* Visibility: **public**
+
+
+
+
 ### parse
 ```php
     mixed PhpOrient\Protocols\Binary\Data\Bag::parse()

diff --git a/docs/PhpOrient-Protocols-Binary-Data-Record.md b/docs/PhpOrient-Protocols-Binary-Data-Record.md
@@ -154,7 +154,7 @@ Methods
 
 ### setOData
 ```php
-    \PhpOrient\Protocols\Binary\Data\Record PhpOrient\Protocols\Binary\Data\Record::setOData(array $oData)
+    \PhpOrient\Protocols\Binary\Data\Record PhpOrient\Protocols\Binary\Data\Record::setOData(array|null $oData)
 ```
 ##### Sets the Orient Record Content
 
@@ -164,7 +164,7 @@ Methods
 
 
 ##### Arguments
-* $oData **array**
+* $oData **array|null**
 
 
 
@@ -337,35 +337,35 @@ content as property
 
 
 
-### configure
+### fromConfig
 ```php
-    \PhpOrient\Protocols\Binary\Data\Record PhpOrient\Protocols\Binary\Data\Record::configure(array $options)
+    static PhpOrient\Protocols\Binary\Data\Record::fromConfig(array $options)
 ```
-##### Configure the object.
+##### Return a new class instance configured from the given options.
 
 
 
 * Visibility: **public**
+* This method is **static**.
 
 
 ##### Arguments
-* $options **array** <p>The options for the object.</p>
+* $options **array** <p>The options for the newly created class instance.</p>
 
 
 
-### fromConfig
+### configure
 ```php
-    static PhpOrient\Protocols\Binary\Data\Record::fromConfig(array $options)
+    \PhpOrient\Protocols\Binary\Data\Record PhpOrient\Protocols\Binary\Data\Record::configure(array $options)
 ```
-##### Return a new class instance configured from the given options.
+##### Configure the object.
 
 
 
 * Visibility: **public**
-* This method is **static**.
 
 
 ##### Arguments
-* $options **array** <p>The options for the newly created class instance.</p>
+* $options **array** <p>The options for the object.</p>