You can pass no parameters or pass either a new filter key or sort key to build a new query string, leaving the
other properties intact.
| public static getSortFilterQueryString ( string $selectedSort, array $selectedFilters, string $sortKeyToSet = '', array $filterKeysToSet = [] ) : string | ||
| $selectedSort | string | |
| $selectedFilters | array | |
| $sortKeyToSet | string | The key name of the sort in the sorts array. |
| $filterKeysToSet | array | An array of filters, where the key is the key of the filterSet in the filters array and the value is the key of the filter. |
| Résultat | string | The current or amended query string for sort and filter. |
/**
* Default all discussions view: chronological by most recent comment.
*
* @since 2.0.0
* @access public
*
* @param int $Page Multiplied by PerPage option to determine offset.
*/
public function index($Page = false)
{
$this->allowJSONP(true);
// Figure out which discussions layout to choose (Defined on "Homepage" settings page).
$Layout = c('Vanilla.Discussions.Layout');
switch ($Layout) {
case 'table':
if ($this->SyndicationMethod == SYNDICATION_NONE) {
$this->View = 'table';
}
break;
default:
// $this->View = 'index';
break;
}
Gdn_Theme::section('DiscussionList');
// Remove score sort
DiscussionModel::removeSort('top');
// Check for the feed keyword.
if ($Page === 'feed' && $this->SyndicationMethod != SYNDICATION_NONE) {
$Page = 'p1';
}
// Determine offset from $Page
list($Offset, $Limit) = offsetLimit($Page, c('Vanilla.Discussions.PerPage', 30), true);
$Page = PageNumber($Offset, $Limit);
// Allow page manipulation
$this->EventArguments['Page'] =& $Page;
$this->EventArguments['Offset'] =& $Offset;
$this->EventArguments['Limit'] =& $Limit;
$this->fireEvent('AfterPageCalculation');
// Set canonical URL
$this->canonicalUrl(url(ConcatSep('/', 'discussions', PageNumber($Offset, $Limit, true, false)), true));
// We want to limit the number of pages on large databases because requesting a super-high page can kill the db.
$MaxPages = c('Vanilla.Discussions.MaxPages');
if ($MaxPages && $Page > $MaxPages) {
throw notFoundException();
}
// Setup head.
if (!$this->data('Title')) {
$Title = c('Garden.HomepageTitle');
$DefaultControllerRoute = val('Destination', Gdn::router()->GetRoute('DefaultController'));
if ($Title && $DefaultControllerRoute == 'discussions') {
$this->title($Title, '');
} else {
$this->title(t('Recent Discussions'));
}
}
if (!$this->Description()) {
$this->Description(c('Garden.Description', null));
}
if ($this->Head) {
$this->Head->AddRss(url('/discussions/feed.rss', true), $this->Head->title());
}
// Add modules
$this->addModule('DiscussionFilterModule');
$this->addModule('NewDiscussionModule');
$this->addModule('CategoriesModule');
$this->addModule('BookmarkedModule');
$this->setData('Breadcrumbs', array(array('Name' => t('Recent Discussions'), 'Url' => '/discussions')));
// Set criteria & get discussions data
$this->setData('Category', false, true);
$DiscussionModel = new DiscussionModel();
$DiscussionModel->setSort(Gdn::request()->get());
$DiscussionModel->setFilters(Gdn::request()->get());
$this->setData('Sort', $DiscussionModel->getSort());
$this->setData('Filters', $DiscussionModel->getFilters());
// Check for individual categories.
$categoryIDs = $this->getCategoryIDs();
$where = array();
if ($categoryIDs) {
$where['d.CategoryID'] = CategoryModel::filterCategoryPermissions($categoryIDs);
} else {
$DiscussionModel->Watching = true;
}
// Get Discussion Count
$CountDiscussions = $DiscussionModel->getCount($where);
if ($MaxPages) {
$CountDiscussions = min($MaxPages * $Limit, $CountDiscussions);
}
$this->setData('CountDiscussions', $CountDiscussions);
// Get Announcements
$this->AnnounceData = $Offset == 0 ? $DiscussionModel->GetAnnouncements($where) : false;
$this->setData('Announcements', $this->AnnounceData !== false ? $this->AnnounceData : array(), true);
// RSS should include announcements.
if ($this->SyndicationMethod !== SYNDICATION_NONE) {
$Where['Announce'] = 'all';
}
// Get Discussions
$this->DiscussionData = $DiscussionModel->getWhereRecent($where, $Limit, $Offset);
$this->setData('Discussions', $this->DiscussionData, true);
$this->setJson('Loading', $Offset . ' to ' . $Limit);
// Build a pager
$PagerFactory = new Gdn_PagerFactory();
$this->EventArguments['PagerType'] = 'Pager';
$this->fireEvent('BeforeBuildPager');
if (!$this->data('_PagerUrl')) {
$this->setData('_PagerUrl', 'discussions/{Page}');
}
$queryString = DiscussionModel::getSortFilterQueryString($DiscussionModel->getSort(), $DiscussionModel->getFilters());
$this->setData('_PagerUrl', $this->data('_PagerUrl') . $queryString);
$this->Pager = $PagerFactory->GetPager($this->EventArguments['PagerType'], $this);
$this->Pager->ClientID = 'Pager';
$this->Pager->configure($Offset, $Limit, $this->data('CountDiscussions'), $this->data('_PagerUrl'));
PagerModule::Current($this->Pager);
$this->setData('_Page', $Page);
$this->setData('_Limit', $Limit);
$this->fireEvent('AfterBuildPager');
// Deliver JSON data if necessary
if ($this->_DeliveryType != DELIVERY_TYPE_ALL) {
$this->setJson('LessRow', $this->Pager->toString('less'));
$this->setJson('MoreRow', $this->Pager->toString('more'));
$this->View = 'discussions';
}
$this->render();
}
/**
* Returns an array of dropdown menus with the data from the filters array or an array containing an empty string
* to make it safe for echoing out.
*
* @return array An array of dropdown menus or an array containing an empty string.
*/
protected function getFilterDropdowns()
{
if (!$this->filters) {
return [''];
}
$dropdowns = [];
foreach ($this->filters as $filterSet) {
// Check to see if there's a category restriction.
if ($categories = val('categories', $filterSet)) {
if (!in_array($this->categoryID, $categories)) {
continue;
}
}
$setKey = val('key', $filterSet);
$dropdown = new DropdownModule('discussions-filter-' . $setKey, val('name', $filterSet), 'discussion-filter');
// Override the trigger text?
$selectedValue = val($setKey, $this->selectedFilters);
if ($selectedValue && $selectedValue != 'none') {
$selected = val('name', $filterSet['filters'][$selectedValue]);
$dropdown->setTrigger($selected);
}
$dropdown->setView($this->dropdownView);
$dropdown->setForceDivider(true);
// Adds dividers between groups in the dropdown.
// Add the filters to the dropdown
foreach (val('filters', $filterSet) as $filter) {
$key = val('group', $filter, '') . '.' . val('key', $filter);
$queryString = DiscussionModel::getSortFilterQueryString($this->selectedSort, $this->selectedFilters, '', [$setKey => val('key', $filter)]);
$pathAndQuery = $this->getPagelessPath() . $queryString;
if (empty($pathAndQuery)) {
$pathAndQuery = '/';
}
$url = url($pathAndQuery);
$dropdown->addLink(val('name', $filter), $url, $key, '', array(), false, array('rel' => 'nofollow'));
}
$dropdowns[] = $dropdown;
}
return $dropdowns;
}
/**
* Show all discussions in a particular category.
*
* @since 2.0.0
* @access public
*
* @param string $CategoryIdentifier Unique category slug or ID.
* @param int $Offset Number of discussions to skip.
*/
public function index($CategoryIdentifier = '', $Page = '0')
{
// Figure out which category layout to choose (Defined on "Homepage" settings page).
$Layout = c('Vanilla.Categories.Layout');
if ($CategoryIdentifier == '') {
switch ($Layout) {
case 'mixed':
$this->View = 'discussions';
$this->Discussions();
break;
case 'table':
$this->table();
break;
default:
$this->View = 'all';
$this->All();
break;
}
return;
} else {
$Category = CategoryModel::categories($CategoryIdentifier);
if (empty($Category)) {
// Try lowercasing before outright failing
$LowerCategoryIdentifier = strtolower($CategoryIdentifier);
if ($LowerCategoryIdentifier != $CategoryIdentifier) {
$Category = CategoryModel::categories($LowerCategoryIdentifier);
if ($Category) {
redirect("/categories/{$LowerCategoryIdentifier}", 301);
}
}
throw notFoundException();
}
$Category = (object) $Category;
Gdn_Theme::section($Category->CssClass);
// Load the breadcrumbs.
$this->setData('Breadcrumbs', CategoryModel::GetAncestors(val('CategoryID', $Category)));
$this->setData('Category', $Category, true);
$this->title(htmlspecialchars(val('Name', $Category, '')));
$this->Description(val('Description', $Category), true);
if ($Category->DisplayAs == 'Categories') {
if (val('Depth', $Category) > c('Vanilla.Categories.NavDepth', 0)) {
// Headings don't make sense if we've cascaded down one level.
saveToConfig('Vanilla.Categories.DoHeadings', false, false);
}
trace($this->deliveryMethod(), 'delivery method');
trace($this->deliveryType(), 'delivery type');
trace($this->SyndicationMethod, 'syndication');
if ($this->SyndicationMethod != SYNDICATION_NONE) {
// RSS can't show a category list so just tell it to expand all categories.
saveToConfig('Vanilla.ExpandCategories', true, false);
} else {
// This category is an overview style category and displays as a category list.
switch ($Layout) {
case 'mixed':
$this->View = 'discussions';
$this->Discussions($CategoryIdentifier);
break;
case 'table':
$this->table($CategoryIdentifier);
break;
default:
$this->View = 'all';
$this->All($CategoryIdentifier);
break;
}
return;
}
}
Gdn_Theme::section('DiscussionList');
// Figure out which discussions layout to choose (Defined on "Homepage" settings page).
$Layout = c('Vanilla.Discussions.Layout');
switch ($Layout) {
case 'table':
if ($this->SyndicationMethod == SYNDICATION_NONE) {
$this->View = 'table';
}
break;
default:
// $this->View = 'index';
break;
}
// Load the subtree.
$Categories = CategoryModel::GetSubtree($CategoryIdentifier, false);
$this->setData('Categories', $Categories);
// Setup head
$this->Menu->highlightRoute('/discussions');
if ($this->Head) {
$this->addJsFile('discussions.js');
$this->Head->AddRss($this->SelfUrl . '/feed.rss', $this->Head->title());
}
// Set CategoryID
$CategoryID = val('CategoryID', $Category);
$this->setData('CategoryID', $CategoryID, true);
// Add modules
$this->addModule('NewDiscussionModule');
$this->addModule('DiscussionFilterModule');
$this->addModule('CategoriesModule');
$this->addModule('BookmarkedModule');
// Get a DiscussionModel
$DiscussionModel = new DiscussionModel();
$DiscussionModel->setSort(Gdn::request()->get());
$DiscussionModel->setFilters(Gdn::request()->get());
$this->setData('Sort', $DiscussionModel->getSort());
$this->setData('Filters', $DiscussionModel->getFilters());
$CategoryIDs = array($CategoryID);
if (c('Vanilla.ExpandCategories')) {
$CategoryIDs = array_merge($CategoryIDs, array_column($this->data('Categories'), 'CategoryID'));
}
$Wheres = array('d.CategoryID' => $CategoryIDs);
$this->setData('_ShowCategoryLink', count($CategoryIDs) > 1);
// Check permission
$this->permission('Vanilla.Discussions.View', true, 'Category', val('PermissionCategoryID', $Category));
// Set discussion meta data.
$this->EventArguments['PerPage'] = c('Vanilla.Discussions.PerPage', 30);
$this->fireEvent('BeforeGetDiscussions');
list($Offset, $Limit) = offsetLimit($Page, $this->EventArguments['PerPage']);
if (!is_numeric($Offset) || $Offset < 0) {
$Offset = 0;
}
$Page = PageNumber($Offset, $Limit);
// Allow page manipulation
$this->EventArguments['Page'] =& $Page;
$this->EventArguments['Offset'] =& $Offset;
$this->EventArguments['Limit'] =& $Limit;
$this->fireEvent('AfterPageCalculation');
// We want to limit the number of pages on large databases because requesting a super-high page can kill the db.
$MaxPages = c('Vanilla.Categories.MaxPages');
if ($MaxPages && $Page > $MaxPages) {
throw notFoundException();
}
$CountDiscussions = $DiscussionModel->getCount($Wheres);
if ($MaxPages && $MaxPages * $Limit < $CountDiscussions) {
$CountDiscussions = $MaxPages * $Limit;
}
$this->setData('CountDiscussions', $CountDiscussions);
$this->setData('_Limit', $Limit);
// We don't wan't child categories in announcements.
$Wheres['d.CategoryID'] = $CategoryID;
$AnnounceData = $Offset == 0 ? $DiscussionModel->GetAnnouncements($Wheres) : new Gdn_DataSet();
$this->setData('AnnounceData', $AnnounceData, true);
$Wheres['d.CategoryID'] = $CategoryIDs;
$this->DiscussionData = $this->setData('Discussions', $DiscussionModel->getWhereRecent($Wheres, $Limit, $Offset));
// Build a pager
$PagerFactory = new Gdn_PagerFactory();
$url = CategoryUrl($CategoryIdentifier);
$this->EventArguments['PagerType'] = 'Pager';
$this->fireEvent('BeforeBuildPager');
if (!$this->data('_PagerUrl')) {
$this->setData('_PagerUrl', $url . '/{Page}');
}
$queryString = DiscussionModel::getSortFilterQueryString($DiscussionModel->getSort(), $DiscussionModel->getFilters());
$this->setData('_PagerUrl', $this->data('_PagerUrl') . $queryString);
$this->Pager = $PagerFactory->GetPager($this->EventArguments['PagerType'], $this);
$this->Pager->ClientID = 'Pager';
$this->Pager->configure($Offset, $Limit, $CountDiscussions, $this->data('_PagerUrl'));
$this->Pager->Record = $Category;
PagerModule::Current($this->Pager);
$this->setData('_Page', $Page);
$this->setData('_Limit', $Limit);
$this->fireEvent('AfterBuildPager');
// Set the canonical Url.
$this->canonicalUrl(CategoryUrl($Category, PageNumber($Offset, $Limit)));
// Change the controller name so that it knows to grab the discussion views
$this->ControllerName = 'DiscussionsController';
// Pick up the discussions class
$this->CssClass = 'Discussions Category-' . GetValue('UrlCode', $Category);
// Deliver JSON data if necessary
if ($this->_DeliveryType != DELIVERY_TYPE_ALL) {
$this->setJson('LessRow', $this->Pager->toString('less'));
$this->setJson('MoreRow', $this->Pager->toString('more'));
$this->View = 'discussions';
}
// Render default view.
$this->fireEvent('BeforeCategoriesRender');
$this->render();
}
}
