EntityAttributeList.php 4.08 KB
Newer Older
Ketan's avatar
Ketan committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
declare(strict_types=1);

namespace Magento\GraphQl\Model;

use Magento\Eav\Api\AttributeManagementInterface;
use Magento\Eav\Api\AttributeSetRepositoryInterface;
use Magento\Eav\Api\Data\AttributeInterface;
use Magento\Framework\Api\FilterBuilder;
use Magento\Framework\Api\MetadataServiceInterface;
use Magento\Framework\Api\SearchCriteriaBuilder;
use Magento\Framework\Exception\NoSuchEntityException;
use Magento\Framework\GraphQl\Exception\GraphQlNoSuchEntityException;

/**
 * Iterate through all attribute sets to retrieve attributes for any given entity type
 */
class EntityAttributeList
{
    /**
     * @var AttributeManagementInterface
     */
    private $attributeManagement;

    /**
     * @var AttributeSetRepositoryInterface
     */
    private $attributeSetRepository;

    /**
     * @var SearchCriteriaBuilder
     */
    private $searchCriteriaBuilder;

    /**
     * @var FilterBuilder
     */
    private $filterBuilder;

    /**
     * @param AttributeManagementInterface $attributeManagement
     * @param AttributeSetRepositoryInterface $attributeSetRepository
     * @param SearchCriteriaBuilder $searchCriteriaBuilder
     * @param FilterBuilder $filterBuilder
     */
    public function __construct(
        AttributeManagementInterface $attributeManagement,
        AttributeSetRepositoryInterface $attributeSetRepository,
        SearchCriteriaBuilder $searchCriteriaBuilder,
        FilterBuilder $filterBuilder
    ) {
        $this->attributeManagement =  $attributeManagement;
        $this->attributeSetRepository = $attributeSetRepository;
        $this->searchCriteriaBuilder = $searchCriteriaBuilder;
        $this->filterBuilder = $filterBuilder;
    }

    /**
     * Retrieve all EAV and custom attribute codes from all attribute sets for given entity code.
     *
     * Returned in the format [$attributeCode => $isSortable] with $isSortable being a boolean value where an attribute
     * can be sorted with in a search criteria expression. The metadata service parameter is only required if type has
     * custom attributes.
     *
     * @param string $entityCode
     * @param MetadataServiceInterface $metadataService
     * @return boolean[]
     * @throws GraphQlNoSuchEntityException
     */
    public function getDefaultEntityAttributes(
        string $entityCode,
        MetadataServiceInterface $metadataService = null
    ) : array {
        $this->searchCriteriaBuilder->addFilters(
            [
                $this->filterBuilder
                    ->setField('entity_type_code')
                    ->setValue($entityCode)
                    ->setConditionType('eq')
                    ->create(),
            ]
        );
        $attributeSetList = $this->attributeSetRepository->getList($this->searchCriteriaBuilder->create())->getItems();
        $attributes = [];
        foreach ($attributeSetList as $attributeSet) {
            try {
                $attributes = array_merge(
                    $attributes,
                    $this->attributeManagement->getAttributes($entityCode, $attributeSet->getAttributeSetId())
                );
            } catch (NoSuchEntityException $exception) {
                throw new GraphQlNoSuchEntityException(__('Entity code %1 does not exist.', [$entityCode]));
            }
        }
        $attributeCodes = [];
        $metadata = $metadataService ? $metadataService->getCustomAttributesMetadata() : [];
        foreach ($metadata as $customAttribute) {
            if (!array_key_exists($customAttribute->getAttributeCode(), $attributeCodes)) {
                $attributeCodes[$customAttribute->getAttributeCode()] = false;
            }
        }
        /** @var AttributeInterface $attribute */
        foreach ($attributes as $attribute) {
            if (!array_key_exists($attribute->getAttributeCode(), $attributeCodes)) {
                $attributeCodes[$attribute->getAttributeCode()]
                    = ((! $attribute->getIsUserDefined()) && !is_array($attribute));
            }
        }
        return $attributeCodes;
    }
}