NelsonMartell\PropertiesHandler

Complexity

Total Complexity

25

Size/Duplication

Total Lines	233
Duplicated Lines	0 %

Test Coverage

Coverage

73.81%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getPropertySetter()	0	40	5
A	__set()	0	13	3
A	getPropertyGetter()	0	40	5
A	ensurePropertyExists()	0	31	6
A	ensureMethodExists()	0	20	3
A	__get()	0	13	3

<?php
/**
 * PHP: Nelson Martell Library file
 *
 * Content:
 * - Trait definition:  [NelsonMartell]  PropertiesHandler
 *
 * Copyright © 2015-2017 Nelson Martell (http://nelson6e65.github.io)
 *
 * Licensed under The MIT License (MIT)
 * For full copyright and license information, please see the LICENSE
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright 2015-2017 Nelson Martell
 * @link      http://nelson6e65.github.io/php_nml/
 * @since     0.5.0
 * @license   http://www.opensource.org/licenses/mit-license.php The MIT License (MIT)
 * */

namespace NelsonMartell;

use NelsonMartell\Extensions\Text;
use \BadMethodCallException;
use \InvalidArgumentException;

/**
 * Enables the class to use properties, by encapsulating class attributes in order to use with
 * auto-setters/getters methods instead of direct access.
 *
 * Using this trail will restrict get and set actions for a property if there is not defined in
 * the class or if there is not a getter or setter method (respectively) for that property.
 *
 * So, you MUST (1) create the property in the class and (2) then unset it in the constructor
 * (*this requirements will change in next releases to be more 'auto-magic'*).
 * You can, also, expose read-only attributes to be public by creating only a getter method and declare

This line exceeds maximum limit of 100 characters; contains 103 characters

 * visibility of attribute as private.
 *
 * @example
 * ```php
 * <?php
 * class Nameable implements NelsonMartell\IStrictPropertiesContainer {
 *     use NelsonMartell\PropertiesHandler;
 *
 *     public function __construct()
 *     {
 *         unset($this->Name); // (2)
 *     }
 *
 *     private $_name = ''; // Attribute: Stores the value.
 *     public $Name; // (1) Property: Accesible name for the property.
 *
 *     public function getName()
 *     {
 *         return ucwords($this->_name);
 *     }
 *
 *     public function setName($value)
 *     {
 *         $this->_name = strtolower($value);
 *     }
 * }
 *
 * $obj = new Nameable();
 * $obj->Name = 'nelson maRtElL';
 * echo $obj->Name; // 'Nelson Martell'
 * echo $obj->name; // Throws: InvalidArgumentException: "name" property do not exists in "Nameable" class.

This line exceeds maximum limit of 100 characters; contains 107 characters

 *
 * ?>
 * ```
 *
 * ## Notes:
 * - You should not define properties wich names only are only different in the first letter upper/lowercase;

This line exceeds maximum limit of 100 characters; contains 109 characters

 *   it will be used the same getter/setter method (since in PHP methods are case-insensitive). In the last

This line exceeds maximum limit of 100 characters; contains 107 characters

 *   example, if you (in addition) define the `public $name` and `unset($this->name)` in the constructor, it will

This line exceeds maximum limit of 100 characters; contains 113 characters

 *   be used the same getter and setter method when you access or set both properties (`->Name` and `->name`).

This line exceeds maximum limit of 100 characters; contains 110 characters

 * - Only works for public properties (even if you declare visibility of getter/setter methods as `private`

This line exceeds maximum limit of 100 characters; contains 107 characters

 *   or `protected`); this only will avoid the direct use of method (``$obj->getName(); // ERROR``), but property

This line exceeds maximum limit of 100 characters; contains 113 characters

 *   value still will be available in child classes and main (``$value = $this->name; // No error``).

This line exceeds maximum limit of 100 characters; contains 101 characters

 * - Getter and Setter methods SHOULD NOT be declared as ``private`` in child classes if parent already

This line exceeds maximum limit of 100 characters; contains 103 characters

 *   uses this trait.
 * - Custom prefixes ability (by implementing ``ICustomPrefixedPropertiesContainer``) is not posible for

This line exceeds maximum limit of 100 characters; contains 104 characters

 *   multiple prefixes in multiples child classes by overriding ``ICustomPrefixedPropertiesContainer`` methods.

This line exceeds maximum limit of 100 characters; contains 111 characters

 *   If you extends a class that already implements it, if you override any methor to return another prefix,

This line exceeds maximum limit of 100 characters; contains 108 characters

 *   parent class properties may be unaccesible (know bug).
 * - Avoid the use of custom prefixes and use the standard 'get'/'set' instead. If you need to, maybe you

This line exceeds maximum limit of 100 characters; contains 105 characters

 *   could try to rename methods instead first.
 *
 * @author Nelson Martell <nelson6e65@gmail.com>
 * @since 0.5.0
 * */
