How is \Magento\Catalog\Helper\Image::getUrl() implemented and used?

dmitry_fedyuk · April 22, 2016, 1:41pm

Implementation

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


/**
 * Retrieve image URL
 *
 * @return string
 */
public function getUrl()
{
    try {
        $this->applyScheduledActions();
        return $this->_getModel()->getUrl();
    } catch (\Exception $e) {
        return $this->getDefaultPlaceholderUrl();
    }
}

github.com

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


protected function applyScheduledActions()
{
    $this->initBaseFile();
    if ($this->isScheduledActionsAllowed()) {
        $model = $this->_getModel();
        if ($this->_scheduleRotate) {
            $model->rotate($this->getAngle());
        }
        if ($this->_scheduleResize) {
            $model->resize();
        }
        if ($this->getWatermark()) {
            $model->setWatermark($this->getWatermark());
        }
        $model->saveFile();
    }
    return $this;
}

github.com

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


/**
 * Initialize base image file
 *
 * @return $this
 */
protected function initBaseFile()
{
    $model = $this->_getModel();
    $baseFile = $model->getBaseFile();
    if (!$baseFile) {
        if ($this->getImageFile()) {
            $model->setBaseFile($this->getImageFile());
        } else {
            $model->setBaseFile($this->getProduct()->getData($model->getDestinationSubdir()));
        }
    }
    return $this;
}

Usage

1. \Magento\Catalog\Block\Product\View\Gallery::getGalleryImages()

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Block/Product/View/Gallery.php#L57-L77


/* @var \Magento\Framework\DataObject $image */
$image->setData(
    'small_image_url',
    $this->_imageHelper->init($product, 'product_page_image_small')
        ->setImageFile($image->getFile())
        ->getUrl()
);
$image->setData(
    'medium_image_url',
    $this->_imageHelper->init($product, 'product_page_image_medium')
        ->constrainOnly(true)->keepAspectRatio(true)->keepFrame(false)
        ->setImageFile($image->getFile())
        ->getUrl()
);
$image->setData(
    'large_image_url',
    $this->_imageHelper->init($product, 'product_page_image_large')
        ->constrainOnly(true)->keepAspectRatio(true)->keepFrame(false)
        ->setImageFile($image->getFile())
        ->getUrl()
);

github.com

magento/magento2/blob/958164/app/design/frontend/Magento/luma/etc/view.xml#L79-L87


<image id="product_page_image_large" type="image"/>
<image id="product_page_image_medium" type="image">
    <width>700</width>
    <height>560</height>
</image>
<image id="product_page_image_small" type="thumbnail">
    <width>88</width>
    <height>110</height>
</image>

2. \Magento\Swatches\Block\Product\Renderer\Configurable::getSwatchProductImage()

github.com

magento/magento2/blob/958164/app/code/Magento/Swatches/Block/Product/Renderer/Configurable.php#L318-L335


/**
 * @param Product $childProduct
 * @param string $imageType
 * @return string
 */
protected function getSwatchProductImage(Product $childProduct, $imageType)
{
    if ($this->isProductHasImage($childProduct, Swatch::SWATCH_IMAGE_NAME)) {
        $swatchImageId = $imageType;
        $imageAttributes = ['type' => Swatch::SWATCH_IMAGE_NAME];
    } elseif ($this->isProductHasImage($childProduct, 'image')) {
        $swatchImageId = $imageType == Swatch::SWATCH_IMAGE_NAME ? 'swatch_image_base' : 'swatch_thumb_base';
        $imageAttributes = ['type' => 'image'];
    }
    if (isset($swatchImageId)) {
        return $this->_imageHelper->init($childProduct, $swatchImageId, $imageAttributes)->getUrl();
    }
}

github.com

magento/magento2/blob/958164/app/code/Magento/Swatches/etc/view.xml#L19-L26


<image id="swatch_image_base" type="swatch_image">
    <width>30</width>
    <height>20</height>
</image>
<image id="swatch_thumb_base" type="swatch_thumb">
    <width>110</width>
    <height>90</height>
</image>

3. \Magento\Wishlist\Block\AbstractBlock::getImageUrl()

github.com

magento/magento2/blob/958164/app/code/Magento/Wishlist/Block/AbstractBlock.php#L283-L292


