ソーシャルキャスト ヘルプセンター

一歩踏み込んだご利用方法、サポートに多く寄せられる質問などをまとめております。

socialcast独自のテンプレート関数

 

socialcastのテンプレートは、PHPテンプレートエンジンTwigを採用しています。
Twigの関数やフィルタを利用することができます。

 

  • Twigの関数、タグ等

Twigのリファレンスをご覧ください

 

また、開発フレームワークとしてPHPフレームワークLaravel 5.5を採用しており、rcrowe/TwigBridgeで使えるヘルパはすべて利用することができます。

 

  • Twig上で利用可能なLaravelの関数(ヘルパ)

rcrowe/TwigBridgeのリファレンスをご覧ください

 

 

socialcast独自のテンプレート関数(ヘルパ)に関しては、下記をご確認ください。

 

 

 

get_login_form


function get_login_form(?string $redirectTo = null)

 

概要

ログイン用フォームを取得する

 

引数

第一引数 $redirectTo

ログイン後に遷移させるURL、https://{{契約時にご案内したホスト}} から始まる必要があります

 

 

戻り値

ログインフォームのオブジェクト

 

使用例

任意のページにログインフォームを表示する

{{ form(get_login_form(url().current()))|raw }}

 

対応バージョン

4.0.0以降

 

 

 

get_freearea


function get_freearea(string $name)

 

概要

フリーエリアを表示する

 

引数

第一引数 $name

フリーエリア名

 

 

戻り値

フリーエリア本文

戻り値はキャッシュされます

 

使用例

任意の箇所にフリーエリアを表示する

{{ get_freearea('some-freearea')|raw }}

 

対応バージョン

4.0.0以降

 

 

 

get_latest_announces


function get_latest_announces(int $num=10)

 

概要

最新のお知らせを取得する

 

引数

第一引数 $num

取得する件数(最大10件まで取得可能)

 

 

戻り値

お知らせのコレクション(lluminate\Support\Collection)

 

使用例

最新のお知らせを5件取得してそのタイトルを表示する

{% for announce in get_latest_announces(5) %}
<p>{{announce.display_name}}</p>
{% endfor %}

 

対応バージョン

4.0.0以降

 

 

 

get_announces_pager


function get_announces_pager(array $condition, int $page = 1, int $size = 12)

 

概要

特定の条件のお知らせをページャで取得する

 

引数

第一引数 $condition

お知らせを取得するための条件

第二引数 $page

表示するページ数

第三引数 $size

1ページに表示する件数

 

戻り値

お知らせのページャ

 

使用例

お知らせを10件取得する

{% set paginator = get_announces_pager({}, input_get('page', 1), 10) %}

 

会員限定のお知らせを15件取得する

{% set paginator = get_announces_pager({search: {limit_type: [1]}}, input_get('page', 1), 15) %}

 

対応バージョン

4.0.0以降

 

 

 

get_categories


function get_categories()

 

概要

最上位カテゴリをすべて取得する

 

引数

 

戻り値

カテゴリのコレクション(lluminate\Support\Collection)

 

使用例

最上位カテゴリをすべて取得して表示名を出力する

{% for category in get_categories() %}

    {{category.display_name}}

{% endfor %}

最上位カテゴリとその子カテゴリをすべて取得して表示名を出力する

{% for category in get_categories() %}
{{category.display_name}}
{% for child in category.descendants %}
{{child.display_name}}
{% endfor %}
{% endfor %}

 

対応バージョン

4.0.0以降

 

 

 

get_latest_contents


function get_latest_contents(int $num = 10, array $categoryIds = [], $type = null, $limit_types=[0,1,2,3,4])

 

  • 概要
    • 最新のコンテンツとセットを取得する

 

引数

第一引数 $num
  • 取得する件数(最大10件まで取得可能)
第二引数 $categoryIds
  • カテゴリIDの配列。特定のカテゴリで絞り込む場合に使用
第三引数 $type

コンテンツまたはセットで縛りこむ場合に使用

● "single" を指定するとコンテンツのみを絞り込み可能

● "set" を指定するとセットのみを絞り込み可能

第四引数 $ limit_types

公開範囲で絞り込む場合に使用。配列として複数設定可能。

● 0 全体に公開

● 1 会員のみ公開

● 2 購入者のみ公開

● 3 見放題購入者のみ公開

● 4 セットの公開範囲に依存

 

戻り値

コンテンツとセットのコレクション(lluminate\Support\Collection)

 

使用例

最新のコンテンツとセットを10件取得

{% for content in get_latest_contents() %}

