BaseType::setProperty() - Code Metrics - Inspection of "replace 3rd-party schema with built-in" - pryley/site-reviews - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( e0dbf5...75834f )

by Paul

created 2018-06-25 01:56 UTC

BaseType::setProperty() A

↳ Parent: BaseType

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
cc	2
nc	2
nop	2
dl	0
loc	8
ccs	0
cts	8
cp	0
crap	6
rs	10
c	0
b	0
f	0

<?php

namespace GeminiLabs\SiteReviews\Modules\Schema;

use ArrayAccess;
use DateTime;
use JsonSerializable;
use ReflectionClass;
use DateTimeInterface;
use GeminiLabs\SiteReviews\Helper;
use GeminiLabs\SiteReviews\Modules\Schema\Type;
use GeminiLabs\SiteReviews\Modules\Schema\Exceptions\InvalidProperty;

abstract class BaseType implements ArrayAccess, JsonSerializable, Type
{
	/**
	 * @var array
	 */
	protected $allowed = [];

	/**
	 * @var array
	 */
	protected $parents = [];

	/**
	 * @var array
	 */
	protected $properties = [];

	/**
	 * @var string
	 */
	protected $type;

	/**
	 * @param string $method
	 * @return static
	 */
	public function __call( $method, array $arguments )
	{
		return $this->setProperty( $method, $arguments[0] ?? '' );
	}

	/**
	 * @param string $type
	 */
	public function __construct( $type = null )
	{
		$this->type = !is_string( $type )
			? (new ReflectionClass( $this ))->getShortName()
			: $type;
		$this->setAllowedProperties();
	}

	/**
	 * @return string
	 */
	public function __toString()
	{
		return $this->toScript();
	}

	/**
	 * @return static
	 */
	public function addProperties( array $properties )
	{
		foreach( $properties as $property => $value ) {
			$this->setProperty( $property, $value );
		}
		return $this;
	}

	/**
	 * @return string
	 */
	public function getContext()
	{
		return 'https://schema.org';
	}

	/**
	 * @return array
	 */
	public function getProperties()
	{
		return $this->properties;
	}

	/**
	 * @param string $property
	 * @param mixed $default
	 * @return mixed
	 */
	public function getProperty( $property, $default = null)
	{
		return $this->properties[$property] ?? $default;
	}

	/**
	 * @return string
	 */
	public function getType()
	{
		return $this->type;
	}

	/**
	 * @param bool $condition
	 * @param function $callback
filter:
    dependency_paths: ["lib/*"]
	 * @return static
	 */
	public function if( $condition, $callback )

	{
		if( $condition ) {
			$callback( $this );
		}
		return $this;
class A {
    var $property;
}
	}

	/**
	 * @return array
	 */
	public function jsonSerialize()
	{
		return $this->toArray();
	}

	/**
	 * @param mixed $offset
	 * @return bool
	 */
	public function offsetExists( $offset )
	{
		return array_key_exists( $offset, $this->properties );
	}

	/**
	 * @param string $offset
	 * @return mixed
	 */
	public function offsetGet( $offset )
	{
		return $this->getProperty( $offset );
	}

	/**
	 * @param string $offset
	 * @param mixed $value
	 * @return void
	 */
	public function offsetSet( $offset, $value )
	{
		$this->setProperty( $offset, $value );
	}

	/**
	 * @param string $offset
	 * @return void
	 */
	public function offsetUnset( $offset )
	{
		unset( $this->properties[$offset] );
	}

	/**
	 * @param string $property
	 * @param mixed $value
	 * @return static
	 */
	public function setProperty( $property, $value )
	{
		if( !in_array( $property, $this->allowed )) {
			glsr_log()->error( 'Invalid schema property ('.$property.') for '.$this->getType() );
			return $this;
		}
		$this->properties[$property] = $value;
		return $this;
	}

	/**
	 * @return array
	 */
	public function toArray()
	{
		return [
			'@context' => $this->getContext(),
			'@type' => $this->getType(),
		] + $this->serializeProperty( $this->getProperties() );
	}

	/**
	 * @return string
	 */
	public function toScript()
	{
		return sprintf( '<script type="application/ld+json">%s</script>',
			json_encode( $this->toArray(), JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES )
		);
	}

	/**
	 * @param null|array $parents
	 * @return void
	 */
	protected function getParents( $parents = null )
	{
		if( !isset( $parents )) {
			$parents = $this->parents;
		}
		$newParents = $parents;
		foreach( $parents as $parent ) {
			$parentClass = glsr( Helper::class )->buildClassName( $parent, __NAMESPACE__ );
			if( !class_exists( $parentClass ))continue;
			$newParents = array_merge( $newParents, $this->getParents( (new $parentClass)->parents ));
			$newParents = array_merge( $newParents, /** @scrutinizer ignore-type */ $this->getParents( (new $parentClass)->parents ));
		}
		return array_values( array_unique( $newParents ));

	}

	/**
	 * @return void
	 */
	protected function setAllowedProperties()
	{
		$parents = $this->getParents();
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
		foreach( $parents as $parent ) {

			$parentClass = glsr( Helper::class )->buildClassName( $parent, __NAMESPACE__ );
			if( !class_exists( $parentClass ))continue;
			$this->allowed = array_values( array_unique( array_merge( (new $parentClass)->allowed, $this->allowed )));
		}
	}

	/**
	 * @param mixed $property
	 * @return array|string
	 */
	protected function serializeProperty( $property )
	{
		if( is_array( $property )) {
			return array_map( [$this, 'serializeProperty'], $property );
		}
		if( $property instanceof Type ) {
			$property = $property->toArray();
			unset( $property['@context'] );
		}
		if( $property instanceof DateTimeInterface ) {
			$property = $property->format( DateTime::ATOM );
		}
		if( is_object( $property )) {
			throw new InvalidProperty();
		}
		return $property;
	}
}


pryley / site-reviews

Push — master ( e0dbf5...75834f )

BaseType::setProperty() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like