vendor/doctrine/dbal/lib/Doctrine/DBAL/Schema/Visitor/Visitor.php

   1 <?php
   2 /*
   3  *  $Id$
   4  *
   5  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   6  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   7  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   8  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   9  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  10  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  11  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  12  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  13  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  14  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  15  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  16  *
  17  * This software consists of voluntary contributions made by many individuals
  18  * and is licensed under the MIT license. For more information, see
  19  * <http://www.doctrine-project.org>.
  20  */
  21
  22 namespace Doctrine\DBAL\Schema\Visitor;
  23
  24 use Doctrine\DBAL\Platforms\AbstractPlatform,
  25     Doctrine\DBAL\Schema\Table,
  26     Doctrine\DBAL\Schema\Schema,
  27     Doctrine\DBAL\Schema\Column,
  28     Doctrine\DBAL\Schema\ForeignKeyConstraint,
  29     Doctrine\DBAL\Schema\Constraint,
  30     Doctrine\DBAL\Schema\Sequence,
  31     Doctrine\DBAL\Schema\Index;
  32
  33 /**
  34  * Schema Visitor used for Validation or Generation purposes.
  35  *
  36  *
  37  * @link    www.doctrine-project.org
  38  * @since   2.0
  39  * @version $Revision$
  40  * @author  Benjamin Eberlei <kontakt@beberlei.de>
  41  */
  42 interface Visitor
  43 {
  44     /**
  45      * @param Schema $schema
  46      */
  47     public function acceptSchema(Schema $schema);
  48
  49     /**
  50      * @param Table $table
  51      */
  52     public function acceptTable(Table $table);
  53
  54     /**
  55      * @param Column $column
  56      */
  57     public function acceptColumn(Table $table, Column $column);
  58
  59     /**
  60      * @param Table $localTable
  61      * @param ForeignKeyConstraint $fkConstraint
  62      */
  63     public function acceptForeignKey(Table $localTable, ForeignKeyConstraint $fkConstraint);
  64
  65     /**
  66      * @param Table $table
  67      * @param Index $index
  68      */
  69     public function acceptIndex(Table $table, Index $index);
  70
  71     /**
  72      * @param Sequence $sequence
  73      */
  74     public function acceptSequence(Sequence $sequence);
  75 }