Magento2 常用功能代码记录

不二不三发表回复 阅读(30699)

获取objectManager

$objectManager = \Magento\Framework\App\ObjectManager::getInstance();

DataObject是所有Model的基类

$row = new \Magento\Framework\DataObject();
$row->setData($key, $value);
$row->getData($key);
$row->hasData($key);
$row->unsetData();
$row->toXml();
$row->toJson();
$row->debug();

date

/* @var $localeDate \Magento\Framework\Stdlib\DateTime\TimezoneInterface */
$localeDate = $objectManager->create(\Magento\Framework\Stdlib\DateTime\TimezoneInterface::class);
$localeDate->date()->format('Y-m-d H:i:s');

Session

$session = $objectManager->get('Magento\Framework\Session\Storage');
$session->setXxxx($value);
$session->getXxxx();
$session->hasXxxx();
$session->unsXxxx();

cache

// save
$this->cache = $context->getCache();
$this->cache->save(\Zend_Json::encode($data), self::CACHE_PREFIX . $key, [], $lifeTime);

// load
$jsonStr = $this->cache->load(self::CACHE_PREFIX . $cacheKey);
if (strlen($jsonStr)) {
    $this->cachedData = \Zend_Json::decode($jsonStr);
}

// sample
$cache = $objectManager->get(\Magento\Framework\App\CacheInterface::class);
$cached = $cache->load($cacheKey);
if(strlen($cached)) {
    $data = unserialize($cached);
} else {
    $data = [];
    $product = $objectManager->create('Magento\Catalog\Model\ProductRepository')->getById($id);
    $row = new \Magento\Framework\DataObject();
    $row->setData($row->getData());
    $data []= $row;
    $cache->save(serialize($data), $cacheKey);
}

判断是否首页

// in action
if($this->_request->getRouteName() == 'cms' && $this->_request->getActionName() == 'index') {
    // is home
}

Registry 用于内部传递临时值

/* @var \Magento\Framework\Registry $coreRegistry */
$coreRegistry = $this->_objectManager->get('Magento\Framework\Registry');
// 存储值
$coreRegistry->register('current_category', $category);
// 提取值
$coreRegistry->registry('current_category');

获取当前店铺对象

$store = $objectManager->get( 'Magento\Store\Model\StoreManagerInterface' )->getStore();

提示信息

// \Magento\Framework\App\Action\Action::execute()
$this->messageManager->addSuccessMessage(__('You deleted the event.'));
$this->messageManager->addErrorMessage(__('You deleted the event.'));
return $this->_redirect ( $returnUrl );

log (support_report.log)

\Magento\Framework\App\ObjectManager::getInstance()
    ->get( '\Psr\Log\LoggerInterface' )->addCritical( 'notice message', [
        'order_id' => $order_id,
        'item_id' => $item_id
        // ...
    ]);

获取当前页面 URL

$currentUrl = $objectManager->get( 'Magento\Framework\UrlInterface' )->getCurrentUrl();

获取指定路由 URL

$url = $objectManager->get( 'Magento\Store\Model\StoreManagerInterface' )->getStore()->getUrl( 'xxx/xxx/xxx' );

block里的URL

// 首页地址
$block->getBaseUrl();
// 指定 route 地址
$block->getUrl( '[module]/[controller]/[action]' );
// 指定的静态文件地址
$block->getViewFileUrl( 'Magento_Checkout::cvv.png' );
$block->getViewFileUrl( 'images/loader-2.gif' );

获取所有website的地址

$storeManager = $objectManager->get('Magento\Store\Model\StoreManagerInterface');
foreach($storeManager->getWebsites() as $website) {
    $store_id = $storeManager->getGroup($website->getDefaultGroupId())->getDefaultStoreId();
    $storeManager->getStore($store_id)->getBaseUrl();
}

获取module下的文件

/** @var \Magento\Framework\Module\Dir\Reader $reader */
$reader = $objectManager->get('Magento\Framework\Module\Dir\Reader');
$reader->getModuleDir('etc', 'Infinity_Project').'/di.xml';

获取资源路径

/* @var \Magento\Framework\View\Asset\Repository $asset */
$asset = $this->_objectManager->get( '\Magento\Framework\View\Asset\Repository' );
$asset->createAsset('Vendor_Module::js/script.js')->getPath();

文件操作

