İsteklerin Kontrol Edilmesi

Kontrolcüler, kullanıcı isteklerine göre duruma bağlı olarak model ile etkileşime girip ilgili görünümün çağrılması için kullanılan ve Nesne Yönelimli Proglama (OOP) ile tasarlanan sınıflardır. Kullanıcıların URL istekleri, bu sınıfların ilgili yöntemlerine yapılır. Bu URL istekleri bir sınıfa ait yöntemi çalıştırır. Kullanıcıların ilk etkileşime girdiği yapılar kontrolcüler olduğu için anlatıma bu bölüme başlıyoruz.

# Bölüm Başlıkları

# Basit Bir Kod Çalıştırmak

● Kontrolcü Bölümü
● Kontrolcü Yöntemi Bölümü
● Parametreler Bölümü
● Otomatik Enjeksiyon Çözümleme (ZN >= 5.7.7)
● Ajax İsteklerinin Kontrolü (ZN >= 6.0.2.0)

# Varsayılan Açılış Kontrolcüsü
# Başlangıç Kontrolcüleri

● Hariç Tutma
● Dahil Tutma
● Çoklu Başlangıç Kontrolcüsü Kullanma
● Alt Kontrolcülere Data Gönderimi

# Kontrolcü Restorasyonu

● Yapılandırma
● Restore Sabiti

# Basit Bir Kod Çalıştırmak

Aşağıda "Welcome to World of ZN" iletisini veren örnek bir kod yer almaktadır. Sizde aşağıda yolu belirtilen dizine aynı isimle Blog.php dosyası oluşturup içeriği aşağıdaki gibi düzenleyin.

<?php namespace Project\Controllers;

class Blog extends Controller
{
    public function main()
    {
        echo "Welcome to World of ZN";
    }
}

Bu kodu çalıştırmak için adres çubuğuna girilmesi gereken URL aşağıdadır.

ZN'nin mevcut ön tanımlı kontrolcüsü Home.php dir. Ve bu kontrolcü içinde  main yöntemi bulunmaktadır. URL üzerinden yapılan isteklerde main ibaresinin adres çubuğunda kullanımına gerek yoktur. Home.php içerisinde yer alan main yöntemini çalıştırmak için adres çubuğuna localhost/home yazılması yeterlidir.

<?php namespace Project\Controllers;

class Blog extends Controller
{
    public function main()
    {
        echo 'Home Page';
    }
}

Adres çubuğuna birinci bölüme erişilecek kontrolcünün dosya adı, ikinci bölüme ise o kontrolcüye ait çalıştırılacak yöntem adı yazılır. Eğer yöntem ismi main ise URL üzerinde belirtilmesine gerek yoktur.

<?php namespace Project\Controllers;

class Blog extends Controller
{
    public function main()
    {
        echo 'Welcome to World of ZN';
    }

    public function comments()
    {
        echo 'Run Now!';
    }
}

Yukarıda yer alan comments yöntemini çalıştırmak için URL adresimizi şu şekilde düzenliyoruz.

Main yöntemini çalıştırmak için URL adresine kontrolcü adını yazmanız yeterlidir.

URL üzerinden yöntemlere parametre göndermek için URL adresinin 3. ve sonraki bölümleri kullanılır. Eğer parametre gönderimi yapılan main yöntemi ise 2. ve sonraki bölümler parametre olarak kullanılır. URL üzerinden gönderilen parametrik değerleri ilgili yöntemin parametreleri tutar. Aşağıdaki örnekte gelen parametrelerin nasıl kullanılabileceği gösterilmiştir.

<?php namespace Project\Controllers;

use Output;

class Products extends Controller
{
    public function main($price, $value)
    {
        Output::write('{0} - {1}', [$price, $value]);
    }

    public function computer($price, $value)
    {
        Output::write('{0} - {1}', [$price, $value]);
    }
}

Main yöntemine istek yapacaksanız yöntem adını kullanmanız gerekli değildir.

ZN Framework belirtilen sürüm itibari ile kontrolcü yöntemlerine nesne enjeksiyonu yapmaya izin verir. Yani herhangi bir kütüphaneyi yöntemlerde parametre olarak çağırabilirsiniz.

<?php namespace Project\Controllers;

