123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295 |
- <?php
- /*
- * This file is part of the Sonata package.
- *
- * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Sonata\AdminBundle\Admin;
- use Symfony\Component\Form\Form;
- use Symfony\Component\Form\FormBuilder;
- use Symfony\Component\Validator\ValidatorInterface;
- use Symfony\Component\Routing\RouterInterface;
- use Symfony\Component\Translation\TranslatorInterface;
- use Symfony\Component\HttpFoundation\Request;
- use Symfony\Component\Security\Acl\Model\DomainObjectInterface;
- use Sonata\AdminBundle\Form\FormMapper;
- use Sonata\AdminBundle\Datagrid\ListMapper;
- use Sonata\AdminBundle\Datagrid\DatagridMapper;
- use Sonata\AdminBundle\Show\ShowMapper;
- use Sonata\AdminBundle\Admin\Pool;
- use Sonata\AdminBundle\Validator\ErrorElement;
- use Sonata\AdminBundle\Translator\LabelTranslatorStrategyInterface;
- use Sonata\AdminBundle\Builder\FormContractorInterface;
- use Sonata\AdminBundle\Builder\ListBuilderInterface;
- use Sonata\AdminBundle\Builder\DatagridBuilderInterface;
- use Sonata\AdminBundle\Builder\ShowBuilderInterface;
- use Sonata\AdminBundle\Builder\RouteBuilderInterface;
- use Sonata\AdminBundle\Security\Handler\SecurityHandlerInterface;
- use Sonata\AdminBundle\Route\RouteCollection;
- use Sonata\AdminBundle\Model\ModelManagerInterface;
- use Knp\Menu\FactoryInterface as MenuFactoryInterface;
- use Knp\Menu\ItemInterface as MenuItemInterface;
- use Knp\Menu\MenuItem;
- abstract class Admin implements AdminInterface, DomainObjectInterface
- {
- /**
- * The class name managed by the admin class
- *
- * @var string
- */
- private $class;
- /**
- * The list collection
- *
- * @var array
- */
- private $list;
- /**
- * The list FieldDescription constructed from the configureListField method
- *
- * @var array
- */
- protected $listFieldDescriptions = array();
- private $show;
- /**
- * The show FieldDescription constructed from the configureShowFields method
- *
- * @var array
- */
- protected $showFieldDescriptions = array();
- /**
- * @var Form
- */
- private $form;
- /**
- * The list FieldDescription constructed from the configureFormField method
- *
- * @var array
- */
- protected $formFieldDescriptions = array();
- /**
- * @var DatagridInterface
- */
- private $filter;
- /**
- * The filter FieldDescription constructed from the configureFilterField method
- *
- * @var array
- */
- protected $filterFieldDescriptions = array();
- /**
- * The number of result to display in the list
- *
- * @var integer
- */
- protected $maxPerPage = 25;
- /**
- * The base route name used to generate the routing information
- *
- * @var string
- */
- protected $baseRouteName;
- /**
- * The base route pattern used to generate the routing information
- *
- * @var string
- */
- protected $baseRoutePattern;
- /**
- * The base name controller used to generate the routing information
- *
- * @var string
- */
- protected $baseControllerName;
- /**
- * The form group disposition
- *
- * @var array|boolean
- */
- private $formGroups = false;
- /**
- * The view group disposition
- *
- * @var array|boolean
- */
- private $showGroups = false;
- /**
- * The label class name (used in the title/breadcrumb ...)
- *
- * @var string
- */
- protected $classnameLabel;
- /**
- * The translation domain to be used to translate messages
- *
- * @var string
- */
- protected $translationDomain = 'messages';
- /**
- * Options to set to the form (ie, validation_groups)
- *
- * @var array
- */
- protected $formOptions = array();
- /**
- * Default values to the datagrid
- *
- * @var array
- */
- protected $datagridValues = array(
- '_page' => 1,
- );
- /**
- * The code related to the admin
- *
- * @var string
- */
- protected $code;
- /**
- * The label
- *
- * @var string
- */
- protected $label;
- /**
- * Array of routes related to this admin
- *
- * @var \Sonata\AdminBundle\Route\RouteCollection
- */
- protected $routes;
- /**
- * The subject only set in edit/update/create mode
- *
- * @var object
- */
- protected $subject;
- /**
- * Define a Collection of child admin, ie /admin/order/{id}/order-element/{childId}
- *
- * @var array
- */
- protected $children = array();
- /**
- * Reference the parent collection
- *
- * @var Admin
- */
- protected $parent = null;
- /**
- * The base code route refer to the prefix used to generate the route name
- *
- * @var string
- */
- protected $baseCodeRoute = '';
- /**
- * The related field reflection, ie if OrderElement is linked to Order,
- * then the $parentReflectionProperty must be the ReflectionProperty of
- * the order (OrderElement::$order)
- *
- * @var \ReflectionProperty $parentReflectionProperty
- */
- protected $parentAssociationMapping = null;
- /**
- * Reference the parent FieldDescription related to this admin
- * only set for FieldDescription which is associated to an Sub Admin instance
- *
- * @var FieldDescription
- */
- protected $parentFieldDescription;
- /**
- * If true then the current admin is part of the nested admin set (from the url)
- *
- * @var boolean
- */
- protected $currentChild = false;
- /**
- * The uniqid is used to avoid clashing with 2 admin related to the code
- * ie: a Block linked to a Block
- *
- * @var string
- */
- protected $uniqid;
- /**
- * The Entity or Document manager
- *
- * @var \Sonata\AdminBundle\Model\ModelManagerInterface
- */
- protected $modelManager;
- /**
- * The current request object
- *
- * @var \Symfony\Component\HttpFoundation\Request
- */
- protected $request;
- /**
- * The translator component
- *
- * @var \Symfony\Component\Translation\TranslatorInterface
- */
- protected $translator;
- /**
- * The related form contractor
- *
- * @var \Sonata\AdminBundle\Builder\FormContractorInterface
- */
- protected $formContractor;
- /**
- * The related list builder
- *
- * @var \Sonata\AdminBundle\Builder\ListBuilderInterface
- */
- protected $listBuilder;
- /**
- * The related view builder
- *
- * @var \Sonata\AdminBundle\View\ShowBuilderInterface
- */
- protected $showBuilder;
- /**
- * The related datagrid builder
- *
- * @var \Sonata\AdminBundle\Builder\DatagridBuilderInterface
- */
- protected $datagridBuilder;
- /**
- * @var \Sonata\AdminBundle\Builder\RouteBuilderInterface
- */
- protected $routeBuilder;
- /**
- * The datagrid instance
- *
- * @var \Sonata\AdminBundle\Datagrid\DatagridInterface
- */
- protected $datagrid;
- /**
- * The router intance
- *
- * @var \Symfony\Component\Routing\RouterInterface
- */
- protected $router;
- /**
- * The generated breadcrumbs
- *
- * @var array
- */
- protected $breadcrumbs = array();
- protected $securityHandler = null;
- /**
- * @var \Symfony\Component\Validator\ValidatorInterface $validator
- */
- protected $validator = null;
- /**
- * The configuration pool
- *
- * @var Pool
- */
- protected $configurationPool;
- protected $menu;
- /**
- * @var \Knp\Menu\MenuFactoryInterface
- */
- protected $menuFactory;
- protected $loaded = array(
- 'view_fields' => false,
- 'view_groups' => false,
- 'routes' => false,
- 'side_menu' => false,
- );
- protected $formTheme = array();
- protected $filterTheme = array();
- protected $templates = array();
- protected $extensions = array();
- protected $labelTranslatorStrategy;
- /**
- * This method can be overwritten to tweak the form construction, by default the form
- * is built by reading the FieldDescription
- *
- * @param \Sonata\AdminBundle\Form\FormMapper $form
- * @return void
- */
- protected function configureFormFields(FormMapper $form)
- {
- }
- /**
- * overwrite this method to configure the list FormField definition
- *
- * @param \Sonata\AdminBundle\Datagrid\ListMapper $list
- * @return void
- */
- protected function configureListFields(ListMapper $list)
- {
- }
- /**
- * @param \Sonata\AdminBundle\Datagrid\DatagridMapper $filter
- * @return void
- */
- protected function configureDatagridFilters(DatagridMapper $filter)
- {
- }
- /**
- * @deprecated Use configureShowFields instead.
- * @param \Sonata\AdminBundle\Show\ShowMapper $show
- * @return void
- */
- protected function configureShowField(ShowMapper $show)
- {
- }
- /**
- * @param \Sonata\AdminBundle\Show\ShowMapper $filter
- * @return void
- */
- protected function configureShowFields(ShowMapper $filter)
- {
- }
- /**
- * configure the Admin routes
- *
- * @param \Sonata\AdminBundle\Route\RouteCollection $collection
- * @return void
- */
- protected function configureRoutes(RouteCollection $collection)
- {
- }
- /**
- * @param \Knp\Menu\ItemInterface $menu
- * @param $action
- * @param null|Admin $childAdmin
- * @return void
- */
- protected function configureSideMenu(MenuItemInterface $menu, $action, Admin $childAdmin = null)
- {
- }
- /**
- * @param \Sonata\AdminBundle\Validator\ErrorElement $errorElement
- * @param $object
- * @return void
- */
- public function validate(ErrorElement $errorElement, $object)
- {
- }
- /**
- * @param string $code
- * @param string $class
- * @param string $baseControllerName
- */
- public function __construct($code, $class, $baseControllerName)
- {
- $this->code = $code;
- $this->class = $class;
- $this->baseControllerName = $baseControllerName;
- }
- /**
- * define custom variable
- */
- public function initialize()
- {
- $this->uniqid = uniqid();
- if (!$this->classnameLabel) {
- $this->classnameLabel = substr($this->getClass(), strrpos($this->getClass(), '\\') + 1);
- }
- $this->baseCodeRoute = $this->getCode();
- $this->configure();
- }
- /**
- * Allows the user to define custom variables
- */
- public function configure()
- {
- }
- public function update($object)
- {
- $this->preUpdate($object);
- $this->getModelManager()->update($object);
- $this->postUpdate($object);
- }
- public function create($object)
- {
- $this->prePersist($object);
- $this->getModelManager()->create($object);
- $this->postPersist($object);
- }
- public function delete($object)
- {
- $this->preRemove($object);
- $this->getModelManager()->delete($object);
- $this->postRemove($object);
- }
- public function preUpdate($object)
- {
- }
- public function postUpdate($object)
- {
- }
- public function prePersist($object)
- {
- }
- public function postPersist($object)
- {
- }
- public function preRemove($object)
- {
- }
- public function postRemove($object)
- {
- }
- /**
- * build the view FieldDescription array
- *
- * @return void
- */
- protected function buildShow()
- {
- if ($this->show) {
- return;
- }
- $collection = new FieldDescriptionCollection();
- $mapper = new ShowMapper($this->showBuilder, $collection, $this);
- $this->configureShowField($mapper); // deprecated, use configureShowFields instead
- $this->configureShowFields($mapper);
- $this->show = $collection;
- }
- /**
- * build the list FieldDescription array
- *
- * @return void
- */
- protected function buildList()
- {
- if ($this->list) {
- return;
- }
- $this->list = $this->getListBuilder()->getBaseList();
- $mapper = new ListMapper($this->getListBuilder(), $this->list, $this);
- if (count($this->getBatchActions()) > 0) {
- $fieldDescription = $this->getModelManager()->getNewFieldDescriptionInstance($this->getClass(), 'batch', array(
- 'label' => 'batch',
- 'code' => '_batch',
- 'sortable' => false
- ));
- $fieldDescription->setAdmin($this);
- $fieldDescription->setTemplate('SonataAdminBundle:CRUD:list__batch.html.twig');
- $mapper->add($fieldDescription, 'batch');
- }
- $this->configureListFields($mapper);
- foreach($this->getExtensions() as $extension) {
- $extension->configureListFields($mapper);
- }
- }
- /**
- * Get parameters that are currently bound to the filter.
- *
- * @return array
- */
- public function getFilterParameters()
- {
- $parameters = array();
- // build the values array
- if ($this->hasRequest()) {
- $parameters = array_merge(
- $this->getModelManager()->getDefaultSortValues($this->getClass()),
- $this->datagridValues,
- $this->request->query->get('filter', array())
- );
- // always force the parent value
- if ($this->isChild() && $this->getParentAssociationMapping()) {
- $parameters[$this->getParentAssociationMapping()] = array('value' => $this->request->get($this->getParent()->getIdParameter()));
- }
- }
- return $parameters;
- }
- /**
- * build the filter FieldDescription array
- *
- * @return void
- */
- public function buildDatagrid()
- {
- if ($this->datagrid) {
- return;
- }
- // initialize the datagrid
- $this->datagrid = $this->getDatagridBuilder()->getBaseDatagrid($this, $this->getFilterParameters());
- $this->datagrid->getPager()->setMaxPerPage($this->maxPerPage);
- $mapper = new DatagridMapper($this->getDatagridBuilder(), $this->datagrid, $this);
- // build the datagrid filter
- $this->configureDatagridFilters($mapper);
- // ok, try to limit to add parent filter
- if ($this->isChild() && $this->getParentAssociationMapping() && !$mapper->has($this->getParentAssociationMapping())) {
- $mapper->add($this->getParentAssociationMapping(), null, array(
- 'field_type' => 'sonata_type_model_reference',
- 'field_options' => array(
- 'model_manager' => $this->getModelManager()
- ),
- 'operator_type' => 'hidden'
- ));
- }
- foreach($this->getExtensions() as $extension) {
- $extension->configureDatagridFilters($mapper);
- }
- }
- /**
- * Returns the name of the parent related field, so the field can be use to set the default
- * value (ie the parent object) or to filter the object
- *
- * @return string the name of the parent related field
- */
- public function getParentAssociationMapping()
- {
- return $this->parentAssociationMapping;
- }
- /**
- * Build the form FieldDescription collection
- *
- * @return void
- */
- protected function buildForm()
- {
- if ($this->form) {
- return;
- }
- // append parent object if any
- // todo : clean the way the Admin class can retrieve set the object
- if ($this->isChild() && $this->getParentAssociationMapping()) {
- $parent = $this->getParent()->getObject($this->request->get($this->getParent()->getIdParameter()));
- $propertyPath = new \Symfony\Component\Form\Util\PropertyPath($this->getParentAssociationMapping());
- $object = $this->getSubject();
- $propertyPath->setValue($object, $parent);
- }
- $this->form = $this->getFormBuilder()->getForm();
- }
- /**
- * Returns the baseRoutePattern used to generate the routing information
- *
- * @throws RuntimeException
- * @return string the baseRoutePattern used to generate the routing information
- */
- public function getBaseRoutePattern()
- {
- if (!$this->baseRoutePattern) {
- preg_match('@([A-Za-z0-9]*)\\\([A-Za-z0-9]*)Bundle\\\(Entity|Document|Model)\\\(.*)@', $this->getClass(), $matches);
- if (!$matches) {
- throw new \RuntimeException(sprintf('Please define a default `baseRoutePattern` value for the admin class `%s`', get_class($this)));
- }
- if ($this->isChild()) { // the admin class is a child, prefix it with the parent route name
- $this->baseRoutePattern = sprintf('%s/{id}/%s',
- $this->getParent()->getBaseRoutePattern(),
- $this->urlize($matches[4], '-')
- );
- } else {
- $this->baseRoutePattern = sprintf('/%s/%s/%s',
- $this->urlize($matches[1], '-'),
- $this->urlize($matches[2], '-'),
- $this->urlize($matches[4], '-')
- );
- }
- }
- return $this->baseRoutePattern;
- }
- /**
- * Returns the baseRouteName used to generate the routing information
- *
- * @throws RuntimeException
- * @return string the baseRouteName used to generate the routing information
- */
- public function getBaseRouteName()
- {
- if (!$this->baseRouteName) {
- preg_match('@([A-Za-z0-9]*)\\\([A-Za-z0-9]*)Bundle\\\(Entity|Document|Model)\\\(.*)@', $this->getClass(), $matches);
- if (!$matches) {
- throw new \RuntimeException(sprintf('Please define a default `baseRouteName` value for the admin class `%s`', get_class($this)));
- }
- if ($this->isChild()) { // the admin class is a child, prefix it with the parent route name
- $this->baseRouteName = sprintf('%s_%s',
- $this->getParent()->getBaseRouteName(),
- $this->urlize($matches[4])
- );
- } else {
- $this->baseRouteName = sprintf('admin_%s_%s_%s',
- $this->urlize($matches[1]),
- $this->urlize($matches[2]),
- $this->urlize($matches[4])
- );
- }
- }
- return $this->baseRouteName;
- }
- /**
- * urlize the given word
- *
- * @param string $word
- * @param string $sep the separator
- *
- * @return string
- */
- public function urlize($word, $sep = '_')
- {
- return strtolower(preg_replace('/[^a-z0-9_]/i', $sep.'$1', $word));
- }
- /**
- * Returns the class name handled by the Admin instance
- *
- * @return string the class name handled by the Admin instance
- */
- public function getClass()
- {
- return $this->class;
- }
- /**
- * Returns the list of batchs actions
- *
- * @return array the list of batchs actions
- */
- public function getBatchActions()
- {
- $actions = array();
- if ($this->isGranted('DELETE')) {
- $actions['delete'] = array(
- 'label' => $this->trans('action_delete', array(), 'SonataAdminBundle'),
- 'ask_confirmation' => true, // by default always true
- );
- }
- return $actions;
- }
- /**
- * Returns the list of available urls
- *
- * @return \Sonata\AdminBundle\Route\RouteCollection the list of available urls
- */
- public function getRoutes()
- {
- $this->buildRoutes();
- return $this->routes;
- }
- /**
- * Returns the parameter representing router id, ie: {id} or {childId}
- *
- * @return string
- */
- public function getRouterIdParameter()
- {
- return $this->isChild() ? '{childId}' : '{id}';
- }
- /**
- * Returns the parameter representing request id, ie: id or childId
- *
- * @return string
- */
- public function getIdParameter()
- {
- return $this->isChild() ? 'childId' : 'id';
- }
- /**
- * Build all the related urls to the current admin
- *
- * @return void
- */
- public function buildRoutes()
- {
- if ($this->loaded['routes']) {
- return;
- }
- $this->loaded['routes'] = true;
- $this->routes = new RouteCollection(
- $this->getBaseCodeRoute(),
- $this->getBaseRouteName(),
- $this->getBaseRoutePattern(),
- $this->getBaseControllerName()
- );
- $this->routeBuilder->build($this, $this->routes);
- $this->configureRoutes($this->routes);
- foreach($this->getExtensions() as $extension) {
- $extension->configureRoutes($this, $this->routes);
- }
- }
- /**
- * Returns the url defined by the $name
- *
- * @param strinf $name
- * @return Route
- */
- public function getRoute($name)
- {
- $this->buildRoutes();
- if (!$this->routes->has($name)) {
- return false;
- }
- return $this->routes->get($name);
- }
- /**
- * @param $name
- * @return bool
- */
- public function hasRoute($name)
- {
- $this->buildRoutes();
- return $this->routes->has($name);
- }
- /**
- * generate the object url with the given $name
- *
- * @param string $name
- * @param $object
- * @param array $parameters
- *
- * @return return a complete url
- */
- public function generateObjectUrl($name, $object, array $parameters = array())
- {
- $parameters['id'] = $this->getNormalizedIdentifier($object);
- return $this->generateUrl($name, $parameters);
- }
- /**
- * generate the url with the given $name
- *
- * @throws RuntimeException
- * @param string $name
- * @param array $parameters
- *
- * @return return a complete url
- */
- public function generateUrl($name, array $parameters = array())
- {
- if (!$this->isChild()) {
- if (strpos($name, '.')) {
- $name = $this->getCode().'|'.$name;
- } else {
- $name = $this->getCode().'.'.$name;
- }
- }
- // if the admin is a child we automatically append the parent's id
- else if ($this->isChild()) {
- $name = $this->baseCodeRoute.'.'.$name;
- // twig template does not accept variable hash key ... so cannot use admin.idparameter ...
- // switch value
- if (isset($parameters['id'])) {
- $parameters[$this->getIdParameter()] = $parameters['id'];
- unset($parameters['id']);
- }
- $parameters[$this->getParent()->getIdParameter()] = $this->request->get($this->getParent()->getIdParameter());
- }
- // if the admin is linked to a parent FieldDescription (ie, embedded widget)
- if ($this->hasParentFieldDescription()) {
- // merge link parameter if any provided by the parent field
- $parameters = array_merge($parameters, $this->getParentFieldDescription()->getOption('link_parameters', array()));
- $parameters['uniqid'] = $this->getUniqid();
- $parameters['code'] = $this->getCode();
- $parameters['pcode'] = $this->getParentFieldDescription()->getAdmin()->getCode();
- $parameters['puniqid'] = $this->getParentFieldDescription()->getAdmin()->getUniqid();
- }
- if ($name == 'update' || substr($name, -7) == '|update') {
- $parameters['uniqid'] = $this->getUniqid();
- $parameters['code'] = $this->getCode();
- }
- // allows to define persistent parameters
- if ($this->hasRequest()) {
- $parameters = array_merge($this->getPersistentParameters(), $parameters);
- }
- $route = $this->getRoute($name);
- if (!$route) {
- throw new \RuntimeException(sprintf('unable to find the route `%s`', $name));
- }
- return $this->router->generate($route->getDefault('_sonata_name'), $parameters);
- }
- /**
- * Returns the list template
- *
- * @return string the list template
- */
- public function getListTemplate()
- {
- return $this->getTemplate('list');
- }
- /**
- * Returns the edit template
- *
- * @return string the edit template
- */
- public function getEditTemplate()
- {
- return $this->getTemplate('edit');
- }
- /**
- * Returns the view template
- *
- * @return string the view template
- */
- public function getShowTemplate()
- {
- return $this->getTemplate('show');
- }
- /**
- * @param array $templates
- * @return void
- */
- public function setTemplates(array $templates)
- {
- $this->templates = $templates;
- }
- /**
- * @param $name
- * @param $template
- * @return void
- */
- public function setTemplate($name, $template)
- {
- $this->templates[$name] = $template;
- }
- /**
- * @return array
- */
- public function getTemplates()
- {
- return $this->templates;
- }
- /**
- * @param $name
- * @return null|string
- */
- public function getTemplate($name)
- {
- if (isset($this->templates[$name])) {
- return $this->templates[$name];
- }
- return null;
- }
- /**
- * Returns an instance of the related classname
- *
- * @return Object An instance of the related classname
- */
- public function getNewInstance()
- {
- return $this->getModelManager()->getModelInstance($this->getClass());
- }
- /**
- * @return \Symfony\Component\Form\FormBuilder the form builder
- */
- public function getFormBuilder()
- {
- $admin = $this;
- // add the custom inline validation option
- $metadata = $this->validator->getMetadataFactory()->getClassMetadata($this->getClass());
- $metadata->addConstraint(new \Sonata\AdminBundle\Validator\Constraints\InlineConstraint(array(
- 'service' => $this,
- 'method' => function(ErrorElement $errorElement, $object) use ($admin) {
- /* @var \Sonata\AdminBundle\Admin\AdminInterface $admin */
- // This avoid the main validation to be cascaded to children
- // The problem occurs when a model Page has a collection of Page as property
- if ($admin->hasSubject() && spl_object_hash($object) !== spl_object_hash($admin->getSubject())) {
- return;
- }
- $admin->validate($errorElement, $object);
- foreach ($admin->getExtensions() as $extension) {
- $extension->validate($admin, $errorElement, $object);
- }
- }
- )));
- $this->formOptions['data_class'] = $this->getClass();
- $formBuilder = $this->getFormContractor()->getFormBuilder(
- $this->getUniqid(),
- $this->formOptions
- );
- $this->defineFormBuilder($formBuilder);
- return $formBuilder;
- }
- /**
- * @param \Symfony\Component\Form\FormBuilder $formBuilder
- * @return void
- */
- public function defineFormBuilder(FormBuilder $formBuilder)
- {
- $mapper = new FormMapper($this->getFormContractor(), $formBuilder, $this);
- $this->configureFormFields($mapper);
- foreach($this->getExtensions() as $extension) {
- $extension->configureFormFields($mapper);
- }
- }
- /**
- * attach an admin instance to the given FieldDescription
- *
- * @param \Sonata\AdminBundle\Admin\FieldDescriptionInterface $fieldDescription
- */
- public function attachAdminClass(FieldDescriptionInterface $fieldDescription)
- {
- $pool = $this->getConfigurationPool();
- $admin = $pool->getAdminByClass($fieldDescription->getTargetEntity());
- if (!$admin) {
- return;
- }
- $fieldDescription->setAssociationAdmin($admin);
- }
- /**
- * Returns the target object
- *
- * @param integer $id
- * @return object
- */
- public function getObject($id)
- {
- return $this->getModelManager()->find($this->getClass(), $id);
- }
- /**
- * Returns a form depend on the given $object
- *
- * @return \Symfony\Component\Form\Form
- */
- public function getForm()
- {
- $this->buildForm();
- return $this->form;
- }
- /**
- * Returns a list depend on the given $object
- *
- * @return \Sonata\AdminBundle\Admin\FieldDescriptionCollection
- */
- public function getList()
- {
- $this->buildList();
- return $this->list;
- }
- /**
- * @return \Sonata\AdminBundle\Datagrid\ProxyQueryInterface
- */
- public function createQuery($context = 'list')
- {
- return $this->getModelManager()->createQuery($this->class);
- }
- /**
- * Returns a list depend on the given $object
- *
- * @return \Sonata\AdminBundle\Datagrid\DatagridInterface
- */
- public function getDatagrid()
- {
- $this->buildDatagrid();
- return $this->datagrid;
- }
- /**
- * Build the side menu related to the current action
- *
- * @param string $action
- * @param \Sonata\AdminBundle\Admin\AdminInterface $childAdmin
- * @return MenuItem|false
- */
- public function buildSideMenu($action, AdminInterface $childAdmin = null)
- {
- if ($this->loaded['side_menu']) {
- return;
- }
- $this->loaded['side_menu'] = true;
- $menu = $this->menuFactory->createItem('root');
- $this->configureSideMenu($menu, $action, $childAdmin);
- foreach ($this->getExtensions() as $extension) {
- $extension->configureSideMenu($this, $menu, $action, $childAdmin);
- }
- $this->menu = $menu;
- }
- /**
- * @param string $action
- * @param \Sonata\AdminBundle\Admin\AdminInterface $childAdmin
- * @return \Knp\MenuBundle\Menu
- */
- public function getSideMenu($action, AdminInterface $childAdmin = null)
- {
- if ($this->isChild()) {
- return $this->getParent()->getSideMenu($action, $this);
- }
- $this->buildSideMenu($action, $childAdmin);
- return $this->menu;
- }
- /**
- * Returns the root code
- *
- * @return string the root code
- */
- public function getRootCode()
- {
- return $this->getRoot()->getCode();
- }
- /**
- * Returns the master admin
- *
- * @return \Sonata\AdminBundle\Admin\Admin the root admin class
- */
- public function getRoot()
- {
- $parentFieldDescription = $this->getParentFieldDescription();
- if (!$parentFieldDescription) {
- return $this;
- }
- return $parentFieldDescription->getAdmin()->getRoot();
- }
- public function setBaseControllerName($baseControllerName)
- {
- $this->baseControllerName = $baseControllerName;
- }
- public function getBaseControllerName()
- {
- return $this->baseControllerName;
- }
- public function setLabel($label)
- {
- $this->label = $label;
- }
- public function getLabel()
- {
- return $this->label;
- }
- public function setMaxPerPage($maxPerPage)
- {
- $this->maxPerPage = $maxPerPage;
- }
- public function getMaxPerPage()
- {
- return $this->maxPerPage;
- }
- public function getFormGroups()
- {
- return $this->formGroups;
- }
- public function setFormGroups(array $formGroups)
- {
- $this->formGroups = $formGroups;
- }
- public function getShowGroups()
- {
- return $this->showGroups;
- }
- public function setShowGroups(array $showGroups)
- {
- $this->showGroups = $showGroups;
- }
- /**
- * set the parent FieldDescription
- *
- * @param \Sonata\AdminBundle\Admin\FieldDescriptionInterface $parentFieldDescription
- * @return void
- */
- public function setParentFieldDescription(FieldDescriptionInterface $parentFieldDescription)
- {
- $this->parentFieldDescription = $parentFieldDescription;
- }
- /**
- *
- * @return \Sonata\AdminBundle\Admin\FieldDescriptionInterface the parent field description
- */
- public function getParentFieldDescription()
- {
- return $this->parentFieldDescription;
- }
- /**
- * Returns true if the Admin is linked to a parent FieldDescription
- *
- * @return bool
- */
- public function hasParentFieldDescription()
- {
- return $this->parentFieldDescription instanceof FieldDescriptionInterface;
- }
- /**
- * set the subject linked to the admin, the subject is the related model
- *
- * @param object $subject
- * @return void
- */
- public function setSubject($subject)
- {
- $this->subject = $subject;
- }
- /**
- * Returns the subject, if none is set try to load one from the request
- *
- * @return object $object the subject
- */
- public function getSubject()
- {
- if ($this->subject === null && $this->request) {
- $id = $this->request->get($this->getIdParameter());
- if (!is_numeric($id)) {
- $this->subject = false;
- } else {
- $this->subject = $this->getModelManager()->find($this->getClass(), $id);
- }
- }
- return $this->subject;
- }
- /**
- * @return bool
- */
- public function hasSubject()
- {
- return $this->subject != null;
- }
- /**
- * build and return the collection of form FieldDescription
- *
- * @return array collection of form FieldDescription
- */
- public function getFormFieldDescriptions()
- {
- $this->buildForm();
- return $this->formFieldDescriptions;
- }
- /**
- * Returns the form FieldDescription with the given $name
- *
- * @param string $name
- * @return \Sonata\AdminBundle\Admin\FieldDescriptionInterface
- */
- public function getFormFieldDescription($name)
- {
- return $this->hasFormFieldDescription($name) ? $this->formFieldDescriptions[$name] : null;
- }
- /**
- * Returns true if the admin has a FieldDescription with the given $name
- *
- * @param string $name
- * @return bool
- */
- public function hasFormFieldDescription($name)
- {
- return array_key_exists($name, $this->formFieldDescriptions) ? true : false;
- }
- /**
- * add a FieldDescription
- *
- * @param string $name
- * @param \Sonata\AdminBundle\Admin\FieldDescriptionInterface $fieldDescription
- * @return void
- */
- public function addFormFieldDescription($name, FieldDescriptionInterface $fieldDescription)
- {
- $this->formFieldDescriptions[$name] = $fieldDescription;
- }
- /**
- * remove a FieldDescription
- *
- * @param string $name
- * @return void
- */
- public function removeFormFieldDescription($name)
- {
- unset($this->formFieldDescriptions[$name]);
- }
- /**
- * build and return the collection of form FieldDescription
- *
- * @return array collection of form FieldDescription
- */
- public function getShowFieldDescriptions()
- {
- $this->buildShow();
- return $this->showFieldDescriptions;
- }
- /**
- * Returns the form FieldDescription with the given $name
- *
- * @param string $name
- * @return \Sonata\AdminBundle\Admin\FieldDescriptionInterface
- */
- public function getShowFieldDescription($name)
- {
- $this->buildShow();
- return $this->hasShowFieldDescription($name) ? $this->showFieldDescriptions[$name] : null;
- }
- /**
- * Returns true if the admin has a FieldDescription with the given $name
- *
- * @param string $name
- * @return bool
- */
- public function hasShowFieldDescription($name)
- {
- return array_key_exists($name, $this->showFieldDescriptions);
- }
- /**
- * add a FieldDescription
- *
- * @param string $name
- * @param \Sonata\AdminBundle\Admin\FieldDescriptionInterface $fieldDescription
- * @return void
- */
- public function addShowFieldDescription($name, FieldDescriptionInterface $fieldDescription)
- {
- $this->showFieldDescriptions[$name] = $fieldDescription;
- }
- /**
- * remove a FieldDescription
- *
- * @param string $name
- * @return void
- */
- public function removeShowFieldDescription($name)
- {
- unset($this->showFieldDescriptions[$name]);
- }
- /**
- * Returns the collection of list FieldDescriptions
- *
- * @return array
- */
- public function getListFieldDescriptions()
- {
- $this->buildList();
- return $this->listFieldDescriptions;
- }
- /**
- * Returns a list FieldDescription
- *
- * @param string $name
- * @return \Sonata\AdminBundle\Admin\FieldDescriptionInterface
- */
- public function getListFieldDescription($name)
- {
- return $this->hasListFieldDescription($name) ? $this->listFieldDescriptions[$name] : null;
- }
- /**
- * Returns true if the list FieldDescription exists
- *
- * @param string $name
- * @return bool
- */
- public function hasListFieldDescription($name)
- {
- $this->buildList();
- return array_key_exists($name, $this->listFieldDescriptions) ? true : false;
- }
- /**
- * add a list FieldDescription
- *
- * @param string $name
- * @param \Sonata\AdminBundle\Admin\FieldDescriptionInterface $fieldDescription
- * @return void
- */
- public function addListFieldDescription($name, FieldDescriptionInterface $fieldDescription)
- {
- $this->listFieldDescriptions[$name] = $fieldDescription;
- }
- /**
- * remove a list FieldDescription
- *
- * @param string $name
- * @return void
- */
- public function removeListFieldDescription($name)
- {
- unset($this->listFieldDescriptions[$name]);
- }
- /**
- * Returns a filter FieldDescription
- *
- * @param string $name
- * @return array|null
- */
- public function getFilterFieldDescription($name)
- {
- return $this->hasFilterFieldDescription($name) ? $this->filterFieldDescriptions[$name] : null;
- }
- /**
- * Returns true if the filter FieldDescription exists
- *
- * @param string $name
- * @return bool
- */
- public function hasFilterFieldDescription($name)
- {
- return array_key_exists($name, $this->filterFieldDescriptions) ? true : false;
- }
- /**
- * add a filter FieldDescription
- *
- * @param string $name
- * @param \Sonata\AdminBundle\Admin\FieldDescriptionInterface $fieldDescription
- * @return void
- */
- public function addFilterFieldDescription($name, FieldDescriptionInterface $fieldDescription)
- {
- $this->filterFieldDescriptions[$name] = $fieldDescription;
- }
- /**
- * remove a filter FieldDescription
- *
- * @param string $name
- */
- public function removeFilterFieldDescription($name)
- {
- unset($this->filterFieldDescriptions[$name]);
- }
- /**
- * Returns the filter FieldDescription collection
- *
- * @param array filter FieldDescription collection
- */
- public function getFilterFieldDescriptions()
- {
- $this->buildDatagrid();
- return $this->filterFieldDescriptions;
- }
- /**
- * add an Admin child to the current one
- *
- * @param \Sonata\AdminBundle\Admin\AdminInterface $child
- * @return void
- */
- public function addChild(AdminInterface $child)
- {
- $this->children[$child->getCode()] = $child;
- $child->setBaseCodeRoute($this->getCode().'|'.$child->getCode());
- $child->setParent($this);
- }
- /**
- * Returns true or false if an Admin child exists for the given $code
- *
- * @param string $code Admin code
- * @return bool True if child exist, false otherwise
- */
- public function hasChild($code)
- {
- return isset($this->children[$code]);
- }
- /**
- * Returns an collection of admin children
- *
- * @return array list of Admin children
- */
- public function getChildren()
- {
- return $this->children;
- }
- /**
- * Returns an admin child with the given $code
- *
- * @param string $code
- * @return array|null
- */
- public function getChild($code)
- {
- return $this->hasChild($code) ? $this->children[$code] : null;
- }
- /**
- * set the Parent Admin
- *
- * @param \Sonata\AdminBundle\Admin\AdminInterface $parent
- * @return void
- */
- public function setParent(AdminInterface $parent)
- {
- $this->parent = $parent;
- }
- /**
- * get the Parent Admin
- *
- * @return \Sonata\AdminBundle\Admin\AdminInterface|null
- */
- public function getParent()
- {
- return $this->parent;
- }
- /**
- * Returns true if the Admin class has an Parent Admin defined
- *
- * @return boolean
- */
- public function isChild()
- {
- return $this->parent instanceof AdminInterface;
- }
- /**
- * Returns true if the admin has children, false otherwise
- *
- * @return bool if the admin has children
- */
- public function hasChildren()
- {
- return count($this->children) > 0;
- }
- /**
- * set the uniqid
- *
- * @param $uniqid
- * @return void
- */
- public function setUniqid($uniqid)
- {
- $this->uniqid = $uniqid;
- }
- /**
- * Returns the uniqid
- *
- * @return integer
- */
- public function getUniqid()
- {
- return $this->uniqid;
- }
- /**
- * Returns the classname label
- *
- * @return string the classname label
- */
- public function getClassnameLabel()
- {
- return $this->classnameLabel;
- }
- /**
- * Returns an array of persistent parameters
- *
- * @return array
- */
- public function getPersistentParameters()
- {
- return array();
- }
- /**
- * @param $name
- * @return null|mixed
- */
- public function getPersistentParameter($name)
- {
- $parameters = $this->getPersistentParameters();
- return isset($parameters[$name]) ? $parameters[$name] : null;
- }
- /**
- * @param string $action
- * @return array
- */
- public function getBreadcrumbs($action)
- {
- if ($this->isChild()) {
- return $this->getParent()->getBreadcrumbs($action);
- }
- return $this->buildBreadcrumbs($action);
- }
- /**
- * Generates the breadcrumbs array
- *
- * @param string $action
- * @param \Knp\Menu\ItemInterface|null $menu
- * @return array
- */
- public function buildBreadcrumbs($action, MenuItemInterface $menu = null)
- {
- if (isset($this->breadcrumbs[$action])) {
- return $this->breadcrumbs[$action];
- }
- if (!$menu) {
- $menu = $this->menuFactory->createItem('root');
- }
- $child = $menu->addChild(
- $this->trans($this->getLabelTranslatorStrategy()->getLabel('dashboard', 'breadcrumb', 'link'), array(), 'SonataAdminBundle'),
- array('uri' => $this->router->generate('sonata_admin_dashboard'))
- );
- $child = $child->addChild(
- $this->trans($this->getLabelTranslatorStrategy()->getLabel(sprintf('%s_list', $this->getClassnameLabel()), 'breadcrumb', 'link')),
- array('uri' => $this->generateUrl('list'))
- );
- $childAdmin = $this->getCurrentChildAdmin();
- if ($childAdmin) {
- $id = $this->request->get($this->getIdParameter());
- $child = $child->addChild(
- (string) $this->getSubject(),
- array('uri' => $this->generateUrl('edit', array('id' => $id)))
- );
- return $childAdmin->buildBreadcrumbs($action, $child);
- } elseif ($this->isChild()) {
- if ($action != 'list') {
- $menu = $menu->addChild(
- $this->trans($this->getLabelTranslatorStrategy()->getLabel(sprintf('%s_list', $this->getClassnameLabel()), 'breadcrumb', 'link')),
- array('uri' => $this->generateUrl('list'))
- );
- }
- if ($this->hasSubject()) {
- $breadcrumbs = $menu->getBreadcrumbsArray( (string) $this->getSubject());
- } else {
- $breadcrumbs = $menu->getBreadcrumbsArray(
- $this->trans($this->getLabelTranslatorStrategy()->getLabel(sprintf('%s_%s', $this->getClassnameLabel(), $action), 'breadcrumb', 'link'))
- );
- }
- } else if ($action != 'list') {
- $breadcrumbs = $child->getBreadcrumbsArray(
- $this->trans($this->getLabelTranslatorStrategy()->getLabel(sprintf('%s_%s', $this->getClassnameLabel(), $action), 'breadcrumb', 'link'))
- );
- } else {
- $breadcrumbs = $child->getBreadcrumbsArray();
- }
- // the generated $breadcrumbs contains an empty element
- array_shift($breadcrumbs);
- return $this->breadcrumbs[$action] = $breadcrumbs;
- }
- /**
- * set the current child status
- *
- * @param boolean $currentChild
- * @return void
- */
- public function setCurrentChild($currentChild)
- {
- $this->currentChild = $currentChild;
- }
- /**
- * Returns the current child status
- *
- * @return bool
- */
- public function getCurrentChild()
- {
- return $this->currentChild;
- }
- /**
- * Returns the current child admin instance
- *
- * @return \Sonata\AdminBundle\Admin\AdminInterface|null the current child admin instance
- */
- public function getCurrentChildAdmin()
- {
- foreach ($this->children as $children) {
- if ($children->getCurrentChild()) {
- return $children;
- }
- }
- return null;
- }
- /**
- * translate a message id
- *
- * @param string $id
- * @param array $parameters
- * @param null $domain
- * @param null $locale
- * @return string the translated string
- */
- public function trans($id, array $parameters = array(), $domain = null, $locale = null)
- {
- $domain = $domain ?: $this->translationDomain;
- if (!$this->translator) {
- return $id;
- }
- return $this->translator->trans($id, $parameters, $domain, $locale);
- }
- /**
- * set the translation domain
- *
- * @param string $translationDomain the translation domain
- * @return void
- */
- public function setTranslationDomain($translationDomain)
- {
- $this->translationDomain = $translationDomain;
- }
- /**
- * Returns the translation domain
- *
- * @return string the translation domain
- */
- public function getTranslationDomain()
- {
- return $this->translationDomain;
- }
- /**
- * @param \Symfony\Component\Translation\TranslatorInterface $translator
- * @return void
- */
- public function setTranslator(TranslatorInterface $translator)
- {
- $this->translator = $translator;
- }
- /**
- * @return \Symfony\Component\Translation\TranslatorInterface
- */
- public function getTranslator()
- {
- return $this->translator;
- }
- /**
- * @param \Symfony\Component\HttpFoundation\Request $request
- * @return void
- */
- public function setRequest(Request $request)
- {
- $this->request = $request;
- if ($request->get('uniqid')) {
- $this->setUniqid($request->get('uniqid'));
- }
- foreach ($this->getChildren() as $children) {
- $children->setRequest($request);
- }
- }
- /**
- * @return \Symfony\Component\HttpFoundation\Request
- */
- public function getRequest()
- {
- if (!$this->request) {
- throw new \RuntimeException('The Request object has not been set');
- }
- return $this->request;
- }
- /**
- *
- * @return true if the request object is linked to the Admin
- */
- public function hasRequest()
- {
- return $this->request !== null;
- }
- /**
- * @param \Sonata\AdminBundle\Builder\FormContractorInterface $formBuilder
- * @return void
- */
- public function setFormContractor(FormContractorInterface $formBuilder)
- {
- $this->formContractor = $formBuilder;
- }
- /**
- * @return \Sonata\AdminBundle\Builder\FormContractorInterface
- */
- public function getFormContractor()
- {
- return $this->formContractor;
- }
- /**
- * @param \Sonata\AdminBundle\Builder\DatagridBuilderInterface $datagridBuilder
- * @return void
- */
- public function setDatagridBuilder(DatagridBuilderInterface $datagridBuilder)
- {
- $this->datagridBuilder = $datagridBuilder;
- }
- /**
- * @return \Sonata\AdminBundle\Builder\DatagridBuilderInterface
- */
- public function getDatagridBuilder()
- {
- return $this->datagridBuilder;
- }
- /**
- * @param \Sonata\AdminBundle\Builder\ListBuilderInterface $listBuilder
- * @return void
- */
- public function setListBuilder(ListBuilderInterface $listBuilder)
- {
- $this->listBuilder = $listBuilder;
- }
- /**
- * @return \Sonata\AdminBundle\Builder\ListBuilderInterface
- */
- public function getListBuilder()
- {
- return $this->listBuilder;
- }
- /**
- * @param \Sonata\AdminBundle\Builder\ShowBuilderInterface $showBuilder
- * @return void
- */
- public function setShowBuilder(ShowBuilderInterface $showBuilder)
- {
- $this->showBuilder = $showBuilder;
- }
- /**
- * @return \Sonata\AdminBundle\Builder\ShowBuilderInterface
- */
- public function getShowBuilder()
- {
- return $this->showBuilder;
- }
- /**
- * @param Pool $configurationPool
- * @return void
- */
- public function setConfigurationPool(Pool $configurationPool)
- {
- $this->configurationPool = $configurationPool;
- }
- /**
- * @return Pool
- */
- public function getConfigurationPool()
- {
- return $this->configurationPool;
- }
- /**
- * @param \Symfony\Component\Routing\RouterInterface $router
- * @return void
- */
- public function setRouter(RouterInterface $router)
- {
- $this->router = $router;
- }
- /**
- * @return \Symfony\Component\Routing\RouterInterface
- */
- public function getRouter()
- {
- return $this->router;
- }
- public function getCode()
- {
- return $this->code;
- }
- public function setBaseCodeRoute($baseCodeRoute)
- {
- $this->baseCodeRoute = $baseCodeRoute;
- }
- public function getBaseCodeRoute()
- {
- return $this->baseCodeRoute;
- }
- /**
- * @return \Sonata\AdminBundle\Model\ModelManagerInterface
- */
- public function getModelManager()
- {
- return $this->modelManager;
- }
- /**
- * @param \Sonata\AdminBundle\Model\ModelManagerInterface $modelManager
- */
- public function setModelManager(ModelManagerInterface $modelManager)
- {
- $this->modelManager = $modelManager;
- }
- /**
- * Returns a unique identifier for this domain object.
- *
- * @return string
- */
- public function getObjectIdentifier()
- {
- return $this->getCode();
- }
- /**
- * Return the list of security name available for the current admin
- * This should be used by experimented users
- *
- * @return array
- */
- public function getSecurityInformation()
- {
- return array(
- 'EDIT' => array('EDIT'),
- 'LIST' => array('LIST'),
- 'CREATE' => array('CREATE'),
- 'VIEW' => array('VIEW'),
- 'DELETE' => array('DELETE'),
- 'OPERATOR' => array('OPERATOR')
- );
- }
- /**
- * @param \Sonata\AdminBundle\Security\Handler\SecurityHandlerInterface $securityHandler
- * @return void
- */
- public function setSecurityHandler(SecurityHandlerInterface $securityHandler)
- {
- $this->securityHandler = $securityHandler;
- }
- /**
- * @return \Sonata\AdminBundle\Security\Handler\SecurityHandlerInterface|null
- */
- public function getSecurityHandler()
- {
- return $this->securityHandler;
- }
- /**
- * @param string $name
- * @param object|null $object
- * @return boolean
- */
- public function isGranted($name, $object = null)
- {
- return $this->securityHandler->isGranted($this, $name, $object ?: $this);
- }
- /**
- * @param $entity
- * @return mixed
- */
- public function getNormalizedIdentifier($entity)
- {
- return $this->getModelManager()->getNormalizedIdentifier($entity);
- }
- /**
- * Shorthand method for templating
- *
- * @param object $entity
- * @return mixed
- */
- public function id($entity)
- {
- return $this->getNormalizedIdentifier($entity);
- }
- /**
- * @param \Symfony\Component\Validator\ValidatorInterface $validator
- * @return void
- */
- public function setValidator(ValidatorInterface $validator)
- {
- $this->validator = $validator;
- }
- /**
- * @return \Symfony\Component\Validator\ValidatorInterface
- */
- public function getValidator()
- {
- return $this->validator;
- }
- /**
- * @return array
- */
- public function getShow()
- {
- $this->buildShow();
- return $this->show;
- }
- /**
- * @param array $formTheme
- * @return void
- */
- public function setFormTheme(array $formTheme)
- {
- $this->formTheme = $formTheme;
- }
- /**
- * @return array
- */
- public function getFormTheme()
- {
- return $this->formTheme;
- }
- /**
- * @param array $filterTheme
- * @return void
- */
- public function setFilterTheme(array $filterTheme)
- {
- $this->filterTheme = $filterTheme;
- }
- /**
- * @return array
- */
- public function getFilterTheme()
- {
- return $this->filterTheme;
- }
- /**
- * @param AdminExtensionInterface $extension
- * @return void
- */
- public function addExtension(AdminExtensionInterface $extension)
- {
- $this->extensions[] = $extension;
- }
- /**
- * @return array
- */
- public function getExtensions()
- {
- return $this->extensions;
- }
- /**
- * @param \Knp\Menu\FactoryInterface $menuFactory
- * @return void
- */
- public function setMenuFactory(MenuFactoryInterface $menuFactory)
- {
- $this->menuFactory = $menuFactory;
- }
- /**
- * @return \Knp\Menu\FactoryInterface
- */
- public function getMenuFactory()
- {
- return $this->menuFactory;
- }
- /**
- * @param \Sonata\AdminBundle\Builder\RouteBuilderInterface $routeBuilder
- */
- public function setRouteBuilder(RouteBuilderInterface $routeBuilder)
- {
- $this->routeBuilder = $routeBuilder;
- }
- /**
- * @return \Sonata\AdminBundle\Builder\RouteBuilderInterface
- */
- public function getRouteBuilder()
- {
- return $this->routeBuilder;
- }
- /**
- * @param $object
- * @return string
- */
- public function toString($object)
- {
- if (method_exists($object, '__toString')) {
- return (string) $object;
- }
- return '';
- }
- /**
- * @param \Sonata\Adminbundle\Translator\LabelTranslatorStrategyInterface $labelTranslatorStrategy
- */
- public function setLabelTranslatorStrategy(LabelTranslatorStrategyInterface $labelTranslatorStrategy)
- {
- $this->labelTranslatorStrategy = $labelTranslatorStrategy;
- }
- /**
- * @return \Sonata\AdminBundle\Translator\LabelTranslatorStrategyInterface
- */
- public function getLabelTranslatorStrategy()
- {
- return $this->labelTranslatorStrategy;
- }
- }
|