/* @var \Magento\Framework\Filesystem $fileSystem */
$fileSystem = $this->_objectManager->get('Magento\Framework\Filesystem');
$fileSystem->getDirectoryWrite('tmp')->copyFile($from, $to);
$fileSystem->getDirectoryWrite('tmp')->delete($file);
$fileSystem->getDirectoryWrite('tmp')->create($file);

文件上传

// 上传到media
$request = $this->getRequest ();
if($request->isPost()) {
    try{
        /* @var $uploader \Magento\MediaStorage\Model\File\Uploader */
        $uploader = $this->_objectManager->create(
            'Magento\MediaStorage\Model\File\Uploader',
            ['fileId' => 'personal_photos']
        );
        /* @var $filesystem \Magento\Framework\Filesystem */
        $filesystem = $this->_objectManager->get( 'Magento\Framework\Filesystem' );
        $dir = $filesystem->getDirectoryRead( \Magento\Framework\App\Filesystem\DirectoryList::UPLOAD )->getAbsolutePath();
        $fileName = time().'.'.$uploader->getFileExtension();
        $uploader->save($dir, $fileName);
        $fileUrl = 'pub/media/upload/'.$fileName;
    } catch(Exception $e) {
        // 未上传
    }
}
// 上传到tmp
/* @var \Magento\Framework\App\Filesystem\DirectoryList $directory */
$directory = $this->_objectManager->get('Magento\Framework\App\Filesystem\DirectoryList');
/* @var \Magento\Framework\File\Uploader $uploader */
$uploader = $this->_objectManager->create('Magento\Framework\File\Uploader', array('fileId' => 'file1'));
$uploader->setAllowedExtensions(array('csv'));
$uploader->setAllowRenameFiles(true);
$uploader->setFilesDispersion(true);
$result = $uploader->save($directory->getPath($directory::TMP));
$directory->getPath($directory::TMP).$result['file'];

产品缩略图

$imageHelper = $objectManager->get( 'Magento\Catalog\Helper\Image' );
$productImage = $imageHelper->init( $product, 'category_page_list' )
  ->constrainOnly( FALSE )
  ->keepAspectRatio( TRUE )
  ->keepFrame( FALSE )
  ->resize( 400 )
  ->getUrl();

缩略图

$imageFactory = $objectManager->get( 'Magento\Framework\Image\Factory' );
$imageAdapter = $imageFactory->create($path);
$imageAdapter->resize($width, $height);
$imageAdapter->save($savePath);

产品属性

/* @var \Magento\Catalog\Model\ProductRepository $product */
$product = $objectManager->create('Magento\Catalog\Model\ProductRepository')->getById($id);
// print price
/* @var \Magento\Framework\Pricing\PriceCurrencyInterface $priceCurrency */
$priceCurrency = $objectManager->get('Magento\Framework\Pricing\PriceCurrencyInterface');
$priceCurrency->format($product->getData('price'));
// print option value
$product->getResource()->getAttribute('color')->getDefaultFrontendLabel();
$product->getAttributeText('color');
// all options
$this->helper('Magento\Catalog\Helper\Output')->productAttribute($product, $product->getData('color'), 'color');
$product->getResource()->getAttribute('color')->getSource()->getAllOptions();
// save attribute
$product->setWeight(1.99)->getResource()->saveAttribute($product, 'weight');
// 库存
$stockItem = $this->stockRegistry->getStockItem($productId, $product->getStore()->getWebsiteId());
$minimumQty = $stockItem->getMinSaleQty();
// Configurable Product 获取父级产品ID
$parentIds = $this->objectManager->get('Magento\ConfigurableProduct\Model\Product\Type\Configurable')
    ->getParentIdsByChild($productId);
$parentId = array_shift($parentIds);
// Configurable Product 获取子级产品ID
$childIds = $this->objectManager->get('Magento\ConfigurableProduct\Model\Product\Type\Configurable')
    ->getChildrenIds($parentId);
// 获取Configurable Product的子产品Collection
$collection = $this->objectManager->get('Magento\ConfigurableProduct\Model\Product\Type\Configurable')
    ->getUsedProducts($product);
// 判断是否Configurable Product
if ($_product->getTypeId() == \Magento\ConfigurableProduct\Model\Product\Type\Configurable::TYPE_CODE);

购物车中的所有产品