trait PropertiesHandler
{
    /**
     * Gets the property value using the auto-magic method `$getterPrefix.$name()` (getter),
     * where `$name` is the name of property and `$getterPrefix` is 'get' by default (but can be customized).

This line exceeds maximum limit of 100 characters; contains 109 characters

     *
     * @param string $name Property name.
     *
     * @return mixed
     * @throws BadMethodCallException If unable to get the property value.
     * @see PropertiesHandler::getPropertyGetter()
     * */
    public function __get($name)
    {
        try {
            $getter = static::getPropertyGetter($name);
        } catch (InvalidArgumentException $error) {
            $msg = msg('Unable to get the property value in "{0}" class.', get_class($this));
            throw new BadMethodCallException($msg, 31, $error);
        } catch (BadMethodCallException $error) {
            $msg = msg('Unable to get the property value in "{0}" class.', get_class($this));
            throw new BadMethodCallException($msg, 32, $error);
        }

        return $this->$getter();
    }


    /**
     * Sets the property value using the auto-magic method `$setterPrefix.$name()` (setter),
     * where `$name` is the name of property and `$setterPrefix` is 'set' by default (but can be customized).

This line exceeds maximum limit of 100 characters; contains 109 characters

     *
     * @param string $name  Property name.
     * @param mixed  $value Property value.
     *
     * @return void
     * @throws BadMethodCallException If unable to set property value.
     * @see PropertiesHandler::getPropertySetter()
     * */
    public function __set($name, $value)
    {
        try {
            $setter = static::getPropertySetter($name);
        } catch (InvalidArgumentException $error) {
            $msg = msg('Unable to set the property value in "{0}" class.', get_class($this));
            throw new BadMethodCallException($msg, 41, $error);
        } catch (BadMethodCallException $error) {
            $msg = msg('Unable to set the property value in "{0}" class.', get_class($this));
            throw new BadMethodCallException($msg, 42, $error);
        }

        $this->$setter($value);
    }


    /**
     * Ensures that property provided exists in this class.
     *
     * @param string $name Property name.
     *
     * @return string Same property name, but validated.
     * @throws InvalidArgumentException If property name is not valid (10) or do not exists (11).
     */
    protected static function ensurePropertyExists($name)
    {
        $args = [
            'class'    => get_called_class(),
        ];

        try {
            $args['property'] = Text::ensureIsValidVarName($name);
        } catch (InvalidArgumentException $error) {
            $msg = msg('Property name is not valid.');
            throw new InvalidArgumentException($msg, 10, $error);
        }

        if (!property_exists($args['class'], $args['property'])) {
            // Check in parent classes for private property
            $current = $args['class'];
            $exists = false;

Equals sign not aligned with surrounding assignments; expected 2 spaces but found 1 space

            while ($current = get_parent_class($current) and !$exists) {
                $exists = property_exists($current, $args['property']);
            }

            if (!$exists) {
                $msg = msg(
                    '"{property}" property do not exists in "{class}" class or parent classes.',
                    $args
                );
                throw new InvalidArgumentException($msg, 11);
            }
        }

        return $name;
    }


