This README would normally document whatever steps are necessary to get your application up and running.

• API version 1.0.0
• API documentation
• API for Angelflight mobile application
• Developed By: Md. Noor-A-Alam Siddique

Dillinger uses a number of open source projects to work properly:

• [Symfony 4.0.6] - Number one fastest PHP framework!
• [Twig] - Modern template engine for PHP.
• [markdown-it] - Markdown parser done right. Fast and easy to extend.
• [Gulp] - the streaming build system
• [PhpStorm] - Super flexible and rich IDE for project development.

This project requires latest composer version and git to run.

• If you already have virtual host setup and not require internal web server [here my project name is : symfony-api-boilerplate.local].

$ composer create-project symfony/website-skeleton symfony-api-boilerplate.local

• Switch to project directory

$ cd symfony-api-boilerplate.local

• If you require internal web server than

$ composer require symfony/web-server-bundle --dev

• to start listening development server

$ php bin/console server:start

• start browsing http://127.0.0.1:8000

• to stop listening development server

$ php bin/console server:stop

• Symfony provides a utility called the "Security Checker" to check whether your project's dependencies contain any known security vulnerability

$ composer require sensiolabs/security-checker --dev

• Before creating the routes, lets create Database with installing Doctrine support via the ORM pack

composer require symfony/orm-pack

- This command will create ```Entity```, ```Migrations``` and ```Repository``` folder inside ```src``` folder - In addition under ```config/packages``` it'll create ```doctrine.yaml``` and ```doctrine_migrations.yaml``` file - At the same time under ```config/packages/prod``` folder it'll create another ```doctrine.yaml``` file 

• To create a database by command please got to the .env file and change the db_user, db_password and db_name and run the bellow command, which will create the database for you.

php bin/console doctrine:database:create

• For our project we are not using orm type as annotations, where as we are using orm type as xml. [Personally I myself and other develoer also feel orm type xml is most handy rather than using annotations]

• Only annotation mapping is supported by php bin/console make:Entity so we have to make our xml by typing it.

• Now, we are going to change the orm type

  • to do this, open the config/packages/doctrine.yaml file
  • find the line type: annotation and replace it with type: xml

