LoginCidadao\OAuthBundle\Entity\Client

Complexity

Total Complexity

64

Size/Duplication

Total Lines	543
Duplicated Lines	0 %

Coupling/Cohesion

Components	4
Dependencies	4

Test Coverage

Coverage

100%

Importance

Changes

0

43 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	1
A	getAllGrants()	0	11	1
A	getName()	0	14	4
A	setName()	0	9	2
A	getDescription()	0	4	1
A	setDescription()	0	6	1
A	getSiteUrl()	0	8	2
A	setSiteUrl()	0	9	2
A	setAuthorizations()	0	6	1
A	getAuthorizations()	0	4	1
A	removeAuthorization()	0	8	3
A	getLandingPageUrl()	0	8	2
A	setLandingPageUrl()	0	9	2
A	getTermsOfUseUrl()	0	8	2
A	setTermsOfUseUrl()	0	9	2
A	getAllowedScopes()	0	10	2
A	setAllowedScopes()	0	6	1
A	isVisible()	0	4	1
A	setVisible()	0	6	1
A	isPublished()	0	4	1
A	setPublished()	0	6	1
A	setId()	0	6	1
A	getOwners()	0	4	1
A	setOwners()	0	6	1
A	getUid()	0	4	1
A	setUid()	0	6	1
A	getClientId()	0	4	1
A	getClientSecret()	0	4	1
A	getMetadata()	0	4	1
A	setMetadata()	0	6	1
A	getRedirectUris()	0	8	2
A	setRedirectUris()	0	10	2
A	getImage()	0	4	1
A	setImage()	0	10	2
A	getImageName()	0	4	1
A	setImageName()	0	6	1
A	getUpdatedAt()	0	4	1
A	setUpdatedAt()	0	10	2
A	getAllowedGrantTypes()	0	8	2
A	ownsDomain()	0	11	3
A	getContacts()	0	13	2
A	getPublicId()	0	4	1
A	getClientUri()	0	4	1

<?php
/**
 * This file is part of the login-cidadao project or it's bundles.
 *
 * (c) Guilherme Donato <guilhermednt on github>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace LoginCidadao\OAuthBundle\Entity;

use LoginCidadao\CoreBundle\Entity\Authorization;
use FOS\OAuthServerBundle\Entity\Client as BaseClient;
use Doctrine\ORM\Mapping as ORM;
use LoginCidadao\CoreBundle\Model\PersonInterface;
use LoginCidadao\OpenIDBundle\Entity\ClientMetadata;
use LoginCidadao\RemoteClaimsBundle\Model\ClaimProviderInterface;
use Symfony\Component\HttpFoundation\File\File;
use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
use JMS\Serializer\Annotation as JMS;
use OAuth2\OAuth2;
use LoginCidadao\OAuthBundle\Model\ClientInterface;
use Vich\UploaderBundle\Mapping\Annotation as Vich;

/**
 * @ORM\Entity(repositoryClass="LoginCidadao\OAuthBundle\Entity\ClientRepository")
 * @ORM\Table(name="client")
 * @ORM\HasLifecycleCallbacks
 * @UniqueEntity("name")
 * @JMS\ExclusionPolicy("all")
 * @Vich\Uploadable
 */
class Client extends BaseClient implements ClientInterface, ClaimProviderInterface
{
    /**
     * @ORM\Id
     * @ORM\Column(type="integer")
     * @ORM\GeneratedValue(strategy="AUTO")
     * @JMS\Expose
     * @JMS\Groups({"public"})
     */
    protected $id;

    /**
     * @ORM\Column(type="string", nullable=false, unique=true)
     * @JMS\Expose
     * @JMS\SerializedName("client_name")
     * @JMS\Groups({"public", "remote_claim"})
     */
    protected $name;

    /**
     * @ORM\Column(type="string", length=4000, nullable=true)
     * @JMS\Expose
     * @JMS\Groups({"public"})
     */
    protected $description;

