Developing (v7+)

ORM Pagination

Permalink 2 users found helpful May 27, 2015 at 3:31 PM

Hi,

Playing with Doctrine's ORM in C5.7.4.x. Works nice, like it

I've created an EntityRepository where I have some functions to get 'lists' of entities by some criteria. Also works fine. (it's like itemlists).
Now I'm trying to get pagination working, but the C5 Pagination works with ItemList (I also see an (empty) EntityItemList.

Are there any examples out there yet? Using ORM with pagination? (the ORM has an paginator).

Or should I use the PagerFanta directly?

A3020 replied on Jul 29, 2015 at 3:28 am Permalink Reply

Really good questions. It seems the core isn't using the ORM functionality yet. Also the EntityItemList class you're talking about seems unused:https://github.com/concrete5/concrete5/search?utf8=%E2%9C%93&q=E...

Have you gotten any further in the meanwhile?

I'm working on similar things, maybe you can share an example of a List class?

SnefIT replied on Jul 29, 2015 at 4:03 am Permalink Reply

I have puzzled a little bit.

I've created a base itemlist object that extends EntityItemList. It has the basic things in it.
When I need an entityitemlist, I extend the itemlist just created (for the basic things) and add things needed for that list.

I'm still experimenting and adjusting when needed ;)

The baseclass looks like:

<?php
namespace Concrete\Package\Blablabla\Src\Base;
defined('C5_EXECUTE') or die('Access Denied');
use Concrete\Core\Search\ItemList\EntityItemList;
use Concrete\Core\Search\Pagination\Pagination;
use Doctrine\ORM\QueryBuilder;
use Pagerfanta\Adapter\DoctrineORMAdapter;
class ItemList extends EntityItemList {
    protected $qb;
    public function __construct($entityManager = null) {
        // Set entity manager.
        if ($entityManager) {
            // Use given manager.
            $this->manager = $entityManager;
        } else {

Viewing 15 lines of 64 lines. View entire code block.

 
<?php
namespace Concrete\Package\Blablabla\Src\Base;
 
defined('C5_EXECUTE') or die('Access Denied');
 
use Concrete\Core\Search\ItemList\EntityItemList;
use Concrete\Core\Search\Pagination\Pagination;
use Doctrine\ORM\QueryBuilder;
use Pagerfanta\Adapter\DoctrineORMAdapter;
 
class ItemList extends EntityItemList {
 
    protected $qb;
 
    public function __construct($entityManager = null) {
 
        // Set entity manager.
        if ($entityManager) {
 
            // Use given manager.
            $this->manager = $entityManager;
        } else {
 
            // Get ORM.
            $orm = \Core::make('database/orm');
 
            // Use new manager.
            $this->manager = $orm->entityManager();
        }
 
        // Create new query builder.
        $this->qb = new QueryBuilder($this->manager);
    }
 
    public function getEntityManager() {
 
        // Return value.
        return $this->manager;
    }
 
    public function getQueryBuilder() {
 
        // Return value.
        return $this->qb;
    }
 
    protected function executeSortBy($column, $direction = 'asc') {
 
        if (in_array(strtolower($direction), array('asc', 'desc'))) {
            $this->qb->orderBy($column, $direction);
        } else {
 
            // Throw exception.
            throw new \Exception(t('Invalid SQL in ORDER BY'));
        }
    }
 
    public function executeGetResults() {
 
        // Return.
        return $this->qb->getQuery()->getResult();
    }
 
    public function getResult($mixed) {
 
        // The input is an entity already. Just return it.
        return $mixed;
    }
 
    public function debugStart() {
 
        // Not implmanagerented yet.
    }
    public function debugStop() {
 
        // Not implemented yet.
    }
 
    public function createPaginationObject() {
 
        // Create adapter.
        $adapter = new \Pagerfanta\Adapter\DoctrineORMAdapter($this->qb->getQuery(), true, null);
 
        // Return pagination.
        return new Pagination($this, $adapter);
    }
 
    public function getTotalResults() {
 
        // Return.
        return $this->getPagination()->count();
    }
}

The itemlist looks like:

<?php
namespace Concrete\Package\Blablabla\Src\Item;
defined('C5_EXECUTE') or die('Access Denied');
use Concrete\Package\Blablabla\Src\Base\ItemList as BaseItemList;
class ItemList extends BaseItemList {
    public function __construct($entityManager = null) {
        // Parental contruct.
        parent::__construct($entityManager);
        // Start building query.
        $this->qb->select('i')
            ->from('Concrete\Package\Blablabla\Src\Item\Item', 'i')
            ;
        // Setup automatic sorting.
        $this->setupAutomaticSorting();
    }

Viewing 15 lines of 18 lines. View entire code block.

 
<?php
namespace Concrete\Package\Blablabla\Src\Item;
 
defined('C5_EXECUTE') or die('Access Denied');
 
use Concrete\Package\Blablabla\Src\Base\ItemList as BaseItemList;
 
class ItemList extends BaseItemList {
 
    public function __construct($entityManager = null) {
 
        // Parental contruct.
        parent::__construct($entityManager);
 
        // Start building query.
        $this->qb->select('i')
            ->from('Concrete\Package\Blablabla\Src\Item\Item', 'i')
            ;
 
        // Setup automatic sorting.
        $this->setupAutomaticSorting();
    }
 
    // You can create functions that use the (ORM) Querybuilder for filtering or something like that.
    // I think you know how ;)
 
}

As already told... still experimenting with Doctrine ORM in C5. The entities are working fine, database tables are generated.

A3020 replied on Jul 29, 2015 at 4:30 am Permalink Reply

Nice! This is what I was looking for. I'm gonna implement it now and if I find something useful I'll share it here. Bedankt. ;)

SnefIT replied on Jul 29, 2015 at 4:50 am Permalink Reply

[dutch]
Graag gedaan!
[/dutch]

Don't forget to mark it as 'best answer' ;)

A3020 replied on Jul 29, 2015 at 4:54 am Permalink Reply

Chief, I can't mark it as best answer cause it's your own topic ;)

SnefIT replied on Jul 29, 2015 at 5:52 am Permalink Reply

you're right :')

A3020 replied on Jul 29, 2015 at 5:37 am Permalink Reply

What are you currently doing with the displayPaging function? Was it your plan to port that also to the BaseItemList? That depends on a lot more code from ItemList. (like getSummary, getTotal, etc.) and would result in a lot of duplicate code.

A3020 replied on Jul 29, 2015 at 5:42 am Permalink Reply

Hm this might be helpful: Concrete\Core\Search\Result\Result.php

SnefIT replied on Jul 29, 2015 at 5:57 am Permalink Reply

I created this itemlist for use in the pagination. If it was only for the list, then I would add some filtering in the custom entityrepository.

I use(d) it this way:

In the controller

// Create productlist.
$list = new ItemList();
// Do some filtering/ordering...
// $list->orderByName('asc');
// Max items per page.
$list->setItemsPerPage(25);
// Pagination
$pagination = $list->getPagination();
// Get items (for this page only).
$items = $pagination->getCurrentPageResults();
// Set variables.
$this->set('products', $products);
$this->set('pagination', $pagination);

in the view:

<div class="ccm-search-results-pagination">
<?php
if ($pagination->haveToPaginate()) {
    echo $pagination->renderDefaultView();
} 
?>
</div>

A3020 replied on Aug 14, 2015 at 6:16 am Permalink Reply

In 5.7.5 the method "createQuery" from EntityItemList also needs to be implemented.https://github.com/concrete5/concrete5/blob/develop/web/concrete/src...

blakeage replied on Feb 3, 2016 at 1:55 pm Permalink Reply

So this is what I've done, using an EntityItemList.

Say you have an entity called Appointment. You need to create an AppointmentEntityList class that extends ItemList, and fill out the abstract methods from ItemList, in that class.

Here is my AppointmentEntityList.php:

<?php
namespace Concrete\Package\Scheduler\Src\Scheduler;
defined('C5_EXECUTE') or die(_("Access Denied."));
use Concrete\Core\Search\ItemList\EntityItemList;
use Concrete\Core\Search\Pagination\Pagination;
use Package;
use Concrete\Core\Search\Result;
use Pagerfanta\Adapter\DoctrineORMAdapter;
class AppointmentEntityList extends EntityItemList
{
  public function createQuery() {
    $qb = $this->getEntityManager()->createQueryBuilder();
    $qb->addSelect("a FROM Concrete\Package\Scheduler\Src\Entity\Appointment a");
    $this->query = $qb;
  }

Viewing 15 lines of 37 lines. View entire code block.

 
<?php
namespace Concrete\Package\Scheduler\Src\Scheduler;
 
defined('C5_EXECUTE') or die(_("Access Denied."));
 
use Concrete\Core\Search\ItemList\EntityItemList;
use Concrete\Core\Search\Pagination\Pagination;
use Package;
use Concrete\Core\Search\Result;
use Pagerfanta\Adapter\DoctrineORMAdapter;
 
class AppointmentEntityList extends EntityItemList
{
  public function createQuery() {
    $qb = $this->getEntityManager()->createQueryBuilder();
    $qb->addSelect("a FROM Concrete\Package\Scheduler\Src\Entity\Appointment a");
    $this->query = $qb;
  }
 
