Skip to content

Extract getTags to own method #119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: 2.x
Choose a base branch
from
Open

Extract getTags to own method #119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ff2edcc
Initial refactoring. Still got to work out how to deal with $total an…
pbowyer Aug 20, 2018
ead3b40
Add a new result class to hold tags, total and max count. Not the ret…
pbowyer Aug 20, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 5 additions & 101 deletions core/components/tagger/elements/snippets/taggergettags.snippet.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,126 +41,30 @@
$tagger = $modx->getService('tagger','Tagger',$modx->getOption('tagger.core_path',null,$modx->getOption('core_path').'components/tagger/').'model/tagger/',$scriptProperties);
if (!($tagger instanceof Tagger)) return '';

$resources = $modx->getOption('resources', $scriptProperties, '');
$parents = $modx->getOption('parents', $scriptProperties, '');
$groups = $modx->getOption('groups', $scriptProperties, '');
$target = (int) $modx->getOption('target', $scriptProperties, $modx->resource->id, true);
$showUnused = (int) $modx->getOption('showUnused', $scriptProperties, '0');
$showUnpublished = (int) $modx->getOption('showUnpublished', $scriptProperties, '0');
$showDeleted = (int) $modx->getOption('showDeleted', $scriptProperties, '0');
$linkCurrentTags = (int) $modx->getOption('linkCurrentTags', $scriptProperties, '0');
$linkOneTagPerGroup = (int) $modx->getOption('linkOneTagPerGroup', $scriptProperties, '0');
$contexts = $modx->getOption('contexts', $scriptProperties, '');
$translate = (int) $modx->getOption('translate', $scriptProperties, '0');

$defaultRowTpl = $modx->getOption('rowTpl', $scriptProperties, '');
$outTpl = $modx->getOption('outTpl', $scriptProperties, '');
$wrapIfEmpty = $modx->getOption('wrapIfEmpty', $scriptProperties, 1);
$separator = $modx->getOption('separator', $scriptProperties, '');
$limit = intval($modx->getOption('limit', $scriptProperties, 0));
$offset = intval($modx->getOption('offset', $scriptProperties, 0));
$totalPh = $modx->getOption('totalPh', $scriptProperties, 'tags_total');

$weight = (int) $modx->getOption('weight', $scriptProperties, '0');

$friendlyURL = (int) $modx->getOption('friendlyURL', $scriptProperties, $modx->getOption('friendly_urls', null, 0));
$linkTagScheme = $modx->getOption('linkTagScheme', $scriptProperties, $modx->getOption('link_tag_scheme', null, -1));

$sort = $modx->getOption('sort', $scriptProperties, '{}');
$sort = $modx->fromJSON($sort);
if ($sort === null || $sort == '' || count($sort) == 0) {
$sort = array(
'tag' => 'ASC'
);
}

$resources = $tagger->explodeAndClean($resources);
$parents = $tagger->explodeAndClean($parents);
$groups = $tagger->explodeAndClean($groups);
$contexts = $tagger->explodeAndClean($contexts);
$toPlaceholder = $modx->getOption('toPlaceholder', $scriptProperties, '');
$totalPh = $modx->getOption('totalPh', $scriptProperties, 'tags_total');

$c = $modx->newQuery('TaggerTag');

$c->leftJoin('TaggerTagResource', 'Resources');
$c->leftJoin('TaggerGroup', 'Group');
$c->leftJoin('modResource', 'Resource', array('Resources.resource = Resource.id'));

if (!empty($parents)) {
$c->where(array(
'Resource.parent:IN' => $parents,
));
}

if (!empty($contexts)) {
$c->where(array(
'Resource.context_key:IN' => $contexts,
));
}

if ($showUnpublished == 0) {
$c->where(array(
'Resource.published' => 1,
'OR:Resource.published:IN' => null,
));
}

if ($showDeleted == 0) {
$c->where(array(
'Resource.deleted' => 0,
'OR:Resource.deleted:IS' => null,
));
}

if ($showUnused == 0) {
$c->having(array(
'cnt > 0',
));
}

if (!empty($resources)) {
$c->where(array(
'Resources.resource:IN' => $resources
));
}

if ($groups) {
$c->where(array(
'Group.id:IN' => $groups,
'OR:Group.name:IN' => $groups,
'OR:Group.alias:IN' => $groups,
));
}
$c->select($modx->getSelectColumns('TaggerTag', 'TaggerTag'));
$c->select($modx->getSelectColumns('TaggerGroup', 'Group', 'group_'));
$c->select(array('cnt' => 'COUNT(Resources.tag)'));
$c->groupby($modx->getSelectColumns('TaggerTag', 'TaggerTag') . ',' . $modx->getSelectColumns('TaggerGroup', 'Group'));

$c->prepare();

$countQuery = new xPDOCriteria($modx, "SELECT COUNT(*) as total, MAX(cnt) as max_cnt FROM ({$c->toSQL(false)}) cq", $c->bindings, $c->cacheFlag);
$stmt = $countQuery->prepare();

