sfneal / address

src/Models/Address.php

<?php

namespace Sfneal\Address\Models;

use Database\Factories\AddressFactory;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Relations\MorphTo;
use Sfneal\Address\Builders\AddressBuilder;
use Sfneal\Address\Models\Traits\CityStateAccessors;
use Sfneal\Helpers\Arrays\ArrayHelpers;
use Sfneal\Helpers\Strings\StringHelpers;
use Sfneal\Models\Model;

class Address extends Model
{
    use CityStateAccessors;
    use HasFactory;

    protected $table = 'address';
    protected $primaryKey = 'address_id';

    protected $fillable = [
        'address_id',
        'type',
        'address_1',
        'address_2',
        'city',
        'state',
        'zip',
        'addressable_id',
        'addressable_type',
    ];

    protected $appends = [
        'address_full',
    ];

    /**
     * Model Factory.
     *
     * @return AddressFactory
     */
    protected static function newFactory(): AddressFactory
    {
        return new AddressFactory();
    }

    /**
     * Query Builder.
     *
     * @param  $query
     * @return AddressBuilder
     */
    public function newEloquentBuilder($query)
    {
        return new AddressBuilder($query);
    }

    /**
     * @return AddressBuilder|Builder
     */
    public static function query(): AddressBuilder
    {
        return parent::query();
    }

    /**
     * Get the owning addressable model.
     *
     * @return MorphTo
     */
    public function addressable(): MorphTo
    {
        return $this->morphTo();
    }

    /**
     * Retrieve an html block to display an address.
     *
     * @param  bool  $withType  include the address type
     * @return string
     */
    public function show(bool $withType = true): string
    {
        $string = '';
        if ($withType && $this->attributes['type']) {
            $string .= '<small><b>'.ucfirst($this->attributes['type']).' Address:</b></small><br>';
        }
        if ($this->attributes['address_1']) {
            $string .= "{$this->attributes['address_1']}<br>";
        }
        if ($this->attributes['address_2']) {
            $string .= "{$this->attributes['address_2']}<br>";
        }
        if ($this->attributes['city']) {
            $string .= "{$this->city_state_zip}<br>";
        }

        return $string;
    }

    /**
     * Retrieve the 'address_full' attribute.
     *
     *  - returns a full address string that includes address, city, state & zip
     *
     * @return string|null
     */
    public function getAddressFullAttribute(): ?string
    {
        if (! array_key_exists('address_1', $this->attributes)) {
            return null;
        }

        // Include the second line address if set
        $address = "{$this->attributes['address_1']}, ".(isset($this->attributes['address_2']) ? "{$this->attributes['address_2']}, " : '');

        return $address."{$this->attributes['city']}, {$this->attributes['state']} {$this->attributes['zip']}";
    }

    /**
     * Set the 'address_1' attribute.
     *
     * @param  $value
     * @return void
     */
    public function setAddress1Attribute($value): void
    {
        $this->attributes['address_1'] = (strlen(trim($value)) > 0) ? trim($value) : null;
    }

    /**
     * Set the 'address_2' attribute.
     *
     * @param  $value
     * @return void
     */
    public function setAddress2Attribute($value): void
    {
        $this->attributes['address_2'] = (strlen(trim($value)) > 0) ? trim($value) : null;
    }

    /**
     * Parse city attribute into city and state values.
     *
     * @param  $value
     * @return void
     */
    public function setCityAttribute($value): void
    {
        if (isset($value) && (new StringHelpers($value))->inString(',')) {
            [$city, $state] = explode(',', $value);
            $this->attributes['city'] = ucfirst(trim($city));
            $this->setStateAttribute(trim($state));
        } else {
            $this->attributes['city'] = ucfirst(trim($value));
        }
    }

    /**
     * Set the 'state' attribute value.
     *
     * @param  $value
     * @return void
     */
    public function setStateAttribute($value): void
    {
        // Check to see if a zip value was accidentally given
        if (ArrayHelpers::from(
            collect(str_split($value))

str_split($value) of type array|true is incompatible with the type Illuminate\Contracts\Support\Arrayable expected by parameter $value of collect().

                ->take(2)
                ->map(function ($char) {
                    return is_int($char);
                })
                ->toArray()
        )->valuesEqual(true)) {
            $attribute = 'zip';
        } else {
            $attribute = 'state';
        }

        // Only allow 2 chars, cast to uppercase, trim whitespace
        $this->attributes[$attribute] = (strlen(trim($value)) > 0) ? strtoupper(trim($value)) : null;
    }

    /**
     * Set the 'zip' attribute.
     *
     * @param  $value
     * @return void
     */
    public function setZipAttribute($value): void
    {
        $this->attributes['zip'] = (strlen(trim($value)) > 0) ? trim($value) : null;
    }
}