/* @var \Magento\Checkout\Model\Session $checkoutSession */
$checkoutSession = $objectManager->get('Magento\Checkout\Model\Session');
foreach($checkoutSession->getQuote()->getItems() as $item) {
    /* @var \Magento\Quote\Model\Quote\Item $item */
    echo $item->getProduct()->getName().'<br/>';
}

获取类型配置

$eavConfig->getAttribute('catalog_product', 'price');
$eavConfig->getEntityType('catalog_product');

获取 EAV 属性所有可选项

/* @var $objectManager \Magento\Framework\App\ObjectManager */
$eavConfig = $objectManager->get( '\Magento\Eav\Model\Config' );
$options = $eavConfig->getAttribute( '[entity_type]', '[attribute_code]' )
    ->getFrontend()->getSelectOptions();
//或者
/* @var $objectManager \Magento\Framework\App\ObjectManager */
$options = $objectManager->create( 'Magento\Eav\Model\Attribute' )
    ->load( '[attribute_code]', 'attribute_code' )->getSource()
    ->getAllOptions( false );

获取config.xml与system.xml里的参数

$this->_scopeConfig = $this->_objectManager->create('Magento\Framework\App\Config\ScopeConfigInterface');
// 语言代码
$this->_scopeConfig->getValue('general/locale/code', \Magento\Store\Model\ScopeInterface::SCOPE_STORE, $storeId);

客户唯一属性验证

if($customer instanceof \Magento\Customer\Model\Customer) {
    /* @var \Magento\Customer\Model\Attribute $attribute */
    foreach($customer->getAttributes() as $attribute) {
        if($attribute->getIsUnique()) {
            if (!$attribute->getEntity()->checkAttributeUniqueValue($attribute, $customer)) {
                $label = $attribute->getFrontend()->getLabel();
                throw new \Magento\Framework\Exception\LocalizedException(
                    __('The value of attribute "%1" must be unique.', $label)
                );
            }
        }
    }
}

读取design view.xml

<vars module="Vendor_Module">
    <var name="var1">value1</var>
</vars>
/* @var \Magento\Framework\Config\View $viewConfig */
$viewConfig = $objectManager->get('Magento\Framework\Config\View');
$viewConfig->getVarValue('Vendor_Module', 'var1');

获取邮件模板

虽然叫邮件模板，但也可以用于需要后台编辑模板的程序 

// template id, 通常在email_templates.xml定义。如果是在后台加的email template，需要换成template的记录ID，例如90
$identifier = 'contact_email_email_template';
/* @var \Magento\Framework\Mail\TemplateInterface $templateFactory */
$templateFactory = $this->_objectManager->create(
    'Magento\Framework\Mail\TemplateInterface',
    ['data' => ['template_id' => $identifier]]
);
// 模板变量，取决于phtml或后台email template的内容
$dataObject = new \Magento\Framework\DataObject();
$dataObject->setData('name', 'william');
// 决定模板变量取值区域，例如像{{layout}}这样的标签，如果取不到值可以试试把area设为frontend
$templateFactory->setOptions([
    'area' => \Magento\Backend\App\Area\FrontNameResolver::AREA_CODE,
    'store' => \Magento\Store\Model\Store::DEFAULT_STORE_ID
]);
$templateFactory->setVars(['data' => $dataObject]);
return $templateFactory->processTemplate();

内容返回

$this->resultFactory = $this->_objectManager->create('Magento\Framework\Controller\Result\RawFactory');
/* @var \Magento\Framework\Controller\Result\Raw $result */
$result = $this->resultFactory->create();
$result->setContents('hello world');
return $result;
$this->resultFactory = $this->_objectManager->create('Magento\Framework\Controller\Result\JsonFactory');
/* @var \Magento\Framework\Controller\Result\Json $result */
$result = $this->resultFactory->create();
$result->setData(['message' => 'hellog world']);
return $result;

HTTP文件

$this->_fileFactory = $this->_objectManager->create('Magento\Framework\App\Response\Http\FileFactory');
$this->_fileFactory->create(
    'invoice' . $date . '.pdf',
    $pdf->render(),
    DirectoryList::VAR_DIR,
    'application/pdf'
);

切换货币与语言

$currencyCode = 'GBP';
/* @var \Magento\Store\Model\Store $store */
$store = $this->_objectManager->get('Magento\Store\Model\Store');
$store->setCurrentCurrencyCode($currencyCode);

