# PHPの命名規則とPSRスタイルガイドの使い方

## 目次
1. はじめに
2. PHPの命名規則
   1. クラスとインターフェース
   2. メソッドとプロパティ
   3. 定数
   4. 変数
   5. 名前空間
3. PSRスタイルガイド
   1. PSR-1: 基本的コーディングスタンダード
   2. PSR-12: コーディングスタイル標準
4. 実際のコード例
5. まとめ

## 1-1 はじめに
PHPの命名規則とPSR（PHP Standards Recommendations）は、コードの一貫性と可読性を保つために非常に重要です。このガイドでは、PHP開発者がこれを理解し、効果的に実装する方法を説明します。

## 2-1 PHPの命名規則

### 2-1-1 クラスとインターフェース
- クラス名とインターフェース名は、パスカルケース（キャメルケースとも呼ばれる）の形式を使用します。
  - 例: `UserManager`, `LogInterface`
- インターフェース名には動作を示す接尾辞として`Interface`を付けます。

### 2-1-2 メソッドとプロパティ
- メソッド名とプロパティ名はキャメルケースを使用します。
  - 例: `getUserName()`, `$totalAmount`

### 2-1-3 定数
- 定数はすべて大文字で記述し、単語の間はアンダースコアで区切ります。
  - 例: `MAX_USERS`, `API_KEY`

### 2-1-4 変数
- 変数名はキャメルケースを使用し、名前自体ができる限り具体的でわかりやすくなるようにします。
  - 例: `$userName`, `$totalPrice`

### 2-1-5 名前空間
- 名前空間はベンダー名から始まり、その後にプロジェクト名が続くパスカルケースを用います。
  - 例: `Acme\Product`, `VendorName\ProjectName`

## 3-1 PSRスタイルガイド

### 3-1-1 PSR-1: 基本的コーディングスタンダード
PSR-1は、PHPコードのための基本的なコーディングスタンダードです。これには以下が含まれます：
- PHPタグは常に `<?php` または `<?=` を使用する。
- ファイルは1つの `namespace` または複数のクラスを持つべきで、前に追加のコードを含めない。

### 3-1-2 PSR-12: コーディングスタイル標準
PSR-12は、PSR-1の拡張であり、スタイルガイドをより詳細に規定しています。
- インデントを4スペースに設定する。
- 行の長さは80文字を推奨、100文字を上限とする。
- ブレースの位置はK&Rスタイル（一行下に置く）を推奨。
- 各ファイルは単一の `<?php` タグがある場合、末尾に空白または閉じるPHPタグを持たない。

## 4-1 実際のコード例

以下にPSRに準拠したPHPコードのシンプルな例を示します。

![img](/mosaic-code.jpg)

## 5-1 まとめ
PHPの命名規則とPSRスタイルガイドを遵守することで、コードの可読性、保守性が向上し、チーム内の一貫性が保証されます。PHP開発においては、これらの規則に従うことで、品質の高いソフトウェアを効率的に作成することが可能になります。 [cv:issue_marketplace_engineer]

# PHPの命名規則とPSRスタイルガイドの使い方

## 目次
1. はじめに
2. PHPの命名規則
   1. クラスとインターフェース
   2. メソッドとプロパティ
   3. 定数
   4. 変数
   5. 名前空間
3. PSRスタイルガイド
   1. PSR-1: 基本的コーディングスタンダード
   2. PSR-12: コーディングスタイル標準
4. 実際のコード例
5. まとめ

## 1-1 はじめに
PHPの命名規則とPSR（PHP Standards Recommendations）は、コードの一貫性と可読性を保つために非常に重要です。このガイドでは、PHP開発者がこれを理解し、効果的に実装する方法を説明します。

## 2-1 PHPの命名規則

### 2-1-1 クラスとインターフェース
- クラス名とインターフェース名は、パスカルケース（キャメルケースとも呼ばれる）の形式を使用します。
  - 例: `UserManager`, `LogInterface`
- インターフェース名には動作を示す接尾辞として`Interface`を付けます。

### 2-1-2 メソッドとプロパティ
- メソッド名とプロパティ名はキャメルケースを使用します。
  - 例: `getUserName()`, `$totalAmount`

### 2-1-3 定数
- 定数はすべて大文字で記述し、単語の間はアンダースコアで区切ります。
  - 例: `MAX_USERS`, `API_KEY`

### 2-1-4 変数
- 変数名はキャメルケースを使用し、名前自体ができる限り具体的でわかりやすくなるようにします。
  - 例: `$userName`, `$totalPrice`

### 2-1-5 名前空間
- 名前空間はベンダー名から始まり、その後にプロジェクト名が続くパスカルケースを用います。
  - 例: `Acme\Product`, `VendorName\ProjectName`

## 3-1 PSRスタイルガイド

### 3-1-1 PSR-1: 基本的コーディングスタンダード
PSR-1は、PHPコードのための基本的なコーディングスタンダードです。これには以下が含まれます：
- PHPタグは常に `<?php` または `<?=` を使用する。
- ファイルは1つの `namespace` または複数のクラスを持つべきで、前に追加のコードを含めない。

### 3-1-2 PSR-12: コーディングスタイル標準
PSR-12は、PSR-1の拡張であり、スタイルガイドをより詳細に規定しています。
- インデントを4スペースに設定する。
- 行の長さは80文字を推奨、100文字を上限とする。
- ブレースの位置はK&Rスタイル（一行下に置く）を推奨。
- 各ファイルは単一の `<?php` タグがある場合、末尾に空白または閉じるPHPタグを持たない。

## 4-1 実際のコード例

以下にPSRに準拠したPHPコードのシンプルな例を示します。

```php
<?php

namespace Acme\Library;

use DateTime;

class BookManager
{
    const MAX_LOANS = 5;

    private $catalog;

    public function __construct(array $catalog)
    {
        $this->catalog = $catalog;
    }

    public function getBookList(): array
    {
        return $this->catalog;
    }

    public function loanBook(string $title): bool
    {
        // Loan logic here
        return true;
    }
}
```

## 5-1 まとめ
PHPの命名規則とPSRスタイルガイドを遵守することで、コードの可読性、保守性が向上し、チーム内の一貫性が保証されます。PHP開発においては、これらの規則に従うことで、品質の高いソフトウェアを効率的に作成することが可能になります。 

PHPの命名規則とPSRスタイルガイドの使い方

目次

続きを読むには単価診断を受けてください（30秒）