ResellerContext::suspendAccount() - Code Metrics - Inspection of "Suspending, unsuspending accounts feature" - omines/directadmin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d80879...6aff97 )

by Niels

created 2016-12-08 14:17 UTC

ResellerContext::suspendAccount() A

↳ Parent: ResellerContext

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/*
 * DirectAdmin API Client
 * (c) Omines Internetbureau B.V. - https://omines.nl/
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Omines\DirectAdmin\Context;

use Omines\DirectAdmin\Objects\BaseObject;
use Omines\DirectAdmin\Objects\Users\User;

/**
 * Context for reseller functions.
 *
 * @author Niels Keurentjes <[email protected]>
 */
class ResellerContext extends UserContext
{
    /**
     * Creates a new user on the server.
     *
     * @param string $username Login for the new user
     * @param string $password Password for the new user
     * @param string $email Email for the new user
     * @param string $domain Default domain for the new user
     * @param string $ip IP for the user
     * @param string|array $package Either a package name or an array of options for custom
     * @return User Newly created user
     * @url http://www.directadmin.com/api.html#create for options to use.
     */
    public function createUser($username, $password, $email, $domain, $ip, $package = [])
    {
        $options = array_merge(
            ['ip' => $ip, 'domain' => $domain],
            is_array($package) ? $package : ['package' => $package]
        );
        return $this->createAccount($username, $password, $email, $options, 'ACCOUNT_USER', User::class);
    }

    /**
     * Internal helper function for creating new accounts.
     *
     * @param string $username Login for the new user
     * @param string $password Password for the new user
     * @param string $email Email for the new user
     * @param array $options List of DA account options to apply
     * @param string $endpoint API endpoint to invoke
     * @param string $returnType Class name that should wrap the resulting account
     * @return object An instance of the type specified in $returnType
     */
    protected function createAccount($username, $password, $email, $options, $endpoint, $returnType)
    {
        $this->invokePost($endpoint, array_merge($options, [
            'action' => 'create',
            'add' => 'Submit',
            'email' => $email,
            'passwd' => $password,
            'passwd2' => $password,
            'username' => $username,
        ]));
        return new $returnType($username, $this);
    }

    /**
     * Deletes a single account.
     *
     * @param string $username Account to delete
     */
    public function deleteAccount($username)
    {
        $this->deleteAccounts([$username]);
    }

    /**
     * Deletes multiple accounts.
     *
     * @param string[] $usernames Accounts to delete
     */
    public function deleteAccounts(array $usernames)

    {
        $options = ['confirmed' => 'Confirm', 'delete' => 'yes'];
        foreach (array_values($usernames) as $idx => $username) {
            $options["select{$idx}"] = $username;
        }
        $this->invokePost('SELECT_USERS', $options);
    }

    /**
     * Suspends a single account
     *
     * @param string $username Account to delete
     */
    public function suspendAccount($username)
    {
        $this->suspendAccounts([$username]);
    }

    /**
     * Unsuspends a single account
     * @param string $username Account to delete
     */
    public function unsuspendAccount($username)
    {
        $this->suspendAccounts([$username], false);
    }

    /**
     * Suspends (or unsuspends) multiple accounts.
     *
     * @param string[] $usernames Accounts to delete
     * @param bool $suspend (true - suspend, false - unsuspend)
     */
    public function suspendAccounts(array $usernames, $suspend = true)

    {
        $options = ['suspend' => $suspend ? 'Suspend' : 'Unsuspend'];
        foreach (array_values($usernames) as $idx => $username) {
            $options["select{$idx}"] = $username;
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
        }
        $this->invokePost('SELECT_USERS', $options);
    }

    /**
     * Unsuspends multiple accounts.
     *
     * @param string[] $usernames Accounts to delete
     */
    public function unsuspendAccounts(array $usernames)
    {
        $this->suspendAccounts($usernames, false);
    }

    /**
     * Returns all IPs available to this reseller.
     *
     * @return array List of IPs as strings
     */
    public function getIPs()
    {
        return $this->invokeGet('SHOW_RESELLER_IPS');
    }

    /**
     * Returns a single user by name.
     *
     * @param string $username
     * @return User|null
     */
    public function getUser($username)
    {
        $resellers = $this->getUsers();
        return isset($resellers[$username]) ? $resellers[$username] : null;
    }

    /**
     * Returns all users for this reseller.
     *
     * @return User[] Associative array of users
     */
    public function getUsers()
    {
        return BaseObject::toObjectArray($this->invokeGet('SHOW_USERS'), User::class, $this);
    }

    /**
     * Impersonates a user, allowing the reseller/admin to act on their behalf.
     *
     * @param string $username Login of the account to impersonate
     * @param bool $validate Whether to check the user exists and is a user
     * @return UserContext
     */
    public function impersonateUser($username, $validate = false)
    {
        return new UserContext($this->getConnection()->loginAs($username), $validate);
    }
}