/**
 * Product image url getter
 *
 * @param \Magento\Catalog\Model\Product $product
 * @return string
 */
public function getImageUrl($product)
{
    return $this->_imageHelper->init($product, 'wishlist_small_image')->getUrl();
}

github.com

magento/magento2/blob/958164/app/design/frontend/Magento/luma/etc/view.xml#L176-L179


<image id="wishlist_small_image" type="small_image">
    <width>113</width>
    <height>113</height>
</image>

4. \Magento\Catalog\Block\Product\ImageBuilder::create()

/**
 * Create image block
 *
 * @return \Magento\Catalog\Block\Product\Image
 */
public function create()
{
	/** @var \Magento\Catalog\Helper\Image $helper */
	$helper = $this->helperFactory->create()
		->init($this->product, $this->imageId);

	$template = $helper->getFrame()
		? 'Magento_Catalog::product/image.phtml'
		: 'Magento_Catalog::product/image_with_borders.phtml';

	$imagesize = $helper->getResizedImageInfo();

	$data = [
		'data' => [
			'template' => $template,
			'image_url' => $helper->getUrl(),
			'width' => $helper->getWidth(),
			'height' => $helper->getHeight(),
			'label' => $helper->getLabel(),
			'ratio' =>  $this->getRatio($helper),
			'custom_attributes' => $this->getCustomAttributes(),
			'resized_image_width' => !empty($imagesize[0]) ? $imagesize[0] : $helper->getWidth(),
			'resized_image_height' => !empty($imagesize[1]) ? $imagesize[1] : $helper->getHeight(),
		],
	];

	return $this->imageFactory->create($data);
}

5. \Magento\Catalog\Block\Rss\Category::getRssData()

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Block/Rss/Category.php#L138-L144


$description = sprintf(
    $description,
    $product->getProductUrl(),
    $this->imageHelper->init($product, 'rss_thumbnail')->getUrl(),
    $product->getDescription(),
    $product->getAllowedPriceInRss() ? $this->renderPriceHtml($product) : ''
);

github.com

magento/magento2/blob/958164/app/design/frontend/Magento/luma/etc/view.xml#L152-L155


<image id="rss_thumbnail" type="thumbnail">
    <width>75</width>
    <height>75</height>
</image>

6. Magento\Catalog\Block\Rss\Product\NewProducts::getRssData()

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Block/Rss/Product/NewProducts.php#L116-L122


$description = sprintf(
    $description,
    $item->getProductUrl(),
    $this->imageHelper->init($item, 'rss_thumbnail')->getUrl(),
    $item->getDescription(),
    $allowedPriceInRss ? $this->renderPriceHtml($item) : ''
);

7. \Magento\Catalog\Block\Rss\Product\Special::getEntryData()

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Block/Rss/Product/Special.php#L191-L197


$description = sprintf(
    $description,
    $item->getProductUrl(),
    $this->imageHelper->init($item, 'rss_thumbnail')->getUrl(),
    $this->outputHelper->productAttribute($item, $item->getDescription(), 'description'),
    $specialPrice
);

8. Magento\Catalog\Ui\Component\Listing\Columns\Thumbnail::prepareDataSource()

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Ui/Component/Listing/Columns/Thumbnail.php#L44-L63


public function prepareDataSource(array $dataSource)
{
    if (isset($dataSource['data']['items'])) {
        $fieldName = $this->getData('name');
        foreach ($dataSource['data']['items'] as & $item) {
            $product = new \Magento\Framework\DataObject($item);
            $imageHelper = $this->imageHelper->init($product, 'product_listing_thumbnail');
            $item[$fieldName . '_src'] = $imageHelper->getUrl();
            $item[$fieldName . '_alt'] = $this->getAlt($item) ?: $imageHelper->getLabel();
            $item[$fieldName . '_link'] = $this->urlBuilder->getUrl(
                'catalog/product/edit',
                ['id' => $product->getEntityId(), 'store' => $this->context->getRequestParam('store')]
            );
            $origImageHelper = $this->imageHelper->init($product, 'product_listing_thumbnail_preview');
            $item[$fieldName . '_orig_src'] = $origImageHelper->getUrl();
        }
    }


    return $dataSource;
}

