ParsedComment::getLastLine() - Code Metrics - Inspection of "Further improve comment extraction" - oscarotero/Gettext - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#166)

by Pascal

created 2018-02-22 11:21 UTC

ParsedComment::getLastLine() A

↳ Parent: ParsedComment

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	4
rs	10

<?php

namespace Gettext\Utils;

/**
 * Comment parsed by PhpFunctionsScanner.
 */
class ParsedComment
{
    /**
     * The comment itself.
     *
     * @var string
     */
    protected $comment;

    /**
     * The line where the comment starts.
     *
     * @var int
     */
    protected $firstLine;

    /**
     * The line where the comment ends.
     *
     * @var int
     */
    protected $lastLine;

    /**
     * Initializes the instance.
     *
     * @param string $comment The comment itself.
     * @param int    $firstLine The line where the comment starts.
     * @param int    $lastLine The line where the comment ends.
     */
    public function __construct($comment, $firstLine, $lastLine)
    {
        $this->comment = $comment;
        $this->firstLine = $firstLine;
        $this->lastLine = $lastLine;
    }

    /**
     * Return the line where the comment starts.
     *
     * @return int Line number.
     */
    public function getFirstLine()
    {
        return $this->firstLine;
    }

    /**
     * Return the line where the comment ends.
     *
     * @return int Line number.
     */
    public function getLastLine()
    {
        return $this->lastLine;
    }

    /**
     * Return the actual comment string.
     *
     * @return string The comment.
     */
    public function getComment()
    {
        return $this->comment;
    }

    /**
     * Whether this comment is related with a given function.
     *
     * @param ParsedFunction $function The function to check.
     * @return bool Whether the comment is related or not.
     */
    public function isRelatedWith(ParsedFunction $function)
    {
        return $this->getLastLine() === $function->getLine() || $this->getLastLine() === $function->getLine() - 1;
    }
}


1			<?php
2
3			namespace Gettext\Utils;
4
5			/**
6			* Comment parsed by PhpFunctionsScanner.
7			*/
8			class ParsedComment
9			{
10			/**
11			* The comment itself.
12			*
13			* @var string
14			*/
15			protected $comment;
16
17			/**
18			* The line where the comment starts.
19			*
20			* @var int
21			*/
22			protected $firstLine;
23
24			/**
25			* The line where the comment ends.
26			*
27			* @var int
28			*/
29			protected $lastLine;
30
31			/**
32			* Initializes the instance.
33			*
34			* @param string $comment The comment itself.
35			* @param int $firstLine The line where the comment starts.
36			* @param int $lastLine The line where the comment ends.
37			*/
38			public function __construct($comment, $firstLine, $lastLine)
39			{
40			$this->comment = $comment;
41			$this->firstLine = $firstLine;
42			$this->lastLine = $lastLine;
43			}
44
45			/**
46			* Return the line where the comment starts.
47			*
48			* @return int Line number.
49			*/
50			public function getFirstLine()
51			{
52			return $this->firstLine;
53			}
54
55			/**
56			* Return the line where the comment ends.
57			*
58			* @return int Line number.
59			*/
60			public function getLastLine()
61			{
62			return $this->lastLine;
63			}
64
65			/**
66			* Return the actual comment string.
67			*
68			* @return string The comment.
69			*/
70			public function getComment()
71			{
72			return $this->comment;
73			}
74
75			/**
76			* Whether this comment is related with a given function.
77			*
78			* @param ParsedFunction $function The function to check.
79			* @return bool Whether the comment is related or not.
80			*/
81			public function isRelatedWith(ParsedFunction $function)
82			{
83			return $this->getLastLine() === $function->getLine() \|\| $this->getLastLine() === $function->getLine() - 1;
84			}
85			}
86

oscarotero / Gettext

Pull Request — master (#166)

ParsedComment::getLastLine() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like