開発(PHP):リソースからURLを生成
リソースからURLを生成するには、$modx->makeURL
メソッドを使用します。
URLは基本的に、
サイトのURL(グローバル設定) + プレフィックス(グローバル設定) + サイトルートからリソースまでのパス + リソースのファイル名 + サフィックス(グローバル設定)
という形式で生成されます。
構文
戻り値 = $modx->makeURL(
リソースID,
エイリアス,
URLパラメータ,
スキーム,
ウェブリンクの除外
);
引数名 | 型 | 初期値 | 説明 | |
---|---|---|---|---|
第一引数 | リソースID | integer | URLを生成する元となるリソースのID。 空を指定するとサイトルートが割り当てられる。 |
|
第二引数 | エイリアス | string | 置き換えるパス。 第一引数で指定したリソースがコンテナかどうかによってサフィックスの付き方が変わる。 |
|
第三引数 | URLパラメータ | string | 付与するURLパラメータ(クエリ文字列)。 | |
第四引数 | スキーム | string | 'full' | 生成するURLの形式。 設定可能な値は次の通り。 full ... フルパスhttp ... プロトコルをhttpにしたフルパスhttps ... プロトコルをhttpsにしたフルパスabsolute ... ルート相対パスrelative ... 相対パス(サイトルートを除く) |
第五引数 | ウェブリンクの除外 | boolean | false | 対象のリソースがウェブリンクである場合は除外。true ... 除外するfalse ... 除外しない |
戻り値
生成に成功した場合は生成したURL、失敗した場合はfalseを返します。
サンプルコード
$url = $modx->makeURL($modx->documentIdentifier);