Ditto - パラメータ

このエントリーをはてなブックマークに追加

パラメータ&プレースホルダ

基本的な項目だけ表示 全てを展開

&ditto_base

Ditto本体が置いてあるディレクトリ
オプション
Ditto's base path
デフォルト
[(base_path)]assets/snippets/ditto/
備考
末尾にスラッシュを含めます

&id

Dittoを識別するID
オプション
英数字&アンダーバー
デフォルト
None
備考
大文字と小文字は区別されます

&language

言語
オプション
$ditto_base/lang folder
デフォルト
Japanese-utf8

&format

出力フォーマット
オプション
html | json | xml | atom | rss
デフォルト
html

&config

Configファイル
オプション
default | CONFIG_NAME (configs folder or @FILE)
デフォルト
”default” - 空のデフォルトファイル
備考
ditto/configsフォルダの中に <name>.config.php で作成したものが使用できます。パラメータを直接PHPで記述つして処理をする事ができます
関連
&extenders

&extenders

機能拡張モード
オプション
extenders folder | @FILE
デフォルト
[NULL]
備考
ditto/extendersフォルダの中に <name>.extender.inc.php で作成したものが使用できます。
  • tagging - タグクラウド実装出来るようにします
  • dateFilter - 日付区切りでフィルタリングを行います。Reflectからの参照など。
  • request - URLパラメータをDittoの設定値として使用出来るようにします
関連
&config

&debug

デバッグモード
オプション
0 (off) | 1 (on)
デフォルト
0

&phx

Phx有効化
オプション
0 (off) | 1 (on)
デフォルト
1

&parents

( = &startID) フォルダ以下を取得する場合の親リソースID
オプション
カンマで区切られたID
デフォルト
現在のリソースID
備考
Supersedes &startID (only 1 value)
関連
&documents, &depth

&documents

特定のドキュメントを取得する場合のリソースID
オプション
Any container/document folder
デフォルト
None
備考
Overrides any setting in &parents
関連
&parents, &depth

&depth

取得する階層
オプション
positive integer
デフォルト
1
備考
ゼロなら無限に取得
関連
&parents, &documents, &seeThruUnpub

&paginate

ページネーションをする
オプション
0 (off) | 1 (on)
デフォルト
0
関連
&paginateAlwaysShowLinks, &paginateSplitterCharacter, &display, &total

&dateSource

[+date+]プレースホルダに使用するタイムスタンプ
オプション
UNIX形式のタイムスタンプ createdon, pub_date, editedon, or other TVs
デフォルト
[+createdon+]
関連
&dateFormat

&dateFormat

[+date+]プレースホルダに使用する日付フォーマット
オプション
PHPのstrftime関数
デフォルト
$_lang["dateFormat"]
関連
&dateSource

&display

( = &summarize) 表示する記事数
オプション
Number | `all`
デフォルト
`all`
備考
ゼロなら無限に取得
関連
&queryLimit, &total

&total

取得する最大数
オプション
Number | `all`
デフォルト
`all`
関連
&queryLimit, &display

&showPublishedOnly

公開リソースのみを表示
オプション
0 - all | 1 – published only
デフォルト
1
関連
&seeThruUnpub, &hideFolders, &where

&showInMenuOnly

メニューに表示リソースのみを表示
オプション
0 - all | 1 – menu only
デフォルト
0
関連
&seeThruUnpub, &hideFolders, &where, &hidePrivate

&hideFolders

フォルダを隠す
オプション
0 – keep folders | 1 – remove folders
デフォルト
0
関連
&seeThruUnpub, &showInMenuOnly, &where

&hidePrivate

閲覧の権限がないユーザーに対して記事を隠す
オプション
0 – show | 1 – hide
デフォルト
1
関連
&seeThruUnpub, &showInMenuOnly, &where

&seeThruUnpub

非公開フォルダの子リソースを表示するか
オプション
0 – hide | 1 – show
デフォルト
0
備考
Used when &depth is greater than 1
関連
&hideFolders, &showInMenuOnly, &where, &depth

&where

MySQLのWHERE文
オプション
A valid MySQL WHERE statement using only document fields (no TVs)
デフォルト
なし
関連
&queryLimit, &showPublishedOnly, &showInMenuOnly, &hidePrivate, &seeThruUnpub

&noResults

結果がない場合の表示テキスト
オプション
$_lang['no_documents'] | {{chunk}} | text
デフォルト
$_lang['no_documents']

&removeChunk

削除するチャンクコールがあれば指定します
オプション
カンマで区切られたチャンク名
デフォルト
false

&hiddenFields

フィールドに含まれるネストされたMODXタグの表示
オプション
カンマで区切られた項目の名前
デフォルト
false
備考
フィールドに記述されているリソース変数、テンプレート変数、プレースホルダで表示を許可するものを指定します。一部の[*id*]とかは元々許可されているもよう?

&start

