Mongodump::excludeCollections() - Code Metrics - Inspection of "Use 'proc_open' over 'exec' to execute binaries" - sebastianfeldmann/phpbu - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e2a90b...0f1023 )

by Sebastian

created 2016-01-20 12:47 UTC

Mongodump::excludeCollections() A

↳ Parent: Mongodump

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	5
ccs	3
cts	3
cp	1
rs	9.4285
cc	1
eloc	3
nc	1
nop	1
crap	1

<?php
namespace phpbu\App\Cli\Executable;

use phpbu\App\Cli\Cmd;
use phpbu\App\Cli\Executable;
use phpbu\App\Cli\Process;
use phpbu\App\Exception;

/**
 * Mongodump executable class.
 *
 * @package    phpbu
 * @subpackage Backup
 * @author     Sebastian Feldmann <[email protected]>
 * @copyright  Sebastian Feldmann <[email protected]>
 * @license    https://opensource.org/licenses/MIT The MIT License (MIT)
 * @link       http://phpbu.de/
 * @since      Class available since Release 2.1.0
 */
class Mongodump extends Abstraction implements Executable
{
    /**
     * Dump Directory
     *
     * @var string
     */
    private $dumpDir;

    /**
     * Use IPv6
     * --ipv6
     *
     * @var boolean
     */
    private $useIPv6;

    /**
     * Host to connect to
     * --host <hostname:port>
     *
     * @var string
     */
    private $host;

    /**
     * User to connect with
     * --user <username>
     *
     * @var string
     */
    private $user;

    /**
     * Password to authenticate with
     * --password <password>
     *
     * @var string
     */
    private $password;

    /**
     * Database to use for authentication
     * --authenticationDatabase <dbname>
     *
     * @var string
     */
    private $authenticationDatabase;

    /**
     * List of databases to backup
     * --db <database>
     *
     * @var array
     */
    private $databases;

    /**
     * List of collections to backup
     * --collection <collection>
     *
     * @var array
     */
    private $collections;

    /**
     * List of collections to ignore
     * --excludeCollections array of strings
     *
     * @var array
     */
    private $excludeCollections;

    /**
     * List of prefixes to exclude collections
     * --excludeCollectionWithPrefix array of strings
     *
     * @var array
     */
    private $excludeCollectionsWithPrefix;

    /**
     * Constructor.
     *
     * @param string $path
     */
    public function __construct($path = null)
    {
        $this->cmd = 'mongodump';
        parent::__construct($path);
    }

    /**
     * Set path to dump to.
     *
     * @param  string $path
     * @return \phpbu\App\Cli\Executable\Mongodump
     */
    public function dumpToDirectory($path)
    {
        $this->dumpDir = $path;
        return $this;
    }

    /**
     * Use ipv6 to connect.
     *
     * @param  boolean $bool
     * @return \phpbu\App\Cli\Executable\Mongodump
     */
    public function useIpv6($bool)
    {
        $this->useIPv6 = $bool;
        return $this;
    }

    /**
     * Set host to dump from.
     *
     * @param  string $host
     * @return \phpbu\App\Cli\Executable\Mongodump
     */
    public function useHost($host)
    {
        $this->host = $host;
        return $this;
    }

    /**
     * Set credentials.
     *
     * @param  string $user
     * @param  string $password
     * @param  string $authDatabase
     * @return \phpbu\App\Cli\Executable\Mongodump
     */
    public function credentials($user = null, $password = null, $authDatabase = null)
    {
        $this->user                   = $user;
        $this->password               = $password;
        $this->authenticationDatabase = $authDatabase;
        return $this;
    }

    /**
     * Dump only given databases.
     *
     * @param  array $databases
     * @return \phpbu\App\Cli\Executable\Mongodump
     */
    public function dumpDatabases(array $databases)
    {
        $this->databases = $databases;
        return $this;
    }

    /**
     * Dump only given collections.
     *
     * @param  array $collections
     * @return \phpbu\App\Cli\Executable\Mongodump
     */
    public function dumpCollections(array $collections)
    {
        $this->collections = $collections;
        return $this;
    }

    /**
     * Exclude collections.
     *
     * @param  array $collections
     * @return \phpbu\App\Cli\Executable\Mongodump
     */
    public function excludeCollections(array $collections)
    {
        $this->excludeCollections = $collections;
        return $this;
    }

