Merge pull request #4 from samsonasik/add-track-table

adding track detail of album

README.md

@@ -73,6 +73,13 @@ database.default.DBDriver = MySQLi
 php spark migrate -n Album
 ```
 
+**4.** Run db seed (Optional)
+
+```bash
+php spark db:seed "Album\Database\Seeds\AlbumSeeder"
+php spark db:seed "Album\Database\Seeds\TrackSeeder"
+```
+
 **4.** Run development server:
 
 ```bash

phpstan.neon

@@ -13,4 +13,5 @@ parameters:
         - '#Access to protected property [a-zA-Z0-9\\_]+Model::\$returnType.#'
         - '#Method ([a-zA-Z0-9\\_]+)(Controllers)([a-zA-Z0-9\\_]+)(::)([a-zA-Z0-9]+)(\(\)) has no return typehint specified.#'
         - '#Call to an undefined static method Config\\Services::albumRepository()#'
+        - '#Call to an undefined static method Config\\Services::trackRepository()#'
         - '#Call to protected method builder\(\) of class CodeIgniter\\Model.#'

src/Config/Routes.php

@@ -13,3 +13,17 @@
 	// example URI: /album/1
 	$routes->match(['get', 'post'], 'edit/(:num)', 'Album::edit/$1', ['as' => 'album-edit']);
 });
+
+$routes->group('track', ['namespace' => 'Album\Controllers'], function ($routes) {
+	// URI: /track/1
+	$routes->get('(:num)', 'Track::index/$1', ['as' => 'track-index']);
+
+	// URI: /track/add/(:num)
+	$routes->match(['get', 'post'], 'add/(:num)', 'Track::add/$1', ['as' => 'track-add']);
+
+	// example URI: /track/delete/1
+	$routes->get('delete/(:num)/(:num)', 'Track::delete/$1/$2', ['as' => 'track-delete']);
+
+	// example URI: /track/1
+	$routes->match(['get', 'post'], 'edit/(:num)/(:num)', 'Track::edit/$1/$2', ['as' => 'track-edit']);
+});

src/Config/Services.php

@@ -1,7 +1,8 @@
 <?php namespace Album\Config;
 
 use Album\Infrastructure\Persistence\Album\SQLAlbumRepository;
-use Album\Models\AlbumModel;
+use Album\Infrastructure\Persistence\Track\SQLTrackRepository;
+use Album\Models;
 use CodeIgniter\Config\BaseService;
 
 class Services extends BaseService
@@ -13,6 +14,16 @@ public static function albumRepository($getShared = true)
 			return static::getSharedInstance('albumRepository');
 		}
 
-		return new SQLAlbumRepository(model(AlbumModel::class));
+		return new SQLAlbumRepository(model(Models\AlbumModel::class));
+	}
+
+	public static function trackRepository($getShared = true)
+	{
+		if ($getShared)
+		{
+			return static::getSharedInstance('trackRepository');
+		}
+
+		return new SQLTrackRepository(model(Models\TrackModel::class));
 	}
 }

src/Controllers/Album.php

@@ -22,7 +22,7 @@ public function index()
 		$data['albums']  = $this->repository->findPaginatedData($data['keyword']);
 		$data['pager']   = $this->repository->pager();
 
-		return view('Album\Views\index', $data);
+		return view('Album\Views\album\index', $data);
 	}
 
 	public function add()
@@ -40,7 +40,7 @@ public function add()
 			return redirect()->withInput()->back();
 		}
 
-		return view('Album\Views\add', ['errors' => session()->getFlashData('errors')]);
+		return view('Album\Views\album\add', ['errors' => session()->getFlashData('errors')]);
 	}
 
 	public function edit(int $id)
@@ -67,7 +67,7 @@ public function edit(int $id)
 			return redirect()->withInput()->back();
 		}
 
-		return view('Album\Views\edit', ['album' => $album, 'errors' => session()->getFlashData('errors')]);
+		return view('Album\Views\album\edit', ['album' => $album, 'errors' => session()->getFlashData('errors')]);
 	}
 
 	public function delete(int $id)

src/Controllers/Track.php