    /**
     * @ORM\Column(type="string", length=2000, nullable=true)
     * @JMS\Expose
     * @JMS\Groups({"public"})
     */
    protected $landingPageUrl;

    /**
     * @ORM\Column(type="string", length=2000, nullable=true)
     * @JMS\Expose
     * @JMS\Groups({"public"})
     */
    protected $termsOfUseUrl;

    /**
     * @ORM\Column(type="json_array", nullable=false)
     */
    protected $allowedScopes;

    /**
     * @ORM\OneToMany(targetEntity="LoginCidadao\CoreBundle\Entity\Authorization", mappedBy="client", cascade={"remove"}, orphanRemoval=true)
     * @var Authorization[]
     */
    protected $authorizations;

    /**
     * @ORM\Column(type="string", length=2000, nullable=true)
     * @JMS\Expose
     * @JMS\Groups({"public"})
     */
    protected $siteUrl;

    /**
     * @Assert\File(
     *      maxSize="2M",
     *      maxSizeMessage="The maxmimum allowed file size is 2MB.",
     *      mimeTypes={"image/png", "image/jpeg", "image/pjpeg"},
     *      mimeTypesMessage="Only JPEG and PNG images are allowed."
     * )
     * @Vich\UploadableField(mapping="client_image", fileNameProperty="imageName")
     * @var File $image
     * @JMS\Since("1.0.2")
     */
    protected $image;

    /**
     * @ORM\Column(type="string", length=255, name="image_name", nullable=true)
     *
     * @var string $imageName
     * @JMS\Since("1.0.2")
     */
    protected $imageName;

    /**
     * @ORM\Column(type="boolean", nullable=false)
     * @JMS\Expose
     * @JMS\Groups({"public"})
     */
    protected $published;

    /**
     * @ORM\Column(type="boolean", nullable=false)
     * @JMS\Expose
     * @JMS\Groups({"public"})
     */
    protected $visible;

    /**
     * @ORM\ManyToMany(targetEntity="LoginCidadao\CoreBundle\Entity\Person", inversedBy="clients"  )
     * @ORM\JoinTable(name="client_owners",
     *      joinColumns={@ORM\JoinColumn(name="person_id", referencedColumnName="id")},
     *      inverseJoinColumns={@ORM\JoinColumn(name="client_id", referencedColumnName="id")}
     *      )
     * @var PersonInterface[]
     */
    protected $owners;

    /**
     * @ORM\OneToMany(targetEntity="LoginCidadao\APIBundle\Entity\LogoutKey", mappedBy="client")
     */
    protected $logoutKeys;

    /**
     * @var \LoginCidadao\OpenIDBundle\Entity\ClientMetadata
     * @ORM\OneToOne(targetEntity="LoginCidadao\OpenIDBundle\Entity\ClientMetadata", mappedBy="client", cascade={"persist"})
     */
    protected $metadata;

    /**
     * @ORM\Column(name="updated_at", type="datetime")
     */
    protected $updatedAt;
    /**
     * @ORM\Column(type="string", nullable=true, unique=true)
     * @var string
     */
    private $uid;

    public function __construct()
    {
        parent::__construct();
        $this->authorizations = [];
        $this->owners = [];

        $this->allowedScopes = array(
            'public_profile',
            'openid',
        );
    }

    public static function getAllGrants()
    {
        return array(
            OAuth2::GRANT_TYPE_AUTH_CODE,
            OAuth2::GRANT_TYPE_IMPLICIT,
            OAuth2::GRANT_TYPE_USER_CREDENTIALS,
            OAuth2::GRANT_TYPE_CLIENT_CREDENTIALS,
            OAuth2::GRANT_TYPE_REFRESH_TOKEN,
            OAuth2::GRANT_TYPE_EXTENSIONS,
        );
    }

