Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
Y
yii2
Project
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
PSDI Army
yii2
Commits
abda4a73
Commit
abda4a73
authored
Jan 13, 2015
by
Nobuo Kihara
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
docs/guide-ja/helper-url.md - added [ci skip]
parent
a7e06d84
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
184 additions
and
2 deletions
+184
-2
README.md
docs/guide-ja/README.md
+1
-1
helper-url.md
docs/guide-ja/helper-url.md
+182
-0
runtime-routing.md
docs/guide-ja/runtime-routing.md
+1
-1
No files found.
docs/guide-ja/README.md
View file @
abda4a73
...
@@ -194,5 +194,5 @@ RESTful ウェブサービス
...
@@ -194,5 +194,5 @@ RESTful ウェブサービス
*
[
概要
](
helper-overview.md
)
*
[
概要
](
helper-overview.md
)
*
[
ArrayHelper
](
helper-array.md
)
*
[
ArrayHelper
](
helper-array.md
)
*
[
Html
](
helper-html.md
)
*
[
Html
](
helper-html.md
)
*
**翻訳未着手**
[
Url
](
helper-url.md
)
*
[
Url
](
helper-url.md
)
docs/guide-ja/helper-url.md
0 → 100644
View file @
abda4a73
Url ヘルパ
==========
Url ヘルパは URL を管理するための一連のスタティックメソッドを提供します。
## よく使う URL を取得する <a name="getting-common-urls"></a>
よく使う URL を取得するために使うことが出来るメソッドが二つあります。
すなわち、ホーム URL と、現在のリクエストのベース URL を取得するメソッドです。
ホーム URL を取得するためには、次のようにします。
```
php
$relativeHomeUrl
=
Url
::
home
();
$absoluteHomeUrl
=
Url
::
home
(
true
);
$httpsAbsoluteHomeUrl
=
Url
::
home
(
'https'
);
```
パラメータが渡されない場合は、相対 URL が生成されます。
`true`
を渡すと、現在のスキーマの絶対 URL を取得することが出来ます。
または、スキームを明示的に指定して (
`http`
,
`https`
) 絶対 URL を取得することも出来ます。
現在のリクエストのベース URL を取得するためには、次のようにします。
```
php
$relativeBaseUrl
=
Url
::
base
();
$absoluteBaseUrl
=
Url
::
base
(
true
);
$httpsAbsoluteBaseUrl
=
Url
::
base
(
'https'
);
```
このメソッドの唯一のパラメータは、
`Url::home()`
の場合と全く同じ動作をします。
## URL を生成する <a name="creating-urls"></a>
与えられたルートへの URL を生成するためには、
`Url::toRoute()`
メソッドを使います。
このメソッドは、
[
[\yii\web\UrlManager
]
] を使って URL を生成します。
```
php
$url
=
Url
::
toRoute
([
'product/view'
,
'id'
=>
42
]);
```
ルートは、文字列として指定することが出来ます (例えば、
`site/index`
)。
または、生成される URL に追加のクエリパラメータを指定したい場合は、配列を使うことも出来ます。
配列の形式は、以下のようにしなければなりません。
```
php
// /index.php?r=site/index¶m1=value1¶m2=value2 を生成
[
'site/index'
,
'param1'
=>
'value1'
,
'param2'
=>
'value2'
]
```
アンカーの付いた URL を生成したい場合は、
`#`
パラメータを持つ配列を使うことが出来ます。例えば、
```
php
// /index.php?r=site/index¶m1=value1#name を生成
[
'site/index'
,
'param1'
=>
'value1'
,
'#'
=>
'name'
]
```
ルートは、絶対ルートか相対ルートかのどちらかです。
絶対ルートは先頭にスラッシュを持ち (例えば
`/site/index`
)、相対ルートは持ちません (例えば
`site/index`
または
`index`
)。
相対ルートは次の規則に従って絶対ルートに変換されます。
-
ルートが空文字列である場合は、現在の
[
[yii\web\Controller::route|ルート
]
] が使用されます。
-
ルートがスラッシュを全く含まない場合は (例えば
`index`
)、カレントコントローラのアクション ID であると見なされて、カレントコントローラの
[
[\yii\web\Controller::uniqueId|uniqueId
]
] が前置されます。
-
ルートが先頭にスラッシュを含まない場合は (例えば
`site/index`
)、カレントモジュールに対する相対ルートと見なされて、カレントモジュールの
[
[\yii\base\Module::uniqueId|uniqueId
]
] が前置されます。
バージョン 2.0.2 以降では、
[
エイリアス
](
concept-aliases.md
)
の形式でルートを指定することが出来ます。
その場合は、エイリアスが最初に実際のルートに変換され、そのルートが上記の規則に従って絶対ルートに変換されます。
以下に、このメソッドの使用例をいくつか挙げます。
```
php
// /index.php?r=site/index
echo
Url
::
toRoute
(
'site/index'
);
// /index.php?r=site/index&src=ref1#name
echo
Url
::
toRoute
([
'site/index'
,
'src'
=>
'ref1'
,
'#'
=>
'name'
]);
// /index.php?r=post/edit&id=100 エイリアス "@postEdit" は "post/edit" と定義されていると仮定
echo
Url
::
toRoute
([
'@postEdit'
,
'id'
=>
100
]);
// http://www.example.com/index.php?r=site/index
echo
Url
::
toRoute
(
'site/index'
,
true
);
// https://www.example.com/index.php?r=site/index
echo
Url
::
toRoute
(
'site/index'
,
'https'
);
```
もうひとつ、
[
[toRoute()
]
] と非常によく似た
`Url::to()`
というメソッドがあります。
唯一の違いは、このメソッドはルートを配列として指定することを要求する、という点です。
文字列が与えられた場合は、URL として扱われます。
最初の引数は、次のいずれかを取り得ます。
-
配列: URL を生成するために
[
[toRoute()
]
] が呼び出されます。例えば、
`['site/index']`
、
`['post/index', 'page' => 2]`
。
ルートの指定方法の詳細については
[
[toRoute()
]
] を参照してください。
on how to specify a route.
-
`@`
で始まる文字列: これはエイリアスとして扱われ、エイリアスに対応する文字列が返されます。
-
空文字列: 現在リクエストされている URL が返されます。
-
通常の文字列: その通りのものとして扱われます。
`$scheme`
(文字列または
`true`
) が指定された場合は、ホスト情報 (
[
[\yii\web\UrlManager::hostInfo
]
] から取得されます) を伴う絶対 URL が返されます。
`$url`
が既に絶対 URL であった場合には、そのスキームが指定されたものに置き換えられます。
下記にいくつかの用例を挙げます。
```
php
// /index.php?r=site/index
echo
Url
::
to
([
'site/index'
]);
// /index.php?r=site/index&src=ref1#name
echo
Url
::
to
([
'site/index'
,
'src'
=>
'ref1'
,
'#'
=>
'name'
]);
// /index.php?r=post/edit&id=100 エイリアス "@postEdit" が "post/edit" と定義されていると仮定
echo
Url
::
to
([
'@postEdit'
,
'id'
=>
100
]);
// 現在リクエストされている URL
echo
Url
::
to
();
// /images/logo.gif
echo
Url
::
to
(
'@web/images/logo.gif'
);
// images/logo.gif
echo
Url
::
to
(
'images/logo.gif'
);
// http://www.example.com/images/logo.gif
echo
Url
::
to
(
'@web/images/logo.gif'
,
true
);
// https://www.example.com/images/logo.gif
echo
Url
::
to
(
'@web/images/logo.gif'
,
'https'
);
```
バージョン 2.0.3 以降では、
[
[yii\helpers\Url::current()
]
] を使って、現在リクエストされているルートと GET パラメータに基づいて URL を生成することが出来ます。
`$params`
パラメータを渡して、GET パラメータの中のいくつかを修正したり削除したり、または新しい GET パラメータを追加したりすることが出来ます。
例えば、
Starting from version 2.0.3, you may use
[
[yii\helpers\Url::current()
]
] to create a URL based on the currently
requested route and GET parameters. You may modify or remove some of the GET parameters or add new ones by
passing a
`$params`
parameter to the method. For example,
```
php
// $_GET が ['id' => 123, 'src' => 'google'] であり、現在のルートが "post/view" であると仮定
// /index.php?r=post/view&id=123&src=google
echo
Url
::
current
();
// /index.php?r=post/view&id=123
echo
Url
::
current
([
'src'
=>
null
]);
// /index.php?r=post/view&id=100&src=google
echo
Url
::
current
([
'id'
=>
100
]);
```
## URL を記憶する <a name="remember-urls"></a>
URL を記憶して、後に続く一連のリクエストの一つを処理するときに、記憶した URL を使わなければならないという場合があります。
これは、次のようにして達成することが出来ます。
```
php
// 現在の URL を記憶する
Url
::
remember
();
// 指定された URL を記憶する。引数の形式は Url::to() を参照。
Url
::
remember
([
'product/view'
,
'id'
=>
42
]);
// 指定された名前で URL を記憶する。
Url
::
remember
([
'product/view'
,
'id'
=>
42
],
'product'
);
```
次のリクエストで、記憶された URL を次のようにして取得することが出来ます。
```
php
$url
=
Url
::
previous
();
$productUrl
=
Url
::
previous
(
'product'
);
```
## 相対 URL かどうかチェックする <a name="checking-relative-urls"></a>
URL が相対 URL であること、すなわち、URL がホスト情報の部分を持っていないことを確かめるために、次のコードを使うことが出来ます。
```
php
$isRelative
=
Url
::
isRelative
(
'test/it'
);
```
docs/guide-ja/runtime-routing.md
View file @
abda4a73
...
@@ -148,7 +148,7 @@ echo Url::to(['post/index'], 'https');
...
@@ -148,7 +148,7 @@ echo Url::to(['post/index'], 'https');
-
ルートが先頭にスラッシュを含まない場合は、カレントモジュールに対する相対ルートと見なされて、カレントモジュールの
[
[\yii\base\Module::uniqueId|uniqueId
]
] の値が前置されます。
-
ルートが先頭にスラッシュを含まない場合は、カレントモジュールに対する相対ルートと見なされて、カレントモジュールの
[
[\yii\base\Module::uniqueId|uniqueId
]
] の値が前置されます。
バージョン 2.0.2 以降では、
[
エイリアス
](
concept-aliases.md
)
の形式でルートを指定することが出来ます。
バージョン 2.0.2 以降では、
[
エイリアス
](
concept-aliases.md
)
の形式でルートを指定することが出来ます。
その場合は、エイリアスが最初に実際のルートに変換され、そのルートが上記の規則に従って絶対
的
ルートに変換されます。
その場合は、エイリアスが最初に実際のルートに変換され、そのルートが上記の規則に従って絶対ルートに変換されます。
例えば、カレントモジュールが
`admin`
であり、カレントコントローラが
`post`
であると仮定すると、
例えば、カレントモジュールが
`admin`
であり、カレントコントローラが
`post`
であると仮定すると、
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment