pkp/pkp-lib#8700 Updated code to make use of the Laravel Builder

pkp · May 30, 2024 · 82a8dd4 · 82a8dd4
1 parent 8657b98
commit 82a8dd4
Showing 1 changed file with 61 additions and 68 deletions.
diff --git a/classes/submission/DAO.php b/classes/submission/DAO.php
@@ -14,6 +14,9 @@
 namespace APP\submission;
 
 use APP\plugins\PubObjectsExportPlugin;
+use Illuminate\Database\Query\Builder;
+use Illuminate\Database\Query\JoinClause;
+use Illuminate\Support\Facades\DB;
 use PKP\db\DAOResultFactory;
 use PKP\db\DBResultRange;
 use PKP\identity\Identity;
@@ -33,78 +36,68 @@ public function deleteById(int $id)
     /**
      * Get all published submissions (eventually with a pubId assigned and) matching the specified settings.
      *
-     * @param ?string $pubIdType
-     * @param ?string $title
-     * @param ?string $author
-     * @param ?int $issueId
-     * @param ?string $pubIdSettingName
-     * @param ?string $pubIdSettingValue
+     * @param null|mixed $pubIdType
+     * @param null|mixed $title
+     * @param null|mixed $author
+     * @param null|mixed $issueId
+     * @param null|mixed $pubIdSettingName
+     * @param null|mixed $pubIdSettingValue
      * @param ?DBResultRange $rangeInfo
      *
      * @return DAOResultFactory<Submission>
      */
