JsonCodecableTrait.php File Reference

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. More...

Variables
trait	Wikimedia\JsonCodec::JsonCodecableTrait
	The JsonCodecableTrait aids in the implementation of stateless codecs.

Detailed Description

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

Variable Documentation

JsonCodecableTrait

trait Wikimedia::JsonCodec\JsonCodecableTrait

Initial value:

{
 
    
    public static function jsonClassCodec(
        JsonCodecInterface $codec, ContainerInterface $serviceContainer
    ): JsonClassCodec {
        
        
        
        
        
        return JsonStaticClassCodec::getInstance();
    }
 
    
    abstract public function toJsonArray(): array

The JsonCodecableTrait aids in the implementation of stateless codecs.

The class using the trait need only define stateless ::toJsonArray() and ::newFromJsonArray() methods.

The class using the trait should also implement JsonCodecable (https://wiki.php.net/rfc/traits-with-interfaces may allow the trait to do this directly in a future PHP version).