    /**
     * @return string
     */
    public function getName()
    {
        if ($this->getMetadata()) {
            if ($this->getMetadata()->getClientName() === null &&
                $this->name !== null
            ) {
                $this->getMetadata()->setClientName($this->name);
            }

            return $this->getMetadata()->getClientName();
        }

        return $this->name;
    }

    public function setName($name)
    {
        if ($this->getMetadata()) {
            $this->getMetadata()->setClientName($name);
        }
        $this->name = $name;

        return $this;
    }

    public function getDescription()

The return type could not be reliably inferred; please add a @return annotation.

    {
        return $this->description;
    }

    public function setDescription($description)
    {
        $this->description = $description;

        return $this;
    }

    public function getSiteUrl()

The return type could not be reliably inferred; please add a @return annotation.

    {
        if ($this->getMetadata()) {
            return $this->getMetadata()->getClientUri();
        }

        return $this->siteUrl;
    }

    public function setSiteUrl($url)
    {
        if ($this->getMetadata()) {
            $this->getMetadata()->setClientUri($url);
        }
        $this->siteUrl = $url;

        return $this;
    }

    /**
     * @param array|Authorization[] $authorizations
     * @return $this
     */
    public function setAuthorizations($authorizations = [])
    {
        $this->authorizations = $authorizations;

        return $this;
    }

    /**
     * @return array|Authorization[]

Consider making the return type a bit more specific; maybe use Authorization[].

     */
    public function getAuthorizations()
    {
        return $this->authorizations;
    }

    /**
     * @param Authorization $authorization
     */
    public function removeAuthorization(Authorization $authorization)
    {
        foreach ($this->authorizations as $k => $candidate) {
            if ($candidate->getId() === $authorization->getId()) {
                unset($this->authorizations[$k]);
            }
        }
    }

    public function getLandingPageUrl()

The return type could not be reliably inferred; please add a @return annotation.

    {
        if ($this->getMetadata()) {
            return $this->getMetadata()->getInitiateLoginUri();
        }

        return $this->landingPageUrl;
    }

    public function setLandingPageUrl($landingPageUrl)
    {
        if ($this->getMetadata()) {
            $this->getMetadata()->setInitiateLoginUri($landingPageUrl);
        }
        $this->landingPageUrl = $landingPageUrl;

        return $this;
    }

    public function getTermsOfUseUrl()

The return type could not be reliably inferred; please add a @return annotation.

    {
        if ($this->getMetadata()) {
            return $this->getMetadata()->getTosUri();
        }

        return $this->termsOfUseUrl;
    }

    public function setTermsOfUseUrl($termsOfUseUrl)
    {
        if ($this->getMetadata()) {
            $this->getMetadata()->setTosUri($termsOfUseUrl);
        }
        $this->termsOfUseUrl = $termsOfUseUrl;

        return $this;
    }

    public function getAllowedScopes()
    {
        $scopes = ['public_profile', 'openid'];

        if (is_array($this->allowedScopes)) {
            $scopes = $this->allowedScopes;
        }

        return $scopes;
    }

    public function setAllowedScopes(array $allowedScopes)
    {
        $this->allowedScopes = $allowedScopes;

        return $this;
    }

    public function isVisible()

The return type could not be reliably inferred; please add a @return annotation.

    {
        return $this->visible;
    }

    public function setVisible($visible)
    {
        $this->visible = $visible;

        return $this;
    }

    public function isPublished()

The return type could not be reliably inferred; please add a @return annotation.

    {
        return $this->published;
    }

    public function setPublished($published)
    {
        $this->published = $published;

        return $this;
    }

    public function setId($var)
    {
        $this->id = $var;

        return $this;
    }

    public function getOwners()
    {
        return $this->owners;
    }

    /* Unique Interface Stuff */

    public function setOwners($owners)
    {
        $this->owners = $owners;

        return $this;
    }

    /**
     * Gets the Unique Id of the Entity.
     * @return string the entity UID
     */
    public function getUid()
    {
        return $this->uid;
    }

