gomymobi.com: 知識ベース

使用可能なストアクラス

組み込みクラスを格納する

- 私たちはすでに多くのビルトインクラスと事前定義されたオブジェクトを開発しています。これらのオブジェクトを使用してストアテーマを作成するだけで済みます。

- あなたのコンテキストに応じて、一部のオブジェクトは使用できません。例：製品のリスティングページでは、オブジェクト$ Productを使用して製品の詳細を照会することはできません。また、注文ページにいない限りオブジェクト$ Shop_Orderを使用することもできません。

- しかし、上記の例はまれです。基本的には、ストア内のどのページでもこれらのグローバルオブジェクトをすべて使用できます。しかし、あなた自身に注意してください。

$Shop = new Shop(アレイ $shop);

この宣言されたオブジェクトを使用して、ストアテーマの任意のページで使用できます。このオブジェクトには、ストア設定を操作するための便利なメソッドがすべて含まれています。

$shop ストアテーブルとサイトテーブルまたはショップIDの両方から取得したストア設定の配列

戻る: オブジェクト

例: ストアオブジェクトを定義する

// 現在のサイトがサブドメインまたはカスタムドメインを使用しているかどうかを検出する
$sql_where = strpos($_GET['site'], '.')>0 ? "S.domain='$_GET[site]'" : "S.subdomain='$_GET[site]'";
$db->_select("$PSZ_TABLE_STORES SHOP LEFT JOIN $PSZ_TABLE_SITES S ON S.shop_id=SHOP.id", 'SHOP.*, S.domain, S.subdomain', $sql_where);
if( NULL == ($shop=$db->get_result(1)) )
  error_wrong_usage('../');

$Shop = new Shop($shop);

get(文字列 $attr)

ストアの属性（データベーステーブルフィールド）を返します。チェックアウト店舗一覧あなたが得るかもしれない分野のために; Paypalの属性を使用すると、以下を使用することができます。 paypal_sandbox, paypal_email, paypal_prefix, paypal_pdt.

戻る: 文字列/数値

例

// 店主のメールを受け取る
echo $Shop->get('email');

// 店主のPaypalメールを受け取る
echo $Shop->get('paypal_email');

// すべての商品のための店舗のフラット送料を得る
echo $Shop->get('shipping_cost');

// 店舗の開店の状態を取得する
echo $Shop->get('status'); // 1 または 0

getDate(タイムスタンプ $time)

ストア所有者の設定から日付形式の書式付きタイムスタンプの文字列を返します。

$time タイムスタンプ

戻る: 文字列

getFavicon()

店舗のfavicon URLを返します。

戻る: 文字列

getPayments()

店舗支払い設定の配列を返します。

戻る: アレイ

例

var_export($Shop->getPayment());

array (
  'bacs' => array (
    'enable' => '1',
    'title' => 'Direct Bank Transfer',
    'description' => 'Make your payment directly into our bank account. Please use your Order ID as the payment reference. Your order will not be shipped until the funds have cleared in our account.',
    'accounts' => 
    array (
      0 => 
      array (
        'name' => 'Ticket Account Holder 1',
        'number' => '223344',
        'bank' => 
        array (
          'name' => 'Bank Name 1',
          'code' => 'CODE1',
          'iban' => '',
          'swift' => 'SWIFT1',
        ),
      ),
      1 => 
      array (
        'name' => 'Ticket Account Holder 2',
        'number' => '445566',
        'bank' => 
        array (
          'name' => 'Bank Name 2',
          'code' => 'CODE2',
          'iban' => 'IBAN2',
          'swift' => 'SWIFT2',
        ),
      ),
    ),
  ),
  'paypal' => array (
    'enable' => '1',
    'sandbox' => '1',
    'title' => 'PayPal',
    'description' => 'Pay via PayPal; you can pay with your credit card if you do not have a PayPal account',
    'email' => 'billing@gomymobi.com',
    'pdt' => '5tzXORMp-DzzyAdTsl1QmX3QSc7h1mJDtpHYqb58Ce2jhVoz4Rpm-TKPfUi',
    'prefix' => 'GTICKET-6717-',
  ),
  'cod' => array (
    'enable' => '1',
    'title' => 'Cash on Delivery',
    'description' => 'Pay with cash upon delivery.',
  ),
)

getLogo()

