EC-CUBE 2系
EC-CUBE標準規約
by TheVOS posted Sep 28, 2019
원문출처 | http://svn.ec-cube.net/open_trac/wiki/EC...F%E7%B4%84 |
---|
基本的に Zend Framework PHP 標準コーディング規約 に順ずる.
以下, 要点及び相違点を規定する.
また, コーディングに際して, 以下のガイドラインに沿うことが望ましい
PHPUnitを利用した単体テストを行う際は以下のガイドラインに沿う事が望ましい
命名規約
ファイル名
- 拡張子は, 各ファイル形式に準ずる.
- PHPファイルは, 必ず .php を使用する.
- PHPクラスは, 特別な場合を除き, 1クラス1ファイルとし, クラス名.php とする.
PHPクラス名
- 区切り文字としてはアンダースコア(_)を使用する.
- クラス名称の先頭には, 大文字でその種類を表す Prefix を付加する.
Prefix 種類 例 SC, GC 1つのサイト内で共有するクラス (他のクラスから呼ばれる) SC_Customer.php LC 1つのソースファイル内で使用するクラス (通常他のクラスから呼ばれない) LC_Page_Abouts.php - クラスがパッケージに属する場合は, Prefix の後にパッケージ名を付加する.
- Page パッケージでインデックスページとしてアクセスされるクラス名は Index とせず, 属する階層名をクラス名とする.
- ユーザーが拡張するために extends するクラスは, クラス名の最後に Ex を付加する.
関数名
- 関数名の先頭には, 小文字でその種類を表す Prefix を付加する.
- クラス名: LC_*
- private または protected を意図する場合、Prefix「lf」を省略できる。(Prefix の付加がない場合、「lf」相当とみなす。)
- public を意図する場合、Prefix「sf」を省略できない。
- クラス名: SC_*, GC_*
- public を意図するメソッドの場合、Prefix「sf」を省略できる。(Prefix の付加がない場合、「sf」相当とみなす。)
- private または protected を意図する場合、Prefix「lf」を省略できない。
- クラス名: LC_*
- 名称が複数の単語からなる場合, それぞれの単語の先頭を大文字にする.
- 関数名は, Prefix + 動詞 + 対象 を原則とする.
Prefix 種類 例 sf 一つのサイト内で共有する関数 sfGetProductName() lf 一つのソースファイル内で使用する関数 lfGetProductName() fn JavaScript で宣言された関数 fnGetProductName()
変数名(Smarty 変数も含む)
- 変数名の先頭には, 小文字でその種類を表す Prefix を付加する.
- ループ等で一時的に使用する, 数値型の変数には慣習的な $i, $j, $k を使用しても良い.
- リテラルを格納する (つまり配列・オブジェクト以外の) 変数名は, すべて小文字を使用し, アンダーバーで区切る.
- 配列・オブジェクトの変数名はキャメルケースを使用する.
Prefix 種類 例 obj クラス変数(オブジェクト) $objQuery arr 配列 $arrCustmers tpl テンプレート変数(リテラル) $this->tpl_csv_id
定数名
- すべて大文字で宣言する.
- 区切り文字としてアンダースコア(_)を使用する.
- パスに関わるもの(パラメータを含む)は、下記を適用する。(#834 から展開)
- *_URL: URL
- 先頭は「スキーム名:」
- *_URLPATH: URL における url-path 相当 (絶対パス)
- 先頭は「/」
- *_HTMLPATH: URL 上の EC-CUBE の /html/ からの相対パス
- 先頭に「/」を含まない。(/html/ と同一の場合、空文字)
- 命名に改善余地あり。 (参考: concrete5=DIR_REL) 現在は利用箇所が無いが、今後利用する必要も考えられるので再考していきたい。
- *_REALFILE: (サーバの)ファイルシステム上のファイルの絶対パス
- 先頭は「/」
- *_REALDIR: (サーバの)ファイルシステム上のディレクトリの絶対パス
- 先頭は「/」。末尾は「/」。
- *_DIR: 上記に該当しない断片的なディレクトリ情報。
- 先頭に「/」を含まない。
- *_FILE: 上記に該当しない断片的なファイル情報。
- *_PATH: 上記に該当しないもの。上記の複数に該当するもの。
- *_URL: URL
DBテーブル名
- テーブル名の先頭には, 小文字でその種類を表す Prefix を付加する.
- 区切り文字としてアンダースコア(_)を使用する.
-
Prefix 種類 例 mtb マスタデータ mtb_pref dtb データテーブル dtb_order_detail
DBカラム名
- 特に指定の無い限り, すべて小文字を使用する.
- 区切り文字としてアンダースコア(_)を使用する.
CSS クラス名
- 特に定義なし
コーディング規約
HTML
- ラジオボタン, チェックボックスは <label></label> で囲み, 文字をクリックしてもチェックされるようにする.
PHPコード
- 改行コードは, 基本的に LF を使用する.
- 使用する Subversion クライアントによっては, svn add を実行した際に, OS 元来の改行コードがリポジトリに反映されてしまう場合があるため, svn propset で svn:eol-style=LF を設定しておくのが望ましい.
- PHPコードの開始タグと, 終了タグは以下のように記述する.
- 終了タグの後に必ず LF (UNIX の改行コード)を1つ入れる.
- 余分な空行, 行末の空白は極力削除する.
- Eclipse でコーディングする場合, AnyEdit プラグイン を使用すると自動的にやってくれる
- クラス定義, 関数定義の後, 括弧の後で改行する.
- 80 文字を目安に改行する.
<?php class LC_Page_Abouts { function process() { // some logic. } }
制御文
- if, for, while, switch 等の制御構造は, 次のルールで開き括弧で記述する.
- インデントは, 半角スペース4文字を使用し, タブは使用しない.
- if 文
<?php if ($flag == '1') { // '1' == $flag と書くのは NG $ret = 1; } elseif ($flag == '2') { $ret = 2; } else { $ret = 3; }
- 判定文の対象となる処理結果は先に記述する.
- for 文
<?php for ($i = 0; $i < $max; $i++) { echo $i . "\n"; }
- foreach 文
<?php foreach ($var as $key => $val) { echo $key . ':' . $val . "\n"; }
- while 文
<?php while ($flag) { var_dump($flag); }
- do while 文
<?php do { var_dump($flag); } while ($flag);
- switch 文
<?php switch ($var) { case VAR_ONE: echo 'one'; break; case VAR_TWO: echo 'two'; break; default: echo 'default'; break; }
- case の記述は, 定数を用いるのが望ましい.
文字列
- 長くなる文字列は分割し, "." で結合する.
<?php $sql = 'SELECT name, age, birthday, zipcode, address, comment ' . ' FROM user_information ' . ' WHERE user_id = ? ' . ' AND is_delete = 0 ';
- ヒアドキュメントを使用しても良い
<?php $sql = <<< __EOS__ SELECT name, age, birthday, zipcode, address, comment FROM user_information WHERE user_id = ? AND is_delete = 0 __EOS__;
SQL文
- フォームから入力された値を利用して SQL文を生成する場合, SQLインジェクションを防ぐため, 必ず PEAR::MDB2 のブレースホルダを利用する.
コメント
- コメントのコーディングは基本的に phpDocumentor に準ずる.
ヘッダ
- 各ファイルのヘッダに著作権表記を記述する.
<?php /* * This file is part of EC-CUBE * * Copyright(c) 2000-2011 LOCKON CO.,LTD. All Rights Reserved. * * http://www.lockon.co.jp/ * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation; either version 2 * of the License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
クラス定義
- phpDoc コメントは必要に応じて記述する.
- @version は $Id$ を使用する.
- enable-auto-props を有効 にし, svn:keywords で *.php = svn:keywords=Id とすることで自動展開される.
- メンバ変数は / */ を使用することによって phpDoc コメントとして認識される.
<?php /** * クラスの簡単な説明 * * クラスの詳細な説明.... * ... * * @package Page * @author LOCKON CO.,LTD. * @version $Id$ */ class LC_Page { /** メンバ変数 */ var foo; }
Pageクラス
- class/pages以下において exit; を個別の処理でしない。exit処理はすべてSC_Response_Ex::actionExit(); に共通化すること.
関数定義
- phpDoc コメントは必要に応じて記述する.
- @param と @return は必須
- コード文中にも必要に応じて的確なコメントを記述する.
<?php /** * 関数の簡単な説明. * * 関数の詳細な説明.... * .... * * @access private * @param string $foo 引数の説明 * @param string|integer $bar 引数の説明 * @return string 返り値の説明 */ function process($foo, $bar = '') { // some process... return 'string value'; }
その他
- 必要に応じて, 下記のタスクタグを使用しても良い
- TODO - TODO として残したいコメント
- FIXME - 必ず修正することを促すコメント
- XXX - 動くけど怪しい...
<?php // TODO リファクタリングすること. // FIXME 要修正. バグの説明(#135) /** * :XXX: 以下, 怪しいロジック(#999) * 複数行のコメントはこのように. * * 必要に応じて チケットの ID も記述する. */
- コメントによってソースコードが見難くならないように注意する.
-
클래스의 사용
클래스의 사용
인스턴스의 생성 클래스가 선언되고 나면, 선언된 클래스로부터 인스턴스를 생성할 수 있습니다. PHP에서는 new 키워드를 사용하여 인스턴스를 생성할 수 있습니다. 이때 클래스 이름을 통해 생성자로 필요한 인수를 전달할 수 있습니다. 문법 $객체이름 = new...Date2019.10.03 Category클래스 Views93 -
클래스의 구조
클래스의 구조
클래스의 구조 PHP에서 클래스는 class 키워드를 사용하여 다음과 같이 선언합니다. 문법 class 클래스이름 { 클래스의 프로퍼티과 메소드의 정의; } PHP에서 클래스의 이름을 생성할 때는 반드시 다음 규칙을 지켜야만 합니다. 1. 클래스의 이름은 숫자와의 ...Date2019.10.03 Category클래스 Views35 -
클래스와 객체의 기초
クラス(class)とオブジェクト(object) オブジェクト(object)とは、実生活では、我々が認識することができるもので理解することができます。 これらのオブジェクトの状態(state)と行動(behavior)は、それぞれのプロパティ(property)とメソッド(met...Date2019.10.03 Category클래스 Views56 -
EC-CUBE:SC_FormParamクラスによるパラメーターチェック方法
EC-CUBE:SC_FormParamクラスによるパラメーターチェック方法
EC-CUBE에 대한 인터넷상에서 아직 정보가 많이 부족합니다. 예를 들어 플러그인 작성에 원래 폼을 만들어도 SC_FormParam 클래스 를 사용하여 어떻게 확인하면 좋은 것인지 조사해도 좀처럼 나오지 않습니다. 그래서 내가 독자적으로 조사한 속에서 조금씩 정...Date2019.10.03 CategoryEC-CUBE 2.x Views119 -
EC-CUBE2.12 運用マニュアル
EC-CUBE ver2120 2121 2122 運用マニュアル1 Page EC-CUBE Ver2120 Ver2121 Ver2122 運用マニュアル 2012年11月28日 Thi s document is licensed under a Creative Commons 表示 - 継承 2 1 日本 License THEVOS ECO LAB Inc EC-CUBE ver2120 2121 212...Date2019.09.29 CategoryEC-CUBE 운용 설명서 Views62 -
単体テストガイドライン
単体テストガイドライン
本ガイドラインはEC-CUBEの単体テストをPHPUnitを使って行う上でのガイドラインを株式会社SHIFT様(http://www.shiftinc.jp/)のご協力によりまとめたものとなります。 各クラス共通のガイドライン1. テストを含めたフォルダ構成テストコードを含んだフォルダ構...Date2019.09.28 CategoryEC-CUBE 2系 Views86 -
リファクタリングガイドライン
リファクタリングガイドライン
init 関数init 関数は, クラスの初期化を目的する. ビジネスロジックの記述はしないこと <?php function init() { /** * NG ビジネスロジックの記述はしない */ if (count($this->arrPayment) > 0) { $i = 0; foreach ($this->arrPayment as $val) { $this->pa...Date2019.09.28 CategoryEC-CUBE 2系 Views153 -
EC-CUBE標準規約
EC-CUBE標準規約
基本的に Zend Framework PHP 標準コーディング規約 に順ずる.以下, 要点及び相違点を規定する. また, コーディングに際して, 以下のガイドラインに沿うことが望ましい EC-CUBE標準規約 > リファクタリングガイドライン PHPUnitを利用した単体テストを行う際は...Date2019.09.28 CategoryEC-CUBE 2系 Views154 -
デフォルトのtitleを任意のものに変更する方法
EC-CUBE 3.Xでデフォルトでtitle部分に表示されるものを任意で削除・変更したり、あらかじめ用意されているページのページ名(テンプレート名)を任意のものに変更する方法です。 ※紹介している内容はEC-CUBEのVersion 3.0.10で動作確認したもので、デフォルト...Date2019.04.10 CategoryEC-CUBE 3.x Views227 -
titleの並びや区切り記号を変更する方法
EC-CUBE 3.Xは、デフォルトのテンプレートだとtitle表示が「ショップ名 / ページ名」という形になっていますが、それを任意の並びにしたり区切り記号を変更したりする方法です。 ※紹介している内容はEC-CUBEのVersion 3.0.10で動作確認したもので、デフォルト...Date2019.04.10 CategoryEC-CUBE 3.x Views96 -
商品数や階層に関係なく全カテゴリーを表示させる方法
EC-CUBEの備忘録。デフォルトのテンプレートだとサイドに表示されている商品カテゴリーですが、商品登録がない場合はカテゴリー名が表示されず、商品が登録されていたとしても親カテゴリーのページでなければ子カテゴリー名は表示されないようになっています。...Date2019.04.10 CategoryEC-CUBE 2.x Views260 -
商品名などで長くなったテキストを省略する方法
引き続きEC-CUBEの備忘録です。商品のタイトルや紹介文が指定した文字数以上になったときに「...」などを表示して、見栄えを揃える方法です。jQueryを使うとかCSSのtext-overflowなんかでも同じ事はできますが、Smartyを使って実装するものになります。 ※EC-CU...Date2019.04.10 CategoryEC-CUBE 2.x Views45 -
サイトデザインをPCで統一させる方法
EC-CUBEはもともとスマートフォンやモバイル用のテンプレートが用意されており、それぞれのデバイスで閲覧すると各テンプレートに振り分けらるようになっているのですが、それを無効にする方法です。この機能自体は良いと思うのですが、例えばモバイルまで手が...Date2019.04.10 CategoryEC-CUBE 2.x Views52 -
商品ステータスを変更・追加する方法
EC-CUBE自体をまだあまり触ったこともなければ、そんなに頻繁に使わないのもあって、しばらくすると簡単なことでもいろいろと忘れてしまうので備忘録。デフォルトだと「NEW」とか「残りわずか」などで登録されている商品ステータスを任意のものに変更・追加す...Date2019.04.10 CategoryEC-CUBE 2.x Views62 -
新規作成したページURLから「user_data」を消す方法とURLを出力するテンプレートタグ
EC-CUBE 3.Xではもともと用意されているページを利用するだけでなくオリジナルで新規ページを追加することもできるのですが、その場合作成したページのURLに「user_data」が付与されています。この「user_data」という部分をURLから消す方法とそれに関連して新...Date2019.04.10 CategoryEC-CUBE 3.x Views863 -
메일 사용자 설명서
메일 사용자 설명서
원 포인트 가이드메일 소프트에 다음 정보를 설정하십시오. 메일 서버 (POP)sv11.star.ne.jp메일 서버 (SMTP)sv11.star.ne.jp계정 (사용자 이름)만든 계정 이름 (@이후도 포함)비밀번호설정 한 패스워드Date2019.03.29 Category메일 서비스 Views61 -
페이스북위젯 삽입하기
페이스북 위젯을 삽입하는 방법을 알아보겠습니다. 1. 페이스북 위젯을 설정하는 곳으로 갑니다. ( https://developers.facebook.com/docs/plugins/page-plugin ) 2. 원하는 위젯모양을 만듭니다. 밑의 이미지를 보시면 쉽게 이해가 되실꺼예요. 3. 설정이 끝...Date2018.12.15 Category팁 & 노하우 나눔 Views45 -
구글 캘린더 합치기
구글 캘린더로 일정관리를 하는 사람이라면 한번쯤 여러개로 나눠진 캘린더를 하나로 합쳐야 할 때가 생깁니다. 저같은 경우는 처음에 일정관리에 심취해서 캘린더 수를 아주 자세하게 여러개로 나눠 놨었죠. 그러나 최근에서야 단순함의 미학과 효율성에 눈을...Date2018.12.12 Category팁 & 노하우 나눔 Views427 -
THEVOS Youtube BOARD SKIN 사용 설명
THEVOS Youtube BOARD SKIN 사용 설명
[ 스킨 기능 ] - 사용자 정의 자동추가 게시판 스킨을 "INSP 유튜브"으로 변경하고 사용자정의 eid(dex_embed_srl)가 없을겨우 자동으로 추가됨 - 기존게시판에서도 사용가능 ㄴ 게시판에 필요한 사용자 정의는 "thevos_extv_youtube_code" 이다. ㄴ 하지만 sk...Date2018.11.11 Category메뉴얼 Views116
Facebook [ko]댓글