• For more generalized our project we are changing the orm mapping directory [it's just an practise, not mandatory]

  • to do this, open the config folder
  • create a folder called doctrine
  • now open the config/packages/doctrine.yaml file
  • find the line dir: '%kernel.project_dir%/src/Entity' and replace it with dir: '%kernel.project_dir%/config/doctrine'

• Though we are not using annotations, so we have to create entity file by manually

  • open src/Entity folder and create two entity files called Offices.php and OfficeEmployees.php
  • to present the object relation between entities we created two entity here
  • now placed the bellow code into Offices.php and followed by OfficeEmployees.php

<?php namespace App\Entity; class Offices { /** * @var int */ protected $id; /** * @var string */ protected $office_name; /** * @return int */ public function getId() { return $this->id; } /** * @return string */ public function getOfficeName() { return $this->office_name; } /** * @param string $office_name */ public function setOfficeName(string $office_name) { $this->office_name = $office_name; } }

• here variable type Offices is a special type of variable, which indicate that this is variable which is connected with other table's [here is Offices or src\Entity\Offices.php] id. In Symfony autometically add _id with the variable name.

<?php namespace App\Entity; class OfficeEmployees { /** * @var int */ protected $id; /** * @var Offices */ protected $offices; /** * @var string */ protected $emp_name; /** * @return int */ public function getId() { return $this->id; } /** * @return string */ public function getEmpName() { return $this->emp_name; } /** * @param string $emp_name */ public function setEmpName(string $emp_name) { $this->emp_name = $emp_name; } /** * @return Offices */ public function getOffices() { return $this->offices; } /** * @param Offices $offices */ public function setOffices(Offices $offices) { $this->offices = $offices; } }

• To use Doctrine Extensions: Timestampable, Sluggable, Translatable, etc

composer require gedmo/doctrine-extensions

• Now inside config/doctrine folder create a file Offices.orm.xml and paste bellow codes

<doctrine-mapping xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://doctrine-project.org/schemas/orm/doctrine-mapping  http://doctrine-project.org/schemas/orm/doctrine-mapping.xsd"> <entity name="App\Entity\Offices" table="offices"> <id name="id" column="id" type="integer"> <generator strategy="AUTO" /> </id> <field name="office_name" type="string" nullable="true" /> </entity> </doctrine-mapping>

• Again inside config/doctrine folder create a file Offices.orm.xml and paste bellow codes

<doctrine-mapping xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:gedmo="http://gediminasm.org/schemas/orm/doctrine-extensions-mapping" xsi:schemaLocation="http://doctrine-project.org/schemas/orm/doctrine-mapping  http://doctrine-project.org/schemas/orm/doctrine-mapping.xsd"> <entity name="App\Entity\OfficeEmployees" table="office_employees"> <id name="id" column="id" type="integer"> <generator strategy="AUTO" /> </id> <field name="emp_name" type="string" nullable="true" /> <one-to-one field="offices" target-entity="App\Entity\Offices"> <cascade> <cascade-persist/> </cascade> <gedmo:blameable on="create"/> <join-column name="offices_id" referenced-column-name="id" nullable="false"/> </one-to-one> </entity> </doctrine-mapping>

• Here one-to-one or one-to-many or many-to-one define the relationship with tables

• Now run the command for creating migration file by which next time developer can track the changes

php bin/console make:migration

• Our migration file is ready to execute now. After running the bellow command create the tables into database.

php bin/console doctrine:migrations:migrate

• We will come back to Repository, but before that lets do something controlling stuff with Controller

• Create two file inside Controller folder called OfficesController.php and OfficeEmployeesController.php

  • Extends base Controller with this two controller
  • Use Controller\Controller with this two controller
  • Use HttpFoundation\Response with this two controller
  • Use Serializer\SerializerInterface with two controller

• For Serializer we are going to use the bellow bundle. This is a complex topic. But useful for developing tools to serialize and deserialize your objects.

$ composer require symfony/serializer

• Now we are starting with OfficesController.php controller
• Inside OfficesController.php create a public function called index, which will show a hello message for us. So, lets do something fun part.
  • Run composer require twig command to add twig. Twig is a view template engine. In symfony you can use two different view engine for view write. Apart from twig you can use php [ reference : https://symfony.com/doc/2.0/cookbook/templating/PHP.html]. But remember, Symfony recomand twig instead of any other things. I am using twig for this documentation.
  • After running the command for twig, it'll create a folder called Template into project root directory, where mainly all view related files will stored.
  • For configure your own directory path, you have to open the config/packages/twig.yaml file and change into default_path: '%kernel.project_dir%/templates' this line. I am taking the default path for this project.
  • To organize the files for particular things I love to create folder by folder for it's related files.
  • Create a folder called Offices where we'll store all Offices related files.
  • First of all create a file called index.html.twig inside Offices folder
  • add bellow html code into index.html.twig for an example purpose

<h1> {{ title }}</h1> <div> <h3>What is Lorem Ipsum?</h3> <p>Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.</p>  <br>  <h3>Why do we use it?</h3>  <p>It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like).</p>  </div>

• Now we are going to call this view file from controller. Open OfficesController.php file and paste the bellow code inside index function.

$pageTitle = "Yahooo!!! our first page is landed."; return $this->render('Offices/index.html.twig', [ 'title' => $pageTitle ]);

<!-- - Add ```SerializerInterface``` into the ```indexAction``` function --> 

• Now lets call the route. Create a .htaccess into your public directory and bellow code into their to remove index.php from url.

<IfModule mod_rewrite.c> <IfModule mod_negotiation.c> Options -MultiViews -Indexes </IfModule> RewriteEngine On # Handle Authorization Header RewriteCond %{HTTP:Authorization} . RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}] # Redirect Trailing Slashes If Not A Folder... RewriteCond %{REQUEST_FILENAME} !-d RewriteCond %{REQUEST_URI} (.+)/$ RewriteRule ^ %1 [L,R=301] # Handle Front Controller... RewriteCond %{REQUEST_FILENAME} !-d RewriteCond %{REQUEST_FILENAME} !-f RewriteRule ^ index.php [L] </IfModule>

• To more organize our application we are creating a folder called Routes into src directory and going to map it with the main route file config/routes.yaml by add this code

web_app: resource: "../src/Routes/routes.yml" prefix: /web

- here ```prefix``` is not mendatory. 

• Inside Routes folder Create a file routes.yml and a folder web
• Now Open the routes.yml file and add bellow code

web_app_offices: resource: "web/web_routes.yaml" # prefix: /web

- here ```prefix``` is not mendatory. 

• Inside web folder Create a file web_routes.yaml and add bellow code
  • TestController is a controller and index is a function, what we create earlier
  • path index is the last part of our route

web_app_index: path: /index methods: GET controller: App\Controller\OfficesController::index

• Now browse http://127.0.0.1:8000/web/index Seeeeeeeee!!!! we are done!!!

• Md. Noor-A-Alam Siddique