PersonTrait - Code Metrics - Inspection of "use instanceOf check from objecthelper #1756" - luyadev/luya - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 267515...e6e37f )

by Basil

created 2018-01-24 14:03 UTC

PersonTrait D

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	1016
Duplicated Lines	1.38 %

Coupling/Cohesion

Components	2
Dependencies	2

Importance

Changes

Metric	Value
wmc	90
lcom	2
cbo	2
dl	14
loc	1016
rs	4.4385
c	0
b	0
f	0

90 Methods

Rating	Name	Duplication	Size	Complexity
A	getAdditionalName()	0	4	1
A	setAdditionalName()	0	5	1
A	getAddress()	0	4	1
A	setAddress()	0	5	1
A	getAffiliation()	0	4	1
A	setAffiliation()	0	5	1
A	getAward()	0	4	1
A	setAward()	0	5	1
A	getBirthDate()	0	4	1
A	setBirthDate()	0	5	1
A	getBirthPlace()	0	4	1
A	setBirthPlace()	0	5	1
A	getBrand()	0	4	1
A	setBrand()	0	5	1
A	getChildren()	0	4	1
A	setChildren()	0	5	1
A	getColleague()	0	4	1
A	setColleague()	0	5	1
A	getContactPoint()	0	4	1
A	setContactPoint()	0	5	1
A	getDeathDate()	0	4	1
A	setDeathDate()	0	5	1
A	getDeathPlace()	0	4	1
A	setDeathPlace()	0	5	1
A	getDuns()	0	4	1
A	setDuns()	0	5	1
A	getEmail()	0	4	1
A	setEmail()	0	5	1
A	getFamilyName()	0	4	1
A	setFamilyName()	0	5	1
A	getFaxNumber()	0	4	1
A	setFaxNumber()	0	5	1
A	getFollows()	0	4	1
A	setFollows()	0	5	1
A	getFunder()	0	4	1
A	setFunder()	7	7	1
A	getGender()	0	4	1
A	setGender()	0	5	1
A	getGivenName()	0	4	1
A	setGivenName()	0	5	1
A	getGlobalLocationNumber()	0	4	1
A	setGlobalLocationNumber()	0	5	1
A	getHasPOS()	0	4	1
A	setHasPOS()	0	5	1
A	getHeight()	0	4	1
A	setHeight()	0	5	1
A	getHomeLocation()	0	4	1
A	setHomeLocation()	0	5	1
A	getHonorificPrefix()	0	4	1
A	setHonorificPrefix()	0	5	1
A	getHonorificSuffix()	0	4	1
A	setHonorificSuffix()	0	5	1
A	getIsicV4()	0	4	1
A	setIsicV4()	0	5	1
A	getJobTitle()	0	4	1
A	setJobTitle()	0	5	1
A	getKnows()	0	4	1
A	setKnows()	0	5	1
A	getMakesOffer()	0	4	1
A	setMakesOffer()	0	5	1
A	getMemberOf()	0	4	1
A	setMemberOf()	0	5	1
A	getNaics()	0	4	1
A	setNaics()	0	5	1
A	getNationality()	0	4	1
A	setNationality()	0	5	1
A	getParent()	0	4	1
A	setParent()	0	5	1
A	getPerformerIn()	0	4	1
A	setPerformerIn()	0	5	1
A	getPublishingPrinciples()	0	4	1
A	setPublishingPrinciples()	0	5	1
A	getRelatedTo()	0	4	1
A	setRelatedTo()	0	5	1
A	getSibling()	0	4	1
A	setSibling()	0	5	1
A	getSponsor()	0	4	1
A	setSponsor()	7	7	1
A	getSpouse()	0	4	1
A	setSpouse()	0	5	1
A	getTaxID()	0	4	1
A	setTaxID()	0	5	1
A	getTelephone()	0	4	1
A	setTelephone()	0	5	1
A	getVatID()	0	4	1
A	setVatID()	0	5	1
A	getWorkLocation()	0	4	1
A	setWorkLocation()	0	5	1
A	getWorksFor()	0	4	1
A	setWorksFor()	0	5	1

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like PersonTrait often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use PersonTrait, and based on these observations, apply Extract Interface, too.

