typo3/sysext/backend/Classes/View/BackendLayout/DataProviderInterface.php

   1 <?php
   2 namespace TYPO3\CMS\Backend\View\BackendLayout;
   3
   4 /*
   5  * This file is part of the TYPO3 CMS project.
   6  *
   7  * It is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU General Public License, either version 2
   9  * of the License, or any later version.
  10  *
  11  * For the full copyright and license information, please read the
  12  * LICENSE.txt file that was distributed with this source code.
  13  *
  14  * The TYPO3 project - inspiring people to share!
  15  */
  16
  17 /**
  18  * Interface for classes which hook into BackendLayoutDataProvider
  19  * to provide additional backend layouts from various sources.
  20  */
  21 interface DataProviderInterface
  22 {
  23     /**
  24      * Adds backend layouts to the given backend layout collection.
  25      *
  26      * @param DataProviderContext $dataProviderContext
  27      * @param BackendLayoutCollection $backendLayoutCollection
  28      */
  29     public function addBackendLayouts(DataProviderContext $dataProviderContext, BackendLayoutCollection $backendLayoutCollection);
  30
  31     /**
  32      * Gets a backend layout by (regular) identifier.
  33      *
  34      * @param string $identifier
  35      * @param int $pageId
  36      * @return null|BackendLayout
  37      */
  38     public function getBackendLayout($identifier, $pageId);
  39 }