erenmustafaozdal/laravel-user-module

laravel 5.1 user, role and auth module package

Laravel User Module

, _(*1)

Laravel User Module, Laravel 5.1 projelerinde kullanıcı, rol ve giriş işlemlerini kapsayan bir modül paketidir. Bu paket kullanıcı arayüzü (views) hariç, arka plandaki bütün işlemleri barındırmaktadır. İstersen görünümleri kapsayan Laravel Modules Core paketini kullanarak, modüle tam kapsamıyla sahip olabilirsin., _(*2)

1. Kurulum
   1. Dosyaların Yayınlanması
   2. Migration
2. Kullanım
   1. Ayar Dosyası
      1. Genel Ayarlar
      2. URL Ayarları
      3. Görünüm Ayarları
      4. Model Ayarları
   2. Görünüm Tasarlama
      1. Model Kullanımı
         1. User
         2. Role
      2. Rotalar
         1. Giriş - Çıkış - Kayıt Rotaları
         2. Kullanıcı Rotaları
         3. Kullanıcı Rolü Rotaları
      3. Form Alanları
         1. Giriş - Çıkış - Kayıt Formları
         2. Kullanıcı Formları
         3. Kullanıcı Rolü Formları
      4. İşlem İzin Formları
   3. Onaylamalar
   4. Olaylar
      1. Giriş - Çıkış - Kayıt Olayları
      2. Kullanıcı Olayları
      3. Kullanıcı Rolü Olayları
3. Lisans

, _(*3)

Kurulum

Composer ile yüklemek için aşağıdaki kodu kullanabilirsin., _(*4)

composer require erenmustafaozdal/laravel-user-module

Ya da composer.json dosyana, aşağıdaki gibi ekleme yapıp, paketleri güncelleyebilirsin., _(*5)

{
    "require": {
        "erenmustafaozdal/laravel-user-module": "~0.1"
    }
}

$ composer update

Bu işlem bittikten sonra, service provider'i projenin config/app.php dosyasına eklemelisin., _(*6)

ErenMustafaOzdal\LaravelUserModule\LaravelUserModuleServiceProvider::class,

:exclamation: Eğer Laravel Modules Core paketini kullanacaksan, o paketin service provider dosyasını üstte tanımlamalısın., _(*7)

, _(*8)

Dosyaların Yayınlanması

Laravel User Module paketinin dosyalarını aşağıdaki kodla yayınlamalısın., _(*9)

php artisan vendor:publish --provider="ErenMustafaOzdal\LaravelUserModule\LaravelUserModuleServiceProvider"

, _(*10)

Migration

Dosyaları yayınladıktan sonra migration işlemi yapmalısın., _(*11)

:exclamation: Migration işleminden önce Laravel'in varsayılan migration dosyalarını silmelisin. Sentinel kendi migration dosyalarını ekleyecek., _(*12)

:exclamation: Sentinel'e ait ...migration_cartalyst_sentinel.php dosyasında Laravel User Module'e özgü bazı değişiklikler yapmalısın. users tablosunun sütunlarının belirlendiği satırlarda, last_name sütunundan sonra aşağıdaki gibi ekleme yapmalısın., _(*13)

$table->string('last_name')->nullable();        // bu satırdan sonra
$table->boolean('is_active')->default(0);       // bu satırı eklemelisin
$table->boolean('is_super_admin')->default(0);  // bu satırı da eklemelisin
$table->string('photo')->nullable();            // ve arkasından bu satırı

Daha sonra migrate işlemini yapabilirsin., _(*14)

php artisan migrate

:exclamation: Kullanıcının başarılı kayıt işlemi sonrasında tetiklenen olay ile, kullanıcıya aktivasyon e-postası göndermek gibi bazı işlemler için; ErenMustafaOzdal\LaravelUserModule\Listeners\LaravelUserModuleListener dinleyicisini App\Providers\EventServiceProvider içinde $subscribe dizi özelliğine eklemelisin., _(*15)

protected $subscribe = [
    'ErenMustafaOzdal\LaravelUserModule\Listeners\LaravelUserModuleListener',
];

config/laravel-user-module.php dosyasından aktivasyon e-posta blade dosyasını değiştirebilirsin., _(*16)

Aktivasyon epostası blade dosyasına kullanıcı bilgileri (user) ve Sentinel Aktivasyon nesnesi gönderilmektedir (activation). Sentinel Aktivasyon nesnesinden $activation->code şeklinde kodu eposta içindeki aktivasyon bağlantısına ekleyebilirsin., _(*17)

:exclamation: Paketin bağımlılıklarından Sentinel ayar dosyasında (config/cartalyst.sentinel.php) users ve roles model değerlerini güncellemelisin., _(*18)

'users' => [
    'model' => 'App\User',
],
'roles' => [
    'model' => 'App\Role',
],

