source: branches/version-2_12-dev/data/class/helper/SC_Helper_PageLayout.php @ 22610

Revision 22610, 13.3 KB checked in by pineray, 11 years ago (diff)

#2176 pageクラスからdtb_blocテーブルを直接指定している箇所をなくす

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