Charge::frequency() - Code Metrics - ipagdevs/ipag-sdk-php - Measure and Improve Code Quality continuously with Scrutinizer

Charge::frequency() A
last analyzed 2025-10-31 19:56 UTC

↳ Parent: Charge

Complexity

Conditions	2
Paths	1

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace Ipag\Sdk\Model;

use Ipag\Sdk\Model\Schema\Mutator;
use Ipag\Sdk\Model\Schema\Schema;
use Ipag\Sdk\Model\Schema\SchemaBuilder;
use Kubinyete\Assertation\Assert;

/**
 * Charge Class
 *
 * Classe responsável por representar o recurso Charge.
 *
 */
final class Charge extends Model
{

    /**
     *  @param array $data
     *  array de dados do Charge.
     *
     *  + [`'amount'`] float.
     *  + [`'description'`] string.
     *  + [`'due_date'`] string (opcional) {`Formato: Y-m-d`}.
     *  + [`'frequency'`] int (opcional).
     *  + [`'interval'`] enum {`'day'` | `'week'` | `'month'`} (opcional).
     *  + [`'type'`] enum {`'charge'` | `'recurring'`} (opcional).
     *  + [`'last_charge_date'`] string (opcional).
     *  + [`'callback_url'`] string (opcional).
     *  + [`'auto_debit'`] bool (opcional).
     *  + [`'installments'`] int (opcional).
     *  + [`'is_active'`] bool (opcional).
     *  + [`'products'`] array[`int`, `int`, `int`, ...] (opcional).
     *  + [`'customer'`] array (opcional) dos dados do Customer.
     *  + &emsp; [`'name'`] string.
     *  + &emsp; [`'email'`] string.
     *  + &emsp; [`'phone'`] string.
     *  + &emsp; [`'cpf_cnpj'`] string.
     *  + [`'checkout_settings'`] array (opcional) dos dados do CheckoutSettings.
     *  + &emsp; [`'max_installments'`] int (opcional).
     *  + &emsp; [`'interest_free_installments'`] int (opcional).
     *  + &emsp; [`'min_installment_value'`] float (opcional).
     *  + &emsp; [`'interest'`] float (opcional).
     *  + &emsp; [`'fixed_installment'`] float (opcional).
     *  + &emsp; [`'payment_method'`] enum {`'all'` | `'creditcard'` | `'boleto'` | `'transfer'` | `'pix'`} (opcional).
     *
     */
    public function __construct(?array $data = [])
    {
        parent::__construct($data);
    }

    public function schema(SchemaBuilder $schema): Schema
    {
        $schema->float('amount')->nullable();
        $schema->string('description')->nullable();
        $schema->string('due_date')->nullable();
        $schema->int('frequency')->nullable();
        $schema->enum('interval', ['day', 'week', 'month'])->nullable();
        $schema->enum('type', ['charge', 'recurring'])->nullable();
        $schema->string('last_charge_date')->nullable();
        $schema->string('callback_url')->nullable();
        $schema->bool('auto_debit')->nullable();
        $schema->int('installments')->nullable();
        $schema->bool('is_active')->nullable();
        $schema->any('products')->nullable();

        $schema->has('customer', Customer::class)->nullable();

        $schema->has('checkout_settings', CheckoutSettings::class)->nullable();

        return $schema->build();
    }

    protected function amount(): Mutator
    {
        return new Mutator(
            null,
            fn($value, $ctx) =>
            is_null($value) ? $value :
            (
                Assert::value(floatval($value))->gte(0)->get()
                ?? $ctx->raise('inválido')
            )
        );
    }

    protected function due_date(): Mutator
    {
        return new Mutator(
            null,
            function ($value, $ctx) {
                $d = \DateTime::createFromFormat('Y-m-d', $value);

                return is_null($value) ||
                    ($d && $d->format('Y-m-d') === $value) ?
                    $value : $ctx->raise('inválido');
            }
        );
    }

