typo3/sysext/extbase/Classes/Object/ObjectManagerInterfaceException.php

   1 <?php
   2 namespace TYPO3\CMS\Extbase\Object;
   3
   4 /***************************************************************
   5  *  Copyright notice
   6  *
   7  *  (c) 2010-2013 Extbase Team (http://forge.typo3.org/projects/typo3v4-mvc)
   8  *  Extbase is a backport of TYPO3 Flow. All credits go to the TYPO3 Flow team.
   9  *  All rights reserved
  10  *
  11  *  This script is part of the TYPO3 project. The TYPO3 project is
  12  *  free software; you can redistribute it and/or modify
  13  *  it under the terms of the GNU General Public License as published by
  14  *  the Free Software Foundation; either version 2 of the License, or
  15  *  (at your option) any later version.
  16  *
  17  *  The GNU General Public License can be found at
  18  *  http://www.gnu.org/copyleft/gpl.html.
  19  *  A copy is found in the textfile GPL.txt and important notices to the license
  20  *  from the author is found in LICENSE.txt distributed with these scripts.
  21  *
  22  *
  23  *  This script is distributed in the hope that it will be useful,
  24  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  *  GNU General Public License for more details.
  27  *
  28  *  This copyright notice MUST APPEAR in all copies of the script!
  29  ***************************************************************/
  30 /**
  31  * Interface for the TYPO3 Object Manager
  32  */
  33 interface ObjectManagerInterfaceException extends \TYPO3\CMS\Core\SingletonInterface {
  34
  35         /**
  36          * Returns TRUE if an object with the given name is registered
  37          *
  38          * @param string $objectName Name of the object
  39          * @return boolean TRUE if the object has been registered, otherwise FALSE
  40          */
  41         public function isRegistered($objectName);
  42
  43         /**
  44          * Returns a fresh or existing instance of the object specified by $objectName.
  45          *
  46          * Important:
  47          *
  48          * If possible, instances of Prototype objects should always be created with the
  49          * Object Manager's create() method and Singleton objects should rather be
  50          * injected by some type of Dependency Injection.
  51          *
  52          * @param string $objectName The name of the object to return an instance of
  53          * @return object The object instance
  54          * @api
  55          */
  56         public function get($objectName);
  57
  58         /**
  59          * Creates a fresh instance of the object specified by $objectName.
  60          *
  61          * This factory method can only create objects of the scope prototype.
  62          * Singleton objects must be either injected by some type of Dependency Injection or
  63          * if that is not possible, be retrieved by the get() method of the
  64          * Object Manager
  65          *
  66          * @param string $objectName The name of the object to create
  67          * @return object The new object instance
  68          * @throws \TYPO3\CMS\Extbase\Object\Exception\WrongScopeException if the created object is not of scope prototype
  69          * @api
  70          */
  71         public function create($objectName);
  72
  73         /**
  74          * Create an instance of $className without calling its constructor
  75          *
  76          * @param string $className
  77          * @return object
  78          * @api
  79          */
  80         public function getEmptyObject($className);
  81 }