kif/doctrine_typescript_bundle

convert doctrine entities into typescript classes

KifDoctrineToTypescriptBundle

Main Concept

This is a command line tool for converting doctrine entities into Typescript language files. TypeScript is a typed superset of JavaScript that compiles to plain JavaScript, and heavily uses OOP-Terminolgy and structuring., _(*1)

A typical Scenario, is if you have a frontEnd based on Typscript/Javascript, and a backend based on symfony/php, and you want to have a unified DTO/MODEL representation between both. So if you structure something using doctrine, you want it autoamtically generated in your javascript part of the project, without needed to write the code for it., _(*2)

Installation

``` bash $ php composer.phar require kif/doctrine_typescript_bundle 'dev-master', <sub>(*3)</sub>

* activate the bundle in your <code>app/AppKernel.php</code> file
<br>

``` php
<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
            new Kif\DoctrineToTypescriptBundle\KifDoctrineToTypescriptBundle(),
    );
}

Usage

Standard Usage

• in your symfony folder use the command

``` bash $ php app/console kif:doctrine:typescript:generate destination_folder, <sub>(*4)</sub>

<code>destination_folder</code> must be a writable folder.

This would generate a folder <code>/models/</code> in the given destination folder, with Typescript files containing all the models
represented in your symfony project as doctrine entities

so let us imagine we have a single Doctrine Entity in our Project:

``` php
<?php
// src/Acme/UserBundle/Entity/Contact.php

namespace Acme\UserBundle\Entity;

use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Entity
 * @ORM\Table(name="contacts")
 */
class Contact
{
    /**
     * @ORM\Id
     * @ORM\Column(type="integer")
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    protected $id;

    /**
     * @var string
     *
     * @ORM\Column(name="nick_name", type="string", length=255, nullable=true)
     */
    private $nickName;

}

Now if we run the command, <sub>(*5)</sub>

``` bash $ php app/console kif:doctrine:typescript:generate src/typscript, <sub>(*6)</sub>

we will find the following file gets generated

``` bash
$ src/typscript/models/AcmeUserBundleEntity/Contact.ts

with the content, <sub>(*7)</sub>

``` typescript, <sub>(*8)</sub>

module AcmeUserBundleEntity {, <sub>(*9)</sub>

export class Contact {, <sub>(*10)</sub>

private _id:number ;, <sub>(*11)</sub>

get id(){, <sub>(*12)</sub>

return this._id;, <sub>(*13)</sub>

}, <sub>(*14)</sub>

set id(_id:number){, <sub>(*15)</sub>

this._id=_id;, <sub>(*16)</sub>

}, <sub>(*17)</sub>

private _nickName:string ;, <sub>(*18)</sub>

get nickName(){, <sub>(*19)</sub>

return this._nickName;, <sub>(*20)</sub>

}, <sub>(*21)</sub>

set nickName(_nickName:string){, <sub>(*22)</sub>

this._nickName=_nickName;, <sub>(*23)</sub>

}, <sub>(*24)</sub>

Now you can have access to the generated model easily in your Typescript code


``` typescript

///<reference path="models/AcmeUserBundleEntity/Contact"/>
var contact = new AcmeUserBundleEntity.Contact();
contact.nickName = "myNickname";
alert(contact.nickName);

Usage with option --exposed-only

Important: For this to work correctly, you need to have the JMS Serialzer Bundle installed correctly., <sub>(*25)</sub>

There are cases, where you want to generate only Entites and fields, that are exposed by the JMS serializer, because you want to keep the rest private or hidden from other parts of your project., <sub>(*26)</sub>

Let us revist the doctrine entity from earlier., <sub>(*27)</sub>

``` php <?php // src/Acme/UserBundle/Entity/Contact.php //... use JMS\Serializer\Annotation\ExclusionPolicy; use JMS\Serializer\Annotation\Expose;, <sub>(*28)</sub>

• @ORM\Table(name="contacts"), <sub>(*29)</sub>

  • @ExclusionPolicy("all") */ class Contact { //...

  /**, <sub>(*30)</sub>

  • @Expose */ private $nickName;

}, <sub>(*31)</sub>

Notice the annotation <code>@ExclusionPolicy("all")</code> that excludes all fields, and the annotation <code>@Expose</code>
right over the field <code>$nickName</code>. This would generate the following Typescript file.


``` typescript

module AcmeUserBundleEntity {


private _nickName:string ;

get nickName(){

return  this._nickName;

}

set nickName(_nickName:string){

this._nickName=_nickName;

}

Notice how only the field $nickName was generated ,while the rest was ignored. (hidden), <sub>(*32)</sub>

Also note that only entites where @ExclusionPolicy is set as (none or all) are generated. So entites without this annotation get automatically recognized as @ExclusionPolicy(all) and get completey ignored by the generator, <sub>(*33)</sub>

Todo

• set a --single-file option to a generate all models in a single .ts/js file. This should stop the bundle-to-folder mechanism. The name of the generated file would be simply "models.ts"
• when using --exposed-only option be able to disable the setters when the field is @readOnly