Merge pull request andreiz#36 from dtakken/update-api-stubs

Some updates to the PHP API stubs

Author: Timandes

zookeeper-api.php

@@ -2,6 +2,7 @@
 
 /**
  * Zookeeper class.
+ * @link https://www.php.net/manual/en/class.zookeeper.php
  */
 class Zookeeper
 {
@@ -64,13 +65,16 @@ class Zookeeper
 
 
     /**
-     * Create a handle to used communicate with zookeeper. * if the host is provided, attempt to connect.
+     * Create a handle to used communicate with zookeeper.
+     * If the host is provided, attempt to connect.
      *
      * @param string   $host
      * @param callable $watcher_cb
      * @param int      $recv_timeout
      *
-     * @throws ZookeeperConnectionException when host is provided and when failed to connect to the host.
+     * @link https://www.php.net/manual/en/zookeeper.construct.php
+     *
+     * @throws ZookeeperConnectionException when host is provided and when failed to connect to the host
      */
     public function __construct($host = '', $watcher_cb = null, $recv_timeout = 10000)
     {
@@ -83,12 +87,25 @@ public function __construct($host = '', $watcher_cb = null, $recv_timeout = 1000
      * @param callable $watcher_cb
      * @param int      $recv_timeout
      *
+     * @link https://www.php.net/manual/en/zookeeper.connect.php
+     *
      * @throws ZookeeperConnectionException when failed to connect to Zookeeper
      */
     public function connect($host, $watcher_cb = null, $recv_timeout = 10000)
     {
     }
 
+    /**
+     * Close the zookeeper handle and free up any resources.
+     *
+     * @link https://www.php.net/manual/en/zookeeper.close.php
+     *
+     * @throws ZookeeperConnectionException when closing an uninitialized instance
+     */
+    public function close()
+    {
+    }
+
     /**
      * Create a node synchronously.
      *
@@ -98,7 +115,11 @@ public function connect($host, $watcher_cb = null, $recv_timeout = 10000)
      * @param int    $flags
      *
      * @return string
+     *
+     * @link https://www.php.net/manual/en/zookeeper.create.php
+     *
      * @throws ZookeeperException
+     * @throws ZookeeperNoNodeException when parent path does not exist
      */
     public function create($path, $value, $acl, $flags = null)
     {
@@ -111,7 +132,11 @@ public function create($path, $value, $acl, $flags = null)
      * @param int    $version
      *
      * @return bool
+     *
+     * @link https://www.php.net/manual/en/zookeeper.delete.php
+     *
      * @throws ZookeeperException
+     * @throws ZookeeperNoNodeException when path does not exist
      */
     public function delete($path, $version = -1)
     {
@@ -126,7 +151,11 @@ public function delete($path, $version = -1)
      * @param array  $stat
      *
      * @return bool
-     * @throws ZookeeperException
+     *
+     * @link https://www.php.net/manual/en/zookeeper.set.php
+     *
+     * @throws ZookeeperException when the version check fails
+     * @throws ZookeeperNoNodeException when path does not exist
      */
     public function set($path, $data, $version = -1, &$stat = null)
     {
@@ -141,7 +170,11 @@ public function set($path, $data, $version = -1, &$stat = null)
      * @param int      $max_size
      *
      * @return string
+     *
+     * @link https://www.php.net/manual/en/zookeeper.get.php
+     *
      * @throws ZookeeperException
+     * @throws ZookeeperNoNodeException when path does not exist
      */
     public function get($path, $watcher_cb = null, &$stat = null, $max_size = 0)
     {
@@ -154,7 +187,11 @@ public function get($path, $watcher_cb = null, &$stat = null, $max_size = 0)
      * @param callable $watcher_cb
      *
      * @return array
-     * @throws ZookeeperException when connection not in connected status
+     *
+     * @link https://www.php.net/manual/en/zookeeper.getchildren.php
+     *
+     * @throws ZookeeperException       when connection not in connected status
+     * @throws ZookeeperNoNodeException when path does not exist
      */
     public function getChildren($path, $watcher_cb = null)
     {
@@ -167,6 +204,9 @@ public function getChildren($path, $watcher_cb = null)
      * @param callable $watcher_cb
      *
      * @return bool
+     *
+     * @link https://www.php.net/manual/en/zookeeper.exists.php
+     *
      * @throws ZookeeperException
      */
     public function exists($path, $watcher_cb = null)
@@ -179,6 +219,9 @@ public function exists($path, $watcher_cb = null)
      * @param string $path
      *
      * @return array
+     *
+     * @link https://www.php.net/manual/en/zookeeper.getacl.php
+     *
      * @throws ZookeeperException when connection not in connected status
      */
     public function getAcl($path)
@@ -192,7 +235,10 @@ public function getAcl($path)
      * @param int    $version
      * @param array  $acls
      *
+     * @link https://www.php.net/manual/en/zookeeper.setacl.php
+     *
      * @return bool
+     *
      * @throws ZookeeperException when connection not in connected status
      */
     public function setAcl($path, $version, $acls)
@@ -201,9 +247,12 @@ public function setAcl($path, $version, $acls)
 
     /**
      * return the client session id, only valid if the connections is currently connected
-     * (ie. last watcher state is ZOO_CONNECTED_STATE)
+     * (ie. last watcher state is ZOO_CONNECTED_STATE).
      *
      * @return int
+     *
+     * @link https://www.php.net/manual/en/zookeeper.getclientid.php
+     *
      * @throws ZookeeperConnectionException when connection not in connected status
      */
     public function getClientId()
@@ -216,6 +265,9 @@ public function getClientId()
      * @param callable $watcher_cb
      *
      * @return bool
+     *
+     * @link https://www.php.net/manual/en/zookeeper.setwatcher.php
+     *
      * @throws ZookeeperConnectionException when connection not in connected status
      */
     public function setWatcher($watcher_cb)
@@ -226,6 +278,9 @@ public function setWatcher($watcher_cb)
      * Get the state of the zookeeper connection.
      *
      * @return int
+     *
+     * @link https://www.php.net/manual/en/zookeeper.getstate.php
+     *
      * @throws ZookeeperConnectionException when connection not in connected status
      */
     public function getState()
@@ -237,6 +292,9 @@ public function getState()
      * (ie. last watcher state is ZOO_CONNECTED_STATE). This value may change after a server reconnect.
      *
      * @return int
+     *
+     * @link https://www.php.net/manual/en/zookeeper.getrecvtimeout.php
+     *
      * @throws ZookeeperConnectionException when connection not in connected status
      */
     public function getRecvTimeout()
@@ -250,6 +308,8 @@ public function getRecvTimeout()
      * @param string   $cert
      * @param callable $completion_cb
      *
+     * @link https://www.php.net/manual/en/zookeeper.addauth.php
+     *
      * @return bool
      */
     public function addAuth($scheme, $cert, $completion_cb = null)
@@ -260,6 +320,9 @@ public function addAuth($scheme, $cert, $completion_cb = null)
      * Checks if the current zookeeper connection state can be recovered.
      *
      * @return bool
+     *
+     * @link https://www.php.net/manual/en/zookeeper.isrecoverable.php
+     *
      * @throws ZookeeperConnectionException when connection not in connected status
      */
     public function isRecoverable()
@@ -273,6 +336,8 @@ public function isRecoverable()
      *
      * @param resource $file
      *
+     * @link https://www.php.net/manual/en/zookeeper.setlogstream.php
+     *
      * @return bool
      */
     public function setLogStream($file)
@@ -284,6 +349,8 @@ public function setLogStream($file)
      *
      * @param int $level
      *
+     * @link https://www.php.net/manual/en/zookeeper.setdebuglevel.php
+     *
      * @return bool
      */
     public static function setDebugLevel($level)
@@ -295,6 +362,8 @@ public static function setDebugLevel($level)
      *
      * @param bool $trueOrFalse
      *
+     * @link https://www.php.net/manual/en/zookeeper.setdeterministicconnorder.php
+     *
      * @return bool
      */
     public static function setDeterministicConnOrder($trueOrFalse)