Charcoal\Image\Effect\LayerEffectTrait

Complexity

Total Complexity

14

Size/Duplication

Total Lines	124
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	setOpacity()	0	10	4
A	opacity()	0	4	1
A	setGravity()	0	10	2
A	gravity()	0	4	1
A	setX()	0	10	2
A	x()	0	4	1
A	setY()	0	10	2
A	y()	0	4	1

<?php

namespace Charcoal\Image\Effect;

use \InvalidArgumentException;

/**
 * Full implementation, as a Trait, of the Layer Effect Interface.
 */
trait LayerEffectTrait
{
    /**
     * @var float $opacity
     */
    private $opacity = 1.0;

    /**
     * @var string $gravity
     */
    private $gravity = 'nw';

    /**
     * Horizontal adjustment, in pixels.
     * Negative values will move mask to the left, positive values to the right.
     * Depends on the gravity setting
     * @var integer $x
     */
    private $x = 0;

    /**
     * Vertical adjustment, in pixels.
     * Negative values will move mask to the top, positive values to the bottom.
     * Depends on the gravity setting
     * @var integer $y
     */
    private $y = 0;

    /**
     * @param float $opacity The mask opacity.
     * @throws InvalidArgumentException If the mask opacity is not a numeric value or not between 0.0 and 1.0.
     * @return AbstractMaskEffect Chainable
     */
    public function setOpacity($opacity)
    {
        if (!is_numeric($opacity) || ($opacity < 0) || ( $opacity > 1)) {
            throw new InvalidArgumentException(
                'Opacity must be a float between 0.0 and 1.0'
            );
        }
        $this->opacity = (float)$opacity;
        return $this;
    }

    /**
     * @return float
     */
    public function opacity()
    {
        return $this->opacity;
    }

    /**
     * @param string $gravity The mask gravity.
     * @throws InvalidArgumentException If the argument is not a valid gravity name.
     * @return AbstractMaskEffect Chainable
     */
    public function setGravity($gravity)
    {
        if (!in_array($gravity, $this->image()->availableGravities())) {

It seems like image() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            throw new InvalidArgumentException(
                'Gravity is not valid'
            );
        }
        $this->gravity = $gravity;
        return $this;
    }

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

    /**
     * @param integer $x The mask X position.
     * @throws InvalidArgumentException If the position is not a numeric value.
     * @return AbstractMaskEffect Chainable
     */
    public function setX($x)
    {
        if (!is_numeric($x)) {
            throw new InvalidArgumentException(
                'X must be a an integer (in pixel)'
            );
        }
        $this->x = (int)$x;
        return $this;
    }

    /**
     * @return float
     */
    public function x()
    {
        return $this->x;
    }

    /**
     * @param integer $y The Y position.
     * @throws InvalidArgumentException If the position is not a numeric value.
     * @return AbstractMaskEffect Chainable
     */
    public function setY($y)
    {
        if (!is_numeric($y)) {
            throw new InvalidArgumentException(
                'Y must be a an integer (in pixel)'
            );
        }
        $this->y = (int)$y;
        return $this;
    }

    /**
     * @return float
     */
    public function y()
    {
        return $this->y;
    }
}