特定の通し番号から表示を開始します
オプション
number
デフォルト
0
備考
ページネーションをしている場合ページを通して最初の記事数分だけがスキップされます

&filter

条件に一致する結果を除外します
オプション
`field,criteria,mode` 条件が複数ある場合 “|” で区切る
デフォルト
なし
備考
  • 1 - != 等しくない
  • 2 - == 等しい
  • 3 - < 未満なら(criteriaを含まない)
  • 4 - > 超えるなら(criteriaを含まない)
  • 5 - <= 以下なら
  • 6 - >= 以上なら
  • 7 - criteriaが含まれていない
  • 8 - criteriaが含まれている
  • 9 - criteriaが含まれていない(大文字小文字を区別しない)
  • 10 - criteriaが含まれている(大文字小文字を区別しない)
  • 11 - checks leading character of the field

&keywords

fetching of associated keywords, from [+keywords+] or as a tagData source
オプション
0 (off) | 1 (on)
デフォルト
0

&orderBy

検索結果の並び順
オプション
カンマで区切られたリスト
デフォルト
`createdon DESC`
備考
Supersedes &sortBy and &sortDir

&randomize

検索結果の並び順をランダムにする
オプション
0 (off) | 1 (on)
デフォルト
0

&save

他のスニペットで使用できるように結果のオブジェクトをプレースホルダに保存する
オプション
0 (off)-returns output | 1 (remaining)-returns output | 2 (save all) | 3 (save all)-returns placeholders only
デフォルト
0

&tpl

表示に使用するテンプレート
オプション
{{chunk_name}} | @CODE | @FILE
デフォルト
$_lang['default_template']
プレースホルダ
[+author+], [+title+], [+url+], [+ditto_iteration+], [+ditto_sort+]

[+author+]

リソースの作成者のフルネーム
備考
フルネームが登録されていない場合ユーザー名

[+title+]

リソース固有のページタイトル

[+url+]

リソース固有のページへのリンク

[+ditto_iteration+]

リソースの通し番号
備考
0から始まる通し番号 ページネーションをしている場合ページごとにリセットされます

[+ditto_sort+]

リソースの完全な通し番号
備考
0から始まる通し番号 ページネーションをしている場合ページを通した通し番号 ソートした場合のみ有効?

ページネーション用パラメータ&プレースホルダ

&paginateが1のときに使用可能です。
ページネーション用のグローバルなプレースホルダはDittoIDが付けられている場合[+dittoid_author+]などプレフィックスにIDを付ける必要があります

基本的な項目だけ表示 全てを展開

&paginateAlwaysShowLinks

ページがない場合でも次のページと前のページへのテキストを表示するか
オプション
0 (off) | 1 (on)
デフォルト
0

&paginateSplitterCharacter

ページ表示を分割する文字列
オプション
文字列
デフォルト
$_lang['button_splitter']

&tplPaginateNext

次のページがある場合のリンク用テンプレート
オプション
{{chunk_name}} | @CODE | @FILE
プレースホルダ
[+url+] | [+lang:next+]

&tplPaginateNextOff

次のページがない場合のテンプレート
オプション
{{chunk_name}} | @CODE | @FILE
プレースホルダ
[+lang:next+]

&tplPaginatePrevious

前のページへが有る場合のリンク用テンプレート
オプション
{{chunk_name}} | @CODE | @FILE
プレースホルダ
[+url+] | [+lang:previous+]

&tplPaginatePreviousOff

前のページがない場合のテンプレート
オプション
{{chunk_name}} | @CODE | @FILE
プレースホルダ
[+lang:previous+]

&tplPaginatePage

ページNoリスト用のテンプレート
オプション
{{chunk_name}} | @CODE | @FILE
プレースホルダ
[+url+] | [+page+]

&tplPaginateCurrentPage

現在のページNo用のテンプレート
オプション
{{chunk_name}} | @CODE | @FILE
プレースホルダ
[+page+]

[+next+]

次のページへのリンク

[+previous+]

前のページへのリンク

[+splitter+]

[+previous+] か [+next+] がアクティブな時に区切り文字を表示する
備考
[+previous+] か [+next+] がアクティブな時に&paginateSplitterCharacterで設定した区切り文字がセットされます

[+start+]

表示を開始した検索結果の番号

[+urlStart+]

number of current page as seen in URL query string (?start=[+urlStart+])

[+stop+]

表示を終了した検索結果の番号

[+total+]

全てのリソース数

[+pages+]

全てのベージリスト

[+currentPage+]

現在のページの表示

[+perPage+]

1ページに表示している記事数 (equal to &display)

[+totalPages+]

全てのページ数

[+ditto_pagination_set+]

ページネーションが有効になっている場合1がセットされます

extenders:tagging用パラメータ&プレースホルダ

&extenders=`tagging`
基本的な項目だけ表示 全てを展開

&tagDocumentID

