Sorting/Reording Symfony2 Entities Display Order.

So i had to implement a mechanism to re-order Categories and also Boards for my forum bundle, and with though there are many ways to go about it, here is how i solved the problem of reordering them. The reordering functionality is circular so last items getting pushed down end up on the top of the list, and top items getting pushed up end up on the bottom of the list.

    /**
     *
     * @access public
     * @param  Array                                               $categories
     * @param  \CCDNForum\ForumBundle\Entity\Category              $categoryShift
     * @param  int                                                 $direction
     * @return \CCDNForum\ForumBundle\Manager\BaseManagerInterface
     */
    public function reorderCategories($categories, Category $categoryShift, $direction)
    {
		$categoryCount = (count($categories) - 1);
		
		// Find category in collection to shift and use list order as array key for easier editing.
		$sorted = array();
		$shiftIndex = null;
		foreach ($categories as $categoryIndex => $category) {
			if ($categories[$categoryIndex]->getId() == $categoryShift->getId()) {
				$shiftIndex = $categoryIndex;
			}
			
			$sorted[$categoryIndex] = $category;
		}

		$incrementKeysAfterIndex = function($index, $arr) {
			$hydrated = array();
		
			foreach ($arr as $key => $el) {
				if ($key > $index) {
					$hydrated[$key + 1] = $el;
				} else {
					$hydrated[$key] = $el;
				}
			}
		
			return $hydrated;
		};
		
		$decrementKeysBeforeIndex = function($index, $arr) {
			$hydrated = array();
		
			foreach ($arr as $key => $el) {
				if ($key < $index) {
					$hydrated[$key - 1] = $el;
				} else {
					$hydrated[$key] = $el;
				}
			}
			
			return $hydrated;
		};
			
		$shifted = array();
		
		// First Category needs reordering??
		if ($shiftIndex == 0) {
			if ($direction) { // Down (move down 1)
				$shifted = $sorted;
				$shifted[$shiftIndex] = $sorted[$shiftIndex + 1];
				$shifted[$shiftIndex + 1] = $sorted[$shiftIndex];
			} else { // Up (send to bottom)
				$shifted[$categoryCount] = $sorted[0];
				unset($sorted[0]);
				$shifted = array_merge($decrementKeysBeforeIndex($categoryCount + 1, $sorted), $shifted);
			}
		} else {
			// Last category needs reordering??
			if ($shiftIndex == $categoryCount) {
				if ($direction) { // Down (send to top)
					$shifted[0] = $sorted[$categoryCount];
					unset($sorted[$categoryCount]);
					$shifted = array_merge($shifted, $incrementKeysAfterIndex(-1, $sorted));
				} else { // Up (move up 1)
					$shifted = $sorted;
					$shifted[$shiftIndex] = $sorted[$shiftIndex - 1];
					$shifted[$shiftIndex - 1] = $sorted[$shiftIndex];
				}
			} else {
				// Swap 2 categories not at beginning or end.
				$shifted = $sorted;
				if ($direction) { // Down (move down 1)
					$shifted[$shiftIndex] = $sorted[$shiftIndex + 1];
					$shifted[$shiftIndex + 1] = $sorted[$shiftIndex];
				} else { // Up (move up 1)
					$shifted[$shiftIndex] = $sorted[$shiftIndex - 1];
					$shifted[$shiftIndex - 1] = $sorted[$shiftIndex];
				}
			}
		}
		
		// Set the order from the $index arranged prior and persist.
		foreach ($shifted as $index => $category) {
			$category->setListOrderPriority($index);
			$this->persist($category);
		}
		
        $this->flush();

        return $this;
    }

