VariableRepository::delete() - Code Metrics - Pterodactyl/Panel - Measure and Improve Code Quality continuously with Scrutinizer

VariableRepository::delete() A
last analyzed 2017-06-15 01:59 UTC

↳ Parent: VariableRepository

Complexity

Conditions	2
Paths	1

Size

Total Lines	12
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	12
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	6
nc	1
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\Repositories;

use DB;
use Validator;
use Pterodactyl\Models\ServiceOption;
use Pterodactyl\Models\ServiceVariable;
use Pterodactyl\Exceptions\DisplayException;
use Pterodactyl\Exceptions\DisplayValidationException;

class VariableRepository
{
    /**
     * Create a new service variable.
     *
     * @param  int    $option
     * @param  array  $data
     * @return \Pterodactyl\Models\ServiceVariable
     *
     * @throws \Pterodactyl\Exceptions\DisplayException
     * @throws \Pterodactyl\Exceptions\DisplayValidationException
     */
    public function create($option, array $data)
    {
        $option = ServiceOption::select('id')->findOrFail($option);

        $validator = Validator::make($data, [
            'name' => 'required|string|min:1|max:255',
            'description' => 'sometimes|nullable|string',
            'env_variable' => 'required|regex:/^[\w]{1,255}$/',
            'default_value' => 'string',
            'options' => 'sometimes|required|array',
            'rules' => 'bail|required|string',
        ]);

        // Ensure the default value is allowed by the rules provided.
        $validator->sometimes('default_value', $data['rules'] ?? null, function ($input) {
            return $input->default_value;
        });

        if ($validator->fails()) {
            throw new DisplayValidationException(json_encode($validator->errors()));
        }

        if (in_array($data['env_variable'], ServiceVariable::reservedNames())) {
            throw new DisplayException('The environment variable name provided is a reserved keyword for the daemon.');
        }

        $search = ServiceVariable::where('env_variable', $data['env_variable'])->where('option_id', $option->id);
        if ($search->first()) {
            throw new DisplayException('The envionment variable name assigned to this variable must be unique for this service option.');
        }

        if (! isset($data['options']) || ! is_array($data['options'])) {
            $data['options'] = [];
        }

        $data['option_id'] = $option->id;
        $data['user_viewable'] = (in_array('user_viewable', $data['options']));
        $data['user_editable'] = (in_array('user_editable', $data['options']));

        // Remove field that isn't used.
        unset($data['options']);

        return ServiceVariable::create($data);
    }

    /**
     * Deletes a specified option variable as well as all server
     * variables currently assigned.
     *
     * @param  int  $id
     * @return void
     */
    public function delete($id)
    {
        $variable = ServiceVariable::with('serverVariable')->findOrFail($id);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

        DB::transaction(function () use ($variable) {
            foreach ($variable->serverVariable as $v) {
                $v->delete();
            }

            $variable->delete();
        });
    }

