PDOSQLExecFormatterElement::setUseFile() - Code Metrics - Inspection of "Remove old directory from scrutinizer config" - phingofficial/phing - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( ddd1a4...b98cb8 )

by Michiel

created 2021-01-31 19:13 UTC

PDOSQLExecFormatterElement::setUseFile() A

↳ Parent: PDOSQLExecFormatterElement

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php
/**
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information please see
 * <http://phing.info>.
 */

namespace Phing\Task\System\Pdo;

use Phing\Exception\BuildException;
use Phing\Io\FileWriter;
use Phing\Io\LogWriter;
use Phing\Io\File;
use Phing\Io\Writer;
use Phing\Parser\Location;
use Phing\Phing;
use Phing\Project;
use Phing\Type\Parameter;

/**
 * A class to represent the nested <formatter> element for PDO SQL results.
 *
 * This class is inspired by the similarly-named class in the PHPUnit tasks.
 *
 * @author  Hans Lellelid <[email protected]>
 * @package phing.tasks.ext.pdo
 * @since   2.3.0
 */
class PDOSQLExecFormatterElement
{
    /**
     * @var PDOResultFormatter
     */
    private $formatter;

    /**
     * The type of the formatter (used for built-in formatter classes).
     *
     * @var string
     */
    private $type = "";

    /**
     * Whether to use file (or write output to phing log).
     *
     * @var boolean
     */
    private $useFile = true;

    /**
     * Output file for formatter.
     *
     * @var File
     */
    private $outfile;

    /**
     * Print header columns.
     *
     * @var boolean
     */
    private $showheaders = true;

    /**
     * Whether to format XML output.
     *
     * @var boolean
     */
    private $formatoutput = true;

    /**
     * Encoding for XML output.
     *
     * @var string
     */
    private $encoding;

    /**
     * Column delimiter.
     * Defaults to ','
     *
     * @var string
     */
    private $coldelimiter = ",";

    /**
     * Row delimiter.
     * Defaults to PHP_EOL.
     *
     * @var string
     */
    private $rowdelimiter = PHP_EOL;

    /**
     * Append to an existing file or overwrite it?
     *
     * @var boolean
     */
    private $append = false;

    /**
     * Parameters for a custom formatter.
     *
     * @var array Parameter[]
     */
    private $formatterParams = [];

    /**
     * @var PDOSQLExecTask
     */
    private $parentTask;

    /**
     * @var Parameter[]
     */
    private $parameters;

    /**
     * @var bool
     */
    private $formatOutput;

    /**
     * Construct a new PDOSQLExecFormatterElement with parent task.
     *
     * @param PDOSQLExecTask $parentTask
     */
    public function __construct(PDOSQLExecTask $parentTask)
    {
        $this->parentTask = $parentTask;
    }

    /**
     * Supports nested <param> element (for custom formatter classes).
     *
     * @return Parameter
     */
    public function createParam()
    {
        $num = array_push($this->parameters, new Parameter());

        return $this->parameters[$num - 1];
    }

    /**
     * Gets a configured output writer.
     *
     * @return Writer
     */
    private function getOutputWriter()
    {
        if ($this->useFile) {
            $of = $this->getOutfile();
            if (!$of) {

                $of = new File($this->formatter->getPreferredOutfile());
            }

            return new FileWriter($of, $this->append);
        }

        return $this->getDefaultOutput();
    }

    /**
     * Configures wrapped formatter class with any attributes on this element.
     *
     * @throws BuildException
     */
    public function prepare(Location $location)
    {
        if (!$this->formatter) {
            throw new BuildException("No formatter specified (use type or classname attribute)", $location);
        }

        $out = $this->getOutputWriter();

        $this->parentTask->log("Setting output writer to: " . get_class($out), Project::MSG_VERBOSE);
        $this->formatter->setOutput($out);

        if ($this->formatter instanceof PlainPDOResultFormatter) {
            // set any options that apply to the plain formatter
            $this->formatter->setShowheaders($this->showheaders);
            $this->formatter->setRowdelim($this->rowdelimiter);
            $this->formatter->setColdelim($this->coldelimiter);
        } elseif ($this->formatter instanceof XMLPDOResultFormatter) {
            // set any options that apply to the xml formatter
            $this->formatter->setEncoding($this->encoding);
            $this->formatter->setFormatOutput($this->formatoutput);
        }

        foreach ($this->formatterParams as $param) {
            $param = new Parameter();
            $method = 'set' . $param->getName();
            if (!method_exists($this->formatter, $param->getName())) {
                throw new BuildException(
                    "Formatter " . get_class(
                        $this->formatter
                    ) . " does not have a $method method.",
                    $location
                );
            }
            call_user_func([$this->formatter, $method], $param->getValue());
        }
    }

