dcatadmin2
/
dcat-admin2


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302
							<?php

namespace Dcat\Admin\Grid\Concerns;

use Dcat\Admin\Admin;
use Dcat\Admin\Grid\Events\Fetched;
use Dcat\Admin\Grid\Events\Fetching;
use Dcat\Admin\Repositories\EloquentRepository;
use Dcat\Admin\Support\Helper;
use Illuminate\Support\Collection;

/**
 * Trait HasTree.
 *
 *
 * @method \Dcat\Admin\Grid grid()
 */
trait HasTree
{
    /**
     * @var string
     */
    protected $parentIdQueryName = '_parent_id_';

    /**
     * @var string
     */
    protected $depthQueryName = '_depth_';

    /**
     * @var bool
     */
    protected $showAllChildrenNodes = false;

    /**
     * @var bool
     */
    protected $allowedTreeQuery = true;

    /**
     * @var array
     */
    protected $treeIgnoreQueryNames = [];

    /**
     * @var mixed
     */
    protected $defaultParentId;

    /**
     * 开启树形表格功能.
     *
     * @param  bool  $showAll
     * @param  bool  $sortable
     * @param  mixed  $defaultParentId
     * @return void
     */
    public function enableTree(bool $showAll, bool $sortable, $defaultParentId = null)
    {
        $this->showAllChildrenNodes = $showAll;
        $this->defaultParentId = $defaultParentId;

        $this->grid()->listen(Fetching::class, function () use ($sortable) {
            $this->sortTree($sortable);
            $this->bindChildrenNodesQuery();

            if ($this->getParentIdFromRequest()) {
                $this->setPageName(
                    $this->getChildrenPageName($this->getParentIdFromRequest())
                );
            }

            $this->addIgnoreQueries();
        });

        $this->grid()->listen(Fetched::class, function ($grid, Collection $collection) {
            if (! $this->getParentIdFromRequest()) {
                return;
            }

            if ($collection->isEmpty()) {
                return $grid->show(false);
            }

            $this->buildChildrenNodesPagination();
        });
    }

    /**
     * 设置保存为"前一个页面地址"时需要忽略的参数.
     */
    protected function addIgnoreQueries()
    {
        Admin::addIgnoreQueryName([
            $this->getParentIdQueryName(),
            $this->getDepthQueryName(),
            $this->getChildrenPageName($this->getParentIdFromRequest()),
        ]);
    }

    /**
     * 禁止树形表格查询.
     *
     * @return $this
     */
    public function disableBindTreeQuery()
    {
        $this->allowedTreeQuery = false;

        return $this->filterQueryBy(function ($query) {
            if (
                $query['method'] === 'where'
                && $query['arguments']
                && $query['arguments'][0] === optional($this->repository)->getParentColumn()
            ) {
                return false;
            }

            return true;
        });
    }

    /**
     * 设置子节点查询链接需要忽略的字段.
     *
     * @param  string|array  $keys
     * @return $this
     */
    public function treeUrlWithoutQuery($keys)
    {
        $this->treeIgnoreQueryNames = array_merge(
            $this->treeIgnoreQueryNames,
            (array) $keys
        );

        return $this;
    }

    public function generateTreeUrl()
    {
        return Helper::urlWithoutQuery(
            $this->grid()->filter()->urlWithoutFilters(),
            $this->treeIgnoreQueryNames
        );
    }

    protected function buildChildrenNodesPagination()
    {
        if ($this->grid()->allowPagination()) {
            $nextPage = $this->getCurrentChildrenPage() + 1;

            Admin::html(
                <<<HTML
<next-page class="hidden">{$nextPage}</next-page>
<last-page class="hidden">{$this->paginator()->lastPage()}</last-page>
HTML
            );
        }
    }

    protected function sortTree(bool $sortable)
    {
        if (
            $sortable
            && $this->findQueryByMethod('orderBy')->isEmpty()
            && $this->findQueryByMethod('orderByDesc')->isEmpty()
            && ($orderColumn = $this->repository->getOrderColumn())
        ) {
            $this->orderBy($orderColumn)
                ->orderBy($this->repository->getKeyName());
        }
    }

    protected function bindChildrenNodesQuery()
    {
        if (! $this->allowedTreeQuery) {
            return;
        }

        $this->where($this->repository->getParentColumn(), $this->getParentIdFromRequest());
    }

    /**
     * @return mixed
     */
    public function getChildrenQueryNamePrefix()
    {
        return $this->grid->getName();
    }

    /**
     * @param  mixed  $parentId
     * @return string
     */
    public function getChildrenPageName($parentId)
    {
        return $this->getChildrenQueryNamePrefix().'_children_page_'.$parentId;
    }

    /**
     * @return int
     */
    public function getCurrentChildrenPage()
    {
        return $this->request->get(
            $this->getChildrenPageName(
                $this->getParentIdFromRequest()
            )
        ) ?: 1;
    }

    /**
     * @return string
     */
    public function getParentIdQueryName()
    {
        return $this->getChildrenQueryNamePrefix().$this->parentIdQueryName;
    }

    /**
     * @return int
     */
    public function getParentIdFromRequest()
    {
        return $this->request->get(
            $this->getParentIdQueryName()
        ) ?: $this->getDefaultParentId();
    }

    /**
     * 移除树相关参数.
     *
     * @param  string  $url
     * @return string
     */
    public function withoutTreeQuery($url)
    {
        if (! $url) {
            return $url;
        }

        parse_str(explode('?', $url)[1] ?? '', $originalQuery);

        $parentId = $originalQuery[$this->getParentIdQueryName()] ?? 0;

        if (! $parentId) {
            return $url;
        }

        return Helper::urlWithoutQuery($url, [
            $this->getParentIdQueryName(),
            $this->getChildrenPageName($parentId),
            $this->getDepthQueryName(),
        ]);
    }

    /**
     * 获取默认parent_id字段值.
     *
     * @return int|mixed
     */
    public function getDefaultParentId()
    {
        if ($this->defaultParentId !== null) {
            return $this->defaultParentId;
        }

        $repository = $this->grid->model()->repository();

        if ($repository instanceof EloquentRepository) {
            return $repository->model()->getDefaultParentId();
        }

        return 0;
    }

    /**
     * @return string
     */
    public function getDepthQueryName()
    {
        return $this->getChildrenQueryNamePrefix().$this->depthQueryName;
    }

    /**
     * @return int
     */
    public function getDepthFromRequest()
    {
        return $this->request->get(
            $this->getDepthQueryName()
        ) ?: 0;
    }

    /**
     * @return bool
     */
    public function showAllChildrenNodes()
    {
        return $this->showAllChildrenNodes;
    }
}