PHPLIB-330: Add property type hints

phpcs.xml.dist

@@ -19,8 +19,6 @@
         <!-- Exclude sniffs that require newer PHP versions -->
         <!-- Available with PHP 7.0 -->
         <exclude name="SlevomatCodingStandard.TypeHints.DeclareStrictTypes" />
-        <!-- In addition to requiring PHP 7.0, this sniff will cause a significant amount of BC breaks. Proceed with caution! -->
-        <exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration" />
         <exclude name="SlevomatCodingStandard.Exceptions.ReferenceThrowableOnly" />
         <exclude name="SlevomatCodingStandard.ControlStructures.RequireNullCoalesceOperator" />
 
@@ -61,7 +59,6 @@
 
         <!-- These sniffs cause a large diff, so enable them in separate steps -->
         <exclude name="SlevomatCodingStandard.Commenting.DocCommentSpacing.IncorrectAnnotationsGroup" />
-        <exclude name="SlevomatCodingStandard.Commenting.RequireOneLinePropertyDocComment" />
         <exclude name="Squiz.Strings.DoubleQuoteUsage" />
 
         <!-- Sniff currently breaks, see https://github.com/slevomat/coding-standard/issues/727 -->
@@ -90,6 +87,24 @@
         </properties>
     </rule>
 
+    <!-- Only enable some checks regarding type hints -->
+    <!-- In addition to requiring PHP 7.0, this sniff will cause a significant amount of BC breaks. Proceed with caution! -->
+    <rule ref="SlevomatCodingStandard.TypeHints.TypeHintDeclaration">
+        <!-- Traversable type hints often end up as mixed[], so we skip them for now -->
+        <exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingTraversablePropertyTypeHintSpecification" />
+        <exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingTraversableParameterTypeHintSpecification" />
+        <exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingTraversableReturnTypeHintSpecification" />
+
+        <!-- Will cause BC breaks to method signatures - disabled for now -->
+        <exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingParameterTypeHint" />
+        <exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingReturnTypeHint" />
+
+        <properties>
+            <property name="enableObjectTypeHint" value="true" />
+            <property name="enableEachParameterAndReturnInspection" value="false" />
+        </properties>
+    </rule>
+
     <rule ref="PSR1.Methods.CamelCapsMethodName.NotCamelCaps">
         <exclude-pattern>/src/GridFS/StreamWrapper</exclude-pattern>
         <exclude-pattern>/tests/DocumentationExamplesTest.php</exclude-pattern>

src/BulkWriteResult.php

