**Course Title:** Mastering Zend Framework (Laminas): Building Robust Web Applications **Section Title:** RESTful API Development with Laminas **Topic:** Create a RESTful API for a product catalog with endpoints for CRUD operations and authentication.(Lab topic) **Overview** In this lab topic, we will create a RESTful API for a product catalog using Laminas. We will cover the basics of RESTful API development, CRUD operations, and authentication. By the end of this topic, you will have a complete RESTful API for a product catalog that can be used in various web applications. **Prerequisites** * Complete the previous topics in the RESTful API Development with Laminas section. * Familiarity with Laminas and PHP is required. **Step 1: Create a New Project** Create a new project in your preferred IDE and create a new file called `module.Product/Catalog/Config/Common.php`. ```php <?php return [ 'routes' => [ 'api' => [ 'type' => 'Restful', 'options' => [ 'router' => new Laminas\Mvc\RoutenRoute(), '-options' => [ 'restrict host' => false, 'extensionless routes' => false, ], ], ], ], ]; ``` **Step 2: Define Routes** In the same file, define the routes for the product catalog API. ```php <?php return [ //... 'routes' => [ //... 'api' => [ //... 'product' => [ 'type' => 'Restful', 'options' => [ 'route' => '/products', 'permissions' => ['admin'], ], ], 'product/:id' => [ 'type' => 'Restful', 'options' => [ 'route' => '/products/{id}', 'permission' => 'view', ], ], 'product/:id/edit' => [ 'type' => 'Restful', 'options' => [ 'route' => '/products/{id}/edit', 'permission' => 'edit', ], ], 'product/:id/delete' => [ 'type' => 'Restful', 'options' => [ 'route' => '/products/{id}/delete', 'permission' => 'delete', ], ], ], ], ]; ``` **Step 3: Create Product Model** Create a new file called `module/Product/Catalog/Model/Product.php`. ```php namespace Module\Product\Catalog\Model; use Laminas\Db\TableGateway\TableGateway; use Laminas\Db\Sql\Sql; class ProductModel { private $tableGateway; public function __construct(TableGateway $tableGateway) { $this->tableGateway = $tableGateway; } public function getProducts() { $sql = new Sql($this->tableGateway->getAdapter()); $query = $sql->select(['product_id', 'product_name', 'price']); $products = $this->tableGateway->selectWith($query); return $products; } public function getProduct($id) { $sql = new Sql($this->tableGateway->getAdapter()); $query = $sql->select(['product_id', 'product_name', 'price']); $query->where('product_id = :id', ['id' => $id]); $product = $this->tableGateway->selectWith($query); return $product; } public function createProduct($product) { $sql = new Sql($this->tableGateway->getAdapter()); $query = $sql->insert('products', $product); $this->tableGateway->insertWith($query); return true; } public function updateProduct($id, $product) { $sql = new Sql($this->tableGateway->getAdapter()); $query = $sql->update('products', $product, ['product_id = :id', ['id' => $id]]); $this->tableGateway->updateWith($query); return true; } public function deleteProduct($id) { $sql = new Sql($this->tableGateway->getAdapter()); $query = $sql->delete('products', ['product_id = :id', ['id' => $id]]); $this->tableGateway->deleteWith($query); return true; } } ``` **Step 4: Create Product Controller** Create a new file called `module/Product/Catalog/Controller/ProductController.php`. ```php namespace Module\Product\Catalog\Controller; use Module\Product\Catalog\Model\ProductModel; use Laminas\Mvc\Controller\ActionController; class ProductController extends ActionController { private $productModel; public function __construct(ProductModel $productModel) { $this->productModel = $productModel; } public function indexAction() { $products = $this->productModel->getProducts(); return $this->view->assign('products', $products); } public function showAction($id) { $product = $this->productModel->getProduct($id); return $this->view->assign('product', $product); } public function createAction() { return $this->view->pick('product/create'); } public function editAction($id) { $product = $this->productModel->getProduct($id); return $this->view->assign('product', $product); } public function updateAction($id) { $product = $this->productModel->getProduct($id); return $this->view->assign('product', $product); } public function deleteAction($id) { $this->productModel->deleteProduct($id); return $this->redirect()->toRoute('api/product'); } } ``` **Step 5: Create Authentication Service** Create a new file called `module\Product/Catalog/Service/AuthService.php`. ```php namespace Module\Product\Catalog\Service; use Laminas\Authentication\AuthenticationService; use Laminas\Auth\Identity\MinecraftAccount; class AuthService { private $authService; public function __construct(AuthenticationService $authService) { $this->authService = $authService; } public function authenticateUser($username, $password) { $user = $this->authService->authenticate($username, $password); return $user; } } ``` **Step 6: Create Authentication Controller** Create a new file called `module/Product/Catalog.Controller\AuthController.php`. ```php namespace Module\Product\Catalog\Controller; use Module\Product\Catalog\Service\AuthService; use Laminas\Mvc\Controller\ActionController; class AuthController extends ActionController { private $authService; public function __construct(AuthService $authService) { $this->authService = $authService; } public function loginAction() { $username = $this->request->getPost('username'); $password = $this->request->getPost('password'); $user = $this->authService->authenticateUser($username, $password); if ($user) { return $this->redirect()->toRoute('api/product'); } else { return $this->redirect()->toRoute('login'); } } public function registerAction() { return $this->view->pick('auth/register'); } public function logoutAction() { return $this->redirect()->toRoute('login'); } } ``` **Step 7: Configure Routes** Update the `module/Product/Catalog/Config/Common.php` file to include the routes for the product catalog API. ```php return [ //... 'routes' => [ //... 'api' => [ //... 'product' => [ //... ], 'auth' => [ 'type' => 'Restful', 'options' => [ 'route' => '/auth', 'permissions' => ['admin'], ], ], ], ], ]; ``` **Conclusion** In this lab topic, we created a RESTful API for a product catalog using Laminas. We covered the basics of RESTful API development, CRUD operations, and authentication. By the end of this topic, you should have a complete RESTful API for a product catalog that can be used in various web applications. **Exercises** 1. Add more routes to the product catalog API for CRUD operations. 2. Implement authentication for the product catalog API using Laminas Authentication. 3. Add more features to the product catalog API, such as filtering and sorting. **Comments and Feedback** Please leave a comment or ask for help if you have any questions or need further clarification on any of the topics covered in this lab topic.