License::allocateMessage() - Code Metrics - Inspection of "Deallocation logic" - tylercd100/laravel-licenser - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4db34d...4103d8 )

by Tyler

created 2018-08-21 17:26 UTC

License::allocateMessage() A

↳ Parent: License

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	2

<?php

namespace Tylercd100\License;

use Illuminate\Database\Eloquent\Model;
use Tylercd100\License\Exceptions\LicenseException;
use Tylercd100\License\Models\License as LicenseModel;
use Tylercd100\License\HasLicenses;

abstract class License
{
    /**
     * Owner of the licenses
     *
     * @var Model
     */
    protected $owner;

    /**
     * The database model for tracking licenses
     *
     * @var LicenseModel
     */
    protected $model;

    /**
     * The default starting amount for the license
     *
     * @var int
     */
    protected $default = 0;

    function __construct(Model $owner)

    {
        if (!in_array(HasLicenses::class, class_uses($owner))) {
            throw new LicenseException("The owner must use the trait: ".HasLicenses::class);
        }

        $this->model = $this->getModel($owner);
        $this->owner = $owner;
    }

    protected function getModel(Model $owner)
    {
        $opts = [
            "owner_type" => get_class($owner),
            "owner_id" => $owner->id,
            "license" => get_class($this),
        ];

        $x = LicenseModel::where($opts)->first();
        
        if (!$x) {
            $opts["quantity"] = $this->default;
            $x = LicenseModel::create($opts);

        }

        return $x;
    }

    public function __toString()
    {
        return $this->name();
    }

    /**
     * Returns the owner of the license
     *
     * @return Model
     */
    public function getOwner()
    {
        return $this->owner;
    }

    /**
     * Throws exception if there are not enough licenses available
     *
     * @param int $quantity
     * @param boolean $add
     * @return void
     */
    public function allocate($quantity, $add = false)
    {
        $remaining = $this->remaining();
        if ($remaining < $quantity) {
            if(!$add) {
                $this->error($this->allocateMessage($remaining, $quantity));
            } else {
                $this->add($quantity);
            }
        }

        $this->allocateSuccess($quantity);
    }

    /**
     * Attempts to lower the quantity of licenses. The sub flag must be true.
     *
     * @param int $quantity
     * @param boolean $sub
     * @return void
     */
    public function deallocate($quantity, $sub = false)
    {
        $used = $this->used();
        if ($used - $quantity >= 0) {
            if(!$sub) {
                $this->error($this->deallocateMessage($used, $quantity));
            } else {
                $this->sub($quantity);
            }
        }

        $this->deallocateSuccess($quantity);
    }

    /**
     * Called when there are enough licenses available to allocate
     *
     * @param int $quantity
     * @return void
     */
    protected function allocateSuccess($quantity)

    {
        
    }

    /**
     * Called when there are enough licenses available to deallocate
     *
     * @param int $quantity
     * @return void
     */
    protected function deallocateSuccess($quantity)

    {
        
    }

    /**
     * Called when there are not enough licenses available
     *
     * @param int $remaining
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param int $quantity
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return void
     */
    protected function error($message)
    {
        throw new LicenseException($message);
    }

    /**
     * Returns the difference between the maximum amount licenses and what you are trying to limit
     *
     * @return int
     */
    public function remaining()
    {
        return max($this->maximum() - $this->used(), 0);
    }

    /**
     * Returns the maximum amount of licenses
     *
     * @return int
     */
    public function maximum()
    {
        return $this->model->quantity;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * Returns the human readable error string when there are not enough licenses available.
     *
     * @param int $remaining Number of licenses available.
     * @param int $quantity Number of licenses trying to allocate.
     * @return string
     */
    protected function allocateMessage($remaining, $quantity)
    {
        return "There are not enough licenses available. Tried to allocate {$quantity} but there are only {$remaining} available.";
    }

    /**
     * Returns the human readable error string when there are not enough licenses remaining to remove.
     *
     * @param int $remaining Number of licenses available.
     * @param int $quantity Number of licenses trying to deallocate.
     * @return string
     */
    protected function deallocateMessage($remaining, $quantity)
    {
        return "You cannot remove more licenses than you have available. Tried to deallocate {$quantity} but there are only {$remaining} remaining.";
    }

    /**
     * Returns human readable string for this license
     *
     * @return string
     */
    abstract public function name();

    /**
     * Returns the current amount of licenses in use
     *
     * @return int
     */
    abstract public function used();

    /**
     * Called before adding to the license count.
     * 
     * @param int $quantity
     * @return void
     */
    abstract protected function adding($quantity);

    /**
     * Called after adding to the license count
     *
     * @param int $quantity
     * @return void
     */
    abstract protected function added($quantity);

    /**
     * Called before subtracting the license count
     *
     * @param int $quantity
     * @return void
     */
    abstract protected function subtracting($quantity);

    /**
     * Called after subtracting the license count
     * 
     * @param int $quantity
     * @return void
     */
    abstract protected function subtracted($quantity);

    /**
     * Add more licenses
     *
     * @param int $quantity
     * @return boolean
     */
    final public function add($quantity = 1)
    {
        if (!is_int($quantity) || $quantity < 0) {
            throw new LicenseException("Quantity must be a positive integer.");
        }

        $this->adding($quantity);

        $this->model->quantity += $quantity;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $this->model->save();

        $this->added($quantity);
        
        return true;
    }

    /**
     * Subtract licenses
     *
     * @param int $quantity
     * @return boolean
     */
    final public function sub($quantity = 1)
    {
        if (!is_int($quantity) || $quantity < 0) {
            throw new LicenseException("Quantity must be a positive integer.");
        }

        if ($this->model->quantity - $quantity < 0) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            throw new LicenseException("You cannot remove more licenses than you have available.");
        }

        $this->subtracting($quantity);

        $this->model->quantity -= $quantity;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $this->model->save();

        $this->subtracted($quantity);
        
        return true;
    }

