Docs?

[renege]

Hi, bundle looks nice.

Is there a readme or some other documentation somewhere?

I'm curious how it looks like, how you handle the sorting with it, because I don't see any jQuery-kinda stuff in the public Resource folder.

If you don't have any documentation, can I see a screenshot of how it looks like?

[cannibal]

Apologies for late reply. The SortBundle was actually built because I was working on REST based apis, so was intended to be purely a backend library to improve code reuse in doctrine repositories / entity managers. It works with the filter bundle to provide some simple filtering and sorting mechanism for web service requests.

You could however very easily use these bundles to standardise search sorting and filtering within some action.

I will write some documentation, but I must confess that when I get time, these libraries will be refactored because ive decided that the SortCollection/FilterCollection pattern is untidy, and it would be cleaner to use something more global like a service. I was experimenting with some ideas along this line with the parameters bundle, but this is just work in progress.

Here is an example of how the sort and filter bundle work in a doctrine repository:

Request: /someAction?field1=testName&field2!=notThisOne
This would look for items where the field1 on the entity = 'testName' but field2 is not equal to 'notThisOne'

It also supports a more verbose syntax for example field1[in][] etc - checkout the FilterInterface and the FilterFetcher for supported functions.

public function queryStuff(FilterCollectionInterface $criteria, SortCollectionInterface $sorts = null)
{
    $builder = $this->createQueryBuilder('a');
    $factory = $this->getExprFactory();

    foreach(array('field1', 'field2') as $name) {
        if ($criteria->hasFilter($name)) {
            $filter = $criteria->getFilter($name);
            $factory->createAndBind($builder, $name, $filter);
        }
    }

    if (isset($sorts)) {
        foreach ($sorts->getSorts() as $sort) {
            /** @var \Cannibal\Bundle\SortBundle\Sort\SortInterface $sort */
            $name = $sort->getName();
            $builder->addOrderBy($name);
        }
    }

    return $builder;

}

Heres how the pagination bundle works (within an SF2 controller action):

    $query = $this->getDoctrineRepo()->findBy($filters, $sorts);

    $results = $this->createPaginator()
        ->setRequestData($this->getRequest()->query->all())
        ->paginate($results);