$storeCode = 'uk';
/* @var \Magento\Store\Api\StoreRepositoryInterface $storeRepository */
$storeRepository = $this->_objectManager->get('Magento\Store\Api\StoreRepositoryInterface');
/* @var \Magento\Store\Model\StoreManagerInterface $storeManager */
$storeManager = $this->_objectManager->get('Magento\Store\Model\StoreManagerInterface');
/* @var \Magento\Store\Api\StoreCookieManagerInterface $storeCookieManager */
$storeCookieManager = $this->_objectManager->get('Magento\Store\Api\StoreCookieManagerInterface');
/* @var \Magento\Framework\App\Http\Context $httpContext */
$httpContext = $this->_objectManager->get('Magento\Framework\App\Http\Context');
$defaultStoreView = $storeManager->getDefaultStoreView();
$store = $storeRepository->getActiveStoreByCode($storeCode);
$httpContext->setValue(\Magento\Store\Model\Store::ENTITY, $store->getCode(), $defaultStoreView->getCode());
$storeCookieManager->setStoreCookie($store);

$this->getResponse()->setRedirect($this->_redirect->getRedirectUrl());

Profiler

\Magento\Framework\Profiler::start(
    'CONFIGURABLE:' . __METHOD__,
    ['group' => 'CONFIGURABLE', 'method' => __METHOD__]
);
\Magento\Framework\Profiler::stop('CONFIGURABLE:' . __METHOD__);

HTML表单元素

日历控件

$block->getLayout()->createBlock('Magento\Framework\View\Element\Html\Date')
    ->setName('date')
    ->setId('date')
    ->setClass('date')
    ->setDateFormat('M/d/yy')
    ->setImage($block->getViewFileUrl('Magento_Theme::calendar.png'))
    ->setExtraParams('data-validate="{required:true}"')
    ->toHtml();

select控件

$block->getLayout()->createBlock('Magento\Framework\View\Element\Html\Select')
    ->setName('sel1')
    ->setId('sel1')
    ->setClass('select')
    ->addOption('value', 'label')
    ->setValue($default)
    ->setExtraParams('data-validate="{required:true}"')
    ->toHtml();

Object

/**
 * @param $className
 * @return mixed
 */
public function getObject($className)
{
    return \Magento\Framework\App\ObjectManager::getInstance()->get($className);
}

/**
 * @param $className
 * @return mixed
 */
public function createObject($className)
{
    return \Magento\Framework\App\ObjectManager::getInstance()->create($className);
}

Url

/**
 * Generate url by route and parameters
 *
 * @param   string $route
 * @param   array $params
 * @return  string
 */
public function getUrl($route = '', $params = [])
{
    return $this->urlManager->getUrl($route, $params);
}

/**
 * @return string
 */
public function getRefer()
{
    return $this->urlEncoder->encode($this->urlManager->getCurrentUrl());
}

/**
 * @return string
 */
public function decodeUrl($refer)
{
    return $this->urlDecoder->decode($refer);
}
注：
urlManager —> \Magento\Framework\UrlInterface
urlEncoder -> \Magento\Framework\Url\EncoderInterface
urlDecoder -> \Magento\Framework\Url\DecoderInterface

Product object

$product = \Magento\Framework\App\ObjectManager::getInstance()->create('Magento\Catalog\Model\Product')->load($productId); // by id
$product = \Magento\Framework\App\ObjectManager::getInstance()->create('Magento\Catalog\Api\ProductRepositoryInterface')->get($sku); // by sku

Product custom attribute and attribute label

// attribute
$product = \Magento\Framework\App\ObjectManager::getInstance()->create('Magento\Catalog\Model\Product')->load($productId);
$attribute = $product->getData($attributeName);

// attribute label
$attributeLabel = $product->getAttributeText($attributeName);
// or
$attributeLabel = $product->getResource()->getAttribute($attributeName)->getFrontend()->getValue($product);

Categories

$objectManger = \Magento\Framework\App\ObjectManager::getInstance();
$categoryHelper = $objectManger->create('Magento\Catalog\Helper\Category');
$categories = $categoryHelper->getStoreCategories($sorted = false, $asCollection = false, $toLoad = true);
$menus = array();
foreach ($categories as $category){
    $sub = array();
    $sub['name'] = $category->getName();
    $sub['link'] = $categoryHelper->getCategoryUrl($category);
    $menus[] = $sub;
}

