nystudio107 / craft-seomatic

src/helpers/EagerLoad.php

<?php
/**
 * SEOmatic plugin for Craft CMS
 *
 * A turnkey SEO implementation for Craft CMS that is comprehensive, powerful,
 * and flexible
 *
 * @link      https://nystudio107.com
 * @copyright Copyright (c) nystudio107
 */

namespace nystudio107\seomatic\helpers;

use craft\fields\Matrix;
use craft\models\FieldLayout;
use craft\models\Section;
use nystudio107\seomatic\helpers\Field as FieldHelper;
use nystudio107\seomatic\models\MetaBundle;
use nystudio107\seomatic\Seomatic;

/**
 * @author    nystudio107
 * @package   Seomatic
 * @since     4.1.11
 */
class EagerLoad
{
    /**
     * Build an eager loading map based on the field layouts from the $metaBundle's
     * "Section"
     *
     * @param MetaBundle $metaBundle
     * @return array
     */
    public static function sitemapEagerLoadMap($metaBundle): array
    {
        $eagerLoadMap = [];
        $transform = $metaBundle->metaSitemapVars->sitemapAssetTransform;
        if ($transform === 'null' || empty($transform)) {
            $transform = null;
        }
        $seoElement = Seomatic::$plugin->seoElements->getSeoElementByMetaBundleType($metaBundle->sourceBundleType);
        /** @var Section $section */
        $section = $seoElement::sourceModelFromHandle($metaBundle->sourceHandle);
        if (method_exists($section, 'getEntryTypes')) {
            $entryTypes = $section->getEntryTypes();
            foreach ($entryTypes as $entryType) {
                $layout = $entryType->getFieldLayout();
                $eagerLoadMap[] = self::assetFieldEagerLoadMap($layout, $transform);
                $eagerLoadMap[] = self::matrixFieldEagerLoadMap($layout, $transform);
            }
        }
        if (method_exists($section, 'getFieldLayout')) {
            $layout = $section->getFieldLayout();
            $eagerLoadMap[] = self::assetFieldEagerLoadMap($layout, $transform);
            $eagerLoadMap[] = self::matrixFieldEagerLoadMap($layout, $transform);
        }
        // Flatten the array
        return array_merge([], ...$eagerLoadMap);
    }

    /**
     * Return an array of field handles for eager loading .with() in Element queries
     *
     * @param FieldLayout $layout
     * @param ?string $transform
     * @return array
     */
    public static function assetFieldEagerLoadMap($layout, $transform): array
    {
        $fieldMap = [];
        $assetFields = FieldHelper::fieldsOfTypeFromLayout(FieldHelper::ASSET_FIELD_CLASS_KEY, $layout);
        foreach ($assetFields as $assetFieldHandle) {
            $fieldMap[] = empty($transform) ? $assetFieldHandle : [$assetFieldHandle, ['withTransforms' => $transform]];
        }

        return $fieldMap;
    }

    /**
     * Return an array of field handles for eager loading .with() in Element queries
     *
     * @param FieldLayout $layout
     * @param ?string $transform
     * @return array
     */
    public static function matrixFieldEagerLoadMap($layout, $transform): array
    {
        $fieldMap = [];
        $matrixFields = FieldHelper::fieldsOfTypeFromLayout(FieldHelper::BLOCK_FIELD_CLASS_KEY, $layout);
        foreach ($matrixFields as $matrixFieldHandle) {
            /** @var Matrix $matrixField */
            $matrixField = $layout->getFieldByHandle($matrixFieldHandle);
            if (method_exists($matrixField, 'getBlockTypes')) {
                $blockTypes = $matrixField->getBlockTypes();
                foreach ($blockTypes as $blockType) {
                    $blockName = $blockType->handle;

The assignment to $blockName is dead and can be removed.

                    $matrixLayout = $blockType->getFieldLayout();
                    $assetFields = FieldHelper::fieldsOfTypeFromLayout(FieldHelper::ASSET_FIELD_CLASS_KEY, $matrixLayout);
                    foreach ($assetFields as $assetFieldHandle) {
                        $fieldMap[] = empty($transform) ? "$matrixFieldHandle.$assetFieldHandle" : ["$matrixFieldHandle.$assetFieldHandle", ['withTransforms' => $transform]];
                    }
                }
            }
        }

        return $fieldMap;
    }
}