<?php

namespace luya\web\jsonld;

use luya\helpers\ObjectHelper;

/**
 * JsonLd - Person trait
 *
 * @see http://schema.org/Person
 *
 * @author Alex Schmid
 * @since 1.0.0
 */
trait PersonTrait
{
    private $_additionalName;

    /**
     * @return string
     */
    public function getAdditionalName()
    {
        return $this->_additionalName;
    }

    /**
     * An additional name for a Person, can be used for a middle name.
     *
     * @param string $additionalName
     * @return PersonTrait

     */
    public function setAdditionalName($additionalName)
    {
        $this->_additionalName = $additionalName;
        return $this;
    }

    private $_address;

    /**
     * @return PostalAddress|string
     */
    public function getAddress()
    {
        return $this->_address;
    }

    /**
     * Physical address of the item.
     *
     * @param PostalAddress|string $address
     * @return PersonTrait

     */
    public function setAddress(PostalAddress $address)
    {
        $this->_address = $address;
        return $this;
    }

    private $_affiliation;

    /**
     * @return Organization
     */
    public function getAffiliation()
    {
        return $this->_affiliation;
    }

    /**
     * An organization that this person is affiliated with. For example, a school/university, a club, or a team.
     *
     * @param Organization $affiliation
     * @return PersonTrait

     */
    public function setAffiliation(Organization $affiliation)
    {
        $this->_affiliation = $affiliation;
        return $this;
    }

    private $_award;

    /**
     * @return string
     */
    public function getAward()
    {
        return $this->_award;
    }

    /**
     * An award won by or for this item.
     * Supersedes awards.
     *
     * @param string $award
     * @return PersonTrait

     */
    public function setAward($award)
    {
        $this->_award = $award;
        return $this;
    }

    private $_birthDate;

    /**
     * @return string
     */
    public function getBirthDate()
    {
        return $this->_birthDate;
    }

    /**
     * Date of birth.
     *
     * @param DateValue $birthDate
     * @return PersonTrait

     */
    public function setBirthDate(DateValue $birthDate)
    {
        $this->_birthDate = $birthDate->getValue();
        return $this;
    }

    private $_birthPlace;

    /**
     * @return Place
     */
    public function getBirthPlace()
    {
        return $this->_birthPlace;
    }

    /**
     * The place where the person was born.
     *
     * @param Place $birthPlace
     * @return PersonTrait

     */
    public function setBirthPlace($birthPlace)
    {
        $this->_birthPlace = $birthPlace;
        return $this;
    }

    private $_brand;

    /**
     * @return Brand|Organization
     */
    public function getBrand()
    {
        return $this->_brand;
    }

    /**
     * The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.
     *
     * @param Brand|Organization $brand
     * @return PersonTrait

     */
    public function setBrand($brand)
    {
        $this->_brand = $brand;
        return $this;
    }

    private $_children;

    /**
     * @return Person
     */
    public function getChildren()
    {
        return $this->_children;
    }

    /**
     * A child of the person.
     *
     * @param Person $children
     * @return PersonTrait

     */
    public function setChildren(Person $children)
    {
        $this->_children = $children;
        return $this;
    }

    private $_colleague;

    /**
     * @return Person
     */
    public function getColleague()
    {
        return $this->_colleague;
    }

    /**
     * A colleague of the person.
     *
     * Supersedes colleagues.
     *
     * @param Person $colleague
     * @return PersonTrait

     */
    public function setColleague(Person $colleague)
    {
        $this->_colleague = $colleague;
        return $this;
    }

    private $_contactPoint;

    /**
     * @return ContactPoint
     */
    public function getContactPoint()
    {
        return $this->_contactPoint;
    }

    /**
     * A contact point for a person or organization.
     *
     * Supersedes contactPoints.
     *
     * @param ContactPoint $contactPoint
     * @return PersonTrait

     */
    public function setContactPoint(ContactPoint $contactPoint)
    {
        $this->_contactPoint = $contactPoint;
        return $this;
    }