    /**
     * Sets the formatter type.
     *
     * @param  string $type
     * @throws BuildException
     */
    public function setType($type)
    {
        $this->type = $type;
        if ($this->type === "xml") {
            $this->formatter = new XMLPDOResultFormatter();
        } elseif ($this->type === "plain") {
            $this->formatter = new PlainPDOResultFormatter();
        } else {
            throw new BuildException("Formatter '" . $this->type . "' not implemented");
        }
    }

    /**
     * Set classname for a custom formatter (must extend PDOResultFormatter).
     *
     * @param string $className
     */
    public function setClassName($className)
    {
        $classNameNoDot = Phing::import($className);
        $this->formatter = new $classNameNoDot();
    }

    /**
     * Set whether to write formatter results to file.
     *
     * @param boolean $useFile
     */
    public function setUseFile($useFile)
    {
        $this->useFile = (bool) $useFile;
    }

    /**
     * Return whether to write formatter results to file.
     *
     * @return boolean
     */
    public function getUseFile()
    {
        return $this->useFile;
    }

    /**
     * Sets the output file for the formatter results.
     *
     * @param    File $outfile
     * @internal param PhingFile $outFile
     */
    public function setOutfile(File $outfile)
    {
        $this->outfile = $outfile;
    }

    /**
     * Get the output file.
     *
     * @return File
     */
    public function getOutfile()
    {
        return $this->outfile;
    }

    /**
     * whether output should be appended to or overwrite
     * an existing file.  Defaults to false.
     *
     * @param boolean $append
     */
    public function setAppend($append)
    {
        $this->append = (bool) $append;
    }

    /**
     * Whether output should be appended to file.
     *
     * @return boolean
     */
    public function getAppend()
    {
        return $this->append;
    }

    /**
     * Print headers for result sets from the
     * statements; optional, default true.
     *
     * @param boolean $showheaders
     */
    public function setShowheaders($showheaders)
    {
        $this->showheaders = (bool) $showheaders;
    }

    /**
     * Sets the column delimiter.
     *
     * @param string $v
     */
    public function setColdelim($v)
    {
        $this->coldelimiter = $v;
    }

    /**
     * Sets the row delimiter.
     *
     * @param string $v
     */
    public function setRowdelim($v)
    {
        $this->rowdelimiter = $v;
    }

    /**
     * Set the DOM document encoding.
     *
     * @param string $v
     */
    public function setEncoding($v)
    {
        $this->encoding = $v;
    }

    /**
     * @param boolean $v
     */
    public function setFormatOutput($v)
    {
        $this->formatOutput = (bool) $v;
    }

    /**
     * Gets a default output writer for this task.
     *
     * @return Writer
     */
    private function getDefaultOutput()
    {
        return new LogWriter($this->parentTask);
    }

    /**
     * Gets the formatter that has been configured based on this element.
     *
     * @return PDOResultFormatter
     */
    public function getFormatter()
    {
        return $this->formatter;
    }
}


