Dahil Etme Yöntemleri


    × Bunları biliyor muydunuz?
"Şablon sihirbazında (Wizard) (5.5.60) sürümünden beri döngülerin sonunda kullanılan : sembolünün kullanım zorunluluğu kaldırılmıştır."


Bu kütüphane görünüm, js, css, font gibi varlık dosyalarını dahil etmek için kullanılır. Kütüphanelerin ise ZN Framework'ün oto yükleyici özelliğinden dolayı dahil edilmesine gerek yoktur.

 

 

# Dahil Edilme Önceliği


Dosyalar genellikle External/ ve Projects/ dizininde yer alan ilgili dizinlerden dahil edilir. Ama burada bilmeniz gereken aynı isimli dosyaların varlığı durumunda öncelikle hangi dizindeki dosyanın dahil edileceğidir. Bu sıralama;

1 - Projects
2 - External

gibidir. Dosya yükleme önceliği Internal (Dahili) yapılardır. Eğer burada dosya mevcut değilse bu defa External (Harici) dizine bakılır. Dosya her 2 dizin de mevcut değilse herhangi bir dahil edilme işlemi yapılmaz.

 

 

# Yöntemler


3.0.0 This usable(Bool $usable = true)
3.0.0 This data(Array $data)
1.0.0 Mixed view(String $page, Array $data = NULL, Bool $contents = false)
1.0.0 Mixed template(String $page, Array $data = NULL, Bool $contents = false)
1.0.0 String style(String ...$styles)
1.0.0 String script(String ...$scripts)
1.0.0 String font(String ...$fonts)
1.0.0 Mixed something(String $page, Array $data = NULL, Bool $contents = false)
3.0.0 This recursive(Bool $recursive = true)
3.0.0 Mixed theme(Mixed $theme, Bool $recursive = false, Bool $contents = false)
3.0.0 Mixed plugin(Mixed $plugin, Bool $recursive = false, Bool $contents = false)
3.0.0 Mixed handload(String ...$args)

 

 

# Usable (3.0.0)


Dahil edilen dosyaların içeriğinin değişkene aktarılabilmesine olanak sağlar. Peki neden böyle bir kullanıma ihtiyaç duyulur sorusu aklımıza gelebilir. Bazen bir sayfanın içeriğini başka bir sayfaya veri olarak göndermek gerekebilir. Özellikle kendi masterpage'inizi tasarlamışsanız masterpage olarak ayarlanan sayfaya içerik sayfalarını veri olarak gönderebilmenizi sağlar. Opsiyonel yöntem olduğu için kullanılmak zorunda değildir.

Parametreler

Bool $usable = true Aktarılabilir olsun mu?
Return This

Kullanımı

Dosya: Projects/ProjectDirectory/Controllers/home.php
<?php namespace Project\Controllers;

use Import;

class Home extends Controller
{
    public function main()
    {
        $content = Import::usable()->view('content');
        $styles  = Import::usable()->styles('mystyle', 'sitestyle');
        
        View::content($content)->styles($styles);
    }
}

 

 

# Data (3.0.0)


Dahil edilen PHP sayfalarına veri göndermek için kullanılır. Opsiyonel yöntem olduğu için kullanılmak zorunda değildir.

Parametreler

Array $data Görünüm sayfalarına gönderilecek veriler dizisidir.
Return This

Aşdağıda belirtilen yöntemlerin 2. parametresi yerine kullanılır.

Kullanımı

Dosya: Controllers/home.php
<?php namespace Project\Controllers;

use Import;

class Home extends Controller
{
    public function main()
    {
        $data = 
        [
            'content' => Import::usable()->view('content'),
            'styles'  => Import::usable()->styles('mystyle', 'sitestyle')
        ];

        Import::data($data)->view('home');
    }
}

 

 

# View (0.0.1)


Views/ dizini içerisindeki sayfaların dahil edilmesi veya çağrılması için kullanılır.

Parametreler

