vendor/doctrine/dbal/lib/Doctrine/DBAL/Event/SchemaEventArgs.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\DBAL\Event;
  21
  22 use Doctrine\Common\EventArgs;
  23
  24 /**
  25  * Base class for schema related events.
  26  *
  27  * @license     http://www.opensource.org/licenses/lgpl-license.php LGPL
  28  * @link        www.doctrine-project.com
  29  * @since       2.2
  30  * @author      Jan Sorgalla <jsorgalla@googlemail.com>
  31  */
  32 class SchemaEventArgs extends EventArgs
  33 {
  34     /**
  35      * @var boolean
  36      */
  37     private $_preventDefault = false;
  38
  39     /**
  40      * @return \Doctrine\DBAL\Event\SchemaEventArgs
  41      */
  42     public function preventDefault()
  43     {
  44         $this->_preventDefault = true;
  45
  46         return $this;
  47     }
  48
  49     /**
  50      * @return boolean
  51      */
  52     public function isDefaultPrevented()
  53     {
  54         return $this->_preventDefault;
  55     }
  56 }