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

Revision 23057, 13.6 KB checked in by Seasoft, 8 years ago (diff)

#2327 (SC_Helper_PageLayout#sfGetPageLayout ページ情報が取得できない場合の動作が不定)

  • 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        if (empty($arrPageData[0])) {
59            trigger_error('ページ情報を取得できませんでした。', E_USER_ERROR);
60        }
61
62        $objPage->tpl_mainpage = $this->getTemplatePath($device_type_id) . $arrPageData[0]['filename'] . '.tpl';
63
64        $objPage->arrPageLayout =& $arrPageData[0];
65        if (strlen($objPage->arrPageLayout['author']) === 0) {
66            $arrInfo = SC_Helper_DB_Ex::sfGetBasisData();
67            $objPage->arrPageLayout['author'] = $arrInfo['company_name'];
68        }
69
70        // ページタイトルを設定
71        if (SC_Utils_Ex::isBlank($objPage->tpl_title)) {
72            $objPage->tpl_title = $objPage->arrPageLayout['page_name'];
73        }
74
75        // 該当ページのブロックを取得し, 配置する
76        $masterData = new SC_DB_MasterData_Ex();
77        $arrTarget = $masterData->getMasterData('mtb_target');
78        $arrBlocs = $this->getBlocPositions($device_type_id, $objPage->arrPageLayout['page_id']);
79        // 無効なプラグインのブロックを取り除く.
80        $objPlugin = SC_Helper_Plugin_Ex::getSingletonInstance();
81        $arrBlocs = $objPlugin->getEnableBlocs($arrBlocs);
82        // php_path, tpl_path が存在するものを, 各ターゲットに配置
83        foreach ($arrTarget as $target_id => $value) {
84            foreach ($arrBlocs as $arrBloc) {
85                if ($arrBloc['target_id'] != $target_id) {
86                    continue;
87                }
88                if (is_file($arrBloc['php_path'])
89                    || is_file($arrBloc['tpl_path'])) {
90                    $objPage->arrPageLayout[$arrTarget[$target_id]][] = $arrBloc;
91                } else {
92                    $error = "ブロックが見つかりません\n"
93                        . 'tpl_path: ' . $arrBloc['tpl_path'] . "\n"
94                        . 'php_path: ' . $arrBloc['php_path'];
95                    trigger_error($error, E_USER_WARNING);
96                }
97            }
98        }
99        // カラム数を取得する
100        $objPage->tpl_column_num = $this->getColumnNum($objPage->arrPageLayout);
101    }
102
103    /**
104     * ページの属性を取得する.
105     *
106     * この関数は, dtb_pagelayout の情報を検索する.
107     * $device_type_id は必須. デフォルト値は DEVICE_TYPE_PC.
108     * $page_id が null の場合は, $page_id が 0 以外のものを検索する.
109     *
110     * @access public
111     * @param integer $device_type_id 端末種別ID
112     * @param integer $page_id ページID; null の場合は, 0 以外を検索する.
113     * @param string $where 追加の検索条件
114     * @param array $arrParams 追加の検索パラメーター
115     * @return array ページ属性の配列
116     */
117    function getPageProperties($device_type_id = DEVICE_TYPE_PC, $page_id = null, $where = '', $arrParams = array())
118    {
119        $objQuery =& SC_Query_Ex::getSingletonInstance();
120        $where = 'device_type_id = ? ' . (SC_Utils_Ex::isBlank($where) ? $where : 'AND ' . $where);
121        if ($page_id === null) {
122            $where = 'page_id <> ? AND ' . $where;
123            $page_id = 0;
124        } else {
125            $where = 'page_id = ? AND ' . $where;
126        }
127        $objQuery->setOrder('page_id');
128        $arrParams = array_merge(array($page_id, $device_type_id), $arrParams);
129
130        return $objQuery->select('*', 'dtb_pagelayout', $where, $arrParams);
131    }
132
133    /**
134     * ブロック情報を取得する.
135     *
136     * @access public
137     * @param integer $device_type_id 端末種別ID
138     * @param string $where 追加の検索条件
139     * @param array $arrParams 追加の検索パラメーター
140     * @param boolean $has_realpath php_path, tpl_path の絶対パスを含める場合 true
141     * @return array ブロック情報の配列
142     */
143    function getBlocs($device_type_id = DEVICE_TYPE_PC, $where = '', $arrParams = array(), $has_realpath = true)
144    {
145        $objBloc = new SC_Helper_Bloc_Ex($device_type_id);
146        $arrBlocs = $objBloc->getWhere($where, $arrParams);
147        if ($has_realpath) {
148            $this->setBlocPathTo($device_type_id, $arrBlocs);
149        }
150
151        return $arrBlocs;
152    }
153
154    /**
155     * ブロック配置情報を取得する.
156     *
157     * @access public
158     * @param integer $device_type_id 端末種別ID
159     * @param integer $page_id ページID
160     * @param boolean $has_realpath php_path, tpl_path の絶対パスを含める場合 true
161     * @return array 配置情報を含めたブロックの配列
162     */
163    function getBlocPositions($device_type_id, $page_id, $has_realpath = true)
164    {
165        $objQuery =& SC_Query_Ex::getSingletonInstance();
166
167        $table = <<< __EOF__
168        dtb_blocposition AS pos
169            JOIN dtb_bloc AS bloc
170                ON bloc.bloc_id = pos.bloc_id
171                    AND bloc.device_type_id = pos.device_type_id
172__EOF__;
173        $where = 'bloc.device_type_id = ? AND ((anywhere = 1 AND pos.page_id != 0) OR pos.page_id = ?)';
174        $objQuery->setOrder('target_id, bloc_row');
175        $arrBlocs = $objQuery->select('*', $table, $where, array($device_type_id, $page_id));
176        if ($has_realpath) {
177            $this->setBlocPathTo($device_type_id, $arrBlocs);
178        }
179
180        //全ページ設定と各ページのブロックの重複を削除
181        $arrUniqBlocIds = array();
182        foreach ($arrBlocs as $index => $arrBloc) {
183            if ($arrBloc['anywhere'] == 1){
184                $arrUniqBlocIds[] = $arrBloc['bloc_id'];
185            }
186        }
187        foreach ($arrBlocs as $bloc_index => $arrBlocData) {
188            if (in_array($arrBlocData['bloc_id'], $arrUniqBlocIds) && $arrBlocData['anywhere'] == 0){
189                unset($arrBlocs[$bloc_index]);
190            }
191        }
192
193        return $arrBlocs;
194    }
195
196    /**
197     * ページ情報を削除する.
198     *
199     * XXX ファイルを確実に削除したかどうかのチェック
200     *
201     * @access public
202     * @param integer $page_id ページID
203     * @param integer $device_type_id 端末種別ID
204     * @return integer 削除数
205     */
206    function lfDelPageData($page_id, $device_type_id = DEVICE_TYPE_PC)
207    {
208        $objQuery =& SC_Query_Ex::getSingletonInstance();
209        // page_id が空でない場合にはdeleteを実行
210        if ($page_id != '') {
211            $arrPageData = $this->getPageProperties($device_type_id, $page_id);
212            $ret = $objQuery->delete('dtb_pagelayout', 'page_id = ? AND device_type_id = ?', array($page_id, $device_type_id));
213            // ファイルの削除
214            $this->lfDelFile($arrPageData[0]['filename'], $device_type_id);
215        }
216
217        return $ret;
218    }
219
220    /**
221     * ページのファイルを削除する.
222     *
223     * dtb_pagelayout の削除後に呼び出すこと。
224     *
225     * @access private
226     * @param string $filename
227     * @param integer $device_type_id 端末種別ID
228     * @return void // TODO boolean にするべき?
229     */
230    function lfDelFile($filename, $device_type_id)
231    {
232        $objQuery =& SC_Query_Ex::getSingletonInstance();
233
234        /*
235         * 同名ファイルの使用件数
236         * PHP ファイルは, 複数のデバイスで共有するため, device_type_id を条件に入れない
237         */
238        $exists = $objQuery->exists('dtb_pagelayout', 'filename = ?', array($filename));
239
240        if (!$exists) {
241            // phpファイルの削除
242            $del_php = HTML_REALDIR . $filename . '.php';
243            if (file_exists($del_php)) {
244                unlink($del_php);
245            }
246        }
247
248        // tplファイルの削除
249        $del_tpl = $this->getTemplatePath($device_type_id) . $filename . '.tpl';
250        if (file_exists($del_tpl)) {
251            unlink($del_tpl);
252        }
253    }
254
255    /**
256     * 編集可能ページかどうか.
257     *
258     * @access public
259     * @param integer $device_type_id 端末種別ID
260     * @param integer $page_id ページID
261     * @return 編集可能ページの場合 true
262     */
263    function isEditablePage($device_type_id, $page_id)
264    {
265        if ($page_id == 0) {
266            return false;
267        }
268        $arrPages = $this->getPageProperties($device_type_id, $page_id);
269        if ($arrPages[0]['edit_flg'] != 2) {
270            return true;
271        }
272
273        return false;
274    }
275
276    /**
277     * テンプレートのパスを取得する.
278     *
279     * @access public
280     * @param integer $device_type_id 端末種別ID
281     * @param boolean $isUser USER_REALDIR 以下のパスを返す場合 true
282     * @return string テンプレートのパス
283     */
284    function getTemplatePath($device_type_id = DEVICE_TYPE_PC, $isUser = false)
285    {
286        $templateName = '';
287        switch ($device_type_id) {
288            case DEVICE_TYPE_MOBILE:
289                $dir = MOBILE_TEMPLATE_REALDIR;
290                $templateName = MOBILE_TEMPLATE_NAME;
291                break;
292
293            case DEVICE_TYPE_SMARTPHONE:
294                $dir = SMARTPHONE_TEMPLATE_REALDIR;
295                $templateName = SMARTPHONE_TEMPLATE_NAME;
296                break;
297
298            case DEVICE_TYPE_PC:
299            default:
300                $dir = TEMPLATE_REALDIR;
301                $templateName = TEMPLATE_NAME;
302                break;
303        }
304        $userPath = USER_REALDIR;
305        if ($isUser) {
306            $dir = $userPath . USER_PACKAGE_DIR . $templateName . '/';
307        }
308
309        return $dir;
310    }
311
312    /**
313     * DocumentRoot から user_data のパスを取得する.
314     *
315     * 引数 $hasPackage を true にした場合は, user_data/packages/template_name
316     * を取得する.
317     *
318     * @access public
319     * @param integer $device_type_id 端末種別ID
320     * @param boolean $hasPackage パッケージのパスも含める場合 true
321     * @return string 端末に応じた DocumentRoot から user_data までのパス
322     */
323    function getUserDir($device_type_id = DEVICE_TYPE_PC, $hasPackage = false)
324    {
325        switch ($device_type_id) {
326        case DEVICE_TYPE_MOBILE:
327            $templateName = MOBILE_TEMPLATE_NAME;
328            break;
329
330        case DEVICE_TYPE_SMARTPHONE:
331            $templateName = SMARTPHONE_TEMPLATE_NAME;
332            break;
333
334        case DEVICE_TYPE_PC:
335        default:
336            $templateName = TEMPLATE_NAME;
337        }
338        $userDir = ROOT_URLPATH . USER_DIR;
339        if ($hasPackage) {
340            return $userDir . USER_PACKAGE_DIR . $templateName . '/';
341        }
342
343        return $userDir;
344    }
345
346    /**
347     * ブロックの php_path, tpl_path を設定する.
348     *
349     * @access private
350     * @param integer $device_type_id 端末種別ID
351     * @param array $arrBlocs 設定するブロックの配列
352     * @return void
353     */
354    function setBlocPathTo($device_type_id = DEVICE_TYPE_PC, &$arrBlocs = array())
355    {
356        foreach ($arrBlocs as $key => $value) {
357            $arrBloc =& $arrBlocs[$key];
358            $arrBloc['php_path'] = SC_Utils_Ex::isBlank($arrBloc['php_path']) ? '' : HTML_REALDIR . $arrBloc['php_path'];
359            $bloc_dir = $this->getTemplatePath($device_type_id) . BLOC_DIR;
360            $arrBloc['tpl_path'] = SC_Utils_Ex::isBlank($arrBloc['tpl_path']) ? '' : $bloc_dir . $arrBloc['tpl_path'];
361        }
362    }
363
364    /**
365     * カラム数を取得する.
366     *
367     * @access private
368     * @param array $arrPageLayout レイアウト情報の配列
369     * @return integer $col_num カラム数
370     */
371    function getColumnNum($arrPageLayout)
372    {
373        // メインは確定
374        $col_num = 1;
375        // LEFT NAVI
376        if (count($arrPageLayout['LeftNavi']) > 0) $col_num++;
377        // RIGHT NAVI
378        if (count($arrPageLayout['RightNavi']) > 0) $col_num++;
379
380        return $col_num;
381    }
382}
Note: See TracBrowser for help on using the repository browser.