BestServedCold\PhalueObjects\Contract\ValueObject

Size/Duplication

Total Lines	40
Duplicated Lines	0 %

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
	__toString()	0	1	?
	__set()	0	1	?
	getValue()	0	1	?
	equals()	0	1	?
	getType()	0	1	?
	hash()	0	1	?
	__destruct()	0	1	?

<?php

namespace BestServedCold\PhalueObjects\Contract;

/**
 * Interface ValueObjectInterface
 *
 * @package  BestServedCold\PhalueObjects\Contract
 */
interface ValueObject

ValueObject does not seem to conform to the naming convention (^[A-Z][a-zA-Z0-9]*Interface$).

{
    /**
     * @return string
     */
    public function __toString();

    /**
     * @param  $field
     * @param  $value
     * @throws \RuntimeException
     */
    public function __set($field, $value);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

    /**
     * @return mixed
     */
    public function getValue();

    /**
     * @param  ValueObject $object
     * @return bool
     */
    public function equals(ValueObject $object);

function equals() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

    /**
     * @return string
     */
    public function getType();

    /**
     * @return string
     */
    public function hash();

    /**
     * @inheritdoc
     */
    public function __destruct();

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

}