[5.4] Add checkedout filter to the Article Manager (joomla#45761)

* API filter articles by their checked out status and user
* Administrator backend with checked out article filter

Author: Aashish-Jha-11

administrator/components/com_content/forms/filter_articles.xml

@@ -89,6 +89,19 @@
 			<option value="*">JALL</option>
 		</field>
 
+		<field
+			name="checked_out"
+			type="list"
+			label="COM_CONTENT_CHECKED_OUT"
+			class="js-select-submit-on-change"
+			default=""
+			validate="options"
+			>
+			<option value="">COM_CONTENT_SELECT_CHECKED_OUT</option>
+			<option value="0">COM_CONTENT_FILTER_CHECKED_OUT_NO</option>
+			<option value="-1">COM_CONTENT_FILTER_CHECKED_OUT_YES</option>
+		</field>
+
 		<field
 			name="tag"
 			type="tag"

administrator/components/com_content/src/Model/ArticlesModel.php

@@ -145,6 +145,7 @@ protected function populateState($ordering = 'a.id', $direction = 'desc')
         $this->getUserStateFromRequest($this->context . '.filter.tag', 'filter_tag', '');
         $this->getUserStateFromRequest($this->context . '.filter.access', 'filter_access');
         $this->getUserStateFromRequest($this->context . '.filter.language', 'filter_language', '');
+        $this->getUserStateFromRequest($this->context . '.filter.checked_out', 'filter_checked_out', '');
 
         // List state information.
         parent::populateState($ordering, $direction);
@@ -179,6 +180,7 @@ protected function getStoreId($id = '')
         $id .= ':' . serialize($this->getState('filter.author_id'));
         $id .= ':' . $this->getState('filter.language');
         $id .= ':' . serialize($this->getState('filter.tag'));
+        $id .= ':' . $this->getState('filter.checked_out');
 
         return parent::getStoreId($id);
     }
@@ -482,6 +484,24 @@ protected function getListQuery()
                 ->bind(':language', $language);
         }
 
+        // Filter by checked out status.
+        $checkedOut = $this->getState('filter.checked_out');
+
+        if (is_numeric($checkedOut)) {
+            if ($checkedOut == -1) {
+                // Only checked out articles
+                $query->where($db->quoteName('a.checked_out') . ' > 0');
+            } elseif ($checkedOut == 0) {
+                // Only not checked out articles (checked_out is 0 or NULL)
+                $query->where('(' . $db->quoteName('a.checked_out') . ' = 0 OR ' . $db->quoteName('a.checked_out') . ' IS NULL)');
+            } else {
+                // Checked out by specific user
+                $checkedOut = (int) $checkedOut;
+                $query->where($db->quoteName('a.checked_out') . ' = :checkedOutUser')
+                    ->bind(':checkedOutUser', $checkedOut, ParameterType::INTEGER);
+            }
+        }
+
         // Filter by a single or group of tags.
         $tag = $this->getState('filter.tag');
 

administrator/language/en-GB/com_content.ini

@@ -14,6 +14,7 @@ COM_CONTENT_BATCH_OPTIONS="Batch process the selected articles"
 COM_CONTENT_BATCH_TIP="If a category is selected for move/copy, any actions selected will be applied to the copied or moved articles. Otherwise, all actions are applied to the selected articles."
 COM_CONTENT_CHANGE_STAGE="Change stage"
 COM_CONTENT_CHANGE_STAGE_AMBIGUOUS_TRANSITIONS="Some transitions are ambiguous for this condition. Please select your preferred transition and proceed."
+COM_CONTENT_CHECKED_OUT="Checked Out"
 COM_CONTENT_CONFIG_ARTICLE_SETTINGS_DESC="These settings apply for article layouts unless they are changed for a specific menu item or article."
 COM_CONTENT_CONFIG_BLOG_SETTINGS_DESC="These settings apply for blog or featured layouts unless they are changed for a specific menu item."
 COM_CONTENT_CONFIG_BLOG_SETTINGS_LABEL="Blog/Featured Layouts"
@@ -104,6 +105,8 @@ COM_CONTENT_FIELDSET_PUBLISHING="Publishing"
 COM_CONTENT_FIELDSET_RULES="Permissions"
 COM_CONTENT_FIELDSET_URLS_AND_IMAGES="Images and Links"
 COM_CONTENT_FILTER_AUTHORS_BY_ME="- Created by me -"
+COM_CONTENT_FILTER_CHECKED_OUT_NO="Not Checked Out"
+COM_CONTENT_FILTER_CHECKED_OUT_YES="Checked Out"
 COM_CONTENT_FILTER_FEATURED_NO="Unfeatured Articles"
 COM_CONTENT_FILTER_FEATURED_YES="Featured Articles"
 COM_CONTENT_FILTER_SEARCH_DESC="Search in title, alias and note. Prefix with ID: or AUTHOR: or CONTENT: to search for an article ID, article author or search in article content. Prefix with CHECKEDOUT: to search for content checked out by a specified user."
@@ -165,6 +168,7 @@ COM_CONTENT_RUN_TRANSITIONS="Run Transitions"
 COM_CONTENT_SAVE_SUCCESS="Article saved."
 COM_CONTENT_SAVE_WARNING="Alias already existed so a number was added at the end. You can re-edit the article to customise the alias."
 COM_CONTENT_SELECT_AN_ARTICLE="Select an Article"
+COM_CONTENT_SELECT_CHECKED_OUT="- Select Checked Out -"
 COM_CONTENT_SELECT_FEATURED="- Select Featured -"
 COM_CONTENT_SHARED_DESC="These settings apply for Shared Options in List, Blog and Featured unless they are changed by the menu settings."
 COM_CONTENT_SHARED_LABEL="Shared"

api/components/com_content/src/Controller/ArticlesController.php

@@ -82,6 +82,10 @@ public function displayList()
             $this->modelState->set('filter.language', $filter->clean($apiFilterInfo['language'], 'STRING'));
         }
 
+        if (\array_key_exists('checked_out', $apiFilterInfo)) {
+            $this->modelState->set('filter.checked_out', $filter->clean($apiFilterInfo['checked_out'], 'INT'));
+        }
+
         $apiListInfo = $this->input->get('list', [], 'array');
 
         if (\array_key_exists('ordering', $apiListInfo)) {

components/com_content/src/Model/ArticlesModel.php

@@ -491,6 +491,24 @@ protected function getListQuery()
             $query->where($authorWhere . $authorAliasWhere);
         }
 
+        // Filter by checked_out status
+        $checkedOut = $this->getState('filter.checked_out', null);
+
+        if (is_numeric($checkedOut)) {
+            if ($checkedOut == -1) {
+                // Only checked out articles
+                $query->where($db->quoteName('a.checked_out') . ' > 0');
+            } elseif ($checkedOut == 0) {
+                // Only not checked out articles
+                $query->where('(' . $db->quoteName('a.checked_out') . ' = 0 OR ' . $db->quoteName('a.checked_out') . ' IS NULL)');
+            } else {
+                // Checked out by specific user
+                $checkedOut = (int) $checkedOut;
+                $query->where($db->quoteName('a.checked_out') . ' = :checkedOutUser')
+                    ->bind(':checkedOutUser', $checkedOut, ParameterType::INTEGER);
+            }
+        }
+
         // Filter by start and end dates.
         if (
             !(is_numeric($condition) && $condition == ContentComponent::CONDITION_UNPUBLISHED)