-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add PartialTreeData action for AdjacencyList tree type - renders not …
…full tree but a part of it
- Loading branch information
Showing
2 changed files
with
160 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,156 @@ | ||
<?php | ||
|
||
namespace devgroup\JsTreeWidget\actions\AdjacencyList; | ||
|
||
use DevGroup\TagDependencyHelper\NamingHelper; | ||
use Yii; | ||
use yii\base\Action; | ||
use yii\base\InvalidConfigException; | ||
use yii\caching\TagDependency; | ||
use yii\helpers\ArrayHelper; | ||
use yii\web\Response; | ||
|
||
/** | ||
* Helper action for retrieving tree data for jstree by ajax. | ||
* Example use in controller: | ||
* | ||
* ``` php | ||
* public function actions() | ||
* { | ||
* return [ | ||
* 'getTree' => [ | ||
* 'class' => PartialTreeDataAction::class, | ||
* 'className' => Category::class, | ||
* 'modelLabelAttribute' => 'defaultTranslation.name', | ||
* | ||
* ], | ||
* ... | ||
* ]; | ||
* } | ||
* ``` | ||
*/ | ||
class PartialTreeDataAction extends Action | ||
{ | ||
|
||
public $className; | ||
|
||
public $modelIdAttribute = 'id'; | ||
|
||
public $modelLabelAttribute = 'name'; | ||
|
||
public $modelParentAttribute = 'parent_id'; | ||
|
||
public $varyByTypeAttribute; | ||
|
||
public $queryParentAttribute = 'id'; | ||
|
||
public $querySortOrder = 'sort_order'; | ||
|
||
public $querySelectedAttribute = 'selected_id'; | ||
/** | ||
* Additional conditions for retrieving tree(ie. don't display nodes marked as deleted) | ||
* @var array|\Closure | ||
*/ | ||
public $whereCondition = []; | ||
|
||
/** | ||
* Cache key prefix. Should be unique if you have multiple actions with different $whereCondition | ||
* @var string|\Closure | ||
*/ | ||
public $cacheKey = 'PartialTree'; | ||
|
||
/** | ||
* Cache lifetime for the full tree | ||
* @var int | ||
*/ | ||
public $cacheLifeTime = 86400; | ||
|
||
public function init() | ||
{ | ||
if ($this->className === null) { | ||
throw new InvalidConfigException('Model name should be set in controller actions'); | ||
} | ||
if (!class_exists($this->className)) { | ||
throw new InvalidConfigException('Model class does not exists'); | ||
} | ||
} | ||
|
||
public function run() | ||
{ | ||
Yii::$app->response->format = Response::FORMAT_JSON; | ||
|
||
/** @var \yii\db\ActiveRecord $class */ | ||
$class = $this->className; | ||
|
||
if (null === $current_selected_id = Yii::$app->request->get($this->querySelectedAttribute)) { | ||
$current_selected_id = Yii::$app->request->get($this->queryParentAttribute); | ||
} | ||
|
||
$parent_id = Yii::$app->request->get($this->queryParentAttribute, '#'); | ||
if (!is_numeric($parent_id)) { | ||
$parent_id = 0; | ||
} | ||
|
||
$cacheKey = $this->cacheKey instanceof \Closure ? call_user_func($this->cacheKey) : $this->cacheKey; | ||
|
||
$cacheKey = "AdjacencyFullTreeData:$cacheKey:{$class}:{$this->querySortOrder}:$parent_id"; | ||
|
||
if (false === $result = Yii::$app->cache->get($cacheKey)) { | ||
$query = $class::find() | ||
->orderBy([$this->querySortOrder => SORT_ASC]); | ||
|
||
if ($this->whereCondition instanceof \Closure) { | ||
$query->where(call_user_func($this->whereCondition)); | ||
} elseif (count($this->whereCondition) > 0) { | ||
$query->where($this->whereCondition); | ||
} | ||
$query->andWhere([$this->modelParentAttribute => $parent_id]); | ||
|
||
if (null === $rows = $query->asArray()->all()) { | ||
return []; | ||
} | ||
|
||
$result = []; | ||
|
||
foreach ($rows as $row) { | ||
$parent = ArrayHelper::getValue($row, $this->modelParentAttribute, 0); | ||
$item = [ | ||
'id' => ArrayHelper::getValue($row, $this->modelIdAttribute, 0), | ||
'parent' => $parent ?: '#', | ||
'text' => ArrayHelper::getValue($row, $this->modelLabelAttribute, 'item'), | ||
'a_attr' => [ | ||
'data-id' => $row[$this->modelIdAttribute], | ||
'data-parent_id' => $row[$this->modelParentAttribute] | ||
], | ||
'children' => true, | ||
]; | ||
|
||
if (null !== $this->varyByTypeAttribute) { | ||
$item['type'] = $row[$this->varyByTypeAttribute]; | ||
} | ||
|
||
$result[$row[$this->modelIdAttribute]] = $item; | ||
} | ||
|
||
Yii::$app->cache->set( | ||
$cacheKey, | ||
$result, | ||
86400, | ||
new TagDependency([ | ||
'tags' => [ | ||
NamingHelper::getCommonTag($class), | ||
], | ||
]) | ||
); | ||
} | ||
|
||
if (array_key_exists($current_selected_id, $result)) { | ||
$result[$current_selected_id] = array_merge( | ||
$result[$current_selected_id], | ||
['state' => ['opened' => true, 'selected' => true]] | ||
); | ||
} | ||
|
||
return array_values($result); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters