方法1-依存性注入(DI)の使用
以下は、依存関係注入を使用してMagento 2のすべてのカテゴリのリストを取得するコードの例です。
カテゴリ情報を取得するには、モジュールのブロッククラスのコンストラクターにクラス\Magento\Catalog\Model\ResourceModel\Category\CollectionFactory
と\Magento\Catalog\Helper\Category
クラスのオブジェクトを挿入し、ビュー(.phtml)ファイルからアクセスする必要がある場合があります。
app/code/YourCompanyName/YourModuleName/Block/YourCustomBlock.php
<?php
namespace YourCompanyName\YourModuleName\Block;
class YourCustomBlock extends \Magento\Framework\View\Element\Template
{
protected $_categoryCollectionFactory;
protected $_categoryHelper;
public function __construct(
\Magento\Framework\View\Element\Template\Context $context,
\Magento\Catalog\Model\ResourceModel\Category\CollectionFactory $categoryCollectionFactory,
\Magento\Catalog\Helper\Category $categoryHelper,
array $data = []
) {
$this->_categoryCollectionFactory = $categoryCollectionFactory;
$this->_categoryHelper = $categoryHelper;
parent::__construct($context, $data);
}
public function getCategoryCollection($isActive = true, $level = false, $sortBy = false, $pageSize = false) {
$collection = $this->_categoryCollectionFactory->create();
$collection->addAttributeToSelect('*');
// select only active categories
if ($isActive) {
$collection->addIsActiveFilter();
}
// select categories of certain level
if ($level) {
$collection->addLevelFilter($level);
}
// sort categories by some value
if ($sortBy) {
$collection->addOrderField($sortBy);
}
// set pagination
if ($pageSize) {
$collection->setPageSize($pageSize);
}
return $collection;
}
/**
* Retrieve current store level 2 category
*
* @param bool|string $sorted (if true display collection sorted as name otherwise sorted as based on id asc)
* @param bool $asCollection (if true display all category otherwise display second level category menu visible category for current store)
* @param bool $toLoad
*/
public function getStoreCategories($sorted = false, $asCollection = false, $toLoad = true) {
return $this->_categoryHelper->getStoreCategories($sorted = false, $asCollection = false, $toLoad = true);
}
}
これで、ビュー(.phtml)ファイルの関数を次のように使用できます。
// get the list of all categories
$categories = $block->getCategoryCollection();
foreach ($categories as $category) {
echo $category->getId() . '<br />';
echo $category->getName() . '<br />';
}
// get categories sorted by category name
$categories = $block->getCategoryCollection(true, false, 'name', false);
foreach ($categories as $category) {
echo $category->getId() . '<br />';
echo $category->getName() . '<br />';
}
// get current store’s categories
$categories = $block->getStoreCategories();
foreach ($categories as $category) {
echo $category->getId() . '<br />';
echo $category->getName() . '<br />';
}
方法2-
オブジェクトマネージャを使用する
オブジェクトマネージャーを使用してMagento 2のすべてのカテゴリのリストを取得するコードは次のとおりです。
$objectManager = \Magento\Framework\App\ObjectManager::getInstance();
// get the list of all categories
$categoryCollection = $objectManager->get('\Magento\Catalog\Model\ResourceModel\Category\CollectionFactory');
$categories = $categoryCollection->create();
$categories->addAttributeToSelect('*');
foreach ($categories as $category) {
echo $category->getId() . '<br />';
echo $category->getName() . '<br />';
echo $category->getUrl() . '<br />';
}
// get current store’s categories
$categoryHelper = $objectManager->get('\Magento\Catalog\Helper\Category');
$categories = $categoryHelper->getStoreCategories();
foreach ($categories as $category) {
echo $category->getId() . '<br />';
echo $category->getName() . '<br />';
}