Contract::getStatus() - Code Metrics - Inspection of "Update" - ControleOnline/api-platform-contract - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 2c40af...4ae8e0 )

by Luiz Kim

created 2024-09-13 22:15 UTC

Contract::getStatus() A

↳ Parent: Contract

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace ControleOnline\Entity;

use ApiPlatform\Metadata\GetCollection;
filter:
    dependency_paths: ["lib/*"]
use ApiPlatform\Metadata\Post;
filter:
    dependency_paths: ["lib/*"]
use ApiPlatform\Metadata\Put;
filter:
    dependency_paths: ["lib/*"]
use ApiPlatform\Metadata\Get;
filter:
    dependency_paths: ["lib/*"]
use ApiPlatform\Doctrine\Orm\Filter\SearchFilter;
filter:
    dependency_paths: ["lib/*"]
use ApiPlatform\Metadata\ApiResource;
filter:
    dependency_paths: ["lib/*"]
use ApiPlatform\Metadata\ApiProperty;
filter:
    dependency_paths: ["lib/*"]
use ApiPlatform\Metadata\ApiFilter;
filter:
    dependency_paths: ["lib/*"]
use DateTime;
use Doctrine\Common\Collections\Collection;
filter:
    dependency_paths: ["lib/*"]
use Doctrine\ORM\Mapping as ORM;
filter:
    dependency_paths: ["lib/*"]
use Symfony\Component\Serializer\Annotation\Groups;
filter:
    dependency_paths: ["lib/*"]

/**
 * @ORM\EntityListeners ({ControleOnline\Listener\LogListener::class})
 * @ORM\Entity (repositoryClass="ControleOnline\Repository\ContractRepository")
 */
#[ApiResource(
    operations: [
        new Get(security: 'is_granted(\'ROLE_CLIENT\')'),
        new Put(
            security: 'is_granted(\'ROLE_CLIENT\')',
            uriTemplate: '/contracts/{id}/change/payment',
            controller: \App\Controller\ChangeContractPaymentAction::class
        ),
        new Put(
            security: 'is_granted(\'ROLE_CLIENT\')',
            uriTemplate: '/contracts/{id}/change',
            controller: \App\Controller\ChangeContractAction::class
        ),
        new Put(
            uriTemplate: 'contracts/{id}/status/{status}',
            controller: \App\Controller\ChangeContractStatusAction::class,
            openapiContext: []
        ),
        new Post(),
        new GetCollection()
    ],
    formats: ['jsonld', 'json', 'html', 'jsonhal', 'csv' => ['text/csv']]
)]
class Contract
{
    /**
     * @ORM\Column(type="integer", nullable=false)
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="IDENTITY")
     * @Groups({"contract_people:read","logistic_read"})
     */
    private $id;
    /**
     * @ORM\ManyToOne(targetEntity="ControleOnline\Entity\File")
     * @ORM\JoinColumns({
     *   @ORM\JoinColumn(referencedColumnName="id", nullable=false)
     * })
     */
    private $contractModel;
    /**
     * @var \ControleOnline\Entity\Status
filter:
    dependency_paths: ["lib/*"]
     *
     * @ORM\ManyToOne(targetEntity="ControleOnline\Entity\Status")
     * @ORM\JoinColumns({
     *   @ORM\JoinColumn(name="status_id", referencedColumnName="id")
     * })
     * @Groups({"display_read","order_read","order_write"})
     */
    #[ApiFilter(filterClass: SearchFilter::class, properties: ['status' => 'exact'])]

    private $status;
    //, columnDefinition="enum('Active', 'Canceled', 'Amended')"
    /**
     * @ORM\Column(name="doc_key", type="string")
     * @Groups("contract_people:read")
     */
    private $doc_key;
    /**
     * @ORM\Column(name="start_date", type="datetime",  nullable=false)
     * @Groups("contract_people:read")
     */
    private $startDate;
    /**
     * @ORM\Column(name="end_date", type="datetime",  nullable=false)
     * @Groups("contract_people:read")
     */
    private $endDate;
    /**
     * @ORM\Column(name="creation_date", type="datetime",  nullable=false)
     */
    private $creationDate;
    /**
     * @ORM\Column(name="alter_date", type="datetime",  nullable=false)
     */
    private $alterDate;
    /**
     * @ORM\ManyToOne(targetEntity="ControleOnline\Entity\File")
     * @ORM\JoinColumns({
     *   @ORM\JoinColumn(name="contract_parent_id", referencedColumnName="id", nullable=true)
     * })
     */
    private $contractParent;
    /**
     * Many Contracts have Many Peoples.
     *
     * @ORM\ManyToMany(targetEntity="ControleOnline\Entity\People")
     * @ORM\JoinTable(name="contract_people",
     *      joinColumns={@ORM\JoinColumn(name="contract_id", referencedColumnName="id")},
     *      inverseJoinColumns={@ORM\JoinColumn(name="people_id", referencedColumnName="id")}
     *      )
     */
    private $peoples;


