開発(PHP):リソースからURLを生成
リソースからURLを生成するには、$modx->makeURLメソッドを使用します。
URLは基本的に、
サイトのURL(グローバル設定) + プレフィックス(グローバル設定) + サイトルートからリソースまでのパス + リソースのファイル名 + サフィックス(グローバル設定)
という形式で生成されます。
構文
1系
3系
引数(1系)
| 引数名 | 型 | 初期値 | 説明 | |
|---|---|---|---|---|
| 第一引数 必須 |
リソースID | integer | URLを生成する元となるリソースのID。 空を指定するとサイトルートが割り当てられる。 |
|
| 第二引数 | エイリアス | string | 空以外を指定すると、index.php?id=リソースID + 第三引数(URLパラメータ)を返す。 |
|
| 第三引数 | URLパラメータ | string | 付与するURLパラメータ(クエリ文字列)。 | |
| 第四引数 | スキーム | string | 'full' | 生成するURLの形式。 設定可能な値は次の通り。 full ... フルパスhttp ... プロトコルをhttpにしたフルパスhttps ... プロトコルをhttpsにしたフルパス |
| 第五引数 | ウェブリンクの除外 | boolean | false | 対象のリソースがウェブリンクである場合は除外。true ... 除外するfalse ... 除外しない |
引数(3系)
| 引数名 | 型 | 初期値 | 説明 | |
|---|---|---|---|---|
| 第一引数 必須 |
リソースID | integer | URLを生成する元となるリソースのID。 空を指定するとサイトルートが割り当てられる。 |
|
| 第二引数 | エイリアス | string | 空以外を指定すると、index.php?id=リソースID + 第三引数(URLパラメータ)を返す。 |
|
| 第三引数 | URLパラメータ | string | 付与するURLパラメータ(クエリ文字列)。 | |
| 第四引数 | スキーム | string | 生成するURLの形式。 設定可能な値は次の通り。 full ... フルパスhttp ... プロトコルをhttpにしたフルパスhttps ... プロトコルをhttpsにしたフルパス |
|
戻り値
生成に成功した場合は生成したURL、失敗した場合はfalseを返します。
サンプルコード
結果(1系)
https://www.example.co.jp/foo/bar/baz.html
結果(3系)
/foo/bar/baz.html