Config::getConnectionString() - Code Metrics - Inspection of "Merge pull request #10 from mrcnpdlk/devel" - mrcnpdlk/unoconv-api - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( c69355...293396 )

by Marcin

created 2019-03-11 17:25 UTC

Config::getConnectionString() A

↳ Parent: Config

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

/**
 * Created by Marcin.
 * Date: 03.03.2019
 * Time: 14:22
 */

namespace Mrcnpdlk\Api\Unoconv;

use Mrcnpdlk\Api\Unoconv\Enum\DocType;
use Mrcnpdlk\Api\Unoconv\Enum\FormatType;
use Mrcnpdlk\Api\Unoconv\Exception\ConfigurationException;
use /* @noinspection PhpUndefinedClassInspection */
    Psr\Log\LoggerInterface;
use /* @noinspection PhpUndefinedClassInspection */
    Psr\Log\NullLogger;

/**
 * Class Config
 */
class Config
{
    /**
     * @var string
     */
    protected $binary = '/usr/bin/unoconv';
    /**
     * @var string
     */
    protected $host = 'localhost';
    /**
     * Port to listen on (as listener) or to connect to (as client).
     *
     * @var int
     */
    protected $port = 2002;
    /**
     * Specify the LibreOffice document type of the backend format. Possible document types are: document, graphics, presentation,
     * spreadsheet.
     *
     * @var DocType
     */
    protected $docType;
    /**
     * Specify the output format for the document. You can get a list of possible output formats per document type by using the --show
     * option.
     *
     * @var FormatType
     */
    protected $format;
    /**
     * When unoconv starts its own listener, try to connect to it for an amount of seconds before giving up. Increasing this may help when
     * you receive random errors caused by the listener not being ready to accept conversion jobs.
     *
     * @var int
     */
    protected $timeout = 30;
    /**
     * @var string
     */
    protected $options = 'urp;StarOffice.ComponentContext';
    /** @noinspection PhpUndefinedClassInspection */
    /**
     * @var \Psr\Log\LoggerInterface
     */
    protected $logger;

    /**
     * Config constructor.
     * Default values;
     *
     * @param array $config
     *
     * @throws \Mrcnpdlk\Api\Unoconv\Exception\ConfigurationException
     */
    public function __construct(array $config = [])
    {
        $this->docType = DocType::DOCUMENT();
        $this->format  = FormatType::PDF();
        /* @noinspection PhpUndefinedClassInspection */
        $this->logger = new NullLogger();

        foreach ($config as $key => $value) {
            $funName = sprintf('set%s', ucfirst($key));
            if (method_exists($this, $funName)) {
                $this->$funName($value);
            } elseif (property_exists($this, $key)) {
                $this->{$key} = $value;
            } else {
                throw new ConfigurationException(sprintf('Property "%s" not defined in Config class "%s"', $key, __CLASS__));
            }
        }
    }

    /**
     * @return string
     */
    public function getConnectionString(): string
    {
        return sprintf('%s --connection="socket,host=%s,port=%s;%s"', $this->binary, $this->host, $this->port, $this->options);
    }

    /**
     * @return DocType
     */
    public function getDocType(): DocType
    {
        return $this->docType;
    }

    /**
     * @return FormatType
     */
    public function getFormat(): FormatType
    {
        return $this->format;
    }

    /** @noinspection PhpUndefinedClassInspection */

    /**
     * @return \Psr\Log\LoggerInterface
     */
    public function getLogger(): LoggerInterface
    {
        return $this->logger;
    }

    /**
     * @return int
     */
    public function getTimeout(): int
    {
        return $this->timeout;
    }

    /**
     * @param string $binary
     *
     * @return $this
     */
    public function setBinary(string $binary): self
    {
        $this->binary = $binary;

        return $this;
    }

    /**
     * @param DocType $docType
     *
     * @return $this
     */
    public function setDocType(DocType $docType): self
    {
        $this->docType = $docType;

        return $this;
    }

    /**
     * @param FormatType $format
     *
     * @return $this
     */
    public function setFormat(FormatType $format): self
    {
        $this->format = $format;

        return $this;
    }

    /**
     * @param string $host
     *
     * @return $this
     */
    public function setHost(string $host): self
    {
        $this->host = $host;

        return $this;
    }

    /** @noinspection PhpUndefinedClassInspection */

    /**
     * @param \Psr\Log\LoggerInterface $logger
     *
     * @return $this
     */
    public function setLogger(LoggerInterface $logger): self
    {
        $this->logger = $logger;

        return $this;
    }

    /**
     * @param int $port
     *
     * @return $this
     */
    public function setPort(int $port): self
    {
        $this->port = $port;

        return $this;
    }

    /**
     * @param int $timeout
     *
     * @return $this
     */
    public function setTimeout(int $timeout): self
    {
        $this->timeout = $timeout;

        return $this;
    }
}