Son olarak App\User ve App\Role modellerini uygun bir şekilde tanımlamalısın. Bunun için App\User modelini ErenMustafaOzdal\LaravelUserModule\User modelinden, App\Role modelini ErenMustafaOzdal\LaravelUserModule\Role modelinden genişletmelisin., _(*19)

namespace App;

use ErenMustafaOzdal\LaravelUserModule\User as EMOUser;

class User extends EMOUser
{
    //
}

```php namespace App;, <sub>(*20)</sub>

use ErenMustafaOzdal\LaravelUserModule\Role as EMORole;, <sub>(*21)</sub>

class Role extends EMORole { // }, <sub>(*22)</sub>

<a name="kullanim"></a>
Kullanım
--------

Kurulum tamamlandığında; [Laravel Modules Core](https://github.com/erenmustafaozdal/laravel-modules-core) paketini de dahil ettiysen, `proje.dev/login` adresinden tüm haliyle seni bekliyor olacak.

> :exclamation: metinler yanlış görünüyorsa, [Laravel Modules Core](https://github.com/erenmustafaozdal/laravel-modules-core) paketinin İngilizce dil dosyaları hazır olmadığı içindir. Bu sebeple projenin `config/app.php` dosyasında `'locale' => 'tr'` tanımlaması yapmalısın.

> :exclamation: ilk kullanıcı ile giriş yaptığında hiçbir rotaya erişemeyeceksin. Bunu engellemek için veri tabanında `is_super_admin` sütununu **1** olarak tanımlamalısın. bu şekilde bütün izinlere sahip olarak işlemlere devam edebilirsin.

<a name="kullanim-ayarDosyasi"></a>
### Ayar Dosyası

<a name="kullanim-ayarDosyasi-genelAyarlar"></a>
##### Genel Ayarlar
Paketin içinde kullanılan genel ayarlar. Ayar dosyası içinde kök alanda bulunan ayarlar.

| Ayar | Açıklama | Varsayılan Değer |
|---|---|---|
| date_format | Kullanılacak tarih formatı | d.m.Y H:i:s |
| use_register | Kullanıcı kayıt sayfası olacak mı? Eğer bu değer `true` olarak ayarlanırsa; kullanıcların kayıt olması için bir rota tanımlanacak | true |

<a name="kullanim-ayarDosyasi-urlAyarlari"></a>
##### URL Ayarları
Tarayıcının adres çubuğunda görünecek adreslerin tanımlandığı ayarlar. Ayar dosyasının `url` alanında bulunan ayarlardır.

> Örneğin: `activate_route` ayarı ile aktivasyon sayfası adresi `account-activate` şeklinde tanımlanmıştır. Bu şekilde adres çubuğunda şuna benzer bir görünüm olacaktır: `www.siteadi.com/account-activate/{id}/{code}`

| Ayar | Açıklama | Varsayılan Değer |
|---|---|---|
| login_route | Giriş sayfası adresi | login |
| logout_route | Çıkış sayfası adresi | logout |
| register_route | Eğer kayıt sayfası olacaksa, kullanıcıların kayıt olacağı sayfanın adresi | register |
| activate_route | Eğer kayıt sayfası olacaksa, kullanıcıların kayıt sonrası aktivasyon adresi | account-activate |
| forget_password_route | Şifre sıfırlama sayfası adresi | forget-password |
| reset_password_route | Şifre sıfırlama e-postası sonrası gelinecek sıfırlama adresi | reset-password |
| user | Kullanıcı oluşturma, düzenleme vb. sayfalarda kullanılacak adres | users |
| role | Kullanıcı rolü oluşturma, düzenleme vb. sayfalarda kullanılacak adres | roles |
| redirect_route | giriş yapan kullanıcının yönlendirileceği adresin rota adı (`route name`). Ör: dashboard | admin |
| admin_url_prefix | Yönetim panelinin adres çubuğundaki ön adı. Örneğin: `www.siteadi.com/admin/users` | admin |

<a name="kullanim-ayarDosyasi-gorunumAyarlari"></a>
##### Görünüm Ayarları
Paketin kullanacağı görünümlerin tanımlandığı ayarlardır. Ayar dosyasının `views` alanı altında bulunan ayarlardır. Buradaki değerler varsayılan olarak [Laravel Modules Core](https://github.com/erenmustafaozdal/laravel-modules-core) paketinin görünümlerine tanımlıdır.

| Ayar | Açıklama | Varsayılan Değer |
|---|---|---|
|auth.layout | Giriş, kayıt gibi sayfaların şablon görünümü | laravel-modules-core::layouts.auth |
| auth.login | Giriş sayfası görünümü | laravel-modules-core::auth.login |
| auth.register | Kayıt sayfası görünümü | laravel-modules-core::auth.register |
| auth.forget_password | Şifremi unuttum sayfası görünümü | laravel-modules-core::auth.forget_password |
| auth.reset_password | Şifre sıfırlama sayfası görünümü | laravel-modules-core::auth.reset_password |
| user.layout | Kullanıcı sayfaları şablon görünümü | laravel-modules-core::layouts.admin |
| user.index | Kullanıcıların listelendiği sayfanın görünümü | laravel-modules-core::user.index |
| user.create | Kullanıcı ekleme sayfasının görünümü | laravel-modules-core::user.create |
| user.show | Kullanıcı bilgilerinin olduğu sayfanın görünümü | laravel-modules-core::user.show |
| user.edit | Kullanıcı bilgilerinin düzenlendiği sayfanın görünümü | laravel-modules-core::user.edit |
| role.layout | Kullanıcı rolü sayfaları şablon görünümü | laravel-modules-core::layouts.admin |
| role.index | Kullanıcı rollerinin listelendiği sayfanın görünümü | laravel-modules-core::role.index |
| role.create | Kullanıcı rolü ekleme sayfasının görünümü | laravel-modules-core::role.create |
| role.show | Kullanıcı rolü bilgilerinin olduğu sayfanın görünümü | laravel-modules-core::role.show |
| role.edit | Kullanıcı rolü bilgilerinin düzenlendiği sayfanın görünümü | laravel-modules-core::role.edit |
| email.activation | Aktivasyon e-postası görünümü | laravel-modules-core::emails.activation |
| email.forget_password | Şifremi unuttum e-postası görünümü | laravel-modules-core::emails.forget_password |


<a name="kullanim-ayarDosyasi-modelAyarlari"></a>
##### Model Ayarları
Paket içinde kullanılan modeller ile ilgili bazı ayarlamalar. Şu an için sadece `User` modeli ayarları mevcut. Ve bu ayar da; ayar dosyasının `user` alanında bulunmaktadır.


| Ayar | Açıklama | Varsayılan Değer |
|---|---|---|
| avatar_path | Varsayılan avatar fotoğraflarının farklı boyutlarda bulunduğu dizini tanımlar. Burada dikkat edilmesi gereken iki nokta vardır: Birincisi, bu dizin içindeki fotoğrafların isimleri aşağıda tanımlanacak `thumbnails` isimleri ile benzer olmalıdır. İkincisi, dosyalar `.jpg` formatında olmalıdır. Varsayılan değer **Laravel Modules Core** paketine tanımlıdır. | vendor/laravel-modules-core/assets/global/img/avatar |
| uploads.column | Veri tabanındaki fotoğraf sütunu adı | photo |
| uploads.path | Fotoğrafların yükleneceği dosya yolu | uploads/user |
| uploads.thumbnails | Fotoğrafın orjinal hali yukarıdaki dosya yolundan sonra `{id}/original` dizini içine kayıt edilir. Burada ise istenilen adette küçük fotoğraf kayıt edilmesi için tanımlama yapılmalıdır. Ayar formatı dosya içinde anlatıldığı için burada sadece bir örnek verilecektir. | `'smallest' => [ 'width' => 35, 'height' => 35]` |


<a name="kullanim-gorunumTasarlama"></a>
### Görünüm Tasarlama
Paket [Laravel Modules Core](https://github.com/erenmustafaozdal/laravel-modules-core) paketiyle beraber direkt kullanıma hazırdır. Ancak istersen kendine özel görünümlerde tasarlayabilirsin. Bu bölüm özel tasarımlar için bir rehberdir.

<a name="kullanim-gorunumTasarlama-modelKullanimi"></a>
##### Model Kullanımı
Görünümler içinde `User` ve `Role` modellerinin özellik ve metot kullanımı hakkında bilgileri kapsamaktadır. Bu metotlar ve özellikler `App\User` ve `App\Role` içinde üzerine yazılarak değiştirilebilir.

<a name="kullanim-gorunumTasarlama-modelKullanimi-user"></a>
###### User

####### Genel Özellikler
1. **protected $table =** 'users'
2. **protected $fillable =** ['first_name', 'last_name', 'email', 'password', 'is_active', 'photo','permissions']
3. **protected $hidden =** ['password', 'remember_token']

####### $user->getPhoto()
Kullanıcı fotoğrafını HTLM `img` etiketi ile veya sadece url olarak geri döndürür. Eğer fotoğraf yoksa, varsayılan fotoğrafı geri döndürür

| Parametre | Açıklama | Tür | Varsayılan Değer |
|---|---|---|---|
| $attributes | HTML `img` etiketi içinde yer alacak özellikler. Örneğin: *class => 'img-responsive'* | array | [] |
| $type | İstenen resmin türü nedir? `original` değeri fotoğrafın orjinal halini döndürür. Bunun dışında da; ayar dosyasında *thumbnails* alanında belirttiğin isimlerden biri ile çağırabilirsin | string | 'original' |
| $onlyUrl | Resim HTML olarak mı, url olarak mı isteniyor? `true` değeri sadece url'yi geri döndürür | boolean | false |

####### $user->first_name `string`
Baş harfi büyük şekilde kullanıcı ilk adı

####### $user->last_name `string`
Bütün harfler büyük şekilde kullanıcı soyadı

####### $user->fullname `string`
Kullanıcı ilk ve soyadı birleşimi

####### $user->is_active `boolean`
Kullanıcının aktif olup olmadığını döndürür

####### $user->last_login `string`
Kullanıcının son giriş yaptığı tarihi ayar dosyasındaki tanıma göre döndürür

####### $user->last_login_for_humans `string`
Kullanıcının son giriş yaptığı tarihi okunaklı veri şeklinde döndürür. Örneğin: *1 hafta önce*

####### $user->last_login_table `array`
Kullanıcının son giriş yaptığı tarihi `display`(last_login_for_humans) ve `timestamp` şeklinde tutulan bir dizi şeklinde döndürür. Datatable'da kullanılması amacıyla oluşturulmuştur

####### $user->permissions `array`
Kullanıcı işlem izinlerini dizi şeklinde döndürür

####### $user->permission_collect `Collection`
Kullanıcı işlem izinlerini *Collection objesi* şeklinde döndürür

####### $user->created_at `string`
Kullanıcının kayıt tarihini ayar dosyasındaki tanıma göre döndürür

####### $user->created_at_for_humans `string`
Kullanıcının kayıt tarihini okunaklı veri şeklinde döndürür. Örneğin: *1 hafta önce*

####### $user->created_at_table `array`
Kullanıcının kayıt tarihini `display`(last_login_for_humans) ve `timestamp` şeklinde tutulan bir dizi şeklinde döndürür. Datatable'da kullanılması amacıyla oluşturulmuştur

####### $user->updated_at `string`
Kullanıcının güncellenme tarihini ayar dosyasındaki tanıma göre döndürür

####### $user->updated_at_for_humans `string`
Kullanıcının güncellenme tarihini okunaklı veri şeklinde döndürür. Örneğin: *1 hafta önce*

####### $user->updated_at_table `array`
Kullanıcının güncellenme tarihini `display`(last_login_for_humans) ve `timestamp` şeklinde tutulan bir dizi şeklinde döndürür. Datatable'da kullanılması amacıyla oluşturulmuştur

<a name="kullanim-gorunumTasarlama-modelKullanimi-role"></a>
###### Role

####### Genel Özellikler
1. **protected $table =** 'roles'
2. **protected $fillable =** ['name', 'slug', 'permissions']

####### $role->name_uc_first `string`
Baş harfi büyük şekilde kullanıcı rolü adı

####### $role->slug `string`
Kullanıcı rolü url formatındaki hali

####### $role->permissions `array`
Kullanıcı rolü işlem izinlerini dizi şeklinde döndürür

####### $role->permission_collect `Collection`
Kullanıcı rolü işlem izinlerini *Collection objesi* şeklinde döndürür

####### $role->created_at `string`
Kullanıcı rolünün kayıt tarihini ayar dosyasındaki tanıma göre döndürür

####### $role->created_at_for_humans `string`
Kullanıcı rolünün kayıt tarihini okunaklı veri şeklinde döndürür. Örneğin: *1 hafta önce*

####### $role->created_at_table `array`
Kullanıcı rolünün kayıt tarihini `display`(last_login_for_humans) ve `timestamp` şeklinde tutulan bir dizi şeklinde döndürür. Datatable'da kullanılması amacıyla oluşturulmuştur

####### $role->updated_at `string`
Kullanıcı rolünün güncellenme tarihini ayar dosyasındaki tanıma göre döndürür

####### $role->updated_at_for_humans `string`
Kullanıcı rolünün güncellenme tarihini okunaklı veri şeklinde döndürür. Örneğin: *1 hafta önce*

####### $role->updated_at_table `array`
Kullanıcı rolünün güncellenme tarihini `display`(last_login_for_humans) ve `timestamp` şeklinde tutulan bir dizi şeklinde döndürür. Datatable'da kullanılması amacıyla oluşturulmuştur



<a name="kullanim-gorunumTasarlama-rotalar"></a>
##### Rotalar
**Laravel User Module** paketi *CRUD* işlemleri için sahip olduğu rotaların dışında, `ajax` ile işlem yapabileceğin birçok rotaya da sahiptir. Görünümlerini tasarlarken bunları kullanabilirsin.

> Rotalarda kullanılabilecek form elemanları bir sonraki bölümde anlatılacaktır.

<a name="kullanim-gorunumTasarlama-rotalar-auth"></a>
###### Giriş - Çıkış - Kayıt Rotaları
Giriş, çıkış, kayıt, şifre hatırlatma vb. işlemler için kullanılan rotalardır.

| Rota Adı | Açıklama | Tür|
|---|---|---|
| getLogin | Giriş sayfası | GET |
| postLogin | Giriş sayfasından form verilerinin gönderildiği sayfa | POST |
| getLogout | Çıkış sayfası | GET |
| getRegister | Kayıt sayfası | GET |
| postRegister | Kayıt sayfasından form verilerinin gönderildiği sayfa | POST |
| accountActivate | Kayıt sonrası hesabın aktifleştirileceği rota. Bu rotada kullanıcı `id`si ve Sentinel Activation tarafından üretilen `code` kullanılıyor. Paket kayıt sonrası bu adresi direkt kullanıcıya e-posta olarak gönderiyor. | GET |
| getForgetPassword | Şifremi unuttum sayfası | GET |
| postForgetPassword | Şifremi unuttum sayfasından form verilerinin gönderildiği sayfa | POST |
| getResetPassword | Şifre sıfırlama sayfası. Şifremi unuttum işlemi sonrası paket kullanıcıya *şifre sıfırlama* e-postası gönderir. Bu bağlantı burada kullanıcıya ulaşmış olur | GET |
| postResetPassword | Şifre sıfırlama sayfasından form verilerinin gönderildiği sayfa | POST |

<a name="kullanim-gorunumTasarlama-rotalar-user"></a>
###### Kullanıcı Rotaları
Başta kullanıcı CRUD işlemleri olmak üzere, bir kısım *ajax* işlemini de kapsayan rotalar.

| Rota Adı | Açıklama | Tür|
|---|---|---|
| admin.user.index | Kullanıcıların listelendiği sayfa | GET |
| admin.user.create | Yeni kullanıcı eklendiği sayfa | GET |
| admin.user.store | Yeni kullanıcı eklendiği sayfadan form verilerinin gönderildiği sayfa | POST |
| admin.user.show | Kullanıcı bilgilerinin gösterildiği sayfa. Bu sayfayı oluşturulacak görünümlere `$user` değişkeni aktarılır. | GET |
| admin.user.edit | Kullanıcı bilgilerinin düzenlendiği sayfa. Bu sayfayı oluşturulacak görünümlere `$user` değişkeni aktarılır. | GET |
| admin.user.update | Kullanıcı bilgilerinin düzenlendiği sayfadan form verilerinin gönderildiği sayfa | PUT-PATCH |
| admin.user.destroy | Kullanıcının silindiği sayfa | DELETE |
| admin.user.changePassword | Kullanıcı şifresininin güncellenmesi için form verilerinin gönderildiği sayfa | POST |
| admin.user.permission | Kullanıcı işlem izinleri verilerinin gönderileceği sayfa. Kullanıcı izinleri formunu oluşturman için aşağıda bir bahis daha geçecek. | POST |
| api.user.index | Bu rotada ajax ile Datatable türü veriler çekilir. Gelen sütunlar şunlardır: `id`, `photo`, `fullaname` *(first_name ve last_name sütunlarından oluşturulur)*, `created_at`, `status` *(is_active sütunundan oluşturulur)*, `urls` *(tablonun eylemler sütununda kullanılmak üzere oluşturulmuş bazı adreslerdir.)*. Bütün bunlar dışında `action=filter` verisi ile birlikte; *id*, *first_name*, *last_name*, *status*, *created_at_from* ve *created_at_to* verileri gönderilerek; filtrelenmiş veriler elde edebilirsin | GET |
| api.user.store | Yeni kullanıcı eklenmesi için verilerin gönderildiği sayfa. Fotoğraf dışında bütün veriler gönderilebilir | POST |
| api.user.update | Kullanıcı bilgilerinin düzenlenmesi için verilerin gönderildiği sayfa. Fotoğraf dışında bütün veriler gönderilebilir. | PUT-PATCH |
| api.user.destroy | Kullanıcının silinmesi için verilerin gönderildiği sayfa | DELETE |
| api.user.group | Kullanıcılar üzerinde grup işlemleri yapmak için kullanılan bir rota. Aktifleştirme, aktifliği kaldırma ve silme işlemlerini destekliyor. `action=activate` gibi bir veri ile birlikte, dizi içinde işlem yapılacak kullanıcı id'leri gönderilir. Aşağıda veri detayları açıklanmıştır. | POST |
| api.user.detail | Kullanıcı id'si iliştirilmiş rota ile kullanıcı *id*, *email*, *last_login*, *updated_at*, *roles* (virgül ile ayrılmış metin türünde) bilgileri Datatable formatında gönderilir | GET |
| api.user.fastEdit | Hızlı bir şekilde kullanıcı bilgisini düzenlemek için; bilgilerin çekildiği rotadır. Rotaya kullanıcı id'si iliştirilir ve kullanıcı bilgilerinin tamamı çekilir | POST |
| api.user.activate | Id'si iliştirilen kullanıcının hesabını aktifleştirildiği rota | POST |
| api.user.notActivate | Id'si iliştirilen kullanıcının hesabınının aktifliğinin kaldırıldığı rota | POST |
| api.user.avatarPhoto | Kullanıcının fotoğrafının eklendiği rota. Eski fotoğrafı siler ve yeni fotoğrafı ayar dosyasına göre ekler | POST |
| api.user.destroyAvatar | Id'si iliştirilen kullanıcının fotoğrafını siler ve varsayılan fotoğrafın tekrar kullanılmasını sağlar | POST |


<a name="kullanim-gorunumTasarlama-rotalar-role"></a>
###### Kullanıcı Rolü Rotaları
Başta kullanıcı rolü CRUD işlemleri olmak üzere, bir kısım *ajax* işlemini de kapsayan rotalar.

| Rota Adı | Açıklama | Tür|
|---|---|---|
| admin.role.index | Kullanıcı rollerinin listelendiği sayfa | GET |
| admin.role.create | Yeni kullanıcı rolü eklendiği sayfa | GET |
| admin.role.store | Yeni kullanıcı rolü eklendiği sayfadan form verilerinin gönderildiği sayfa | POST |
| admin.role.show | Kullanıcı rolü bilgilerinin gösterildiği sayfa. Bu sayfayı oluşturulacak görünümlere `$role` değişkeni aktarılır. | GET |
| admin.role.edit | Kullanıcı rolü bilgilerinin düzenlendiği sayfa. Bu sayfayı oluşturulacak görünümlere `$role` değişkeni aktarılır. | GET |
| admin.role.update | Kullanıcı rolü bilgilerinin düzenlendiği sayfadan form verilerinin gönderildiği sayfa | PUT-PATCH |
| admin.role.destroy | Kullanıcı rolünün silindiği sayfa | DELETE |
| api.role.index | Bu rotada ajax ile Datatable türü veriler çekilir. Gelen sütunlar şunlardır: `id`, `name`, `slug`, `created_at`, `urls` *(tablonun eylemler sütununda kullanılmak üzere oluşturulmuş bazı adreslerdir.)*. Bütün bunlar dışında `action=filter` verisi ile birlikte; *id*, *name*, *slug*, *created_at_from* ve *created_at_to* verileri gönderilerek; filtrelenmiş veriler elde edebilirsin | GET |
| api.role.store | Yeni kullanıcı rolü eklenmesi için verilerin gönderildiği sayfa | POST |
| api.role.update | Kullanıcı rolü bilgilerinin düzenlenmesi için verilerin gönderildiği sayfa | PUT-PATCH |
| api.role.destroy | Kullanıcı rolünün silinmesi için verilerin gönderildiği sayfa | DELETE |
| api.role.models | Kullanıcı rollerinin isme veya url tanımlamasına göre filtrelenip döndürüldüğü rota  | POST |
| api.role.group | Kullanıcı rolleri üzerinde grup işlemleri yapmak için kullanılan bir rota. Silme işlemini destekliyor. `action=destroy` şeklinde bir veri ile birlikte, dizi içinde işlem yapılacak kullanıcı id'leri gönderilir. Aşağıda veri detayları açıklanmıştır. | POST |
| api.role.detail | Kullanıcı rolü id'si iliştirilmiş rota ile kullanıcı rolü *id*, *name*, *slug*, *created_at*, *updated_at* bilgileri Datatable formatında gönderilir | GET |
| api.role.fastEdit | Hızlı bir şekilde kullanıcı rolü bilgisini düzenlemek için; bilgilerin çekildiği rotadır. Rotaya kullanıcı rolü id'si iliştirilir ve kullanıcı rolü bilgilerinin tamamı çekilir | POST |



<a name="kullanim-gorunumTasarlama-formAlanlari"></a>
##### Form Alanları
İşlemler sırasında görünümlerinde kullanacağın form elemanları veri tabanı tablolarındaki sütun isimleriyle aynı olmalıdır. Aşağıda her işlem için gereken eleman listesi verilmiştir.

:exclamation: Aşağıda belirtilen form isimleri kullanılması zorunlu olup, sırası değişebilir.

> `lang/.../validation.php` dosyanda bu form isimlerinin metin değerlerini belirtmeyi unutma! Ayrıca her dil için validation dosyası oluşturmalısın.

<a name="kullanim-gorunumTasarlama-formAlanlari-auth"></a>
###### Giriş - Çıkış - Kayıt Formları

* `register` işlemi form elemanları
    * first_name
    * last_name
    * email
    * password
    * password_confirmation
    * terms

**RegisterRequest**

```php
public function rules()
{
    return [
        'first_name'    => 'required|max:255',
        'last_name'     => 'required|max:255',
        'email'         => 'required|unique:users|email|max:255',
        'password'      => 'required|confirmed|min:6|max:255',
        'terms'         => 'required|in:1|accepted'
    ];
}

