fishingboy/madump

Magento Data Object Dump Tool

1.1.3 2022-03-23 06:02 UTC

Requires (Dev)

• phpunit/phpunit: ^4.0 || ^5.0 || ^6.0 || ^7.0

MIT

• fishingboy

• magento
• var_dump
• dd

README

為什麼需要 MaDump ?

因為 Magento 的物件如果直接用 var_dump() 或是 print_r() ，都會出現記憶體不足的錯誤，所以寫了一個 dump 工具只 dump 出物件的第一層方便開發。

安裝

composer require fishingboy/madump

使用方法

1. 直接輸出

   use Fishingboy\MaDump\MaDump; 
   MaDump::dump($product);

   Output:

   <pre>
   Magento\Catalog\Model\Product\Interceptor
       ->addAttributeUpdate($code, $value, $store)
       ->addCustomOption($code, $value, $product)
       ->addData(array $arr)
       ->addImageToMediaGallery($file, $mediaAttribute, $move, $exclude)
       ->addOption(Magento\Catalog\Model\Product\Option $option)
       ->afterCommitCallback()
       ->afterDelete()
       ->afterDeleteCommit()
       ->formatUrlKey($str)
       ->fromArray(array $data)
       ->getAttributeDefaultValue($attributeCode)
       ->getAttributeSetId() : 16 (string)
       ->getAttributeText($attributeCode)
       ->getAttributes($groupId, $skipSuper)
       ->getAvailableInCategories() : array
       ->getCacheIdTags() : array
       ->getCacheTags() : array
       ->getCalculatedFinalPrice() :  (NULL)
       ->getCategory() :  (NULL)
       ->getCategoryCollection() : Magento\Catalog\Model\ResourceModel\Category\Collection\Interceptor
       ...
   </pre>

2. 記在 Log (把 output 內容 return 回來)

   use Fishingboy\MaDump\MaDump; 
   $product_dump = MaDump::dump($product, true);
   $this->_logger->info("product => " . $product_dump); 

3. 有時候可能需要直接中斷執行，請直接用 exit

   use Fishingboy\MaDump\MaDump;
   MaDump::dump($product);
   exit;

4. 通常 Trace Code 的時候過程會長這樣

   step.1

   MaDump::dump($product);

   step.2

   MaDump::dump($product->getCustomAttributes());

   step.3

   MaDump::dump($product->getCustomAttributes()[0]);

   自己在程式一層一層往下去找

Output 說明

1. 如果是物件

   <pre>
   Magento\Catalog\Model\Product\Interceptor
       ->addAttributeUpdate($code, $value, $store)
       ->addCustomOption($code, $value, $product)
       ->addData(array $arr)
       ->addImageToMediaGallery($file, $mediaAttribute, $move, $exclude)
       ->addOption(Magento\Catalog\Model\Product\Option $option)
       ->afterCommitCallback()
       ->afterDelete()
       ->afterDeleteCommit()
       ->formatUrlKey($str)
       ->fromArray(array $data)
       ->getAttributeDefaultValue($attributeCode)
       ->getAttributeSetId() : 16 (string)
       ->getAttributeText($attributeCode)
       ->getAttributes($groupId, $skipSuper)
       ->getAvailableInCategories() : array
       ->getCacheIdTags() : array
       ->getCacheTags() : array
       ->getCalculatedFinalPrice() :  (NULL)
       ->getCategory() :  (NULL)
       ->getCategoryCollection() : Magento\Catalog\Model\ResourceModel\Category\Collection\Interceptor
       ...
   </pre>

   如果是 getter method 而且不需要帶參數的話，會直接把呼叫後的值秀出來看，像這樣：

       ->getAttributeSetId() : 16 (string)
       ->getCategoryCollection() : Magento\Catalog\Model\ResourceModel\Category\Collection\Interceptor
       ->getCacheIdTags() : array

2. 如果是陣列

   <pre>
   Array(52) => 
   [0] => (Magento\Framework\Api\AttributeValue)
   [10] => (Magento\Framework\Api\AttributeValue)
   [11] => (Magento\Framework\Api\AttributeValue)
   [12] => (Magento\Framework\Api\AttributeValue)
   ...
   </pre>

   或是這樣

   <pre>
   Array(2) => 
   [0] => 101
   [1] => 102
   </pre>

3. 如果只是一般的值

   <pre>1 (integer)</pre>

   <pre>true (boolean)</pre>

   <pre>sku-123 (string)</pre>