raulfraile/sublime-symfony2

This is a Sublime Text package which includes handy snippets for doing Symfony2 framework development.

Important: The master branch of this plugin will always be in sync with the latest stable release of Symfony2.

Installation

With Package Control

If you have the Package Control package installed, you can install Symfony2 Snippets from inside Sublime Text itself. Open the Command Palette and select "Package Control: Install Package", then search for Symfony2 Snippets.

Without Package Control

If you haven't got Package Control installed you will need to make a clone of this repository into your packages folder, like so:

git clone https://github.com/raulfraile/sublime-symfony2 symfony2-snippets

If you need to install a specific branch of the plugin (2.0 in this example), please use the following commands:

cd symfony2-snippets
git checkout origin/2.0

Shortcuts

All shortcuts start with the sf prefix and are both short and intuitive:

Controller

sfcontroller

use Symfony\Bundle\FrameworkBundle\Controller\Controller;

class DefaultController extends Controller
{
    public function indexAction()
    {
        return $this->render('.html.twig');
    }
}

sfcontrollera

use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;

class DefaultController extends Controller
{
    /**
     * @Route("/", name="")
     * @Template()
     */
    public function indexAction()
    {

    }
}

sfaction

public function indexAction()
{
    return $this->render('.html.twig');
}

sfactiona

/**
 * @Route("/", name="")
 * @Template()
 */
public function indexAction()
{

}

sfem

$em = $this->getDoctrine()->getManager();

sfrepo

$em->getRepository('Bundle:Repository');

sfforward

$this->forward('Bundle:Controller:action', array(), array());

sfredirect

$this->redirect($this->generateUrl('route', array()));

sfrender

$this->render('Bundle:Folder:template.html.twig', array());

sfgetsession

$this->getRequest()->getSession();

sfsetflash

$this->get('session')->getFlashBag()->add('type', 'message');

sfdump

\Doctrine\Common\Util\Debug::dump();

Command

sfcommand

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

class DefaultCommand extends Command
{
    /**
     * {@inheritdoc}
     */
    protected function configure()
    {
        $this
            ->setName('default:command')
            ->setDescription('Default description')
        ;
    }

    /**
     * {@inheritdoc}
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {

    }
}

sfcommandca

use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

class DefaultCommand extends ContainerAwareCommand
{
    /**
     * {@inheritdoc}
     */
    protected function configure()
    {
        $this
            ->setName('default:command')
            ->setDescription('Default description')
        ;
    }

    /**
     * {@inheritdoc}
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {

    }
}

Doctrine

Classes

sfentityclass

use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Validator\Constraints as Assert;

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

sfdocumentclass

use Doctrine\ODM\MongoDB\Mapping\Annotations as MongoDB;
use Symfony\Component\Validator\Constraints as Assert;

/**
 * @MongoDB\Document(collection="", repositoryClass="")
 */
class Document
{
    /**
     * @MongoDB\Id()
     */
    protected $id;
}

sfrepository

use Doctrine\ORM\EntityRepository;

class EntityNameRepository extends EntityRepository
{
}

sfgetset Just type your variable name (firstName for instance), and the snippets will name the functions automatically (getFirstName).

/**
* Get 
* @return  
*/
public function get()
{
    return $this->;
}

/**
* Set 
* @return $this
*/
public function set($)
{
    $this-> = $;
    return $this;
}

Annotations

After triggering the snippets, just type your var name and it will automatically set the name in the annotation (If you type 'firstName', your variable will be named 'firstName' and in the annotation the name will be 'first_name').

sfentity

/**
 * @ORM\Entity()
 * @ORM\Table(name="name")
 */

sfidcolumn

/**
 * @ORM\Column(name="id", type="integer", nullable=false)
 * @ORM\Id()
 * @ORM\GeneratedValue(strategy="IDENTITY")
 */
 private $id;

sfstringcolumn

/**
 * @ORM\Column(name="", type="string", length=255)
 */
 private $;

sfdecimalcolumn

/**
 * @ORM\Column(name="", type="decimal", scale=2)
 */
 private $;

sftextcolumn

/**
 * @ORM\Column(name="", type="text")
 */
 private $;

sfintegercolumn

/**
 * @ORM\Column(name="", type="integer")
 */
 private $;

sfbooleancolumn

/**
 * @ORM\Column(name="", type="boolean")
 */
 private $;

sfsmallintcolumn

/**
 * @ORM\Column(name="", type="smallint")
 */
 private $;

sfbigintcolumn

/**
 * @ORM\Column(name="", type="bigint")
 */
 private $;

sfdatetimecolumn

/**
 * @ORM\Column(name="", type="datetime")
 */
 private $;

sfdatecolumn

/**
 * @ORM\Column(name="", type="date")
 */
 private $;

sftimecolumn

/**
 * @ORM\Column(name="", type="time")
 */
 private $;

sffloatcolumn

/**
 * @ORM\Column(name="", type="float")
 */
 private $;

sfarraycolumn

/**
 * @ORM\Column(name="", type="array")
 */
 private $;

sfobjectcolumn

/**
 * @ORM\Column(name="", type="object")
 */
 private $;

Forms

sfform

use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;

class NameType extends AbstractType
{
    /**
     * {@inheritdoc}
     */
    public function buildForm(FormBuilderInterface $builder, array $options)
    {

    }

