https://github.com/cleaniquecoders/profile
Basic Profile Information using Polymorph
https://github.com/cleaniquecoders/profile
address bank email laravel package polymorph profile
Last synced: 6 months ago
JSON representation
Basic Profile Information using Polymorph
- Host: GitHub
- URL: https://github.com/cleaniquecoders/profile
- Owner: cleaniquecoders
- License: mit
- Created: 2017-12-24T19:42:15.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2025-03-05T23:08:01.000Z (7 months ago)
- Last Synced: 2025-03-28T19:37:45.823Z (6 months ago)
- Topics: address, bank, email, laravel, package, polymorph, profile
- Language: PHP
- Size: 865 KB
- Stars: 14
- Watchers: 0
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
## Profile
Profile is a package to store basic information - addresses, phone numbers, emails, and websites using [Polymorph](https://laravel.com/docs/6.x/eloquent-relationships#polymorphic-relationships) approach.
[](https://packagist.org/packages/cleaniquecoders/profile) [](https://packagist.org/packages/cleaniquecoders/profile) [](https://scrutinizer-ci.com/g/cleaniquecoders/profile/?branch=master) [](https://packagist.org/packages/cleaniquecoders/profile)
## Installation
Install Profile package by running in your terminal:
```bash
composer require cleaniquecoders/profile
```
Publish migrations files:
```bash
php artisan vendor:publish --tag=profile-migrations
```
Then run:
```bash
php artisan migrate
```
Then run default seeders:
```bash
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\Concerns\Addressable`
2. `CleaniqueCoders\Profile\Concerns\Emailable`
3. `CleaniqueCoders\Profile\Concerns\Phoneable`
4. `CleaniqueCoders\Profile\Concerns\Websiteable`
5. `CleaniqueCoders\Profile\Concerns\Bankable`
For most common setup for entity is to use `HasProfile` trait.
`HasProfile` trait consist of:
1. `CleaniqueCoders\Profile\Concerns\Addressable`
2. `CleaniqueCoders\Profile\Concerns\Emailable`
3. `CleaniqueCoders\Profile\Concerns\Phoneable`
4. `CleaniqueCoders\Profile\Concerns\Websiteable`
```php
namespace App;
use CleaniqueCoders\Profile\Concerns\HasProfile;
use Illuminate\Foundation\Auth\User as Authenticatable;
class User extends Authenticatable
{
use HasProfile;
}
```
#### Usage
**Create a record for each profile**
```php
$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
]);
```
```php
$user->phones()->create([
'phone_number' => '+6089259167',
'is_default' => true,
'phone_type_id' => PhoneType::HOME,
]);
$user->phones()->create([
'phone_number' => '+60191234567',
'is_default' => true,
'phone_type_id' => PhoneType::MOBILE,
]);
$user->phones()->create([
'phone_number' => '+60380001000',
'is_default' => true,
'phone_type_id' => PhoneType::OFFICE,
]);
$user->phones()->create([
'phone_number' => '+60380001000',
'is_default' => true,
'phone_type_id' => PhoneType::OTHER,
]);
$user->phones()->create([
'phone_number' => '+60380001001',
'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();
```
```php
$user->emails()->create([...]);
$user->websites()->create([...]);
$user->bankable()->create([...]);
```
**Get all records**
```php
$user->addresses;
$user->emails;
$user->phones;
$user->websites;
$user->banks;
```
## License
This package is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).