if ($stmt && $stmt->execute()) {
$fetchedData = $stmt->fetch(PDO::FETCH_ASSOC);
$total = intval($fetchedData['total']);
$maxCnt = intval($fetchedData['max_cnt']);
} else {
$total = 0;
$maxCnt = 0;
}
$taggerResult = $tagger->getTags($scriptProperties);
$tags = $taggerResult->tags;
$total = $taggerResult->total;
$maxCnt = $taggerResult->maxCnt;

$modx->setPlaceholder($totalPh, $total);

foreach ($sort as $field => $dir) {
$dir = (strtolower($dir) == 'asc') ? 'asc' : 'desc';
$c->sortby($field, $dir);
}

$c->limit($limit, $offset);

$tags = $modx->getIterator('TaggerTag', $c);

$out = array();

// prep for &tpl_N
Expand Down
106 changes: 106 additions & 0 deletions core/components/tagger/model/tagger/tagger.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,4 +137,110 @@ public function getCurrentTags()

return $currentTags;
}

public function getTags($scriptProperties)
{
$resources = $this->modx->getOption('resources', $scriptProperties, '');
$parents = $this->modx->getOption('parents', $scriptProperties, '');
$groups = $this->modx->getOption('groups', $scriptProperties, '');
$showUnused = (int) $this->modx->getOption('showUnused', $scriptProperties, '0');
$showUnpublished = (int) $this->modx->getOption('showUnpublished', $scriptProperties, '0');
$showDeleted = (int) $this->modx->getOption('showDeleted', $scriptProperties, '0');
$contexts = $this->modx->getOption('contexts', $scriptProperties, '');
$limit = intval($this->modx->getOption('limit', $scriptProperties, 0));
$offset = intval($this->modx->getOption('offset', $scriptProperties, 0));

$sort = $this->modx->getOption('sort', $scriptProperties, '{}');
$sort = $this->modx->fromJSON($sort);
if ($sort === null || $sort == '' || count($sort) == 0) {
$sort = array(
'tag' => 'ASC'
);
}

$resources = $this->explodeAndClean($resources);
$parents = $this->explodeAndClean($parents);
$groups = $this->explodeAndClean($groups);
$contexts = $this->explodeAndClean($contexts);

$c = $this->modx->newQuery('TaggerTag');

$c->leftJoin('TaggerTagResource', 'Resources');
$c->leftJoin('TaggerGroup', 'Group');
$c->leftJoin('modResource', 'Resource', array('Resources.resource = Resource.id'));

if (!empty($parents)) {
$c->where(array(
'Resource.parent:IN' => $parents,
));
}

if (!empty($contexts)) {
$c->where(array(
'Resource.context_key:IN' => $contexts,
));
}

if ($showUnpublished == 0) {
$c->where(array(
'Resource.published' => 1,
'OR:Resource.published:IN' => null,
));
}

if ($showDeleted == 0) {
$c->where(array(
'Resource.deleted' => 0,
'OR:Resource.deleted:IS' => null,
));
}

if ($showUnused == 0) {
$c->having(array(
'cnt > 0',
));
}

if (!empty($resources)) {
$c->where(array(
'Resources.resource:IN' => $resources
));
}

if ($groups) {
$c->where(array(
'Group.id:IN' => $groups,
'OR:Group.name:IN' => $groups,
'OR:Group.alias:IN' => $groups,
));
}
$c->select($this->modx->getSelectColumns('TaggerTag', 'TaggerTag'));
$c->select($this->modx->getSelectColumns('TaggerGroup', 'Group', 'group_'));
$c->select(array('cnt' => 'COUNT(Resources.tag)'));
$c->groupby($this->modx->getSelectColumns('TaggerTag', 'TaggerTag') . ',' . $this->modx->getSelectColumns('TaggerGroup', 'Group'));

$c->prepare();

$countQuery = new xPDOCriteria($this->modx, "SELECT COUNT(*) as total, MAX(cnt) as max_cnt FROM ({$c->toSQL(false)}) cq", $c->bindings, $c->cacheFlag);
$stmt = $countQuery->prepare();

$result = new TaggerResult();

if ($stmt && $stmt->execute()) {
$fetchedData = $stmt->fetch(PDO::FETCH_ASSOC);
$result->total = intval($fetchedData['total']);
$result->maxCnt = intval($fetchedData['max_cnt']);
}


foreach ($sort as $field => $dir) {
$dir = (strtolower($dir) == 'asc') ? 'asc' : 'desc';
$c->sortby($field, $dir);
}

$c->limit($limit, $offset);

$result->tags = $this->modx->getIterator('TaggerTag', $c);
return $result;
}
}
13 changes: 13 additions & 0 deletions core/components/tagger/model/tagger/taggerresult.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?php

/**
* Result class for Tagger::getTags()
*
* @package tagger
*/
class TaggerResult
{
public $tags = [];
public $total = 0;
public $maxCnt = 0;
}