/**

* @access public

* @param Array $categories

* @param \CCDNForum\ForumBundle\Entity\Category $categoryShift

* @param int $direction

* @return \CCDNForum\ForumBundle\Manager\BaseManagerInterface

public function reorderCategories($categories, Category $categoryShift, $direction)

{

$categoryCount = (count($categories) - 1);

// Find category in collection to shift and use list order as array key for easier editing.

$sorted = array();

$shiftIndex = null;

foreach ($categories as $categoryIndex => $category) {

if ($categories[$categoryIndex]->getId() == $categoryShift->getId()) {

$shiftIndex = $categoryIndex;

}

$sorted[$categoryIndex] = $category;

}

$incrementKeysAfterIndex = function($index, $arr) {

$hydrated = array();

foreach ($arr as $key => $el) {

if ($key > $index) {

$hydrated[$key + 1] = $el;

} else {

$hydrated[$key] = $el;

}

return $hydrated;

};

$decrementKeysBeforeIndex = function($index, $arr) {

$hydrated = array();

foreach ($arr as $key => $el) {

if ($key < $index) {

$hydrated[$key - 1] = $el;

} else {

$hydrated[$key] = $el;

}

return $hydrated;

};

$shifted = array();

// First Category needs reordering??

if ($shiftIndex == 0) {

if ($direction) { // Down (move down 1)

$shifted = $sorted;

$shifted[$shiftIndex] = $sorted[$shiftIndex + 1];

$shifted[$shiftIndex + 1] = $sorted[$shiftIndex];

} else { // Up (send to bottom)

$shifted[$categoryCount] = $sorted[0];

unset($sorted[0]);

$shifted = array_merge($decrementKeysBeforeIndex($categoryCount + 1, $sorted), $shifted);

}

} else {

// Last category needs reordering??

if ($shiftIndex == $categoryCount) {

if ($direction) { // Down (send to top)

$shifted[0] = $sorted[$categoryCount];

unset($sorted[$categoryCount]);

$shifted = array_merge($shifted, $incrementKeysAfterIndex(-1, $sorted));

} else { // Up (move up 1)

$shifted = $sorted;

$shifted[$shiftIndex] = $sorted[$shiftIndex - 1];

$shifted[$shiftIndex - 1] = $sorted[$shiftIndex];

}

} else {

// Swap 2 categories not at beginning or end.

$shifted = $sorted;

if ($direction) { // Down (move down 1)

$shifted[$shiftIndex] = $sorted[$shiftIndex + 1];

$shifted[$shiftIndex + 1] = $sorted[$shiftIndex];

} else { // Up (move up 1)

$shifted[$shiftIndex] = $sorted[$shiftIndex - 1];

$shifted[$shiftIndex - 1] = $sorted[$shiftIndex];

}

// Set the order from the $index arranged prior and persist.

foreach ($shifted as $index => $category) {

$category->setListOrderPriority($index);

$this->persist($category);

}

$this->flush();

return $this;

}

What do you guys think? Know of a better approach? Let me know!

Custom Validators on Validation Groups in Symfony2.

If you are using validation groups and have created a custom validator, you will want to use it in your validation group, however its a bit different from how you would apply validators in the entity, and quite similar in-fact to how you define services.

Its similar to how you define services because you have 2 root nodes, first somewhat like services.yml’s parameters line, in this instance called ‘namespaces’, the second part matches the entities name which the validator will be applied to.

Starting out, your validator.yml file probably looks like this:

CCDNComponent\AttachmentBundle\Entity\Attachment:
    properties:
        description: 
            - Type: { type: string, groups: [upload] }
            - MaxLength: { limit: 1000, groups: [upload] }
        attachment:
            - NotNull: { groups: [upload] }
            - File: { groups: [upload] }

CCDNComponent\AttachmentBundle\Entity\Attachment:

properties:

description:

- Type: { type: string, groups: [upload] }

- MaxLength: { limit: 1000, groups: [upload] }

attachment:

- NotNull: { groups: [upload] }

- File: { groups: [upload] }

This is an example taken from my AttachmentBundle, which you can find here.

Now, when we have a custom validator, in this case, some validators to check a users quota on file uploads etc, we need to set a namespace for our custom validators, with the namespace parameter, and then reference that namespace below followed by our custom validator.

namespaces:
    CCDNComponentAttachmentBundle: CCDNComponent\AttachmentBundle\Form\Validator\Constraints\

CCDNComponent\AttachmentBundle\Entity\Attachment:
    properties:
        description: 
            - Type: { type: string, groups: [upload] }
            - MaxLength: { limit: 1000, groups: [upload] }
        attachment:
            - NotNull: { groups: [upload] }
            - File: { groups: [upload] }
            - "CCDNComponentAttachmentBundle:UploadQuotaFileSize": { groups: [upload] }
            - "CCDNComponentAttachmentBundle:UploadQuotaDiskSpace": { groups: [upload] }
            - "CCDNComponentAttachmentBundle:UploadQuotaFileQuantity": { groups: [upload] }

namespaces:

CCDNComponentAttachmentBundle: CCDNComponent\AttachmentBundle\Form\Validator\Constraints\

CCDNComponent\AttachmentBundle\Entity\Attachment:

properties:

description:

- Type: { type: string, groups: [upload] }

- MaxLength: { limit: 1000, groups: [upload] }

attachment:

- NotNull: { groups: [upload] }

- File: { groups: [upload] }

- "CCDNComponentAttachmentBundle:UploadQuotaFileSize": { groups: [upload] }

- "CCDNComponentAttachmentBundle:UploadQuotaDiskSpace": { groups: [upload] }

- "CCDNComponentAttachmentBundle:UploadQuotaFileQuantity": { groups: [upload] }

The name of the validator must be wrapped in double quotes so that Symfony2 is aware that this is using a custom validator, inside of which we first start the namespace, and secondly the validator alias.

We define the alias of our validator in our services.yml like so:

Parameters:
    ccdn_component_attachment.validator.upload_quota_disk_space.class:      CCDNComponent\AttachmentBundle\Form\Validator\UploadQuotaDiskSpaceValidator
    ccdn_component_attachment.validator.upload_quota_file_quantity.class:   CCDNComponent\AttachmentBundle\Form\Validator\UploadQuotaFileQuantityValidator
    ccdn_component_attachment.validator.upload_quota_file_size.class:       CCDNComponent\AttachmentBundle\Form\Validator\UploadQuotaFileSizeValidator

Services:
    ccdn_component_attachment.validator.upload_quota_disk_space:
        class: %ccdn_component_attachment.validator.upload_quota_disk_space.class%
        arguments: [@doctrine, @service_container]
        tags:
            - { name: validator.constraint_validator, alias: upload_quota_disk_space }
    ccdn_component_attachment.validator.upload_quota_file_quantity:
        class: %ccdn_component_attachment.validator.upload_quota_file_quantity.class%
        arguments: [@doctrine, @service_container]
        tags:
            - { name: validator.constraint_validator, alias: upload_quota_file_quantity }
    ccdn_component_attachment.validator.upload_quota_file_size:
        class: %ccdn_component_attachment.validator.upload_quota_file_size.class%
        arguments: [@doctrine, @service_container]
        tags:
            - { name: validator.constraint_validator, alias: upload_quota_file_size }

Parameters:

ccdn_component_attachment.validator.upload_quota_disk_space.class: CCDNComponent\AttachmentBundle\Form\Validator\UploadQuotaDiskSpaceValidator

ccdn_component_attachment.validator.upload_quota_file_quantity.class: CCDNComponent\AttachmentBundle\Form\Validator\UploadQuotaFileQuantityValidator

ccdn_component_attachment.validator.upload_quota_file_size.class: CCDNComponent\AttachmentBundle\Form\Validator\UploadQuotaFileSizeValidator

Services:

ccdn_component_attachment.validator.upload_quota_disk_space:

arguments: [@doctrine, @service_container]

tags:

- { name: validator.constraint_validator, alias: upload_quota_disk_space }

ccdn_component_attachment.validator.upload_quota_file_quantity:

arguments: [@doctrine, @service_container]

tags:

- { name: validator.constraint_validator, alias: upload_quota_file_quantity }

ccdn_component_attachment.validator.upload_quota_file_size:

arguments: [@doctrine, @service_container]

tags:

- { name: validator.constraint_validator, alias: upload_quota_file_size }

Creating embedded forms in Symfony 2.0

If you are looking to create a form from 2 or more entities, like i have been then you probably find the documentation somewhat lacking and confusing. If you follow the guides you can get your form working if you start from the least dependant entity making that the first entity you use to build your form from your controller. I find if you start from the most dependant you usually get all manner of errors.

What i have is a basic forum i am working on, in my current form situation i have 3 entities, Board entity, a Thread entity and a Post entity. If you start by creating your form with Board then chances are it won’t work, i created my forms in separate ‘Type’ classes (PostType.php ThreadType.php and BoardType.php) and then created my PostType form in my controller, which then sorts out its dependencies on its own.

My controller class is very basic and not very polished, but here is what it looks like:

// In your controller 
public function createAction($board_id)
{
	$board = $this->getDoctrine()
		->getRepository('CodeConsortiumForumBundle:Board')
		->find($board_id);

	$post = new post();

	$form = $this->createForm(new PostType(), $post);

	$formHandler = new PostFormHandler($form, $this->getRequest(), $post);

	if ($formHandler->process()) 
	{
		$em = $this->get('doctrine')->getEntityManager();
		$em->persist($form->getData());
		$em->flush();

		//return $this->redirect($this->generateUrl('thread_show', array( 'thread_id' => $thread_id ) ));
	}
	else
	{
		return $this->render('CodeConsortiumForumBundle:Thread:create.html.twig', array(
			'board' => $board,
			'form' => $form->createView(),
			));
		}

	}
}

// In your controller

public function createAction($board_id)

{

$board = $this->getDoctrine()

->getRepository('CodeConsortiumForumBundle:Board')

->find($board_id);

$post = new post();

$form = $this->createForm(new PostType(), $post);

$formHandler = new PostFormHandler($form, $this->getRequest(), $post);

if ($formHandler->process())

{

$em = $this->get('doctrine')->getEntityManager();

$em->persist($form->getData());

$em->flush();

//return $this->redirect($this->generateUrl('thread_show', array( 'thread_id' => $thread_id ) ));

}

else

{

return $this->render('CodeConsortiumForumBundle:Thread:create.html.twig', array(

'board' => $board,

'form' => $form->createView(),

));

}

It probably looks somewhat messy as i say, its a rough work in progress, but it works, and here are the FormTypes i used, starting with; PostType.php:

<?php
// CodeConsortium/ForumBundle/Form/Type/PostType.php
namespace CodeConsortium\ForumBundle\Form\Type;

use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilder;

class PostType extends AbstractType
{

	private $options;

	public function __construct(array $options = null)
	{
		$this->options = $options;
	}

	public function buildForm(FormBuilder $builder, array $options)
	{
		$builder->add('Thread', new ThreadType($this->options) );
		$builder->add('body');
	}

	// for creating and replying to threads
	public function getDefaultOptions(array $options)
	{
		return array(
			'data_class' => 'CodeConsortium\ForumBundle\Entity\Post',
		);
	}

	public function getName()
	{
		return 'Post';
	}

}

<?php

// CodeConsortium/ForumBundle/Form/Type/PostType.php

namespace CodeConsortium\ForumBundle\Form\Type;

use Symfony\Component\Form\AbstractType;

use Symfony\Component\Form\FormBuilder;

class PostType extends AbstractType

{

private $options;

public function __construct(array $options = null)

{

$this->options = $options;

}

public function buildForm(FormBuilder $builder, array $options)

{

$builder->add('Thread', new ThreadType($this->options) );

$builder->add('body');

}

// for creating and replying to threads

public function getDefaultOptions(array $options)

{

return array(

'data_class' => 'CodeConsortium\ForumBundle\Entity\Post',

);

}

public function getName()

{

return 'Post';

}

ThreadType.php

<?php
// CodeConsortium/ForumBundle/Form/Type/PostType.php
namespace CodeConsortium\ForumBundle\Form\Type;

use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilder;

class PostType extends AbstractType
{

	private $options;

	public function __construct(array $options = null)
	{
		$this->options = $options;
	}

	public function buildForm(FormBuilder $builder, array $options)
	{
		$builder->add('Thread', new ThreadType($this->options) );
		$builder->add('body');
	}

	// for creating and replying to threads
	public function getDefaultOptions(array $options)
	{
		return array(
			'data_class' => 'CodeConsortium\ForumBundle\Entity\Post',
		);
	}

	public function getName()
	{
		return 'Post';
	}

}

<?php

// CodeConsortium/ForumBundle/Form/Type/PostType.php

namespace CodeConsortium\ForumBundle\Form\Type;

use Symfony\Component\Form\AbstractType;

use Symfony\Component\Form\FormBuilder;

class PostType extends AbstractType

{

private $options;

public function __construct(array $options = null)

{

$this->options = $options;

}

public function buildForm(FormBuilder $builder, array $options)

{

$builder->add('Thread', new ThreadType($this->options) );

$builder->add('body');

}

// for creating and replying to threads

public function getDefaultOptions(array $options)

{

return array(

'data_class' => 'CodeConsortium\ForumBundle\Entity\Post',

);

}

public function getName()

{

return 'Post';

}

And lastly, the BoardType.php

<?php
// CodeConsortium/ForumBundle/Form/Type/BoardType.php
namespace CodeConsortium\ForumBundle\Form\Type;

use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilder;

class BoardType extends AbstractType
{

	private $options;

	public function __construct(array $options = null)
	{
		$this->options = $options;
	}

	public function buildForm(FormBuilder $builder, array $options)
	{

	}

	// for creating and replying to threads
	public function getDefaultOptions(array $options)
	{
		return array(
			'data_class' => 'CodeConsortium\ForumBundle\Entity\Board',
		);
	}

	public function getName()
	{
		return 'Board';
	}

}

<?php

// CodeConsortium/ForumBundle/Form/Type/BoardType.php

namespace CodeConsortium\ForumBundle\Form\Type;

use Symfony\Component\Form\AbstractType;

use Symfony\Component\Form\FormBuilder;

class BoardType extends AbstractType

{

private $options;

public function __construct(array $options = null)

{

$this->options = $options;

}

public function buildForm(FormBuilder $builder, array $options)

{

}

// for creating and replying to threads

public function getDefaultOptions(array $options)

{

return array(

'data_class' => 'CodeConsortium\ForumBundle\Entity\Board',

);

}

public function getName()

{

return 'Board';

}

Notice how i added a constructor, this is so we can easily chain feed in from the first object any changes to the form, such as wether we wish to bother including a field or not, we can opt to have any field removed if the form is used under different circumstances such as different access controls for different users with different permissions or if the form is used in another way on the site.

One more thing we need to make sure, is that all the references in our entities make use of the cascade={“persist”} option so that it maintains relations between the relevant forms as new ones get processed, so if say a thread does not exist then when processing the post, it should create one and do the association for us.

Here is an example of a snip from my Post entity class Post.php

 /**
 * @ORM\ManyToOne(targetEntity="Thread", inversedBy="posts", cascade={"persist"})
 * @ORM\JoinColumn(name="thread_id", referencedColumnName="id")
 */
 protected $thread;

