phpbu\App\Cli\Executable\OptionMasker

Complexity

Total Complexity

10

Size/Duplication

Total Lines	83
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	setMaskCandidates()	0	4	1
A	getCommandLinePrintable()	0	14	2
A	mask()	0	9	2
A	restore()	0	6	2
A	getPropertiesToMask()	0	10	3

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

use phpbu\App\Cli\Process;
use phpbu\App\Util\Cli;

/**
 * Binary using credentials not safe for printing.
 *
 * @package    phpbu
 * @subpackage Backup
 * @author     Sebastian Feldmann <sebastian@phpbu.de>
 * @copyright  Sebastian Feldmann <sebastian@phpbu.de>
 * @license    https://opensource.org/licenses/MIT The MIT License (MIT)
 * @link       http://phpbu.de/
 * @since      Class available since Release 3.0.5
 */
trait OptionMasker
{
    /**
     * List of properties to mask for print safe output
     *
     * @var array
     */
    protected $maskCandidates = [];

    /**
     * Set potentially insecure properties.
     *
     * @param array $candidates
     */
    protected function setMaskCandidates(array $candidates)
    {
        $this->maskCandidates = $candidates;
    }

    /**
     * Return the command with masked passwords or keys.
     *
     * @return string
     */
    public function getCommandLinePrintable()
    {
        $propertiesToMask = $this->getPropertiesToMask();
        // no candidates need masking
        if (0 === count($propertiesToMask)) {
            return $this->getCommandLine();

The method getCommandLine() does not exist on phpbu\App\Cli\Executable\OptionMasker. Did you maybe mean getCommandLinePrintable()?

        }

        $masked = $this->mask($propertiesToMask);
        $cmd    = $this->getCommandLine();

The method getCommandLine() does not exist on phpbu\App\Cli\Executable\OptionMasker. Did you maybe mean getCommandLinePrintable()?

        $this->restore($masked);

        return $cmd;
    }

    /**
     * Mask given properties and return map with original values.
     *
     * @param  array $properties
     * @return array
     */
    private function mask(array $properties)
    {
        $masked = [];
        foreach ($properties as $p) {
            $masked[$p] = $this->$p;
            $this->$p   = '******';
        }
        return $masked;
    }

    /**
     * Restore masked properties.
     *
     * @param array $masked
     */
    private function restore(array $masked)
    {
        foreach ($masked as $p => $value) {
            $this->$p = $value;
        }
    }

    /**
     * Return list of properties that actually needs masking.
     *
     * @return array
     */
    private function getPropertiesToMask()
    {
        $properties = [];
        foreach ($this->maskCandidates as $p) {
            if ($this->$p !== null) {
                $properties[] = $p;
            }
        }
        return $properties;
    }
}