Issues in CommentParser.php (master) - Issues in master - mkusher/padawan.php - Measure and Improve Code Quality continuously with Scrutinizer

Issues (114)

Security Analysis no request data

Cross-Site Scripting

Cross-Site Scripting enables an attacker to inject code into the response of a web-request that is viewed by other users. It can for example be used to bypass access controls, or even to take over other users' accounts.

File Exposure

File Exposure allows an attacker to gain access to local files that he should not be able to access. These files can for example include database credentials, or other configuration files.

File Manipulation

File Manipulation enables an attacker to write custom data to files. This potentially leads to injection of arbitrary code on the server.

Object Injection

Object Injection enables an attacker to inject an object into PHP code, and can lead to arbitrary code execution, file exposure, or file manipulation attacks.

Code Injection

Code Injection enables an attacker to execute arbitrary code on the server.

Response Splitting

Response Splitting can be used to send arbitrary responses.

File Inclusion

File Inclusion enables an attacker to inject custom files into PHP's file loading mechanism, either explicitly passed to include, or for example via PHP's auto-loading mechanism.

Command Injection

Command Injection enables an attacker to inject a shell command that is execute with the privileges of the web-server. This can be used to expose sensitive data, or gain access of your server.

SQL Injection

SQL Injection enables an attacker to execute arbitrary SQL code on your database server gaining access to user data, or manipulating user data.

XPath Injection

XPath Injection enables an attacker to modify the parts of XML document that are read. If that XML document is for example used for authentication, this can lead to further vulnerabilities similar to SQL Injection.

LDAP Injection

LDAP Injection enables an attacker to inject LDAP statements potentially granting permission to run unauthorized queries, or modify content inside the LDAP tree.

Header Injection

Other Vulnerability

This category comprises other attack vectors such as manipulating the PHP runtime, loading custom extensions, freezing the runtime, or similar.

Regex Injection

Regex Injection enables an attacker to execute arbitrary code in your PHP process.

XML Injection

XML Injection enables an attacker to read files on your local filesystem including configuration files, or can be abused to freeze your web-server process.

Variable Injection

Variable Injection enables an attacker to overwrite program variables with custom data, and can lead to further vulnerabilities.

Unfortunately, the security analysis is currently not available for your project. If you are a non-commercial open-source project, please contact support to gain access.

src/Padawan/Parser/CommentParser.php (12 issues)

Labels

Severity

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

namespace Padawan\Parser;

use phpDocumentor\Reflection\DocBlock;
use phpDocumentor\Reflection\DocBlock\Tag;
use phpDocumentor\Reflection\DocBlock\Context;
use Padawan\Domain\Project\Node\Comment;
use Padawan\Domain\Project\Node\MethodParam;
use Padawan\Domain\Project\Node\Variable;
use Padawan\Domain\Project\Node\ClassProperty;

class CommentParser
{
    public function __construct(UseParser $useParser) {
        $this->useParser = $useParser;
    }

    /**
     * Parses DocComment block
     *
     * @param string $doc
     * @return Comment
     */
    public function parse($doc) {
        $text = $doc;
        if (is_array($doc)) {
            $doc = array_shift($doc);
            $text = $doc->getText();
        }
        $comment = new Comment(
            $this->trimComment($text)
        );
        $this->parseDoc($comment, $text);

        return $comment;
    }

    /**
     * Parses doc comment and populates comment entity
     *
     * @param string $text
     */
    protected function parseDoc(Comment $comment, $text) {
        $context = $this->getContext();
        try {
            $block = new DocBlock($text, $context);
            foreach ($block->getTags() AS $tag) {
                switch ($tag->getName()) {
                case "param":
                    $comment->addVar(
                        $this->createMethodParam($tag)
                    );
                    break;
                case "var":
                    $comment->addVar(
                        $this->createVar($tag)
                    );
                    break;
                case "return":
                    $comment->setReturn(
                        $this->getFQCN($tag->getType())
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                    );
                    break;
                case "property":
                case "property-read":
                case "property-write":
                    $comment->addProperty(
                        $this->createProperty($tag)
                    );
                    break;
                case "inheritdoc":
                    $comment->markInheritDoc();
                    break;
                }
            }
        }
        catch (\Exception $e) {


        }
    }
    protected function createMethodParam(Tag $tag) {

        $name = trim($tag->getVariableName(), '$');
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        $param = new MethodParam($name);
        $param->setType($this->getFQCN($tag->getType()));
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        return $param;
    }
    protected function createVar(Tag $tag) {

        $name = trim($tag->getVariableName(), '$');
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        $param = new Variable($name);
        $param->setType($this->getFQCN($tag->getType()));
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        return $param;
    }
    protected function createProperty(Tag $tag) {

        $name = trim($tag->getVariableName(), '$');
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        $prop = new ClassProperty;
        $prop->name = $name;
        $prop->setType($this->getFQCN($tag->getType()));
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        return $prop;
    }

