Lifeboat\Models\Address

Complexity

Total Complexity

5

Size/Duplication

Total Lines	42
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	retrieve()	0	7	2
A	all()	0	3	1
A	search()	0	4	1
A	getSaveURL()	0	3	1

<?php

namespace Lifeboat\Models;

use Lifeboat\Exceptions\ApiException;
use Lifeboat\Exceptions\InvalidArgumentException;
use Lifeboat\Exceptions\OAuthException;
use Lifeboat\Resource\ListResource;

/**
 * Class Address
 * @package Lifeboat\Models
 *
 * @property string $Name
 * @property string $Address
 * @property string $AddressL2
 * @property string $City
 * @property string $SubdivisionCode
 * @property string $CountryCode
 * @property string $PostCode
 * @property string $Notes
 * @property string $Latitude
 * @property string $Longitude
 * @property string $Email
 * @property string $Tel
 * @property string $VATNo
 * @property int $isDefault
 * @property string $Country
 * @property string $Subdivision
 * @property int $CustomerID
 */
class Address extends Model {

    /**
     * @param int $id
     * @return Model|null
     * @throws ApiException
     * @throws OAuthException
     * @throws InvalidArgumentException If param $id is less than 1
     */
    public function retrieve(int $id = -1): ?Model
    {
        if ($id <= 0) {
            throw new InvalidArgumentException("Address::fetch() expects parameter 1 to be a positive integer");
        }

        return $this->curl_for_model('api/addresses/address/' . $id);
    }

    /**
     * @return ListResource
     */
    public function all(): ListResource
    {
        return new ListResource($this->getClient(), 'api/addresses/all', [], 20);

It seems like $this->getClient() can also be of type null; however, parameter $client of Lifeboat\Resource\ListResource::__construct() does only seem to accept Lifeboat\Connector, maybe add an additional type check?

    }

    /**
     * @param string $search
     * @return ListResource
     */
    public function search(string $search): ListResource
    {
        $all = $this->all();
        return $all->setParams(['search' => $search]);
    }

    /**
     * @return string
     */
    protected function getSaveURL(): string
    {
        return 'api/addresses/address/' . $this->ID;
    }
}