How does \Magento\Catalog\Helper\Image::init() work?

dmitry_fedyuk (Dmitrii Fediuk) April 23, 2016, 9:37am 1

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Helper/Image.php#L166-L174


/**
 * Initialize Helper to work with Image
 *
 * @param \Magento\Catalog\Model\Product $product
 * @param string $imageId
 * @param array $attributes
 * @return $this
 */
public function init($product, $imageId, $attributes = [])

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Helper/Image.php#L146-L164


/**
 * Reset all previous data
 *
 * @return $this
 */
protected function _reset()
{
    $this->_model = null;
    $this->_scheduleRotate = false;
    $this->_angle = null;
    $this->_watermark = null;
    $this->_watermarkPosition = null;
    $this->_watermarkSize = null;
    $this->_watermarkImageOpacity = null;
    $this->_product = null;
    $this->_imageFile = null;
    $this->attributes = [];
    return $this;
}

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Helper/Image.php#L178-L181


$this->attributes = array_merge(
    $this->getConfigView()->getMediaAttributes('Magento_Catalog', self::MEDIA_TYPE_CONFIG_NODE, $imageId),
    $attributes
);

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Helper/Image.php#L17-L20


/**
 * Media config node
 */
const MEDIA_TYPE_CONFIG_NODE = 'images';

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Helper/Image.php#L781-L792


/**
 * Retrieve config view
 *
 * @return \Magento\Framework\Config\View
 */
protected function getConfigView()
{
    if (!$this->configView) {
        $this->configView = $this->viewConfig->getViewConfig();
    }
    return $this->configView;
}

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Helper/Image.php#L116-L119


/**
 * @var \Magento\Framework\Config\View
 */
protected $configView;

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Helper/Image.php#L111-L114


/**
 * @var \Magento\Framework\View\ConfigInterface
 */
protected $viewConfig;

github.com

magento/magento2/blob/958164/lib/internal/Magento/Framework/Config/View.php#L120-L128


/**
 * Retrieve array of media attributes
 *
 * @param string $module
 * @param string $mediaType
 * @param string $mediaId
 * @return array
 */
public function getMediaAttributes($module, $mediaType, $mediaId)

github.com

magento/magento2/blob/958164/lib/internal/Magento/Framework/Config/View.php#L205-L215


/**
 * Initialize data array
 *
 * @return void
 */
protected function initData()
{
    if ($this->data === null) {
        $this->data = $this->read();
    }
}

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Helper/Image.php#L691-L701


/**
 * Set current Product
 *
 * @param \Magento\Catalog\Model\Product $product
 * @return $this
 */
protected function setProduct($product)
{
    $this->_product = $product;
    return $this;
}

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Helper/Image.php#L190-L197


/**
 * Set image properties
 *
 * @return $this
 */
protected function setImageProperties()
{
    $this->_getModel()->setDestinationSubdir($this->getType());

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Helper/Image.php#L559-L570


/**
 * Get current Image model
 *
 * @return \Magento\Catalog\Model\Product\Image
 */
protected function _getModel()
{
    if (!$this->_model) {
        $this->_model = $this->_productImageFactory->create();
    }
    return $this->_model;
}

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Helper/Image.php#L104-L109


/**
 * Product image factory
 *
 * @var \Magento\Catalog\Model\Product\ImageFactory
 */
protected $_productImageFactory;

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Helper/Image.php#L130-L130


* @param \Magento\Catalog\Model\Product\ImageFactory $productImageFactory

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Helper/Image.php#L136-L136


\Magento\Catalog\Model\Product\ImageFactory $productImageFactory,

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Helper/Image.php#L794-L802


/**
 * Retrieve image type
 *
 * @return string
 */
public function getType()
{
    return $this->getAttribute('type');
}

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Helper/Image.php#L838-L847


/**
 * Retrieve image attribute
 *
 * @param string $name
 * @return string
 */
protected function getAttribute($name)
{
    return isset($this->attributes[$name]) ? $this->attributes[$name] : null;
}

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Model/Product/Image.php#L721-L729


/**
 * @param string $dir
 * @return $this
 */
public function setDestinationSubdir($dir)
{
    $this->_destinationSubdir = $dir;
    return $this;
}

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Helper/Image.php#L804-L812


/**
 * Retrieve image width
 *
 * @return string
 */
public function getWidth()
{
    return $this->getAttribute('width');
}

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Model/Product/Image.php#L217-L225


/**
 * @param int $width
 * @return $this
 */
public function setWidth($width)
{
    $this->_width = $width;
    return $this;
}

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Helper/Image.php#L200-L203


$this->_getModel()->setHeight($this->getHeight());


// Set 'keep frame' flag
$frame = $this->getFrame();

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Helper/Image.php#L824-L836


/**
 * Retrieve image frame flag
 *
 * @return false|string
 */
public function getFrame()
{
    $frame = $this->getAttribute('frame');
    if (empty($frame)) {
        $frame = $this->getConfigView()->getVarValue('Magento_Catalog', 'product_image_white_borders');
    }
    return $frame;
}

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Helper/Image.php#L204-L206


if (!empty($frame)) {
    $this->_getModel()->setKeepFrame($frame);
}

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Model/Product/Image.php#L285-L293


/**
 * @param bool $keep
 * @return $this
 */
public function setKeepFrame($keep)
{
    $this->_keepFrame = (bool)$keep;
    return $this;
}

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Helper/Image.php#L208-L212


// Set 'constrain only' flag
$constrain = $this->getAttribute('constrain');
if (!empty($constrain)) {
    $this->_getModel()->setConstrainOnly($constrain);
}

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Helper/Image.php#L214-L218


// Set 'keep aspect ratio' flag
$aspectRatio = $this->getAttribute('aspect_ratio');
if (!empty($aspectRatio)) {
    $this->_getModel()->setKeepAspectRatio($aspectRatio);
}

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Helper/Image.php#L220-L224


// Set 'transparency' flag
$transparency = $this->getAttribute('transparency');
if (!empty($transparency)) {
    $this->_getModel()->setKeepTransparency($transparency);
}

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Helper/Image.php#L226-L230


// Set background color
$background = $this->getAttribute('background');
if (!empty($background)) {
    $this->_getModel()->setBackgroundColor($background);
}

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Helper/Image.php#L235-L247


/**
 * Set watermark properties
 *
 * @return $this
 */
protected function setWatermarkProperties()
{
    $this->setWatermark(
        $this->scopeConfig->getValue(
            "design/watermark/{$this->_getModel()->getDestinationSubdir()}_image",
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        )
    );