配送プラグイン

<?php 
/**
 * Live Commerce, Open Source E-Commerce Solutions
 * http://www.live-commerce.com
 * Copyright (c) 2009 DigitalStudio Inc, http://www.ds-style.com
 *
 * 配送プラグイン sample
 *
 * カスタマイズについての詳細は以下を参照のこと。
 * http://www.live-commerce.com/wiki/index.php/配送プラグイン
 *
 * LICENSE: ライセンス情報
 *
 * @package  Live Commerce
 * @copyright  Copyright (c) 2009, DigitalStudio
 * @license    http://www.live-commerce.com/about/gpl/   GPL License
 * @version    $Id:$
 * @link       http://www.live-commerce.com
 * @since      File available since Release 1.0
 * @deprecated Class deprecated in Release 1.0
 */
 
class sample{
 
    /**
    * 注文時に送信するメール本文
    * @param string Ｅメール本文のテキストファイル名
    * @return 注文メールに転記される文言
    */
    public function getShippingEmailTxt($shipping_exact_folder){} 
 
    /**
    * 支払い手続き時に表示される配送プラグイン名
    * @param string 配送プラグインフォルダ名
    * @return 配送プラグイン名
    */
    public function getShippingName($shipping_exact_folder){}    
 
    /**
    * 支払い手続き時に表示される配送プラグイン説明文
    * @param string 配送プラグインフォルダ名
    * @return 配送プラグイン説明文
    */
    public function getShippingDesc($shipping_exact_folder){} 
 
    /**
    *  支払い手続き時に表示される配送プラグイン選択可能オプション
    * @param string
    * @param string
    * @return array
    * array($this->option_1($shipping_exact_folder, $PFN),$this->option_2($shipping_exact_folder, $PFN))
    */
    public function getShippingOption($shipping_exact_folder, $PFN){}
 
    /**
    * 支払い手続き時に表示される配送プラグインの選択可能オプション1つ目を返す。
    * 複数のオプションをセットする場合はこの関数を複製し、option_3, option_4..
    * としてget_shipping_optionにセットする。
    * @param bool true =>   false=>
    * @param string
    * @param array
    * array('option_label' => $option_label, 'option_type' => $option_type, 'option_name' => $option_name, 'option_value' => $option_value);
    */
    private function option1($shipping_exact_folder, $PFN, $only_label = false){}
    private function option2($shipping_exact_folder,$PFN,$only_label=false){}     
 
    /**
    * 支払い手続き時に表示される配送プラグイン選択可能オプションに対するjavascript
    * @param string
    * array($this->js_1($PFN),$this->js_2($PFN));
    */
    public function getShippingJs($PFN){}     
 
    /**
    * オプション1/オプション2のjavascript
    * @param string
    * @return array
    */
    private function js1($PFN){}    
    private function js2($PFN){}     
 
    /**
    * 合計送料を設定された通貨形式で出力する
    * @param string
    * @param string 配送プラグインフォルダ名
    * @return string 送料(c::convert_price(金額)) 
    */
    public function getShippingCost($return = false, $shipping_exact_folder = ""){}     
 
    /**
    * オプション1/オプション2送料を出力する
    * @param string 配送プラグインフォルダ名
    * @return int 送料
    */
    private function getShippingCost1($shipping_exact_folder = ""){}     
    private function getShippingCost2($shipping_exact_folder = ""){}     
 
    /**
    * 注文内容確認画面(checkout/confirmation)で表示される配送料金の表示をHTMLレンダリングする
    * @return array 
    * return array( 'label' => $label, 'value' => $cost, 'text' => $text, 'pfn' => $sessionHandler->shipping_plugin_display_CHKINFO['selected']);
    */
    public function getShippingKeyVal(){}     
 
    /**
    * 注文内容確認画面(checkout/confirmation)で表示される配送料金の表示をHTMLレンダリングする
    * @param string ラベル
    * @param string 値
    * @return string HTMLテキスト
    */
    public function getShippingDynamicHtml($label, $text){}     
 
    /**
    * 配送プラグインをo.php,chk_shipping_plugin()へセットする
    * @param string function名
    * @param string 値
    * @param string 配送プラグインフォルダ名
    * @return bool true/false
    */
    public function getShippingChk($request, $PFN, $shipping_exact_folder){}     
 
    private function chkOption_1($request, $PFN){}
    private function chkOption_2($request, $PFN){}     
 
