Iptc::getHeadline() - Code Metrics - Inspection of "Merge pull request #27 from Miljar/develop" - PHPExif/php-exif-common - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 5bcd3c...9a7c30 )

by Tom Van

created 2016-11-11 10:55 UTC

Iptc::getHeadline() A

↳ Parent: Iptc

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
/**
 * Iptc: A container class for IPTC data
 *
 * @link        http://github.com/PHPExif/php-exif-common for the canonical source repository
 * @copyright   Copyright (c) 2016 Tom Van Herreweghe <[email protected]>
 * @license     http://github.com/PHPExif/php-exif-common/blob/master/LICENSE MIT License
 * @category    PHPExif
 * @package     Common
 */

namespace PHPExif\Common\Data;

use PHPExif\Common\Data\ValueObject\Caption;
use PHPExif\Common\Data\ValueObject\Copyright;
use PHPExif\Common\Data\ValueObject\Credit;
use PHPExif\Common\Data\ValueObject\Headline;

/**
 * Iptc class
 *
 * Container for IPTC data
 *
 * @category    PHPExif
 * @package     Common
 */
class Iptc implements IptcInterface
{
    /**
     * @var Caption
     */
    protected $caption;

    /**
     * @var Copyright
     */
    protected $copyright;

    /**
     * @var Credit
     */
    protected $credit;

    /**
     * @var Headline
     */
    protected $headline;

    /**
     * Contains the mapping of names to IPTC field numbers
     *
     * @var array
     */
    public static $iptcMapping = array(
        'caption'   => '2#120',
        'copyright' => '2#116',
        'credit'    => '2#110',
        'headline'  => '2#105',
        'jobtitle'  => '2#085',
        'keywords'  => '2#025',
        'source'    => '2#115',
        'title'     => '2#005',
    );

    /**
     * {@inheritDoc}
     */
    public function getHeadline()
    {
        return $this->headline;
    }

    /**
     * {@inheritDoc}
     */
    public function withHeadline(Headline $headline)
    {
        $new = clone $this;
        $new->headline = $headline;

        return $new;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * {@inheritDoc}
     */
    public function getCredit()
    {
        return $this->credit;
    }

    /**
     * {@inheritDoc}
     */
    public function withCredit(Credit $credit)
    {
        $new = clone $this;
        $new->credit = $credit;

        return $new;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * {@inheritDoc}
     */
    public function getCopyright()
    {
        return $this->copyright;
    }

    /**
     * {@inheritDoc}
     */
    public function withCopyright(Copyright $copyright)
    {
        $new = clone $this;
        $new->copyright = $copyright;

        return $new;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * {@inheritDoc}
     */
    public function getCaption()
    {
        return $this->caption;
    }

    /**
     * {@inheritDoc}
     */
    public function withCaption(Caption $caption)
    {
        $new = clone $this;
        $new->caption = $caption;

        return $new;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }
}


1			<?php
2			/**
3			* Iptc: A container class for IPTC data
4			*
5			* @link http://github.com/PHPExif/php-exif-common for the canonical source repository
6			* @copyright Copyright (c) 2016 Tom Van Herreweghe <[email protected]>
7			* @license http://github.com/PHPExif/php-exif-common/blob/master/LICENSE MIT License
8			* @category PHPExif
9			* @package Common
10			*/
11
12			namespace PHPExif\Common\Data;
13
14			use PHPExif\Common\Data\ValueObject\Caption;
15			use PHPExif\Common\Data\ValueObject\Copyright;
16			use PHPExif\Common\Data\ValueObject\Credit;
17			use PHPExif\Common\Data\ValueObject\Headline;
18
19			/**
20			* Iptc class
21			*
22			* Container for IPTC data
23			*
24			* @category PHPExif
25			* @package Common
26			*/
27			class Iptc implements IptcInterface
28			{
29			/**
30			* @var Caption
31			*/
32			protected $caption;
33
34			/**
35			* @var Copyright
36			*/
37			protected $copyright;
38
39			/**
40			* @var Credit
41			*/
42			protected $credit;
43
44			/**
45			* @var Headline
46			*/
47			protected $headline;
48
49			/**
50			* Contains the mapping of names to IPTC field numbers
51			*
52			* @var array
53			*/
54			public static $iptcMapping = array(
55			'caption' => '2#120',
56			'copyright' => '2#116',
57			'credit' => '2#110',
58			'headline' => '2#105',
59			'jobtitle' => '2#085',
60			'keywords' => '2#025',
61			'source' => '2#115',
62			'title' => '2#005',
63			);
64
65			/**
66			* {@inheritDoc}
67			*/
68			public function getHeadline()
69			{
70			return $this->headline;
71			}
72
73			/**
74			* {@inheritDoc}
75			*/
76			public function withHeadline(Headline $headline)
77			{
78			$new = clone $this;
79			$new->headline = $headline;
80
81			return $new;
			0 ignored issues – show Bug Best Practice introduced 2016-11-10 11:57 UTC by Report Bug Copy Issue Report The return type of `return $new;` (`PHPExif\Common\Data\Iptc`) is incompatible with the return type declared by the interface `PHPExif\Common\Data\IptcInterface::withHeadline` of type `PHPExif\Common\Data\ExifInterface`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
82			}
83
84			/**
85			* {@inheritDoc}
86			*/
87			public function getCredit()
88			{
89			return $this->credit;
90			}
91
92			/**
93			* {@inheritDoc}
94			*/
95			public function withCredit(Credit $credit)
96			{
97			$new = clone $this;
98			$new->credit = $credit;
99
100			return $new;
			0 ignored issues – show Bug Best Practice introduced 2016-11-10 11:57 UTC by Report Bug Copy Issue Report The return type of `return $new;` (`PHPExif\Common\Data\Iptc`) is incompatible with the return type declared by the interface `PHPExif\Common\Data\IptcInterface::withCredit` of type `PHPExif\Common\Data\ExifInterface`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
101			}
102
103			/**
104			* {@inheritDoc}
105			*/
106			public function getCopyright()
107			{
108			return $this->copyright;
109			}
110
111			/**
112			* {@inheritDoc}
113			*/
114			public function withCopyright(Copyright $copyright)
115			{
116			$new = clone $this;
117			$new->copyright = $copyright;
118
119			return $new;
			0 ignored issues – show Bug Best Practice introduced 2016-11-10 11:57 UTC by Report Bug Copy Issue Report The return type of `return $new;` (`PHPExif\Common\Data\Iptc`) is incompatible with the return type declared by the interface `PHPExif\Common\Data\IptcInterface::withCopyright` of type `PHPExif\Common\Data\ExifInterface`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
120			}
121
122			/**
123			* {@inheritDoc}
124			*/
125			public function getCaption()
126			{
127			return $this->caption;
128			}
129
130			/**
131			* {@inheritDoc}
132			*/
133			public function withCaption(Caption $caption)
134			{
135			$new = clone $this;
136			$new->caption = $caption;
137
138			return $new;
			0 ignored issues – show Bug Best Practice introduced 2016-11-10 11:57 UTC by Report Bug Copy Issue Report The return type of `return $new;` (`PHPExif\Common\Data\Iptc`) is incompatible with the return type declared by the interface `PHPExif\Common\Data\IptcInterface::withCaption` of type `PHPExif\Common\Data\ExifInterface`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
139			}
140			}
141

PHPExif / php-exif-common

GitHub Access Token became invalid

Push — develop ( 5bcd3c...9a7c30 )

Iptc::getHeadline() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like