1		<?php
2
3		/**
4		* Created by Marcin.
5		* Date: 03.03.2019
6		* Time: 14:22
7		*/
8
9		namespace Mrcnpdlk\Api\Unoconv;
10
11		use Mrcnpdlk\Api\Unoconv\Enum\DocType;
12		use Mrcnpdlk\Api\Unoconv\Enum\FormatType;
13		use Mrcnpdlk\Api\Unoconv\Exception\ConfigurationException;
14		use /* @noinspection PhpUndefinedClassInspection */
15		Psr\Log\LoggerInterface;
16		use /* @noinspection PhpUndefinedClassInspection */
17		Psr\Log\NullLogger;
18
19		/**
20		* Class Config
21		*/
22		class Config
23		{
24		/**
25		* @var string
26		*/
27		protected $binary = '/usr/bin/unoconv';
28		/**
29		* @var string
30		*/
31		protected $host = 'localhost';
32		/**
33		* Port to listen on (as listener) or to connect to (as client).
34		*
35		* @var int
36		*/
37		protected $port = 2002;
38		/**
39		* Specify the LibreOffice document type of the backend format. Possible document types are: document, graphics, presentation,
40		* spreadsheet.
41		*
42		* @var DocType
43		*/
44		protected $docType;
45		/**
46		* Specify the output format for the document. You can get a list of possible output formats per document type by using the --show
47		* option.
48		*
49		* @var FormatType
50		*/
51		protected $format;
52		/**
53		* When unoconv starts its own listener, try to connect to it for an amount of seconds before giving up. Increasing this may help when
54		* you receive random errors caused by the listener not being ready to accept conversion jobs.
55		*
56		* @var int
57		*/
58		protected $timeout = 30;
59		/**
60		* @var string
61		*/
62		protected $options = 'urp;StarOffice.ComponentContext';
63		/** @noinspection PhpUndefinedClassInspection */
64		/**
65		* @var \Psr\Log\LoggerInterface
66		*/
67		protected $logger;
68
69		/**
70		* Config constructor.
71		* Default values;
72		*
73		* @param array $config
74		*
75		* @throws \Mrcnpdlk\Api\Unoconv\Exception\ConfigurationException
76		*/
77	9	public function __construct(array $config = [])
78		{
79	9	$this->docType = DocType::DOCUMENT();
80	9	$this->format = FormatType::PDF();
81		/* @noinspection PhpUndefinedClassInspection */
82	9	$this->logger = new NullLogger();
83
84	9	foreach ($config as $key => $value) {
85	5	$funName = sprintf('set%s', ucfirst($key));
86	5	if (method_exists($this, $funName)) {
87	4	$this->$funName($value);
88	1	} elseif (property_exists($this, $key)) {
89		$this->{$key} = $value;
90		} else {
91	5	throw new ConfigurationException(sprintf('Property "%s" not defined in Config class "%s"', $key, __CLASS__));
92		}
93		}
94	8	}
95
96		/**
97		* @return string
98		*/
99	5	public function getConnectionString(): string
100		{
101	5	return sprintf('%s --connection="socket,host=%s,port=%s;%s"', $this->binary, $this->host, $this->port, $this->options);
102		}
103
104		/**
105		* @return DocType
106		*/
107	6	public function getDocType(): DocType
108		{
109	6	return $this->docType;
110		}
111
112		/**
113		* @return FormatType
114		*/
115	6	public function getFormat(): FormatType
116		{
117	6	return $this->format;
118		}
119
120		/** @noinspection PhpUndefinedClassInspection */
121
122		/**
123		* @return \Psr\Log\LoggerInterface
124		*/
125	5	public function getLogger(): LoggerInterface
126		{
127	5	return $this->logger;
128		}
129
130		/**
131		* @return int
132		*/
133	6	public function getTimeout(): int
134		{
135	6	return $this->timeout;
136		}
137
138		/**
139		* @param string $binary
140		*
141		* @return $this
142		*/
143	4	public function setBinary(string $binary): self
144		{
145	4	$this->binary = $binary;
146
147	4	return $this;
148		}
149
150		/**
151		* @param DocType $docType
152		*
153		* @return $this
154		*/
155	1	public function setDocType(DocType $docType): self
156		{
157	1	$this->docType = $docType;
158
159	1	return $this;
160		}
161
162		/**
163		* @param FormatType $format
164		*
165		* @return $this
166		*/
167	1	public function setFormat(FormatType $format): self
168		{
169	1	$this->format = $format;
170
171	1	return $this;
172		}
173
174		/**
175		* @param string $host
176		*
177		* @return $this
178		*/
179	1	public function setHost(string $host): self
180		{
181	1	$this->host = $host;
182
183	1	return $this;
184		}
185
186		/** @noinspection PhpUndefinedClassInspection */
187
188		/**
189		* @param \Psr\Log\LoggerInterface $logger
190		*
191		* @return $this
192		*/
193	1	public function setLogger(LoggerInterface $logger): self
194		{
195	1	$this->logger = $logger;
196
197	1	return $this;
198		}
199
200		/**
201		* @param int $port
202		*
203		* @return $this
204		*/
205	1	public function setPort(int $port): self
206		{
207	1	$this->port = $port;
208
209	1	return $this;
210		}
211
212		/**
213		* @param int $timeout
214		*
215		* @return $this
216		*/
217	1	public function setTimeout(int $timeout): self
218		{
219	1	$this->timeout = $timeout;
220
221	1	return $this;
222		}
223		}
224

mrcnpdlk / unoconv-api

Push — master ( c69355...293396 )

Config::getConnectionString() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like