    /**
     * Creates FQN by type string
     *
     * @param string $type
     * @return \Padawan\Domain\Project\FQCN
     */
    protected function getFQCN($type) {
        return $this->useParser->parseType($type);

    }

    /**
     * @return string
     */
    protected function trimComment($comment) {
        $lines = explode("\n", $comment);
        foreach ($lines AS $key => $line) {
            $lines[$key] = preg_replace([
                "/^\/\**/",
                "/^ *\* */",
                "/\**\/$/"
            ], "", $line);
        }
        $text = implode("\n", $lines);
        return utf8_encode($text);
    }

    /**
     * @return Context
     */
    protected function getContext() {
        $uses = $this->useParser->getUses();
        $namespace = $uses->getFQCN()->toString();
        $aliases = array_map(function($fqcn) {
            return $fqcn->toString();
        }, $uses->all());
        return new Context($namespace, $aliases);
    }

    /** @property UseParser */
    private $useParser;
}


1		<?php
2
3		namespace Padawan\Parser;
4
5		use phpDocumentor\Reflection\DocBlock;
6		use phpDocumentor\Reflection\DocBlock\Tag;
7		use phpDocumentor\Reflection\DocBlock\Context;
8		use Padawan\Domain\Project\Node\Comment;
9		use Padawan\Domain\Project\Node\MethodParam;
10		use Padawan\Domain\Project\Node\Variable;
11		use Padawan\Domain\Project\Node\ClassProperty;
12
13		class CommentParser
14		{
15		public function __construct(UseParser $useParser) {
16		$this->useParser = $useParser;
17		}
18
19		/**
20		* Parses DocComment block
21		*
22		* @param string $doc
23		* @return Comment
24		*/
25		public function parse($doc) {
26		$text = $doc;
27		if (is_array($doc)) {
28		$doc = array_shift($doc);
29		$text = $doc->getText();
30		}
31		$comment = new Comment(
32		$this->trimComment($text)
33		);
34		$this->parseDoc($comment, $text);
35
36		return $comment;
37		}
38
39		/**
40		* Parses doc comment and populates comment entity
41		*
42		* @param string $text
43		*/
44		protected function parseDoc(Comment $comment, $text) {
45		$context = $this->getContext();
46		try {
47		$block = new DocBlock($text, $context);
48		foreach ($block->getTags() AS $tag) {
49		switch ($tag->getName()) {
50		case "param":
51		$comment->addVar(
52		$this->createMethodParam($tag)
53		);
54		break;
55		case "var":
56		$comment->addVar(
57		$this->createVar($tag)
58		);
59		break;
60		case "return":
61		$comment->setReturn(
62		$this->getFQCN($tag->getType())
		0 ignored issues – show Bug introduced 2015-11-27 13:32 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like you code against a specific sub-type and not the parent class `phpDocumentor\Reflection\DocBlock\Tag` as the method `getType()` does only exist in the following sub-classes of `phpDocumentor\Reflection\DocBlock\Tag`: `phpDocumentor\Reflection\DocBlock\Tag\MethodTag`, `phpDocumentor\Reflection\DocBlock\Tag\ParamTag`, `phpDocumentor\Reflection...ock\Tag\PropertyReadTag`, `phpDocumentor\Reflection\DocBlock\Tag\PropertyTag`, `phpDocumentor\Reflection...ck\Tag\PropertyWriteTag`, `phpDocumentor\Reflection\DocBlock\Tag\ReturnTag`, `phpDocumentor\Reflection\DocBlock\Tag\ThrowsTag`, `phpDocumentor\Reflection\DocBlock\Tag\VarTag`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
63		);
64		break;
65		case "property":
66		case "property-read":
67		case "property-write":
68		$comment->addProperty(
69		$this->createProperty($tag)
70		);
71		break;
72		case "inheritdoc":
73		$comment->markInheritDoc();
74		break;
75		}
76		}
77		}
78		catch (\Exception $e) {
		0 ignored issues – show Coding Style Comprehensibility introduced 2015-11-27 13:32 UTC by Report Bug Copy Issue Report Show Similar Issues like this Consider adding a comment why this CATCH block is empty. Loading history...
79
80		}
81		}
82	View Code Duplication	protected function createMethodParam(Tag $tag) {
		0 ignored issues – show Duplication introduced 2015-11-27 13:32 UTC by Report Bug Copy Issue Report Show Similar Issues like this This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
83		$name = trim($tag->getVariableName(), '$');
		0 ignored issues – show Bug introduced 2016-12-28 10:22 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like you code against a specific sub-type and not the parent class `phpDocumentor\Reflection\DocBlock\Tag` as the method `getVariableName()` does only exist in the following sub-classes of `phpDocumentor\Reflection\DocBlock\Tag`: `phpDocumentor\Reflection\DocBlock\Tag\ParamTag`, `phpDocumentor\Reflection...ock\Tag\PropertyReadTag`, `phpDocumentor\Reflection\DocBlock\Tag\PropertyTag`, `phpDocumentor\Reflection...ck\Tag\PropertyWriteTag`, `phpDocumentor\Reflection\DocBlock\Tag\VarTag`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
84		$param = new MethodParam($name);
85		$param->setType($this->getFQCN($tag->getType()));
		0 ignored issues – show Bug introduced 2016-12-28 10:22 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like you code against a specific sub-type and not the parent class `phpDocumentor\Reflection\DocBlock\Tag` as the method `getType()` does only exist in the following sub-classes of `phpDocumentor\Reflection\DocBlock\Tag`: `phpDocumentor\Reflection\DocBlock\Tag\MethodTag`, `phpDocumentor\Reflection\DocBlock\Tag\ParamTag`, `phpDocumentor\Reflection...ock\Tag\PropertyReadTag`, `phpDocumentor\Reflection\DocBlock\Tag\PropertyTag`, `phpDocumentor\Reflection...ck\Tag\PropertyWriteTag`, `phpDocumentor\Reflection\DocBlock\Tag\ReturnTag`, `phpDocumentor\Reflection\DocBlock\Tag\ThrowsTag`, `phpDocumentor\Reflection\DocBlock\Tag\VarTag`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
86		return $param;
87		}
88	View Code Duplication	protected function createVar(Tag $tag) {
		0 ignored issues – show Duplication introduced 2015-11-27 13:32 UTC by Report Bug Copy Issue Report Show Similar Issues like this This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
89		$name = trim($tag->getVariableName(), '$');
		0 ignored issues – show Bug introduced 2016-12-28 10:22 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like you code against a specific sub-type and not the parent class `phpDocumentor\Reflection\DocBlock\Tag` as the method `getVariableName()` does only exist in the following sub-classes of `phpDocumentor\Reflection\DocBlock\Tag`: `phpDocumentor\Reflection\DocBlock\Tag\ParamTag`, `phpDocumentor\Reflection...ock\Tag\PropertyReadTag`, `phpDocumentor\Reflection\DocBlock\Tag\PropertyTag`, `phpDocumentor\Reflection...ck\Tag\PropertyWriteTag`, `phpDocumentor\Reflection\DocBlock\Tag\VarTag`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
90		$param = new Variable($name);
91		$param->setType($this->getFQCN($tag->getType()));
		0 ignored issues – show Bug introduced 2016-12-28 10:22 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like you code against a specific sub-type and not the parent class `phpDocumentor\Reflection\DocBlock\Tag` as the method `getType()` does only exist in the following sub-classes of `phpDocumentor\Reflection\DocBlock\Tag`: `phpDocumentor\Reflection\DocBlock\Tag\MethodTag`, `phpDocumentor\Reflection\DocBlock\Tag\ParamTag`, `phpDocumentor\Reflection...ock\Tag\PropertyReadTag`, `phpDocumentor\Reflection\DocBlock\Tag\PropertyTag`, `phpDocumentor\Reflection...ck\Tag\PropertyWriteTag`, `phpDocumentor\Reflection\DocBlock\Tag\ReturnTag`, `phpDocumentor\Reflection\DocBlock\Tag\ThrowsTag`, `phpDocumentor\Reflection\DocBlock\Tag\VarTag`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
92		return $param;
93		}
94	View Code Duplication	protected function createProperty(Tag $tag) {
		0 ignored issues – show Duplication introduced 2015-11-27 13:32 UTC by Report Bug Copy Issue Report Show Similar Issues like this This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
95		$name = trim($tag->getVariableName(), '$');
		0 ignored issues – show Bug introduced 2016-12-28 10:22 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like you code against a specific sub-type and not the parent class `phpDocumentor\Reflection\DocBlock\Tag` as the method `getVariableName()` does only exist in the following sub-classes of `phpDocumentor\Reflection\DocBlock\Tag`: `phpDocumentor\Reflection\DocBlock\Tag\ParamTag`, `phpDocumentor\Reflection...ock\Tag\PropertyReadTag`, `phpDocumentor\Reflection\DocBlock\Tag\PropertyTag`, `phpDocumentor\Reflection...ck\Tag\PropertyWriteTag`, `phpDocumentor\Reflection\DocBlock\Tag\VarTag`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
96		$prop = new ClassProperty;
97		$prop->name = $name;
98		$prop->setType($this->getFQCN($tag->getType()));
		0 ignored issues – show Bug introduced 2015-11-27 13:32 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like you code against a specific sub-type and not the parent class `phpDocumentor\Reflection\DocBlock\Tag` as the method `getType()` does only exist in the following sub-classes of `phpDocumentor\Reflection\DocBlock\Tag`: `phpDocumentor\Reflection\DocBlock\Tag\MethodTag`, `phpDocumentor\Reflection\DocBlock\Tag\ParamTag`, `phpDocumentor\Reflection...ock\Tag\PropertyReadTag`, `phpDocumentor\Reflection\DocBlock\Tag\PropertyTag`, `phpDocumentor\Reflection...ck\Tag\PropertyWriteTag`, `phpDocumentor\Reflection\DocBlock\Tag\ReturnTag`, `phpDocumentor\Reflection\DocBlock\Tag\ThrowsTag`, `phpDocumentor\Reflection\DocBlock\Tag\VarTag`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
99		return $prop;
100		}
101
102		/**
103		* Creates FQN by type string
104		*
105		* @param string $type
106		* @return \Padawan\Domain\Project\FQCN
107		*/
108		protected function getFQCN($type) {
109		return $this->useParser->parseType($type);
		0 ignored issues – show Bug Compatibility introduced 2016-05-08 10:22 UTC by Report Bug Copy Issue Report Show Similar Issues like this The expression `$this->useParser->parseType($type);` of type `Padawan\Domain\Project\FQCN\|boolean` adds the type `boolean` to the return on line 109 which is incompatible with the return type documented by `Padawan\Parser\CommentParser::getFQCN` of type `Padawan\Domain\Project\FQCN`. Loading history...
110		}
111
112		/**
113		* @return string
114		*/
115		protected function trimComment($comment) {
116		$lines = explode("\n", $comment);
117		foreach ($lines AS $key => $line) {
118		$lines[$key] = preg_replace([
119		"/^\/\**/",
120		"/^ \ */",
121		"/\**\/$/"
122		], "", $line);
123		}
124		$text = implode("\n", $lines);
125		return utf8_encode($text);
126		}
127
128		/**
129		* @return Context
130		*/
131		protected function getContext() {
132		$uses = $this->useParser->getUses();
133		$namespace = $uses->getFQCN()->toString();
134		$aliases = array_map(function($fqcn) {
135		return $fqcn->toString();
136		}, $uses->all());
137		return new Context($namespace, $aliases);
138		}
139
140		/** @property UseParser */
141		private $useParser;
142		}
143

mkusher / padawan.php

Issues (114)

Security Analysis no request data

src/Padawan/Parser/CommentParser.php (12 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like