タグ検索用ページのリソースID
オプション
リソースID
デフォルト
現在のリソースID

&tagData

タグデータとして使用するリソース変数まはテンプレート変数
オプション
カンマで区切られたリソース変数またはテンプレート変数のフィールド名
デフォルト
[NULL]

&caseSensitive

大文字小文字の区別
オプション
0 (off) | 1 (on)
デフォルト
0

&tagMode

タグのフィルタリング方法
オプション
  • onlyAllTags - タグをすべて持っているドキュメント
  • onlyTags - タグのいずれかを持っているドキュメント
  • removeAllTags - タグのすべてを持っていないドキュメント
  • removeTags - タグのいずれかを持っていないドキュメント
デフォルト
onlyTags

&tagDelimiter

&tagDataで各タグを分割している区切り文字
オプション
Any character not included in the tags themselves
デフォルト
” “ - space

&tagDisplayDelimiter

[+tagLinks+]で分割する区切り文字
オプション
文字列
デフォルト
&tagDelimiter

&tagSort

タグを昇順で並び替える
オプション
0 (off) | 1 (on)
デフォルト
1

&tagDisplayMode

[+tagLinks+]でタグを表示する方法
オプション
1 - &tagDisplayDelimiterで分割されたインラインのリンク
2 - UL/LIリスト
デフォルト
1

&tags

デフォルトでフィルタリングに使用するタグ
オプション
&tagDelimiterで区切られたタグリスト
デフォルト
[NULL]
備考
URLパラメータに含まれていなくても追加される

&tplTagLinks

[+tagLinks+]プレースホルダ用のカスタムテンプレート
オプション
{{chunk_name}} | @CODE | @FILE
デフォルト
<a href="[+url+]" class="ditto_tag" rel="tag">[+tag+]</a>

&tagCallback

Allow the user to modify both where the tags come from and how they are parsed.
オプション
Any valid function name
デフォルト
[NULL]
備考
The function should expect to receive the following three parameters

[+tagLinks+]

リンク付きのタグリスト
備考
&tpl内で使用可能になる&tagDocumentIDページへのリンクが付いた&tagDelimiterで区切ったタグリスト
関連
&tagDocumentID

[+tags+]

テキスト形式のタグリスト
備考
&tpl内で使用可能になる&tagDelimiterで区切ったタグリスト
関連
&tagDelimiter

extenders:dateFilter用パラメータ&プレースホルダ

&extenders=`dateFilter`
基本的な項目だけ表示 全てを展開

&dateFilterSource

フィルタリングを行う日付の取得方法
オプション
  • get - 「year」「month」「day」URLパラメータを使用します
  • params - スニペットコールの値を使用します
  • text - YYYY-MM-DD 形式になっている「text」URLパラメータを使用します
デフォルト
get
備考
URLを使用するならgetかtext スニペットで直接指定するならparams URLパラメータのプレフィックスにはDittoIDがつきます。

&dateSource

日付を検索するフィールド
オプション
UNIXタイムスタンプのフィールド名
デフォルト
createdon
備考
createdon, pub_date, editedon, その他テンプレート変数
関連
&dateFormat

&dateFilterDefault

パラメータがない場合デフォルトで現在の日時設定を使用する
オプション
  • 0 - なし
  • 1 - 現在の年をデフォルトにする
  • 2 - 現在の年月をデフォルトにする
  • 3 – 現在の年月日をデフォルトにする
デフォルト
0

&month

スニペットパラメータで取得する場合の月
オプション
1-12の月を表す数字
デフォルト
[NULL]
備考
&dateFilterSource=`params`の場合に指定します

&year

スニペットパラメータで取得する場合の年
オプション
4桁の西暦を表す数字
デフォルト
[NULL]
備考
&dateFilterSource=`params`の場合に指定します

&day

スニペットパラメータで取得する場合の日
オプション
日を表す数字
デフォルト
[NULL]
備考
&dateFilterSource=`params`の場合に指定します

[+year+]

取得した年

[+month+]

取得した月 英語表記
備考
Aprilなど

[+month_numeric+]

取得した月

[+day+]

取得した日

extenders:request用パラメータ&プレースホルダ

&extenders=`request`
基本的な項目だけ表示 全てを展開

&stripTags

パラメータの値からHTMLタグを取り除く
オプション
0 (off) | 1 (on)
デフォルト
1

&bad

許可しないパラメータ
オプション
カンマで区切られたDittoパラメータの名前
デフォルト
seeThroughtUnpub, showInMenuOnly, showPublishedOnly, debug, start, config, extenders, dittoID

&good

許可するパラメータ
オプション
カンマで区切られたDittoパラメータの名前
デフォルト
&bad に設定されたもの以外の全てのパラメータ

&dbg

Output variables being set
オプション
0 (off) | 1 (on)
デフォルト
0
Edited on 2016.12.21 Created on 2012.11.29
PAGE TO TOP