PhpCSTask::main() - Code Metrics - phingofficial/phing - Measure and Improve Code Quality continuously with Scrutinizer

PhpCSTask::main() F
last analyzed 2025-06-01 11:47 UTC

↳ Parent: PhpCSTask

Complexity

Conditions	15
Paths	385

Size

Total Lines	63
Code Lines	42

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	42
dl	0
loc	63
rs	2.7708
c	0
b	0
f	0
cc	15
nc	385
nop	0

How to fix Long Method Complexity

<?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\Ext;

use Phing\Exception\BuildException;
use Phing\Io\File;
use Phing\Project;
use Phing\Task;
use Phing\Task\System\Element\LogLevelAware;
use Phing\Task\System\ExecTask;
use Phing\Type\Commandline;
use Phing\Type\Element\FileSetAware;

/**
 * A PHP code sniffer task. Checking the style of one or more PHP source files.
 *
 * @author Siad Ardroumli <[email protected]>
 */
class PhpCSTask extends Task
{
    use LogLevelAware;
    use FileSetAware;

    /**
     * The.
     *
     * @var array
     */
    protected $files = [];

    protected $formatters = [];

    /**
     * A php source code filename or directory.
     *
     * @var File
     */
    private $file;

    /** @var Commandline */
    private $cmd;

    /** @var bool */
    private $cache = false;

    /** @var bool */
    private $ignoreAnnotations = false;

    /** @var bool */
    private $checkreturn = false;

    /** @var string */
    private $standard = '';

    /** @var string */
    private $outfile = '';

    /** @var string */
    private $format = '';

    /** @var string */
    private $bin = 'phpcs';

    public function __construct()
    {
        $this->cmd = new Commandline();
        $this->logLevelName = 'info';
        parent::__construct();
    }

    public function getCommandline(): Commandline
    {
        return $this->cmd;
    }

    public function setCache(bool $cache): void
    {
        $this->cache = $cache;
    }

    public function setIgnoreAnnotations(bool $ignore): void
    {
        $this->ignoreAnnotations = $ignore;
    }

    public function setCheckreturn(bool $checkreturn): void
    {
        $this->checkreturn = $checkreturn;
    }

    public function setBin(string $bin): void
    {
        $this->bin = $bin;
    }

    public function setFormat(string $format): void
    {
        $this->format = $format;
        $this->project->log("Format set to {$format}", Project::MSG_VERBOSE);
    }

