ServiceOptions::getDisplayExecutableAttribute() - Code Metrics - Inspection of "Implementation of improved Model logic and relatio..." - Pterodactyl/Panel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#286)

by Dane

created 2017-02-10 22:42 UTC

ServiceOptions::getDisplayExecutableAttribute() A

↳ Parent: ServiceOptions

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
/**
 * Pterodactyl - Panel
 * Copyright (c) 2015 - 2017 Dane Everitt <[email protected]>.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

namespace Pterodactyl\Models;

use Illuminate\Database\Eloquent\Model;

class ServiceOptions extends Model
{
    /**
     * The table associated with the model.
     *
     * @var string
     */
    protected $table = 'service_options';

    /**
     * Fields that are not mass assignable.
     *
     * @var array
     */
    protected $guarded = ['id', 'created_at', 'updated_at'];

     /**
      * Cast values to correct type.
      *
      * @var array
      */
     protected $casts = [
         'service_id' => 'integer',
     ];

     /**
      * Returns the display executable for the option and will use the parent
      * service one if the option does not have one defined.
      *
      * @return string
      */
     public function getDisplayExecutableAttribute($value)

     {
         return (is_null($this->executable)) ? $this->service->executable : $this->executable;
<?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 display startup string for the option and will use the parent
      * service one if the option does not have one defined.
      *
      * @return string
      */
     public function getDisplayStartupAttribute($value)

     {
         return (is_null($this->startup)) ? $this->service->startup : $this->startup;
<?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.");
        }
    }

}
     }

     /**
      * Gets service associated with a service option.
      *
      * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
      */
     public function service()
     {
         return $this->belongsTo(Service::class);
     }

     /**
      * Gets all servers associated with this service option.
      *
      * @return \Illuminate\Database\Eloquent\Relations\HasMany
      */
     public function servers()
     {
         return $this->hasMany(Server::class, 'option_id');
     }

     /**
      * Gets all variables associated with this service.
      *
      * @return \Illuminate\Database\Eloquent\Relations\HasMany
      */
     public function variables()
     {
         return $this->hasMany(ServiceVariables::class, 'option_id');
     }

     /**
      * Gets all packs associated with this service.
      *
      * @return \Illuminate\Database\Eloquent\Relations\HasMany
      */
     public function packs()
     {
         return $this->hasMany(ServicePack::class, 'option_id');
     }
}


1			<?php
2			/**
3			* Pterodactyl - Panel
4			* Copyright (c) 2015 - 2017 Dane Everitt <[email protected]>.
5			*
6			* Permission is hereby granted, free of charge, to any person obtaining a copy
7			* of this software and associated documentation files (the "Software"), to deal
8			* in the Software without restriction, including without limitation the rights
9			* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10			* copies of the Software, and to permit persons to whom the Software is
11			* furnished to do so, subject to the following conditions:
12			*
13			* The above copyright notice and this permission notice shall be included in all
14			* copies or substantial portions of the Software.
15			*
16			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18			* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19			* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20			* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21			* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22			* SOFTWARE.
23			*/
24
25			namespace Pterodactyl\Models;
26
27			use Illuminate\Database\Eloquent\Model;
28
29			class ServiceOptions extends Model
30			{
31			/**
32			* The table associated with the model.
33			*
34			* @var string
35			*/
36			protected $table = 'service_options';
37
38			/**
39			* Fields that are not mass assignable.
40			*
41			* @var array
42			*/
43			protected $guarded = ['id', 'created_at', 'updated_at'];
44
45			/**
46			* Cast values to correct type.
47			*
48			* @var array
49			*/
50			protected $casts = [
51			'service_id' => 'integer',
52			];
53
54			/**
55			* Returns the display executable for the option and will use the parent
56			* service one if the option does not have one defined.
57			*
58			* @return string
59			*/
60			public function getDisplayExecutableAttribute($value)
			0 ignored issues – show Unused Code introduced 2017-02-09 22:48 UTC by Report Bug Copy Issue Report The parameter `$value` 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...
61			{
62			return (is_null($this->executable)) ? $this->service->executable : $this->executable;
			0 ignored issues – show Documentation introduced 2017-02-09 22:48 UTC by Report Bug Copy Issue Report The property `executable` does not exist on `object<Pterodactyl\Models\ServiceOptions>`. 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... Documentation introduced 2017-02-09 22:48 UTC by Report Bug Copy Issue Report The property `service` does not exist on `object<Pterodactyl\Models\ServiceOptions>`. 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...
63			}
64
65			/**
66			* Returns the display startup string for the option and will use the parent
67			* service one if the option does not have one defined.
68			*
69			* @return string
70			*/
71			public function getDisplayStartupAttribute($value)
			0 ignored issues – show Unused Code introduced 2017-02-09 22:48 UTC by Report Bug Copy Issue Report The parameter `$value` 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...
72			{
73			return (is_null($this->startup)) ? $this->service->startup : $this->startup;
			0 ignored issues – show Documentation introduced 2017-02-09 22:48 UTC by Report Bug Copy Issue Report The property `startup` does not exist on `object<Pterodactyl\Models\ServiceOptions>`. 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... Documentation introduced 2017-02-09 22:48 UTC by Report Bug Copy Issue Report The property `service` does not exist on `object<Pterodactyl\Models\ServiceOptions>`. 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...
74			}
75
76			/**
77			* Gets service associated with a service option.
78			*
79			* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
80			*/
81			public function service()
82			{
83			return $this->belongsTo(Service::class);
84			}
85
86			/**
87			* Gets all servers associated with this service option.
88			*
89			* @return \Illuminate\Database\Eloquent\Relations\HasMany
90			*/
91			public function servers()
92			{
93			return $this->hasMany(Server::class, 'option_id');
94			}
95
96			/**
97			* Gets all variables associated with this service.
98			*
99			* @return \Illuminate\Database\Eloquent\Relations\HasMany
100			*/
101			public function variables()
102			{
103			return $this->hasMany(ServiceVariables::class, 'option_id');
104			}
105
106			/**
107			* Gets all packs associated with this service.
108			*
109			* @return \Illuminate\Database\Eloquent\Relations\HasMany
110			*/
111			public function packs()
112			{
113			return $this->hasMany(ServicePack::class, 'option_id');
114			}
115			}
116

Pterodactyl / Panel

GitHub Access Token became invalid

Pull Request — develop (#286)

ServiceOptions::getDisplayExecutableAttribute() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like