    public function __construct()
    {
        $this->startDate = new DateTime('now');
        $this->endDate = new DateTime('now');
        $this->creationDate = new DateTime('now');
        $this->alterDate = new DateTime('now');
    }
    public function getId(): int
    {
        return $this->id;
    }
    public function getFile(): File
filter:
    dependency_paths: ["lib/*"]
    {
        return $this->contractModel;
    }
    public function setFile(File $document_model): Contract
    {
        $this->contractModel = $document_model;
        return $this;
    }
    public function getKey(): ?string
    {
        return $this->doc_key;
    }
    public function setKey(string $doc_key): Contract
    {
        $this->doc_key = $doc_key;
        return $this;
    }

    /**
     * Set status
     *
     * @param \ControleOnline\Entity\Status $status
     * @return Order
filter:
    dependency_paths: ["lib/*"]
     */
    public function setStatus(\ControleOnline\Entity\Status $status = null)
    {
        $this->status = $status;

        return $this;

    }

    /**
     * Get status
     *
     * @return \ControleOnline\Entity\Status
     */
    public function getStatus()
    {
        return $this->status;
    }

    public function getStartDate(): DateTime
    {
        return $this->startDate;
    }
    public function setStartDate(DateTime $start_date): Contract
    {
        $this->startDate = $start_date;
        return $this;
    }
    public function getEndDate(): ?DateTime
    {
        return $this->endDate;
    }
    public function setEndDate(DateTime $end_date): Contract
    {
        $this->endDate = $end_date;
        return $this;
    }
    public function getCreationDate(): DateTime
    {
        return $this->creationDate;
    }
    public function setCreationDate(DateTime $creation_date): Contract
    {
        $this->creationDate = $creation_date;
        return $this;
    }
    public function getAlterDate(): DateTime
    {
        return $this->alterDate;
    }
    public function setAlterDate(DateTime $alter_date): Contract
    {
        $this->alterDate = $alter_date;
        return $this;
    }
    /**
     * @return mixed
     */
    public function getContractParent()
    {
        return $this->contractParent;
    }
    public function setContractParentId(Contract $contractParent): Contract
    {
        $this->contractParent = $contractParent;
        return $this;
    }
    public function getPeoples(): Collection
    {
        return $this->peoples;
    }
}


1			<?php
2
3			namespace ControleOnline\Entity;
4
5			use ApiPlatform\Metadata\GetCollection;
			0 ignored issues – show Bug introduced 2024-07-06 20:51 UTC by Report Bug Copy Issue Report The type `ApiPlatform\Metadata\GetCollection` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
6			use ApiPlatform\Metadata\Post;
			0 ignored issues – show Bug introduced 2024-07-06 20:51 UTC by Report Bug Copy Issue Report The type `ApiPlatform\Metadata\Post` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
7			use ApiPlatform\Metadata\Put;
			0 ignored issues – show Bug introduced 2024-07-06 20:51 UTC by Report Bug Copy Issue Report The type `ApiPlatform\Metadata\Put` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
8			use ApiPlatform\Metadata\Get;
			0 ignored issues – show Bug introduced 2024-07-06 20:51 UTC by Report Bug Copy Issue Report The type `ApiPlatform\Metadata\Get` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
9			use ApiPlatform\Doctrine\Orm\Filter\SearchFilter;
			0 ignored issues – show Bug introduced 2024-09-13 22:27 UTC by Report Bug Copy Issue Report The type `ApiPlatform\Doctrine\Orm\Filter\SearchFilter` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