• login işlemi form elemanları
  • email
  • password
  • remember

LoginRequest, <sub>(*23)</sub>

public function rules()
{
    return [
        'email'         => 'required|email|max:255',
        'password'      => 'required|min:6|max:255',
    ];
}

• forgetPassword işlemi form elemanları
  • email

ForgetPasswordRequest, <sub>(*24)</sub>

public function rules()
{
    return [
        'email'         => 'required|email|max:255',
    ];
}

• resetPassword işlemi form elemanları
  • email
  • password
  • password_confirmation

ResetPasswordRequest, <sub>(*25)</sub>

public function rules()
{
    return [
        'email'         => 'required|email|max:255',
        'password'      => 'required|confirmed|min:6|max:255',
    ];
}

, <sub>(*26)</sub>

Kullanıcı Formları

• store işlemi form elemanları
  • first_name
  • last_name
  • email
  • password
  • password_confirmation
  • photo
  • x (fotoğraf kırpılacaksa; kırpılacak halin sol üst köşe konumu x değeri)
  • y (fotoğraf kırpılacaksa; kırpılacak halin sol üst köşe konumu y değeri)
  • width (fotoğraf kırpılacaksa; kırpılacak halin width değeri)
  • height (fotoğraf kırpılacaksa; kırpılacak halin height değeri)
  • permissions

