FS User Crud

Introduction

FS User Crud is a framework for creating, reading, updating and deleting user records, within a MySQL database. This project is an exercise in creating a well-structured PHP project with Composer dependencies, namespacing, unit tests and more.

The project includes:

• A command-line interface that lets the user issue CRUD commands
• An MVC framework, used by the command-line interface
• A database schema to create the user table
• Dependency management via Composer
• 100% method code coverage by PHPUnit tests
• Full code documentation via PHPDoc comments
• Compliance with PSR-2 coding standards
• A Vagrant setup for running MySQL

A note on "re-inventing the wheel"

If this was a real-world application, I would certainly re-use existing well-tested software for parts, such as a command-line tool framework or an argument parser. However I chose to implement everything myself, as an exercise. The AOrm project dependency was also developed by me.

Pre-requisites

The following need to be installed on your machine, before you can set up and use fs-user-crud.

• PHP >=5.6
• git
• Composer
• Vagrant
• VirtualBox

Dependencies installed via Composer

The only production dependency is AOrm - a simple ORM library for PHP.

Development dependencies installed via Composer

PHPUnit is set as a require-dev dependency, which is only used for development or testing purposes, and therefore optional.

Set up instructions

Download and install dependencies

$ git clone [email protected]:denizozsen/fs-user-crud

$ cd fs-user-crud

$ composer install

Note If you don't have a GitHub SSH key setup, you can use the HTTPS method for cloning the repository, by replacing the first of these commands with git clone https://github.com/denizozsen/fs-user-crud.git

Set up virtual machine

$ vagrant up

Create user table

$ vagrant ssh

$ cat /vagrant/db_schema.sql | mysql -Dmy_app

$ exit

The installation is now done. Congratulations!

Usage

The functionality is provided by the command-line PHP application src/cli.php. The following assumes that the current working directory in your terminal is the root of the cloned fs-user-crud repository.

Note: the Vagrant configuration is such that you should be able to use these commands from your host OS. However, if you experience any errors related to the MySQL connection, please use the command-line interface from within the guest OS, by running the following commands first, from within the project root:

$ vagrant ssh

$ cd /vagrant

Display usage instructions

$ php src/cli.php

List all users

$ php src/cli.php --retrieve-all

List users that match given filters, e.g. where the last name contains "Smith" and the email contains "gmail.com"

$ php src/cli.php --retrieve "last_name=Smith&email=gmail.com"

Create a new user

$ php src/cli.php --create "[email protected]&first_name=John&last_name=Doe&password=hardT0Gue55"

Update the email of existing user with id 123

$ php src/cli.php --update "user_id=123&[email protected]"

Delete the existing user with id 5

$ php src/cli.php --delete 5

Tests

The project includes a unit test suite, based on PHPUnit. These can be run via the PHPUnit that is included as a require-dev dependency. E.g. in a terminal, change the current working directory to the root directory of the project, then type the following:

$ vendor/bin/phpunit

Future

Moving on from here, there are still lots of interesting features that could be added to this project.

Here's what I would like to add next:

• Web request routing framework: route URLs to action methods in Handler objects
• REST API that provides access to the user CRUD operations
• An Angular-based web application that adds a nice GUI that communicates with the REST API
• A general-purpose configuration mechanism (perhaps based on environment variables), to allow configuring things like the database credentials
• More to come...