テンプレート

  1. ドキュメンテーション Home
  2. リファレンス
  3. テンプレート

リファレンス 

テンプレートで利用できる関数について

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

また、開発フレームワークとしてPHPフレームワーク"Symfony1.4"を採用しており、
Symfony1.4のヘルパ関数はすべて、Twigの関数として利用することができます

Socialcast独自のテンプレート関数に関しては、こちらをご確認ください

Twigの関数、フィルタ一覧

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

Symfony1.4のテンプレート関数（ヘルパ関数）一覧

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

Socialcast独自のテンプレート関数一覧

関数名をクリックすると、詳細な説明を確認できます

Socialcast独自のテンプレート関数詳細

app_url_for

(string) app_url_for($application, $route, $parameters = array(), $absolute = false)
概要
アプリケーションを指定して、URLを生成する
引数
$application アプリケーション名、'frontend','backend',または'api'
$route ルート名
$parameters ルートに引き渡すパラメータ
$absolute trueの場合は返り値がhttp://から始まるURL、falseの場合は/で始まる絶対パスになる
戻り値
対象ルートのURLまたは絶対パス

convert_unit_size

(string) convert_unit_size($value)
概要
引数の数値を'MB','GB'などの単位に換算して返します
引数
$value バイト数を表す数値(ex:1000, 5000..)
戻り値
換算された文字列(1MBに満たない場合は引数がそのまま戻ります)
利用例
1024バイトを換算する
{{convert_unit_size(1024)}}  // '1MB'

generate_pager_link

(string) generate_pager_link($uri, $page, $getParameters = array())
概要
ページネーション中のリンクを生成
引数
$uri ベースとなるuri
$page ページ数
$getParameters GET渡しで付加したいパラメータの連想配列
戻り値
指定したページ数のuri
利用例
cityカテゴリの4ページ目を生成する
{{generate_pager_link('/category/city', 4)}}  // '/category/city?page=4'

get_admin_mailaddress

(string) get_admin_mailaddress()
概要
メールアドレス送信設定画面で設定した管理者メールアドレスを取得
引数
なし
戻り値
管理者メールアドレス

get_auth_login_mail_address_form

(scAuthLoginFormMailAddress) get_auth_login_mail_address_form()
概要
ログインフォームオブジェクトを返す
引数
なし
戻り値
ログインフォームオブジェクト
利用例
ログインフォームを取得し、include_form関数で描画する
{{include_form(get_auth_login_mail_address_form())}}

get_base_url

(string) get_base_url()
概要
サイトのベースURL（≒TOPページのURL）を返す
引数
なし
戻り値
インストールした環境のベースURL（≒TOPページのURL）

get_class_name

(mixed) get_class_name($instance)
概要
引数の変数がインスタンスの場合、そのクラス名を返す
(php関数 get_class と同等)
引数
評価したい変数
戻り値
引数が何らかのインスタンスの場合、そのクラス名
その他の場合false(boolean)

get_freearea

(string) get_freearea($name)
概要
フリーエリア管理画面で設定したフリーエリアの本文を返す
引数
フリーエリアの名前
戻り値
フリーエリアの本文
利用例
ログイン前フリーエリア上部（PC）を取得してHTMLで表示する
{{get_freearea('pc_freearea_logoff_top')|raw}}

get_query_string

get_query_string($excludes = null)
概要
$_SERVER['QUERY_STRING'] から、$excludesで指定されたパラメータを除外して返す
引数
$excludes 除外するパラメータ名の配列
戻り値
フィルタリングされたクエリ文字列
利用例
?foo=bar&hoge=piyo から、hogeパラメータを削除する
{{get_query_string(['hoge'])}} // '?foo=bar'

get_root_categories

(Doctrine_Collection) get_root_categories()
概要
最上位カテゴリをすべて取得する
引数
なし
戻り値
カテゴリ(ProductsCategory)のコレクション
利用例
1 最上位カテゴリをすべて取得し、その名前を表示する
{% for category in get_root_categories() %}
  {% category.getDisplayName() %}<br>
{% endfor %}

2 最上位カテゴリをすべて取得し、その子カテゴリの名前を表示する

{% for category in get_root_categories() %}
    {% for child in category.getChilds() %}
      {% child.getDisplayName() %}<br>
    {% endfor %}
{% endfor %}

get_sitename

(string) get_sitename()
概要
サイト情報管理で設定したサイト名
引数
なし
戻り値
サイト名の文字列

get_subscription_name

get_subscription_name()
概要
月額見放題の設定で設定した月額見放題の名前
引数
なし
戻り値
月額見放題の名前

get_this_url