    /**
    * 配送プラグインを支払い手続き画面に出力する最終形
    * @return array
    */
    public function getShippingDisplayInfo(){} 
}

<?php
/***************************************************************************
*   管理画面で管理するための関数を設定します。
*   管理機能が必要ない場合は、以下のソースコードの編集は必要ありません。
/***************************************************************************/
 
/**
 * プラグインが有効化されたときに実行したスクリプトを記述します。
 * プラグインを管理すためのデータベースが必要な場合は、クエリーを記
 * 述してテーブル作成を行います。
 * 実行するスクリプトがある場合は return true の前に記述します。
 * @param    none
 * @return    bool
 */
function invokeStart()
{
	return true ;
}
 
/**
 * invokeStartで実行するときに利用するファイルをインクルードします。
 * ファイルはlibフォルダに設置したファイル名を配列で登録します。
 * @param    none
 * @return    array
 */
function invokeStarterLibrary()
{
	//$lib = array('aaaa.php','bbb.php');
	return '';
}
 
/**
 * 管理画面のメニュータブにマウスオーバーした時にプルダウンメニューに
 * 表示される名称
 *
 * @param    none
 * @return    string
 */
function invokeRegisterPluginName()
{
	return 'デモプラグイン';
}
 
/**
 * 管理画面に表示されるメニュータブの位置
 * メニュー番号
 * 0 => ホーム  1=>商品管理  2=>注文管理  3=>顧客管理  4=>ページ管理  
 * 5=>サイト設定  6=>機能管理  7=>ローカライズ  8=>テーマ管理  9=>レポート
 *
 * プルダウンメニューに表示しない場合は空でよい。
 *    
 * @param    none
 * @return    array
 */
function invokeRegisterPlugin()
{
	//$Tab = array('6');
	//return $Tab;
}
 
/**
 * invokeOutputで実行するときに利用するJavascriptファイルをインクルードします。
 * ファイルはjsフォルダに設置したファイル名を配列で登録します。
 * @param    none
 * @return    array
 */
function invokeJs()
{
	$JS = array('');
	//$JS = array('aaaa.js','bbbb.js');
	return $JS;
}
 
/**
 * invokeOutputで実行するときに利用するCSSファイルをインクルードします。
 * ファイルはcssフォルダに設置したファイル名を配列で登録します。
 * @param    none
 * @return    array
 */
function invokeCss()
{
	$CSS = array('');
	//$CSS = array('aaaa.css','bbbb.css');
	return $CSS;
}
 
/**
 * invokeOutputで実行するときに利用するスクリプトファイルをインクルードします。
 * ファイルはlibフォルダに設置したファイル名を配列で登録します。
 *
 * @param    none
 * @return    array
 */
function invokeLibrary()
{
	$lib = array('');
	//$lib = array("constant.php","helper.php","action.php");
	return $lib;
}
 
/**
 * このプラグインを管理するためのAdmin用の設定表示画面のHTMLを登録します。
 * ファイルはlibフォルダに設置したファイル名を配列で登録します。
 *
 * @param    none
 * @return    string
 */    
function invokeOutput()
{
	return '' ;
	//return '<h3>基本設定</h3><div class="box">ここにHTMLタグを記述</div>';
}
 
/**
 * プラグインを無効にするときに利用するスクリプトファイルをインクルードします。
 * ファイルはlibフォルダに設置したファイル名を配列で登録します。
 * @param    none
 * @return    array
 */
function invokeStop_library()
{
	$lib = array('');
	//$lib = array("constant.php","helper.php","action.php");
	return $lib;
}
 
/**
 * プラグインが無効化されたときに実行したスクリプトを記述します。
 * データベースを作成した場合は、削除クエリーなどを記述します。
 * @param    none
 * @return    bool
 */
function invokeStop()
{
	return true ;
}
 
 
/**
 * invokeDevice
 *
 *  このプラグインの有効デバイスを指定する。この関数は省略可
 *  省略した場合は、PC,携帯のそれぞれでtrueとして返す(両デバイスで対応可）
 *  例）携帯のみに対応させる場合は $array = array('pc' => false,'mobile' => true, 'iPhone' => false);　とする。
 *
 * @param    none
 * @return    array
 */
function invokeDevice()
{
//このプラグインの利用端末先を判定する
    $array = array('pc' => true,'mobile' => true, 'iPhone' => true);
    return $array;
}