Kullanıcı Kütüphanesi

Kullanıcılar veya üyelerle ilgili bir takım işlemlerin yapıldığı sınıftır. Yeni üyelik, siteye giriş, aktivasyon, üye bilgilerini kullanma gibi işlevleri vardır.

# Kurulum

ZN dağıtımları için kurulum gerekmez.

↓ composer require znframework/package-authentication

# Yapılandırma

User kütüphanesi veritabanı ile çalıştığı için ilgili veritabanı tablosuna ait ilgili kolonların kütüphaneye bildirilmesi gerekir. Bu kütüphane ile ilgili ayarlar aşağıdaki dosyalarlarda yer alır.

$encode = 'super'

$verification = ''

$otherLogin = []

'encode'    => 'super',
'spectator' => '',
'matching'  =>
[
    'table'   => 'users',
    'columns' =>
    [
        'username'     => 'user',
        'password'     => 'pass',
        'email'        => 'mail',
        'active'       => '',
        'banned'       => '',
        'activation'   => 'activation',
        'verification' => '', 
        'otherLogin'   => ['phone'] 
    ]
],
'joining' =>
[
    'column' => 'id',
    'tables' => ['addresses.user_id']
],
'emailSenderInfo' =>
[
    'name' => 'Company Name',
    'mail' => '[email protected]'
]

Şifreleme algoritması olarak super seçilmesi durumunda bu algoritmanın bir parçasını oluşturan proje anahtarının varsayılan değeri domain ve proje adına göre farklılık gösterdiğinden geliştirilen bir projenin farklı bir domaine taşınması veya domain adının değişmesi durumunda mevcut projede oluşturulan kullanıcı şifreleri geçerliliğini kaybedecektir. Böyle bir durumun önüne geçmek için aşağıda yer alan değere projeye özel herhangi bir proje anahtarı belirleyin. 

'key' => '$19a04��1d4x#1d' # Projeye özel bir herhangi bir dizge tercih edebilirsiniz.

Konsol üzerinden 64 karakterli rasgele proje anahtarı oluşturulmasını sağlayabilirsiniz.

php zerocore generate-project-key

# Yöntemler

# Register

Kullanıcı bilgilerinin, yapılandırma dosyasında yer alan 'table' ayarına belirtilen tabloya kayıt edilmesi için kullanılır. Register yönteminin 1. parametresine ilgili tabloya eklenecek veriler dizi türünde belirtilir.

Parametreler

mixed $autoLogin = false

string $returnLink = NULL

Opsiyonel Yöntemler

Kullanımlar

<?php namespace Project\Controllers;

use User, Post;

class Accounts
{
    public function register()
    {
        if( Post::submit() )
        {
            User::register
            (
                [
                    'username' => Post::username(),
                    'password' => Post::password(),
                    'usermail' => Post::email(),
                    'address'  => Post::address(),
                    'phone'    => Post::mobilePhone()  
                ],  
                'users/login'
            );
        }
    }
}

Yukarıda kullanıcı kayıt işleminden sonra 2. parametrede belirtilen users/login sayfasına yönlenmesini istemiş olduk.

User::register() yönteminin 1. parametresine oto eşleşme özelliği de bulunmaktadır. Formdan gelen input nesnelerinin isimleri kullanıcı tablosunun kolon isimleri ile aynı belirtilirse form gönderim yöntemine göre otomatik eşleşme yapılır.

Kullanılabilir Seçenekler

User::register('post'); # post, get veya request

Eğer birleştirilmiş tablolar varsa üye kayıt işlemini aşağıdaki gibi yapılmalıdır.

User::register
([
     'table1' => ['column1' => 'value1', ...],
     'table2' => ['column1' => 'value2', ...]
]);

Otomatik giriş yapılmasını istersek 2. parametreyi true olarak ayarlamamız gerekir. Hem oto giriş hem de sayfa yönlendirmesi için aşağıdaki gibi kullanılmalıdır.

User::register
([
    'username' => Post::username(),
    'password' => Post::password() 
],  true);

if( User::isLogin() )
{
    redirect('profile');
}

# Login

Kullanıcıların giriş yapmaları için kullanılır.

Parametreler

Opsiyonel Yöntemler

Kullanımlar

$status = User::login(Post::username(), Post::password(), Post::rememberMe());

if( $status === true )
{
    redirect(URL::prev());
}

# IsLogin

Kullanıcının giriş yapıp yapmadığı kontrol etmek için kullanılır.

Parametreler

Kullanımlar

if( User::isLogin() )
{
    echo 'Hi, User';
}

# Data

Giriş yapmış kullanıcıya ait kullanıcı bilgilerini dizi türünde verir.

Parametreler

Kullanımlar