9. \Magento\Catalog\Ui\DataProvider\Product\Form\Modifier\Related::fillData()

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/Related.php#L207-L221


protected function fillData(ProductInterface $linkedProduct, ProductLinkInterface $linkItem)
{
    return [
        'id' => $linkedProduct->getId(),
        'thumbnail' => $this->imageHelper->init($linkedProduct, 'product_listing_thumbnail')->getUrl(),
        'name' => $linkedProduct->getName(),
        'status' => $this->status->getOptionText($linkedProduct->getStatus()),
        'attribute_set' => $this->attributeSetRepository
            ->get($linkedProduct->getAttributeSetId())
            ->getAttributeSetName(),
        'sku' => $linkItem->getLinkedProductSku(),
        'price' => $linkedProduct->getPrice(),
        'position' => $linkItem->getPosition(),
    ];
}

github.com

magento/magento2/blob/958164/app/design/adminhtml/Magento/backend/etc/view.xml#L14-L17


<image id="product_listing_thumbnail" type="thumbnail">
    <width>75</width>
    <height>75</height>
</image>

10. \Magento\Checkout\CustomerData\DefaultItem::doGetItemData()

github.com

magento/magento2/blob/958164/app/code/Magento/Checkout/CustomerData/DefaultItem.php#L66-L85


$imageHelper = $this->imageHelper->init($this->getProductForThumbnail(), 'mini_cart_product_thumbnail');
return [
    'options' => $this->getOptionList(),
    'qty' => $this->item->getQty() * 1,
    'item_id' => $this->item->getId(),
    'configure_url' => $this->getConfigureUrl(),
    'is_visible_in_site_visibility' => $this->item->getProduct()->isVisibleInSiteVisibility(),
    'product_name' => $this->item->getProduct()->getName(),
    'product_url' => $this->getProductUrl(),
    'product_has_url' => $this->hasProductUrl(),
    'product_price' => $this->checkoutHelper->formatPrice($this->item->getCalculationPrice()),
    'product_image' => [
        'src' => $imageHelper->getUrl(),
        'alt' => $imageHelper->getLabel(),
        'width' => $imageHelper->getWidth(),
        'height' => $imageHelper->getHeight(),
    ],
    'canApplyMsrp' => $this->msrpHelper->isShowBeforeOrderConfirm($this->item->getProduct())
        && $this->msrpHelper->isMinimalPriceLessMsrp($this->item->getProduct()),
];

github.com

magento/magento2/blob/958164/app/design/frontend/Magento/luma/etc/view.xml#L55-L58


<image id="mini_cart_product_thumbnail" type="thumbnail">
    <width>75</width>
    <height>75</height>
</image>

11. \Magento\Checkout\Model\DefaultConfigProvider::getQuoteItemData()

github.com

magento/magento2/blob/958164/app/code/Magento/Checkout/Model/DefaultConfigProvider.php#L380-L396


private function getQuoteItemData()
{
    $quoteItemData = [];
    $quoteId = $this->checkoutSession->getQuote()->getId();
    if ($quoteId) {
        $quoteItems = $this->quoteItemRepository->getList($quoteId);
        foreach ($quoteItems as $index => $quoteItem) {
            $quoteItemData[$index] = $quoteItem->toArray();
            $quoteItemData[$index]['options'] = $this->getFormattedOptionValue($quoteItem);
            $quoteItemData[$index]['thumbnail'] = $this->imageHelper->init(
                $quoteItem->getProduct(),
                'product_thumbnail_image'
            )->getUrl();
        }
    }
    return $quoteItemData;
}

12. Magento\ConfigurableProduct\Block\Adminhtml\Product\Edit\Tab\Variations\Config\Matrix::prepareVariations()

github.com

magento/magento2/blob/958164/app/code/Magento/ConfigurableProduct/Block/Adminhtml/Product/Edit/Tab/Variations/Config/Matrix.php#L367-L379


$productMatrix[] = [
    'productId' => $product->getId(),
    'images' => [
        'preview' => $this->image->init($product, 'product_thumbnail_image')->getUrl()
    ],
    'sku' => $product->getSku(),
    'name' => $product->getName(),
    'quantity' => $this->getProductStockQty($product),
    'price' => $price,
    'options' => $variationOptions,
    'weight' => $product->getWeight(),
    'status' => $product->getStatus()
];

