Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kenjis/codeigniter-tettei-apps

『CodeIgniter徹底入門』のサンプルアプリケーション（CodeIgniter v3.1版）
https://github.com/kenjis/codeigniter-tettei-apps

codeception codeigniter codeigniter3 hacktoberfest phpunit selenium twig

Last synced: 3 months ago
JSON representation

『CodeIgniter徹底入門』のサンプルアプリケーション（CodeIgniter v3.1版）

Host: GitHub
URL: https://github.com/kenjis/codeigniter-tettei-apps
Owner: kenjis
Created: 2015-05-05T08:37:13.000Z (almost 10 years ago)
Default Branch: develop
Last Pushed: 2022-09-30T19:16:46.000Z (over 2 years ago)
Last Synced: 2024-11-01T07:51:50.958Z (3 months ago)
Topics: codeception, codeigniter, codeigniter3, hacktoberfest, phpunit, selenium, twig
Language: PHP
Homepage:
Size: 3.92 MB
Stars: 28
Watchers: 8
Forks: 18
Open Issues: 4
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing-codeigniter-3.0.0.md

Awesome Lists containing this project

README

# 『CodeIgniter徹底入門』のサンプルアプリケーションをCodeIgniter 3.xにアップデート

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/kenjis/codeigniter-tettei-apps/badges/quality-score.png?b=develop)](https://scrutinizer-ci.com/g/kenjis/codeigniter-tettei-apps/?branch=develop)
[![Coverage Status](https://coveralls.io/repos/kenjis/codeigniter-tettei-apps/badge.svg?branch=develop)](https://coveralls.io/r/kenjis/codeigniter-tettei-apps?branch=develop)
[![Build Status](https://travis-ci.org/kenjis/codeigniter-tettei-apps.svg?branch=develop)](https://travis-ci.org/kenjis/codeigniter-tettei-apps)

**現在、CodeIgniterの開発は4.xに移っています。CodeIgniter4にアップグレードした、を参照してください。**

ここは『CodeIgniter徹底入門』（翔泳社）に含まれている以下のサンプルアプリケーション（CodeIgniter 1.6.1用）をCodeIgniter 3.xで動作するように更新したものです。

* コンタクトフォーム（7章）
* モバイル対応簡易掲示板（8章）
* 簡易ショッピングサイト（9章）

CodeIgniter 3.xで動作するように更新し、少しリファクタリングしました。

## 動作確認環境

### アプリ

* PHP 7.4.15
* Composer 1.10.19 (Composer 2.0ではCli for CodeIgniterが動作しません)
* MySQL 5.7

### 受入テスト

* Selenium Server 3.141.59
* geckodriver 0.29.0
* OpenJDK 15.0.1

## 書籍のコードからの変更点

* CodeIgniter 3.1.11に対応（CodeIgniter本体は [CodeIgniter Composer Installer](http://blog.a-way-out.net/blog/2015/12/06/install-codeigniter/) によりComposerでインストール）
* フォルダ構成を変更し、Web公開領域を`public`フォルダ以下に限定
* CodeIgniterでComposerを利用可能に設定
* ISO-2022-JPのメールは作成できなくなったのでUTF-8に変更
* CSRF対策を独自実装からCodeIgniterの自動保護に変更
* Codeception/Seleniumによる受入テストの追加 [tests/acceptance](tests/acceptance)
* PHPUnitによるアプリケーションテストの追加 [application/tests](application/tests)
* データベースマイグレーションの追加 [application/database/migrations](application/database/migrations)
* 掲示板
* コントローラでの文字エンコード変換ができなくなったのでフックの`pre_system`に移動
* ショッピング
* `category`と`product`テーブルのSeederを追加 [application/database/seeds](application/database/seeds)
* キーワード検索をGETメソッドを使うように変更
* メール本文の作成をテンプレートパーサクラスを使うように変更
* クラスの分割
* `MY_Controller`の追加
* ビューにTwigを利用
* XSS脆弱性の修正
* リファクタリング
* ビューのコーディングスタイルを統一し、HTMLエスケープを徹底

追加されたComposerのパッケージ

* CodeIgniter Simple and Secure Twig
* Cli for CodeIgniter
* ci-phpunit-test
* Faker
* Codeception
* Symfony DomCrawler
* Symfony CssSelector
* PHPUnit
* CodeIgniter Debug Bar

## インストール方法

### ダウンロード

https://github.com/kenjis/codeigniter-tettei-apps/archive/develop.zip をダウンロードし解凍します。

### Apacheの設定

`codeigniter-tettei-apps/public`フォルダが公開フォルダです。ここをでアクセスできるように設定してください。

例えば、以下のようにApacheの`htdocs`以下にシンボリックリンクを張ります。

~~~
$ cd /paht/to/Apache/htdocs/
$ ln -s /path/to/codeigniter-tettei-apps/public/ CodeIgniter
~~~

なお、`.htaccess`によるmod_rewriteの設定を有効にしてください。

### ファイルのパーミッション設定

必要な場合は、以下のフォルダにApacheから書き込みできる権限を付与してください。

~~~
$ cd /path/to/codeigniter-tettei-apps/
$ chmod o+w application/logs/
$ chmod o+w application/cache/
$ chmod o+w public/captcha/
~~~

### 依存パッケージのインストール

Composerで依存パッケージをインストールします。

~~~
$ php composer.phar self-update
$ php composer.phar self-update --1
$ php composer.phar install --no-plugins
~~~

#### Note

パッケージをupdateする場合

~~~
$ php -d memory_limit=-1 composer.phar update --no-plugins
~~~

### データベースとユーザの作成

MySQLにデータベースとユーザを作成します。

~~~
CREATE DATABASE `codeigniter` DEFAULT CHARACTER SET utf8mb4;
GRANT ALL PRIVILEGES ON codeigniter.* TO username@localhost IDENTIFIED BY 'password';
~~~

### データベースマイグレーションとシーディングの実行

データベースにテーブルを作成し、テストデータを挿入します。

~~~
$ php cli migrate
$ php cli seed
~~~

## テストの実行方法

### PHPUnitによるアプリケーションテスト

~~~
$ composer test
~~~

テストカバー率のレポートは`build/coverage`フォルダに作成されます。なお、カバー率の集計にはXdebugが必要です。

#### Note

RuntimeException: Cannot modify header information - headers already sent by (output started at .../vendor/phpunit/phpunit/src/Util/Printer.php:113) on line 350 ... のようなエラーが出る場合

~~~
$ vendor/bin/phpunit -c application/tests/ --stderr
~~~

### Codeception/Seleniumによる受入テスト

よりFirefoxをダウンロードしインストールします。

Homebrewからselenium-server-standaloneとgeckodriverをインストールします。

~~~
$ brew install selenium-server-standalone
$ brew install geckodriver
~~~

Seleniumサーバを起動します。

~~~
$ selenium-server -port 4444
~~~

受入テストを実行します。

~~~
$ sh acceptance-test.sh
~~~

#### Note

geckodriverが開けない場合は、一度Finderからgeckodriverを右クリックして開いてください。

参考: https://github.com/mozilla/geckodriver/issues/1629#issuecomment-650432816

## 参考

書籍のコードほぼそのままでCodeIgniter 3.0.0に対応したものを見たい場合は、[master](https://github.com/kenjis/codeigniter-tettei-apps/tree/master)ブランチをご覧ください。

また、具体的な変更点は以下をご覧ください。

* [application/以下のCodeIgniter 3.0へのアップデート](https://github.com/kenjis/codeigniter-tettei-apps/commit/3dcdeefc8e42b2c8f6636fba5e86c7de28f961a3?w=1)

## ライセンス

サンプルアプリケーションのライセンスは「修正BSDライセンス」です。詳細は、[docs/license-codeigniter-tettei-1.4.txt](docs/license-codeigniter-tettei-1.4.txt) をご覧ください。

## 謝辞

サンプルアプリケーションのデザインは、神野みちるさん（株式会社ステップワイズ）にしていただきました。

## 『CodeIgniter徹底入門』について

* [『CodeIgniter徹底入門』情報ページ](http://codeigniter.jp/tettei/)
* [『CodeIgniter徹底入門』に対するノート](https://github.com/codeigniter-jp/codeigniter-tettei-note)