@@ -25,8 +25,13 @@
  */
 class BulkWriteResult
 {
+    /** @var WriteResult */
     private $writeResult;
+
+    /** @var mixed[] */
     private $insertedIds;
+
+    /** @var boolean */
     private $isAcknowledged;
 
     /**

src/ChangeStream.php

@@ -42,19 +42,27 @@ class ChangeStream implements Iterator
      */
     const CURSOR_NOT_FOUND = 43;
 
+    /** @var array */
     private static $nonResumableErrorCodes = [
         136, // CappedPositionLost
         237, // CursorKilled
         11601, // Interrupted
     ];
 
+    /** @var callable */
     private $resumeCallable;
+
+    /** @var ChangeStreamIterator */
     private $iterator;
+
+    /** @var integer */
     private $key = 0;
 
     /**
      * Whether the change stream has advanced to its first result. This is used
      * to determine whether $key should be incremented after an iteration event.
+     *
+     * @var boolean
      */
     private $hasAdvanced = false;
 

src/Client.php

@@ -37,19 +37,35 @@
 
 class Client
 {
+    /** @var array */
     private static $defaultTypeMap = [
         'array' => BSONArray::class,
         'document' => BSONDocument::class,
         'root' => BSONDocument::class,
     ];
+
+    /** @var integer */
     private static $wireVersionForReadConcern = 4;
+
+    /** @var integer */
     private static $wireVersionForWritableCommandWriteConcern = 5;
 
+    /** @var Manager */
     private $manager;
+
+    /** @var ReadConcern */
     private $readConcern;
+
+    /** @var ReadPreference */
     private $readPreference;
+
+    /** @var string */
     private $uri;
+
+    /** @var array */
     private $typeMap;
+
+    /** @var WriteConcern */
     private $writeConcern;
 
     /**

src/Collection.php

@@ -66,22 +66,44 @@
 
 class Collection
 {
+    /** @var array */
     private static $defaultTypeMap = [
         'array' => BSONArray::class,
         'document' => BSONDocument::class,
         'root' => BSONDocument::class,
     ];
+
+    /** @var integer */
     private static $wireVersionForFindAndModifyWriteConcern = 4;
+
+    /** @var integer */
     private static $wireVersionForReadConcern = 4;
+
+    /** @var integer */
     private static $wireVersionForWritableCommandWriteConcern = 5;
+
+    /** @var integer */
     private static $wireVersionForReadConcernWithWriteStage = 8;
 
+    /** @var string */
     private $collectionName;
+
+    /** @var string */
     private $databaseName;
+
+    /** @var Manager */
     private $manager;
+
+    /** @var ReadConcern */
     private $readConcern;
+
+    /** @var ReadPreference */
     private $readPreference;
+
+    /** @var array */
     private $typeMap;
+
+    /** @var WriteConcern */
     private $writeConcern;
 
     /**

src/Database.php

@@ -44,20 +44,38 @@
 
 class Database
 {
+    /** @var array */
     private static $defaultTypeMap = [
         'array' => BSONArray::class,
         'document' => BSONDocument::class,
         'root' => BSONDocument::class,
     ];
+
+    /** @var integer */
     private static $wireVersionForReadConcern = 4;
+
+    /** @var integer */
     private static $wireVersionForWritableCommandWriteConcern = 5;
+
+    /** @var integer */
     private static $wireVersionForReadConcernWithWriteStage = 8;
 
+    /** @var string */
     private $databaseName;
+
+    /** @var Manager */
     private $manager;
+
+    /** @var ReadConcern */
     private $readConcern;
+
+    /** @var ReadPreference */
     private $readPreference;
+
+    /** @var array */
     private $typeMap;
+
+    /** @var WriteConcern */
     private $writeConcern;
 
     /**

src/DeleteResult.php

@@ -25,12 +25,12 @@
  */
 class DeleteResult
 {
+    /** @var WriteResult */
     private $writeResult;
+
+    /** @var boolean */
     private $isAcknowledged;
 
-    /**
-     * @param WriteResult $writeResult
-     */
     public function __construct(WriteResult $writeResult)
     {
         $this->writeResult = $writeResult;

src/GridFS/Bucket.php

@@ -62,24 +62,50 @@
  */
 class Bucket
 {
+    /** @var string */
     private static $defaultBucketName = 'fs';
+
+    /** @var integer */
     private static $defaultChunkSizeBytes = 261120;
+
+    /** @var array */
     private static $defaultTypeMap = [
         'array' => BSONArray::class,
         'document' => BSONDocument::class,
         'root' => BSONDocument::class,
     ];
+
+    /** @var string */
     private static $streamWrapperProtocol = 'gridfs';
 
+    /** @var CollectionWrapper */
     private $collectionWrapper;
+
+    /** @var string */
     private $databaseName;
+
+    /** @var Manager */
     private $manager;
+
+    /** @var string */
     private $bucketName;
+
+    /** @var boolean */
     private $disableMD5;
+
+    /** @var integer */
     private $chunkSizeBytes;
+
+    /** @var ReadConcern */
     private $readConcern;
+
+    /** @var ReadPreference */
     private $readPreference;
+
+    /** @var array */
     private $typeMap;
+
+    /** @var WriteConcern */
     private $writeConcern;
 
     /**

src/GridFS/CollectionWrapper.php

@@ -34,10 +34,19 @@
  */
 class CollectionWrapper
 {
+    /** @var string */
     private $bucketName;
+
+    /** @var Collection */
     private $chunksCollection;
+
+    /** @var string */
     private $databaseName;
+
+    /** @var boolean */
     private $checkedIndexes = false;
+
+    /** @var Collection */
     private $filesCollection;
 
     /**

src/GridFS/ReadableStream.php

@@ -36,15 +36,34 @@
  */
 class ReadableStream
 {
+    /** @var string|null */
     private $buffer;
+
+    /** @var integer */
     private $bufferOffset = 0;
+
+    /** @var integer */
     private $chunkSize;
+
+    /** @var integer */
     private $chunkOffset = 0;
+
+    /** @var IteratorIterator|null */
     private $chunksIterator;
+
+    /** @var CollectionWrapper */
     private $collectionWrapper;
+
+    /** @var float|integer */
     private $expectedLastChunkSize = 0;
+
+    /** @var stdClass */
     private $file;
+
+    /** @var integer */
     private $length;
+
+    /** @var integer */
     private $numChunks = 0;
 
     /**

src/GridFS/StreamWrapper.php

@@ -45,13 +45,16 @@
  */
 class StreamWrapper
 {
-    /**
-     * @var resource|null Stream context (set by PHP)
-     */
+    /** @var resource|null Stream context (set by PHP) */
     public $context;
 
+    /** @var string|null */
     private $mode;
+
+    /** @var string|null */
     private $protocol;
+
+    /** @var ReadableStream|WritableStream|null */
     private $stream;
 
     /**

src/GridFS/WritableStream.php

@@ -44,16 +44,34 @@
  */
 class WritableStream
 {
+    /** @var integer */
     private static $defaultChunkSizeBytes = 261120;
 
+    /** @var string */
     private $buffer = '';
+
+    /** @var integer */
     private $chunkOffset = 0;
+
+    /** @var integer */
     private $chunkSize;
+
+    /** @var boolean */
     private $disableMD5;
+
+    /** @var CollectionWrapper */
     private $collectionWrapper;
+
+    /** @var array */
     private $file;
+
+    /** @var resource */
     private $hashCtx;
+
+    /** @var boolean */
     private $isClosed = false;
+
+    /** @var integer */
     private $length = 0;
 
     /**

src/InsertManyResult.php

@@ -25,8 +25,13 @@
  */
 class InsertManyResult
 {
+    /** @var WriteResult */
     private $writeResult;
+
+    /** @var mixed[] */
     private $insertedIds;
+
+    /** @var boolean */
     private $isAcknowledged;
 
     /**