tests/phpunit/mocks/json/SampleObject.php

   1 <?php
   2 namespace MediaWiki\Tests\Json;
   3
   4 use Wikimedia\Assert\Assert;
   5 use Wikimedia\JsonCodec\JsonCodecable;
   6 use Wikimedia\JsonCodec\JsonCodecableTrait;
   7
   8 /**
   9  * Sample object which uses JsonCodecableTrait to directly implement
  10  * serialization/deserialization.
  11  */
  12 class SampleObject implements JsonCodecable {
  13         use JsonCodecableTrait;
  14
  15         /** @var string */
  16         public string $property;
  17
  18         /**
  19          * Create a new SampleObject which stores $property.
  20          * @param string $property
  21          */
  22         public function __construct( string $property ) {
  23                 $this->property = $property;
  24         }
  25
  26         // Implement JsonCodecable using the JsonCodecableTrait
  27
  28         /** @inheritDoc */
  29         public function toJsonArray(): array {
  30                 if ( $this->property !== 'use _type_' ) {
  31                         // Allow testing both with and without the '_type_' special case
  32                         return [ 'property' => $this->property ];
  33                 }
  34                 return [
  35                         'property' => $this->property,
  36                         // Implementers shouldn't have to know which properties the
  37                         // codec is using for its own purposes; this will still work
  38                         // fine:
  39                         '_type_' => 'check123',
  40                 ];
  41         }
  42
  43         /** @inheritDoc */
  44         public static function newFromJsonArray( array $json ): SampleObject {
  45                 if ( $json['property'] === 'use _type_' ) {
  46                         Assert::invariant( $json['_type_'] === 'check123', 'protected field' );
  47                 }
  48                 return new SampleObject( $json['property'] );
  49         }
  50 }
  51
  52 // This class_alias exists for testing alias support in JsonCodec and
  53 // should not be removed.
  54 class_alias( SampleObject::class, 'MediaWiki\\Tests\\Json\\SampleObjectAlias' );