StoreRequest, <sub>(*27)</sub>

public function rules()
{
    return [
        'first_name'    => 'required|max:255',
        'last_name'     => 'required|max:255',
        'email'         => 'required|unique:users|email|max:255',
        'password'      => 'required|confirmed|min:6|max:255',
        'photo'         => 'max:5120|image|mimes:jpeg,jpg,png',
        'x'             => 'integer',
        'y'             => 'integer',
        'width'         => 'integer',
        'height'        => 'integer',
        'permissions'   => 'array',
    ];
}

• update işlemi form elemanları
  • first_name
  • last_name
  • email
  • password
  • password_confirmation
  • photo
  • x (fotoğraf kırpılacaksa; kırpılacak halin sol üst köşe konumu x değeri)
  • y (fotoğraf kırpılacaksa; kırpılacak halin sol üst köşe konumu y değeri)
  • width (fotoğraf kırpılacaksa; kırpılacak halin width değeri)
  • height (fotoğraf kırpılacaksa; kırpılacak halin height değeri)
  • permissions

UpdateRequest, <sub>(*28)</sub>

public function rules()
{
    return [
        'first_name'    => 'required|max:255',
        'last_name'     => 'required|max:255',
        'slug'          => 'email|max:255|unique:users,slug,'.$this->segment(3),
        'password'      => 'confirmed|min:6|max:255',
        'photo'         => 'max:5120|image|mimes:jpeg,jpg,png',
        'x'             => 'integer',
        'y'             => 'integer',
        'width'         => 'integer',
        'height'        => 'integer',
        'permissions'   => 'array',
    ];
}

