Page MenuHomeWickedGov Phorge
Files F2752321

JsonStaticClassCodec.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

JsonStaticClassCodec.php
View Options

<?php
declare( strict_types=1 );
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Json
*/
namespace Wikimedia\JsonCodec;
/**
* This is a simple class codec which proxies to methods on the object for
* serialization and a static method on the class for deserialization.
* It is intended for use as a singleton helper to JsonCodecableTrait.
*/
class JsonStaticClassCodec implements JsonClassCodec {
/**
* Returns a JSON array representing the contents of the given object, that
* can be deserialized with the corresponding newFromJsonArray() method,
* using a ::toJsonArray() method on the object itself.
*
* @param object $obj An object of the type handled by this JsonClassCodec
* @return array A Json representation of the object.
* @inheritDoc
* @see JsonCodecableTrait
*/
public function toJsonArray( $obj ): array {
// Proxy to a method on the object itself.
// @see JsonCodecableTrait
return $obj->toJsonArray();
}
/**
* Creates a new instance of the given class and initializes it from the
* $json array, using a static method on $className.
* @param class-string<T> $className
* @param array $json
* @return T
* @inheritDoc
* @phan-template T
* @see JsonCodecableTrait
*/
public function newFromJsonArray( string $className, array $json ) {
// Proxy to a static method on the class.
// @see JsonCodecableTrait
return $className::newFromJsonArray( $json );
}
/**
* Return an optional type hint for the given array key in the result of
* ::toJsonArray() / input to ::newFromJsonArray. If a class name is
* returned here and it matches the runtime type of the value of that
* array key, then type information will be omitted from the generated
* JSON which can save space. The class name can be suffixed with `[]`
* to indicate an array or list containing objects of the given class
* name.
*
* @param class-string<T> $className
* @param string $keyName
* @return class-string|string|Hint|null A class string, Hint or null.
* For backward compatibility, a class string suffixed with `[]` can
* also be returned, but that is deprecated.
*/
public function jsonClassHintFor( string $className, string $keyName ) {
// Proxy to a static method on the class.
// @see JsonCodecableTrait
return $className::jsonClassHintFor( $keyName );
}
/**
* Return a singleton instance of this class codec.
* @return JsonStaticClassCodec a singleton instance of this class
*/
public static function getInstance(): JsonStaticClassCodec {
static $instance = null;
if ( $instance == null ) {
$instance = new JsonStaticClassCodec();
}
return $instance;
}
}

File Metadata

Mime Type
text/x-php
Expires
Fri, Jul 3, 19:53 (1 d, 7 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
9f/8b/65b9ee1241f0473c7845288a0b05
Default Alt Text
JsonStaticClassCodec.php (3 KB)

Event Timeline