  public function getEntityManager() {
    return Package::getByHandle("scheduler")->getEntityManager();
  }
 
  protected function executeSortBy($field, $direction = "asc") {
    $this->query->addOrderBy("a." . $field, $direction);
  }
 
  public function executeGetResults( ) {
    return $this->query->getQuery()->getResult();
  }
 
  public function getResult( $mixed ){
    return $mixed;
  }
 
  public function debugStart(){}
  public function debugStop(){}
 
  protected function createPaginationObject(){
    return new Pagination($this, new DoctrineORMAdapter($this->query) );
  }
 
  public function getTotalResults(){
    return $this->query->getQuery()->getMaxResults();
  }
}
?>

I'm not certain the sort code above works, as I haven't full implemented sorting yet. It was a first draft of the method.

In your controller, you'll do something like this:

$list = new AppointmentEntityList();
$list->createQuery();
$list->setItemsPerPage(Constants::$APPTS_PER_PAGE);
$pagination = $list->getPagination();
$appointments = $pagination->getCurrentPageResults();
$this->set('appointments', $appointments);
$this->set('pagination', $pagination);

In your view, you would loop over $appointments, as is an array of Appointment entities. And to display the pagination, it's just:

<div class="ccm-search-results-pagination">
  <?php
    if ($pagination->haveToPaginate()) {
      echo $pagination->renderDefaultView();
    }
  ?>
</div>

Forums

Developing (v7+)

ORM Pagination

Code

Post Reply

Delete Post

Mark Post as Spam

Destroy Spammer

Sign In?