{# 任意の処理 #}
{% endfor%}

 

最新のセットを5件取得

{% for content in get_latest_contents(5, [], 'set') %}

{# 任意の処理 #}
{% endfor%}

 

IDが1と5のカテゴリが設定された最新のコンテンツを10件取得

{% for content in get_latest_contents(10, [1,5], 'single') %}

{# 任意の処理 #}
{% endfor%}

 

IDが1と5のカテゴリが設定された最新のコンテンツのうち公開範囲が「セットの公開範囲に依存」以外を10件取得

{% for content in get_latest_contents(10, [1,5], 'single', [0,1,2,3]) %}

{# 任意の処理 #}
{% endfor%}

 

対応バージョン

4.0.0以降

 

 

 

get_contents_pager


function get_contents_pager(array $condition, int $page = 1, int $size = 12)

 

概要

特定の条件のコンテンツとセットをページャで取得する

 

引数

第一引数 $condition

取得するための条件

第二引数 $page

表示するページ数

第三引数 $size

1ページに表示する件数

 

 

戻り値

コンテンツとセットのページャ

 

使用例

コンテンツとセットを1ページにつき30件取得する

{% set paginator = get_contents_pager({}, input_get('page', 1), 30) %}

セットだけを1ページにつき15件取得する

{% set paginator = get_contents_pager({search: {type: 'set'}}, input_get('page', 1), 15) %}

コンテンツだけを1ページにつき15件取得する

{% set paginator = get_contents_pager({search: {type: 'single'}}, input_get('page', 1), 15) %}

 

対応バージョン

4.0.0以降

 

 

 

get_favorites_pager


function get_favorites_pager(int $userId, int $page = 1, int $size = 12)

 

概要

任意の会員のお気に入りをページャで取得する

 

引数

第一引数 $userId

取得対象となる会員のID

第二引数 $page

表示するページ数

第三引数 $size

1ページに表示する件数

 

戻り値

お気に入りのページャ

 

使用例

ログイン中の会員のお気に入りを15件づつ取得する

{% set paginator = get_favorites_pager(auth_user().id, input_get('page', 1), 15) %}

 

対応バージョン

4.0.0以降

 

 

 

get_payment_history_pager


function get_payment_history_pager(int $userId, int $page = 1, int $size = 12)

 

概要

任意の会員の決済履歴をページャで取得する

 

引数

第一引数 $userId

取得対象となる会員のID

第二引数 $page

表示するページ数

第三引数 $size

1ページに表示する件数

 

戻り値

決済履歴のページャ

 

使用例

ログイン中の会員の決済履歴を15件づつ取得する

{% set paginator = get_payment_history_pager(auth_user().id, input_get('page', 1), 15) %}

 

対応バージョン

4.0.0以降

 

 

 

get_own_contents_pager


function get_own_contents_pager(int $userId, int $page = 1, int $size = 12)

 

概要

任意の会員の所有コンテンツをページャで取得する

 

引数

第一引数 $userId

取得対象となる会員のID

第二引数 $page

表示するページ数

第三引数 $size

1ページに表示する件数

 

戻り値

所有コンテンツのページャ

 

使用例

ログイン中の会員の所有コンテンツを15件づつ取得する

{% set paginator = get_own_contents_pager(auth_user().id, input_get('page', 1), 15) %}
 

対応バージョン

4.0.0以降

 

 

 

get_category_by_id

get_category_by_id($id) 

 

概要

引数で指定したIDを持つカテゴリーの情報を取得

 

引数

第一引数 $id 取得したいカテゴリのIDを指定する

 

戻り値

カテゴリーの情報

 

使用例

任意の個所にカテゴリ名と説明文を表示する

{{ get_category_by_id(1).display_name }}
{{ get_category_by_id(1).description }}

 

対応バージョン

4.4.6以降

 

 

 

get_category_by_name

get_category_by_name($name)

 

概要

引数で指定した識別子を持つカテゴリーの情報を取得

 

引数

第一引数 $name 取得したいカテゴリの識別子を指定する

 

戻り値

カテゴリーの情報

 

使用例

任意の個所にカテゴリ名と説明文を表示する

{{ get_category_by_name('test').display_name }}
{{ get_category_by_name('test').description }}

  

対応バージョン

4.4.6以降

 

 

 

get_content_by_id

get_content_by_id($id)

 

概要

引数で指定したIDを持つコンテンツの情報を取得

 

引数

第一引数 $id 取得したいコンテンツのIDを指定する

 

戻り値

コンテンツの情報

 

使用例

任意の個所にコンテンツの価格を表示する

{{ get_content_by_id(1).price }}

 

対応バージョン

4.4.6以降

 

 

 

get_set_content_by_id (id)

get_set_content_by_id($id)

 

概要

引数で指定したIDを持つセットの情報を取得

 

引数

第一引数 $id 取得したいセットのIDを指定する

 

戻り値

セットの情報

 

使用例

任意の個所にセットの価格を表示する

{{ get_set_content_by_id(2).price }}

 

対応バージョン

4.4.6以降

この記事は役に立ちましたか?
0人中0人がこの記事が役に立ったと言っています