    /**
     * Exclude collections with given prefixes.
     *
     * @param  array $prefixes
     * @return \phpbu\App\Cli\Executable\Mongodump
     */
    public function excludeCollectionsWithPrefix(array $prefixes)
    {
        $this->excludeCollectionsWithPrefix = $prefixes;
        return $this;
    }

    /**
     * Subclass Process generator.
     *
     * @return \phpbu\App\Cli\Process
     * @throws \phpbu\App\Exception
     */
    protected function createProcess()
    {
        if (empty($this->dumpDir)) {
            throw new Exception('no directory to dump to');
        }
        $process = new Process();
        $cmd     = new Cmd($this->binary);
        $process->addCommand($cmd);

        $cmd->addOption('--out', $this->dumpDir, ' ');
        $cmd->addOptionIfNotEmpty('--ipv6', $this->useIPv6, false);
        $cmd->addOptionIfNotEmpty('--host', $this->host, true, ' ');
        $cmd->addOptionIfNotEmpty('--user', $this->user, true, ' ');
        $cmd->addOptionIfNotEmpty('--password', $this->password, true, ' ');
        $cmd->addOptionIfNotEmpty('--authenticationDatabase', $this->authenticationDatabase, true, ' ');

        if (count($this->databases)) {
            foreach ($this->databases as $db) {
                $cmd->addOption('--database', $db, ' ');
            }
        }

        if (count($this->collections)) {
            foreach ($this->collections as $col) {
                $cmd->addOption('--collection', $col, ' ');
            }
        }

        $cmd->addOptionIfNotEmpty('--excludeCollection', $this->excludeCollections);
        $cmd->addOptionIfNotEmpty('--excludeCollectionWithPrefix', $this->excludeCollectionsWithPrefix);

        return $process;
    }
}