class Products extends Controller
{
    protected $database;

    public function __construct(\DB $db)
    {
        $this->database = $db;
    }

    public function main(\Post $post, \Get $get)
    {
        $post::name('Example');
    }
}

Dikkat edilirse yöntemlerin içerisine belirtilen kütüphaneler otomatik enjeksiyon çözümlemesi sayesinde kullanılabilmektedir.

Otomatik çözümleme ile aynı zamanda parametre ile belirtilen kütüphaneler belirtilen değişken isimleri ile görünümlerin içerisinde de kullanılabilir.

{{ $post::name() }}

Kontrolcü yönteminin return type değeri void olarak ayarlanarak ajax kontrolü eklenebilir. Böylece bu yönteme ajax dışında yapılan istekler exit ile sonlandırılarak işleme alınmaz.

<?php namespace Project\Controllers;

use Http;

class Home extends Controller
{
    public function ajaxControlProcess() : void
    {
        # your codes...
    }
}

# Varsayılan Açılış Kontrolcüsü

ZN kod çatısında varsayılan olarak ayarlanmış açılış kontrolcüsü Home.php dosyasıdır. Açılış kontrolcüsünü URL üzerinde belirtmenize gerek yoktur. Bu nedenle URL adresine localhost/ yazıldığında doğrudan bu kontrolcü çalışmaktadır. Bunu değiştirmek için Config/Routing.php dosyasını açıp aşağıdaki openController ayarını değiştirmeniz yeterlidir.

'openController' => 'home'

# Başlangıç Kontrolcüleri

Tüm kontrolcülerden önce tüm sistem için geçerli olacak kodlar çalıştırmak isteyebilirsiniz. Mevcut kontrolcülerinizden birini sistemin tümünde çalışacak kodları yazmak için kullanabilirsiniz. Başlangıçta çalıştırılacak kontrolcüler aşağıdaki yapılandırma dosyasından belirtilir.

$constructors = 'Initialize'

Eğer birden fazla kontrolcü veya aynı kontrolcüye bağlı fonksiyon çalıştıracaksanız değeri dizi olarak belirtmeniz gerekir.

'constructors' => ['StartingController1:functionName', 'StartingController2:functionName']

Aşağıda örnek bir kullanıma yer verilmiştir.

<?php namespace Project\Controllers;

use User;

class Initialize extends Controller
{
    public function main()
    {
        if( CURRENT_CFPATH !== 'user/login' && ! User::isLogin() )
        {
            redirect('user/login');
        }
    }
}

Bazı durumlarda bazı kontrolcülerde başlangıç kontrolcüsünün çalışmamasını isteyebilirsiniz. Örneğin bir login işlemi yapılacağında başlangıç kontrolcüsündeki login kontrolü yüzünden login kontrolcüsü yönlendirmeye girebilir. Bu gibi durumlar nedeni ile bazı kontrolcüleri hariç tutmanız gerekir. Bunun için exclude sabiti kullanılır. Hariç tutulacak kontrolcüler bu diziye belirtilirken kontrolcünün dosya adı kullanılmalıdır.

<?php namespace Project\Controllers;

use User;

class Initialize extends Controller
{
    const exclude = ['Login']; # Kontrolcünün dosya adı belirtilmelidir.

    public function main()
    {
        if( ! User::isLogin() )
        {
            redirect('Login');
        }
    }
}

Kontrolcünün yanı sıra URI bilgisi de hariç tutulabilir. Bu durumda exclude dizisine yazılacak veri küçük harflerden oluşacak şekilde yazılmalıdır.

<?php namespace Project\Controllers;

use User;

class Initialize extends Controller
{
    const exclude = ['account/login']; # It should be written in lower case.

    public function main()
    {
        if( ! User::isLogin() )
        {
            redirect('account/login');
        }
    }
}

Sayfaları hariç tutmanın tam tersidir. Bu sabitin (include) kullanımında başlangıç kontrolcüsünün hangi kontrolcüler üzerinde geçerli olacağını belirtir. İstenirse hem exclude hem include sabitleri bir arada kullanılabilir.

<?php namespace Project\Controllers;

use User;

class Initialize extends Controller
{
    const include = ['home', 'product', 'contact'];