13. \Magento\ConfigurableProduct\Helper\Data::getGalleryImages()

github.com

magento/magento2/blob/958164/app/code/Magento/ConfigurableProduct/Helper/Data.php#L44-L64


/** @var $image \Magento\Catalog\Model\Product\Image */
$image->setData(
    'small_image_url',
    $this->imageHelper->init($product, 'product_page_image_small')
        ->setImageFile($image->getFile())
        ->getUrl()
);
$image->setData(
    'medium_image_url',
    $this->imageHelper->init($product, 'product_page_image_medium')
        ->constrainOnly(true)->keepAspectRatio(true)->keepFrame(false)
        ->setImageFile($image->getFile())
        ->getUrl()
);
$image->setData(
    'large_image_url',
    $this->imageHelper->init($product, 'product_page_image_large')
        ->constrainOnly(true)->keepAspectRatio(true)->keepFrame(false)
        ->setImageFile($image->getFile())
        ->getUrl()
);

14. \Magento\ConfigurableProduct\Ui\DataProvider\Product\Form\Modifier\Data\AssociatedProducts::prepareVariations()

github.com

magento/magento2/blob/958164/app/code/Magento/ConfigurableProduct/Ui/DataProvider/Product/Form/Modifier/Data/AssociatedProducts.php#L277-L297


$productMatrix[] = [
    'id' => $product->getId(),
    'product_link' => '<a href="' . $this->urlBuilder->getUrl(
        'catalog/product/edit',
        ['id' => $product->getId()]
    ) . '" target="_blank">' . $product->getName() . '</a>',
    'sku' => $product->getSku(),
    'name' => $product->getName(),
    'qty' => $this->getProductStockQty($product),
    'price' => $currency->toCurrency(sprintf("%f", $price), ['display' => false]),
    'price_string' => $currency->toCurrency(sprintf("%f", $price)),
    'price_currency' => $this->locator->getStore()->getBaseCurrency()->getCurrencySymbol(),
    'configurable_attribute' => $this->getJsonConfigurableAttributes($variationOptions),
    'weight' => $product->getWeight(),
    'status' => $product->getStatus(),
    'variationKey' => $this->getVariationKey($variationOptions),
    'canEdit' => 0,
    'newProduct' => 0,
    'attributes' => $this->getTextAttributes($variationOptions),
    'thumbnail_image' => $this->imageHelper->init($product, 'product_thumbnail_image')->getUrl(),
];

github.com

magento/magento2/blob/958164/app/design/frontend/Magento/luma/etc/view.xml#L108-L111


<image id="product_thumbnail_image" type="thumbnail">
    <width>75</width>
    <height>75</height>
</image>

15. \Magento\GroupedProduct\Ui\DataProvider\Product\Form\Modifier\Grouped::fillData()

github.com

magento/magento2/blob/958164/app/code/Magento/GroupedProduct/Ui/DataProvider/Product/Form/Modifier/Grouped.php#L166-L185


protected function fillData(ProductInterface $linkedProduct, ProductLinkInterface $linkItem)
{
    /** @var \Magento\Framework\Currency $currency */
    $currency = $this->localeCurrency->getCurrency($this->locator->getBaseCurrencyCode());


    return [
        'id' => $linkedProduct->getId(),
        'name' => $linkedProduct->getName(),
        'sku' => $linkItem->getLinkedProductSku(),
        'price' => $currency->toCurrency(sprintf("%f", $linkedProduct->getPrice())),
        'qty' => $linkItem->getExtensionAttributes()->getQty(),
        'position' => $linkItem->getPosition(),
        'thumbnail' => $this->imageHelper->init($linkedProduct, 'product_listing_thumbnail')->getUrl(),
        'type_id' => $linkedProduct->getTypeId(),
        'status' => $this->status->getOptionText($linkedProduct->getStatus()),
        'attribute_set' => $this->attributeSetRepository
            ->get($linkedProduct->getAttributeSetId())
            ->getAttributeSetName(),
    ];
}

16. \Magento\SendFriend\Model\SendFriend::send()

