src/Eccube/Util/EntityUtil.php line 68

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of EC-CUBE
  5.  *
  6.  * Copyright(c) EC-CUBE CO.,LTD. All Rights Reserved.
  7.  *
  8.  * http://www.ec-cube.co.jp/
  9.  *
  10.  * For the full copyright and license information, please view the LICENSE
  11.  * file that was distributed with this source code.
  12.  */
  14. namespace Eccube\Util;
  16. use Doctrine\ORM\EntityNotFoundException;
  17. use Doctrine\ORM\Proxy\Proxy;
  19. class EntityUtil
  20. {
  21.     /**
  22.      * LAZY loading したエンティティの有無をチェックする.
  23.      *
  24.      * 削除済みのエンティティを LAZY loading した場合、 soft_delete filter で
  25.      * フィルタリングされてしまい、正常に取得することができない.
  26.      * しかし、 Proxy オブジェクトとして取得されるため、この関数を使用して
  27.      * 有無をチェックする.
  28.      * この関数を使用せず、該当のオブジェクトのプロパティを取得しようとすると、
  29.      * EntityNotFoundException がスローされてしまう.
  30.      *
  31.      * @param $entity LAZY loading したエンティティ
  32.      *
  33.      * @return bool エンティティが削除済みの場合 true
  34.      *
  35.      * @see https://github.com/EC-CUBE/ec-cube/pull/602#issuecomment-125431246
  36.      * @deprecated
  37.      */
  38.     public static function isEmpty($entity)
  39.     {
  40.         @trigger_error('The '.__METHOD__.' method is deprecated.', E_USER_DEPRECATED);
  41.         if ($entity instanceof Proxy) {
  42.             try {
  43.                 $entity->__load();
  44.             } catch (EntityNotFoundException $e) {
  45.                 return true;
  46.             }
  48.             return false;
  49.         } else {
  50.             return empty($entity);
  51.         }
  52.     }
  54.     /**
  55.      * LAZY loading したエンティティの有無をチェックする.
  56.      *
  57.      * EntityUtil::isEmpty() の逆の結果を返します.
  58.      *
  59.      * @param $entity
  60.      *
  61.      * @return bool
  62.      *
  63.      * @see EntityUtil::isEmpty()
  64.      * @deprecated
  65.      */
  66.     public static function isNotEmpty($entity)
  67.     {
  68.         @trigger_error('The '.__METHOD__.' method is deprecated.', E_USER_DEPRECATED);
  70.         return !self::isEmpty($entity);
  71.     }
  73.     /**
  74.      * エンティティのプロパティを配列で返す.
  75.      *
  76.      * このメソッドはエンティティの内容をログ出力する際などに使用する.
  77.      * AbstractEntity::toArray() と異なり再帰処理しない.
  78.      * プロパティの値がオブジェクトの場合は、クラス名を出力する.
  79.      *
  80.      * @param object $entity 対象のエンティティ
  81.      *
  82.      * @return array エンティティのプロパティの配列
  83.      */
  84.     public static function dumpToArray($entity)
  85.     {
  86.         $objReflect = new \ReflectionClass($entity);
  87.         $arrProperties = $objReflect->getProperties();
  88.         $arrResults = [];
  89.         foreach ($arrProperties as $objProperty) {
  90.             $objProperty->setAccessible(true);
  91.             $name = $objProperty->getName();
  92.             $value = $objProperty->getValue($entity);
  93.             $arrResults[$name] = is_object($value) ? get_class($value) : $value;
  94.         }
  96.         return $arrResults;
  97.     }
  98. }