    public function main()
    {
        
    }
}

Çoklu başlangıç kontrolcü kullanımına bazı kodların tüm kontrolcülerde bazılarının ise belirli kontrolcülerde geçerli olması veya olmaması gereken durumlarda ihtiyaç duyulur.

Öncelikle hangi kontrolcülerin başlangıç kontrolcüsü olarak kullanılacağı yapılandırma dosyasına belirtilmelidir.

'constructors' => ['Initialize', 'Master'],

Yukarıdaki yapılandırmadan sonra artık hem Initialize hem de Master kontrolcüleri başlangıç kontrolcüsü olarak kullanılacaktır.

<?php namespace Project\Controllers;

class Master extends Controller
{
    const exclude = ['Login'];

    public function main()
    {
        # Masterpage'nin kullanacağı head ve body sayfaları belirtiliyor.
        Masterpage::headPage('head')->bodyPage('body');
    }
}

Yukarıda Masterpage:: kullanımı Login kontrolcüsü için devre dışı bırakılırken;

<?php namespace Project\Controllers;

use Config;

class Initialize extends Controller
{
    public function main()
    {
        # Config/Database.php -> database
        # Veritabanı ayarı yapılandırılıyor.
        Config::database('database', 
        [
            'database' => 'test',
            'user'     => 'root',
            'password' => '123456'
        ]);
    }
}

Yukarıda yer alan veritabanı yapılandırması hem Login hem de diğer tüm kontrolcüler için devrede olacaktır. 

Görüldüğü üzere birden fazla başlangıç kontrolcüsü kullanımı bu tip yapılandırmaların ayrıştırılması gereken durumlarda gerekli olmaktadır.

Görünüme data göndermek için kulanılan View sınıfı ile istenirse o an çalışan kontrolcüyede data gönderebilir. Bunun için 2 yöntem vardır.

● Kontrolcüde const extract = true tanımlaması.
●  Config/Starting.php -> extractViewData = true tanımlaması.

<?php namespace Project\Controllers;

class Initialize extends Controller
{
    public function main()
    {
        View::sendData('Send Data')->otherData('Other Data');
    }
}

Yukarıdaki örnek data gönderiminden sonra belirtilen 2 yöntemden biri kullanıldığı taktirde kontrolcüde $this nesnesi ile bu değerlere ulaşılabilir.

<?php namespace Project\Controllers;

class MyController extends Controller
{
    const extract = true;

    public function main()
    {
        echo $this->sendData;
        echo $this->otherData;
    }
}

Gönderimler tüm kontrolcüler için geçerli olacaksa her kontrolcüde const extract tanımlası yerine bunu Config/Starting.php değerinden aktif edilmesi daha akıllıca olacaktır.

Doğrudan Erişim (ZN >= 5.6.0)

Bu güncelleme ile const extract kullanmadan doğrudan doğruya aşağıdaki gibi de verileri alabilirsiniz.

<?php namespace Project\Controllers;

class MyController extends Controller
{
    public function main()
    {
        echo View::sendData();
        echo View::otherData();
    }
}

# Kontrolcü Restorasyonu (ZN >= 4.3.0)

Yayında olan bir projenizde bazı kontrolcüler üzerinde kodsal düzenlemeler yaparken kullanıcıların bu düzenlemelere yönelik sonuçlarla karşılamasını istemeyip farklı bir sayfaya yönlendirilmesini sağlayabilirsiniz.

Bu işlem 2 şekilde yapılabilir;

● Yapılandırma dosyası ile.
● Kontrolcü içinde const restore sabiti ile.

Restorasyon ayarları aşağıdaki yapılandırma dosya üzerinden yapılmaktadır. Bu yapılandırma dosyasında yer alan ayarlar aşağıda verilmiştir.

Bu kullanımda $mode değerinin değiştirilmesine gerek yoktur. 

<?php namespace Project\Controllers;

class Home extends Controller
{
    const restore =

    [
        'machinesIP' => '127.0.0.2',   // Array or String
        'functions'  => 'main',        // Array or String
        'routePage'  => 'home/restore' // Route Controller/Function
    ];

    public function main(string $params = NULL)
    {

    }

    public function restore()
    {
        echo 'System Restore!';
    }
}