github.com

magento/magento2/blob/958164/app/code/Magento/SendFriend/Model/SendFriend.php#L194-L205


)->setTemplateVars(
    [
        'name' => $name,
        'email' => $email,
        'product_name' => $this->getProduct()->getName(),
        'product_url' => $this->getProduct()->getUrlInStore(),
        'message' => $message,
        'sender_name' => $sender['name'],
        'sender_email' => $sender['email'],
        'product_image' => $this->_catalogImage->init($this->getProduct(), 'sendfriend_small_image')
            ->getUrl(),
    ]

17. \Magento\Swatches\Helper\Data::getAllSizeImages()

github.com

magento/magento2/blob/958164/app/code/Magento/Swatches/Helper/Data.php#L310-L330


/**
 * @param ModelProduct $product
 * @param string $imageFile
 * @return array
 */
private function getAllSizeImages(ModelProduct $product, $imageFile)
{
    return [
        'large' => $this->imageHelper->init($product, 'product_page_image_large')
            ->constrainOnly(true)->keepAspectRatio(true)->keepFrame(false)
            ->setImageFile($imageFile)
            ->getUrl(),
        'medium' => $this->imageHelper->init($product, 'product_page_image_medium')
            ->constrainOnly(true)->keepAspectRatio(true)->keepFrame(false)
            ->setImageFile($imageFile)
            ->getUrl(),
        'small' => $this->imageHelper->init($product, 'product_page_image_small')
            ->setImageFile($imageFile)
            ->getUrl(),
    ];
}

github.com

magento/magento2/blob/958164/app/design/frontend/Magento/luma/etc/view.xml#L79-L87


<image id="product_page_image_large" type="image"/>
<image id="product_page_image_medium" type="image">
    <width>700</width>
    <height>560</height>
</image>
<image id="product_page_image_small" type="thumbnail">
    <width>88</width>
    <height>110</height>
</image>

18. \Magento\Wishlist\CustomerData\Wishlist::getImageData()

/**
 * Retrieve product image data
 *
 * @param \Magento\Catalog\Model\Product $product
 * @return \Magento\Catalog\Block\Product\Image
 * @SuppressWarnings(PHPMD.NPathComplexity)
 */
protected function getImageData($product)
{
	/** @var \Magento\Catalog\Helper\Image $helper */
	$helper = $this->imageHelperFactory->create()
		->init($product, 'wishlist_sidebar_block');

	$template = $helper->getFrame()
		? 'Magento_Catalog/product/image'
		: 'Magento_Catalog/product/image_with_borders';

	$imagesize = $helper->getResizedImageInfo();

	$width = $helper->getFrame()
		? $helper->getWidth()
		: (!empty($imagesize[0]) ? $imagesize[0] : $helper->getWidth());

	$height = $helper->getFrame()
		? $helper->getHeight()
		: (!empty($imagesize[1]) ? $imagesize[1] : $helper->getHeight());

	return [
		'template' => $template,
		'src' => $helper->getUrl(),
		'width' => $width,
		'height' => $height,
		'alt' => $helper->getLabel(),
	];
}

19. \Magento\Wishlist\Model\Rss\Wishlist::getRssData()

github.com

magento/magento2/blob/958164/app/code/Magento/Wishlist/Model/Rss/Wishlist.php#L150-L158


$description = '<table><tr><td><a href="' . $productUrl . '"><img src="'
    . $this->imageHelper->init($product, 'rss_thumbnail')->getUrl()
    . '" border="0" align="left" height="75" width="75"></a></td>'
    . '<td style="text-decoration:none;">'
    . $this->outputHelper->productAttribute(
        $product,
        $product->getShortDescription(),
        'short_description'
    ) . '<p>';

20. Magento/Catalog/view/frontend/templates/product/gallery.phtml

github.com

magento/magento2/blob/958164/app/code/Magento/Catalog/view/frontend/templates/product/gallery.phtml#L28-L31


$imageUrl = $this->helper('Magento\Catalog\Helper\Image')
    ->init($block->getProduct(), 'product_page_image_large')
    ->setImageFile($block->getImageFile())
    ->getUrl();

dmitry_fedyuk · April 22, 2016, 1:46pm