Category custom attribute

$objectManger = \Magento\Framework\App\ObjectManager::getInstance();
$categoryModel = $objectManger->get('Magento\Catalog\Model\Category')->load($categoryId);
$attribute = $categoryModel->getData('attribute_name');

Logo and Copyright

// Logo
$objectManger = \Magento\Framework\App\ObjectManager::getInstance();
$logoObject = $objectManger->create('Magento\Theme\Block\Html\Header\Logo');
$logo = $logoObject->getLogoSrc();

// Copyright
$footer = $objectManger->create('Magento\Theme\Block\Html\Footer');
$copyright = $footer->getCopyright();

Format price

$objectManager = \Magento\Framework\App\ObjectManager::getInstance();
$priceHelper = $objectManager->create('Magento\Framework\Pricing\Helper\Data');
$price = 998;
$formattedPrice = $priceHelper->currency($price, true, false); // eg:EGP998.00
注: 已convert价格

$priceHelper = $objectManager->get('Magento\Framework\Pricing\PriceCurrencyInterface');
$formatPrice = $priceHelper->format($price);
注: 未convert价格

Resize product image

/**
 * Resize product image
 *
 * @param $imageFile
 * @param $size
 * @return mixed
 */
public function resizeProductImage($imageFile, $size)
{
    $imageObj = $objectManager->get("Magento\Catalog\Model\Product\Image");
    $imageObj->setDestinationSubdir("image");
    $imageObj->setSize($size);
    $imageObj->setBaseFile($imageFile);
    if (!$imageObj->isCached()) {
        $imageObj->resize();
        $imageObj->saveFile();
    }
    return $imageObj->getUrl();
}

Customer session

/**
 * Return customer session model
 *
 * @return mixed
 */
public function getCustomerSession()
{
    return \Magento\Framework\App\ObjectManager::getInstance()->get('Magento\Customer\Model\Session');
}

Get params

$params = $this->_request->getParams();
$param = $this->_request->getParam($key);

用户验证

$authentication = $objectManager->get("Magento\Customer\Model\Authentication");
$customerId = $this->getCustomerSession()->getCustomer()->getId();
$currentPassword = $this->_request->getParam('current_password');
$checkResult = $authentication->authenticate($customerId, $currentPassword); // 返回值为 ture/false

自定义前缀 (Custom prefix of order/invoice/shipment/creditmemo)

UPDATE sales_sequence_profile SET prefix = 'order-' WHERE meta_id in (SELECT meta_id FROM sales_sequence_meta 
WHERE entity_type='order' AND store_id !=0);
UPDATE sales_sequence_profile SET prefix = 'invoice-' WHERE meta_id in (SELECT meta_id FROM sales_sequence_meta 
WHERE entity_type='invoice' AND store_id !=0);
UPDATE sales_sequence_profile SET prefix = 'shipment-' WHERE meta_id in (SELECT meta_id FROM sales_sequence_meta 
WHERE entity_type='shipment' AND store_id !=0);
UPDATE sales_sequence_profile SET prefix = 'creditmemo-' WHERE meta_id in (SELECT meta_id FROM 
sales_sequence_meta WHERE entity_type='creditmemo' AND store_id !=0);

Magento 2 推荐通过构造函数注入的方式获得单例，比如 

namespace Vendor\Module\Helper;

class Dev
{
    /**
     * @var \Psr\Log\LoggerInterface
     */
    protected $logger;

    public function __construct(
        \Psr\Log\LoggerInterface $logger
    ) {
        $this->logger = $logger;
    }
}

另外最好使用接口名来获得实例，这样日后改写业务逻辑时，可以通过 di.xml 指定新的类来实现该接口的功能，比如 

<preference for="Psr\Log\LoggerInterface"
            type="Vendor\Module\Helper\Logger" />

转载自： https://segmentfault.com/a/1190000019165823

转载自： https://segmentfault.com/a/1190000005154774

赏 赞(0)
分享
微信
支付宝
微信二维码图片

用微信扫描二维码打赏

支付宝二维码图片

用支付宝扫描二维码打赏

版权属于: sbboke版权所有。

转载时必须以链接形式注明作者和原始出处及本声明。

张贴在magento2教程

相关文章

0 0 投票数
文章评分
订阅评论
提醒
0 评论
内联反馈
查看所有评论