    protected function frequency(): Mutator
    {
        return new Mutator(
            null,
            fn($value, $ctx) =>
            is_null($value) ? $value :
            (
                Assert::value(intval($value))->gt(0)->get()
                ?? $ctx->raise('inválido (informe um valor de 1 à 12)')
            )
        );
    }

    protected function last_charge_date(): Mutator
    {
        return new Mutator(
            null,
            function ($value, $ctx) {
                $d = \DateTime::createFromFormat('Y-m-d', $value);

                return is_null($value) ||
                    ($d && $d->format('Y-m-d') === $value) ?
                    $value : $ctx->raise('inválido');
            }
        );
    }

    protected function installments(): Mutator
    {
        return new Mutator(
            null,
            fn($value, $ctx) =>
            is_null($value) ? $value :
            (
                Assert::value(intval($value))->gt(0)->get()
                ?? $ctx->raise('inválido (informe um valor de 1 à 48)')
            )
        );
    }

    protected function products(): Mutator
    {
        return new Mutator(
            null,
            fn($value, $ctx) =>
            is_null($value) ? $value :
            (
                Assert::value($value)->array() ? $value :
                $ctx->raise('inválido (informe um array de ids (int) de produtos)')
            )
        );
    }

    /**
     * Retorna o valor da propriedade `amount`.
     *
     * @return float|null
     */
    public function getAmount(): ?float
    {
        return $this->get('amount');
    }

    /**
     * Seta o valor da propriedade `amount`.
     *
     * @param float|null $amount
     * @return self
     */
    public function setAmount(?float $amount = null): self
    {
        $this->set('amount', $amount);
        return $this;
    }

    /**
     * Retorna o valor da propriedade `description`.
     *
     * @return string|null
     */
    public function getDescription(): ?string
    {
        return $this->get('description');
    }

    /**
     * Seta o valor da propriedade `description`.
     *
     * @param string|null $description
     * @return self
     */
    public function setDescription(?string $description = null): self
    {
        $this->set('description', $description);
        return $this;
    }

    /**
     * Retorna o valor da propriedade `due_date`.
     *
     * @return string|null
     */
    public function getDueDate(): ?string
    {
        return $this->get('due_date');
    }

    /**
     * Seta o valor da propriedade `due_date`.
     *
     * @param string|null $due_date
     * @return self
     */
    public function setDueDate(?string $due_date = null): self
    {
        $this->set('due_date', $due_date);
        return $this;
    }

    /**
     * Retorna o valor da propriedade `frequency`.
     *
     * @return integer|null
     */
    public function getFrequency(): ?int
    {
        return $this->get('frequency');
    }

    /**
     * Seta o valor da propriedade `frequency`.
     *
     * @param integer|null $frequency
     * @return self
     */
    public function setFrequency(?int $frequency = null): self
    {
        $this->set('frequency', $frequency);
        return $this;
    }

    /**
     * Retorna o valor da propriedade `interval`.
     *
     * @return string|null
     */
    public function getInterval(): ?string
    {
        return $this->get('interval');
    }

    /**
     * Seta o valor da propriedade `interval`.
     *
     * @param string|null $interval
     * @return self
     */
    public function setInterval(?string $interval = null): self
    {
        $this->set('interval', $interval);
        return $this;
    }

    /**
     * Retorna o valor da propriedade `type`.
     *
     * @return string|null
     */
    public function getType(): ?string
    {
        return $this->get('type');
    }

    /**
     * Seta o valor da propriedade `type`.
     *
     * @param string|null $type
     * @return self
     */
    public function setType(?string $type = null): self
    {
        $this->set('type', $type);
        return $this;
    }

    /**
     * Retorna o valor da propriedade `last_charge_date`.
     *
     * @return string|null
     */
    public function getLastChargeDate(): ?string
    {
        return $this->get('last_charge_date');
    }

    /**
     * Seta o valor da propriedade `last_charge_date`.
     *
     * @param string|null $last_charge_date
     * @return self
     */
    public function setLastChargeDate(?string $last_charge_date = null): self
    {
        $this->set('last_charge_date', $last_charge_date);
        return $this;
    }