/**

* @ORM\ManyToOne(targetEntity="Thread", inversedBy="posts", cascade={"persist"})

* @ORM\JoinColumn(name="thread_id", referencedColumnName="id")

protected $thread;

Lastly, you will need a formHandler if your not working in your controller, if using my example code then the postFormHandler.php looks like this:

<?php
// CodeConsortium/ForumBundle/Form/Handler/PostFormHandler.php
namespace CodeConsortium\ForumBundle\Form\Handler;

use Symfony\Component\Form\Form;
use Symfony\Component\HttpFoundation\Request;

use CodeConsortium\ForumBundle\Form\Type\PostType;
use CodeConsortium\ForumBundle\Entity\Post;

class PostFormHandler
{

	protected $request;
	protected $form;
	protected $post;

	public function __construct(Form $form, Request $request, $post) //, $entityManager)
	{
		$this->form = $form;
		$this->request = $request;
		$this->post = $post;
	}

	public function process()
	{
		//$form = $this->createForm(new PostType(), $this->post);
		//$this->form->setData($this->post);

		if ($this->request->getMethod() == 'POST')
		{
			$this->form->bindRequest($this->request);

			if ($this->form->isValid())
			{ 

				return true; 
			}

		}

		return false;
	}

}

<?php

// CodeConsortium/ForumBundle/Form/Handler/PostFormHandler.php

namespace CodeConsortium\ForumBundle\Form\Handler;

use Symfony\Component\Form\Form;

use Symfony\Component\HttpFoundation\Request;

use CodeConsortium\ForumBundle\Form\Type\PostType;

use CodeConsortium\ForumBundle\Entity\Post;

class PostFormHandler

{

protected $request;

protected $form;

protected $post;

public function __construct(Form $form, Request $request, $post) //, $entityManager)

{

$this->form = $form;

$this->request = $request;

$this->post = $post;

}

public function process()

{

//$form = $this->createForm(new PostType(), $this->post);

//$this->form->setData($this->post);

if ($this->request->getMethod() == 'POST')

{

$this->form->bindRequest($this->request);

if ($this->form->isValid())

{

return true;

}

return false;

}

M	T	W	T	F	S	S
« Aug
					1	2
3	4	5	6	7	8	9
10	11	12	13	14	15	16
17	18	19	20	21	22	23
24	25	26	27	28	29	30
31

Reece Fowells Blog

The home of a lot of crapola…

Tag: entities

Sorting/Reording Symfony2 Entities Display Order.

Custom Validators on Validation Groups in Symfony2.

Creating embedded forms in Symfony 2.0