@@ -0,0 +1,120 @@
+<?php namespace Album\Controllers;
+
+use Album\Domain\Album\AlbumRepository;
+use Album\Domain\Exception\RecordNotFoundException;
+use Album\Domain\Track\TrackRepository;
+use App\Controllers\BaseController;
+use CodeIgniter\Exceptions\PageNotFoundException;
+use Config\Services;
+
+class Track extends BaseController
+{
+	/** @var AlbumRepository */
+	private $albumRepository;
+
+	/** @var TrackRepository */
+	private $trackRepository;
+
+	public function __construct()
+	{
+		$this->albumRepository = Services::albumRepository();
+		$this->trackRepository = Services::trackRepository();
+	}
+
+	public function index(int $albumId)
+	{
+		try
+		{
+			$album = $this->albumRepository->findAlbumOfId($albumId);
+		}
+		catch (RecordNotFoundException $e)
+		{
+			throw new PageNotFoundException($e->getMessage());
+		}
+
+		$data['keyword'] = $this->request->getGet('keyword') ?? '';
+		$data['album']   = $album;
+		$data['tracks']  = $this->trackRepository->findPaginatedData($album, $data['keyword']);
+		$data['pager']   = $this->trackRepository->pager();
+
+		return view('Album\Views\track\index', $data);
+	}
+
+	public function add(int $albumId)
+	{
+		try
+		{
+			$album = $this->albumRepository->findAlbumOfId($albumId);
+		}
+		catch (RecordNotFoundException $e)
+		{
+			throw new PageNotFoundException($e->getMessage());
+		}
+
+		if ($this->request->getMethod() === 'post')
+		{
+			$data = $this->request->getPost();
+			if ($this->trackRepository->save($data))
+			{
+				session()->setFlashdata('status', 'New album track has been added');
+				return redirect()->route('track-index', [$albumId]);
+			}
+
+			session()->setFlashdata('errors', $this->trackRepository->errors());
+			return redirect()->withInput()->back();
+		}
+
+		return view('Album\Views\track\add', [
+			'album'  => $album,
+			'errors' => session()->getFlashData('errors'),
+		]);
+	}
+
+	public function edit(int $albumId, int $trackId)
+	{
+		try
+		{
+			$album = $this->albumRepository->findAlbumOfId($albumId);
+			$track = $this->trackRepository->findTrackOfId($trackId);
+		}
+		catch (RecordNotFoundException $e)
+		{
+			throw new PageNotFoundException($e->getMessage());
+		}
+
+		if ($this->request->getMethod() === 'post')
+		{
+			$data = $this->request->getPost();
+			if ($this->trackRepository->save($data))
+			{
+				session()->setFlashdata('status', 'Album track has been updated');
+				return redirect()->route('track-index', [$albumId]);
+			}
+
+			session()->setFlashdata('errors', $this->trackRepository->errors());
+			return redirect()->withInput()->back();
+		}
+
+		return view('Album\Views\track\edit', [
+			'album'  => $album,
+			'track'  => $track,
+			'errors' => session()->getFlashData('errors'),
+		]);
+	}
+
+	public function delete(int $albumId, int $trackId)
+	{
+		try
+		{
+			$this->albumRepository->findAlbumOfId($albumId);
+			$this->trackRepository->deleteOfId($trackId);
+		}
+		catch (RecordNotFoundException $e)
+		{
+			throw new PageNotFoundException($e->getMessage());
+		}
+
+		session()->setFlashdata('status', 'Album track has been deleted');
+		return redirect()->route('track-index', [$albumId]);
+	}
+}

src/Database/Migrations/2020-03-26-203957_Track.php

@@ -0,0 +1,37 @@
+<?php namespace Album\Database\Migrations;
+
+use CodeIgniter\Database\Migration;
+
+class Track extends Migration
+{
+	public function up()
+	{
+		$this->forge->addField([
+			'id'     => [
+				'type'           => 'BIGINT',
+				'unsigned'       => true,
+				'auto_increment' => true,
+			],
+			'album_id' => [
+				'type'       => 'BIGINT',
+				'unsigned'   => true,
+			],
+			'title'  => [
+				'type'       => 'VARCHAR',
+				'constraint' => '255',
+			],
+			'author'  => [
+				'type'       => 'VARCHAR',
+				'constraint' => '255',
+			],
+		]);
+		$this->forge->addKey('id', true);
+		$this->forge->addForeignKey('album_id', 'album', 'id', 'CASCADE', 'CASCADE');
+		$this->forge->createTable('track');
+	}
+
+	public function down()
+	{
+		$this->forge->dropTable('track');
+	}
+}

