Changes between Version 6 and Version 7 of EC-CUBE標準規約/開発効率向上のためのTips

Timestamp:

2013/12/17 10:58:04 (13 years ago)

Author:

nanasess

Comment:

Fix indent.

EC-CUBE標準規約/開発効率向上のためのTips

@@ -209 +209 @@
 #!php
 
-  <?php
-
-  /**
-   * エンティティクラスの例
-   */
-  class SC_Entity_OrderDetail {
-
-      private $order_detail_id;
-      private $order_id;
-      private $product_id;
-      private $product_class_id;
-      private $product_name;
-      private $product_code;
-      private $classcategory_name1;
-      private $classcategory_name2;
-      private $price;
-      private $quantity;
-      private $point_rate;
-
-      /**
-       * コンストラクタ.
-       * 
-       * 引数の連想配列で, 本オブジェクトのプロパティを設定可能.
-       * 
-       * @param array $arrOrderDetail
-       */
-      public function __construct($arrOrderDetail = array()) {
-          if (is_array($arrOrderDetail)) {
-              $this->setPropertiesFromArray($arrOrderDetail);
-          }
-      }
-
-      /**
-       * 税込単価を返します.
-       * 
-       * @return integer 税込単価
-       */
-      public function getTotalInTax() {
-          return SC_Helper_DB_Ex::sfTax($this->getPrice()) *
-          $this->getQuantity();
-      }
-
-      /**
-       * 該当商品のカテゴリIDを配列で返します.
-       * 
-       * @return array カテゴリ一覧の配列
-       */
-      public function getCategoryIds() {
-          // エンティティクラスの内部での DBアクセスは極力避けるべきですが,
-          // 内部でDBアクセスした方が効率が良い場合は, その旨のコメントを入れて使用します.
-          // この場合は, product_id に紐づいた category_id を取得します.
-          // 以下のロジックを外出しするより簡潔なコードになります.
-          $objQuery = SC_Query_Ex::getSingletonInstance();
-          $col = 'category_id';
-          $from = 'dtb_product_categories';
-          $where = 'product_id = ?';
-          $arrResults = $objQuery->select($col, $from, $where,
-          array($this->getProductId()));
-          $arrCategoryIds = array();
-          foreach ($arrResults as $val) {
-              $arrCategoryIds[] = $val;
-          }
-          return $arrCategoryIds;
-      }
-
-      /*
-       * 読み取り専用にしたいプロパティは, getter のみ作成します.
-       * 更新可能なプロパティは setter を作成します.
-       */
-      public function getOrderId() {
-          return $this->order_id;
-      }
-      public function getProductId() {
-          return $this->product_id;
-      }
-      public function getProductClassId() {
-          return $this->product_class_id;
-      }
-      public function getProductCode() {
-          return $this->product_code;
-      }
-      public function getClassCategoryName1() {
-          return $this->classcategory_name1;
-      }
-      public function getClassCategoryName2() {
-          return $this->classcategory_name2;
-      }
-      public function getPrice() {
-          return $this->price;
-      }
-      public function setQuantity($quantity) {
-          $this->quantity = $quantity;
-      }
-      public function getQuantity() {
-          return $this->quantity;
-      }
-      protected function getPointRate() {
-          return $this->point_rate;
-      }
-
-      /**
-       * 引数の連想配列を元にプロパティを設定します.
-       * DBから取り出した連想配列を, プロパティへ設定する際に使用します.
-       * 
-       * @param array プロパティの情報を格納した連想配列
-       * @param ReflectionClass $parentClass 親のクラス. 本メソッドの内部的に使用します.
-       */
-      public function setPropertiesFromArray($arrProps, ReflectionClass $parentClass = null) {
-          $objReflect = null;
-          if (is_object($parentClass)) {
-              $objReflect = $parentClass;
-          } else {
-              $objReflect = new ReflectionClass($this);
-          }
-
-          $arrProperties = $objReflect->getProperties();
-          foreach ($arrProperties as $objProperty) {
-              $objProperty->setAccessible(true);
-              $name = $objProperty->getName();
-              $objProperty->setValue($this, $arrProps[$name]);
-          }
-
-          // 親クラスがある場合は再帰的にプロパティを取得
-          $parentClass = $objReflect->getParentClass();
-          if (is_object($parentClass)) {
-              self::setPropertiesFromArray($arrProps, $parentClass);
-          }
-      }
-
-      /**
-       * プロパティの値を連想配列で返します.
-       * DBを更新する場合などで, 連想配列の値を取得したい場合に使用します.
-       * 
-       * @return array 連想配列のプロパティの値
-       */
+<?php
+
+/**
+ * エンティティクラスの例
+ */
+class SC_Entity_OrderDetail {
+
+    private $order_detail_id;
+    private $order_id;
+    private $product_id;
+    private $product_class_id;
+    private $product_name;
+    private $product_code;
+    private $classcategory_name1;
+    private $classcategory_name2;
+    private $price;
+    private $quantity;
+    private $point_rate;
+
+    /**
+     * コンストラクタ.
+     * 
+     * 引数の連想配列で, 本オブジェクトのプロパティを設定可能.
+     * 
+     * @param array $arrOrderDetail
+     */
+    public function __construct($arrOrderDetail = array()) {
+        if (is_array($arrOrderDetail)) {
+            $this->setPropertiesFromArray($arrOrderDetail);
+        }
+    }
+
+    /**
+     * 税込単価を返します.
+     * 
+     * @return integer 税込単価
+     */
+    public function getTotalInTax() {
+        return SC_Helper_DB_Ex::sfTax($this->getPrice()) * $this->getQuantity();
+    }
+
+    /**
+     * 該当商品のカテゴリIDを配列で返します.
+     * 
+     * @return array カテゴリ一覧の配列
+     */
+    public function getCategoryIds() {
+        // エンティティクラスの内部での DBアクセスは極力避けるべきですが,
+        // 内部でDBアクセスした方が効率が良い場合は, その旨のコメントを入れて使用します.
+        // この場合は, product_id に紐づいた category_id を取得します.
+        // 以下のロジックを外出しするより簡潔なコードになります.
+        $objQuery = SC_Query_Ex::getSingletonInstance();
+        $col = 'category_id';
+        $from = 'dtb_product_categories';
+        $where = 'product_id = ?';
+        $arrResults = $objQuery->select($col, $from, $where,
+                                        array($this->getProductId()));
+        $arrCategoryIds = array();
+        foreach ($arrResults as $val) {
+            $arrCategoryIds[] = $val;
+        }
+        return $arrCategoryIds;
+    }
+
+    /*
+     * 読み取り専用にしたいプロパティは, getter のみ作成します.
+     * 更新可能なプロパティは setter を作成します.
+     */
+    public function getOrderId() {
+        return $this->order_id;
+    }
+    public function getProductId() {
+        return $this->product_id;
+    }
+    public function getProductClassId() {
+        return $this->product_class_id;
+    }
+    public function getProductCode() {
+        return $this->product_code;
+    }
+    public function getClassCategoryName1() {
+        return $this->classcategory_name1;
+    }
+    public function getClassCategoryName2() {
+        return $this->classcategory_name2;
+    }
+    public function getPrice() {
+        return $this->price;
+    }
+    public function setQuantity($quantity) {
+        $this->quantity = $quantity;
+    }
+    public function getQuantity() {
+        return $this->quantity;
+    }
+    protected function getPointRate() {
+        return $this->point_rate;
+    }
+
+    /**
+     * 引数の連想配列を元にプロパティを設定します.
+     * DBから取り出した連想配列を, プロパティへ設定する際に使用します.
+     * 
+     * @param array プロパティの情報を格納した連想配列
+     * @param ReflectionClass $parentClass 親のクラス. 本メソッドの内部的に使用します.
+     */
+    public function setPropertiesFromArray($arrProps, ReflectionClass $parentClass = null) {
+        $objReflect = null;
+        if (is_object($parentClass)) {
+            $objReflect = $parentClass;
+        } else {
+            $objReflect = new ReflectionClass($this);
+        }
+
+        $arrProperties = $objReflect->getProperties();
+        foreach ($arrProperties as $objProperty) {
+            $objProperty->setAccessible(true);
+            $name = $objProperty->getName();
+            $objProperty->setValue($this, $arrProps[$name]);
+        }
+
+        // 親クラスがある場合は再帰的にプロパティを取得
+        $parentClass = $objReflect->getParentClass();
+        if (is_object($parentClass)) {
+            self::setPropertiesFromArray($arrProps, $parentClass);
+        }
+    }
+
+    /**
+     * プロパティの値を連想配列で返します.
+     * DBを更新する場合などで, 連想配列の値を取得したい場合に使用します.
+     * 
+     * @return array 連想配列のプロパティの値
+     */
     public function toArray(ReflectionClass $parentClass = null) {
         $objReflect = null;
@@ -352 +351 @@
         }
         $arrProperties = $objReflect->getProperties();
+        $arrResults = array();
         foreach ($arrProperties as $objProperty) {
             $objProperty->setAccessible(true);
@@ -372 +372 @@
         return $arrResults;
     }
-  }
+}
 }}}