nystudio107\seomatic\controllers\ContentSeoController::actionMetaBundles()

Complexity

Conditions	23
Paths	273

Size

Total Lines	150
Code Lines	101

Duplication

Lines	0
Ratio	0 %

Importance

Changes	14
Bugs	0	Features	0

<?php
    public function actionMetaBundles(
        string $sort = 'sourceName|asc',
        int $page = 1,
        int $per_page = 20,
        $filter = '',
        $siteId = 0
    ): Response {
        $data = [];
        $sortField = 'sourceName';
        $sortType = 'ASC';
        // Figure out the sorting type
        if ($sort !== '') {
            if (strpos($sort, '|') === false) {
                $sortField = $sort;
            } else {
                list($sortField, $sortType) = explode('|', $sort);
            }
        }
        $sortType = strtoupper($sortType);
        $sortType = self::SORT_MAP[$sortType] ?? self::SORT_MAP['DESC'];
        $sortParams = [
            $sortField => $sortType,
        ];
        // Validate untrusted data
        if (!in_array($sortField, self::ALLOWED_SORT_FIELDS, true)) {
            throw new BadRequestHttpException(Craft::t('seomatic', 'Invalid sort field specified.'));
        }
        if ($sortField !== 'sourceName') {
            $sortParams = array_merge($sortParams, [
                'sourceName' => self::SORT_MAP['ASC'],
            ]);
        }

        // Query the db table
        $offset = ($page - 1) * $per_page;

        $currentSiteHandle = '';
        if ((int)$siteId !== 0) {
            $site = Craft::$app->getSites()->getSiteById($siteId);

It seems like $siteId can also be of type null; however, parameter $siteId of craft\services\Sites::getSiteById() does only seem to accept integer, maybe add an additional type check?

            if ($site !== null) {
                $currentSiteHandle = $site->handle;
            }
        }
        $bundleQuery = (new Query())
            ->select(['mb.*'])
            ->offset($offset)
            ->limit($per_page)
            ->orderBy($sortParams)

Space after closing parenthesis of function call prohibited

            ;

        // Since sectionIds, CategoryIds, etc. are not unique, we need to special case for them
        $seoElements = Seomatic::$plugin->seoElements->getAllSeoElementTypes();
        $tableIndex = 1;
        foreach ($seoElements as $seoElement) {
            $tableIndex++;
            $subQuery = (new Query())
                ->from(['{{%seomatic_metabundles}}'])
                ->where(['=', 'sourceBundleType', $seoElement::META_BUNDLE_TYPE]);

The constant nystudio107\seomatic\base\SeoElementInterface::META_BUNDLE_TYPE was not found. Maybe you did not declare it correctly or list all dependencies?

            if ((int)$siteId !== 0) {
                $subQuery->andWhere(['sourceSiteId' => $siteId]);
            }
            if ($filter !== '') {
                $subQuery->andWhere(['like', 'sourceName', $filter]);
            }
            $bundleQuery
                ->where(['mb'.$tableIndex.'.id' => null])
                ->from(['mb' => $subQuery])
                ->leftJoin(['mb'.$tableIndex => $subQuery], [
                    'and',
                    '[[mb.sourceId]] = [[mb'.$tableIndex.'.sourceId]]',
                    '[[mb.id]] < [[mb'.$tableIndex.'.id]]'
                ]);
        }
        $bundles = $bundleQuery->all();
        if ($bundles) {

The expression $bundles of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

            $dataArray = [];
            // Add in the `addLink` field
            foreach ($bundles as $bundle) {
                $dataItem = [];
                $metaBundle = MetaBundle::create($bundle);
                if ($metaBundle !== null) {
                    $sourceBundleType = $metaBundle->sourceBundleType;
                    $sourceHandle = $metaBundle->sourceHandle;
                    // For all the emojis
                    $dataItem['sourceName'] = html_entity_decode($metaBundle->sourceName, ENT_NOQUOTES, 'UTF-8');
                    $dataItem['sourceType'] = $metaBundle->sourceType;
                    $dataItem['contentSeoUrl'] = UrlHelper::cpUrl(
                        "seomatic/edit-content/general/{$sourceBundleType}/{$sourceHandle}/{$currentSiteHandle}"
                    );
                    // Fill in the number of entries
                    $entries = 0;
                    $seoElement = null;
                    if ($metaBundle->sourceBundleType) {
                        $seoElement = Seomatic::$plugin->seoElements->getSeoElementByMetaBundleType(
                            $metaBundle->sourceBundleType
                        );
                    }
                    /** @var SeoElementInterface $seoElement */

The open comment tag must be the only content on the line

The close comment tag must be the only content on the line

                    if ($seoElement !== null) {
                        // Ensure `null` so that the resulting element query is correct
                        if (empty($metaBundle->metaSitemapVars->sitemapLimit)) {
                            $metaBundle->metaSitemapVars->sitemapLimit = null;
                        }
                        $query = $seoElement::sitemapElementsQuery($metaBundle);
                        $entries = $query->count();
                    }
                    $dataItem['entries'] = $entries;
                    // Basic configuration setup
                    $dataItem['title'] = $metaBundle->metaGlobalVars->seoTitle !== '' ? 'enabled' : 'disabled';
                    $dataItem['description'] = $metaBundle->metaGlobalVars->seoDescription !== '' ? 'enabled' : 'disabled';
                    $dataItem['image'] = $metaBundle->metaGlobalVars->seoImage !== '' ? 'enabled' : 'disabled';
                    $dataItem['sitemap'] = $metaBundle->metaSitemapVars->sitemapUrls ? 'enabled' : 'disabled';
                    $dataItem['robots'] = $metaBundle->metaGlobalVars->robots;
                    // Calculate the setup stat
                    $stat = 0;
                    $numGrades = \count(SettingsController::SETUP_GRADES);
                    $numFields = \count(SettingsController::SEO_SETUP_FIELDS);
                    foreach (SettingsController::SEO_SETUP_FIELDS as $setupField => $setupLabel) {
                        $stat += (int)!empty($metaBundle->metaGlobalVars[$setupField]);
                        $value = $variables['contentSetupChecklist'][$setupField]['value'] ?? 0;
                        $variables['contentSetupChecklist'][$setupField] = [
                            'label' => $setupLabel,
                            'value' => $value + (int)!empty($metaBundle->metaGlobalVars[$setupField]),
                        ];
                    }
                    $stat = round($numGrades - (($stat * $numGrades) / $numFields));
                    if ($stat >= $numGrades) {
                        $stat = $numGrades - 1;
                    }
                    $dataItem['setup'] = SettingsController::SETUP_GRADES[$stat];

                    $dataArray[] = $dataItem;
                }
            }
            // Format the data for the API
            $data['data'] = $dataArray;
            $count = $bundleQuery->count();
            $data['links']['pagination'] = [
                'total' => $count,
                'per_page' => $per_page,
                'current_page' => $page,
                'last_page' => ceil($count / $per_page),
                'next_page_url' => null,
                'prev_page_url' => null,
                'from' => $offset + 1,
                'to' => $offset + ($count > $per_page ? $per_page : $count),
            ];
        }

        return $this->asJson($data);
    }