    /**
     * Create object for nested formatter element.
     *
     * @return CodeSnifferFormatterElement
filter:
    dependency_paths: ["lib/*"]
     */
    public function createFormatter()
    {
        $num = array_push(
            $this->formatters,
            new PhpCSTaskFormatterElement()
        );

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

    public function setStandard(string $standard): void
    {
        $this->standard = $standard;
        $this->project->log("Standard set to {$standard}", Project::MSG_VERBOSE);
    }

    public function setFile(File $file): void
    {
        $this->file = $file;
    }

    public function setOutfile(string $outfile): void
    {
        $this->outfile = $outfile;
        $this->project->log("Outfile set to {$outfile}", Project::MSG_VERBOSE);
    }

    public function main()
    {
        if (null === $this->file && 0 == count($this->filesets)) {
            throw new BuildException('Missing both attribute "file" and "fileset".');
        }
        if (null === $this->file) {
            // check filesets, and compile a list of files for phpcs to analyse
            foreach ($this->filesets as $fileset) {
                $files = $fileset->getIterator();
                foreach ($files as $file) {
                    $this->files[] = $file;
                }
            }
        }

        $toExecute = $this->getCommandline();

        $this->cache
            ? $toExecute->createArgument()->setValue('--cache')
            : $toExecute->createArgument()->setValue('--no-cache');

        if ($this->ignoreAnnotations) {
            $toExecute->createArgument()->setValue('--ignore-annotations');
        }
        if ('' !== $this->format) {
            $toExecute->createArgument()->setValue(' --report=' . $this->format);
        }
        if ('' !== $this->standard) {
            $toExecute->createArgument()->setValue(' --standard=' . $this->standard);
        }
        if ('' !== $this->outfile) {
            $toExecute->createArgument()->setValue(' --report-file=' . $this->outfile);
        }

        foreach ($this->formatters as $formatter) {
            $formatterReportFile = ($formatter->getUseFile() ? $formatter->getOutFile() : null);
            $formatterType = $formatter->getType();
            $this->project->log(
                "Generate report of type \"{$formatterType}\" with report written to {$formatterReportFile}",
                Project::MSG_VERBOSE
            );
            $toExecute->createArgument()->setValue(' --report-' . $formatterType . '=' . $formatterReportFile);
        }

        if (null !== $this->file) {
            $toExecute->createArgument()->setFile($this->file);
        } else {
            foreach ($this->files as $file) {
                $toExecute->createArgument()->setFile(new File($file));
            }
        }

        $exe = new ExecTask();
        $exe->setProject($this->getProject());
        $exe->setLocation($this->getLocation());
        $exe->setOwningTarget($this->target);
        $exe->setTaskName($this->getTaskName());
        $exe->setExecutable($this->bin);
        $exe->setCheckreturn($this->checkreturn);
        $exe->setLevel($this->logLevelName);
        $exe->setExecutable($toExecute->getExecutable());
        $exe->createArg()->setLine(implode(' ', $toExecute->getArguments()));
        $exe->main();
    }
}


1			<?php
2
3			/**
4			* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
5			* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
6			* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
7			* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
8			* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
9			* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
10			* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
11			* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
12			* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
13			* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
14			* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
15			*
16			* This software consists of voluntary contributions made by many individuals
17			* and is licensed under the LGPL. For more information please see
18			* <http://phing.info>.
19			*/
20
21			namespace Phing\Task\Ext;
22
23			use Phing\Exception\BuildException;
24			use Phing\Io\File;
25			use Phing\Project;
26			use Phing\Task;
27			use Phing\Task\System\Element\LogLevelAware;
28			use Phing\Task\System\ExecTask;
29			use Phing\Type\Commandline;
30			use Phing\Type\Element\FileSetAware;
31
32			/**
33			* A PHP code sniffer task. Checking the style of one or more PHP source files.
34			*
35			* @author Siad Ardroumli <[email protected]>
36			*/
37			class PhpCSTask extends Task
38			{
39			use LogLevelAware;
40			use FileSetAware;
41
42			/**
43			* The.
44			*
45			* @var array
46			*/
47			protected $files = [];
48
49			protected $formatters = [];
50
51			/**
52			* A php source code filename or directory.
53			*
54			* @var File
55			*/
56			private $file;
57
58			/** @var Commandline */
59			private $cmd;
60
61			/** @var bool */
62			private $cache = false;
63
64			/** @var bool */
65			private $ignoreAnnotations = false;
66
67			/** @var bool */
68			private $checkreturn = false;
69
70			/** @var string */
71			private $standard = '';
72
73			/** @var string */
74			private $outfile = '';
75
76			/** @var string */
77			private $format = '';
78
79			/** @var string */
80			private $bin = 'phpcs';
81
82			public function __construct()
83			{
84			$this->cmd = new Commandline();
85			$this->logLevelName = 'info';
86			parent::__construct();
87			}
88
89			public function getCommandline(): Commandline
90			{
91			return $this->cmd;
92			}
93
94			public function setCache(bool $cache): void
95			{
96			$this->cache = $cache;
97			}
98
99			public function setIgnoreAnnotations(bool $ignore): void
100			{
101			$this->ignoreAnnotations = $ignore;
102			}
103
104			public function setCheckreturn(bool $checkreturn): void
105			{
106			$this->checkreturn = $checkreturn;
107			}
108
109			public function setBin(string $bin): void
110			{
111			$this->bin = $bin;
112			}
113
114			public function setFormat(string $format): void
115			{
116			$this->format = $format;
117			$this->project->log("Format set to {$format}", Project::MSG_VERBOSE);
118			}
119
120			/**
121			* Create object for nested formatter element.
122			*
123			* @return CodeSnifferFormatterElement
			0 ignored issues – show Bug introduced 2023-03-31 16:25 UTC by Report Bug Copy Issue Report The type `Phing\Task\Ext\CodeSnifferFormatterElement` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
124			*/
125			public function createFormatter()
126			{
127			$num = array_push(
128			$this->formatters,
129			new PhpCSTaskFormatterElement()
130			);
131
132			return $this->formatters[$num - 1];
133			}
134
135			public function setStandard(string $standard): void
136			{
137			$this->standard = $standard;
138			$this->project->log("Standard set to {$standard}", Project::MSG_VERBOSE);
139			}
140
141			public function setFile(File $file): void
142			{
143			$this->file = $file;
144			}
145
146			public function setOutfile(string $outfile): void
147			{
148			$this->outfile = $outfile;
149			$this->project->log("Outfile set to {$outfile}", Project::MSG_VERBOSE);
150			}
151
152			public function main()
153			{
154			if (null === $this->file && 0 == count($this->filesets)) {
155			throw new BuildException('Missing both attribute "file" and "fileset".');
156			}
157			if (null === $this->file) {
158			// check filesets, and compile a list of files for phpcs to analyse
159			foreach ($this->filesets as $fileset) {
160			$files = $fileset->getIterator();
161			foreach ($files as $file) {
162			$this->files[] = $file;
163			}
164			}
165			}
166
167			$toExecute = $this->getCommandline();
168
169			$this->cache
170			? $toExecute->createArgument()->setValue('--cache')
171			: $toExecute->createArgument()->setValue('--no-cache');
172
173			if ($this->ignoreAnnotations) {
174			$toExecute->createArgument()->setValue('--ignore-annotations');
175			}
176			if ('' !== $this->format) {
177			$toExecute->createArgument()->setValue(' --report=' . $this->format);
178			}
179			if ('' !== $this->standard) {
180			$toExecute->createArgument()->setValue(' --standard=' . $this->standard);
181			}
182			if ('' !== $this->outfile) {
183			$toExecute->createArgument()->setValue(' --report-file=' . $this->outfile);
184			}
185
186			foreach ($this->formatters as $formatter) {
187			$formatterReportFile = ($formatter->getUseFile() ? $formatter->getOutFile() : null);
188			$formatterType = $formatter->getType();
189			$this->project->log(
190			"Generate report of type \"{$formatterType}\" with report written to {$formatterReportFile}",
191			Project::MSG_VERBOSE
192			);
193			$toExecute->createArgument()->setValue(' --report-' . $formatterType . '=' . $formatterReportFile);
194			}
195
196			if (null !== $this->file) {
197			$toExecute->createArgument()->setFile($this->file);
198			} else {
199			foreach ($this->files as $file) {
200			$toExecute->createArgument()->setFile(new File($file));
201			}
202			}
203
204			$exe = new ExecTask();
205			$exe->setProject($this->getProject());
206			$exe->setLocation($this->getLocation());
207			$exe->setOwningTarget($this->target);
208			$exe->setTaskName($this->getTaskName());
209			$exe->setExecutable($this->bin);
210			$exe->setCheckreturn($this->checkreturn);
211			$exe->setLevel($this->logLevelName);
212			$exe->setExecutable($toExecute->getExecutable());
213			$exe->createArg()->setLine(implode(' ', $toExecute->getArguments()));
214			$exe->main();
215			}
216			}
217

phingofficial / phing

PhpCSTask::main() F last analyzed 2025-06-01 11:47 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like

PhpCSTask::main() F
last analyzed 2025-06-01 11:47 UTC