1		<?php
2
3		/*
4		* DirectAdmin API Client
5		* (c) Omines Internetbureau B.V. - https://omines.nl/
6		*
7		* For the full copyright and license information, please view the LICENSE
8		* file that was distributed with this source code.
9		*/
10
11		namespace Omines\DirectAdmin\Context;
12
13		use Omines\DirectAdmin\Objects\BaseObject;
14		use Omines\DirectAdmin\Objects\Users\User;
15
16		/**
17		* Context for reseller functions.
18		*
19		* @author Niels Keurentjes <[email protected]>
20		*/
21		class ResellerContext extends UserContext
22		{
23		/**
24		* Creates a new user on the server.
25		*
26		* @param string $username Login for the new user
27		* @param string $password Password for the new user
28		* @param string $email Email for the new user
29		* @param string $domain Default domain for the new user
30		* @param string $ip IP for the user
31		* @param string\|array $package Either a package name or an array of options for custom
32		* @return User Newly created user
33		* @url http://www.directadmin.com/api.html#create for options to use.
34		*/
35		public function createUser($username, $password, $email, $domain, $ip, $package = [])
36		{
37		$options = array_merge(
38		['ip' => $ip, 'domain' => $domain],
39		is_array($package) ? $package : ['package' => $package]
40		);
41		return $this->createAccount($username, $password, $email, $options, 'ACCOUNT_USER', User::class);
42		}
43
44		/**
45		* Internal helper function for creating new accounts.
46		*
47		* @param string $username Login for the new user
48		* @param string $password Password for the new user
49		* @param string $email Email for the new user
50		* @param array $options List of DA account options to apply
51		* @param string $endpoint API endpoint to invoke
52		* @param string $returnType Class name that should wrap the resulting account
53		* @return object An instance of the type specified in $returnType
54		*/
55		protected function createAccount($username, $password, $email, $options, $endpoint, $returnType)
56		{
57		$this->invokePost($endpoint, array_merge($options, [
58		'action' => 'create',
59		'add' => 'Submit',
60		'email' => $email,
61		'passwd' => $password,
62		'passwd2' => $password,
63		'username' => $username,
64		]));
65		return new $returnType($username, $this);
66		}
67
68		/**
69		* Deletes a single account.
70		*
71		* @param string $username Account to delete
72		*/
73		public function deleteAccount($username)
74		{
75		$this->deleteAccounts([$username]);
76		}
77
78		/**
79		* Deletes multiple accounts.
80		*
81		* @param string[] $usernames Accounts to delete
82		*/
83	View Code Duplication	public function deleteAccounts(array $usernames)
		0 ignored issues – show Duplication introduced 2016-12-07 12:18 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
84		{
85		$options = ['confirmed' => 'Confirm', 'delete' => 'yes'];
86		foreach (array_values($usernames) as $idx => $username) {
87		$options["select{$idx}"] = $username;
88		}
89		$this->invokePost('SELECT_USERS', $options);
90		}
91
92		/**
93		* Suspends a single account
94		*
95		* @param string $username Account to delete
96		*/
97		public function suspendAccount($username)
98		{
99		$this->suspendAccounts([$username]);
100		}
101
102		/**
103		* Unsuspends a single account
104		* @param string $username Account to delete
105		*/
106		public function unsuspendAccount($username)
107		{
108		$this->suspendAccounts([$username], false);
109		}
110
111		/**
112		* Suspends (or unsuspends) multiple accounts.
113		*
114		* @param string[] $usernames Accounts to delete
115		* @param bool $suspend (true - suspend, false - unsuspend)
116		*/
117	View Code Duplication	public function suspendAccounts(array $usernames, $suspend = true)
		0 ignored issues – show Duplication introduced 2016-12-07 12:18 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
118		{
119		$options = ['suspend' => $suspend ? 'Suspend' : 'Unsuspend'];
120		foreach (array_values($usernames) as $idx => $username) {
121		$options["select{$idx}"] = $username;
		0 ignored issues – show Coding Style Best Practice introduced 2016-12-07 12:18 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$idx` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history...
122		}
123		$this->invokePost('SELECT_USERS', $options);
124		}
125
126		/**
127		* Unsuspends multiple accounts.
128		*
129		* @param string[] $usernames Accounts to delete
130		*/
131		public function unsuspendAccounts(array $usernames)
132		{
133		$this->suspendAccounts($usernames, false);
134		}
135
136		/**
137		* Returns all IPs available to this reseller.
138		*
139		* @return array List of IPs as strings
140		*/
141		public function getIPs()
142		{
143		return $this->invokeGet('SHOW_RESELLER_IPS');
144		}
145
146		/**
147		* Returns a single user by name.
148		*
149		* @param string $username
150		* @return User\|null
151		*/
152		public function getUser($username)
153		{
154		$resellers = $this->getUsers();
155		return isset($resellers[$username]) ? $resellers[$username] : null;
156		}
157
158		/**
159		* Returns all users for this reseller.
160		*
161		* @return User[] Associative array of users
162		*/
163		public function getUsers()
164		{
165		return BaseObject::toObjectArray($this->invokeGet('SHOW_USERS'), User::class, $this);
166		}
167
168		/**
169		* Impersonates a user, allowing the reseller/admin to act on their behalf.
170		*
171		* @param string $username Login of the account to impersonate
172		* @param bool $validate Whether to check the user exists and is a user
173		* @return UserContext
174		*/
175		public function impersonateUser($username, $validate = false)
176		{
177		return new UserContext($this->getConnection()->loginAs($username), $validate);
178		}
179		}
180

omines / directadmin

Push — master ( d80879...6aff97 )

ResellerContext::suspendAccount() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like