SchemaEventArgs.php 1.6 KB

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