- Fix for generate_doc.php to generate correct namespaces for "extends" and "implements"

Vasyl Sovyak · Vasyl Sovyak · commit 9c84d3c2e8b8 · 2018-09-06T10:57:26.000+03:00
- Regenerated docs with applied fix in generator.
diff --git a/ext/doc/Cassandra.php b/ext/doc/Cassandra.php
@@ -379,12 +379,12 @@ final class Cassandra {
     /**
      * The current version of the extension.
      */
-    const VERSION = '1.3.1';
+    const VERSION = '1.3.2';
 
     /**
      * The version of the cpp-driver the extension is compiled against.
      */
-    const CPP_DRIVER_VERSION = '2.7.0';
+    const CPP_DRIVER_VERSION = '2.9.0';
 
     /**
      * Creates a new cluster builder for constructing a Cluster object.
diff --git a/ext/doc/Cassandra/Cluster/Builder.php b/ext/doc/Cassandra/Cluster/Builder.php
@@ -323,6 +323,10 @@ public function withSchemaMetadata($enabled) { }
      * reverse IP lookup. This is useful for authentication (Kerberos) or
      * encryption SSL services that require a valid hostname for verification.
      *
+     * Important: It's possible that the underlying C/C++ driver does not
+     * support hostname resolution. A PHP warning will be emitted if the driver
+     * does not support hostname resolution.
+     *
      * @param bool $enabled whether the driver uses hostname resolution.
      *
      * @return Builder self
diff --git a/ext/doc/Cassandra/Exception/DomainException.php b/ext/doc/Cassandra/Exception/DomainException.php
@@ -21,7 +21,7 @@
 /**
  * Cassandra domain exception.
  */
-class DomainException extends \DomainException implements Exception {
+class DomainException extends \DomainException implements \Cassandra\Exception {
 
     /**
      * @param mixed $message
diff --git a/ext/doc/Cassandra/Exception/InvalidArgumentException.php b/ext/doc/Cassandra/Exception/InvalidArgumentException.php
@@ -21,7 +21,7 @@
 /**
  * Cassandra invalid argument exception.
  */
-class InvalidArgumentException extends \InvalidArgumentException implements Exception {
+class InvalidArgumentException extends \InvalidArgumentException implements \Cassandra\Exception {
 
     /**
      * @param mixed $message
diff --git a/ext/doc/Cassandra/Exception/LogicException.php b/ext/doc/Cassandra/Exception/LogicException.php
@@ -21,7 +21,7 @@
 /**
  * Cassandra logic exception.
  */
-class LogicException extends \LogicException implements Exception {
+class LogicException extends \LogicException implements \Cassandra\Exception {
 
     /**
      * @param mixed $message
diff --git a/ext/doc/Cassandra/Exception/RangeException.php b/ext/doc/Cassandra/Exception/RangeException.php
@@ -21,7 +21,7 @@
 /**
  * Cassandra domain exception.
  */
-class RangeException extends \RangeException implements Exception {
+class RangeException extends \RangeException implements \Cassandra\Exception {
 
     /**
      * @param mixed $message
diff --git a/ext/doc/Cassandra/Exception/RuntimeException.php b/ext/doc/Cassandra/Exception/RuntimeException.php
@@ -21,7 +21,7 @@
 /**
  * Cassandra runtime exception.
  */
-class RuntimeException extends \RuntimeException implements Exception {
+class RuntimeException extends \RuntimeException implements \Cassandra\Exception {
 
     /**
      * @param mixed $message
diff --git a/ext/doc/Cassandra/RetryPolicy/DefaultPolicy.php b/ext/doc/Cassandra/RetryPolicy/DefaultPolicy.php
@@ -28,6 +28,6 @@
  *
  * In all other cases the error will be returned.
  */
-final class DefaultPolicy implements RetryPolicy {
+final class DefaultPolicy implements \Cassandra\RetryPolicy {
 
 }
diff --git a/ext/doc/Cassandra/RetryPolicy/DowngradingConsistency.php b/ext/doc/Cassandra/RetryPolicy/DowngradingConsistency.php
@@ -39,6 +39,6 @@
  * Important: This policy may attempt to retry requests with a lower
  * consistency level. Using this policy can break consistency guarantees.
  */
-final class DowngradingConsistency implements RetryPolicy {
+final class DowngradingConsistency implements \Cassandra\RetryPolicy {
 
 }
diff --git a/ext/doc/Cassandra/RetryPolicy/Fallthrough.php b/ext/doc/Cassandra/RetryPolicy/Fallthrough.php
@@ -21,6 +21,6 @@
 /**
  * A retry policy that never retries and allows all errors to fallthrough.
  */
-final class Fallthrough implements RetryPolicy {
+final class Fallthrough implements \Cassandra\RetryPolicy {
 
 }
diff --git a/ext/doc/Cassandra/RetryPolicy/Logging.php b/ext/doc/Cassandra/RetryPolicy/Logging.php
@@ -21,7 +21,7 @@
 /**
  * A retry policy that logs the decisions of its child policy.
  */
-final class Logging implements RetryPolicy {
+final class Logging implements \Cassandra\RetryPolicy {
 
     /**
      * Creates a new Logging retry policy.
diff --git a/ext/doc/Cassandra/TimestampGenerator/Monotonic.php b/ext/doc/Cassandra/TimestampGenerator/Monotonic.php
@@ -27,6 +27,6 @@
  * exceeded then a warning is logged and timestamps stop incrementing until
  * the next clock tick.
  */
-final class Monotonic implements TimestampGenerator {
+final class Monotonic implements \Cassandra\TimestampGenerator {
 
 }
diff --git a/ext/doc/Cassandra/TimestampGenerator/ServerSide.php b/ext/doc/Cassandra/TimestampGenerator/ServerSide.php
@@ -21,6 +21,6 @@
 /**
  * A timestamp generator that allows the server-side to assign timestamps.
  */
-final class ServerSide implements TimestampGenerator {
+final class ServerSide implements \Cassandra\TimestampGenerator {
 
 }
diff --git a/ext/doc/Cassandra/Type/Collection.php b/ext/doc/Cassandra/Type/Collection.php
@@ -22,7 +22,7 @@
  * A class that represents the list type. The list type contains the type of the
  * elements contain in the list.
  */
-final class Collection extends Type {
+final class Collection extends \Cassandra\Type {
 
     private function __construct() { }
 
diff --git a/ext/doc/Cassandra/Type/Custom.php b/ext/doc/Cassandra/Type/Custom.php
@@ -21,7 +21,7 @@
 /**
  * A class that represents a custom type.
  */
-final class Custom extends Type {
+final class Custom extends \Cassandra\Type {
 
     private function __construct() { }
 
diff --git a/ext/doc/Cassandra/Type/Map.php b/ext/doc/Cassandra/Type/Map.php
@@ -22,7 +22,7 @@
  * A class that represents the map type. The map type contains two types that
  * represents the types of the key and value contained in the map.
  */
-final class Map extends Type {
+final class Map extends \Cassandra\Type {
 
     private function __construct() { }
 
diff --git a/ext/doc/Cassandra/Type/Scalar.php b/ext/doc/Cassandra/Type/Scalar.php
@@ -21,7 +21,7 @@
 /**
  * A class that represents a primitive type (e.g. `varchar` or `bigint`)
  */
-final class Scalar extends Type {
+final class Scalar extends \Cassandra\Type {
 
     private function __construct() { }
 
diff --git a/ext/doc/Cassandra/Type/Set.php b/ext/doc/Cassandra/Type/Set.php
@@ -22,7 +22,7 @@
  * A class that represents the set type. The set type contains the type of the
  * elements contain in the set.
  */
-final class Set extends Type {
+final class Set extends \Cassandra\Type {
 
     private function __construct() { }
 
diff --git a/ext/doc/Cassandra/Type/Tuple.php b/ext/doc/Cassandra/Type/Tuple.php
@@ -22,7 +22,7 @@
  * A class that represents the tuple type. The tuple type is able to represent
  * a composite type of one or more types accessed by index.
  */
-final class Tuple extends Type {
+final class Tuple extends \Cassandra\Type {
 
     private function __construct() { }
 
diff --git a/ext/doc/Cassandra/Type/UserType.php b/ext/doc/Cassandra/Type/UserType.php
@@ -22,7 +22,7 @@
  * A class that represents a user type. The user type is able to represent a
  * composite type of one or more types accessed by name.
  */
-final class UserType extends Type {
+final class UserType extends \Cassandra\Type {
 
     private function __construct() { }
 
diff --git a/ext/doc/generate_doc.php b/ext/doc/generate_doc.php
@@ -392,8 +392,9 @@ function writeClass($doc, $file, $class) {
     $parentClass = $class->getParentClass();
     if ($parentClass) {
         $parentClassName = $parentClass->getName();
-        if (startsWith($parentClassName, $namespace)) {
-            $parentClassName = $parentClass->getShortName();
+        if (startsWith($parentClassName, $namespace) && $parentClassName !== $namespace) {
+            $replacement = $namespace . '\\';
+            $parentClassName = substr_replace($parentClassName, '', 0, strlen($replacement));
         } else {
             $parentClassName = "\\" . $parentClassName;
         }
@@ -409,8 +410,9 @@ function writeClass($doc, $file, $class) {
                 continue;
             }
             $interfaceName = $interface->getName();
-            if (startsWith($interfaceName, $namespace)) {
-                $interfaceName = $interface->getShortName();
+            if (startsWith($interfaceName, $namespace) && $interfaceName !== $namespace) {
+                $replacement = $namespace . '\\';
+                $interfaceName = substr_replace($interfaceName, '', 0, strlen($replacement));
             } else {
                 $interfaceName = "\\" . $interfaceName;
             }

Original file line number	Diff line number	Diff line change
`@@ -323,6 +323,10 @@ public function withSchemaMetadata($enabled) { }`
`323`	`323`	`* reverse IP lookup. This is useful for authentication (Kerberos) or`
`324`	`324`	`* encryption SSL services that require a valid hostname for verification.`
`325`	`325`	`*`
	`326`	`+ * Important: It's possible that the underlying C/C++ driver does not`
	`327`	`+ * support hostname resolution. A PHP warning will be emitted if the driver`
	`328`	`+ * does not support hostname resolution.`
	`329`	`+ *`
`326`	`330`	`* @param bool $enabled whether the driver uses hostname resolution.`
`327`	`331`	`*`
`328`	`332`	`* @return Builder self`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,6 @@`
`28`	`28`	`*`
`29`	`29`	`* In all other cases the error will be returned.`
`30`	`30`	`*/`
`31`		`-final class DefaultPolicy implements RetryPolicy {`
	`31`	`+final class DefaultPolicy implements \Cassandra\RetryPolicy {`
`32`	`32`
`33`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,6 @@`
`39`	`39`	`* Important: This policy may attempt to retry requests with a lower`
`40`	`40`	`* consistency level. Using this policy can break consistency guarantees.`
`41`	`41`	`*/`
`42`		`-final class DowngradingConsistency implements RetryPolicy {`
	`42`	`+final class DowngradingConsistency implements \Cassandra\RetryPolicy {`
`43`	`43`
`44`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,6 @@`
`21`	`21`	`/**`
`22`	`22`	`* A retry policy that never retries and allows all errors to fallthrough.`
`23`	`23`	`*/`
`24`		`-final class Fallthrough implements RetryPolicy {`
	`24`	`+final class Fallthrough implements \Cassandra\RetryPolicy {`
`25`	`25`
`26`	`26`	`}`