Placeholder Class Reference

Inheritance diagram for Placeholder:

Public Member Functions
	__construct (ContextInterface $context, ScopeConfigInterface $scopeConfig, Repository $assetRepo, $type)
	getUrl ()
	getContentType ()
	getPath ()
	getSourceFile ()
	getSourceContentType ()
	getContent ()
	getFilePath ()
	getContext ()
	getModule ()

Detailed Description

A locally available image placeholder file asset that can be referred with a file type

Definition at line 18 of file Placeholder.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ContextInterface	$context,
		ScopeConfigInterface	$scopeConfig,
		Repository	$assetRepo,
			$type
	)

Placeholder constructor.

Parameters

ContextInterface	$context
ScopeConfigInterface	$scopeConfig
Repository	$assetRepo
string	$type

Definition at line 64 of file Placeholder.php.

      {
        $this->context = $context;
        $this->scopeConfig = $scopeConfig;
        $this->assetRepo = $assetRepo;
        $this->type = $type;
    }

Member Function Documentation

getContent()

getContent

(

)

{Get content of a local asset

Returns

string

}

Implements LocalInterface.

Definition at line 142 of file Placeholder.php.

    {
        return null;
    }

getContentType()

getContentType

(

)

{Retrieve type of contents

Returns

string

}

Implements AssetInterface.

Definition at line 93 of file Placeholder.php.

    {
        return $this->contentType;
    }

getContext()

getContext

(

)

{Get context of the asset that contains data necessary to build an absolute path or URL to the file

Returns

ContextInterface

}

Returns

ContextInterface

Implements LocalInterface.

Definition at line 169 of file Placeholder.php.

    {
        return $this->context;
    }

getFilePath()

getFilePath

(

)

{Get an invariant relative path to file

Returns

string

}

Implements LocalInterface.

Definition at line 150 of file Placeholder.php.

    {
        if ($this->filePath !== null) {
            return $this->filePath;
        }
        // check if placeholder defined in config
        $isConfigPlaceholder = $this->scopeConfig->getValue(
            "catalog/placeholder/{$this->type}_placeholder",
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        );
        $this->filePath = $isConfigPlaceholder;

        return $this->filePath;
    }

getModule()

getModule

(

)

{Get the module context of file path

Returns

string

}

Implements LocalInterface.

Definition at line 177 of file Placeholder.php.

    {
        return 'placeholder';
    }

getPath()

getPath

(

)

{Get a relative "context" path to the asset fileThis path includes both invariant and context part that can serve as an identifier of the file in current context

Returns

string

}

Implements LocalInterface.

Definition at line 101 of file Placeholder.php.

    {
        if ($this->getFilePath() !== null) {
            $result = $this->getContext()->getPath()
                . DIRECTORY_SEPARATOR . $this->getModule()
                . DIRECTORY_SEPARATOR . $this->getFilePath();
        } else {
            $defaultPlaceholder = $this->assetRepo->createAsset(
                "Magento_Catalog::images/product/placeholder/{$this->type}.jpg"
            );
            try {
                $result = $defaultPlaceholder->getSourceFile();
            } catch (NotFoundException $e) {
                $result = null;
            }
        }

        return $result;
    }

getSourceContentType()

getSourceContentType

(

)

Get source content type

Returns

string

Implements AssetInterface.

Definition at line 134 of file Placeholder.php.

    {
        return $this->contentType;
    }

getSourceFile()

getSourceFile

(

)

{Get original source file where the asset contents can be read fromReturns absolute path to file in local file system

Returns

string

}

Implements LocalInterface.

Definition at line 124 of file Placeholder.php.

    {
        return $this->getPath();
    }

getUrl()

getUrl

(

)

{Retrieve URL pointing to a resource

Returns

string

}

Implements AssetInterface.

Definition at line 79 of file Placeholder.php.

    {
        if ($this->getFilePath() !== null) {
            $result = $this->context->getBaseUrl() . '/' . $this->getModule() . '/' . $this->getFilePath();
        } else {
            $result = $this->assetRepo->getUrl("Magento_Catalog::images/product/placeholder/{$this->type}.jpg");
        }

        return $result;
    }

---

The documentation for this class was generated from the following file:

• vendor/magento/module-catalog/Model/View/Asset/Placeholder.php