    private $_deathDate;

    /**
     * @return string
     */
    public function getDeathDate()
    {
        return $this->_deathDate;
    }

    /**
     * Date of death.
     *
     * @param DateValue $deathDate
     * @return PersonTrait

     */
    public function setDeathDate(DateValue $deathDate)
    {
        $this->_deathDate = $deathDate->getValue();
        return $this;
    }

    private $_deathPlace;

    /**
     * @return Place
     */
    public function getDeathPlace()
    {
        return $this->_deathPlace;
    }

    /**
     * The place where the person died.
     *
     * @param Place $deathPlace
     * @return PersonTrait

     */
    public function setDeathPlace(Place $deathPlace)
    {
        $this->_deathPlace = $deathPlace;
        return $this;
    }

    private $_duns;

    /**
     * @return string
     */
    public function getDuns()
    {
        return $this->_duns;
    }

    /**
     * The Dun & Bradstreet DUNS number for identifying an organization or business person.
     *
     * @param string $duns
     * @return PersonTrait

     */
    public function setDuns(Person $duns)
    {
        $this->_duns = $duns;
        return $this;
    }

    private $_email;

    /**
     * @return string
     */
    public function getEmail()
    {
        return $this->_email;
    }

    /**
     * Email address.
     *
     * @param string $email
     * @return PersonTrait

     */
    public function setEmail($email)
    {
        $this->_email = $email;
        return $this;
    }

    private $_familyName;

    /**
     * @return string
     */
    public function getFamilyName()
    {
        return $this->_familyName;
    }

    /**
     * Family name. In the U.S., the last name of an Person.
     * This can be used along with givenName instead of the name property.
     *
     * @param string $familyName
     * @return PersonTrait

     */
    public function setFamilyName($familyName)
    {
        $this->_familyName = $familyName;
        return $this;
    }

    private $_faxNumber;

    /**
     * @return string
     */
    public function getFaxNumber()
    {
        return $this->_faxNumber;
    }

    /**
     * The fax number.
     *
     * @param string $faxNumber
     * @return PersonTrait

     */
    public function setFaxNumber($faxNumber)
    {
        $this->_faxNumber = $faxNumber;
        return $this;
    }

    private $_follows;

    /**
     * @return Person
     */
    public function getFollows()
    {
        return $this->_follows;
    }

    /**
     * The most generic uni-directional social relation.
     *
     * @param Person $follows
     * @return PersonTrait

     */
    public function setFollows(Person $follows)
    {
        $this->_follows = $follows;
        return $this;
    }

    private $_funder;

    /**
     * @return Organization|Person
     */
    public function getFunder()
    {
        return $this->_funder;
    }

    /**
     * A person or organization that supports (sponsors) something through some kind of financial contribution.
     *
     * @param Organization|Person $funder
     * @return PersonTrait

     */
    public function setFunder($funder)

    {
        ObjectHelper::instanceOf($funder, [Organization::class, PersonInterface::class]);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        
        $this->_funder = $funder;
        return $this;
    }

    private $_gender;

    /**
     * @return GenderType|string
     */
    public function getGender()
    {
        return $this->_gender;
    }

    /**
     * Gender of the person. While http://schema.org/Male and http://schema.org/Female may be used,
     * text strings are also acceptable for people who do not identify as a binary gender.
     *
     * @param GenderType|string $gender
     * @return PersonTrait

     */
    public function setGender($gender)
    {
        $this->_gender = $gender;
        return $this;
    }

    private $_givenName;

    /**
     * @return string
     */
    public function getGivenName()
    {
        return $this->_givenName;
    }

    /**
     * Given name. In the U.S., the first name of a Person.
     * This can be used along with familyName instead of the name property.
     *
     * @param string $givenName
     * @return PersonTrait

     */
    public function setGivenName($givenName)
    {
        $this->_givenName = $givenName;
        return $this;
    }

