Laravel,简化关系:多种可排序模型

时间:2015-03-23 17:13:45

标签: php sorting laravel orm eloquent

当我在Laravel项目上工作时,我注意到我的模型中出现了反复出现的模式:

  • Model A hasMany Model B
  • Model B可以选择隐藏
  • Model B可以选择排序

示例:

画廊有图片。您可以选择不显示图片,也可以选择对图片进行排序。

A"查看我们的团队"页。您可以选择不显示某些员工,也可以选择对其进行排序。

主页上的滑块。您可以选择不显示某些图像,也可以选择对其进行排序。

我一直在实施以下所有这些:

class ModelA extends Model {
    function modelBs() {
        $this->hasMany('modelB');
    }
}

class modelB extends Model {
    protected $fillable = ['visible', 'order'];
    function modelA() {
        $this->belongsTo('modelA');
    }
}

我还反复重复实施(复制/粘贴)用于在刀片模板中显示这些代码的代码:

@foreach( $modelA->modelBs()->sortBy('order') as $modelB )
    @if( $modelB->visible )
        <li>{{ $modelB->output() }}</li>
    @endif
@endforeach

在管理面板中,我必须反复重新实现(复制/粘贴)jQuery-UI可排序小部件,以修改订单,序列化您的决策,并将其提交给服务器,然后保存此订单(通过更新每个Model B的订单(

它失控了,我想起了Laracasts的格言:

  

如果您发现自己使用复制和粘贴,可能有更好的方法

当我试图想出更好的解决方案时,这是我想象的第一个关系:

  • Model A hasMany SortThing
  • SortThing morphsTo sortable
  • Model B hasOne sortable

这样我知道任何 SortThing都可以排序或隐藏,SortThing可以引用任何可排序对象(图片,员工,滑块面板等)< / p>

问题是这样做并不能让我的代码更加干嘛:

class ModelA extends Model {
    function modelBs() {
        $this->hasMany('SortThing');
    }
}

class modelB extends Model {
    function sortable() {
        $this->morphsOne('SortThing', 'sortable');
    }
}

class SortThing extends Model {
    protected $fillable = ['visible', 'order'];
    function sortable() {
        $this->morphTo();
    }
}

@foreach( $modelA->modelBs()->sortBy('order') as $modelB )
    @if( $modelB->visible )
        <li>{{ $modelB->sortable->output() }}</li>
    @endif
@endforeach

我已经添加了一个额外的课程,并且在我的输出中需要sortable->并且我仍在复制/粘贴代码。

有关如何清理我的代码的任何建议将不胜感激。还是一点Laravel newb。

如果生成的关系在重新排序对象时不需要我更新18个数据库行,则会获得奖励积分,因为这可能会导致一些丑陋的开销,因为列表变得非常长。

更新

在下面尝试@ gpopoteur的答案(在他的renderItems函数声明中解决了拼写错误后)我收到了以下错误:

[2015-03-24 13:08:52] production.ERROR: exception 'Symfony\Component\Debug\Exception\FatalErrorException' with message 'App\Slider and App\HasSortableItemsTrait define the same property ($sortItemClass) in the composition of App\Slider. However, the definition differs and is considered incompatible. Class was composed' in /var/www/example.com/app/Slider.php:26

Slider.php看起来像这样:

<?php namespace App;

use Illuminate\Database\Eloquent\Model;

class Slider extends Model {

    use HasSortableItemsTrait;

    protected $sortItemClass = 'App\SliderPanel';

    //
    public function sliderable() {
        return $this->morphTo();
    }

    public function panels() {
        return $this->hasMany('App\SliderPanel');
    }

    public function output() {
        $panels = $this->panels();
        return "Test?";

    }

} // Line 26

和HasSortableItemsTrait.php看起来像这样:

<?php namespace App;

trait HasSortableItemsTrait {

    protected $sortItemClass; // Also tried $sortItemClass = ''; and $sortItemClass = null;

    public function items() {
        $this->hasMany($this->sortItemClass)->sortyBy('order')->where('visible', '=', true);
    }

    public function renderItems($htmlTag = '<li>:item</li>') {
        $render = '';
        foreach( $this->items() as $item ){
            $render .= str_replace($item->render(), ':item', $htmlTag);
        }

        return $render;
    }

}

更新2

我已经发现注释掉以下行可以解决我的问题:

protected $sortItemClass;

当然,我仍然需要确保使用特征定义$sortItemClass的任何内容,否则在调用items()时会失败

现在我收到了一个新错误:

[2015-03-24 13:34:50] production.ERROR: exception 'BadMethodCallException' with message 'Call to undefined method Illuminate\Database\Query\Builder::sortBy()' in /var/www/example.com/vendor/laravel/framework/src/Illuminate/Database/Query/Builder.php:1992

我仔细检查了Laravel文档,并且我90%确定sortBy应该是查询构建器上的有效方法...

1 个答案:

答案 0 :(得分:1)

您可以尝试在特征中添加所有内容,然后在模型上添加use SortableTrait;。然后将该类设置为其拥有的其他可排序项的protected属性。

!!!以下代码未经过测试!!!

让我们为具有可排序项的Class定义一个特征。

    trait HasSortableItemsTrait {

        // define this in your class
        // protected $sortItemClass

        public function items() {
            $this->hasMany($sortItemClass)->orderBy('order');
        }

        public function renderItems($htmlTag = '<li>:item</li>']) {
            return $this->items->map(function($item) use ($htmlTag) {
                if( $item->visible ){
                    return str_replace($item->render(), ':item', $htmlTag);
                }
            });
        }

    }

可用于可排序项目的另一个特征。

    trait IsSortableTrait {

        // define this in your class
        // protected $sortItemParent

        function items() {
            $this->belongsTo($sortItemParent);
        }

        function render(){
            return $this->output();
        }

    }

让我们举一个具有可排序照片的图库的示例。这就是App\Gallery应该是这样的:

    class Gallery extends Model {
        use HasSortableItemsTrait;

        protected $sortItemClass = 'App\Photo';
    }

这就是App\Photo类的样子:

    class Photo extends Model {
        use IsSortableTrait;

        protected $sortItemParent = 'App\Gallery';
    }

然后你只需要获取包含许多可排序项目的Item,在本例中为gallery。

    $gallery = Gallery::find(1);

在视图中,您只需调用视图的renderItems()方法即可。

    {{ $gallery->renderItems() }}

我让renderItems方法能够接收你想要包装$item->render()将作为输出的内容。例如,在<p></p>之间,你只需要调用这样的方法:

    {{ $gallery->renderItems('<p>:item</p>') }}