Attribute.php 5.94 KB
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
namespace Magento\Eav\Model\ResourceModel;

use Magento\Framework\DB\Select;
use Magento\Framework\Model\AbstractModel;

/**
 * EAV attribute resource model (Using Forms)
 *
 * @api
 * @since 100.0.2
 */
abstract class Attribute extends \Magento\Eav\Model\ResourceModel\Entity\Attribute
{
    /**
     * Get EAV website table
     *
     * Get table, where website-dependent attribute parameters are stored
     * If realization doesn't demand this functionality, let this function just return null
     *
     * @return string|null
     */
    abstract protected function _getEavWebsiteTable();

    /**
     * Get Form attribute table
     *
     * Get table, where dependency between form name and attribute ids are stored
     *
     * @return string|null
     */
    abstract protected function _getFormAttributeTable();

    /**
     * Perform actions before object save
     *
     * @param \Magento\Framework\Model\AbstractModel $object
     * @return $this
     */
    protected function _beforeSave(AbstractModel $object)
    {
        $validateRules = $object->getData('validate_rules');
        if (is_array($validateRules)) {
            $object->setData('validate_rules', $this->getSerializer()->serialize($validateRules));
        }
        return parent::_beforeSave($object);
    }

    /**
     * Retrieve select object for load object data
     *
     * @param string $field
     * @param mixed $value
     * @param AbstractModel $object
     * @return Select
     */
    protected function _getLoadSelect($field, $value, $object)
    {
        $select = parent::_getLoadSelect($field, $value, $object);
        $websiteId = (int)$object->getWebsite()->getId();
        if ($websiteId) {
            $connection = $this->getConnection();
            $columns = [];
            $scopeTable = $this->_getEavWebsiteTable();
            $describe = $connection->describeTable($scopeTable);
            unset($describe['attribute_id']);
            foreach (array_keys($describe) as $columnName) {
                $columns['scope_' . $columnName] = $columnName;
            }
            $conditionSql = $connection->quoteInto(
                $this->getMainTable() . '.attribute_id = scope_table.attribute_id AND scope_table.website_id =?',
                $websiteId
            );
            $select->joinLeft(['scope_table' => $scopeTable], $conditionSql, $columns);
        }

        return $select;
    }

    /**
     * Save attribute/form relations after attribute save
     *
     * @param \Magento\Framework\Model\AbstractModel $object
     * @return $this
     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
     */
    protected function _afterSave(AbstractModel $object)
    {
        $forms = $object->getData('used_in_forms');
        $connection = $this->getConnection();
        if (is_array($forms)) {
            $where = ['attribute_id=?' => $object->getId()];
            $connection->delete($this->_getFormAttributeTable(), $where);

            $data = [];
            foreach ($forms as $formCode) {
                $data[] = ['form_code' => $formCode, 'attribute_id' => (int)$object->getId()];
            }

            if ($data) {
                $connection->insertMultiple($this->_getFormAttributeTable(), $data);
            }
        }

        // update sort order
        if (!$object->isObjectNew() && $object->dataHasChangedFor('sort_order')) {
            $data = ['sort_order' => $object->getSortOrder()];
            $where = ['attribute_id=?' => (int)$object->getId()];
            $connection->update($this->getTable('eav_entity_attribute'), $data, $where);
        }

        // save scope attributes
        $websiteId = (int)$object->getWebsite()->getId();
        if ($websiteId) {
            $table = $this->_getEavWebsiteTable();
            $describe = $this->getConnection()->describeTable($table);
            $data = [];
            if (!$object->getScopeWebsiteId() || $object->getScopeWebsiteId() != $websiteId) {
                $data = $this->getScopeValues($object);
            }

            $data['attribute_id'] = (int)$object->getId();
            $data['website_id'] = (int)$websiteId;
            unset($describe['attribute_id']);
            unset($describe['website_id']);

            $updateColumns = [];
            foreach (array_keys($describe) as $columnName) {
                $data[$columnName] = $object->getData('scope_' . $columnName);
                $updateColumns[] = $columnName;
            }

            $connection->insertOnDuplicate($table, $data, $updateColumns);
        }

        return parent::_afterSave($object);
    }

    /**
     * Return scope values for attribute and website
     *
     * @param \Magento\Eav\Model\Attribute $object
     * @return array
     */
    public function getScopeValues(\Magento\Eav\Model\Attribute $object)
    {
        $connection = $this->getConnection();
        $bind = ['attribute_id' => (int)$object->getId(), 'website_id' => (int)$object->getWebsite()->getId()];
        $select = $connection->select()->from(
            $this->_getEavWebsiteTable()
        )->where(
            'attribute_id = :attribute_id'
        )->where(
            'website_id = :website_id'
        )->limit(
            1
        );
        $result = $connection->fetchRow($select, $bind);

        if (!$result) {
            $result = [];
        }

        return $result;
    }

    /**
     * Return forms in which the attribute
     *
     * @param \Magento\Framework\Model\AbstractModel $object
     * @return array
     */
    public function getUsedInForms(AbstractModel $object)
    {
        $connection = $this->getConnection();
        $bind = ['attribute_id' => (int)$object->getId()];
        $select = $connection->select()->from(
            $this->_getFormAttributeTable(),
            'form_code'
        )->where(
            'attribute_id = :attribute_id'
        );

        return $connection->fetchCol($select, $bind);
    }
}