Skip to content

[6.0] Add modified start and end date filter to articled API endpoint #45210

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

Merged
Bodge-IT merged 2 commits into from
Apr 14, 2025
Merged

[6.0] Add modified start and end date filter to articled API endpoint #45210

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
18ee5a3
Add modified start and end date filter to articled API endpoint
laoneo Mar 25, 2025
69d850a
Merge branch '6.0-dev' into modified
Bodge-IT Apr 14, 2025
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
16 changes: 16 additions & 0 deletions administrator/components/com_content/src/Model/ArticlesModel.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -504,6 +504,22 @@ protected function getListQuery()
->bind(':tag', $tag, ParameterType::INTEGER);
}

// Filter by date after modified date.
$modifiedStartDateTime = $this->getState('filter.modified_start');

if (!empty($modifiedStartDateTime)) {
$query->where($db->quoteName('a.modified') . ' >= :startDate')
->bind(':startDate', $modifiedStartDateTime);
}

// Filter by date before modified date.
$modifiedEndDateTime = $this->getState('filter.modified_end');

if (!empty($modifiedEndDateTime)) {
$query->where($db->quoteName('a.modified') . ' <= :endDate')
->bind(':endDate', $modifiedEndDateTime);
}

// Add the list ordering clause.
$orderCol = $this->state->get('list.ordering', $defaultOrdering);
$orderDirn = $this->state->get('list.direction', 'DESC');
Expand Down
8 changes: 8 additions & 0 deletions api/components/com_content/src/Controller/ArticlesController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,14 @@ public function displayList()
$this->modelState->set('filter.language', $filter->clean($apiFilterInfo['language'], 'STRING'));
}

if (\array_key_exists('modified_start', $apiFilterInfo)) {
$this->modelState->set('filter.modified_start', $filter->clean($apiFilterInfo['modified_start'], 'STRING'));
}

if (\array_key_exists('modified_end', $apiFilterInfo)) {
$this->modelState->set('filter.modified_end', $filter->clean($apiFilterInfo['modified_end'], 'STRING'));
}

$apiListInfo = $this->input->get('list', [], 'array');

if (\array_key_exists('ordering', $apiListInfo)) {
Expand Down
12 changes: 12 additions & 0 deletions tests/System/integration/api/com_content/Articles.cy.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,18 @@ describe('Test that content API endpoint', () => {
.should('include', 'automated test article'));
});

it('can deliver a list of articles filtered by the modified start and end filter', () => {
cy.db_createArticle({ title: 'automated test article before', modified: '2025-03-15 10:00:00' })
.then(() => cy.db_createArticle({ title: 'automated test article within', modified: '2025-03-15 15:00:00' }))
.then(() => cy.db_createArticle({ title: 'automated test article after', modified: '2025-03-15 20:00:00' }))
.then(() => cy.api_get('/content/articles?filter[modified_start]=2025-03-15 14:00:00&filter[modified_end]=2025-03-15 16:00:00'))
.then((response) => cy.wrap(response).its('body').its('data.0').its('attributes')
.its('title')
.should('include', 'automated test article within')
.should('not.include', 'automated test article before')
.should('not.include', 'automated test article after'));
});

it('can deliver a single article', () => {
cy.db_createArticle({ title: 'automated test article' })
.then((article) => cy.api_get(`/content/articles/${article.id}`))
Expand Down