Çerezler Kütüphanesi
"ZN Framework'te Masterpage kütüphanesi ile çok basit bir şekilde web iskeleti oluşturabilirsiniz."
Çerez oluşturma, kullanma ve silme gibi işlemleri gerçekleştiren sınıftır.
# Kurulum
ZN dağıtımları için kurulum gerekmez.
↓ composer require znframework/package-storage
# Yapılandırma
Cookie | ||
String | $encode = 'super' | Çerez anahtarlarını şifrelemek için kullanılır. Şifrelenmesi istenmiyorsa bu değer boş bırakılır. |
Seçenekler | super, golden, md5, sha1 .... | |
Bool | $regenerate = true | Sayfa yenilenmesinde oturum kimliğinin değiştirilip değiştirilmeyeceği. |
Scalar | $time = 604800 | Çerezin yaşam süresi. |
String | $path = '/' | Çerezlerin tutulacağı dizin bilgisi. |
String | $domain = '' | Çerezin istemciye güvenli bir HTTPS bağlantısı üzerinden mi aktarılması gerektiğini belirtmek için kullanılır. |
Bool | $secure = false | Çerezin istemciye güvenli bir HTTPS bağlantısı üzerinden mi aktarılması gerektiğini belirtmek için kullanılır. |
Bool | $httpOnly = true | TRUE olduğu takdirde çerez sadece HTTP protokolü üzerinden erişilebilir olacaktır. Yani çerez, JavaScript gibi betik dilleri tarafından erişilebilir olmayacaktır. |
# INI Yapılandırması
Bu ayarların kullanımı Session kütüphanesinde anlatılan kullanımla aynıdır.
# Yöntemler
Bool | insert(String $name, $value, Int $time = CONFIG_TIME) |
Mixed | select(String $name) |
Array | selectAll(Void) |
Bool | delete(String $name, String $path = CONFIG_PATH) |
Bool | deleteAll(Void) |
This | time(Int $time) |
This | path(String $path) |
This | domain(String $domain) |
This | secure(Bool $secure) |
This | httpOnly(Bool $httpOnly) |
This | encode(String $name, String $value) |
This | decode(String $hash) |
# Insert (ZN >= 0.0.1)
Çerez oluşturmak için kullanılır.
Parametreler
String | $name | Çerez adı. |
Mixed | $value | Çerezin tutacağı değer. |
Scalar | $time = 604800 | Çerezin yaşam süresi. |
Return | Bool |
Kullanımı
Cookie::insert('example', 'Example Data');
echo Cookie::select('example');
İstenirse değer olarak dizi verisi de tutulabilir.
Cookie::insert('example', ['a', 1, 'b']);
output(Cookie::select('example'));
1 => integer 1 ( length = 1 ),
2 => string 'b' ( length = 3 )
Doğrudan Erişim (ZN >= 5.2.0)
Cookie::example('Example Data');
# Select (ZN >= 0.0.1)
Oluşturulan çerezleri kullanmak için kullanılır. Eğer oturum bulunmazsa FALSE
değeri döner.
Parametreler
String | $name | Çerez adı. |
Return | Mixed |
Kullanımı
Cookie::insert('example', 'Example Data');
echo Cookie::select('example');
Doğrudan Erişim (ZN >= 5.2.0)
echo Cookie::example();
# SelectAll (ZN >= 0.0.1)
Oluşturulan tüm çerezlerin değerlerini dizi olarak almak için kullanılır.
Parametreler
Void | ||
Return | Array |
Kullanımı
Cookie::insert('example', ['a', 1, 'b']);
Cookie::insert('value', 'Value');
output(Cookie::selectAll());
example => string '["a",1,"b"]' ( length = 13 ),
Doğrudan Erişim (ZN >= 5.2.0)
output(Cookie::all());
# Delete (ZN >= 0.0.1)
Oluşturulan çerezleri silmek için kullanılır.
Parametreler
String | $name | Çerez adı. |
Return | Bool |
Kullanımı
Cookie::insert('example', 'Example Data');
Cookie::delete('example');
echo Cookie::select('example');
Doğrudan Erişim (ZN >= 5.2.0)
Cookie::exampleDelete();
# DeleteAll (ZN >= 0.0.1)
Oluşturulan tüm çerezleri silmek için kullanılır.
Parametreler
Void | ||
Return | Bool |
Kullanımı
Cookie::insert('example', ['a', 1, 'b']);
Cookie::insert('value', 'Value');
Cookie::deleteAll();
output(Cookie::selectAll());
# Time (ZN >= 3.0.1)
Çerezin yaşam süresini belirlemek için kullanılır. Opsiyonel yöntemdir. Cookie::insert() yönteminin 3. parametresi yerine kullanılır.
Parametreler
Scalar | $time | Çerezin yaşam süresinin saniye cinsinden belirtilmesidir. |
Return | This |
Kullanımı
Cookie::time(60 * 60 * 24)->insert('oneDay', 'One Day');
# Time (ZN >= 3.0.1)
Çerezin tutlacağı dizini belirlemek için kullanılır. Opsiyonel Yöntemdir.
Parametreler
String | $path | Çerezin hangi dizinde tutulacağı. |
Return | This |
Kullanımı
Cookie::path('/cookies/')->time(60 * 60 * 24)->insert('example', 'Example Value');
# Domain (ZN >= 3.0.1)
Çerezinin hangi alan isimleri için geçerli olacağını belirlemek için kullanılır. Opsiyonel Yöntemdir.
Parametreler
String | $domain | Çerezlerin geçerli olacağı alan adı. |
Return | This |
Kullanımı
Cookie::domain('example.com')
->path('/cookies/')
->time(60 * 60 * 24)
->insert('example', 'Example Value');
# Secure (ZN >= 3.0.1)
Çerezin istemciye güvenli bir HTTPS bağlantısı üzerinden mi aktarılması gerektiğini belirtmek için kullanılır. TRUE belirtildiği takdirde, çerez sadece güvenli bağlantı mevcutsa gönderilecektir. Opsiyonel Yöntemdir.
Parametreler
Bool | $secure | Güvenli kip. |
Return | This |
Kullanımı
Cookie::secure(true)
->domain('example.com')
->path('/cookies/')
->time(60 * 60 * 24)
->insert('example', 'Example Value');
# Encode (ZN >= 3.1.2)
Çerezin oluştururken hem değeri tutacak anahtarı hemde değerin kendsini şifrelemek için kullanabilirsiniz. Burada dikkat edilmesi gereken nokta anahtar şifrelemesi çözümlenebilirken değerin şifrelemesi çözümlenememektedir. Ön tanımlı olarak Config/Services.php -> cookie ayarları içinde ön tanımlı olarak anahtarın şifrelenmesi için kullanılan encode ayarı md5 olarak ayarlıdır.
Parametreler
String | $encodeName | Çerezin değerini tutacak anahtarın şifrelenmesi için kullanılır. Boş bırakılması halinde hiç bir şifreleme yapmaz. |
String | $encodeValue | Çerezin verisini şifrelemek için kullanılır. Boş bırakılması halinde hiç bir şifreleme yapmaz. |
Return | This |
Kullanımı
Cookie::encode('md5')->insert('sessionValue', 'Session Value');
Cookie::encode('sha1')->insert('sessionValue', 'Session Value');
Output::writeLine(Cookie::decode('md5')->select('sessionValue'));
Output::writeLine(Cookie::decode('sha1')->select('sessionValue'));
Session Value
# Decode (ZN >= 3.1.2)
Cookie::encode() ile şifrelenmiş çerez adını çözer. Şifreleme değer için tek yönlü olarak yapıldığı için çözümlenemez.
Parametreler
String | $encodeName | Çerezin değerini tutacak anahtarın şifrelenmesi için kullanılır. Boş bırakılması halinde hiç bir şifreleme yapmaz. |
Return | This |
Kullanımı
Cookie::encode('md5')->insert('value', 'Cookie Value');
Output::writeLine(Cookie::decode('md5')->select('value'));
İstenirse oturumun değeri de şifrelenebilir. Ancak bu kullanımda verinin çözümlenmesi mümkün değildir.
Cookie::encode('md5', 'sha1')->insert('value', 'Cookie Value');
Output::writeLine(Cookie::decode('md5')->select('value'));