ContactObjectMutator::setAuthors() - Code Metrics - Inspection of "Finished article object creation" - apparat/dev - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9e945f...ca30df )

by Joschi

created 2016-06-09 21:42 UTC

ContactObjectMutator::setAuthors() A

↳ Parent: ContactObjectMutator

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

/**
 * apparat-dev
 *
 * @category    Apparat
 * @package     Apparat\Dev
 * @subpackage  Apparat\Dev\Infrastructure
 * @author      Joschi Kuphal <[email protected]> / @jkphl
 * @copyright   Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
 * @license     http://opensource.org/licenses/MIT The MIT License (MIT)
 */

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ***********************************************************************************/

namespace Apparat\Dev\Infrastructure\Mutator;

use Apparat\Dev\Application\Utility\Random;
use Apparat\Object\Domain\Model\Object\ObjectInterface;

/**
 * Contact object mutator
 *
 * @package Apparat\Dev
 * @subpackage Apparat\Dev\Infrastructure
 */
class ContactObjectMutator extends AbstractObjectMutator
{
    /**
     * Initialize the article
     *
     * @param ObjectInterface $object Article
     * @return ObjectInterface Article
     */
    public function initialize(ObjectInterface $object)
    {
        $this->setTitle($object); // p-name
        $this->setRandomDescription($object, .7); // p-summary
        $this->setRandomAbstract($object, .2);
        $this->setRandomCategories($object, .4); // p-category
        $this->setRandomKeywords($object, .7);
        $this->setAuthors($object); // TODO p-author
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}

        // URL = u-url
        // URL = u-uid
        // system.published = dt-published
        // system.modified = dt-updated

        // p-location
        // u-syndication
        // u-in-reply-to
        // p-rsvp
        // p-comment
        // u-like-of
        // u-like
        // u-repost-of
        // u-repost (+ h-cite)
        // u-photo
        // u-audio
        // u-video
        // u-featured

        return $object;
    }

    /**
     * Mutate the article
     *
     * @param ObjectInterface $object Article
     * @return ObjectInterface Article
     */
    public function mutate(ObjectInterface $object)
    {
        $object->setPayload(Random::markdown()); // e-content

        $this->setRandomTitle($object, .1);
        $this->setRandomDescription($object, .2); // p-summary
        $this->setRandomAbstract($object, .1);
        $this->setRandomCategories($object, .2); // p-category
        $this->setRandomKeywords($object, .2);
//        $this->setAuthors($object); // TODO p-author

        return $object;
    }

    /**
     * Set the article title
     *
     * @param ObjectInterface $object Article
     * @return ObjectInterface $object Article
     */
    protected function setTitle(ObjectInterface $object)
    {
        return $object->setTitle($this->generator->text(70));
    }
    /**
     * Set the article description
     *
     * @param ObjectInterface $object Article
     * @return ObjectInterface $object Article
     */
    protected function setDescription(ObjectInterface $object)
    {
        return $object->setDescription($this->generator->text(200));
    }

    /**
     * Set the article abstract
     *
     * @param ObjectInterface $object Article
     * @return ObjectInterface $object Article
     */
    protected function setAbstract(ObjectInterface $object)
    {
        return $object->setAbstract($this->generator->realText(250));
    }

    /**
     * Set the article keywords
     *
     * @param ObjectInterface $object Article
     * @return ObjectInterface $object Article
     */
    protected function setKeywords(ObjectInterface $object)
    {
        return $object->setKeywords($this->generator->words(rand(0, 5)));

    }

    /**
     * Set the article categories
     *
     * @param ObjectInterface $object Article
     * @return ObjectInterface $object Article
     */
    protected function setCategories(ObjectInterface $object)
    {
        return $object->setCategories($this->generator->words(rand(0, 5)));

    }

    /**
     * Set the article authors
     *
     * @param ObjectInterface $object Article
     * @return ObjectInterface $object Article
     */
    protected function setAuthors(ObjectInterface $object)
    {
        return $object;
    }
}