    /**
     * Updates a given service variable.
     *
     * @param  int    $id
     * @param  array  $data
     * @return \Pterodactyl\Models\ServiceVariable
     *
     * @throws \Pterodactyl\Exceptions\DisplayException
     * @throws \Pterodactyl\Exceptions\DisplayValidationException
     */
    public function update($id, array $data)
    {
        $variable = ServiceVariable::findOrFail($id);

        $validator = Validator::make($data, [
            'name' => 'sometimes|required|string|min:1|max:255',
            'description' => 'sometimes|nullable|string',
            'env_variable' => 'sometimes|required|regex:/^[\w]{1,255}$/',
            'default_value' => 'string',
            'options' => 'sometimes|required|array',
            'rules' => 'bail|sometimes|required|string|min:1',
        ]);

        // Ensure the default value is allowed by the rules provided.
        $rules = (isset($data['rules'])) ? $data['rules'] : $variable->rules;
        $validator->sometimes('default_value', $rules, function ($input) {
            return $input->default_value;
        });

        if ($validator->fails()) {
            throw new DisplayValidationException(json_encode($validator->errors()));
        }

        if (isset($data['env_variable'])) {
            if (in_array($data['env_variable'], ServiceVariable::reservedNames())) {
                throw new DisplayException('The environment variable name provided is a reserved keyword for the daemon.');
            }

            $search = ServiceVariable::where('env_variable', $data['env_variable'])
                ->where('option_id', $variable->option_id)
                ->where('id', '!=', $variable->id);
            if ($search->first()) {
                throw new DisplayException('The envionment variable name assigned to this variable must be unique for this service option.');
            }
        }

        if (! isset($data['options']) || ! is_array($data['options'])) {
            $data['options'] = [];
        }

        $data['user_viewable'] = (in_array('user_viewable', $data['options']));
        $data['user_editable'] = (in_array('user_editable', $data['options']));

        // Remove field that isn't used.
        unset($data['options']);

        $variable->fill($data)->save();

        return $variable;
    }
}


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\Repositories;
26
27			use DB;
28			use Validator;
29			use Pterodactyl\Models\ServiceOption;
30			use Pterodactyl\Models\ServiceVariable;
31			use Pterodactyl\Exceptions\DisplayException;
32			use Pterodactyl\Exceptions\DisplayValidationException;
33
34			class VariableRepository
35			{
36			/**
37			* Create a new service variable.
38			*
39			* @param int $option
40			* @param array $data
41			* @return \Pterodactyl\Models\ServiceVariable
42			*
43			* @throws \Pterodactyl\Exceptions\DisplayException
44			* @throws \Pterodactyl\Exceptions\DisplayValidationException
45			*/
46			public function create($option, array $data)
47			{
48			$option = ServiceOption::select('id')->findOrFail($option);
49
50			$validator = Validator::make($data, [
51			'name' => 'required\|string\|min:1\|max:255',
52			'description' => 'sometimes\|nullable\|string',
53			'env_variable' => 'required\|regex:/^[\w]{1,255}$/',
54			'default_value' => 'string',
55			'options' => 'sometimes\|required\|array',
56			'rules' => 'bail\|required\|string',
57			]);
58
59			// Ensure the default value is allowed by the rules provided.
60			$validator->sometimes('default_value', $data['rules'] ?? null, function ($input) {
61			return $input->default_value;
62			});
63
64			if ($validator->fails()) {
65			throw new DisplayValidationException(json_encode($validator->errors()));
66			}
67
68			if (in_array($data['env_variable'], ServiceVariable::reservedNames())) {
69			throw new DisplayException('The environment variable name provided is a reserved keyword for the daemon.');
70			}
71
72			$search = ServiceVariable::where('env_variable', $data['env_variable'])->where('option_id', $option->id);
73			if ($search->first()) {
74			throw new DisplayException('The envionment variable name assigned to this variable must be unique for this service option.');
75			}
76
77			if (! isset($data['options']) \|\| ! is_array($data['options'])) {
78			$data['options'] = [];
79			}
80
81			$data['option_id'] = $option->id;
82			$data['user_viewable'] = (in_array('user_viewable', $data['options']));
83			$data['user_editable'] = (in_array('user_editable', $data['options']));
84
85			// Remove field that isn't used.
86			unset($data['options']);
87
88			return ServiceVariable::create($data);
89			}
90
91			/**
92			* Deletes a specified option variable as well as all server
93			* variables currently assigned.
94			*
95			* @param int $id
96			* @return void
97			*/
98			public function delete($id)
99			{
100			$variable = ServiceVariable::with('serverVariable')->findOrFail($id);
			0 ignored issues – show Bug introduced 2017-03-16 01:04 UTC by Report Bug Copy Issue Report The method `findOrFail` does only exist in `Illuminate\Database\Eloquent\Builder`, but not in `Illuminate\Database\Eloquent\Model`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
101
102			DB::transaction(function () use ($variable) {
103			foreach ($variable->serverVariable as $v) {
104			$v->delete();
105			}
106
107			$variable->delete();
108			});
109			}
110
111			/**
112			* Updates a given service variable.
113			*
114			* @param int $id
115			* @param array $data
116			* @return \Pterodactyl\Models\ServiceVariable
117			*
118			* @throws \Pterodactyl\Exceptions\DisplayException
119			* @throws \Pterodactyl\Exceptions\DisplayValidationException
120			*/
121			public function update($id, array $data)
122			{
123			$variable = ServiceVariable::findOrFail($id);
124
125			$validator = Validator::make($data, [
126			'name' => 'sometimes\|required\|string\|min:1\|max:255',
127			'description' => 'sometimes\|nullable\|string',
128			'env_variable' => 'sometimes\|required\|regex:/^[\w]{1,255}$/',
129			'default_value' => 'string',
130			'options' => 'sometimes\|required\|array',
131			'rules' => 'bail\|sometimes\|required\|string\|min:1',
132			]);
133
134			// Ensure the default value is allowed by the rules provided.
135			$rules = (isset($data['rules'])) ? $data['rules'] : $variable->rules;
136			$validator->sometimes('default_value', $rules, function ($input) {
137			return $input->default_value;
138			});
139
140			if ($validator->fails()) {
141			throw new DisplayValidationException(json_encode($validator->errors()));
142			}
143
144			if (isset($data['env_variable'])) {
145			if (in_array($data['env_variable'], ServiceVariable::reservedNames())) {
146			throw new DisplayException('The environment variable name provided is a reserved keyword for the daemon.');
147			}
148
149			$search = ServiceVariable::where('env_variable', $data['env_variable'])
150			->where('option_id', $variable->option_id)
151			->where('id', '!=', $variable->id);
152			if ($search->first()) {
153			throw new DisplayException('The envionment variable name assigned to this variable must be unique for this service option.');
154			}
155			}
156
157			if (! isset($data['options']) \|\| ! is_array($data['options'])) {
158			$data['options'] = [];
159			}
160
161			$data['user_viewable'] = (in_array('user_viewable', $data['options']));
162			$data['user_editable'] = (in_array('user_editable', $data['options']));
163
164			// Remove field that isn't used.
165			unset($data['options']);
166
167			$variable->fill($data)->save();
168
169			return $variable;
170			}
171			}
172

Pterodactyl / Panel

GitHub Access Token became invalid

VariableRepository::delete() A last analyzed 2017-06-15 01:59 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

VariableRepository::delete() A
last analyzed 2017-06-15 01:59 UTC