1		<?php
2		namespace phpbu\App\Cli\Executable;
3
4		use phpbu\App\Cli\Cmd;
5		use phpbu\App\Cli\Executable;
6		use phpbu\App\Cli\Process;
7		use phpbu\App\Exception;
8
9		/**
10		* Mongodump executable class.
11		*
12		* @package phpbu
13		* @subpackage Backup
14		* @author Sebastian Feldmann <[email protected]>
15		* @copyright Sebastian Feldmann <[email protected]>
16		* @license https://opensource.org/licenses/MIT The MIT License (MIT)
17		* @link http://phpbu.de/
18		* @since Class available since Release 2.1.0
19		*/
20		class Mongodump extends Abstraction implements Executable
21		{
22		/**
23		* Dump Directory
24		*
25		* @var string
26		*/
27		private $dumpDir;
28
29		/**
30		* Use IPv6
31		* --ipv6
32		*
33		* @var boolean
34		*/
35		private $useIPv6;
36
37		/**
38		* Host to connect to
39		* --host <hostname:port>
40		*
41		* @var string
42		*/
43		private $host;
44
45		/**
46		* User to connect with
47		* --user <username>
48		*
49		* @var string
50		*/
51		private $user;
52
53		/**
54		* Password to authenticate with
55		* --password <password>
56		*
57		* @var string
58		*/
59		private $password;
60
61		/**
62		* Database to use for authentication
63		* --authenticationDatabase <dbname>
64		*
65		* @var string
66		*/
67		private $authenticationDatabase;
68
69		/**
70		* List of databases to backup
71		* --db <database>
72		*
73		* @var array
74		*/
75		private $databases;
76
77		/**
78		* List of collections to backup
79		* --collection <collection>
80		*
81		* @var array
82		*/
83		private $collections;
84
85		/**
86		* List of collections to ignore
87		* --excludeCollections array of strings
88		*
89		* @var array
90		*/
91		private $excludeCollections;
92
93		/**
94		* List of prefixes to exclude collections
95		* --excludeCollectionWithPrefix array of strings
96		*
97		* @var array
98		*/
99		private $excludeCollectionsWithPrefix;
100
101		/**
102		* Constructor.
103		*
104		* @param string $path
105		*/
106	12	public function __construct($path = null)
107		{
108	12	$this->cmd = 'mongodump';
109	12	parent::__construct($path);
110	12	}
111
112		/**
113		* Set path to dump to.
114		*
115		* @param string $path
116		* @return \phpbu\App\Cli\Executable\Mongodump
117		*/
118	11	public function dumpToDirectory($path)
119		{
120	11	$this->dumpDir = $path;
121	11	return $this;
122		}
123
124		/**
125		* Use ipv6 to connect.
126		*
127		* @param boolean $bool
128		* @return \phpbu\App\Cli\Executable\Mongodump
129		*/
130	2	public function useIpv6($bool)
131		{
132	2	$this->useIPv6 = $bool;
133	2	return $this;
134		}
135
136		/**
137		* Set host to dump from.
138		*
139		* @param string $host
140		* @return \phpbu\App\Cli\Executable\Mongodump
141		*/
142	2	public function useHost($host)
143		{
144	2	$this->host = $host;
145	2	return $this;
146		}
147
148		/**
149		* Set credentials.
150		*
151		* @param string $user
152		* @param string $password
153		* @param string $authDatabase
154		* @return \phpbu\App\Cli\Executable\Mongodump
155		*/
156	3	public function credentials($user = null, $password = null, $authDatabase = null)
157		{
158	3	$this->user = $user;
159	3	$this->password = $password;
160	3	$this->authenticationDatabase = $authDatabase;
161	3	return $this;
162		}
163
164		/**
165		* Dump only given databases.
166		*
167		* @param array $databases
168		* @return \phpbu\App\Cli\Executable\Mongodump
169		*/
170	2	public function dumpDatabases(array $databases)
171		{
172	2	$this->databases = $databases;
173	2	return $this;
174		}
175
176		/**
177		* Dump only given collections.
178		*
179		* @param array $collections
180		* @return \phpbu\App\Cli\Executable\Mongodump
181		*/
182	2	public function dumpCollections(array $collections)
183		{
184	2	$this->collections = $collections;
185	2	return $this;
186		}
187
188		/**
189		* Exclude collections.
190		*
191		* @param array $collections
192		* @return \phpbu\App\Cli\Executable\Mongodump
193		*/
194	2	public function excludeCollections(array $collections)
195		{
196	2	$this->excludeCollections = $collections;
197	2	return $this;
198		}
199
200		/**
201		* Exclude collections with given prefixes.
202		*
203		* @param array $prefixes
204		* @return \phpbu\App\Cli\Executable\Mongodump
205		*/
206	2	public function excludeCollectionsWithPrefix(array $prefixes)
207		{
208	2	$this->excludeCollectionsWithPrefix = $prefixes;
209	2	return $this;
210		}
211
212		/**
213		* Subclass Process generator.
214		*
215		* @return \phpbu\App\Cli\Process
216		* @throws \phpbu\App\Exception
217		*/
218	12	protected function createProcess()
219		{
220	12	if (empty($this->dumpDir)) {
221	1	throw new Exception('no directory to dump to');
222		}
223	11	$process = new Process();
224	11	$cmd = new Cmd($this->binary);
225	11	$process->addCommand($cmd);
226
227		$cmd->addOption('--out', $this->dumpDir, ' ');
228	11	$cmd->addOptionIfNotEmpty('--ipv6', $this->useIPv6, false);
229	10	$cmd->addOptionIfNotEmpty('--host', $this->host, true, ' ');
230		$cmd->addOptionIfNotEmpty('--user', $this->user, true, ' ');
231	10	$cmd->addOptionIfNotEmpty('--password', $this->password, true, ' ');
232		$cmd->addOptionIfNotEmpty('--authenticationDatabase', $this->authenticationDatabase, true, ' ');
233	11
234	11	if (count($this->databases)) {
235	11	foreach ($this->databases as $db) {
236	11	$cmd->addOption('--database', $db, ' ');
237	11	}
238	11	}
239
240	11	if (count($this->collections)) {
241	1	foreach ($this->collections as $col) {
242	1	$cmd->addOption('--collection', $col, ' ');
243	1	}
244	1	}
245
246	11	$cmd->addOptionIfNotEmpty('--excludeCollection', $this->excludeCollections);
247	1	$cmd->addOptionIfNotEmpty('--excludeCollectionWithPrefix', $this->excludeCollectionsWithPrefix);
248	1
249	1	return $process;
250	1	}
251		}
252

sebastianfeldmann / phpbu

Push — master ( e2a90b...0f1023 )

Mongodump::excludeCollections() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like