File oops_lib/Xoops/Core/Database/Schema/ExportVisitor.php

  1: <?php
  2: /*
  3:  You may not change or alter any portion of this comment or credits
  4:  of supporting developers from this source code or any supporting source code
  5:  which is considered copyrighted (c) material of the original comment or credit authors.
  6: 
  7:  This program is distributed in the hope that it will be useful,
  8:  but WITHOUT ANY WARRANTY; without even the implied warranty of
  9:  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 10: */
 11: 
 12: namespace Xoops\Core\Database\Schema;
 13: 
 14: use Doctrine\DBAL\Schema\Table;
 15: use Doctrine\DBAL\Schema\Schema;
 16: use Doctrine\DBAL\Schema\Column;
 17: use Doctrine\DBAL\Schema\ForeignKeyConstraint;
 18: use Doctrine\DBAL\Schema\Sequence;
 19: use Doctrine\DBAL\Schema\Index;
 20: use Doctrine\DBAL\Schema\Visitor\Visitor;
 21: 
 22: /**
 23:  * ExportVisitor is a Schema Visitor that builds an exportable array
 24:  * (not object) version of a schema.
 25:  * 
 26:  * @category  Xoops\Core\Database\Schema\ExportVisitor
 27:  * @package   Xoops\Core
 28:  * @author    Richard Griffith <richard@geekwright.com>
 29:  * @copyright 2013 XOOPS Project (http://xoops.org)
 30:  * @license   GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 31:  * @version   Release: 2.6
 32:  * @link      http://xoops.org
 33:  * @since     2.6.0
 34:  */
 35: class ExportVisitor implements Visitor
 36: {
 37: 
 38:     protected $schemaArray;
 39: 
 40:     /**
 41:      * Constructor
 42:      */
 43:     public function __construct()
 44:     {
 45:         $this->schemaArray = array();
 46:     }
 47: 
 48:     /**
 49:      * return the generated Schema
 50:      * 
 51:      * @return Schema the generated schema object
 52:      */
 53:     public function getSchemaArray()
 54:     {
 55:         return $this->schemaArray;
 56:     }
 57: 
 58:     /**
 59:      * Accept an entire schema. Do nothing in this visitor
 60:      * 
 61:      * @param Schema $schema schema object
 62:      * 
 63:      * @return void
 64:      */
 65:     public function acceptSchema(Schema $schema)
 66:     {
 67: 
 68:     }
 69: 
 70:     /**
 71:      * Accept a table
 72:      *
 73:      * @param Table $table a table object
 74:      * 
 75:      * @return void
 76:      */
 77:     public function acceptTable(Table $table)
 78:     {
 79:         $this->schemaArray['tables'][$table->getName()]['options'] = $table->getOptions();
 80:     }
 81: 
 82:     /**
 83:      * Accept a column in a table
 84:      *
 85:      * @param Table  $table  a table object
 86:      * @param Column $column a column object
 87:      * 
 88:      * @return void
 89:      */
 90:     public function acceptColumn(Table $table, Column $column)
 91:     {
 92:         $this->schemaArray['tables'][$table->getName()]['columns'][$column->getName()] = $column->toArray();
 93:         $this->schemaArray['tables'][$table->getName()]['columns'][$column->getName()]['type'] =
 94:             $column->getType()->getName();
 95:     }
 96: 
 97:     /**
 98:      * Accept a foreign key for a table
 99:      *
100:      * @param Table                $localTable   a table object
101:      * @param ForeignKeyConstraint $fkConstraint a constraint object
102:      * 
103:      * @return void
104:      */
105:     public function acceptForeignKey(Table $localTable, ForeignKeyConstraint $fkConstraint)
106:     {
107:         if (!isset($this->schemaArray['tables'][$localTable->getName()]['constraint'])) {
108:             $this->schemaArray['tables'][$localTable->getName()]['constraint']=array();
109:         }
110:         $this->schemaArray['tables'][$localTable->getName()]['constraint'][] = array(
111:                 'name' => $fkConstraint->getName(),
112:                 'localcolumns' => $fkConstraint->getLocalColumns(),
113:                 'foreigntable' => $fkConstraint->getForeignTableName(),
114:                 'foreigncolumns' => $fkConstraint->getForeignColumns(),
115:                 'options' => $fkConstraint->getOptions()
116:             );
117: 
118:     }
119: 
120:     /**
121:      * Accept an index on in a table
122:      *
123:      * @param Table $table a table object
124:      * @param Index $index a column object
125:      * 
126:      * @return void
127:      */
128:     public function acceptIndex(Table $table, Index $index)
129:     {
130:         $this->schemaArray['tables'][$table->getName()]['indexes'][$index->getName()] = array(
131:                 'name' => $index->getName(),
132:                 'columns' => $index->getColumns(),
133:                 'unique' => $index->isUnique(),
134:                 'primary' => $index->isPrimary()
135:             );
136:     }
137: 
138:     /**
139:      * Accept an sequence
140:      *
141:      * @param Sequence $sequence a sequence object
142:      * 
143:      * @return void
144:      */
145:     public function acceptSequence(Sequence $sequence)
146:     {
147:         $this->schemaArray['sequence'][$sequence->getName()] = array(
148:                 'name' => $sequence->getName(),
149:                 'allocationsize' => $sequence->getAllocationSize(),
150:                 'initialvalue' => $sequence->getInitialValue()
151:             );
152:     }
153: }
154:
Namespaces

Classes

Interfaces

Exceptions

Functions
