LaravelRUS / SleepingOwlAdmin

src/Display/Column/Order.php

<?php

namespace SleepingOwl\Admin\Display\Column;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Routing\Router;
use SleepingOwl\Admin\Contracts\WithRoutesInterface;
use SleepingOwl\Admin\Display\TableColumn;
use SleepingOwl\Admin\Model\ModelConfiguration;
use SleepingOwl\Admin\Section;
use SleepingOwl\Admin\Traits\OrderableModel;

class Order extends TableColumn implements WithRoutesInterface
{
    /**
     * @var bool
     */
    protected $orderable = false;

    /**
     * @var string
     */
    protected $view = 'column.order';

    /**
     * @var null|int
     */
    protected $totalCountValue = null;

    /**
     * Register routes.
     *
     * @param Router $router
     */
    public static function registerRoutes(Router $router)
    {
        $routeName = 'admin.display.column.move-up';
        if (! $router->has($routeName)) {
            $router->group(['namespace' => 'SleepingOwl\Admin\Http\Controllers'],
                function ($router) use ($routeName) {
                    $router->post('{adminModel}/{adminModelId}/up', [
                        'as' => $routeName,
                        'uses' => 'DisplayColumnController@orderUp',
                    ]);
                });
        }

        $routeName = 'admin.display.column.move-down';
        if (! $router->has($routeName)) {
            $router->group(['namespace' => 'SleepingOwl\Admin\Http\Controllers'],
                function ($router) use ($routeName) {
                    $router->post('{adminModel}/{adminModelId}/down', [
                        'as' => $routeName,
                        'uses' => 'DisplayColumnController@orderDown',
                    ]);
                });
        }
    }

    /**
     * Order constructor.
     */
    public function __construct()
    {
        parent::__construct();
        $this->setHtmlAttribute('class', 'row-order');
    }

    /**
     * @return Model $model
     * @throws \Exception
     */
    public function getModel()
    {
        if (! in_array(OrderableModel::class, trait_uses_recursive($class = get_class($this->model)))) {
            throw new \Exception("Model [$class] should uses trait [SleepingOwl\\Admin\\Traits\\OrderableModel]");
        }

        return $this->model;
    }

    /**
     * @return mixed
     * @throws \Exception
     */
    protected function getOrderValue()
    {
        return $this->getModel()->getOrderValue();
    }

    /**
     * @return int
     * @throws \Exception
     */
    protected function totalCount()
    {
        if ($this->totalCountValue !== null) {
            return $this->totalCountValue;
        }

        //$request = \Request::capture();

55% of this comment could be valid code. Did you maybe forget this after debugging?

        $request = \Illuminate\Http\Request::capture();
        $modelConfiguration = $this->getModelConfiguration();
        $query = $modelConfiguration->getRepository()->getQuery();
        if ($modelConfiguration instanceof Section) {
            $onDisplay = $modelConfiguration->onDisplay();

The method onDisplay() does not exist on SleepingOwl\Admin\Section. Since you implemented __call, consider adding a @method annotation.

        } elseif ($modelConfiguration instanceof ModelConfiguration) {
            $onDisplay = $modelConfiguration->getDisplay();
            $onDisplay = call_user_func($onDisplay, ['payload' => $request->get('payload')]);
        } else {
            /*
             * @see https://sleepingowladmin.ru/docs/model_configuration
             * @see https://sleepingowladmin.ru/docs/model_configuration_section
             */
            throw new \Exception('Unknown type of the Model Configuration. Use Section or AdminSection::registerModel()');
        }
        $onDisplay->getExtensions()->modifyQuery($query);
        $onDisplay->applySearch($query, $request);
        $onDisplay->applyOffset($query, $request);
        $this->totalCountValue = $query->count();

It seems like $query->count() can also be of type Illuminate\Database\Eloquent\Builder. However, the property $totalCountValue is declared as type integer|null. Maybe add an additional type check?

        return $this->totalCountValue;

The expression return $this->totalCountValue also could return the type Illuminate\Database\Eloquent\Builder which is incompatible with the documented return type integer.

    }

    /**
     * @return bool
     * @throws \Exception
     */
    protected function movableUp()
    {
        return $this->getOrderValue() > 0;
    }

    /**
     * @return string
     * @throws \Exception
     */
    protected function moveUpUrl()
    {
        return route('admin.display.column.move-up', [
            $this->getModelConfiguration()->getAlias(),
            $this->getModel()->getKey(),
        ]);
    }

    /**
     * @return bool
     * @throws \Exception
     */
    protected function movableDown()
    {
        return $this->getOrderValue() < $this->totalCount() - 1;
    }

    /**
     * @return string
     * @throws \Exception
     */
    protected function moveDownUrl()
    {
        return route('admin.display.column.move-down', [
            $this->getModelConfiguration()->getAlias(),
            $this->getModel()->getKey(),
        ]);
    }

    /**
     * @return array
     * @throws \Exception
     */
    public function toArray()
    {
        return parent::toArray() + [
            'movableUp' => $this->movableUp(),
            'moveUpUrl' => $this->moveUpUrl(),
            'movableDown' => $this->movableDown(),
            'moveDownUrl' => $this->moveDownUrl(),
        ];
    }
}