Address::systemModelHasAddress() - Code Metrics - Inspection of "Adds artomated addresses" - pwweb/localisation - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 8be593...d0f45d )

by F

created 2020-04-07 21:33 UTC

Address::systemModelHasAddress() A

↳ Parent: Address

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 PWWEB\Localisation\Models;

use Eloquent as Model;
use Illuminate\Database\Eloquent\SoftDeletes;

/**
 * PWWEB\Localisation\Models\Address Model.
 *
 * Standard Address Model.
 *
 * @package   pwweb/localisation
 * @author    Frank Pillukeit <[email protected]>
 * @author    Richard Browne <[email protected]
 * @copyright 2020 pw-websolutions.com
 * @license   http://www.opensource.org/licenses/mit-license.html  MIT License
 * @property \PWWEB\Localisation\Models\SystemLocalisationCountry country
 * @property \PWWEB\Localisation\Models\SystemAddressType type
 * @property \PWWEB\Localisation\Models\SystemModelHasAddress systemModelHasAddress
 * @property integer country_id
 * @property integer type_id
 * @property string street
 * @property string street2
 * @property string city
 * @property string state
 * @property string postcode
 * @property number lat
 * @property number lng
 * @property boolean primary
 */

class Address extends Model
{
    use SoftDeletes;

    public $table = 'system_addresses';

    const CREATED_AT = 'created_at';
    const UPDATED_AT = 'updated_at';


    protected $dates = ['deleted_at'];



    public $fillable = [
        'country_id',
        'type_id',
        'street',
        'street2',
        'city',
        'state',
        'postcode',
        'lat',
        'lng',
        'primary'
    ];

    /**
     * The attributes that should be casted to native types.
     *
     * @var array
     */
    protected $casts = [
        'id' => 'integer',
        'country_id' => 'integer',
        'type_id' => 'integer',
        'street' => 'string',
        'street2' => 'string',
        'city' => 'string',
        'state' => 'string',
        'postcode' => 'string',
        'lat' => 'float',
        'lng' => 'float',
        'primary' => 'boolean'
    ];

    /**
     * Validation rules.
     *
     * @var array
     */
    public static $rules = [
        'country_id' => 'required',
        'type_id' => 'required',
        'primary' => 'required'
    ];

    /**
     * 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'));
    }

    /**
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     **/
    public function country()
    {
        return $this->belongsTo(\App\Models\Pwweb\Localisation\Models\SystemLocalisationCountry::class, 'country_id');
filter:
    dependency_paths: ["lib/*"]
    }

    /**
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     **/
    public function type()
    {
        return $this->belongsTo(\App\Models\Pwweb\Localisation\Models\SystemAddressType::class, 'type_id');
filter:
    dependency_paths: ["lib/*"]
    }

    /**
     * @return \Illuminate\Database\Eloquent\Relations\HasOne
     **/
    public function systemModelHasAddress()
    {
        return $this->hasOne(\App\Models\Pwweb\Localisation\Models\SystemModelHasAddress::class);
filter:
    dependency_paths: ["lib/*"]
    }

    /**
     * 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
filter:
    dependency_paths: ["lib/*"]
    {
        $address = static::getAddresses(['id' => $id])->first();

        if (null === $address) {
            throw AddressDoesNotExist::withId($id);
filter:
    dependency_paths: ["lib/*"]
        }

        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
filter:
    dependency_paths: ["lib/*"]
    {
        return app(LocalisationRegistrar::class)
filter:
    dependency_paths: ["lib/*"]
            ->setAddressClass(static::class)
            ->/** @scrutinizer ignore-call */ setAddressClass(static::class)
            ->getAddresses($params);
    }
}


pwweb / localisation

Push — master ( 8be593...d0f45d )

Address::systemModelHasAddress() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like