    private $_globalLocationNumber;

    /**
     * @return string
     */
    public function getGlobalLocationNumber()
    {
        return $this->_globalLocationNumber;
    }

    /**
     * The Global Location Number (GLN, sometimes also referred to as International Location Number or ILN)
     * of the respective organization, person, or place.
     * The GLN is a 13-digit number used to identify parties and physical locations.
     *
     * @param string $globalLocationNumber
     * @return PersonTrait

     */
    public function setGlobalLocationNumber($globalLocationNumber)
    {
        $this->_globalLocationNumber = $globalLocationNumber;
        return $this;
    }

    private $_hasPOS;

    /**
     * @return Place
     */
    public function getHasPOS()
    {
        return $this->_hasPOS;
    }

    /**
     * Points-of-Sales operated by the organization or person.
     *
     * @param Place $hasPOS
     * @return PersonTrait

     */
    public function setHasPOS($hasPOS)
    {
        $this->_hasPOS = $hasPOS;
        return $this;
    }

    private $_height;

    /**
     * @return Distance|QuantitativeValue
     */
    public function getHeight()
    {
        return $this->_height;
    }

    /**
     * The height of the item.
     *
     * @param Distance|QuantitativeValue $height
     * @return PersonTrait

     */
    public function setHeight($height)
    {
        $this->_height = $height;
        return $this;
    }

    private $_homeLocation;

    /**
     * @return ContactPoint|Place
     */
    public function getHomeLocation()
    {
        return $this->_homeLocation;
    }

    /**
     * A contact location for a person's residence.
     *
     * @param ContactPoint|Place $homeLocation
     * @return PersonTrait

     */
    public function setHomeLocation($homeLocation)
    {
        $this->_homeLocation = $homeLocation;
        return $this;
    }

    private $_honorificPrefix;

    /**
     * @return string
     */
    public function getHonorificPrefix()
    {
        return $this->_honorificPrefix;
    }

    /**
     * An honorific prefix preceding a Person's name such as Dr/Mrs/Mr.
     *
     * @param string $honorificPrefix
     * @return PersonTrait

     */
    public function setHonorificPrefix($honorificPrefix)
    {
        $this->_honorificPrefix = $honorificPrefix;
        return $this;
    }

    private $_honorificSuffix;

    /**
     * @return string
     */
    public function getHonorificSuffix()
    {
        return $this->_honorificSuffix;
    }

    /**
     * An honorific suffix preceding a Person's name such as M.D. /PhD/MSCSW.
     *
     * @param string $honorificSuffix
     * @return PersonTrait

     */
    public function setHonorificSuffix($honorificSuffix)
    {
        $this->_honorificSuffix = $honorificSuffix;
        return $this;
    }

    private $_isicV4;

    /**
     * @return string
     */
    public function getIsicV4()
    {
        return $this->_isicV4;
    }

    /**
     * The International Standard of Industrial Classification of All Economic Activities (ISIC),
     * Revision 4 code for a particular organization, business person, or place.
     *
     * @param string $isicV4
     * @return PersonTrait

     */
    public function setIsicV4($isicV4)
    {
        $this->_isicV4 = $isicV4;
        return $this;
    }

    private $_jobTitle;

    /**
     * @return string
     */
    public function getJobTitle()
    {
        return $this->_jobTitle;
    }

    /**
     * The job title of the person (for example, Financial Manager).
     *
     * @param string $jobTitle
     * @return PersonTrait

     */
    public function setJobTitle($jobTitle)
    {
        $this->_jobTitle = $jobTitle;
        return $this;
    }

    private $_knows;

    /**
     * @return Person
     */
    public function getKnows()
    {
        return $this->_knows;
    }

    /**
     * The most generic bi-directional social/work relation.
     *
     * @param Person $knows
     * @return PersonTrait

     */
    public function setKnows(Person $knows)
    {
        $this->_knows = $knows;
        return $this;
    }

    private $_makesOffer;

    /**
     * @return Offer
     */
    public function getMakesOffer()
    {
        return $this->_makesOffer;
    }

