Skip to content

Commit

Permalink
Merge pull request #290 from KazuyaUchida/fix-tutorial
Browse files Browse the repository at this point in the history
チュートリアルの記載修正
  • Loading branch information
koriym authored Nov 1, 2024
2 parents ae67879 + f4e0730 commit 8c721bd
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 15 deletions.
6 changes: 3 additions & 3 deletions manuals/1.0/en/50.tutorial2.md
Original file line number Diff line number Diff line change
Expand Up @@ -338,11 +338,11 @@ use Ray\MediaQuery\Annotation\DbQuery;

interface TicketQueryInterface
{
#[DbQuery('ticket_item']
#[DbQuery('ticket_item')]
public function item(string $id): Ticket|null;

/** @return array<Ticket> */
#[DbQuery('ticket_list']
#[DbQuery('ticket_list')]
public function list(): array;
}
```
Expand Down Expand Up @@ -887,4 +887,4 @@ Applications should aim for evolvability without breaking development efficiency
[^11]: It is a widespread misconception that the Uniform Interface is not an HTTP method. See [Uniform Interface](https://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm).
[^12]: [https://www.iana.org/assignments/media-types/media-types.xhtml](https://www.iana.org/assignments/media-types/media-types.xhtml)
[^13]: This SQL conforms to the [SQL Style Guide](https://www.sqlstyle.guide/). It can be configured from PhpStorm as [Joe Celko](https://twitter.com/koriym/status/1410996122412150786).
The comment is not only descriptive, but also makes it easier to identify the SQL in the slow query log, etc.
The comment is not only descriptive, but also makes it easier to identify the SQL in the slow query log, etc.
15 changes: 7 additions & 8 deletions manuals/1.0/ja/50.tutorial2.md
Original file line number Diff line number Diff line change
Expand Up @@ -336,11 +336,11 @@ use Ray\MediaQuery\Annotation\DbQuery;

interface TicketQueryInterface
{
#[DbQuery('ticket_item']
#[DbQuery('ticket_item')]
public function item(string $id): Ticket|null;

/** @return array<Ticket> */
#[DbQuery('ticket_list']
#[DbQuery('ticket_list')]
public function list(): array;
}
```
Expand Down Expand Up @@ -374,12 +374,12 @@ interface TicketCommandInterface
メソッドの返り値に`array`を指定すると、データベースの結果はそのまま連想配列と得られますが、メソッドの返り値にエンティティの型を指定すると、その型にハイドレーションされます。

```php
#[DbQuery('ticket_item']
#[DbQuery('ticket_item')]
public function item(string $id): array // 配列が得られる
```

```php
#[DbQuery('ticket_item']
#[DbQuery('ticket_item')]
public function item(string $id): Ticket|null; // Ticketエンティティが得られる
```

Expand Down Expand Up @@ -416,7 +416,7 @@ class Ticket

リソースクラスはクエリーインターフェイスに依存します。

## tikcetリソース
## ticketリソース

`ticket`リソースを`src/Resource/App/Ticket.php`に作成します。

Expand Down Expand Up @@ -557,7 +557,7 @@ Ticketリソースにアトリビュート`#[Embed]`を追加します。

## ticketsリソース

`POST`で作成、`GET`でチケットリストが取得できる`tikcets`リソースを`src/resource/App/Tickets.php`に作成します。
`POST`で作成、`GET`でチケットリストが取得できる`tickets`リソースを`src/resource/App/Tickets.php`に作成します。

```php
<?php
Expand Down Expand Up @@ -891,5 +891,4 @@ BEAR.Sundayは標準に基づいたクリーンなコードである事を重視
[^13]: このSQLは[SQLスタイルガイド](https://www.sqlstyle.guide/ja/) に準拠しています。 PhpStormからは[Joe Celko](https://twitter.com/koriym/status/1410996122412150786)として設定できます。
コメントは説明になるだけでなくスロークエリーログ等からもSQLを特定しやすくなります。

※ 以前のPHP7対応のチュートリアルは[tutorial2_v1](tutorial2_v1.html)にあります。

※ 以前のPHP7対応のチュートリアルは[tutorial2_v1](tutorial2_v1.html)にあります。
8 changes: 4 additions & 4 deletions manuals/1.0/ja/archive/tutorial2_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -463,7 +463,7 @@ composer test

リソースのロジックはSQLとして、そのバリデーションはJSONファイルで表すことが出来ています。リソースクラスではそれらのファイルを利用します。

## tikcetリソース
## ticketリソース

`ticket`リソースを`src/Resource/App/Ticket.php`に作成します。

Expand Down Expand Up @@ -503,9 +503,9 @@ class Ticket extends ResourceObject
`@Query("ticket_item_by_id", type="row")`と指定されているので、このメソッドはSQL実行と置き換わります。`var/sql/ticket_item_by_id.sql`ファイルのSQLが実行され、その結果が単一行(type="row")で返ります。このようにロジックが単純にSQLで置換えられる場合は`@Query`を使ってPHPの記述を省略することができます。


## tikcetsリソース
## ticketsリソース

次は`tikcet`リソースの集合の`tikcets`リソースを`src/resource/App/Tickets.php`に作成します。
次は`ticket`リソースの集合の`tickets`リソースを`src/resource/App/Tickets.php`に作成します。

```php
<?php
Expand Down Expand Up @@ -798,4 +798,4 @@ $docApp->dumpMd(dirname(__DIR__) . '/docs', 'app');```
[^9]:http://json-schema.org/latest/json-schema-core.html#rfc.section.10.1
[^10]:`/ticket`でPOSTされると`/tickets`リソースのキャッシュを破壊しています。`@Refresh`とすると破壊のタイミングでキャッシュを再生成します。
[^11]: [Publishing your GitHub Pages site from a /docs folder on your master branch](https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/#publishing-your-github-pages-site-from-a-docs-folder-on-your-master-branch)
[^13]: 2018年9月現在php7.3だと実行できますが`PHP Deprecated`が表示されます。
[^13]: 2018年9月現在php7.3だと実行できますが`PHP Deprecated`が表示されます。

0 comments on commit 8c721bd

Please sign in to comment.