• changePassword işlemi form elemanları
  • password
  • password_confirmation

PasswordRequest, <sub>(*29)</sub>

public function rules()
{
    return [
        'password'      => 'required|confirmed|min:6|max:255'
    ];
}

• permission işlemi form elemanları
  • permissions

PermissionRequest, <sub>(*30)</sub>

public function rules()
{
    return [
        'permissions'      => 'array'
    ];
}

• Api index filtreleme işlemi verileri, <sub>(*31)</sub>

  • action=filter
  • id
  • first_name
  • last_name
  • status (is_active sütunu filtrelemesi için; 1 veya 0)
  • created_at_from
  • created_at_to

• Api store işlemi verileri, yukarıdaki store işlemi ile aynıdır. Sadece fotoğraf verileri kullanılmaz, <sub>(*32)</sub>

• Api update işlemi verileri, yukarıdaki update işlemi ile aynıdır. Sadece fotoğraf verileri kullanılmaz, <sub>(*33)</sub>

• Api group işlemi verileri, <sub>(*34)</sub>

  • action=activate|not_activate|destroy
  • id (array şeklinde model id'leri)

• Api avatarPhoto işlemi verileri,, <sub>(*35)</sub>

  • photo
  • x (fotoğraf kırpılacaksa; kırpılacak halin sol üst köşe konumu x değeri)
  • y (fotoğraf kırpılacaksa; kırpılacak halin sol üst köşe konumu y değeri)
  • width (fotoğraf kırpılacaksa; kırpılacak halin width değeri)
  • height (fotoğraf kırpılacaksa; kırpılacak halin height değeri)

PhotoRequest, <sub>(*36)</sub>

public function rules()
{
    return [
        'photo'     => 'required|max:5120|image|mimes:jpeg,jpg,png',
        'x'         => 'integer',
        'y'         => 'integer',
        'width'     => 'integer',
        'height'    => 'integer',
    ];
}

, <sub>(*37)</sub>

Kullanıcı Rolü Formları

• store işlemi form elemanları
  • name
  • slug
  • permissions

StoreRequest, <sub>(*38)</sub>

public function rules()
{
   return [
        'name'          => 'required|max:255',
        'slug'          => 'alpha_dash|max:255|unique:roles',
        'permissions'   => 'array',
    ];
}

• update işlemi form elemanları
  • name
  • slug
  • permissions

UpdateRequest, <sub>(*39)</sub>

public function rules()
{
    return [
        'name'          => 'max:255',
        'slug'          => 'alpha_dash|max:255|unique:roles,slug,'.$this->segment(3),
        'permissions'   => 'array',
    ];
}

• Api index filtreleme işlemi verileri, <sub>(*40)</sub>

  • action=filter
  • id
  • name
  • slug
  • created_at_from
  • created_at_to

• Api store işlemi verileri, yukarıdaki store işlemi ile aynıdır, <sub>(*41)</sub>

• Api update işlemi verileri, yukarıdaki update işlemi ile aynıdır, <sub>(*42)</sub>

• Api group işlemi verileri, <sub>(*43)</sub>

  • action=destroy
  • id (array şeklinde model id'leri)

• Api models işlemi verileri, <sub>(*44)</sub>

  • query (metin şeklinde gönderilir ve name, slug alanlarında like yöntemi ile filtreleme yapar)

, <sub>(*45)</sub>

İşlem İzin Formları

Hem kullanıcı hem de rol işlem izinleri formu oluşturmak çok kolaydır. Laravel User Module bu işlem için ErenMustafaOzdal\LaravelUserModule\Services\PermissionService sınıfını kullanmaktadır. Bu sınıf admin ve api rota adı başlangıcına sahip tüm tanımlı rotaları alır ve Collection türünde döndürür. Bu şekilde izinleri checkbox ile foreach kullanarak listeleyebilirsin. Örnek kullanım için öncelikle formu oluşturacağın blade dosyasına bu sınıfı enjekte et, daha sonra da listeleme yap., <sub>(*46)</sub>

@inject('permission', 'ErenMustafaOzdal\LaravelUserModule\Services\PermissionService')

@foreach($permission->groupByController() as $namespace => $routes)
• {!! $route['route'] !!} {!! Form::checkbox( "permissions[{$route['route']}]", true, isset($permissions[$route['route']]) ) !!}
@endforeach

$permission->getCollection()

Illuminate\Routing\RouteCollection türünden bir liste döndürür, <sub>(*47)</sub>

$permission->getNames()

Illuminate\Support\Collection türünden bir liste döndürür. Bu listenin all anahtarında bütün rotalar yer alır. admin ve api anahtarlarında ise ilgili rota listeleri yer alır., <sub>(*48)</sub>

$permission->getSpecificNames($prefix)

Illuminate\Support\Collection türünden bir liste istenen ön ada sahip rota ismi listesi döndürür. Örneğin: api, <sub>(*49)</sub>

$permission->getNameParts()

Illuminate\Support\Collection türünden bir liste döndürür. $permission->getNames() metodundan tek farkı all anahtarı olmayışıdır., <sub>(*50)</sub>

$permission->getAllNames()

Illuminate\Support\Collection türünden bir liste döndürür. Sadece all anahtarındaki listeyi barındırır., <sub>(*51)</sub>

$permission->groupByController()

Illuminate\Support\Collection türünden Controller türüne göre gruplandırılmış şekilde bütün rotaları döndürür, <sub>(*52)</sub>

$permission->permissionCount()

İşlem izin sayısını, yani rota ismi sayısını döndürür, <sub>(*53)</sub>

$permission->permissionRate($count)

Metoda gönderilen kullanıcı veya kullanıcı rolü izinli işlem sayısı sonucunda; yüzde kaç yetkiye sahip olduğunu döndürür. Döndürdüğü değer türü: integer, <sub>(*54)</sub>

, <sub>(*55)</sub>

Onaylamalar

Laravel User Module paketi yapılan her form isteği için onaylama kurallarını belirlemiştir. Bu tür form istek onaylama kuralları için yapman gereken bir şey yoktur. Yukarıda Request sınıflarının rules metotlarında açıklamaları yapılmıştır., <sub>(*56)</sub>

, <sub>(*57)</sub>

Olaylar

Paket içindeki hemen hemen tüm işlemler belli bir olayı tetikler. Sen kendi listener dosyanda bu olayları dinleyebilir ve tetiklendiğinde istediğin işlemleri kolay bir şekilde yapabilirsin., <sub>(*58)</sub>

, <sub>(*59)</sub>

Giriş - Çıkış - Kayıt Olayları

, <sub>(*60)</sub>

Kullancı Olayları

, <sub>(*61)</sub>

Kullancı Rolü Olayları

, <sub>(*62)</sub>

Lisans

MIT, <sub>(*63)</sub>