10			use ApiPlatform\Metadata\ApiResource;
			0 ignored issues – show Bug introduced 2024-07-06 20:51 UTC by Report Bug Copy Issue Report The type `ApiPlatform\Metadata\ApiResource` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
11			use ApiPlatform\Metadata\ApiProperty;
			0 ignored issues – show Bug introduced 2024-07-06 20:51 UTC by Report Bug Copy Issue Report The type `ApiPlatform\Metadata\ApiProperty` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
12			use ApiPlatform\Metadata\ApiFilter;
			0 ignored issues – show Bug introduced 2024-07-06 20:51 UTC by Report Bug Copy Issue Report The type `ApiPlatform\Metadata\ApiFilter` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
13			use DateTime;
14			use Doctrine\Common\Collections\Collection;
			0 ignored issues – show Bug introduced 2024-07-06 20:51 UTC by Report Bug Copy Issue Report The type `Doctrine\Common\Collections\Collection` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
15			use Doctrine\ORM\Mapping as ORM;
			0 ignored issues – show Bug introduced 2024-07-06 20:51 UTC by Report Bug Copy Issue Report The type `Doctrine\ORM\Mapping` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
16			use Symfony\Component\Serializer\Annotation\Groups;
			0 ignored issues – show Bug introduced 2024-07-06 20:51 UTC by Report Bug Copy Issue Report The type `Symfony\Component\Serializer\Annotation\Groups` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