$data = User::data();

output([$data->username, $data->email]);

Eğer birleştirilmiş kullanıcı tabloları kullanılıyorsa 1. parametreye hangi tablodan verilerin alınmak istendiği belirtilir.

$profile = User::data('user_profile');
$user    = User::data('users');

output([$user->username, $profile->address]);

# Logout

Kullanıcı çıkışı yapmak için kullanılır.

Parametreler

Kullanımlar

User::logout(URL::prev(), 2);

# Update

Giriş yapan kullanıcıların eski şifresi ile şifre bilgileri ve mevcut diğer bilgilerini güncellemeleri için kullanılır.

Parametreler

string $newPassword = NULL

Opsiyonel Yöntemler

Kullanımlar

Sadece şifre güncellenmesi istenirse;

User::update(Post::oldPassword(), Post::newPassword());

Şifre ile birlikte diğer bilgilerinde güncellenmesi istenirse;

User::update
(
    Post::oldPassword(),
    Post::newPassword(),
    NULL,
    [
        'name'  => Post::name(),
        'phone' => Post::phone(),
    ]
);

gibi kullanılabilir.

Kullanıcı tablosu birleştirilmiş tablolardan oluşuyorsa;

User::update
(
    Post::oldPassword(),
    Post::newPassword(),
    NULL,
    [
        'users' =>
        [
            'name'  => Post::name(),
            'phone' => Post::phone()
        ],

        'user_profile' =>
        [
            'first_name' => Post::firstName(),
            'last_name'  => Post::lastName()
        ]
    ]
);

gibi kullanılır.

# ForgotPassword

Şifremi unuttum yöntemidir.

Parametreler

string $change = 'before'

Opsiyonel Yöntemler

Kullanımlar

User::forgotPassword(Method::post('email'), 'users/login');

2. parametre şifremi unuttum için gönderilen e-posta da yer alan linktir. Bu linke tıklandığında hangi sayfaya dönülmesi istendiği belirtilir.

User::forgotPassword() yöntemine şifre değiştirme işleminin hangi aşamada yapılacağını belirten 3. bir parametre bulunmaktadır.

Kullanılabilir Seçenekler

User::forgotPassword(Method::post('email'), 'users/passwordChangeComplete', 'after');

Şifre değiştirme işlemini tamamlamak için kullanılır. Bu yönteme User::forgotPassword() yönteminin 3. parametresinin 'after' ayarlanması durumunda ihtiyaç duyulur.

Parametreler

string $redirect = NULL

Kullanımı

public function passwordChangeComplete()
{
    User::passwordChangeComplete('users/login');
}

Yukarıdaki kullanım şifre değiştirme işleminin başarılı olaması durumunda users/login kontrolcüsüne yönlendirme yapar.

Şifremini unuttum işlemi için sadece e-posta bilgisinin kullanılması bazı güvenlik sorunlarına neden olabilir. Bu nedenle e-posta bilgisi dışında 2. bir güvenlik bilgisine daha ihtiyaç duyulur. Bu güvenlik bilgisinin tabloda hangi kolonda tutulacağını yukarıda yapılandırmada yer alan verification yapılandırmasında belirtilir.

User::verification(Post::verification())->forgotPassword(Post::email(), 'users/login');

Yukarıdaki kullanımda formlardan gelen doğrulama bilgisi verification() yöntemi içinde kullanılır. Bu doğrulama bilgisi kullanıcıların profillerinden kendi belirtecekleri bir değer olmalıdır.

# SetForgotPasswordEmail

User::forgotPassword() yöntemi ile birlikte kullanılır. Varsayılan e-posta şablonunu değiştirmek için kullanılır.

Parametreler

string $template

string $subject = NULL

Kullanımlar

$template  = 'Merhaba {user}, ';
$template .= 'yeni şifreniz:{pass} ';
$template .= 'işlemi tamamlamak için linke tıklayınız';

User::setForgotPasswordEmail($template)->forgotPassword(Post::email(), 'users/login');

# SendEmailAll

Sistemde kayıtlı kullanıcıların tamamına e-posta gönderimi için oluşturulmuştur.

Parametreler

Kullanımlar

User::sendEmailAll('New Topic', 'Added new topic.');

Bu e-posta gönderimine dosya eklemek isterseniz opsiyonel yöntem olaran attachment() yönteminden yararlanabilirsiniz. Yöntemin parametreleri Email::attachment() yöntemi ile bire bir aynıdır.

User::attachment('path/topic.jpg')->sendEmailAll('New Topic', 'Added new topic');

# ActivationComplete