get_this_url($absolute = false)
概要
現在のページのURLを返す
引数
$absolute trueの場合は返り値がhttp://から始まるURL、falseの場合は/で始まる絶対パスになる
戻り値
現在のページのURL

get_time

(int) get_time()
概要
現在のUNIXタイムスタンプを返す
(php関数 time() と等価)
引数
なし
戻り値
実行時のUNIXタイムスタンプ

htmlescape_unhtmlescape

(string) htmlescape_unhtmlescape($sValue)
概要
引数に含まれる>,<,/を文字実体参照に変換して返す
引数
sValue 任意の文字列
戻り値
変換後の文字列

include_form

(string) include_form($form, $options = array())
概要
フォームをHTMLにして表示する
引数
$form フォームオブジェクト(sfFormを継承したクラスのインスタンス)
$options オプション
戻り値
対象のフォームのHTML表現

include_pager

(string) include_pager($pager, $options = array())
概要
ページネーションをHTMLにして表示する
引数
$pager ページャオブジェクト(sfDoctrinePagerを継承したクラスのインスタンス)
戻り値
ページネーションのHTML表現

instance_of

(bool) instance_of($instance, $className)
概要
$instance が $className のインスタンスであるか評価する
(php演算子 instanceof と同等)
引数
$instance 評価するインスタンス
$className クラス名
戻り値
$instance が $classNameのインスタンスならばtrue,そうでない場合はfalse

is_enable_comment

(bool) is_enable_comment()
概要
コメント管理画面の設定で、コメントが許可されているかどうか判別する
引数
なし
戻り値
コメントの投稿が許可されていればtrue、許可されていなければfalse

modifier_strip_tags

(string) modifier_strip_tags($sValue)
概要
引数の(HTML)文字列に含まれる改行コード、半角スペース(&nbsp;を含む)を除去する
引数
$sValue 任意の(HTML)文字列
戻り値
除去後の文字列

payment_plugin_is_enabled

(bool) payment_plugin_is_enabled()
概要
決済プラグインが有効になっているかどうか判定する
引数
なし
戻り値
決済プラグインが有効になっていればtrue、それ以外の場合はfalse
オンプレミス版、レンタル版ではプラグインが有効のためtrueが返ります
個人版ではプラグインが無効のためfalseが返ります

premium_member_plugin_is_enabled

(bool) premium_member_plugin_is_enabled()
概要
月額見放題プラグインが有効になっているかどうか判定する
引数
なし
戻り値
月額見放題プラグインが有効になっていればtrue、それ以外の場合はfalse
オンプレミス版、レンタル版ではプラグインが有効のためtrueが返ります
個人版ではプラグインが無効のためfalseが返ります

sc_config_get

(string) sc_config_get($name, $default = null)
概要
データベースの'site_config'テーブルの'name'カラムを$nameで検索し、'value'カラムの値を返す
引数
$name 検索文字列
$defalut 結果が存在しない場合に返すデフォルト値
戻り値
対象のレコードが存在する場合は、'value'カラムの値
存在しない場合は、デフォルト値

sc_format_date

(string) sc_format_date($date, $format = 'd', $culture = null, $charset = null)
概要
$dateの文字列をフォーマットして返す
引数
$date 日付文字列
$format フォーマットの種別
$culture 言語コード
$charset 文字コード
戻り値
フォーマットされた文字列

sc_image_tag_sf_image

sc_image_tag_sf_image($filepath, $options)
概要
画像のパスからimgタグを返す。画像ファイルが存在しない場合は、/images/no-image.gifになる
引数
$filepath 画像ファイルのパス
$options オプション symfony 1.4 のimage_tag_sf_image ヘルパ関数で利用可能なオプション
戻り値
imgタグ

sc_include_partial

sc_include_partial($templateName, $vars = array())
概要
パーツテンプレートを読み込む
引数
$templateName テンプレート名
$vars テンプレートに渡す変数
戻り値
パーツテンプレートを描画した結果のHTML文字列

sc_include_slot

sc_include_slot($name, $default = '')
概要
symfony 1.4 のslotヘルパ関数でセットしたスロットを描画する
引数
$name スロットの名前 $default スロットが見つからない場合のデフォルト値
戻り値
対象のスロットのHTML文字列

sf_config_get

sf_config_get($name, $default = null)
概要
symfonyの設定値を取得する(sfConfig::get() と同等)
引数
$name 設定値の名前
$default 設定値が存在しない場合のデフォルト値
戻り値
対象の設定値
利用例
'sf_web_dir'を参照する
{{sf_config_get('sf_web_dir')}} // '/path/to/socialcast/web'
  • Prev