test/Database/Seeds/AlbumSeeder.php → src/Database/Seeds/AlbumSeeder.php

@@ -1,4 +1,4 @@
-<?php namespace AlbumTest\Database\Seeds;
+<?php namespace Album\Database\Seeds;
 
 use CodeIgniter\Database\Seeder;
 
@@ -9,7 +9,7 @@ public function run()
 		$row = [
 			'id'     => 1,
 			'artist' => 'Sheila On 7',
-			'title'  => 'Melompat Lebih Tinggi',
+			'title'  => 'Kisah Klasik Untuk Masa Depan',
 		];
 
 		$this->db->table('album')->insert($row);

src/Database/Seeds/TrackSeeder.php

@@ -0,0 +1,18 @@
+<?php namespace Album\Database\Seeds;
+
+use CodeIgniter\Database\Seeder;
+
+class TrackSeeder extends Seeder
+{
+	public function run()
+	{
+		$row = [
+			'id'       => 1,
+			'album_id' => 1,
+			'title'    => 'Sebuah Kisah Klasik',
+			'author'   => 'Eross Chandra',
+		];
+
+		$this->db->table('track')->insert($row);
+	}
+}

src/Domain/Album/Album.php

@@ -2,15 +2,18 @@
 
 use CodeIgniter\Entity;
 
+/**
+ * @property int $id
+ * @property string $artist
+ * @property string $title
+ */
 class Album extends Entity
 {
-	public function __construct(array $data = null)
-	{
-		$data['artist'] = $data['artist'] ?? '';
-		$data['title']  = $data['title'] ?? '';
-
-		parent::__construct($data);
-	}
+	protected $attributes = [
+		'id'     => null,
+		'artist' => null,
+		'title'  => null,
+	];
 
 	public function setArtist(string $artist): self
 	{

src/Domain/Album/AlbumRepository.php

@@ -1,13 +1,9 @@
 <?php namespace Album\Domain\Album;
 
-use CodeIgniter\Pager\PagerInterface;
+use Album\Domain\Repository;
 
-interface AlbumRepository
+interface AlbumRepository extends Repository
 {
 	public function findPaginatedData(string $keyword = ''): ?array;
-	public function pager(): ?PagerInterface;
 	public function findAlbumOfId(int $id): Album;
-	public function save(array $data): bool;
-	public function errors(): ?array;
-	public function deleteOfId(int $id): bool;
 }

src/Domain/Repository.php

@@ -0,0 +1,11 @@
+<?php namespace Album\Domain;
+
+use CodeIgniter\Pager\PagerInterface;
+
+interface Repository
+{
+	public function pager(): ?PagerInterface;
+	public function save(array $data): bool;
+	public function errors(): ?array;
+	public function deleteOfId(int $id): bool;
+}

src/Domain/Track/Track.php

@@ -0,0 +1,36 @@
+<?php namespace Album\Domain\Track;
+
+use CodeIgniter\Entity;
+
+/**
+ * @property int $id
+ * @property int $album_id
+ * @property string $title
+ */
+class Track extends Entity
+{
+	protected $attributes = [
+		'id'       => null,
+		'album_id' => null,
+		'title'    => null,
+		'author'   => null,
+	];
+
+	public function setAlbumId(int $albumId): self
+	{
+		$this->attributes['album_id'] = $albumId;
+		return $this;
+	}
+
+	public function setTitle(string $title): self
+	{
+		$this->attributes['title'] = ucwords($title);
+		return $this;
+	}
+
+	public function setAuthor(string $author): self
+	{
+		$this->attributes['author'] = ucwords($author);
+		return $this;
+	}
+}

src/Domain/Track/TrackNotFoundException.php

@@ -0,0 +1,9 @@
+<?php namespace Album\Domain\Track;
+
+use Album\Domain\Exception\RecordNotFoundException;
+
+class TrackNotFoundException extends RecordNotFoundException
+{
+	/** @var string */
+	public $message = 'The album track you requested does not exist.';
+}

src/Domain/Track/TrackRepository.php

@@ -0,0 +1,10 @@
+<?php namespace Album\Domain\Track;
+
+use Album\Domain\Album\Album;
+use Album\Domain\Repository;
+
+interface TrackRepository extends Repository
+{
+	public function findPaginatedData(Album $album, string $keyword = ''): ?array;
+	public function findTrackOfId(int $id): Track;
+}