symfony-bundle nami-core-bundle

phpink/nami-core-bundle

Nami CMS - CORE Bundle

Welcome to the NamiCoreBundle repository - a Symfony 2.7 bundle., _(*1)

, _(*2)

PhpInk\Nami\CoreBundle is the main bundle of a Nami CMS application. It contains the dependencies configuration, Doctrine ORM/ODM mapping and FOSRest controllers to provide an API., _(*3)

1) Installation

Getting started

Run the following command to install the bundle :, _(*4)

composer require phpink/nami-core-bundle

To get NAMI working with MongoDB, after specifying the configuration driver to ''odm''' instead of '''orm''', add the following line to your composer.json :, _(*5)

        "doctrine/mongodb-odm-bundle": "3.0.*@dev",

Then, add the following line to your AppKernel.php :, _(*6)

        new Doctrine\Bundle\MongoDBBundle\DoctrineMongoDBBundle(),

Generate new RSA keys [optional]

Run the following OpenSSL commands to generate RSA keys for JSON Web Token authentication :, _(*7)

openssl genrsa -out app/var/jwt/private.pem -aes256 4096
openssl rsa -pubout -in app/var/jwt/private.pem -out app/var/jwt/public.pem

2) API endpoints

All available endpoints are available in a Postman dump, _(*8)

nami.postman_collection

Some http client you can run to test the API :, _(*9)

GET     http://host/api-doc/     REST API documentation [HTML]
GET     http://host/api/         REST API ping [JSON]
POST    http://host/api/token    API token getter [JSON]
GET     http://host/api/pages    API get all method [JSON]
GET     http://host/api/pages/1  API get one method [JSON]
POST    http://host/api/pages/1  API update one method [JSON]
DELETE  http://host/api/pages/1  API delete one method [JSON]

What's inside?

The bundle is configured with the following defaults:, _(*10)

• Twig is the only configured template engine;, _(*11)

• Translations are activated, _(*12)

• Doctrine ORM/DBAL or Doctrine MongoDB is configured;, _(*13)

• Swiftmailer is configured;, _(*14)

• Annotations for everything are enabled., _(*15)

It comes pre-configured with the following bundles:, _(*16)

• FrameworkBundle - The core Symfony framework bundle, _(*17)

• SensioFrameworkExtraBundle - Adds several enhancements, including template and routing annotation capability, _(*18)

• DoctrineBundle - Adds support for the Doctrine ORM, _(*19)

• DoctrineMongoDBBundle - Adds support for the Doctrine ODM, _(*20)

• DoctrineExtensions - Doctrine2 behavioral extensions, _(*21)

• DoctrineFixtures (in dev/test env) - Load data fixtures into the Doctrine ORM, _(*22)

• TwigBundle - Adds support for the Twig templating engine, _(*23)

• SecurityBundle - Adds security by integrating Symfony's security component, _(*24)

• SwiftmailerBundle - Adds support for Swiftmailer, a library for sending emails, _(*25)

• MonologBundle - Adds support for Monolog, a logging library, _(*26)

• AsseticBundle - Adds support for Assetic, an asset processing library, _(*27)

• WebProfilerBundle (in dev/test env) - Adds profiling functionality and the web debug toolbar, _(*28)

• SensioDistributionBundle (in dev/test env) - Adds functionality for configuring and working with Symfony distributions, _(*29)

• SensioGeneratorBundle (in dev/test env) - Adds code generation capabilities, _(*30)

• FOSRestBundle - Adds rest functionality, _(*31)

• FOSHttpCacheBundle - This bundle offers tools to improve HTTP caching with Symfony2, _(*32)

• NelmioApiDocBundle - Add API documentation features, _(*33)

• BazingaHateoasBundle - Adds HATEOAS support, _(*34)

• HautelookTemplatedUriBundle - Adds Templated URIs (RFC 6570) support, _(*35)

• BazingaRestExtraBundle, _(*36)

• LexikJWTAuthenticationBundle - JSON Web Token generation, _(*37)

• GfreeauGetJWTBundle - JSON Web Token authentication, _(*38)

• LiipImagineBundle - Image thumbnail generation, _(*39)

Enjoy!, _(*40)

API inner working

Controllers

CoreBundle controllers extend a base AbstractController, which contains a set of methods for the Doctrine CRUD worflow. Associated Doctrine model/repository & FormType class names are guessed automatically., _(*41)

For example: NamiCoreBundle:Model\Orm\User entity & NamiCoreBundle:Form\UserType for NamiCoreBundle:Controller\UserController., _(*42)

The doctrine repository used by the controller to run the generic CRUD commands is the one associated by default to the model. A different one can be called :, _(*43)

public function getEntitiesAction() {
    $productRepo = $this->getRepository('Product'); // From model name
    // or
    $productRepo = $this->getRepository('\PhpInk\Nami\CoreBundle\Model\Orm\Products'); // More specific
    ...
    return $this->restView(...); // Returns a JSON response
}

Repositories

Core repositories extend a base AbstractRepository, which contains all the CRUD methods called from controllers. Repositories can overload the base properties, such as orderByFields, filterByFields., _(*44)

They must implement a buildItemsQuery method that will be called to create the Doctrine QueryBuilder retrieving one or more item from the database., _(*45)

As for creation & update, the controllers instantiate the form type related to the associated model., _(*46)

Json TO Forms

A JsonDecoder is implemented and modifies the input request data. It is called from the FosRest body listener (configuration is in src/PhpInk/CoreBundle/DependencyInjection/NamiCoreBundleExtension.php)., _(*47)

It transforms json input booleans true,false into optional 0,1 checkboxes for FormTypes., _(*48)

To execute specific code after an item creation or update, take a look at the UserController::onPostSave method that sends the user confirmation mail., _(*49)