Helper
[ class tree: Helper ] [ index: Helper ] [ all elements ]
Packages:
EC-CUBE 2.11.4
Batch
DB
Graph
Helper
module
Page
SC
SC_Session
SC_SessionFactory
Util


Files:
SC_Helper_Customer.php
SC_Helper_DB.php
SC_Helper_Mail.php
SC_Helper_Mobile.php
SC_Helper_PageLayout.php
SC_Helper_Plugin.php
SC_Helper_Purchase.php
SC_Helper_Session.php

Classes:
SC_Helper_Customer
SC_Helper_DB
SC_Helper_Mail
SC_Helper_Mobile
SC_Helper_PageLayout
SC_Helper_Plugin
SC_Helper_Purchase
SC_Helper_Session

Class: SC_Helper_PageLayout

Source Location: /helper/SC_Helper_PageLayout.php

Class Overview




Webページのレイアウト情報を制御するヘルパークラス.




Author(s):


    
          
  • LOCKON CO.,LTD.
    • 
            





        
    

Version:


    
  
  • $Id:SC_Helper_PageLayout.php 15532 2007-08-31 14:39:46Z nanasess $
    • 



        






Methods
























Class Details



[line 31]

Webページのレイアウト情報を制御するヘルパークラス.





Tags:





  

    author:  LOCKON CO.,LTD.
  

  

    version:  $Id:SC_Helper_PageLayout.php 15532 2007-08-31 14:39:46Z nanasess $
  










[ Top ]








Class Methods




  

	
	
method getBlocPositions [line 153]

	

    

    

		array getBlocPositions(
integer
$device_type_id, integer
$page_id, [boolean
$has_realpath = true])
    

    


	
		ブロック配置情報を取得する.





Tags:





  

    return:  配置情報を含めたブロックの配列
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        integer  
        $device_type_id  
        端末種別ID
      

          

        integer  
        $page_id  
        ページID
      

          

        boolean  
        $has_realpath  
        php_path, tpl_path の絶対パスを含める場合 true
      

        

    


        
[ Top ]

  

  

	
	
method getBlocs [line 132]

	

    

    

		array getBlocs(
[integer
$device_type_id = DEVICE_TYPE_PC], [string
$where = ''], [array
$arrParams = array()], [boolean
$has_realpath = true])
    

    


	
		ブロック情報を取得する.





Tags:





  

    return:  ブロック情報の配列
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        integer  
        $device_type_id  
        端末種別ID
      

          

        string  
        $where  
        追加の検索条件
      

          

        array  
        $arrParams  
        追加の検索パラメーター
      

          

        boolean  
        $has_realpath  
        php_path, tpl_path の絶対パスを含める場合 true
      

        

    


        
[ Top ]

  

  

	
	
method getPageProperties [line 108]

	

    

    

		array getPageProperties(
[integer
$device_type_id = DEVICE_TYPE_PC], [integer
$page_id = null], [string
$where = ''], [array
$arrParams = array()])
    

    


	
		ページの属性を取得する.

この関数は, dtb_pagelayout の情報を検索する.  $device_type_id は必須. デフォルト値は DEVICE_TYPE_PC.  $page_id が null の場合は, $page_id が 0 以外のものを検索する.





Tags:





  

    return:  ページ属性の配列
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        integer  
        $device_type_id  
        端末種別ID
      

          

        integer  
        $page_id  
        ページID; null の場合は, 0 以外を検索する.
      

          

        string  
        $where  
        追加の検索条件
      

          

        array  
        $arrParams  
        追加の検索パラメーター
      

        

    


        
[ Top ]

  

  

	
	
method getTemplatePath [line 256]

	

    

    

		string getTemplatePath(
[integer
$device_type_id = DEVICE_TYPE_PC], [boolean
$isUser = false])
    

    


	
		テンプレートのパスを取得する.





Tags:





  

    return:  テンプレートのパス
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        integer  
        $device_type_id  
        端末種別ID
      

          

        boolean  
        $isUser  
        USER_REALDIR 以下のパスを返す場合 true
      

        

    


        
[ Top ]

  

  

	
	
method getUserDir [line 292]

	

    

    

		string getUserDir(
[integer
$device_type_id = DEVICE_TYPE_PC], [boolean
$hasPackage = false])
    

    


	
		DocumentRoot から user_data のパスを取得する.

引数 $hasPackage を true にした場合は, user_data/packages/template_name  を取得する.





Tags:





  

    return:  端末に応じた DocumentRoot から user_data までのパス
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        integer  
        $device_type_id  
        端末種別ID
      

          

        boolean  
        $hasPackage  
        パッケージのパスも含める場合 true
      

        

    


        
[ Top ]

  

  

	
	
method isEditablePage [line 237]

	

    

    

		編集可能ページの場合 isEditablePage(
integer
$device_type_id, integer
$page_id)
    

    


	
		編集可能ページかどうか.





Tags:





  

    return:  true
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        integer  
        $device_type_id  
        端末種別ID
      

          

        integer  
        $page_id  
        ページID
      

        

    


        
[ Top ]

  

  

	
	
method lfDelPageData [line 181]

	

    

    

		integer lfDelPageData(
integer
$page_id, [integer
$device_type_id = DEVICE_TYPE_PC])
    

    


	
		ページ情報を削除する.

XXX ファイルを確実に削除したかどうかのチェック





Tags:





  

    return:  削除数
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        integer  
        $page_id  
        ページID
      

          

        integer  
        $device_type_id  
        端末種別ID
      

        

    


        
[ Top ]

  

  

	
	
method sfGetPageLayout [line 49]

	

    

    

		void sfGetPageLayout(

&$objPage, [boolean
$preview = false], [string
$url = ""], [integer
$device_type_id = DEVICE_TYPE_PC], LC_Page
$objPage)
    

    


	
		ページのレイアウト情報を取得し, 設定する.

現在の URL に応じたページのレイアウト情報を取得し, LC_Page インスタンスに  設定する.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        LC_Page  
        $objPage  
        LC_Page インスタンス
      

          

        boolean  
        $preview  
        プレビュー表示の場合 true
      

          

        string  
        $url  
        ページのURL($_SERVER['PHP_SELF'] の情報)
      

          

        integer  
        $device_type_id  
        端末種別ID
      

          

          
        &$objPage  
        
      

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Fri, 24 Feb 2012 14:02:46 +0900 by Seasoft