店舗のロゴURLを返します。

戻る: 文字列

getURL()

店舗のURLを返します。

戻る: 文字列

例

echo $Shop->getURL();

/*
サブドメインまたはサブフォルダとユーザーのサイト設定に関するシステムベースの設定を行うには、以下のいずれかの結果を返します。

http://www.user-custom-domain.com/shop-slug/
http://site-sub-domain.gomymobi.com/shop-slug/
http://www.gomymobi.com/app/sites/site-sub-domain/shop-slug/
*/

Price(数 $price = 0)

ストア通貨の設定に基づいて、フォーマットされた価格の文字列を返します。

戻る: 文字列

echo $Shop->Price(30.895);

/*
通貨に関する店舗ベースの店舗設定では、以下のいずれかの結果を返します。

30$
$30
30.9$
$30.895
*/

$Shop_Categories = new Shop_Categories(アレイ $categories);

この宣言されたオブジェクトを使用して、ストアテーマの任意のページで使用できます。このオブジェクトには、ストアのすべてのカテゴリの階層構造が含まれています。

$categories 両方のカテゴリテーブルからフェッチしたストアのすべてのカテゴリの配列。または、NULLまたは空を渡すことができますが、このクラスは現在のストアを自動的に取得します。

戻る: オブジェクト

例: テーブルからすべてのカテゴリを取得し、ストアカテゴリのオブジェクトを定義する

$db->_select($PSZ_TABLE_STORE_CATEGORIES, 'id, name, slug, icon, parent, description', "active=1 AND shop_id=" . $Shop->get('id') . " AND user_id=" . $Shop->get('user_id'), "ORDER BY sorting DESC, created_time ASC");
if( NULL == ($categories = $db->get_result()) )
  $Shop_Categories = new Shop_Categories($categories);

例: 最高のシンプルなソリューション

$Shop_Categories = new Shop_Categories();

上記の2つのソリューションは、以下のようなデータを持つオブジェクトを返します

Shop_Categories::__set_state(array(
   'categories' => array (
      0 => Shop_Category::__set_state(array(
           'id' => '1',
           'icon' => NULL,
           'name' => '3D',
           'slug' => '3d',
           'description' => '',
           'childs' => array(),
           'popular' => NULL,
           'parent' => '0',
        )),
      1 => Shop_Category::__set_state(array(
           'id' => '2',
           'icon' => NULL,
           'name' => 'IMAX',
           'slug' => 'imax',
           'description' => '',
           'childs' => array (),
           'popular' => NULL,
           'parent' => '0',
      )),
      2 => Shop_Category::__set_state(array(
           'id' => '3',
           'icon' => NULL,
           'name' => 'Genre',
           'slug' => 'genre',
           'description' => '',
           'childs' => array (
              0 => Shop_Category::__set_state(array(
                 'id' => '4',
                 'icon' => NULL,
                 'name' => 'Action',
                 'slug' => 'action',
                 'description' => '',
                 'childs' => array(),
                 'popular' => NULL,
                 'parent' => '3',
              )),
              1 => Shop_Category::__set_state(array(
                 'id' => '5',
                 'icon' => NULL,
                 'name' => 'Horror',
                 'slug' => 'horror',
                 'description' => '',
                 'childs' => array(),
                 'popular' => NULL,
                 'parent' => '3',
              )),
            ),
           'popular' => NULL,
           'parent' => '0',
      )),
    ),
   'length' => 3,
))

getAll()

階層構造でオブジェクトの配列（ストアのアクティブなカテゴリ）を返します。

戻る: オブジェクトの配列

例: このオブジェクトを使用して階層メニューバーを作成することができます

if( $Shop_Categories->length>0 )
{
  // すべてのカテゴリを取得するループ
  foreach ($Shop_Categories->getAll() as $cat) {
    $pTemplate->assign_block_vars('menu_category_top_nav', array(
      // カテゴリプロパティに直接アクセス
      'NAME'      => $cat->name,
      'SLUG'      => $cat->slug,
      'ICON'      => is_image($cat->icon) ? '<img class="category-icon" src="' . $cat->icon . '"/>' : '<i class="' . $cat->icon . '"></i>',

      // 訪問者があるカテゴリにいる場合は、それをアクティブとマークします
      'ACTIVE'    => $Shop_Current_Category!=NULL && $Shop_Current_Category->slug==$cat->slug ? 'active' : '',

      'HAS_CHILD' => count($cat->childs) ? true : false,

      // 可能であれば、このカテゴリの子を構築する
      'CHILDS'    => get_html_menu_childs($cat->childs),
    ));
  }
}