    /**
     * Ensures that method provided exists in this class.
     *
     * @param string $name Method name.
     *
     * @return string Same method name, but validated.
     * @throws InvalidArgumentException If method name is not valid (20) or do not exists (21).
     */
    protected static function ensureMethodExists($name)
    {
        $args = [
            'class'  => get_called_class(),
        ];

        try {
            $args['method'] = Text::ensureIsValidVarName($name);
        } catch (InvalidArgumentException $error) {
            $msg = msg('Method name is not valid.');
            throw new InvalidArgumentException($msg, 20, $error);
        }

        if (method_exists($args['class'], $args['method']) === false) {
            $msg = msg('"{class}::{method}" do not exists.', $args);

            throw new InvalidArgumentException($msg, 21);
        }

        return $name;
    }


    /**
     * Gets the property setter method name.
     * You can customize the setter prefix by implementing ``ICustomPrefixedPropertiesContainer`` interface.

This line exceeds maximum limit of 100 characters; contains 108 characters

     *
     * @param string $name Property name.
     *
     * @return string
     * @throws InvalidArgumentException If property is not valid or has not setter.
     * @throws BadMethodCallException If custom prefix is not an ``string`` instance.
     * @see ICustomPrefixedPropertiesContainer::getCustomSetterPrefix()
     */
    protected static function getPropertySetter($name)
    {
        $args = [
            'class' => get_called_class(),
        ];

        $prefix = 'set';

        $args['name'] = static::ensurePropertyExists($name, $args['class']);

The call to NelsonMartell\PropertiesHandler::ensurePropertyExists() has too many arguments starting with $args['class'].

        try {
            $setter = static::ensureMethodExists($prefix.$args['name']);
        } catch (InvalidArgumentException $error) {
            $msg = msg('"{name}" property has not a setter method in "{class}".', $args);

            if (is_subclass_of($args['class'], ICustomPrefixedPropertiesContainer::class)) {
                // If not available standard setter, check if custom available
                try {
                    $prefix = Text::ensureIsString(static::getCustomSetterPrefix());
                } catch (InvalidArgumentException $e) {
                    $msg = msg(
                        '"{class}::getCustomSetterPrefix" method must to return an string.',
                        $args['class']
                    );

                    throw new BadMethodCallException($msg, 31, $e);
                }

                try {
                    $setter = static::ensureMethodExists($prefix.$args['name']);
                } catch (InvalidArgumentException $e) {
                    throw new InvalidArgumentException($msg, 32, $e);
                }
            } else {
                // Error for non custom prefixes
                throw new InvalidArgumentException($msg, 30, $error);
            }
        }

        return $setter;
    }


    /**
     * Gets the property getter method name.
     * You can customize the getter prefix by implementing ``ICustomPrefixedPropertiesContainer`` interface.

This line exceeds maximum limit of 100 characters; contains 108 characters

     *
     * @param string $name Property name.
     *
     * @return string
     * @throws InvalidArgumentException If property is not valid or has not getter.
     * @throws BadMethodCallException If custom prefix is not an ``string`` instance.
     * @see ICustomPrefixedPropertiesContainer::getCustomGetterPrefix()
     */
    protected static function getPropertyGetter($name)
    {
        $args = [
            'class' => get_called_class(),
        ];

        $prefix = 'get';

        $args['name'] = static::ensurePropertyExists($name, $args['class']);

The call to NelsonMartell\PropertiesHandler::ensurePropertyExists() has too many arguments starting with $args['class'].

        try {
            $getter = static::ensureMethodExists($prefix.$args['name']);
        } catch (InvalidArgumentException $error) {
            $msg = msg('"{name}" property has not a getter method in "{class}".', $args);

            if (is_subclass_of($args['class'], ICustomPrefixedPropertiesContainer::class)) {
                // If not available standard getter, check if custom available
                try {
                    $prefix = Text::ensureIsString(static::getCustomGetterPrefix());
                } catch (InvalidArgumentException $e) {
                    $msg = msg(
                        '"{class}::getCustomGetterPrefix" method must to return an string.',
                        $args['class']
                    );

                    throw new BadMethodCallException($msg, 31, $e);
                }

                try {
                    $getter = static::ensureMethodExists($prefix.$args['name']);
                } catch (InvalidArgumentException $e) {
                    throw new InvalidArgumentException($msg, 32, $e);
                }
            } else {
                // Error for non custom prefixes
                throw new InvalidArgumentException($msg, 30, $error);
            }
        }

        return $getter;
    }
}