1			<?php
2			/**
3			* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4			* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5			* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6			* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7			* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8			* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9			* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10			* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11			* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12			* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13			* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14			*
15			* This software consists of voluntary contributions made by many individuals
16			* and is licensed under the LGPL. For more information please see
17			* <http://phing.info>.
18			*/
19
20			namespace Phing\Task\System\Pdo;
21
22			use Phing\Exception\BuildException;
23			use Phing\Io\FileWriter;
24			use Phing\Io\LogWriter;
25			use Phing\Io\File;
26			use Phing\Io\Writer;
27			use Phing\Parser\Location;
28			use Phing\Phing;
29			use Phing\Project;
30			use Phing\Type\Parameter;
31
32			/**
33			* A class to represent the nested <formatter> element for PDO SQL results.
34			*
35			* This class is inspired by the similarly-named class in the PHPUnit tasks.
36			*
37			* @author Hans Lellelid <[email protected]>
38			* @package phing.tasks.ext.pdo
39			* @since 2.3.0
40			*/
41			class PDOSQLExecFormatterElement
42			{
43			/**
44			* @var PDOResultFormatter
45			*/
46			private $formatter;
47
48			/**
49			* The type of the formatter (used for built-in formatter classes).
50			*
51			* @var string
52			*/
53			private $type = "";
54
55			/**
56			* Whether to use file (or write output to phing log).
57			*
58			* @var boolean
59			*/
60			private $useFile = true;
61
62			/**
63			* Output file for formatter.
64			*
65			* @var File
66			*/
67			private $outfile;
68
69			/**
70			* Print header columns.
71			*
72			* @var boolean
73			*/
74			private $showheaders = true;
75
76			/**
77			* Whether to format XML output.
78			*
79			* @var boolean
80			*/
81			private $formatoutput = true;
82
83			/**
84			* Encoding for XML output.
85			*
86			* @var string
87			*/
88			private $encoding;
89
90			/**
91			* Column delimiter.
92			* Defaults to ','
93			*
94			* @var string
95			*/
96			private $coldelimiter = ",";
97
98			/**
99			* Row delimiter.
100			* Defaults to PHP_EOL.
101			*
102			* @var string
103			*/
104			private $rowdelimiter = PHP_EOL;
105
106			/**
107			* Append to an existing file or overwrite it?
108			*
109			* @var boolean
110			*/
111			private $append = false;
112
113			/**
114			* Parameters for a custom formatter.
115			*
116			* @var array Parameter[]
117			*/
118			private $formatterParams = [];
119
120			/**
121			* @var PDOSQLExecTask
122			*/
123			private $parentTask;
124
125			/**
126			* @var Parameter[]
127			*/
128			private $parameters;
129
130			/**
131			* @var bool
132			*/
133			private $formatOutput;
134
135			/**
136			* Construct a new PDOSQLExecFormatterElement with parent task.
137			*
138			* @param PDOSQLExecTask $parentTask
139			*/
140			public function __construct(PDOSQLExecTask $parentTask)
141			{
142			$this->parentTask = $parentTask;
143			}
144
145			/**
146			* Supports nested <param> element (for custom formatter classes).
147			*
148			* @return Parameter
149			*/
150			public function createParam()
151			{
152			$num = array_push($this->parameters, new Parameter());
153
154			return $this->parameters[$num - 1];
155			}
156
157			/**
158			* Gets a configured output writer.
159			*
160			* @return Writer
161			*/
162			private function getOutputWriter()
163			{
164			if ($this->useFile) {
165			$of = $this->getOutfile();
166			if (!$of) {
			0 ignored issues – show introduced 2021-01-31 19:22 UTC by Report Bug Copy Issue Report `$of` is of type `Phing\Io\File`, thus it always evaluated to `true`. Loading history...
167			$of = new File($this->formatter->getPreferredOutfile());
168			}
169
170			return new FileWriter($of, $this->append);
171			}
172
173			return $this->getDefaultOutput();
174			}
175
176			/**
177			* Configures wrapped formatter class with any attributes on this element.
178			*
179			* @throws BuildException
180			*/
181			public function prepare(Location $location)
182			{
183			if (!$this->formatter) {
184			throw new BuildException("No formatter specified (use type or classname attribute)", $location);
185			}
186
187			$out = $this->getOutputWriter();
188
189			$this->parentTask->log("Setting output writer to: " . get_class($out), Project::MSG_VERBOSE);
190			$this->formatter->setOutput($out);
191
192			if ($this->formatter instanceof PlainPDOResultFormatter) {
193			// set any options that apply to the plain formatter
194			$this->formatter->setShowheaders($this->showheaders);
195			$this->formatter->setRowdelim($this->rowdelimiter);
196			$this->formatter->setColdelim($this->coldelimiter);
197			} elseif ($this->formatter instanceof XMLPDOResultFormatter) {
198			// set any options that apply to the xml formatter
199			$this->formatter->setEncoding($this->encoding);
200			$this->formatter->setFormatOutput($this->formatoutput);
201			}
202
203			foreach ($this->formatterParams as $param) {
204			$param = new Parameter();
205			$method = 'set' . $param->getName();
206			if (!method_exists($this->formatter, $param->getName())) {
207			throw new BuildException(
208			"Formatter " . get_class(
209			$this->formatter
210			) . " does not have a $method method.",
211			$location
212			);
213			}
214			call_user_func([$this->formatter, $method], $param->getValue());
215			}
216			}
217
218			/**
219			* Sets the formatter type.
220			*
221			* @param string $type
222			* @throws BuildException
223			*/
224			public function setType($type)
225			{
226			$this->type = $type;
227			if ($this->type === "xml") {
228			$this->formatter = new XMLPDOResultFormatter();
229			} elseif ($this->type === "plain") {
230			$this->formatter = new PlainPDOResultFormatter();
231			} else {
232			throw new BuildException("Formatter '" . $this->type . "' not implemented");
233			}
234			}
235
236			/**
237			* Set classname for a custom formatter (must extend PDOResultFormatter).
238			*
239			* @param string $className
240			*/
241			public function setClassName($className)
242			{
243			$classNameNoDot = Phing::import($className);
244			$this->formatter = new $classNameNoDot();
245			}
246
247			/**
248			* Set whether to write formatter results to file.
249			*
250			* @param boolean $useFile
251			*/
252			public function setUseFile($useFile)
253			{
254			$this->useFile = (bool) $useFile;
255			}
256
257			/**
258			* Return whether to write formatter results to file.
259			*
260			* @return boolean
261			*/
262			public function getUseFile()
263			{
264			return $this->useFile;
265			}
266
267			/**
268			* Sets the output file for the formatter results.
269			*
270			* @param File $outfile
271			* @internal param PhingFile $outFile
272			*/
273			public function setOutfile(File $outfile)
274			{
275			$this->outfile = $outfile;
276			}
277
278			/**
279			* Get the output file.
280			*
281			* @return File
282			*/
283			public function getOutfile()
284			{
285			return $this->outfile;
286			}
287
288			/**
289			* whether output should be appended to or overwrite
290			* an existing file. Defaults to false.
291			*
292			* @param boolean $append
293			*/
294			public function setAppend($append)
295			{
296			$this->append = (bool) $append;
297			}
298
299			/**
300			* Whether output should be appended to file.
301			*
302			* @return boolean
303			*/
304			public function getAppend()
305			{
306			return $this->append;
307			}
308
309			/**
310			* Print headers for result sets from the
311			* statements; optional, default true.
312			*
313			* @param boolean $showheaders
314			*/
315			public function setShowheaders($showheaders)
316			{
317			$this->showheaders = (bool) $showheaders;
318			}
319
320			/**
321			* Sets the column delimiter.
322			*
323			* @param string $v
324			*/
325			public function setColdelim($v)
326			{
327			$this->coldelimiter = $v;
328			}
329
330			/**
331			* Sets the row delimiter.
332			*
333			* @param string $v
334			*/
335			public function setRowdelim($v)
336			{
337			$this->rowdelimiter = $v;
338			}
339
340			/**
341			* Set the DOM document encoding.
342			*
343			* @param string $v
344			*/
345			public function setEncoding($v)
346			{
347			$this->encoding = $v;
348			}
349
350			/**
351			* @param boolean $v
352			*/
353			public function setFormatOutput($v)
354			{
355			$this->formatOutput = (bool) $v;
356			}
357
358			/**
359			* Gets a default output writer for this task.
360			*
361			* @return Writer
362			*/
363			private function getDefaultOutput()
364			{
365			return new LogWriter($this->parentTask);
366			}
367
368			/**
369			* Gets the formatter that has been configured based on this element.
370			*
371			* @return PDOResultFormatter
372			*/
373			public function getFormatter()
374			{
375			return $this->formatter;
376			}
377			}
378

phingofficial / phing

Push — main ( ddd1a4...b98cb8 )

PDOSQLExecFormatterElement::setUseFile() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like