Skip to content

feat: extend join tables config for types #25

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: master
Choose a base branch
from
Open

feat: extend join tables config for types #25

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
273ebb0
feat: extend join tables config for types
Zerogiven Mar 21, 2023
864e545
fix: typo
Zerogiven Mar 21, 2023
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
15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ The built-in SilverStripe search form is a very simple search engine. This plugi
* `ClassName`: full ClassName
* `ClassNameShort`: namespaced ClassName
* `Filters`: a list of filters to apply pre-search (maps to `DataList->Filter(key => value)`)
* `JoinTables`: Join Tables. (format `JoinTable` or `JoinTable.Column` or `JoinTable.Column: JoinTableOn.Column` or `JoinTable: [JoinTableFrom.Column: JoinTableOn.Column]`. Look below for examples)
* `Columns`: columns to search for query string matches (format `Table.Column`)
* `filters`: associative list of filter options
* `Structure`: defines the filter's relational structure (must be one of `db`, `has_one` or `many_many`)
Expand All @@ -51,7 +52,7 @@ TODO: `defaults`: Default attributes or settings, as opposed to those submitted

# Example configuration

```
```yml
---
Name: search
Before:
Expand All @@ -76,6 +77,18 @@ PlasticStudio\Search\SearchPageController:
Filters:
SiteTree_Live.ShowInSearch: '1'
JoinTables: ['SiteTree_Live']
# Another possible syntax (same result like above):
# JoinTables: ['SiteTree_Live.ID']

# Another possible syntax (same result like above):
# JoinTables:
# - "SiteTree_Live.ID": "Page.ID"

# Another possible syntax (same result like above):
# JoinTables:
# - "SiteTree_Live":
# - "SiteTree_Live.ID": "Page.ID"

Columns: ['SiteTree_Live.Title','SiteTree_Live.MenuTitle','SiteTree_Live.Content', 'SiteTree_Live.ElementalSearchContent']
filters:
updated_before:
Expand Down
9 changes: 9 additions & 0 deletions _config/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,15 @@ SilverStripe\CMS\Model\SiteTree:
# Filters:
# SiteTree_Live.ShowInSearch: '1'
# JoinTables: ['SiteTree_Live']
# # Same result as above
# # JoinTables: ['SiteTree_Live.ID'] # Same result as above
# # Same result as above
# # JoinTables:
# # - 'SiteTree_Live.ID': 'Page_Live.ID'
# # Same result as above
# # JoinTables:
# # - 'SiteTree_Live':
# # 'SiteTree_Live.ID': 'Page_Live.ID'
# Columns: ['SiteTree_Live.Title','SiteTree_Live.MetaDescription','SiteTree_Live.MenuTitle','SiteTree_Live.Content']
# filters:
# edited_before:
Expand Down
67 changes: 65 additions & 2 deletions src/SearchPageController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,8 +300,71 @@ public function PerformSearch(){
// Join this type with any dependent tables (if applicable)
if (isset($type['JoinTables'])){
foreach ($type['JoinTables'] as $joinTable){
$joins.= "LEFT JOIN \"".$joinTable."\" ON \"".$joinTable."\".\"ID\" = \"".$type['Table']."\".\"ID\" ";
}
/**
* Valid yaml values: SiteTree, SiteTree.ID
* SQL: LEFT JOIN SiteTree ON SiteTree.ID = Table.ID
*/
if (is_string(($joinTable))) {
$joinTableField = 'ID';

if (substr_count($joinTable, '.') > 0) {
[$joinTable, $joinTableField] = explode('.', $joinTable);
}

$joins.= "LEFT JOIN \"".$joinTable."\" ON \"".$joinTable."\".\"".$joinTableField."\" = \"".$type['Table']."\".\"ID\" ";

continue;
}

/**
* Valid yaml value: - "SiteTree.ID": "Page.ID"
* SQL: LEFT JOIN SiteTree ON SiteTree.ID = Page.ID
*/
if (is_array($joinTable) && is_string(reset($joinTable))) {
$joinTableTo = reset($joinTable);
$joinTableToField = 'ID';
$joinTable = array_key_first($joinTable);
$joinTableField = 'ID';

if (substr_count($joinTable, '.') > 0) {
[$joinTable, $joinTableField] = explode('.', $joinTable);
}

if (substr_count($joinTableTo, '.') > 0) {
[$joinTableTo, $joinTableToField] = explode('.', $joinTableTo);
}

$joins.= "LEFT JOIN \"".$joinTable."\" ON \"".$joinTable."\".\"".$joinTableField."\" = \"".$joinTableTo."\".\"".$joinTableToField."\" ";

continue;
}

/**
* Valid yaml value: - "SiteTree":
* - "SiteTree.ID": "Page.ID"
* SQL: LEFT JOIN SiteTree ON SiteTree.ID = Page.ID
*/
if (is_array($joinTable) && is_array(reset($joinTable))) {
$joinTableFrom = array_key_first(reset($joinTable));
$joinTableFromField = 'ID';
$joinTableTo = reset($joinTable);
$joinTableTo = reset($joinTableTo);
$joinTableToField = 'ID';
$joinTable = array_key_first($joinTable);

if (substr_count($joinTableFrom, '.') > 0) {
[$joinTableFrom, $joinTableFromField] = explode('.', $joinTableFrom);
}

if (substr_count($joinTableTo, '.') > 0) {
[$joinTableTo, $joinTableToField] = explode('.', $joinTableTo);
}

$joins.= "LEFT JOIN \"".$joinTable."\" ON \"".$joinTableFrom."\".\"".$joinTableFromField."\" = \"".$joinTableTo."\".\"".$joinTableToField."\" ";

continue;
}
}
}

/**
Expand Down