String $page Views/ dizininden çağrılacak görünüm sayfasının yolu. .php veya .wizard uzantısı eklemeye gerek yok.
Array $data = NULL Görünüme gönderilecek veriler dizisi.
Bool $usable = false Görünümün içeriği aktarılabilir olsun mu?
Return Mixed

Kullanımı

Dosya: Controllers/home.php
<?php namespace Project\Controllers;

use Import;

class Home extends Controller
{
    public function main()
    {
        Import::view('home');
    }
}
Data Gönderimi

Data gönderimi 2. parametre ile yapılır. Bu parametreye gönderilecek datalar anahtar => değer formunda yazılan bir dizi gönderilmelidir.

<?php namespace Project\Controllers;

use Import;

class Home extends Controller
{
    public function main()
    {
        $content = Import::usable()->view('content');
        $styles  = Import::usable()->styles('mystyle', 'sitestyle');

        Import::view('home',
        [
            'content' => $content,
            'styles'  => $styles
        ]);
    }
}
Değişkene Aktarılabilirlik

Değişkene aktarım için 3. parametrenin true olarak ayarlanması ya da usable(true) yönteminin kullanılması gerekir. Eğer 3. parametreyi kullanıyor ve data göndermiyorsanız 2. parametreyi NULL ya da [] ayarlamanız gereklidir.

<?php namespace Project\Controllers;

use Import;

class Home extends Controller
{
    public function main()
    {
        $content = Import::view('content', NULL, true);

        Import::view('home',
        [
            'content' => $content
        ]);
    }
}

 

 

# Template (0.0.1)


Bu yöntem view kullanımı ile benzer olup 2 dizinden çağrım yapar. Çağrım önceliğine göre bu dizinler aşağıdaki gibidir.

Dosya: Projects/Any/Resources/Templates/
Dosya: External/Resources

Genellikle bu dizinlerde .php uzantılı html içerikli tablolar, şemalar, formlar yer alır.

Parametreler

String $page Resources/Templates/ dizininden çağrılacak şablon dosyasının yolu. .php veya .wizard uzantısı eklemeye gerek yok.
Array $data = NULL Görünüme gönderilecek veriler dizisi.
Bool $usable = false Görünümün içeriği aktarılabilir olsun mu?
Return Mixed

Kullanımı

Dosya: Controllers/home.php
<?php namespace Project\Controllers;

use Import;

class Home extends Controller
{
    public function main()
    {  
        $templateData  =

        [
            'subject' => 'Example Subject',
            'message' => 'Example Message'      
        ];
      
        $emailTemplate = Import::template('MyEmailTemplate', $templateData, true);
        
        View::emailTemplate($emailTemplate);
    }
}


 

# Style / Script (0.0.1)


Harici olarak .css veya .js uzantılı stil ve script dosyalarını görünüme dahil etmek için kullanılır. Import::style() ve Import::script() yöntemlerinin kullanımları bire bir aynı olduğu için anlatım sadece Import::style() üzerinden götürülmüştür.

Theme::active() yöntemi ile herhangi bir tema dizini (Resources/Themes/Default/) aktif edilmişse yol bilgisi bu aktif edilen dizini gösterecek şekilde içerisine oluşturulmuş stil dosyalarını dahil etmek için kullanılır. Bu yöntem ile herhangi bir tema aktive işlemi yapılmamışsa yol bilgisi belirtmeye Resources/Themes/ dizini içerisinden başlar. Aynı anda birden fazla dosyayı dahil edebilmeniz mümkündür.

Aşağıdaki gibi örnek bir dosya dizin yapısına sahip olduğumuzu varsayalım;

Resources/Themes/Blue/

site.css
contact.css
panel.css

Parametreler

Mixed ...$args Resources/Themes/ dizininden çağrılacak css dosyasının yolu.
Return Mixed

Kullanımı

Herhangi bir tema ative işlemi gerçekleştirilmemişse aşağıdaki kullanımlar yukarıdaki örnek dizin yapısına göre yol bilgisi Resources/Themes/ dizinini gösterecek şekilde belirtilerek dahil edilir.