    /**
     * Sets the Unique Id of the Entity.
     * @param string $uid the entity UID

Should the type for parameter $uid not be string|null?

     * @return $this
     */
    public function setUid($uid = null)
    {
        $this->uid = $uid;

        return $this;
    }

    /**
     * Compatibility with OIDC code
     */
    public function getClientId()
    {
        return $this->getPublicId();
    }

    /**
     * Compatibility with OIDC code
     */
    public function getClientSecret()
    {
        return $this->getSecret();
    }

    public function getMetadata()
    {
        return $this->metadata;
    }

    public function setMetadata(ClientMetadata $metadata)
    {
        $this->metadata = $metadata;

        return $this;
    }

    /**
     * @JMS\VirtualProperty()
     * @JMS\SerializedName("redirect_uris")
     * @JMS\Groups({"remote_claim"})
     * @return array|string[]
     */
    public function getRedirectUris()
    {
        if ($this->getMetadata()) {
            return $this->getMetadata()->getRedirectUris();
        }

        return parent::getRedirectUris();
    }

    public function setRedirectUris(array $redirectUris)
    {
        if ($this->getMetadata()) {
            $this->getMetadata()->setRedirectUris($redirectUris);
        } else {
            parent::setRedirectUris($redirectUris);
        }

        return $this;
    }

    /**
     * @return File
     */
    public function getImage()
    {
        return $this->image;
    }

    /**
     * If manually uploading a file (i.e. not using Symfony Form) ensure an instance
     * of 'UploadedFile' is injected into this setter to trigger the  update. If this
     * bundle's configuration parameter 'inject_on_load' is set to 'true' this setter
     * must be able to accept an instance of 'File' as the bundle will inject one here
     * during Doctrine hydration.
     *
     * @param File|\Symfony\Component\HttpFoundation\File\UploadedFile $image
     * @return $this
     */
    public function setImage($image)
    {
        $this->image = $image;

        if ($this->image) {
            $this->updatedAt = new \DateTime('now');
        }

        return $this;
    }

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

    /**
     * @param string $imageName
     * @return $this
     */
    public function setImageName($imageName)
    {
        $this->imageName = $imageName;

        return $this;
    }

    public function getUpdatedAt()
    {
        return $this->updatedAt;
    }

    /**
     * @ORM\PrePersist
     * @ORM\PreUpdate
     * @param \DateTime|null $updatedAt
     * @return $this
     */
    public function setUpdatedAt($updatedAt = null)
    {
        if ($updatedAt instanceof \DateTime) {
            $this->updatedAt = $updatedAt;
        } else {
            $this->updatedAt = new \DateTime('now');
        }

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getAllowedGrantTypes()
    {
        if ($this->getMetadata()) {
            return $this->getMetadata()->getGrantTypes();
        }

        return parent::getAllowedGrantTypes();
    }

    public function ownsDomain($domain)

function ownsDomain() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

    {
        foreach ($this->getRedirectUris() as $redirectUrl) {
            $host = parse_url($redirectUrl, PHP_URL_HOST);
            if ($host == $domain) {
                return true;
            }
        }

        return false;
    }

    public function getContacts()
    {
        if ($this->getMetadata()) {
            return $this->getMetadata()->getContacts();
        }

        return array_map(
            function (PersonInterface $owner) {
                return $owner->getEmail();
            },
            $this->getOwners()
        );
    }

    /**
     * @JMS\VirtualProperty()
     * @JMS\SerializedName("client_id")
     * @JMS\Groups({"remote_claim"})
     * @inheritDoc
     */
    public function getPublicId()
    {
        return parent::getPublicId();
    }

    /**
     * @JMS\VirtualProperty()
     * @JMS\SerializedName("client_uri")
     * @JMS\Groups({"remote_claim"})
     */
    public function getClientUri()

The return type could not be reliably inferred; please add a @return annotation.

    {
        return $this->getSiteUrl();
    }
}