vendor/contao-bootstrap/grid/src/GridProvider.php line 73

Open in your IDE?
  1. <?php
  3. /**
  4.  * Contao Bootstrap grid.
  5.  *
  6.  * @filesource
  7.  */
  9. declare(strict_types=1);
  11. namespace ContaoBootstrap\Grid;
  13. use ContaoBootstrap\Grid\Definition\Grid;
  14. use InvalidArgumentException;
  15. use RuntimeException;
  17. /**
  18.  * GridProvider is the main entry point to get grids or grid iterators.
  19.  */
  20. final class GridProvider
  21. {
  22.     /**
  23.      * Grid builder.
  24.      */
  25.     private GridBuilder $builder;
  27.     /**
  28.      * Map of created grids.
  29.      *
  30.      * @var array<int,Grid>
  31.      */
  32.     private array $grids = [];
  34.     /**
  35.      * Map of grid iterators.
  36.      *
  37.      * @var array<string,GridIterator>
  38.      */
  39.     private array $iterators = [];
  41.     /**
  42.      * @param GridBuilder $builder The grid builder.
  43.      */
  44.     public function __construct(GridBuilder $builder)
  45.     {
  46.         $this->builder = $builder;
  47.     }
  49.     /**
  50.      * Get a grid.
  51.      *
  52.      * @param int $gridId Grid id.
  53.      *
  54.      * @throws RuntimeException When grid could not be build.
  55.      */
  56.     public function getGrid(int $gridId): Grid
  57.     {
  58.         if (! isset($this->grids[$gridId])) {
  59.             $this->grids[$gridId] = $this->builder->build($gridId);
  60.         }
  62.         return $this->grids[$gridId];
  63.     }
  65.     /**
  66.      * Get the grid iterator.
  67.      *
  68.      * @param string   $uniqueId Unique id to reference a grid iterator.
  69.      * @param int|null $gridId   The grid id.
  70.      *
  71.      * @throws RuntimeException When grid could not be build.
  72.      */
  73.     public function getIterator(string $uniqueId, ?int $gridId = null): GridIterator
  74.     {
  75.         if (! isset($this->iterators[$uniqueId])) {
  76.             if ($gridId === null) {
  77.                 throw new InvalidArgumentException('GridId required if iterator does not yet exist');
  78.             }
  80.             $grid     = $this->getGrid($gridId);
  81.             $iterator = new GridIterator($grid);
  83.             $this->iterators[$uniqueId] = $iterator;
  84.         }
  86.         return $this->iterators[$uniqueId];
  87.     }
  88. }