Timothy J Warren
951f4362db
All checks were successful
timw4mail/HummingBirdAnimeClient/develop This commit looks good
225 lines
3.9 KiB
PHP
225 lines
3.9 KiB
PHP
<?php declare(strict_types=1);
|
|
/**
|
|
* Hummingbird Anime List Client
|
|
*
|
|
* An API client for Kitsu to manage anime and manga watch lists
|
|
*
|
|
* PHP version 7.2
|
|
*
|
|
* @package HummingbirdAnimeClient
|
|
* @author Timothy J. Warren <tim@timshomepage.net>
|
|
* @copyright 2015 - 2019 Timothy J. Warren
|
|
* @license http://www.opensource.org/licenses/mit-license.html MIT License
|
|
* @version 4.2
|
|
* @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient
|
|
*/
|
|
|
|
namespace Aviat\AnimeClient\Types;
|
|
|
|
use ArrayAccess;
|
|
use ArrayObject;
|
|
use Countable;
|
|
|
|
abstract class AbstractType implements ArrayAccess, Countable {
|
|
/**
|
|
* Populate values for un-serializing data
|
|
*
|
|
* @param $properties
|
|
* @return mixed
|
|
*/
|
|
public static function __set_state($properties): self
|
|
{
|
|
return new static($properties);
|
|
}
|
|
|
|
/**
|
|
* Sets the properties by using the constructor
|
|
*
|
|
* @param mixed $data
|
|
*/
|
|
final public function __construct($data = [])
|
|
{
|
|
$typeKeys = array_keys((array)$this);
|
|
$dataKeys = array_keys((array)$data);
|
|
|
|
$unsetKeys = array_diff($typeKeys, $dataKeys);
|
|
|
|
foreach ($data as $key => $value)
|
|
{
|
|
$this->__set($key, $value);
|
|
}
|
|
|
|
// Remove unset keys so that they aren't serialized
|
|
foreach ($unsetKeys as $k)
|
|
{
|
|
unset($this->$k);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* See if a property is set
|
|
*
|
|
* @param $name
|
|
* @return bool
|
|
*/
|
|
public function __isset($name): bool
|
|
{
|
|
return property_exists($this, $name);
|
|
}
|
|
|
|
/**
|
|
* Set a property on the type object
|
|
*
|
|
* @param string $name
|
|
* @param mixed $value
|
|
* @return void
|
|
*/
|
|
public function __set($name, $value): void
|
|
{
|
|
$setterMethod = 'set' . ucfirst($name);
|
|
|
|
if (method_exists($this, $setterMethod))
|
|
{
|
|
$this->$setterMethod($value);
|
|
return;
|
|
}
|
|
|
|
if ( ! property_exists($this, $name))
|
|
{
|
|
$existing = json_encode($this);
|
|
|
|
throw new UndefinedPropertyException("Trying to set undefined property: '$name'. Existing properties: $existing");
|
|
}
|
|
|
|
$this->$name = $value;
|
|
}
|
|
|
|
/**
|
|
* Get a property from the type object
|
|
*
|
|
* @param string $name
|
|
* @return mixed
|
|
*/
|
|
public function __get($name)
|
|
{
|
|
if (property_exists($this, $name))
|
|
{
|
|
return $this->$name;
|
|
}
|
|
|
|
throw new UndefinedPropertyException("Trying to get undefined property: '$name'");
|
|
}
|
|
|
|
/**
|
|
* Create a string representation of the object for debugging
|
|
*
|
|
* @return string
|
|
*/
|
|
public function __toString(): string
|
|
{
|
|
return print_r($this, TRUE);
|
|
}
|
|
|
|
/**
|
|
* Implementing ArrayAccess
|
|
*
|
|
* @param $offset
|
|
* @return bool
|
|
*/
|
|
public function offsetExists($offset): bool
|
|
{
|
|
return $this->__isset($offset);
|
|
}
|
|
|
|
/**
|
|
* Implementing ArrayAccess
|
|
*
|
|
* @param $offset
|
|
* @return mixed
|
|
*/
|
|
public function offsetGet($offset)
|
|
{
|
|
return $this->__get($offset);
|
|
}
|
|
|
|
/**
|
|
* Implementing ArrayAccess
|
|
*
|
|
* @param $offset
|
|
* @param $value
|
|
*/
|
|
public function offsetSet($offset, $value): void
|
|
{
|
|
$this->__set($offset, $value);
|
|
}
|
|
|
|
/**
|
|
* Implementing ArrayAccess
|
|
*
|
|
* @param $offset
|
|
*/
|
|
public function offsetUnset($offset): void
|
|
{
|
|
if ($this->offsetExists($offset))
|
|
{
|
|
unset($this->$offset);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Implementing Countable
|
|
*
|
|
* @return int
|
|
*/
|
|
public function count(): int
|
|
{
|
|
$keys = array_keys($this->toArray());
|
|
return count($keys);
|
|
}
|
|
|
|
/**
|
|
* Recursively cast properties to an array
|
|
*
|
|
* @param null $parent
|
|
* @return mixed
|
|
*/
|
|
public function toArray($parent = null)
|
|
{
|
|
$object = $parent ?? $this;
|
|
|
|
if (is_scalar($object) || $object === NULL)
|
|
{
|
|
return $object;
|
|
}
|
|
|
|
$output = [];
|
|
|
|
foreach ($object as $key => $value)
|
|
{
|
|
$output[$key] = (is_scalar($value) || empty($value))
|
|
? $value
|
|
: $this->toArray((array) $value);
|
|
}
|
|
|
|
return $output;
|
|
}
|
|
|
|
/**
|
|
* Determine whether the type has any properties set
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isEmpty(): bool
|
|
{
|
|
foreach ($this as $key => $value)
|
|
{
|
|
if ( ! empty($value))
|
|
{
|
|
return FALSE;
|
|
}
|
|
}
|
|
|
|
return TRUE;
|
|
}
|
|
}
|