Ignore certain phpcs errors for all examples

Author: alcaeus

examples/command_logger.php

@@ -28,7 +28,6 @@ function toJSON(object $document): string
     return toRelaxedExtendedJSON(fromPHP($document));
 }
 
-// phpcs:disable Squiz.Classes.ClassFileName.NoMatch
 class CommandLogger implements CommandSubscriber
 {
     public function commandStarted(CommandStartedEvent $event): void

examples/persistable.php

@@ -6,7 +6,8 @@
 use MongoDB\BSON\ObjectId;
 use MongoDB\BSON\Persistable;
 use MongoDB\Client;
-use stdClass;
+use MongoDB\Model\BSONArray;
+use UnexpectedValueException;
 
 use function array_search;
 use function dirname;
@@ -15,15 +16,15 @@
 
 require dirname(__FILE__) . '/../vendor/autoload.php';
 
-class Entry implements Persistable
+class PersistableEntry implements Persistable
 {
     /** @var ObjectId */
     private $id;
 
     /** @var string */
     private $name;
 
-    /** @var array<Email> */
+    /** @var array<PersistableEmail> */
     private $emails = [];
 
     public function __construct(string $name)
@@ -52,12 +53,12 @@ public function getEmails(): array
         return $this->emails;
     }
 
-    public function addEmail(Email $email): void
+    public function addEmail(PersistableEmail $email): void
     {
         $this->emails[] = $email;
     }
 
-    public function deleteEmail(Email $email): void
+    public function deleteEmail(PersistableEmail $email): void
     {
         $index = array_search($email, $this->emails, true);
         if ($index === false) {
@@ -67,7 +68,7 @@ public function deleteEmail(Email $email): void
         unset($this->emails[$index]);
     }
 
-    public function bsonSerialize(): stdClass
+    public function bsonSerialize(): object
     {
         return (object) [
             '_id' => $this->id,
@@ -78,13 +79,23 @@ public function bsonSerialize(): stdClass
 
     public function bsonUnserialize(array $data): void
     {
+        if (! $data['_id'] instanceof ObjectId) {
+            throw new UnexpectedValueException('_id field is not of the expected type');
+        }
+
+        if (! $data['emails'] instanceof BSONArray) {
+            throw new UnexpectedValueException('emails field is not of the expected type');
+        }
+
         $this->id = $data['_id'];
         $this->name = (string) $data['name'];
+
+        /** @psalm-suppress MixedPropertyTypeCoercion */
         $this->emails = $data['emails']->getArrayCopy(); // Emails will be passed as a BSONArray instance
     }
 }
 
-class Email implements Persistable
+class PersistableEmail implements Persistable
 {
     /** @var string */
     private $type;
@@ -108,7 +119,7 @@ public function getAddress(): string
         return $this->address;
     }
 
-    public function bsonSerialize(): stdClass
+    public function bsonSerialize(): object
     {
         return (object) [
             'type' => $this->type,
@@ -123,9 +134,9 @@ public function bsonUnserialize(array $data): void
     }
 }
 
-$entry = new Entry('alcaeus');
-$entry->addEmail(new Email('work', '[email protected]'));
-$entry->addEmail(new Email('private', '[email protected]'));
+$entry = new PersistableEntry('alcaeus');
+$entry->addEmail(new PersistableEmail('work', '[email protected]'));
+$entry->addEmail(new PersistableEmail('private', '[email protected]'));
 
 $client = new Client(getenv('MONGODB_URI') ?: 'mongodb://127.0.0.1/');
 
@@ -136,4 +147,5 @@ public function bsonUnserialize(array $data): void
 
 $foundEntry = $collection->findOne([]);
 
+/** @psalm-suppress ForbiddenCode */
 var_dump($foundEntry);

phpcs.xml.dist

@@ -176,6 +176,10 @@
         <exclude-pattern>/tests/GridFS/UnusableStream.php</exclude-pattern>
     </rule>
     <rule ref="PSR1.Classes.ClassDeclaration.MultipleClasses">
+        <exclude-pattern>/examples</exclude-pattern>
         <exclude-pattern>/tests/PHPUnit/ConstraintTrait.php</exclude-pattern>
     </rule>
+    <rule ref="Squiz.Classes.ClassFileName.NoMatch">
+        <exclude-pattern>/examples</exclude-pattern>
+    </rule>
 </ruleset>