PWWeb\Localisation\Models\Address

Complexity

Total Complexity

8

Size/Duplication

Total Lines	97
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	findById()	0	9	2
A	country()	0	3	1
A	findByType()	0	9	2
A	type()	0	3	1
A	getAddresses()	0	5	1
A	__construct()	0	5	1

<?php

/**
 * PWWEB\Localisation\Models\Address Model.
 *
 * Standard Address Model.
 *
 * @author    Frank Pillukeit <clients@pw-websolutions.com>
 * @copyright 2020 pw-websolutions.com
 * @license   http://www.opensource.org/licenses/mit-license.html  MIT License
 */

namespace PWWeb\Localisation\Models;

use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use PWWEB\Localisation\Contracts\Address as AddressContract;
use PWWEB\Localisation\Exceptions\AddressDoesNotExist;
use PWWEB\Localisation\LocalisationRegistrar;
use PWWEB\Localisation\Models\Address\Type;

class Address extends Model implements AddressContract
{
    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'street', 'street2', 'city', 'state', 'postcode', 'country_id', 'type_id', 'lat', 'lng',
    ];

    /**
     * Constructor.
     *
     * @param array $attributes additional attributes for model initialisation
     *
     * @return void
     */
    public function __construct(array $attributes = [])
    {
        parent::__construct($attributes);

        $this->setTable(config('pwweb.localisation.table_names.addresses'));
    }

    /**
     * An address can be of only one type (e.g. private, work, etc).
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function type(): BelongsTo
    {
        return $this->belongsTo(Address\Type::class);
    }

    /**
     * An address belongs to a country.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function country(): BelongsTo
    {
        return $this->belongsTo(Country::class);
    }

    /**
     * Find an address by its id.
     *
     * @param int $id ID to be used to retrieve the address
     *
     * @throws \PWWEB\Localisation\Exceptions\AddressDoesNotExist
     *
     * @return \PWWEB\Localisation\Contracts\Address
     */
    public static function findById(int $id): AddressContract
    {
        $address = static::getAddresses(['id' => $id])->first();

        if (null === $address) {
            throw AddressDoesNotExist::withId($id);
        }

        return $address;
    }

    /**
     * Find an address by its type.
     *
     * @param string $type Address type to be used to retrieve the address
     *
     * @throws \PWWEB\Localisation\Exceptions\AddressDoesNotExist
     *
     * @return \PWWEB\Localisation\Contracts\Address
     */
    public static function findByType(string $type): AddressContract
    {
        $address = static::getAddresses(['type' => $type])->first();

        if (null === $address) {
            throw AddressDoesNotExist::withType($type);
        }

        return $address;
    }

    /**
     * Get the current cached addresses.
     *
     * @param array $params additional parameters for the database query
     *
     * @return Collection collection of addresses
     */
    protected static function getAddresses(array $params = []): Collection
    {
        return app(LocalisationRegistrar::class)
            ->setAddressClass(static::class)
            ->getAddresses($params);
    }
}