source: branches/version-2_13-dev/data/class/helper/SC_Helper_PageLayout.php @ 22856

Revision 22856, 13.5 KB checked in by Seasoft, 11 years ago (diff)

#2043 (typo修正・ソース整形・ソースコメントの改善 for 2.13.0)

  • 主に空白・空白行の調整。もう少し整えたいが、一旦現状コミット。
  • Property svn:eol-style set to LF
  • Property svn:keywords set to Id
  • Property svn:mime-type set to text/x-httpd-php; charset=UTF-8
Line 
1<?php
2/*
3 * This file is part of EC-CUBE
4 *
5 * Copyright(c) 2000-2013 LOCKON CO.,LTD. All Rights Reserved.
6 *
7 * http://www.lockon.co.jp/
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22 */
23
24/**
25 * Webページのレイアウト情報を制御するヘルパークラス.
26 *
27 * @package Helper
28 * @author LOCKON CO.,LTD.
29 * @version $Id:SC_Helper_PageLayout.php 15532 2007-08-31 14:39:46Z nanasess $
30 */
31class SC_Helper_PageLayout
32{
33    /**
34     * ページのレイアウト情報を取得し, 設定する.
35     *
36     * 現在の URL に応じたページのレイアウト情報を取得し, LC_Page インスタンスに
37     * 設定する.
38     *
39     * @access public
40     * @param LC_Page $objPage LC_Page インスタンス
41     * @param boolean $preview プレビュー表示の場合 true
42     * @param string $url ページのURL($_SERVER['SCRIPT_NAME'] の情報)
43     * @param integer $device_type_id 端末種別ID
44     * @return void
45     */
46    function sfGetPageLayout(&$objPage, $preview = false, $url = '', $device_type_id = DEVICE_TYPE_PC)
47    {
48        // URLを元にページ情報を取得
49        if ($preview === false) {
50            $url = preg_replace('|^' . preg_quote(ROOT_URLPATH) . '|', '', $url);
51            $arrPageData = $this->getPageProperties($device_type_id, null, 'url = ?', array($url));
52        }
53        // プレビューの場合は, プレビュー用のデータを取得
54        else {
55            $arrPageData = $this->getPageProperties($device_type_id, 0);
56        }
57
58        $objPage->tpl_mainpage = $this->getTemplatePath($device_type_id) . $arrPageData[0]['filename'] . '.tpl';
59        $objPage->arrPageLayout =& $arrPageData[0];
60        if (strlen($objPage->arrPageLayout['author']) === 0) {
61            $arrInfo = SC_Helper_DB_Ex::sfGetBasisData();
62            $objPage->arrPageLayout['author'] = $arrInfo['company_name'];
63        }
64
65        // ページタイトルを設定
66        if (SC_Utils_Ex::isBlank($objPage->tpl_title)) {
67            $objPage->tpl_title = $objPage->arrPageLayout['page_name'];
68        }
69
70        // 該当ページのブロックを取得し, 配置する
71        $masterData = new SC_DB_MasterData_Ex();
72        $arrTarget = $masterData->getMasterData('mtb_target');
73        $arrBlocs = $this->getBlocPositions($device_type_id, $objPage->arrPageLayout['page_id']);
74        // 無効なプラグインのブロックを取り除く.
75        $objPlugin = SC_Helper_Plugin_Ex::getSingletonInstance();
76        $arrBlocs = $objPlugin->getEnableBlocs($arrBlocs);
77        // php_path, tpl_path が存在するものを, 各ターゲットに配置
78        foreach ($arrTarget as $target_id => $value) {
79            foreach ($arrBlocs as $arrBloc) {
80                if ($arrBloc['target_id'] != $target_id) {
81                    continue;
82                }
83                if (is_file($arrBloc['php_path'])
84                    || is_file($arrBloc['tpl_path'])) {
85                    $objPage->arrPageLayout[$arrTarget[$target_id]][] = $arrBloc;
86                } else {
87                    $error = "ブロックが見つかりません\n"
88                        . 'tpl_path: ' . $arrBloc['tpl_path'] . "\n"
89                        . 'php_path: ' . $arrBloc['php_path'];
90                    trigger_error($error, E_USER_WARNING);
91                }
92            }
93        }
94        // カラム数を取得する
95        $objPage->tpl_column_num = $this->getColumnNum($objPage->arrPageLayout);
96    }
97
98    /**
99     * ページの属性を取得する.
100     *
101     * この関数は, dtb_pagelayout の情報を検索する.
102     * $device_type_id は必須. デフォルト値は DEVICE_TYPE_PC.
103     * $page_id が null の場合は, $page_id が 0 以外のものを検索する.
104     *
105     * @access public
106     * @param integer $device_type_id 端末種別ID
107     * @param integer $page_id ページID; null の場合は, 0 以外を検索する.
108     * @param string $where 追加の検索条件
109     * @param array $arrParams 追加の検索パラメーター
110     * @return array ページ属性の配列
111     */
112    function getPageProperties($device_type_id = DEVICE_TYPE_PC, $page_id = null, $where = '', $arrParams = array())
113    {
114        $objQuery =& SC_Query_Ex::getSingletonInstance();
115        $where = 'device_type_id = ? ' . (SC_Utils_Ex::isBlank($where) ? $where : 'AND ' . $where);
116        if ($page_id === null) {
117            $where = 'page_id <> ? AND ' . $where;
118            $page_id = 0;
119        } else {
120            $where = 'page_id = ? AND ' . $where;
121        }
122        $objQuery->setOrder('page_id');
123        $arrParams = array_merge(array($page_id, $device_type_id), $arrParams);
124
125        return $objQuery->select('*', 'dtb_pagelayout', $where, $arrParams);
126    }
127
128    /**
129     * ブロック情報を取得する.
130     *
131     * @access public
132     * @param integer $device_type_id 端末種別ID
133     * @param string $where 追加の検索条件
134     * @param array $arrParams 追加の検索パラメーター
135     * @param boolean $has_realpath php_path, tpl_path の絶対パスを含める場合 true
136     * @return array ブロック情報の配列
137     */
138    function getBlocs($device_type_id = DEVICE_TYPE_PC, $where = '', $arrParams = array(), $has_realpath = true)
139    {
140        $objBloc = new SC_Helper_Bloc_Ex($device_type_id);
141        $arrBlocs = $objBloc->getWhere($where, $arrParams);
142        if ($has_realpath) {
143            $this->setBlocPathTo($device_type_id, $arrBlocs);
144        }
145
146        return $arrBlocs;
147    }
148
149    /**
150     * ブロック配置情報を取得する.
151     *
152     * @access public
153     * @param integer $device_type_id 端末種別ID
154     * @param integer $page_id ページID
155     * @param boolean $has_realpath php_path, tpl_path の絶対パスを含める場合 true
156     * @return array 配置情報を含めたブロックの配列
157     */
158    function getBlocPositions($device_type_id, $page_id, $has_realpath = true)
159    {
160        $objQuery =& SC_Query_Ex::getSingletonInstance();
161
162        $table = <<< __EOF__
163        dtb_blocposition AS pos
164            JOIN dtb_bloc AS bloc
165                ON bloc.bloc_id = pos.bloc_id
166                    AND bloc.device_type_id = pos.device_type_id
167__EOF__;
168        $where = 'bloc.device_type_id = ? AND ((anywhere = 1 AND pos.page_id != 0) OR pos.page_id = ?)';
169        $objQuery->setOrder('target_id, bloc_row');
170        $arrBlocs = $objQuery->select('*', $table, $where, array($device_type_id, $page_id));
171        if ($has_realpath) {
172            $this->setBlocPathTo($device_type_id, $arrBlocs);
173        }
174
175        //全ページ設定と各ページのブロックの重複を削除
176        $arrUniqBlocIds = array();
177        foreach ($arrBlocs as $index => $arrBloc) {
178            if ($arrBloc['anywhere'] == 1){
179                $arrUniqBlocIds[] = $arrBloc['bloc_id'];
180            }
181        }
182        foreach ($arrBlocs as $bloc_index => $arrBlocData) {
183            if (in_array($arrBlocData['bloc_id'], $arrUniqBlocIds) && $arrBlocData['anywhere'] == 0){
184                unset($arrBlocs[$bloc_index]);
185            }
186        }
187
188        return $arrBlocs;
189    }
190
191    /**
192     * ページ情報を削除する.
193     *
194     * XXX ファイルを確実に削除したかどうかのチェック
195     *
196     * @access public
197     * @param integer $page_id ページID
198     * @param integer $device_type_id 端末種別ID
199     * @return integer 削除数
200     */
201    function lfDelPageData($page_id, $device_type_id = DEVICE_TYPE_PC)
202    {
203        $objQuery =& SC_Query_Ex::getSingletonInstance();
204        // page_id が空でない場合にはdeleteを実行
205        if ($page_id != '') {
206            $arrPageData = $this->getPageProperties($device_type_id, $page_id);
207            $ret = $objQuery->delete('dtb_pagelayout', 'page_id = ? AND device_type_id = ?', array($page_id, $device_type_id));
208            // ファイルの削除
209            $this->lfDelFile($arrPageData[0]['filename'], $device_type_id);
210        }
211
212        return $ret;
213    }
214
215    /**
216     * ページのファイルを削除する.
217     *
218     * dtb_pagelayout の削除後に呼び出すこと。
219     *
220     * @access private
221     * @param string $filename
222     * @param integer $device_type_id 端末種別ID
223     * @return void // TODO boolean にするべき?
224     */
225    function lfDelFile($filename, $device_type_id)
226    {
227        $objQuery =& SC_Query_Ex::getSingletonInstance();
228
229        /*
230         * 同名ファイルの使用件数
231         * PHP ファイルは, 複数のデバイスで共有するため, device_type_id を条件に入れない
232         */
233        $exists = $objQuery->exists('dtb_pagelayout', 'filename = ?', array($filename));
234
235        if (!$exists) {
236            // phpファイルの削除
237            $del_php = HTML_REALDIR . $filename . '.php';
238            if (file_exists($del_php)) {
239                unlink($del_php);
240            }
241        }
242
243        // tplファイルの削除
244        $del_tpl = $this->getTemplatePath($device_type_id) . $filename . '.tpl';
245        if (file_exists($del_tpl)) {
246            unlink($del_tpl);
247        }
248    }
249
250    /**
251     * 編集可能ページかどうか.
252     *
253     * @access public
254     * @param integer $device_type_id 端末種別ID
255     * @param integer $page_id ページID
256     * @return 編集可能ページの場合 true
257     */
258    function isEditablePage($device_type_id, $page_id)
259    {
260        if ($page_id == 0) {
261            return false;
262        }
263        $arrPages = $this->getPageProperties($device_type_id, $page_id);
264        if ($arrPages[0]['edit_flg'] != 2) {
265            return true;
266        }
267
268        return false;
269    }
270
271    /**
272     * テンプレートのパスを取得する.
273     *
274     * @access public
275     * @param integer $device_type_id 端末種別ID
276     * @param boolean $isUser USER_REALDIR 以下のパスを返す場合 true
277     * @return string テンプレートのパス
278     */
279    function getTemplatePath($device_type_id = DEVICE_TYPE_PC, $isUser = false)
280    {
281        $templateName = '';
282        switch ($device_type_id) {
283            case DEVICE_TYPE_MOBILE:
284                $dir = MOBILE_TEMPLATE_REALDIR;
285                $templateName = MOBILE_TEMPLATE_NAME;
286                break;
287
288            case DEVICE_TYPE_SMARTPHONE:
289                $dir = SMARTPHONE_TEMPLATE_REALDIR;
290                $templateName = SMARTPHONE_TEMPLATE_NAME;
291                break;
292
293            case DEVICE_TYPE_PC:
294            default:
295                $dir = TEMPLATE_REALDIR;
296                $templateName = TEMPLATE_NAME;
297                break;
298        }
299        $userPath = USER_REALDIR;
300        if ($isUser) {
301            $dir = $userPath . USER_PACKAGE_DIR . $templateName . '/';
302        }
303
304        return $dir;
305    }
306
307    /**
308     * DocumentRoot から user_data のパスを取得する.
309     *
310     * 引数 $hasPackage を true にした場合は, user_data/packages/template_name
311     * を取得する.
312     *
313     * @access public
314     * @param integer $device_type_id 端末種別ID
315     * @param boolean $hasPackage パッケージのパスも含める場合 true
316     * @return string 端末に応じた DocumentRoot から user_data までのパス
317     */
318    function getUserDir($device_type_id = DEVICE_TYPE_PC, $hasPackage = false)
319    {
320        switch ($device_type_id) {
321        case DEVICE_TYPE_MOBILE:
322            $templateName = MOBILE_TEMPLATE_NAME;
323            break;
324
325        case DEVICE_TYPE_SMARTPHONE:
326            $templateName = SMARTPHONE_TEMPLATE_NAME;
327            break;
328
329        case DEVICE_TYPE_PC:
330        default:
331            $templateName = TEMPLATE_NAME;
332        }
333        $userDir = ROOT_URLPATH . USER_DIR;
334        if ($hasPackage) {
335            return $userDir . USER_PACKAGE_DIR . $templateName . '/';
336        }
337
338        return $userDir;
339    }
340
341    /**
342     * ブロックの php_path, tpl_path を設定する.
343     *
344     * @access private
345     * @param integer $device_type_id 端末種別ID
346     * @param array $arrBlocs 設定するブロックの配列
347     * @return void
348     */
349    function setBlocPathTo($device_type_id = DEVICE_TYPE_PC, &$arrBlocs = array())
350    {
351        foreach ($arrBlocs as $key => $value) {
352            $arrBloc =& $arrBlocs[$key];
353            $arrBloc['php_path'] = SC_Utils_Ex::isBlank($arrBloc['php_path']) ? '' : HTML_REALDIR . $arrBloc['php_path'];
354            $bloc_dir = $this->getTemplatePath($device_type_id) . BLOC_DIR;
355            $arrBloc['tpl_path'] = SC_Utils_Ex::isBlank($arrBloc['tpl_path']) ? '' : $bloc_dir . $arrBloc['tpl_path'];
356        }
357    }
358
359    /**
360     * カラム数を取得する.
361     *
362     * @access private
363     * @param array $arrPageLayout レイアウト情報の配列
364     * @return integer $col_num カラム数
365     */
366    function getColumnNum($arrPageLayout)
367    {
368        // メインは確定
369        $col_num = 1;
370        // LEFT NAVI
371        if (count($arrPageLayout['LeftNavi']) > 0) $col_num++;
372        // RIGHT NAVI
373        if (count($arrPageLayout['RightNavi']) > 0) $col_num++;
374
375        return $col_num;
376    }
377}
Note: See TracBrowser for help on using the repository browser.