Ayarlardan activation kolonu belirtilmişse ve kayıt yaparken register() yönteminin 3. parametresi ile dönüş linki belirtilmişse bu yöntemden istifade edilebilir. Bu yöntem dönüş linki belirtilen sayfada kullanılmalıdır. Yani e-posta üzerinden gelinmesini istediğiniz sayfada kullanılması gerekir. Böylece belirtilen sayfaya istek yapıldığında kullanıcı aktivasyonu tamamlanmış olur.  Bu kolonun tutması gereken değer 0 ve 1 değeri olacak şekilde ayarlanmalıdır.

Parametreler

mixed $decryptor = 'pass'

Kullanımlar

Dönüş linki ile ziyaret edilecek sayfada kullanılması gereken yöntem.

public function activationComplete()
{
    User::activationComplete();
}

Gönderilen ön tanımlı e-posta şablonunda link yapısı aşağıdaki gibidir.

$url . 'user/' . $user . '/pass/' . $pass

Bu dizilim üzerinde değişilik yapılabilir;

$url . 'u/' . $user . '/p/' . $pass

Böyle bir düzenlemeden sonra bu yöntemi aşağıdaki gibi kullanmanız gerekmektedir.

User::activationComplete('u', 'p');

E-posta ile gönderilen linkte kriptolu gönderilen şifrenin daha güvenli bir formda gönderilmesini sağlayabilirsiniz.

$url . 'u/' . $user . '/p/' . base64_encode($pass)

Yukarıdaki gibi bir link gönderiminden sonra eşleşme için geri çağrım işlevi uygulanmalıdır.

User::activationComplete('u', function()
{
    return base64_decode(URI::get('p'));
});

# SetActivationEmail [5.7.3]

User::register() yöntemi ile birlikte kullanılır. Eğer activation kolonu ayarlı ise User::register() yöntemi kendi içerisinde bir aktivasyon e-postası gönderir. Varsayılan e-posta şablonunu değiştirmek için kullanılır.

Parametreler

string $template

string $subject = NULL

Kullanımlar

$template = 'Click please do activation';

User::setActivationEmail($template)->register
([ 
    'username' => Post::username(), 
    'password' => Post::password(), 
    'usermail' => Post::email(), 
    'address'  => Post::address(), 
    'phone'    => Post::mobilePhone() 
], 'users/login');

Yukarıdaki örnek e-posta içeriğinde yer alan [user/{user}/pass/{pass}] çıktısı aşağıdakine benzer bir yapıda olacaktır.

# ResendActivationEmail

Aktivasyon e-postasının herhangi bir neden gelmemesi durumunda tekrar gönderim sağlamak için kullanılır.

Parametreler

string $email = NULL

Kullanımlar

User::resendActivationEmail($username, 'profile/activation', $usermail);

# Ip

İstek yapılan IP adresi bilgisini verir. Kullanımı Request::ipv4() ile aynıdır.

Parametreler

Kullanımı

echo User::ip();

# Agent (Paket[6.1.2][2020-05-29])

Yapılan isteğin HTTP_USER_AGENT bilgisini verir. Kullanımı Http::userAgent() ile aynıdır.

Parametreler

Kullanımı

echo User::agent();

# Count

Kayıtlı üye sayısını öğrenmek için kullanılır.

Parametreler

Kullanımlar

echo User::count();

# ActiveCount

Oturum açmış kullanıcıların sayısını verir. Ancak bu yöntemden yararlanılabilmesi için ayarlardan active kolonunun belirtilmesi gerekir. Bu kolonun tutması gereken değer 0 ve 1 değeri olacak şekilde ayarlanmalıdır.

Parametreler

Kullanımlar

echo User::activeCount();

# BannedCount

Banlanmış kullanıcıların sayısını verir. Ancak bu yöntemden yararlanılabilmesi için ayarlardan banned kolonunun belirtilmesi gerekir. Bu kolonun tutması gereken değer 0 ve 1 değeri olacak şekilde ayarlanmalıdır.

Parametreler

Kullanımlar

echo User::bannedCount();

# GetEncryptionPassword

User:: kütüphanesinin seçili şifreleme algoritmasına göre parametre olarak belirtilen şifrenin yeniden şifrelenmesini sağlar. Bu yöntem User:: kütüphanesine ek olarak yürüteceğiniz işlemlerde mevcut kullanıcı şifreleri ile ilgili bir çalışma yapmanız durumunda doğru kullanıcı şifresini oluşturmanıza olanak sağlar.

Parametreler

Kullanımlar

echo User::getEncryptionPassword('1234');

# Success

Kullanıcı işlemlerine yönelik başarı bilgisi döndürür.

Parametreler

Kullanımlar

echo User::success();

# Error

Kullanıcı işlemlerine yönelik hata bilgisi döndürür.

Parametreler

Kullanımlar

echo User::error();