$Shop_Current_Category = new Shop_Category(アレイ $category);

If this defined object $Shop_Current_Category is not NULL, indicate visitors are viewing some store category. And you may access all properties of this object directly, please check its properties (table fields).

$category カテゴリテーブルからフェッチされたすべてのカテゴリプロパティ（テーブルフィールド）の配列。または、カテゴリのユニークなスラッグを使用することができます

戻る: オブジェクト/ NULL

例: あるカテゴリのオブジェクトを定義する

$db->_select($PSZ_TABLE_STORE_CATEGORIES, 'id, name, slug, icon, parent, description', "active=1 AND shop_id=" . $Shop->get('id') . " AND user_id=" . $Shop->get('user_id') . " AND slug='some-category-slug'");
  if( NULL != ($result=$db->get_result(1)) )
    $Shop_Current_Category = new Shop_Category($result);

addChild(Shop_Category $category_object)

現在のカテゴリオブジェクトにいくつかのカテゴリオブジェクトを階層構造として追加します。

$category_object あなたが子供として追加したいいくつかのカテゴリのオブジェクト

$Shop_Pages = new Shop_Pages();

このオブジェクトには、ストアのすべてのアクティブなページが含まれています。このオブジェクトは店舗のどこでも使用できます。

戻る: オブジェクト/ NULL

get(Int &$id)

ストアページのオブジェクトをページIDで返します。

$id ページのID値を取得する必要があります

戻る: オブジェクト/ NULL

getAll()

ストアページオブジェクトの配列を返します。

戻る: オブジェクトの配列

Shop_Page(アレイ $page)

このクラスを使用すると、ページのオブジェクトを宣言できます。

$page array of store page properties (table fields) fetched from page table. Or you may use ID (number) of page

戻る: オブジェクト/ NULL

Price()

このメソッドは、購入者が販売または購読料（サブスクリプション製品の場合）で計算した後に支払う必要のある最終価格を返します。このメソッドは、チェックアウトページで使用されます。

戻る: 数

Purchase_Price()

このメソッドは、購買手数料を計算した後、購入者が支払う必要がある最終的な価格を返します。このメソッドは、fprサブスクリプション製品のみに使用されます。

戻る: 数

Get_Price(ブール $short = false)

製品価格の文字列を返します。フィルタを適用することができます get_price 最終結果をフォーマットする。

$short 短い形式の価格を表示

戻る: 文字列

例: 製品が単一の場合、結果の1つをエコーする

echo $Product->Get_Price();

// 30$
// <strike class='font-xs'>30$</strike> <b>19$</b>
// レギュラー: <strike>30$</strike><br/>販売: <b>19$</b>

例: 商品がグループの場合

echo $Product->Get_Price();

// 30$ <i class="fa fa-long-arrow-right"></i> 50$

例: 製品がサブスクリプションの場合、以下のようにエコーします

echo $Product->Get_Price();

// 9$ / 6か月間
// 3$ 前向きに 9$ / 無料トライアル1週間後
// 0$ 前向きに 9$ / 無料トライアル1ヶ月後の1か月

例: フィルタを適用する

// functions.phpに以下のフィルタ関数を追加する
function get_price_format($price) {
  $price = str_replace('strike', 'small', $price);
  $price = str_replace('<i class="fa fa-long-arrow-right"></i>', 'to', $price);
  $price = str_replace('Free Trial', 'FREE period', $price);
  return $price;
}
add_filter('get_price', 'get_price_format');

echo $Product->Get_Price();

// 製品が単一の場合
// 30$
// <small class='font-xs'>30$</small> <b>19$</b>
// レギュラー: <small>30$</small><br/>販売: <b>19$</b>

// 商品がグループの場合
// 30$ to 50$

// 製品が定期購入の場合
// 3$ 前向きに 9$ / 1週間後の無料期間

Get_Relates(Int $number = 8)

関連する製品オブジェクトを含む配列を返します。これらの類似製品は製品名に基づいて計算されます。

$number デフォルトでは、関連する8つの製品のみを取得します

