www.aleph1.co.uk Git - yaffs-website/blob - vendor/doctrine/common/lib/Doctrine/Common/Proxy/Exception/InvalidArgumentException.php

   1 <?php
   2 /*
   3  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   4  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   5  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   6  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   7  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   8  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   9  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  10  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  11  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  12  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  13  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14  *
  15  * This software consists of voluntary contributions made by many individuals
  16  * and is licensed under the MIT license. For more information, see
  17  * <http://www.doctrine-project.org>.
  18  */
  19
  20 namespace Doctrine\Common\Proxy\Exception;
  21
  22 use Doctrine\Common\Persistence\Proxy;
  23 use InvalidArgumentException as BaseInvalidArgumentException;
  24
  25 /**
  26  * Proxy Invalid Argument Exception.
  27  *
  28  * @link   www.doctrine-project.org
  29  * @since  2.4
  30  * @author Marco Pivetta <ocramius@gmail.com>
  31  */
  32 class InvalidArgumentException extends BaseInvalidArgumentException implements ProxyException
  33 {
  34     /**
  35      * @return self
  36      */
  37     public static function proxyDirectoryRequired()
  38     {
  39         return new self('You must configure a proxy directory. See docs for details');
  40     }
  41
  42     /**
  43      * @param string $className
  44      * @param string $proxyNamespace
  45      *
  46      * @return self
  47      */
  48     public static function notProxyClass($className, $proxyNamespace)
  49     {
  50         return new self(sprintf('The class "%s" is not part of the proxy namespace "%s"', $className, $proxyNamespace));
  51     }
  52
  53     /**
  54      * @param string $name
  55      *
  56      * @return self
  57      */
  58     public static function invalidPlaceholder($name)
  59     {
  60         return new self(sprintf('Provided placeholder for "%s" must be either a string or a valid callable', $name));
  61     }
  62
  63     /**
  64      * @return self
  65      */
  66     public static function proxyNamespaceRequired()
  67     {
  68         return new self('You must configure a proxy namespace');
  69     }
  70
  71     /**
  72      * @param Proxy $proxy
  73      *
  74      * @return self
  75      */
  76     public static function unitializedProxyExpected(Proxy $proxy)
  77     {
  78         return new self(sprintf('Provided proxy of type "%s" must not be initialized.', get_class($proxy)));
  79     }
  80
  81     /**
  82      * @param mixed $callback
  83      *
  84      * @return self
  85      */
  86     public static function invalidClassNotFoundCallback($callback)
  87     {
  88         $type = is_object($callback) ? get_class($callback) : gettype($callback);
  89
  90         return new self(sprintf('Invalid \$notFoundCallback given: must be a callable, "%s" given', $type));
  91     }
  92 }