-    public function getExportable(
-        $contextId,
-        $pubIdType = null,
-        $title = null,
-        $author = null,
-        $issueId = null,
-        $pubIdSettingName = null,
-        $pubIdSettingValue = null,
-        $rangeInfo = null
-    ) {
-        $params = [];
-        if ($pubIdSettingName) {
-            $params[] = $pubIdSettingName;
-        }
-        $params[] = Submission::STATUS_PUBLISHED;
-        $params[] = $contextId;
-        if ($pubIdType) {
-            $params[] = 'pub-id::' . $pubIdType;
-        }
-        if ($title) {
-            $params[] = 'title';
-            $params[] = '%' . $title . '%';
-        }
-        if ($author) {
-            $params[] = $author;
-            $params[] = $author;
-        }
-        if ($issueId) {
-            $params[] = $issueId;
-        }
-        if ($pubIdSettingName && $pubIdSettingValue && $pubIdSettingValue != PubObjectsExportPlugin::EXPORT_STATUS_NOT_DEPOSITED) {
-            $params[] = $pubIdSettingValue;
-        }
-
-        $baseSql = '
-            FROM submissions s
-            LEFT JOIN publications p ON s.current_publication_id = p.publication_id
-            LEFT JOIN publication_settings ps ON p.publication_id = ps.publication_id'
-            . ($pubIdType != null ? ' LEFT JOIN publication_settings pspidt ON (p.publication_id = pspidt.publication_id)' : '')
-            . ($title != null ? ' LEFT JOIN publication_settings pst ON (p.publication_id = pst.publication_id)' : '')
-            . ($author != null ? ' LEFT JOIN authors au ON (p.publication_id = au.publication_id)
-                    LEFT JOIN author_settings asgs ON (asgs.author_id = au.author_id AND asgs.setting_name = \'' . Identity::IDENTITY_SETTING_GIVENNAME . '\')
-                    LEFT JOIN author_settings asfs ON (asfs.author_id = au.author_id AND asfs.setting_name = \'' . Identity::IDENTITY_SETTING_FAMILYNAME . '\')
-                ' : '')
-            . ($pubIdSettingName != null ? ' LEFT JOIN submission_settings pss ON (s.submission_id = pss.submission_id AND pss.setting_name = ?)' : '')
-            . ' WHERE s.status = ?
-            AND s.context_id = ?'
-            . ($pubIdType != null ? ' AND pspidt.setting_name = ? AND pspidt.setting_value IS NOT NULL' : '')
-            . ($title != null ? ' AND (pst.setting_name = ? AND pst.setting_value LIKE ?)' : '')
-            . ($author != null ? ' AND (asgs.setting_value LIKE ? OR asfs.setting_value LIKE ?)' : '')
-            . (($pubIdSettingName != null && $pubIdSettingValue != null && $pubIdSettingValue == PubObjectsExportPlugin::EXPORT_STATUS_NOT_DEPOSITED) ? ' AND pss.setting_value IS NULL' : '')
-            . (($pubIdSettingName != null && $pubIdSettingValue != null && $pubIdSettingValue != PubObjectsExportPlugin::EXPORT_STATUS_NOT_DEPOSITED) ? ' AND pss.setting_value = ?' : '')
-            . (($pubIdSettingName != null && is_null($pubIdSettingValue)) ? ' AND (pss.setting_value IS NULL OR pss.setting_value = \'\')' : '');
+    public function getExportable($contextId, $pubIdType = null, $title = null, $author = null, $issueId = null, $pubIdSettingName = null, $pubIdSettingValue = null, $rangeInfo = null)
+    {
+        $q = DB::table('submissions', 's')
+            ->leftJoin('publications AS p', 's.current_publication_id', '=', 'p.publication_id')
+            ->leftJoin('publication_settings AS ps', 'p.publication_id', '=', 'ps.publication_id')
+            ->when($pubIdType != null, fn (Builder $q) => $q->leftJoin('publication_settings AS pspidt', 'p.publication_id', '=', 'pspidt.publication_id'))
+            ->when($title != null, fn (Builder $q) => $q->leftJoin('publication_settings AS pst', 'p.publication_id', '=', 'pst.publication_id'))
+            ->when(
+                $author != null,
+                fn (Builder $q) => $q->leftJoin('authors AS au', 'p.publication_id', '=', 'au.publication_id')
+                    ->leftJoin(
+                        'author_settings AS asgs',
+                        fn (JoinClause $j) => $j->on('asgs.author_id', '=', 'au.author_id')
+                            ->where('asgs.setting_name', '=', Identity::IDENTITY_SETTING_GIVENNAME)
+                    )
+                    ->leftJoin(
+                        'author_settings AS asfs',
+                        fn (JoinClause $j) => $j->on('asfs.author_id', '=', 'au.author_id')
+                            ->where('asfs.setting_name', '=', Identity::IDENTITY_SETTING_FAMILYNAME)
+                    )
+            )
+            ->when(
+                $pubIdSettingName,
+                fn (Builder $q) => $q->leftJoin(
+                    'submission_settings AS pss',
+                    fn (JoinClause $j) => $j->on('s.submission_id', '=', 'pss.submission_id')
+                        ->where('pss.setting_name', '=', $pubIdSettingName)
+                )
+            )
+            ->where('s.status', '=', Submission::STATUS_PUBLISHED)
+            ->where('s.context_id', '=', $contextId)
+            ->when($pubIdType != null, fn (Builder $q) => $q->where('pspidt.setting_name', '=', "pub-id::{$pubIdType}")->whereNotNull('pspidt.setting_value'))
+            ->when($title != null, fn (Builder $q) => $q->where('pst.setting_name', '=', 'title')->where('pst.setting_value', 'LIKE', "%{$title}%"))
+            ->when($author != null, fn (Builder $q) => $q->where(fn (Builder $q) => $q->whereRaw("CONCAT(COALESCE(asgs.setting_value, ''), ' ', COALESCE(asfs.setting_value, ''))", 'LIKE', $author)))
+            ->when(
+                $pubIdSettingName,
+                fn (Builder $q) => $q->when(
+                    $pubIdSettingValue === null,
+                    fn (Builder $q) => $q->whereRaw("COALESCE(pss.setting_value, '') = ''"),
+                    fn (Builder $q) => $q->when(
+                        $pubIdSettingValue != PubObjectsExportPlugin::EXPORT_STATUS_NOT_DEPOSITED,
+                        fn (Builder $q) => $q->where('pss.setting_value', '=', $pubIdSettingValue),
+                        fn (Builder $q) => $q->whereNull('pss.setting_value')
+                    )
+                )
+            )
+            ->groupBy('s.submission_id')
+            ->orderByRaw('MAX(p.date_published) DESC')
+            ->orderByDesc('s.submission_id')
+            ->select('s.*');
 
-        $rows = $this->deprecatedDao->retrieveRange(
-            "SELECT s.*
-            {$baseSql}
-            GROUP BY s.submission_id
-            ORDER BY MAX(p.date_published) DESC, s.submission_id DESC",
-            $params,
-            $rangeInfo
-        );
-        return new DAOResultFactory($rows, $this, 'fromRow', [], "SELECT 0 {$baseSql}", $params, $rangeInfo);
+        $rows = $this->deprecatedDao->retrieveRange($q, [], $rangeInfo);
+        return new DAOResultFactory($rows, $this, 'fromRow', [], $q, [], $rangeInfo);
     }
 }