1			<?php
2
3			/**
4			* apparat-dev
5			*
6			* @category Apparat
7			* @package Apparat\Dev
8			* @subpackage Apparat\Dev\Infrastructure
9			* @author Joschi Kuphal <[email protected]> / @jkphl
10			* @copyright Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
11			* @license http://opensource.org/licenses/MIT The MIT License (MIT)
12			*/
13
14			/***********************************************************************************
15			* The MIT License (MIT)
16			*
17			* Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
18			*
19			* Permission is hereby granted, free of charge, to any person obtaining a copy of
20			* this software and associated documentation files (the "Software"), to deal in
21			* the Software without restriction, including without limitation the rights to
22			* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
23			* the Software, and to permit persons to whom the Software is furnished to do so,
24			* subject to the following conditions:
25			*
26			* The above copyright notice and this permission notice shall be included in all
27			* copies or substantial portions of the Software.
28			*
29			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
31			* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
32			* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
33			* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
34			* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35			***********************************************************************************/
36
37			namespace Apparat\Dev\Infrastructure\Mutator;
38
39			use Apparat\Dev\Application\Utility\Random;
40			use Apparat\Object\Domain\Model\Object\ObjectInterface;
41
42			/**
43			* Contact object mutator
44			*
45			* @package Apparat\Dev
46			* @subpackage Apparat\Dev\Infrastructure
47			*/
48			class ContactObjectMutator extends AbstractObjectMutator
49			{
50			/**
51			* Initialize the article
52			*
53			* @param ObjectInterface $object Article
54			* @return ObjectInterface Article
55			*/
56			public function initialize(ObjectInterface $object)
57			{
58			$this->setTitle($object); // p-name
59			$this->setRandomDescription($object, .7); // p-summary
60			$this->setRandomAbstract($object, .2);
61			$this->setRandomCategories($object, .4); // p-category
62			$this->setRandomKeywords($object, .7);
63			$this->setAuthors($object); // TODO p-author
			0 ignored issues – show Unused Code introduced 2016-06-09 21:44 UTC by Report Bug Copy Issue Report The call to the method `Apparat\Dev\Infrastructu...ctMutator::setAuthors()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
64
65			// URL = u-url
66			// URL = u-uid
67			// system.published = dt-published
68			// system.modified = dt-updated
69
70			// p-location
71			// u-syndication
72			// u-in-reply-to
73			// p-rsvp
74			// p-comment
75			// u-like-of
76			// u-like
77			// u-repost-of
78			// u-repost (+ h-cite)
79			// u-photo
80			// u-audio
81			// u-video
82			// u-featured
83
84			return $object;
85			}
86
87			/**
88			* Mutate the article
89			*
90			* @param ObjectInterface $object Article
91			* @return ObjectInterface Article
92			*/
93			public function mutate(ObjectInterface $object)
94			{
95			$object->setPayload(Random::markdown()); // e-content
96
97			$this->setRandomTitle($object, .1);
98			$this->setRandomDescription($object, .2); // p-summary
99			$this->setRandomAbstract($object, .1);
100			$this->setRandomCategories($object, .2); // p-category
101			$this->setRandomKeywords($object, .2);
102			// $this->setAuthors($object); // TODO p-author
103
104			return $object;
105			}
106
107			/**
108			* Set the article title
109			*
110			* @param ObjectInterface $object Article
111			* @return ObjectInterface $object Article
112			*/
113			protected function setTitle(ObjectInterface $object)
114			{
115			return $object->setTitle($this->generator->text(70));
116			}
117			/**
118			* Set the article description
119			*
120			* @param ObjectInterface $object Article
121			* @return ObjectInterface $object Article
122			*/
123			protected function setDescription(ObjectInterface $object)
124			{
125			return $object->setDescription($this->generator->text(200));
126			}
127
128			/**
129			* Set the article abstract
130			*
131			* @param ObjectInterface $object Article
132			* @return ObjectInterface $object Article
133			*/
134			protected function setAbstract(ObjectInterface $object)
135			{
136			return $object->setAbstract($this->generator->realText(250));
137			}
138
139			/**
140			* Set the article keywords
141			*
142			* @param ObjectInterface $object Article
143			* @return ObjectInterface $object Article
144			*/
145			protected function setKeywords(ObjectInterface $object)
146			{
147			return $object->setKeywords($this->generator->words(rand(0, 5)));
			0 ignored issues – show Bug introduced 2016-06-09 21:44 UTC by Report Bug Copy Issue Report It seems like `$this->generator->words(rand(0, 5))` targeting `Faker\Generator::words()` can also be of type `string`; however, `Apparat\Object\Domain\Mo...nterface::setKeywords()` does only seem to accept `array`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
148			}
149
150			/**
151			* Set the article categories
152			*
153			* @param ObjectInterface $object Article
154			* @return ObjectInterface $object Article
155			*/
156			protected function setCategories(ObjectInterface $object)
157			{
158			return $object->setCategories($this->generator->words(rand(0, 5)));
			0 ignored issues – show Bug introduced 2016-06-09 21:44 UTC by Report Bug Copy Issue Report It seems like `$this->generator->words(rand(0, 5))` targeting `Faker\Generator::words()` can also be of type `string`; however, `Apparat\Object\Domain\Mo...erface::setCategories()` does only seem to accept `array`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
159			}
160
161			/**
162			* Set the article authors
163			*
164			* @param ObjectInterface $object Article
165			* @return ObjectInterface $object Article
166			*/
167			protected function setAuthors(ObjectInterface $object)
168			{
169			return $object;
170			}
171			}
172

apparat / dev

Push — master ( 9e945f...ca30df )

ContactObjectMutator::setAuthors() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like