    /**
     * A pointer to products or services offered by the organization or person.
     * Inverse property: offeredBy.
     *
     * @param Offer $makesOffer
     * @return PersonTrait

     */
    public function setMakesOffer(Offer $makesOffer)
    {
        $this->_makesOffer = $makesOffer;
        return $this;
    }

    private $_memberOf;

    /**
     * @return Organization|ProgramMembership
     */
    public function getMemberOf()
    {
        return $this->_memberOf;
    }

    /**
     * An Organization (or ProgramMembership) to which this Person or Organization belongs.
     * Inverse property: member.
     *
     * @param Organization|ProgramMembership $memberOf
     * @return PersonTrait

     */
    public function setMemberOf($memberOf)
    {
        $this->_memberOf = $memberOf;
        return $this;
    }

    private $_naics;

    /**
     * @return string
     */
    public function getNaics()
    {
        return $this->_naics;
    }

    /**
     * The North American Industry Classification System (NAICS) code for a particular organization or business person.
     *
     * @param string $naics
     * @return PersonTrait

     */
    public function setNaics($naics)
    {
        $this->_naics = $naics;
        return $this;
    }

    private $_nationality;

    /**
     * @return Country
     */
    public function getNationality()
    {
        return $this->_nationality;
    }

    /**
     * Nationality of the person.
     *
     * @param Country $nationality
     * @return PersonTrait

     */
    public function setNationality(Country $nationality)
    {
        $this->_nationality = $nationality;
        return $this;
    }

    private $_parent;

    /**
     * @return Person
     */
    public function getParent()
    {
        return $this->_parent;
    }

    /**
     * A parent of this person. Supersedes parents.
     *
     * @param Person $parent
     * @return PersonTrait

     */
    public function setParent(Person $parent)
    {
        $this->_parent = $parent;
        return $this;
    }

    private $_performerIn;

    /**
     * @return Event
     */
    public function getPerformerIn()
    {
        return $this->_performerIn;
    }

    /**
     * Event that this person is a performer or participant in.
     *
     * @param Event $performerIn
     * @return PersonTrait

     */
    public function setPerformerIn(Event $performerIn)
    {
        $this->_performerIn = $performerIn;
        return $this;
    }

    private $_publishingPrinciples;

    /**
     * @return CreativeWork|URL
     */
    public function getPublishingPrinciples()
    {
        return $this->_publishingPrinciples;
    }

    /**
     * The publishingPrinciples property indicates (typically via URL) a document describing the editorial principles
     * of an Organization (or individual e.g. a Person writing a blog) that relate to their activities as a publisher,
     * e.g. ethics or diversity policies. When applied to a CreativeWork (e.g. NewsArticle) the principles are those
     * of the party primarily responsible for the creation of the CreativeWork.
     *
     * While such policies are most typically expressed in natural language, sometimes related information
     * (e.g. indicating a funder) can be expressed using schema.org terminology.
     *
     * @param CreativeWork|URL $publishingPrinciples
     * @return PersonTrait

     */
    public function setPublishingPrinciples($publishingPrinciples)
    {
        $this->_publishingPrinciples = $publishingPrinciples;
        return $this;
    }

    private $_relatedTo;

    /**
     * @return Person
     */
    public function getRelatedTo()
    {
        return $this->_relatedTo;
    }

    /**
     * The most generic familial relation.
     *
     * @param Person $relatedTo
     * @return PersonTrait

     */
    public function setRelatedTo(Person $relatedTo)
    {
        $this->_relatedTo = $relatedTo;
        return $this;
    }

    private $_sibling;

    /**
     * @return Person
     */
    public function getSibling()
    {
        return $this->_sibling;
    }

    /**
     * A sibling of the person. Supersedes siblings.
     *
     * @param Person $sibling
     * @return PersonTrait

     */
    public function setSibling(Person $sibling)
    {
        $this->_sibling = $sibling;
        return $this;
    }

    private $_sponsor;

