BackendInterface.php 1.97 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
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
namespace Magento\Eav\Model\Entity\Attribute\Backend;

/**
 * Entity attribute backend interface
 *
 * Backend is responsible for saving the values of the attribute
 * and performing pre and post actions
 *
 */
interface BackendInterface
{
    /**
     * @return string
     */
    public function getTable();

    /**
     * @return bool
     */
    public function isStatic();

    /**
     * @return string
     */
    public function getType();

    /**
     * @return string
     */
    public function getEntityIdField();

    /**
     * @param int $valueId
     * @return $this
     */
    public function setValueId($valueId);

    /**
     * @return int
     */
    public function getValueId();

    /**
     * @param \Magento\Framework\DataObject $object
     * @return $this
     */
    public function afterLoad($object);

    /**
     * @param \Magento\Framework\DataObject $object
     * @return $this
     */
    public function beforeSave($object);

    /**
     * @param \Magento\Framework\DataObject $object
     * @return $this
     */
    public function afterSave($object);

    /**
     * @param \Magento\Framework\DataObject $object
     * @return $this
     */
    public function beforeDelete($object);

    /**
     * @param \Magento\Framework\DataObject $object
     * @return $this
     */
    public function afterDelete($object);

    /**
     * Get entity value id
     *
     * @param \Magento\Framework\DataObject $entity
     * @return int
     */
    public function getEntityValueId($entity);

    /**
     * Set entity value id
     *
     * @param \Magento\Framework\DataObject $entity
     * @param int $valueId
     * @return $this
     */
    public function setEntityValueId($entity, $valueId);

    /**
     * Whether an attribute is represented by a scalar value that can be stored in a generic way
     *
     * @return bool
     */
    public function isScalar();
}