Import::style('Blue/site');

Birden çok stil dosyasını aynı anda dahil etmek istersek aşağıdaki şekilde kullanırız.

Import::style('Blue/site', 'Blue/contact', 'Blue/panel');
Tema Aktivasyonu

Eğer tema aktif edilmişse bu defa yol bilgisi aktif edilen bu tema dizini gösterecek şeilde belirtilir.

Dosya: Controllers/Initialize.php
Theme::active('Blue');
Dosya: Views/Sections/head.wizard.php
Import::style('site', 'contact', 'panel');
Değişkene Aktarılabilirlik

Eğer import edilen stil dosyasını bir değişkene veri olarak aktarmak istersek son parametre true olarak girilmelidir.

$style = Import::style('site', 'contact', 'panel' , true);
Uzak Bağlantılı Linkler

Settings/CDNLinks.php yapılandırma dosyasında yer alan link anahtarları ilgili stili yüklemek için kullanılabilir.

Import::style('bootstrap', 'awesome');

 

 

# Font (0.0.1)


Resources/Themes/Any/ dizini içerisine eklenmiş font dosyalarını dahil etmek için kullanılır. Desteklenen fontlar SVG, WOFF, OTF, TTF, EOT uzantılı fontlardır. Istenirse Settings/Expressions.php ayar dosyasında yer alan 'differentFontExtensions' => [] ayarından desteklenmesi istenen farklı bir font türleri belirtilebilir.

Parametreler

Mixed ...$args Resources/Themes/ dizininden çağrılacak font dosyasının yolu.
Return Mixed

Kullanımı

Değişkene aktarılabilirlik ve Tema aktivasyonu kullanımları Import::style() gibidir. 

Import::font('Elips');

Birden çok font dosyasını aynı anda dahil etmek istersek aşağıdaki şekilde kullanırız. Aynı anda birden fazla font dahil edilebilir.

Import::font('Elips', 'Abode', 'Secrcode/secrcode');
Farklı Uzantılar

Eğer font dosyanızın farklı uzantılı türleride varsa onlarda yüklenir.

Aşağıdaki gibi örnek bir font dosyalarınızın olduğunu varsayalım;

Resources/Themes/Blue/fonts/

akrobat.svg
akrobat.ttf
akrobat.eot

Aşağıdaki kullanım bu fontların hepsini dahil eder.

Import::font('fonts/akrobat');
Uygulama

Kullanımı daha iyi anlamanız için basit bir kod üzerinde inceleyelim.

Dosya: Controllers/home.php
<?php namespace Project\Controllers;

use Import;

class Home extends Controller
{
    public function main()
    {
        Import::font('Akrobat/Black');
    }
}
View File: Views/home/main.php
<div style="font-family:AkrobatBlack">Font Example</div>

 

 

# Something (0.0.1)


.php, .css veya .js uzantılı dosyaları dahil etmek için kullanılır.

Parametreler

String $page Herhangi bir dizinden çağrılaca dosyanın yolu.
Array $data = NULL Görünüme gönderilecek veriler dizisi.
Bool $usable = false Görünümün içeriği aktarılabilir olsun mu?
Return Mixed

Kullanımı

Import::something(STYLES_DIR . 'site.css');
Import::something(CONTROLLERS_DIR . 'contact.php');
Import::something(CONTROLLERS_DIR . 'contact.php', ['data1' => 1, 'data2' => 2]);
Değişkene Aktarılabilirlik
$page = Import::something(CONTROLLERS_DIR, NULL, true);

Bu kullanım css ve js yüklemeleri içinde geçerlidir.

 

 

# Recursive (3.0.0)


İç dizin taramasını yapılıp yapılmayacağını belirlemek için kullanılır.

Parametreler

Bool $recursive = true İç içe dizin taraması yapılsın mı?
Return This

Kullanımı