戻る: オブジェクトの配列

Get_Childs()

子プロダクトを含むオブジェクトの配列を返します。このメソッドは、商品がグループの場合に使用されます。 productがグループでない場合はFALSEを返し、子がない場合はNULLを返し、子を返します。

戻る: オブジェクトの配列/ NULL / FALSE

Get(文字列 $attr)

Return an attribute (table field) of product. Beside, this method also accepts some extra attributes for accessing easier.

$attr 属性は検索したい、追加の属性

featured_image 製品の特徴イメージ

tags 製品のすべてのタグ、存在する場合はタグの配列を返す

戻る: 配列/文字列

is(文字列 $type)

製品が本当に何かであるかどうかを検出します。

$type 属性は検出可能な値を検出したい:

saleoff 商品が売り切れかどうかを確認する（割引）
new 製品が新しい場合はTRUEを返します。
instock 製品がまだ在庫切れの場合はTRUEを返します
outstock 製品が在庫切れの場合はTRUEを返します
group 製品がグループであるかどうかを検出する
subscription 製品がサブスクリプションかどうかを確認する
single 製品がシングルであるかどうかを確認する
digital 製品がデジタルであるかどうかを確認する

戻る: 正誤

List_Products(文字列 $type = '',文字列 $condition = '',Int $number = 10,ブール $parent = false)

このクラスは、ルールと条件でフィルタリングされた商品を一覧表示するために使用されます。

$type あなたが適用する必要があるメインフィルター。デフォルトでは、このクラスは新しい製品を返します。許容値:

featured 注目商品のみを選択
discounted 割引または売り切れの商品を選択する
childs 使用される製品の子供を選ぶ $condition 親のIDです
cart 製品をカートに入れ、一緒に使用する $condition 製品IDの配列です
relate 関連製品を選び、 $condition 現在の製品のIDと名前の配列です
order_add_item 店主の許可を得た注文管理ページで使用される、注文に追加する商品の検索

$condition 応募条件

$number 取得する製品の数を制限する。既定では、10個の製品のみを取得します

$parent TRUEの場合、グループに属していない製品を選択します

戻る: オブジェクトの配列/ NULL

例

// 新製品を入手する
$New_Products = new List_Products();

// 新しい10の製品を得る
$New_Products = new List_Products('', '', 10);

// 名前や説明に文字列「VIP」を含む新製品を入手する
$New_Products = new List_Products('', 'VIP');

// おすすめ商品を入手する
$Item_Featured = new List_Products('featured');

// トップ10の割引商品を取得する
$Item_Discounted = new List_Products('discounted', '', 10);

// カート内の商品を入手し、カート＆チェックアウトのページで使用する
$Cart_Items = new List_Products('cart');

// この長いソリューションを使用する
$Cart_Items = new List_Products('cart', array_keys($_COOKIE[ $shop_cookie_name ]['cart']) );

// 訪問者が検索機能を使用するときに10の商品を取得し、価格降順でソートする
$Items = new List_Products("price DESC", $keyword, 10);

// 時間の降順で商品を入手する
$Items = new List_Products("time DESC");

// 人気のある商品を入手する
$Items = new List_Products("pageviews DESC");

// 現在の商品の関連商品を取得する
$Items = new List_Products('relate');

// この長いソリューションを使用する
$Items = new List_Products('relate', 
    array('id' => $Product->get('id'), 'name' => $Product->get('name'))
);

// 現在の製品の子供たちを得る
$Items = new List_Products('childs');

// この長いソリューションを使用する
$Items = new List_Products('childs', $Product->get('id'));

if( $Items->length>0 )
{
  // あなたの仕事をここで処理する
}

Total(文字列 $type = '',文字列 $keyword = '')

この静的メソッドは、ルールと条件で商品を数えます。

$type main filter to count, you may check table fields for futher usage, acceptable defined values:

featured すべての注目商品を数えます
discounted すべての割引商品を数えます

戻る: 正誤

例

// すべての注目商品を数えます
echo List_Products::Total('featured');

// すべての割引商品を数えます
echo List_Products::Total('discounted');

// 名前または説明に文字列 \'VIP\'を含むすべての商品を数えます
echo List_Products::Total('', 'VIP');

// サブスクリプションを含むすべての製品をカウントする
echo List_Products::Total("item_type='subscription'");