    /**
     * Retorna o valor da propriedade `callback_url`.
     *
     * @return string|null
     */
    public function getCallbackUrl(): ?string
    {
        return $this->get('callback_url');
    }

    /**
     * Seta o valor da propriedade `callback_url`.
     *
     * @param string|null $callback_url
     * @return self
     */
    public function setCallbackUrl(?string $callback_url = null): self
    {
        $this->set('callback_url', $callback_url);
        return $this;
    }

    /**
     * Retorna o valor da propriedade `auto_debit`.
     *
     * @return boolean|null
     */
    public function getAutoDebit(): ?bool
    {
        return $this->get('auto_debit');
    }

    /**
     * Seta o valor da propriedade `auto_debit`.
     *
     * @param boolean|null $auto_debit
     * @return self
     */
    public function setAutoDebit(?bool $auto_debit = null): self
    {
        $this->set('auto_debit', $auto_debit);
        return $this;
    }

    /**
     * Retorna o valor da propriedade `installments`.
     *
     * @return integer|null
     */
    public function getInstallments(): ?int
    {
        return $this->get('installments');
    }

    /**
     * Seta o valor da propriedade `installments`.
     *
     * @param integer|null $installments
     * @return self
     */
    public function setInstallments(?int $installments = null): self
    {
        $this->set('installments', $installments);
        return $this;
    }

    /**
     * Retorna o valor da propriedade `is_active`.
     *
     * @return boolean|null
     */
    public function getIsActive(): ?bool
    {
        return $this->get('is_active');
    }

    /**
     * Seta o valor da propriedade `is_active`.
     *
     * @param boolean|null $is_active
     * @return self
     */
    public function setIsActive(?bool $is_active = null): self
    {
        $this->set('is_active', $is_active);
        return $this;
    }

    /**
     * Retorna o array `Products_Ids` associado ao `Charge`.
     *
     * @return array|null
     */
    public function getProducts(): ?array
    {
        return $this->get('products');
    }

    /**
     * Seta o array `Products_Ids` associado ao `Charge`.
     *
     * @param array|null $products
     * @return self
     */
    public function setProducts(?array $products = null): self
    {
        $this->set('products', $products);
        return $this;
    }

    /**
     * Retorna o objeto `Customer` associado ao `Charge`.
     *
     * @return Customer|null
     */
    public function getCustomer(): ?Customer
    {
        return $this->get('customer');
    }

    /**
     * Seta o objeto `Customer` associado ao `Charge`.
     *
     * @param Customer|null $customer
     * @return self
     */
    public function setCustomer(?Customer $customer = null): self
    {
        $this->set('customer', $customer);
        return $this;
    }

    /**
     * Retorna o objeto `CheckoutSettings` associado ao `Charge`.
     *
     * @return CheckoutSettings|null
     */
    public function getCheckoutSettings(): ?CheckoutSettings
    {
        return $this->get('checkout_settings');
    }

    /**
     * Seta o objeto `CheckoutSettings` associado ao `Charge`.
     *
     * @param CheckoutSettings|null $checkout_settings
     * @return self
     */
    public function setCheckoutSettings(?CheckoutSettings $checkout_settings = null): self
    {
        $this->set('checkout_settings', $checkout_settings);
        return $this;
    }

}