Import::recursive()->plugin('Bootstrap');
Import::recursive()->theme('BluePrint');

 

 

# Theme (3.0.0)


Aşağıdaki dizinlerin içinde yer alan tema dizininin adı belirtilerek dizin içindeki tema ile alakalı her dosyanın otomatik olarak yüklenmesi sağlanır.

Proje: Resources/Themes/
Ortak: External/Resources/Themes/

Parametreler

Mixed $theme Tema adı.
Bool $recurseive = false İç içe dizin taraması yapılsın mı?
Bool $usable = false Görünümün içeriği aktarılabilir olsun mu?
Return Mixed

Kullanımı

Import::theme('MyTheme');
Alt Dizin Taraması

Belirtilen dizin içindeki tüm alt dizinlerde bulunan dosyaları yüklemek için kullanılır. Yani alt dizinlerin içerisinde de tarama yapar. 2. parametre true olarak ayarlanmalı veya recursive() yönteminden yararlanılmalıdır.

Import::theme('Slider', true);
Değişkene Aktarılabilirlik

Bir değişkene aktarılarak kullanılmak istenirse 3. parametre true olarak ayarlanmalı veya usable() yönteminden yararlanılmalıdır.

Import::theme('Slider', false, true);
Seçime Göre Yükleme

Birden fazla dosya veya dizin de dahil etme işlemi yapabilmek için 1. parametre array veri türünde belirtilir.

Import::theme(['BlueTheme', 'RedTheme', 'BlackTheme/black.css', 'style.css']);

Package kullanımı için geçerli olan usable() ve recursive() yöntemlerinin kullanımları bu yöntem içinde geçerlidir.

 

 

# Plugin (3.0.0)


Aşağıdaki dizinlerin içinde yer alan eklenti dizininin adı belirtilerek dizin içindeki eklenti ile alakalı her dosyanın otomatik olarak yüklenmesi sağlanır.

Proje: Resources/Plugins/
Ortak: External/Resources/Plugins/

Parametreler

Mixed $plugin Eklenti adı.
Bool $recurseive = false İç içe dizin taraması yapılsın mı?
Bool $usable = false Görünümün içeriği aktarılabilir olsun mu?
Return Mixed

Kullanımı

Import::plugin('MyPlugin');
Alt Dizin Taraması

Belirtilen dizin içindeki tüm alt dizinlerde bulunan dosyaları yüklemek için kullanılır. Yani alt dizinlerin içerisinde de tarama yapar. 2. parametre true olarak ayarlanmalı veya recursive() yönteminden yararlanılmalıdır.

Import::plugin('Slider', true);
Değişkene Aktarılabilirlik

Bir değişkene aktarılarak kullanılmak istenirse 3. parametre true olarak ayarlanmalı veya usable() yönteminden yararlanılmalıdır.

Import::plugin('Slider', false, true);
Seçime Göre Yükleme

Birden fazla dosya veya dizinde dahil etme işlemi yapabilmek için 1. parametre array veri türünde belirtilir.

Import::plugin(['MyPlugins', 'bootstrap/bootstrap.css', 'bootstrap/boostrap.js']);

Yukarıdaki örnek kullanımda aşağıdaki dosyaların yüklenmesi sağlanmıştır.

Themes/MyPlugins/ dizinine ait tüm css ve js uzantılı dosyalar ile Themes/boostrap/boostrap.css ve Themes/boostrap/boostrap.js dosyalarını yükler.

 

 

# Handload (3.0.0)


Aşağıdaki dizinlerin içerisinde yer alan fonksiyon içerikli dosyaları dahil etmek için kullanılır. Uzantı belirtmeye gerek yoktur. Özellikle projeniz için gerekli fonksiyon tanımlamaları yapmak için kullanışlıdır.

Proje: Starting/Handload/
Ortak: External/Starting/Handload/

Parametreler

Mixed ...$args Dosya adı.
Return Mixed

Kullanımı

Import::handload('funcFile1', 'funcFile2');