// ダウンロード可能なすべての製品を数える
echo List_Products::Total("downloadable=1");

// 未発行（起草済み）の製品をすべてカウントする
echo List_Products::Total("published_time=0");

// すべての売却（割引）商品を数えます
echo List_Products::Total("price_sale>0");

// サブスクリプションと無料試用版のすべての製品を数える
echo List_Products::Total("signup_fee>0");

get(Int &$id)

現在のリストにある製品のオブジェクトを返します。

$id 取得する必要がある商品のID値

戻る: オブジェクト/ NULL

getAll()

現在のリスト内の製品オブジェクトの配列を返します。

戻る: オブジェクトの配列

getIDs()

現在のリストにある製品IDの配列を返します。

戻る: アレイ

Shop_Order(アレイ $order_properties)

ストアオーダーのオブジェクトを返します。

$order_properties array of all order properties (table fields) fetched from order table. Or you may use order ID value

戻る: オブジェクト/ NULL

例

// ストアオーダーを取得する
$Shop_Order = new Shop_Order($order_id);

// この長いソリューションを使用する
$db->_select(
  $PSZ_TABLE_STORE_ORDERS, '*',
  "`shop_id`=? AND `user_id`=? AND `key`=?",
  array($Shop->get('id'), $Shop->get('user_id'), $order_key)
);
if( NULL != ($order=$db->get_result(1)) )
  $Shop_Order = new Shop_Order($order);

is(文字列 $type)

注文が本当に何かであるかどうかを検出します。

$type 属性は検出可能な値を検出したい:

subscription 注文がサブスクリプションかどうかを確認する
shipping 注文が有形のアイテムを出荷する必要があるかどうかを確認する
suspended 注文が一時停止されている場合はTRUEを返します
downloadable 注文にダウンロード可能なファイルがある場合はTRUEを返します

戻る: 正誤

Subscription_Price(ブール $short = false)

ストア通貨の設定に基づいて、フォーマットされた価格の文字列を返します。この方法は、カート、注文ページ、注文ページの注文総額を表示するために使用されました。計算目的ではなく目的を表示するためのものです。

つかいます $Shop_Order->get('purchase_price') 購読価格を取得したい場合、または計算する場合。

$short TRUEの場合、短い形式を返す

戻る: 文字列

get(文字列 $attr, 文字列 $option = '')

注文の属性（データベーステーブルフィールド）を返します。チェックアウト注文の表あなたが得るかもしれないフィールドのために。.

$attr 属性を取得したい。テーブルフィールドの横に、これらの定義された属性を使用することもできます:

date 作成された注文日を検索し、結果は店主の日付書式設定でフォーマットされます
date_completed 注文の完了日（払い出された日付）を検索し、結果は店主の日付フォーマット設定によってフォーマットされる
items 第2のパラメータと共に使用される製品のリストを順番に返す $option
count 製品の合計を返す
list 製品の文字列を返す、各製品へのリンクと購入数を含める
id 製品IDの配列を返す
default 製品の戻り値の配列
files ダウンロード可能なファイルの配列を順番に取得するか、または設定されている場合にのみファイル数を返します。 $option = 'count'
buyer_name バイヤーの完全な名前を返す
buyer_email バイヤーの電子メールへのリンクまたは第2パラメータが設定されている場合にのみ電子メールを返す $option = 'raw'
buyer_phone 買い手の電話番号または電話番号へのリンクを返すのは、2番目のパラメータが設定されている場合のみです $option = 'raw'
ship_fullname 発送人の氏名を返す
ship_fax 出荷された人のファックスを返す
ship_company 出荷された人の返品会社
ship_email 出荷された人の電子メールへのリンクまたは第2のパラメータが設定されている場合にのみ電子メールを返す $option = 'raw'
ship_phone 第2パラメータが設定されている場合に限り、出荷された人の電話番号または電話番号へのリンクを返す $option = 'raw'
ship_address 返送先住所
payment_method 戻り値メソッドの選択された支払いまたはスラッグの名前が設定されている場合2番目のパラメータ $option = 'key'
payment_guide 選ばれた方法の支払いガイドを返す
paypal_link 注文が未払いで支払い方法がPaypalの場合、Paypalへのリンクを返す

$option 追加のオプションを取得する必要があります

戻る: 文字列