Eloquent orm otomatik where koşulu

Pyrotoxin

Merhaba eloquent model için sorgulara otomatik where kosulu nasıl ataya biliriz?
Yapmak istediğim olay çoklu web sitesi oluşturmak. Şöyleki tüm tablolarımda site_id alanı oluşturup gelen domaine göre veri tabanından istenilen sonucu cıkartmak istiyorum. hali hazır tek işlem yapan bir sistemim var tek tek sorgulaarıma gidip
$sorgu->where('site_id',$this->site);
şeklinde ekleme yapıp uzun uzadıya uğraşmak yerine model dosyalarıma bu kosulu koyup her sorguda bunun baz alınması. böyle mülteci isteklerim var

Yardımlrını için teşekkürler iyi çalışmalar^^

mgsmus

Scope kullanabilirsiniz http://laravel.com/docs/eloquent#query-scopes

ya da

Şu şekilde modelin ana sorgusuna şart ekleyebilisiniz. Her sorgudan önce bu şart otomatik eklenecek.

public function newQuery()
{
 $query = parent::newQuery();
 $query->where('site_id',1);
 return $query;
}

sergin

Bir model üzerinde yapılan tüm sorgulara uygulanan bir scope tanımlamak istediğinizde önerilen şey Global scopes kullanmaktır. Global scope konusu pek bilinmez, orijinal laravel dokümantasyonlarına 4 gün önce eklendi ( http://laravel.com/docs/eloquent#global-scopes ). Henüz türkçe dokümantasyonlara geçmedi.

sineld

sergin abi, güzel özellik olmuş.
Teşekkürler.

mevlut44

Global Scopes kullanımını anlayan varmı benimde tum tablolarda kullandığım status alanım var bu tüm tablolarda 1 ise sitede gözükmesini istiyorum Global Scopes işime yarar mı? nasıl oluşturacam anlamadım.

sineld

Sergin abi ilgili bölümü çevirdi: http://laravel.gen.tr/docs/eloquent#global-scopes

sergin

@mevlut44, Türkçe dokümanlar da az önce güncellenmiştir. Aşağıda sizin sorunuza uyan çözüm açıklanmıştır.

Önce bir trait tanımlamak gerekiyor

trait StatusTrait {

 /**
 * Bir model için status traiti boot et.
 *
 * @return void
 */
 public static function bootStatusTrait()
 {
 static::addGlobalScope(new StatusScope);
 }
 
 /**
 * Tam kalifiye "status" sütununu öğren.
 *
 * @return string
 */
 public function getTamStatusKolon()
 {
	return $this->getTable().'.status';
 }
}

Buradaki StatusScope'nin Illuminate\Database\Eloquent\ScopeInterface'i implemente etmesi gerekiyor.

use \Illuminate\Database\Eloquent\Builder as Builder;
class StatusScope implements \Illuminate\Database\Eloquent\ScopeInterface {
	/**
 * Verilen bir Eloquent sorgu oluşturucusuna scope'u uygula.
 *
 * @param \Illuminate\Database\Eloquent\Builder $builder
 * @return void
 */
	public function apply(Builder $builder)
	{
 $builder->where('status', '=', 1);
	}

	/**
 * Verilen bir Eloquent sorgu oluşturucusundan scope'u kaldır.
 *
 * @param \Illuminate\Database\Eloquent\Builder $builder
 * @return void
 */
	public function remove(Builder $builder)
	{
 $column = $builder->getModel()->getTamStatusKolon();
 $query = $builder->getQuery();

 foreach ((array) $query->wheres as $key => $where)
 {
 // Eğer where cümlesi status sınırlaması ise sorgudan bunu çıkarıyoruz ve
 // wheres'deki anahtarları resetliyoruz.
 if ($this->isStatusSinirlamasi($where, $column))
 {
 unset($query->wheres[$key]);

 $query->wheres = array_values($query->wheres);
 }
 }
	}

	/**
 * Verilen bir where cümlesinin bir status sınırlaması olup olmadığını belirle.
 *
 * @param array $where
 * @param string $column
 * @return bool
 */
	protected function isStatusSinirlamasi(array $where, $column)
	{
 return $where['type'] == 'Basic' && $where['column'] == $column;
	}

}

Bu sınıf ve traitin önyüklemeye dahil edildiğinden emin olun. Son olarak bunu kullanmak istediğimiz model tanımında StatusTrait'i kullanmak gerekiyor

use StatusTrait;

class Masa extends Eloquent {
 use StatusTrait;
 //.. diğer şeyler
}

Artık Masa modeline yapılan her sorguya where('status', '=', 1) sınırlaması otomatik olarak eklenecektir.
Ne kadar kolay ve şiir yazmak gibi değil mi?

mgsmus

Ben sadece aktif kullanıcılarla çalışmamı sağlayan bir global scope örneği hazırladım. mevlut44 arkadaşımızın da isteğine uygun.

Henüz daha karar vermedim ama global scope için app/scopes gibi bir klasörü uygun gördüm.
composer.json dosyama ekledim:

"classmap": [
 "app/commands",
 "app/controllers",
 "app/models",
 "app/database/migrations",
 "app/database/seeds",
 "app/scopes",
 "app/tests/TestCase.php"
]

Kullanıcı tablomda status sütunu var. 1 ise kullanıcı aktif; 0 ise kullanıcı pasif. Kullanıcı işlemleri ile uğraşırken sadece aktif kullanıcılarla uğraşmak istiyorum. O yüzden Users modelinde tüm sorgulara where('status',1) şeklinde bir şart eklemek istiyorum

app/scopes/OnlyActiveUsersScope.php:

<?php

use Illuminate\Database\Eloquent\ScopeInterface;
use Illuminate\Database\Eloquent\Builder;


class OnlyActiveUsersScope implements ScopeInterface {


 public function apply(Builder $builder)
 {
 $builder->where('status',1);
 }


 public function remove(Builder $builder)
 {

 $query = $builder->getQuery();

 foreach ((array) $query->wheres as $key => $where)
 {
 if ($this->isOnlyActiveUsersScopeConstraint($where, 'status'))
 {
 unset($query->wheres[$key]);

 $query->wheres = array_values($query->wheres);
 }
 }
 }

 protected function isOnlyActiveUsersScopeConstraint(array $where, $column)
 {
	return $where['type'] == 'Basic' && $where['column'] == $column;
 }

}

trait OnlyActiveUsersTrait {
 public static function bootOnlyActiveUsersTrait()
 {
 static::addGlobalScope(new OnlyActiveUsersScope);
 }
}

Daha sonra OnlyActiveUsersTrait traitini kullanmak için models/User.php dosyama ekliyorum

use UserTrait, RemindableTrait, OnlyActiveUsersTrait;

Basit bir şekilde kullanıcıları aldığımda sorgu şu şekilde değişiyor:

$users = User::all();
print_r(DB::getQueryLog());

Array
(
 [0] => Array
 (
 [query] => select * from `users` where `status` = ?
 [bindings] => Array
 (
 [0] => 1
 )

 [time] => 0.55
 )
)

Umarım işinize yarar.

Edit: Biraz geç kaldım anlaşılan

sergin

@msgmus, bunun oldukça uzun bir yol olduğunu görüyoruz. Önceki önerinizdeki newQuery overridingi düzgün çalışıyor mu, newQuery birçok yerde, ilişkileri getirmede falan da kullanılıyor. Buralarda sorun olmuyor ve düzgün çalışıyorsa global scopelere tercih edilebilir, ne dersiniz?

mevlut44

trait StatusTrait {

 /**
 * Bir model için status traiti boot et.
 *
 * @return void
 */
 public static function bootStatusTrait()
 {
 static::addGlobalScope(new StatusScope);
 }
 
 /**
 * Tam kalifiye "status" sütununu öğren.
 *
 * @return string
 */
 public function getTamStatusKolon()
 {
	return $this->getTable().'.status';
 }
}

trait leri tam olarak nereye tanımlayacağız?

sergin

Scope sınıfı ve trait'in önyüklemeye dahil edildiğinden emin olun diye belirtmiştim. Bunu yapmanın bir yolu @msgmus'un belirttiği gibi onları app/scopes gibi bir klasöre koyup, sonra bu klasörü composer.json dosyanızın classmap anahtarına eklemek ve artisan dump-autoload komutunu çalıştırarak önyüklemeleri güncellemektir.

mgsmus

sergin yazdı@msgmus, bunun oldukça uzun bir yol olduğunu görüyoruz. Önceki önerinizdeki newQuery overridingi düzgün çalışıyor mu, newQuery birçok yerde, ilişkileri getirmede falan da kullanılıyor. Buralarda sorun olmuyor ve düzgün çalışıyorsa global scopelere tercih edilebilir, ne dersiniz?

newQuery düzgün çalışıyor ama basit bir şekilde. Yani aynı şartı User::where şeklinde bir daha eklerseniz onu da sorguya dahil ediyor

mevlut44

@mgsmus Teşekkurler işime yaradı. Şuan tanımladım kullanıyorum.
Fakat şimdide admin panelindede status alanı 0 olanlarda gelmiyor admin paneli için use StatusTrait; bunu sonrgunun dışında tutamaz mıyım? Nasıl yapabilirim ?
İyi Çalışmalar...

mgsmus

@mevlut44

Ben de yeni yeni bakıyorum, tam anlamıyla ilgilenemedim ama laravelin kendin sofdelete özelliğinden yola çıkarak kendi sisteminize uygulayabileceğinizi düşünüyorum
https://github.com/laravel/framework/tree/master/src/Illuminate/Database/Eloquent
Burada SoftDeletingScope.php ve SoftDeletingTrait.php inceleyin, özellikle withTrashed ve onlyTrashed metodlarına bakın.

Aslında böyle şeyleri paylaşmak için bir blog tutsam fena olmaz, ben şurada anlattım deyip insanları yönlendirsem ama işte, terzi kendi söküğünü dikemezmiş