Merge pull request #7 from stof/fix_phpdoc

avalanche123 · avalanche123 · commit 2a645cef88b1 · 2015-04-02T14:28:38.000-07:00
Fix the phpdoc on classes
diff --git a/src/Cassandra.php b/src/Cassandra.php
@@ -80,7 +80,7 @@ final class Cassandra
     /**
      * Returns a Cluster Builder
      *
-     * @return Cassandra\Cluster\Builder a Cluster Builder instance
+     * @return \Cassandra\Cluster\Builder a Cluster Builder instance
      */
     public static function cluster()
     {
@@ -90,7 +90,7 @@ public static function cluster()
     /**
      * Returns SSL Options Builder
      *
-     * @return Cassanrda\SSLOptions\Builder a SSLOptions Builder instance
+     * @return \Cassandra\SSLOptions\Builder a SSLOptions Builder instance
      */
     public static function ssl()
     {
@@ -101,7 +101,6 @@ public static function ssl()
      * Sets log severity
      *
      * @param  int  $level  log severity, must be one of Cassandra::LOG_* constants.
-     * @return void
      */
     public static function setLogLevel($level)
     {
diff --git a/src/Cassandra/BatchStatement.php b/src/Cassandra/BatchStatement.php
@@ -24,7 +24,7 @@
  * Batch statements are used to execute a series of simple or prepared statements.
  * There are 3 types of batch statements:
  *  * `Cassandra::BATCH_LOGGED`   - this is the default batch type. This batch
- *     gurantees that either all or none of its statements will be executed.
+ *     guarantees that either all or none of its statements will be executed.
  *     This behavior is achieved by writing a batch log on the coordinator, which
  *     slows down the execution somewhat.
  *   * `Cassandra::BATCH_UNLOGGED` - this batch will not be verified when executed,
@@ -74,8 +74,11 @@ public function __construct($type = \Cassandra::BATCH_LOGGED)
 
     /**
      * Adds a statement to this batch
-     * @param Cassandra\Statement $statement the statement to add
+     *
+     * @param Statement $statement the statement to add
      * @param array|null          $arguments positional or named arguments
+     *
+     * @return self
      */
     public function add(Statement $statement, array $arguments = null)
     {
diff --git a/src/Cassandra/Cluster.php b/src/Cassandra/Cluster.php
@@ -28,7 +28,7 @@ interface Cluster
      *
      * @param  string  $keyspace  Optional keyspace name
      *
-     * @return  Cassandra\Session  Session instance
+     * @return  Session  Session instance
      */
     public function connect($keyspace = null);
 }
diff --git a/src/Cassandra/Cluster/Builder.php b/src/Cassandra/Cluster/Builder.php
@@ -31,7 +31,7 @@ final class Builder
 {
     /**
      * Contact points, defaults to "127.0.0.1"
-     * @var contactPoints
+     * @var string
      */
     private $contactPoints;
 
@@ -91,7 +91,7 @@ final class Builder
 
     /**
      * sslOptions
-     * @var Cassandra\SSLOptions
+     * @var SSLOptions
      */
     private $sslOptions;
 
@@ -133,7 +133,7 @@ public function __construct()
     /**
      * Returns a Cluster Instance
      *
-     * @return Cassandra\Cluster Cluster instance
+     * @return \Cassandra\Cluster Cluster instance
      */
     public function build()
     {
@@ -182,7 +182,7 @@ public function build()
     /**
      * Configures default consistency for all requests
      * @param int $consistency A consistency level, must be one of Cassandra::CONSISTENCY_* values
-     * @return Cassandra\Cluster\Builder self
+     * @return self
      */
     public function withDefaultConsistency($consistency)
     {
@@ -213,6 +213,8 @@ public function withDefaultConsistency($consistency)
      * Configures default page size for all results.
      * Set to -1 to disable paging altogether.
      * @param int $pageSize default page size
+     *
+     * @return self
      */
     public function withDefaultPageSize($pageSize)
     {
@@ -224,12 +226,16 @@ public function withDefaultPageSize($pageSize)
       }
 
       $this->defaultPageSize = $pageSize;
+
+        return $this;
     }
 
     /**
      * Configures default timeout for future resolution in blocking operations
      * Set to null to disable (default)
      * @param int|null $timeout timeout value
+     *
+     * @return self
      */
     public function withDefaultTimeout($timeout)
     {
@@ -241,6 +247,8 @@ public function withDefaultTimeout($timeout)
       }
 
       $this->defaultTimeout = $timeout;
+
+        return $this;
     }
 
     /**
@@ -249,7 +257,7 @@ public function withDefaultTimeout($timeout)
      *
      * @param  string $host  an ip address string
      * @param  string ...    additional addresses
-     * @return Cassandra\Cluster\Builder self
+     * @return self
      */
     public function withContactPoints($host)
     {
@@ -260,7 +268,7 @@ public function withContactPoints($host)
     /**
      * Configures this cluster to use a round robin load balancing policy.
      *
-     * @return Cassandra\Cluster\Builder self
+     * @return self
      */
     public function withRoundRobinLoadBalancingPolicy()
     {
@@ -275,7 +283,7 @@ public function withRoundRobinLoadBalancingPolicy()
      * @param integer $hostPerRemoteDatacenter                  Maximum number of hosts to try in remote datacenters
      * @param boolean $useRemoteDatacenterForLocalConsistencies Allow using hosts from remote datacenters to execute statements with local consistencies
      *
-     * @return Cassandra\Cluster\Builder self
+     * @return self
      */
     public function withDatacenterAwareRoundRobinLoadBalancingPolicy($localDatacenter, $hostPerRemoteDatacenter, $useRemoteDatacenterForLocalConsistencies)
     {
@@ -299,7 +307,7 @@ public function withDatacenterAwareRoundRobinLoadBalancingPolicy($localDatacente
      *
      * @param boolean $enabled Whether to enable token aware routing (default: `true`)
      *
-     * @return Cassandra\Cluster\Builder self
+     * @return self
      */
     public function withTokenAwareRouting($enabled = true)
     {
@@ -313,7 +321,7 @@ public function withTokenAwareRouting($enabled = true)
      * @param string $username Username
      * @param string $password Password
      *
-     * @return Cassandra\Cluster\Builder self
+     * @return self
      */
     public function withCredentials($username, $password)
     {
@@ -327,7 +335,7 @@ public function withCredentials($username, $password)
      *
      * @param float $timeout Timeout value in seconds, can be fractional
      *
-     * @return Cassandra\Cluster\Builder self
+     * @return self
      */
     public function withConnectTimeout($timeout)
     {
@@ -340,7 +348,7 @@ public function withConnectTimeout($timeout)
      *
      * @param float $timeout Timeout value in seconds, can be fractional
      *
-     * @return Cassandra\Cluster\Builder self
+     * @return self
      */
     public function withRequestTimeout($timeout)
     {
@@ -350,7 +358,10 @@ public function withRequestTimeout($timeout)
 
     /**
      * Set up ssl context
-     * @param SSLOptions $context a preconfigured ssl context
+     *
+     * @param SSLOptions $options a preconfigured ssl context
+     *
+     * @return self
      */
     public function withSSL(SSLOptions $options)
     {
diff --git a/src/Cassandra/DefaultCluster.php b/src/Cassandra/DefaultCluster.php
@@ -41,6 +41,7 @@ final class DefaultCluster implements Cluster
     /**
      * Holds a reference to SSLContext resource if was configured with SSL.
      * This is necessary to prevent GC from destroying it before the cluster.
+     * @see https://datastax-oss.atlassian.net/projects/PHP/issues/PHP-5
      * @var resource|null
      */
     private $ssl;
@@ -50,6 +51,8 @@ final class DefaultCluster implements Cluster
      * a reference to it to prevent GC from destroying it before the cluster.
      * @access private
      * @param resource $resource Cluster resource
+     * @param ExecutionOptions $defaults
+     * @param resource $ssl
      */
     public function __construct($resource, ExecutionOptions $defaults, $ssl = null)
     {
diff --git a/src/Cassandra/Future.php b/src/Cassandra/Future.php
@@ -30,8 +30,10 @@ interface Future
     /**
      * Waits for a given future resource to resolve and throws errors if any
      *
-     * @throws Cassandra\Exception\InvalidArgumentException
-     * @throws Cassandra\Exception\TimeoutException
+     * @throws \Cassandra\Exception\InvalidArgumentException
+     * @throws \Cassandra\Exception\TimeoutException
+     *
+     * @param int|null $timeout
      *
      * @return mixed a value that the future has been resolved with
      */
diff --git a/src/Cassandra/FutureException.php b/src/Cassandra/FutureException.php
@@ -31,7 +31,7 @@ final class FutureException implements Future
 
     /**
      * Creates a future exception.
-     * @param Exception $exception an exception to resolve this futuer with.
+     * @param \Exception $exception an exception to resolve this future with.
      */
     public function __construct(\Exception $exception)
     {
diff --git a/src/Cassandra/FuturePreparedStatement.php b/src/Cassandra/FuturePreparedStatement.php
@@ -36,7 +36,7 @@ final class FuturePreparedStatement implements Future
     private $resource;
     /**
      * The prepared statement that this future will resolve with
-     * @var Cassandra\PreparedStatement
+     * @var PreparedStatement
      */
     private $statement;
 
diff --git a/src/Cassandra/FutureRows.php b/src/Cassandra/FutureRows.php
@@ -46,7 +46,7 @@ final class FutureRows implements Future
 
     /**
      * Rows that this future will resolve with
-     * @var Cassandra\Rows
+     * @var Rows
      */
     private $rows;
 
diff --git a/src/Cassandra/FutureSession.php b/src/Cassandra/FutureSession.php
@@ -28,7 +28,7 @@ final class FutureSession implements Future
 {
     /**
      * Session instance that this future will resolve with.
-     * @var Cassandra\Session
+     * @var Session
      */
     private $session;
 
@@ -48,7 +48,7 @@ final class FutureSession implements Future
      * Creates a new session future.
      * @access private
      * @param resource          $resource Actual future resource
-     * @param Cassandra\Session $session  A session that will be connected
+     * @param Session $session  A session that will be connected
      */
     public function __construct($resource, Session $session)
     {
diff --git a/src/Cassandra/Row.php b/src/Cassandra/Row.php
@@ -96,7 +96,8 @@ public function valid()
 
     /**
      * Rows are read-only so this method throws an exception and doesn't do anything.
-     * @throws Cassandra\Exception\DomainException
+     *
+     * @throws DomainException
      * @param string $offset
      * @param mixed  $value
      */
@@ -109,7 +110,7 @@ public function offsetSet($offset, $value) {
 
     /**
      * Rows are read-only so this method throws an exception and doesn't do anything.
-     * @throws Cassandra\Exception\DomainException
+     * @throws DomainException
      * @param string $offset
      */
     public function offsetUnset($offset) {
diff --git a/src/Cassandra/Rows.php b/src/Cassandra/Rows.php
@@ -132,7 +132,7 @@ public function offsetExists($offset)
             ));
         }
 
-        return $offset >= 0 && $offset < $this->count;
+        return $offset >= 0 && $offset < count($this->rows);
     }
 
     /**
@@ -178,15 +178,17 @@ public function isLastPage()
     }
 
     /**
-     * @return  Cassandra\Result|null  loads and returns next result page
+     * @param int|null $timeout
+     *
+     * @return  Rows|null  loads and returns next result page
      */
     public function nextPage($timeout = null)
     {
         return $this->nextPageAsync()->get($timeout);
     }
 
     /**
-     * @return  Cassandra\Future  returns future of the next result page
+     * @return  Future  returns future of the next result page
      */
     public function nextPageAsync()
     {
@@ -203,7 +205,7 @@ public function nextPageAsync()
     }
 
     /**
-     * @return  Cassandra\Row|null  returns first row if any
+     * @return  Row|null  returns first row if any
      */
     public function first()
     {
diff --git a/src/Cassandra/SSLOptions/Builder.php b/src/Cassandra/SSLOptions/Builder.php
@@ -76,7 +76,7 @@ public function __construct()
      * @param string $path path to a file containing a PEM formatted certificate.
      * @param string ...   additional paths
      *
-     * @return Cassandra\SSLOptions\Builder self
+     * @return Builder self
      */
     public function withTrustedCerts($path)
     {
@@ -96,7 +96,9 @@ public function withTrustedCerts($path)
     /**
      * Disable certificate verification
      *
-     * @return Cassandra\SSLOptions\Builder self
+     * @param int $flags
+     *
+     * @return self
      */
     public function withVerifyFlags($flags)
     {
@@ -105,13 +107,14 @@ public function withVerifyFlags($flags)
     }
 
     /**
-     * Set client-side certificate chain. This is used to authenticate the
-     * client on the server-side. This should contain the entire Certificate
+     * Set client-side certificate chain.
+     *
+     * This is used to authenticate the client on the server-side. This should contain the entire Certificate
      * chain starting with the certificate itself.
      *
-     * @param [type] $path path to a file containing a PEM formatted certificate.
+     * @param string $path path to a file containing a PEM formatted certificate.
      *
-     * @return Cassandra\SSLOptions\Builder self
+     * @return self
      */
     public function withClientCert($path)
     {
@@ -130,9 +133,9 @@ public function withClientCert($path)
      * the server-side.
      *
      * @param string $path       Path to the private key file
-     * @param string $passphrase Passphrase for the private key, if any (default: `null`)
+     * @param string|null $passphrase Passphrase for the private key, if any (default: `null`)
      *
-     * @return Cassandra\SSLOptions\Builder self
+     * @return self
      */
     function withPrivateKey($path, $passphrase = null)
     {
@@ -153,7 +156,7 @@ function withPrivateKey($path, $passphrase = null)
 
     /**
      * Builds SSL options
-     * @return Cassandra\SSLOptions ssl options configured accordingly.
+     * @return SSLOptions ssl options configured accordingly.
      */
     public function build()
     {
diff --git a/src/Cassandra/Session.php b/src/Cassandra/Session.php
diff --git a/src/Cassandra/Statement.php b/src/Cassandra/Statement.php

Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ final class Cassandra`
`80`	`80`	`/**`
`81`	`81`	`* Returns a Cluster Builder`
`82`	`82`	`*`
`83`		`- * @return Cassandra\Cluster\Builder a Cluster Builder instance`
	`83`	`+ * @return \Cassandra\Cluster\Builder a Cluster Builder instance`
`84`	`84`	`*/`
`85`	`85`	`public static function cluster()`
`86`	`86`	`{`
`@@ -90,7 +90,7 @@ public static function cluster()`
`90`	`90`	`/**`
`91`	`91`	`* Returns SSL Options Builder`
`92`	`92`	`*`
`93`		`- * @return Cassanrda\SSLOptions\Builder a SSLOptions Builder instance`
	`93`	`+ * @return \Cassandra\SSLOptions\Builder a SSLOptions Builder instance`
`94`	`94`	`*/`
`95`	`95`	`public static function ssl()`
`96`	`96`	`{`
`@@ -101,7 +101,6 @@ public static function ssl()`
`101`	`101`	`* Sets log severity`
`102`	`102`	`*`
`103`	`103`	`* @param int $level log severity, must be one of Cassandra::LOG_* constants.`
`104`		`- * @return void`
`105`	`104`	`*/`
`106`	`105`	`public static function setLogLevel($level)`
`107`	`106`	`{`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ interface Cluster`
`28`	`28`	`*`
`29`	`29`	`* @param string $keyspace Optional keyspace name`
`30`	`30`	`*`
`31`		`- * @return Cassandra\Session Session instance`
	`31`	`+ * @return Session Session instance`
`32`	`32`	`*/`
`33`	`33`	`public function connect($keyspace = null);`
`34`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ final class Builder`
`31`	`31`	`{`
`32`	`32`	`/**`
`33`	`33`	`* Contact points, defaults to "127.0.0.1"`
`34`		`- * @var contactPoints`
	`34`	`+ * @var string`
`35`	`35`	`*/`
`36`	`36`	`private $contactPoints;`
`37`	`37`
`@@ -91,7 +91,7 @@ final class Builder`
`91`	`91`
`92`	`92`	`/**`
`93`	`93`	`* sslOptions`
`94`		`- * @var Cassandra\SSLOptions`
	`94`	`+ * @var SSLOptions`
`95`	`95`	`*/`
`96`	`96`	`private $sslOptions;`
`97`	`97`
`@@ -133,7 +133,7 @@ public function __construct()`
`133`	`133`	`/**`
`134`	`134`	`* Returns a Cluster Instance`
`135`	`135`	`*`
`136`		`- * @return Cassandra\Cluster Cluster instance`
	`136`	`+ * @return \Cassandra\Cluster Cluster instance`
`137`	`137`	`*/`
`138`	`138`	`public function build()`
`139`	`139`	`{`
`@@ -182,7 +182,7 @@ public function build()`
`182`	`182`	`/**`
`183`	`183`	`* Configures default consistency for all requests`
`184`	`184`	`* @param int $consistency A consistency level, must be one of Cassandra::CONSISTENCY_* values`
`185`		`- * @return Cassandra\Cluster\Builder self`
	`185`	`+ * @return self`
`186`	`186`	`*/`
`187`	`187`	`public function withDefaultConsistency($consistency)`
`188`	`188`	`{`
`@@ -213,6 +213,8 @@ public function withDefaultConsistency($consistency)`
`213`	`213`	`* Configures default page size for all results.`
`214`	`214`	`* Set to -1 to disable paging altogether.`
`215`	`215`	`* @param int $pageSize default page size`
	`216`	`+ *`
	`217`	`+ * @return self`
`216`	`218`	`*/`
`217`	`219`	`public function withDefaultPageSize($pageSize)`
`218`	`220`	`{`
`@@ -224,12 +226,16 @@ public function withDefaultPageSize($pageSize)`
`224`	`226`	`}`
`225`	`227`
`226`	`228`	`$this->defaultPageSize = $pageSize;`
	`229`	`+`
	`230`	`+ return $this;`
`227`	`231`	`}`
`228`	`232`
`229`	`233`	`/**`
`230`	`234`	`* Configures default timeout for future resolution in blocking operations`
`231`	`235`	`* Set to null to disable (default)`
`232`	`236`	`* @param int\|null $timeout timeout value`
	`237`	`+ *`
	`238`	`+ * @return self`
`233`	`239`	`*/`
`234`	`240`	`public function withDefaultTimeout($timeout)`
`235`	`241`	`{`
`@@ -241,6 +247,8 @@ public function withDefaultTimeout($timeout)`
`241`	`247`	`}`
`242`	`248`
`243`	`249`	`$this->defaultTimeout = $timeout;`
	`250`	`+`
	`251`	`+ return $this;`
`244`	`252`	`}`
`245`	`253`
`246`	`254`	`/**`
`@@ -249,7 +257,7 @@ public function withDefaultTimeout($timeout)`
`249`	`257`	`*`
`250`	`258`	`* @param string $host an ip address string`
`251`	`259`	`* @param string ... additional addresses`
`252`		`- * @return Cassandra\Cluster\Builder self`
	`260`	`+ * @return self`
`253`	`261`	`*/`
`254`	`262`	`public function withContactPoints($host)`
`255`	`263`	`{`
`@@ -260,7 +268,7 @@ public function withContactPoints($host)`
`260`	`268`	`/**`
`261`	`269`	`* Configures this cluster to use a round robin load balancing policy.`
`262`	`270`	`*`
`263`		`- * @return Cassandra\Cluster\Builder self`
	`271`	`+ * @return self`
`264`	`272`	`*/`
`265`	`273`	`public function withRoundRobinLoadBalancingPolicy()`
`266`	`274`	`{`
`@@ -275,7 +283,7 @@ public function withRoundRobinLoadBalancingPolicy()`
`275`	`283`	`* @param integer $hostPerRemoteDatacenter Maximum number of hosts to try in remote datacenters`
`276`	`284`	`* @param boolean $useRemoteDatacenterForLocalConsistencies Allow using hosts from remote datacenters to execute statements with local consistencies`
`277`	`285`	`*`
`278`		`- * @return Cassandra\Cluster\Builder self`
	`286`	`+ * @return self`
`279`	`287`	`*/`
`280`	`288`	`public function withDatacenterAwareRoundRobinLoadBalancingPolicy($localDatacenter, $hostPerRemoteDatacenter, $useRemoteDatacenterForLocalConsistencies)`
`281`	`289`	`{`
`@@ -299,7 +307,7 @@ public function withDatacenterAwareRoundRobinLoadBalancingPolicy($localDatacente`
`299`	`307`	`*`
`300`	`308`	* @param boolean $enabled Whether to enable token aware routing (default: `true`)
`301`	`309`	`*`
`302`		`- * @return Cassandra\Cluster\Builder self`
	`310`	`+ * @return self`
`303`	`311`	`*/`
`304`	`312`	`public function withTokenAwareRouting($enabled = true)`
`305`	`313`	`{`
`@@ -313,7 +321,7 @@ public function withTokenAwareRouting($enabled = true)`
`313`	`321`	`* @param string $username Username`
`314`	`322`	`* @param string $password Password`
`315`	`323`	`*`
`316`		`- * @return Cassandra\Cluster\Builder self`
	`324`	`+ * @return self`
`317`	`325`	`*/`
`318`	`326`	`public function withCredentials($username, $password)`
`319`	`327`	`{`
`@@ -327,7 +335,7 @@ public function withCredentials($username, $password)`
`327`	`335`	`*`
`328`	`336`	`* @param float $timeout Timeout value in seconds, can be fractional`
`329`	`337`	`*`
`330`		`- * @return Cassandra\Cluster\Builder self`
	`338`	`+ * @return self`
`331`	`339`	`*/`
`332`	`340`	`public function withConnectTimeout($timeout)`
`333`	`341`	`{`
`@@ -340,7 +348,7 @@ public function withConnectTimeout($timeout)`
`340`	`348`	`*`
`341`	`349`	`* @param float $timeout Timeout value in seconds, can be fractional`
`342`	`350`	`*`
`343`		`- * @return Cassandra\Cluster\Builder self`
	`351`	`+ * @return self`
`344`	`352`	`*/`
`345`	`353`	`public function withRequestTimeout($timeout)`
`346`	`354`	`{`
`@@ -350,7 +358,10 @@ public function withRequestTimeout($timeout)`
`350`	`358`
`351`	`359`	`/**`
`352`	`360`	`* Set up ssl context`
`353`		`- * @param SSLOptions $context a preconfigured ssl context`
	`361`	`+ *`
	`362`	`+ * @param SSLOptions $options a preconfigured ssl context`
	`363`	`+ *`
	`364`	`+ * @return self`
`354`	`365`	`*/`
`355`	`366`	`public function withSSL(SSLOptions $options)`
`356`	`367`	`{`
Original file line number	Diff line number	Diff line change
`@@ -30,8 +30,10 @@ interface Future`
`30`	`30`	`/**`
`31`	`31`	`* Waits for a given future resource to resolve and throws errors if any`
`32`	`32`	`*`
`33`		`- * @throws Cassandra\Exception\InvalidArgumentException`
`34`		`- * @throws Cassandra\Exception\TimeoutException`
	`33`	`+ * @throws \Cassandra\Exception\InvalidArgumentException`
	`34`	`+ * @throws \Cassandra\Exception\TimeoutException`
	`35`	`+ *`
	`36`	`+ * @param int\|null $timeout`
`35`	`37`	`*`
`36`	`38`	`* @return mixed a value that the future has been resolved with`
`37`	`39`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ final class FutureException implements Future`
`31`	`31`
`32`	`32`	`/**`
`33`	`33`	`* Creates a future exception.`
`34`		`- * @param Exception $exception an exception to resolve this futuer with.`
	`34`	`+ * @param \Exception $exception an exception to resolve this future with.`
`35`	`35`	`*/`
`36`	`36`	`public function __construct(\Exception $exception)`
`37`	`37`	`{`