cleaniquecoders/profile

Common Profile Information

v5.0.0 2024-03-21 03:35 UTC

Requires

• php: ^8.1 | ^8.2 | ^8.3
• cleaniquecoders/blueprint-macro: ^5.0
• illuminate/auth: ^9.0 | ^10.0 | ^11.0
• illuminate/support: ^9.0 | ^10.0 | ^11.0

Requires (Dev)

• laravel/pint: ^1.6
• orchestra/testbench: 7.*|8.*
• pestphp/pest: ^2.0
• phpstan/phpstan-phpunit: ^1.2

MIT

• Nasrul Hazim

README

Profile is a package to store basic information - addresses, phone numbers, emails, and websites using Polymorph approach.

Installation

1. In order to install Profile in your Laravel project:

$ composer require cleaniquecoders/profile

1. Then in your config/app.php add the following to the providers key:

\CleaniqueCoders\Profile\ProfileServiceProvider::class,

Publish factory files:

$ php artisan vendor:publish --tag=profile-factories

Publish migrations files:

$ php artisan vendor:publish --tag=profile-migrations

Publish seed files:

$ php artisan vendor:publish --tag=profile-seeds

Then run:

$ php artisan migrate

Then seed the Country and Phone Types data with:

$ php artisan profile:seed

Configuration

Now you are able to configure your own models and type name. See config/profile.php.

You may want to define your own seeders for profile:seed in config/profile.php.

Available Polymorph Traits

User Cases:

1. A company has addresses, phone numbers, emails and websites.
2. An employee has addresses, phone numbers, emails and websites.

This lead us to use Polymorph to tackle the issue of similarity in data stored.

Setup

Available traits for polymorph:

1. CleaniqueCoders\Profile\Traits\Morphs\Addressable
2. CleaniqueCoders\Profile\Traits\Morphs\Emailable
3. CleaniqueCoders\Profile\Traits\Morphs\Phoneable
4. CleaniqueCoders\Profile\Traits\Morphs\Websiteable
5. CleaniqueCoders\Profile\Traits\Morphs\Bankable

For most common setup for entity is to use HasProfile trait.

HasProfile trait consist of:

1. CleaniqueCoders\Profile\Traits\Morphs\Addressable
2. CleaniqueCoders\Profile\Traits\Morphs\Emailable
3. CleaniqueCoders\Profile\Traits\Morphs\Phoneable
4. CleaniqueCoders\Profile\Traits\Morphs\Websiteable

namespace App;

use CleaniqueCoders\Profile\Traits\HasProfile;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable
{
	use HasProfile;
}

Usage

Create a record for each profile

$user->addresses()->create([
	'primary' => '9 miles, Sungei Way',
	'secondary' => 'P.O.Box 6503, Seri Setia',
	'city' => 'Petaling Jaya',
	'postcode' => '46150',
	'state' => 'Selangor',
	'country_id' => config('profile.providers.country.model')::name('Malaysia')->first()->id
]);

$user->phones()->create([
    'phone_number'  => '[phone]',
    'is_default'    => true,
    'phone_type_id' => PhoneType::HOME,
]);
$user->phones()->create([
    'phone_number'  => '[phone]',
    'is_default'    => true,
    'phone_type_id' => PhoneType::MOBILE,
]);
$user->phones()->create([
    'phone_number'  => '[phone]',
    'is_default'    => true,
    'phone_type_id' => PhoneType::OFFICE,
]);
$user->phones()->create([
    'phone_number'  => '[phone]',
    'is_default'    => true,
    'phone_type_id' => PhoneType::OTHER,
]);
$user->phones()->create([
    'phone_number'  => '[phone]',
    'is_default'    => true,
    'phone_type_id' => PhoneType::FAX,
]);

// you can futher query using local scopes in phone models.
// get the first home phone number
$user->phones()->home()->first();
// get all the mobile phone numbers
$user->phones()->mobile()->get();

$user->emails()->create([...]);
$user->websites()->create([...]);
$user->bankable()->create([...]);

Get all records

$user->addresses;
$user->emails;
$user->phones;
$user->websites;
$user->banks;

License

This package is open-sourced software licensed under the MIT license.