17
18			/**
19			* @ORM\EntityListeners ({ControleOnline\Listener\LogListener::class})
20			* @ORM\Entity (repositoryClass="ControleOnline\Repository\ContractRepository")
21			*/
22			#[ApiResource(
23			operations: [
24			new Get(security: 'is_granted(\'ROLE_CLIENT\')'),
25			new Put(
26			security: 'is_granted(\'ROLE_CLIENT\')',
27			uriTemplate: '/contracts/{id}/change/payment',
28			controller: \App\Controller\ChangeContractPaymentAction::class
29			),
30			new Put(
31			security: 'is_granted(\'ROLE_CLIENT\')',
32			uriTemplate: '/contracts/{id}/change',
33			controller: \App\Controller\ChangeContractAction::class
34			),
35			new Put(
36			uriTemplate: 'contracts/{id}/status/{status}',
37			controller: \App\Controller\ChangeContractStatusAction::class,
38			openapiContext: []
39			),
40			new Post(),
41			new GetCollection()
42			],
43			formats: ['jsonld', 'json', 'html', 'jsonhal', 'csv' => ['text/csv']]
44			)]
45			class Contract
46			{
47			/**
48			* @ORM\Column(type="integer", nullable=false)
49			* @ORM\Id
50			* @ORM\GeneratedValue(strategy="IDENTITY")
51			* @Groups({"contract_people:read","logistic_read"})
52			*/
53			private $id;
54			/**
55			* @ORM\ManyToOne(targetEntity="ControleOnline\Entity\File")
56			* @ORM\JoinColumns({
57			* @ORM\JoinColumn(referencedColumnName="id", nullable=false)
58			* })
59			*/
60			private $contractModel;
61			/**
62			* @var \ControleOnline\Entity\Status
			0 ignored issues – show Bug introduced 2024-09-13 22:27 UTC by Report Bug Copy Issue Report The type `ControleOnline\Entity\Status` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
63			*
64			* @ORM\ManyToOne(targetEntity="ControleOnline\Entity\Status")
65			* @ORM\JoinColumns({
66			* @ORM\JoinColumn(name="status_id", referencedColumnName="id")
67			* })
68			* @Groups({"display_read","order_read","order_write"})
69			*/
70			#[ApiFilter(filterClass: SearchFilter::class, properties: ['status' => 'exact'])]
71
72			private $status;
73			//, columnDefinition="enum('Active', 'Canceled', 'Amended')"
74			/**
75			* @ORM\Column(name="doc_key", type="string")
76			* @Groups("contract_people:read")
77			*/
78			private $doc_key;
79			/**
80			* @ORM\Column(name="start_date", type="datetime", nullable=false)
81			* @Groups("contract_people:read")
82			*/
83			private $startDate;
84			/**
85			* @ORM\Column(name="end_date", type="datetime", nullable=false)
86			* @Groups("contract_people:read")
87			*/
88			private $endDate;
89			/**
90			* @ORM\Column(name="creation_date", type="datetime", nullable=false)
91			*/
92			private $creationDate;
93			/**
94			* @ORM\Column(name="alter_date", type="datetime", nullable=false)
95			*/
96			private $alterDate;
97			/**
98			* @ORM\ManyToOne(targetEntity="ControleOnline\Entity\File")
99			* @ORM\JoinColumns({
100			* @ORM\JoinColumn(name="contract_parent_id", referencedColumnName="id", nullable=true)
101			* })
102			*/
103			private $contractParent;
104			/**
105			* Many Contracts have Many Peoples.
106			*
107			* @ORM\ManyToMany(targetEntity="ControleOnline\Entity\People")
108			* @ORM\JoinTable(name="contract_people",
109			* joinColumns={@ORM\JoinColumn(name="contract_id", referencedColumnName="id")},
110			* inverseJoinColumns={@ORM\JoinColumn(name="people_id", referencedColumnName="id")}
111			* )
112			*/
113			private $peoples;
114
115
116			public function __construct()
117			{
118			$this->startDate = new DateTime('now');
119			$this->endDate = new DateTime('now');
120			$this->creationDate = new DateTime('now');
121			$this->alterDate = new DateTime('now');
122			}
123			public function getId(): int
124			{
125			return $this->id;
126			}
127			public function getFile(): File
			0 ignored issues – show Bug introduced 2024-09-13 22:17 UTC by Report Bug Copy Issue Report The type `ControleOnline\Entity\File` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
128			{
129			return $this->contractModel;
130			}
131			public function setFile(File $document_model): Contract
132			{
133			$this->contractModel = $document_model;
134			return $this;
135			}
136			public function getKey(): ?string
137			{
138			return $this->doc_key;
139			}
140			public function setKey(string $doc_key): Contract
141			{
142			$this->doc_key = $doc_key;
143			return $this;
144			}
145
146			/**
147			* Set status
148			*
149			* @param \ControleOnline\Entity\Status $status
150			* @return Order
			0 ignored issues – show Bug introduced 2024-09-13 22:27 UTC by Report Bug Copy Issue Report The type `ControleOnline\Entity\Order` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
151			*/
152			public function setStatus(\ControleOnline\Entity\Status $status = null)
153			{
154			$this->status = $status;
155
156			return $this;
			0 ignored issues – show Bug Best Practice introduced 2024-09-13 22:27 UTC by Report Bug Copy Issue Report The expression `return $this` returns the type `ControleOnline\Entity\Contract` which is incompatible with the documented return type `ControleOnline\Entity\Order`. Loading history...
157			}
158
159			/**
160			* Get status
161			*
162			* @return \ControleOnline\Entity\Status
163			*/
164			public function getStatus()
165			{
166			return $this->status;
167			}
168
169			public function getStartDate(): DateTime
170			{
171			return $this->startDate;
172			}
173			public function setStartDate(DateTime $start_date): Contract
174			{
175			$this->startDate = $start_date;
176			return $this;
177			}
178			public function getEndDate(): ?DateTime
179			{
180			return $this->endDate;
181			}
182			public function setEndDate(DateTime $end_date): Contract
183			{
184			$this->endDate = $end_date;
185			return $this;
186			}
187			public function getCreationDate(): DateTime
188			{
189			return $this->creationDate;
190			}
191			public function setCreationDate(DateTime $creation_date): Contract
192			{
193			$this->creationDate = $creation_date;
194			return $this;
195			}
196			public function getAlterDate(): DateTime
197			{
198			return $this->alterDate;
199			}
200			public function setAlterDate(DateTime $alter_date): Contract
201			{
202			$this->alterDate = $alter_date;
203			return $this;
204			}
205			/**
206			* @return mixed
207			*/
208			public function getContractParent()
209			{
210			return $this->contractParent;
211			}
212			public function setContractParentId(Contract $contractParent): Contract
213			{
214			$this->contractParent = $contractParent;
215			return $this;
216			}
217			public function getPeoples(): Collection
218			{
219			return $this->peoples;
220			}
221			}
222

ControleOnline / api-platform-contract

Push — master ( 2c40af...4ae8e0 )

Contract::getStatus() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like