1			<?php
2
3			namespace Ipag\Sdk\Model;
4
5			use Ipag\Sdk\Model\Schema\Mutator;
6			use Ipag\Sdk\Model\Schema\Schema;
7			use Ipag\Sdk\Model\Schema\SchemaBuilder;
8			use Kubinyete\Assertation\Assert;
9
10			/**
11			* Charge Class
12			*
13			* Classe responsável por representar o recurso Charge.
14			*
15			*/
16			final class Charge extends Model
17			{
18
19			/**
20			* @param array $data
21			* array de dados do Charge.
22			*
23			* + [`'amount'`] float.
24			* + [`'description'`] string.
25			* + [`'due_date'`] string (opcional) {`Formato: Y-m-d`}.
26			* + [`'frequency'`] int (opcional).
27			* + [`'interval'`] enum {`'day'` \| `'week'` \| `'month'`} (opcional).
28			* + [`'type'`] enum {`'charge'` \| `'recurring'`} (opcional).
29			* + [`'last_charge_date'`] string (opcional).
30			* + [`'callback_url'`] string (opcional).
31			* + [`'auto_debit'`] bool (opcional).
32			* + [`'installments'`] int (opcional).
33			* + [`'is_active'`] bool (opcional).
34			* + [`'products'`] array[`int`, `int`, `int`, ...] (opcional).
35			* + [`'customer'`] array (opcional) dos dados do Customer.
36			* + &emsp; [`'name'`] string.
37			* + &emsp; [`'email'`] string.
38			* + &emsp; [`'phone'`] string.
39			* + &emsp; [`'cpf_cnpj'`] string.
40			* + [`'checkout_settings'`] array (opcional) dos dados do CheckoutSettings.
41			* + &emsp; [`'max_installments'`] int (opcional).
42			* + &emsp; [`'interest_free_installments'`] int (opcional).
43			* + &emsp; [`'min_installment_value'`] float (opcional).
44			* + &emsp; [`'interest'`] float (opcional).
45			* + &emsp; [`'fixed_installment'`] float (opcional).
46			* + &emsp; [`'payment_method'`] enum {`'all'` \| `'creditcard'` \| `'boleto'` \| `'transfer'` \| `'pix'`} (opcional).
47			*
48			*/
49			public function __construct(?array $data = [])
50			{
51			parent::__construct($data);
52			}
53
54			public function schema(SchemaBuilder $schema): Schema
55			{
56			$schema->float('amount')->nullable();
57			$schema->string('description')->nullable();
58			$schema->string('due_date')->nullable();
59			$schema->int('frequency')->nullable();
60			$schema->enum('interval', ['day', 'week', 'month'])->nullable();
61			$schema->enum('type', ['charge', 'recurring'])->nullable();
62			$schema->string('last_charge_date')->nullable();
63			$schema->string('callback_url')->nullable();
64			$schema->bool('auto_debit')->nullable();
65			$schema->int('installments')->nullable();
66			$schema->bool('is_active')->nullable();
67			$schema->any('products')->nullable();
68
69			$schema->has('customer', Customer::class)->nullable();
70
71			$schema->has('checkout_settings', CheckoutSettings::class)->nullable();
72
73			return $schema->build();
74			}
75
76			protected function amount(): Mutator
77			{
78			return new Mutator(
79			null,
80			fn($value, $ctx) =>
81			is_null($value) ? $value :
82			(
83			Assert::value(floatval($value))->gte(0)->get()
84			?? $ctx->raise('inválido')
85			)
86			);
87			}
88
89			protected function due_date(): Mutator
90			{
91			return new Mutator(
92			null,
93			function ($value, $ctx) {
94			$d = \DateTime::createFromFormat('Y-m-d', $value);
95
96			return is_null($value) \|\|
97			($d && $d->format('Y-m-d') === $value) ?
98			$value : $ctx->raise('inválido');
99			}
100			);
101			}
102
103			protected function frequency(): Mutator
104			{
105			return new Mutator(
106			null,
107			fn($value, $ctx) =>
108			is_null($value) ? $value :
109			(
110			Assert::value(intval($value))->gt(0)->get()
111			?? $ctx->raise('inválido (informe um valor de 1 à 12)')
112			)
113			);
114			}
115
116			protected function last_charge_date(): Mutator
117			{
118			return new Mutator(
119			null,
120			function ($value, $ctx) {
121			$d = \DateTime::createFromFormat('Y-m-d', $value);
122
123			return is_null($value) \|\|
124			($d && $d->format('Y-m-d') === $value) ?
125			$value : $ctx->raise('inválido');
126			}
127			);
128			}
129
130			protected function installments(): Mutator
131			{
132			return new Mutator(
133			null,
134			fn($value, $ctx) =>
135			is_null($value) ? $value :
136			(
137			Assert::value(intval($value))->gt(0)->get()
138			?? $ctx->raise('inválido (informe um valor de 1 à 48)')
139			)
140			);
141			}
142
143			protected function products(): Mutator
144			{
145			return new Mutator(
146			null,
147			fn($value, $ctx) =>
148			is_null($value) ? $value :
149			(
150			Assert::value($value)->array() ? $value :
151			$ctx->raise('inválido (informe um array de ids (int) de produtos)')
152			)
153			);
154			}
155
156			/**
157			* Retorna o valor da propriedade `amount`.
158			*
159			* @return float\|null
160			*/
161			public function getAmount(): ?float
162			{
163			return $this->get('amount');
164			}
165
166			/**
167			* Seta o valor da propriedade `amount`.
168			*
169			* @param float\|null $amount
170			* @return self
171			*/
172			public function setAmount(?float $amount = null): self
173			{
174			$this->set('amount', $amount);
175			return $this;
176			}
177
178			/**
179			* Retorna o valor da propriedade `description`.
180			*
181			* @return string\|null
182			*/
183			public function getDescription(): ?string
184			{
185			return $this->get('description');
186			}
187
188			/**
189			* Seta o valor da propriedade `description`.
190			*
191			* @param string\|null $description
192			* @return self
193			*/
194			public function setDescription(?string $description = null): self
195			{
196			$this->set('description', $description);
197			return $this;
198			}
199
200			/**
201			* Retorna o valor da propriedade `due_date`.
202			*
203			* @return string\|null
204			*/
205			public function getDueDate(): ?string
206			{
207			return $this->get('due_date');
208			}
209
210			/**
211			* Seta o valor da propriedade `due_date`.
212			*
213			* @param string\|null $due_date
214			* @return self
215			*/
216			public function setDueDate(?string $due_date = null): self
217			{
218			$this->set('due_date', $due_date);
219			return $this;
220			}
221
222			/**
223			* Retorna o valor da propriedade `frequency`.
224			*
225			* @return integer\|null
226			*/
227			public function getFrequency(): ?int
228			{
229			return $this->get('frequency');
230			}
231
232			/**
233			* Seta o valor da propriedade `frequency`.
234			*
235			* @param integer\|null $frequency
236			* @return self
237			*/
238			public function setFrequency(?int $frequency = null): self
239			{
240			$this->set('frequency', $frequency);
241			return $this;
242			}
243
244			/**
245			* Retorna o valor da propriedade `interval`.
246			*
247			* @return string\|null
248			*/
249			public function getInterval(): ?string
250			{
251			return $this->get('interval');
252			}
253
254			/**
255			* Seta o valor da propriedade `interval`.
256			*
257			* @param string\|null $interval
258			* @return self
259			*/
260			public function setInterval(?string $interval = null): self
261			{
262			$this->set('interval', $interval);
263			return $this;
264			}
265
266			/**
267			* Retorna o valor da propriedade `type`.
268			*
269			* @return string\|null
270			*/
271			public function getType(): ?string
272			{
273			return $this->get('type');
274			}
275
276			/**
277			* Seta o valor da propriedade `type`.
278			*
279			* @param string\|null $type
280			* @return self
281			*/
282			public function setType(?string $type = null): self
283			{
284			$this->set('type', $type);
285			return $this;
286			}
287
288			/**
289			* Retorna o valor da propriedade `last_charge_date`.
290			*
291			* @return string\|null
292			*/
293			public function getLastChargeDate(): ?string
294			{
295			return $this->get('last_charge_date');
296			}
297
298			/**
299			* Seta o valor da propriedade `last_charge_date`.
300			*
301			* @param string\|null $last_charge_date
302			* @return self
303			*/
304			public function setLastChargeDate(?string $last_charge_date = null): self
305			{
306			$this->set('last_charge_date', $last_charge_date);
307			return $this;
308			}
309
310			/**
311			* Retorna o valor da propriedade `callback_url`.
312			*
313			* @return string\|null
314			*/
315			public function getCallbackUrl(): ?string
316			{
317			return $this->get('callback_url');
318			}
319
320			/**
321			* Seta o valor da propriedade `callback_url`.
322			*
323			* @param string\|null $callback_url
324			* @return self
325			*/
326			public function setCallbackUrl(?string $callback_url = null): self
327			{
328			$this->set('callback_url', $callback_url);
329			return $this;
330			}
331
332			/**
333			* Retorna o valor da propriedade `auto_debit`.
334			*
335			* @return boolean\|null
336			*/
337			public function getAutoDebit(): ?bool
338			{
339			return $this->get('auto_debit');
340			}
341
342			/**
343			* Seta o valor da propriedade `auto_debit`.
344			*
345			* @param boolean\|null $auto_debit
346			* @return self
347			*/
348			public function setAutoDebit(?bool $auto_debit = null): self
349			{
350			$this->set('auto_debit', $auto_debit);
351			return $this;
352			}
353
354			/**
355			* Retorna o valor da propriedade `installments`.
356			*
357			* @return integer\|null
358			*/
359			public function getInstallments(): ?int
360			{
361			return $this->get('installments');
362			}
363
364			/**
365			* Seta o valor da propriedade `installments`.
366			*
367			* @param integer\|null $installments
368			* @return self
369			*/
370			public function setInstallments(?int $installments = null): self
371			{
372			$this->set('installments', $installments);
373			return $this;
374			}
375
376			/**
377			* Retorna o valor da propriedade `is_active`.
378			*
379			* @return boolean\|null
380			*/
381			public function getIsActive(): ?bool
382			{
383			return $this->get('is_active');
384			}
385
386			/**
387			* Seta o valor da propriedade `is_active`.
388			*
389			* @param boolean\|null $is_active
390			* @return self
391			*/
392			public function setIsActive(?bool $is_active = null): self
393			{
394			$this->set('is_active', $is_active);
395			return $this;
396			}
397
398			/**
399			* Retorna o array `Products_Ids` associado ao `Charge`.
400			*
401			* @return array\|null
402			*/
403			public function getProducts(): ?array
404			{
405			return $this->get('products');
406			}
407
408			/**
409			* Seta o array `Products_Ids` associado ao `Charge`.
410			*
411			* @param array\|null $products
412			* @return self
413			*/
414			public function setProducts(?array $products = null): self
415			{
416			$this->set('products', $products);
417			return $this;
418			}
419
420			/**
421			* Retorna o objeto `Customer` associado ao `Charge`.
422			*
423			* @return Customer\|null
424			*/
425			public function getCustomer(): ?Customer
426			{
427			return $this->get('customer');
428			}
429
430			/**
431			* Seta o objeto `Customer` associado ao `Charge`.
432			*
433			* @param Customer\|null $customer
434			* @return self
435			*/
436			public function setCustomer(?Customer $customer = null): self
437			{
438			$this->set('customer', $customer);
439			return $this;
440			}
441
442			/**
443			* Retorna o objeto `CheckoutSettings` associado ao `Charge`.
444			*
445			* @return CheckoutSettings\|null
446			*/
447			public function getCheckoutSettings(): ?CheckoutSettings
448			{
449			return $this->get('checkout_settings');
450			}
451
452			/**
453			* Seta o objeto `CheckoutSettings` associado ao `Charge`.
454			*
455			* @param CheckoutSettings\|null $checkout_settings
456			* @return self
457			*/
458			public function setCheckoutSettings(?CheckoutSettings $checkout_settings = null): self
459			{
460			$this->set('checkout_settings', $checkout_settings);
461			return $this;
462			}
463
464			}

ipagdevs / ipag-sdk-php

Charge::frequency() A last analyzed 2025-10-31 19:56 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Charge::frequency() A
last analyzed 2025-10-31 19:56 UTC