    /**
     * {@inheritdoc}
     */
    public function configureOptions(OptionsResolver $resolver)
    {
        $resolver->setDefaults(array(
            'data_class' => '',
        ));
    }

    /**
     * {@inheritdoc}
     */
    public function getName()
    {
        return 'name';
    }
}

sfdatatransformer

use Symfony\Component\Form\DataTransformerInterface;
use Symfony\Component\Form\Exception\UnexpectedTypeException;
use Symfony\Component\Form\Exception\TransformationFailedException;

class NameTransformer implements DataTransformerInterface
{
    /**
     * {@inheritdoc}
     */
    public function transform($value)
    {

    }

    /**
     * {@inheritdoc}
     */
    public function reverseTransform($value)
    {

    }
}

Twig

sftwigextension

class NameExtension extends \Twig_Extension
{
    /**
     * {@inheritdoc}
     */
    public function getFilters()
    {
        return array();
    }

    /**
     * {@inheritdoc}
     */
    public function getTests()
    {
        return array();
    }

    /**
     * {@inheritdoc}
     */
    public function getFunctions()
    {
        return array();
    }
}

sftwigform

<form class="" action="{{ path('') }}" method="post" {{ form_enctype(form) }}>
    {{ form_errors(form) }}
    {{ form_widget(form) }}
    <input type="submit" value="Submit" />
</form>

sftwigrow

{{ form_row(form.) }}

trans

{% trans %}{% endtrans %}

Template

sfasset

{{ asset('bundles/')}}

sfasseticjs

{% javascripts '@/Resources/public/js/*' %}
    <script type="text/javascript" src="{{ asset_url }}"></script>
{% endjavascripts %}

sfasseticcss

{% stylesheets 'bundles//css/*' filter='cssrewrite' %}
    <link rel="stylesheet" href="{{ asset_url }}" />
{% endstylesheets %}

Validation

sfconstraint

use Symfony\Component\Validator\Constraint;

/**
 * @Annotation
 */
class NameConstraint extends Constraint
{
    public $message = '';
}

sfconstraintvalidator

use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\ConstraintValidator;

class NameValidator extends ConstraintValidator
{
    public function validate($value, Constraint $constraint)
    {

    }
}

DependencyInjection

sfdiconfiguration

use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;

class Configuration implements ConfigurationInterface
{
    public function getConfigTreeBuilder()
    {
        $treeBuilder = new TreeBuilder();
        $rootNode = $treeBuilder->root('bundle_name');

        $rootNode
            ->children()
                ->scalarNode('enabled')
                    ->setInfo('Enable the container extension')
                    ->setDefault(true)
                ->end()
            ->end()
        ;

        return $treeBuilder;
    }
}

sfdiextension

use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
use Symfony\Component\HttpKernel\DependencyInjection\Extension;

class BundleExtension extends Extension
{
    public function load(array $configs, ContainerBuilder $container)
    {
        $config = $this->processConfiguration(new Configuration(), $configs);
        if (false === $config['enabled']) {
            return;
        }

        $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
        $loader->load('services.xml');
    }
}

sfdiservices

<?xml version="1.0" ?>

<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">

    <services>
        <service id="id" class="class" />
    </services>
</container>

YAML

sfroute

route_name:
    path:   /
    defaults:  { _controller: Bundle:Controller:action }

Contribute

If you miss something, feel free to fork this repository and send a PR with your awesome snippets for Symfony2 :)

Contributors list

Raúl Fraile: github | twitter
Pierre-Yves LEBECQ: github | twitter
Willemsen Christophe: github | twitter
Alexandre Salomé: github
Purple Babar: github

raulfraile / sublime-symfony2