    /**
     * Set the amount of licenses
     *
     * @param int $quantity
     * @return boolean
     */
    final public function set($quantity)
    {
        if (!is_int($quantity) || $quantity < 0) {
            throw new LicenseException("Quantity must be a positive integer.");
        }

        $difference = $quantity - $this->maximum();

        if ($difference < 0) {
            return $this->sub(abs($difference));
        } else {
            return $this->add($difference);
        }
    }
}


1			<?php
2
3			namespace Tylercd100\License;
4
5			use Illuminate\Database\Eloquent\Model;
6			use Tylercd100\License\Exceptions\LicenseException;
7			use Tylercd100\License\Models\License as LicenseModel;
8			use Tylercd100\License\HasLicenses;
9
10			abstract class License
11			{
12			/**
13			* Owner of the licenses
14			*
15			* @var Model
16			*/
17			protected $owner;
18
19			/**
20			* The database model for tracking licenses
21			*
22			* @var LicenseModel
23			*/
24			protected $model;
25
26			/**
27			* The default starting amount for the license
28			*
29			* @var int
30			*/
31			protected $default = 0;
32
33			function __construct(Model $owner)
			0 ignored issues – show Best Practice introduced 2017-09-15 22:39 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
34			{
35			if (!in_array(HasLicenses::class, class_uses($owner))) {
36			throw new LicenseException("The owner must use the trait: ".HasLicenses::class);
37			}
38
39			$this->model = $this->getModel($owner);
40			$this->owner = $owner;
41			}
42
43			protected function getModel(Model $owner)
44			{
45			$opts = [
46			"owner_type" => get_class($owner),
47			"owner_id" => $owner->id,
48			"license" => get_class($this),
49			];
50
51			$x = LicenseModel::where($opts)->first();
52
53			if (!$x) {
54			$opts["quantity"] = $this->default;
55			$x = LicenseModel::create($opts);
			0 ignored issues – show Bug introduced 2017-09-18 23:06 UTC by Report Bug Copy Issue Report The method `create()` does not exist on `Tylercd100\License\Models\License`. Did you maybe mean `created()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
56			}
57
58			return $x;
59			}
60
61			public function __toString()
62			{
63			return $this->name();
64			}
65
66			/**
67			* Returns the owner of the license
68			*
69			* @return Model
70			*/
71			public function getOwner()
72			{
73			return $this->owner;
74			}
75
76			/**
77			* Throws exception if there are not enough licenses available
78			*
79			* @param int $quantity
80			* @param boolean $add
81			* @return void
82			*/
83			public function allocate($quantity, $add = false)
84			{
85			$remaining = $this->remaining();
86			if ($remaining < $quantity) {
87			if(!$add) {
88			$this->error($this->allocateMessage($remaining, $quantity));
89			} else {
90			$this->add($quantity);
91			}
92			}
93
94			$this->allocateSuccess($quantity);
95			}
96
97			/**
98			* Attempts to lower the quantity of licenses. The sub flag must be true.
99			*
100			* @param int $quantity
101			* @param boolean $sub
102			* @return void
103			*/
104			public function deallocate($quantity, $sub = false)
105			{
106			$used = $this->used();
107			if ($used - $quantity >= 0) {
108			if(!$sub) {
109			$this->error($this->deallocateMessage($used, $quantity));
110			} else {
111			$this->sub($quantity);
112			}
113			}
114
115			$this->deallocateSuccess($quantity);
116			}
117
118			/**
119			* Called when there are enough licenses available to allocate
120			*
121			* @param int $quantity
122			* @return void
123			*/
124			protected function allocateSuccess($quantity)
			0 ignored issues – show Unused Code introduced 2018-08-21 17:33 UTC by Report Bug Copy Issue Report The parameter `$quantity` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
125			{
126
127			}
128
129			/**
130			* Called when there are enough licenses available to deallocate
131			*
132			* @param int $quantity
133			* @return void
134			*/
135			protected function deallocateSuccess($quantity)
			0 ignored issues – show Unused Code introduced 2018-08-21 17:33 UTC by Report Bug Copy Issue Report The parameter `$quantity` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
136			{
137
138			}
139
140			/**
141			* Called when there are not enough licenses available
142			*
143			* @param int $remaining
			0 ignored issues – show Bug introduced 2018-08-21 17:33 UTC by Report Bug Copy Issue Report There is no parameter named `$remaining`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
144			* @param int $quantity
			0 ignored issues – show Bug introduced 2018-08-21 17:33 UTC by Report Bug Copy Issue Report There is no parameter named `$quantity`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
145			* @return void
146			*/
147			protected function error($message)
148			{
149			throw new LicenseException($message);
150			}
151
152			/**
153			* Returns the difference between the maximum amount licenses and what you are trying to limit
154			*
155			* @return int
156			*/
157			public function remaining()
158			{
159			return max($this->maximum() - $this->used(), 0);
160			}
161
162			/**
163			* Returns the maximum amount of licenses
164			*
165			* @return int
166			*/
167			public function maximum()
168			{
169			return $this->model->quantity;
			0 ignored issues – show Documentation introduced 2017-09-15 22:39 UTC by Report Bug Copy Issue Report The property `quantity` does not exist on `object<Tylercd100\License\Models\License>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
170			}
171
172			/**
173			* Returns the human readable error string when there are not enough licenses available.
174			*
175			* @param int $remaining Number of licenses available.
176			* @param int $quantity Number of licenses trying to allocate.
177			* @return string
178			*/
179			protected function allocateMessage($remaining, $quantity)
180			{
181			return "There are not enough licenses available. Tried to allocate {$quantity} but there are only {$remaining} available.";
182			}
183
184			/**
185			* Returns the human readable error string when there are not enough licenses remaining to remove.
186			*
187			* @param int $remaining Number of licenses available.
188			* @param int $quantity Number of licenses trying to deallocate.
189			* @return string
190			*/
191			protected function deallocateMessage($remaining, $quantity)
192			{
193			return "You cannot remove more licenses than you have available. Tried to deallocate {$quantity} but there are only {$remaining} remaining.";
194			}
195
196			/**
197			* Returns human readable string for this license
198			*
199			* @return string
200			*/
201			abstract public function name();
202
203			/**
204			* Returns the current amount of licenses in use
205			*
206			* @return int
207			*/
208			abstract public function used();
209
210			/**
211			* Called before adding to the license count.
212			*
213			* @param int $quantity
214			* @return void
215			*/
216			abstract protected function adding($quantity);
217
218			/**
219			* Called after adding to the license count
220			*
221			* @param int $quantity
222			* @return void
223			*/
224			abstract protected function added($quantity);
225
226			/**
227			* Called before subtracting the license count
228			*
229			* @param int $quantity
230			* @return void
231			*/
232			abstract protected function subtracting($quantity);
233
234			/**
235			* Called after subtracting the license count
236			*
237			* @param int $quantity
238			* @return void
239			*/
240			abstract protected function subtracted($quantity);
241
242			/**
243			* Add more licenses
244			*
245			* @param int $quantity
246			* @return boolean
247			*/
248			final public function add($quantity = 1)
249			{
250			if (!is_int($quantity) \|\| $quantity < 0) {
251			throw new LicenseException("Quantity must be a positive integer.");
252			}
253
254			$this->adding($quantity);
255
256			$this->model->quantity += $quantity;
			0 ignored issues – show Documentation introduced 2017-09-15 22:39 UTC by Report Bug Copy Issue Report The property `quantity` does not exist on `object<Tylercd100\License\Models\License>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
257			$this->model->save();
258
259			$this->added($quantity);
260
261			return true;
262			}
263
264			/**
265			* Subtract licenses
266			*
267			* @param int $quantity
268			* @return boolean
269			*/
270			final public function sub($quantity = 1)
271			{
272			if (!is_int($quantity) \|\| $quantity < 0) {
273			throw new LicenseException("Quantity must be a positive integer.");
274			}
275
276			if ($this->model->quantity - $quantity < 0) {
			0 ignored issues – show Documentation introduced 2017-09-15 22:39 UTC by Report Bug Copy Issue Report The property `quantity` does not exist on `object<Tylercd100\License\Models\License>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
277			throw new LicenseException("You cannot remove more licenses than you have available.");
278			}
279
280			$this->subtracting($quantity);
281
282			$this->model->quantity -= $quantity;
			0 ignored issues – show Documentation introduced 2017-09-15 22:39 UTC by Report Bug Copy Issue Report The property `quantity` does not exist on `object<Tylercd100\License\Models\License>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
283			$this->model->save();
284
285			$this->subtracted($quantity);
286
287			return true;
288			}
289
290			/**
291			* Set the amount of licenses
292			*
293			* @param int $quantity
294			* @return boolean
295			*/
296			final public function set($quantity)
297			{
298			if (!is_int($quantity) \|\| $quantity < 0) {
299			throw new LicenseException("Quantity must be a positive integer.");
300			}
301
302			$difference = $quantity - $this->maximum();
303
304			if ($difference < 0) {
305			return $this->sub(abs($difference));
306			} else {
307			return $this->add($difference);
308			}
309			}
310			}
311

tylercd100 / laravel-licenser

Push — master ( 4db34d...4103d8 )

License::allocateMessage() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like