    /**
     * @return Organization|Person
     */
    public function getSponsor()
    {
        return $this->_sponsor;
    }

    /**
     * A person or organization that supports a thing through a pledge, promise, or financial contribution.
     * e.g. a sponsor of a Medical Study or a corporate sponsor of an event.
     *
     * @param Organization|Person $sponsor
     * @return PersonTrait

     */
    public function setSponsor($sponsor)

    {
        ObjectHelper::instanceOf($sponsor, [Organization::class, PersonInterface::class]);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        
        $this->_sponsor = $sponsor;
        return $this;
    }

    private $_spouse;

    /**
     * @return Person
     */
    public function getSpouse()
    {
        return $this->_spouse;
    }

    /**
     * The person's spouse.
     *
     * @param Person $spouse
     * @return PersonTrait

     */
    public function setSpouse(Person $spouse)
    {
        $this->_spouse = $spouse;
        return $this;
    }

    private $_taxID;

    /**
     * @return string
     */
    public function getTaxID()
    {
        return $this->_taxID;
    }

    /**
     * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in Spain.
     *
     * @param string $taxID
     * @return PersonTrait

     */
    public function setTaxID($taxID)
    {
        $this->_taxID = $taxID;
        return $this;
    }

    private $_telephone;

    /**
     * @return string
     */
    public function getTelephone()
    {
        return $this->_telephone;
    }

    /**
     * The telephone number.
     *
     * @param string $telephone
     * @return PersonTrait

     */
    public function setTelephone($telephone)
    {
        $this->_telephone = $telephone;
        return $this;
    }

    private $_vatID;

    /**
     * @return string
     */
    public function getVatID()
    {
        return $this->_vatID;
    }

    /**
     * The Value-added Tax ID of the organization or person.
     *
     * @param string $vatID
     * @return PersonTrait

     */
    public function setVatID($vatID)
    {
        $this->_vatID = $vatID;
        return $this;
    }

    private $_workLocation;

    /**
     * @return ContactPoint|Place
     */
    public function getWorkLocation()
    {
        return $this->_workLocation;
    }

    /**
     * A contact location for a person's place of work.
     *
     * @param ContactPoint|Place $workLocation
     * @return PersonTrait

     */
    public function setWorkLocation($workLocation)
    {
        $this->_workLocation = $workLocation;
        return $this;
    }

    private $_worksFor;

    /**
     * @return Organization
     */
    public function getWorksFor()
    {
        return $this->_worksFor;
    }

    /**
     * Organizations that the person works for.
     *
     * @param Organization $worksFor
     * @return PersonTrait

     */
    public function setWorksFor(Organization $worksFor)
    {
        $this->_worksFor = $worksFor;
        return $this;
    }
}


1			<?php
2
3			namespace luya\web\jsonld;
4
5			use luya\helpers\ObjectHelper;
6
7			/**
8			* JsonLd - Person trait
9			*
10			* @see http://schema.org/Person
11			*
12			* @author Alex Schmid
13			* @since 1.0.0
14			*/
15			trait PersonTrait
16			{
17			private $_additionalName;
18
19			/**
20			* @return string
21			*/
22			public function getAdditionalName()
23			{
24			return $this->_additionalName;
25			}
26
27			/**
28			* An additional name for a Person, can be used for a middle name.
29			*
30			* @param string $additionalName
31			* @return PersonTrait
			0 ignored issues – show Comprehensibility Bug introduced 2017-11-14 22:36 UTC by Report Bug Copy Issue Report The return type `PersonTrait` is a trait, and thus cannot be used for type-hinting in PHP. Maybe consider adding an interface and use that for type-hinting? In PHP traits cannot be used for type-hinting as they do not define a well-defined structure. This is because any class that uses a trait can rename that trait’s methods. If you would like to return an object that has a guaranteed set of methods, you could create a companion interface that lists these methods explicitly. Loading history...
32			*/
33			public function setAdditionalName($additionalName)
34			{
35			$this->_additionalName = $additionalName;
36			return $this;
37			}
38
39			private $_address;

luyadev / luya