SchemaConfig.php 2.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
<?php
/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
Benjamin Eberlei's avatar
Benjamin Eberlei committed
16
 * and is licensed under the MIT license. For more information, see
17 18 19 20 21 22 23 24
 * <http://www.doctrine-project.org>.
 */

namespace Doctrine\DBAL\Schema;

/**
 * Configuration for a Schema
 *
Benjamin Eberlei's avatar
Benjamin Eberlei committed
25
 * 
26 27 28 29 30 31 32 33 34
 * @link    www.doctrine-project.org
 * @since   2.0
 * @author  Benjamin Eberlei <kontakt@beberlei.de>
 */
class SchemaConfig
{
    /**
     * @var bool
     */
35
    protected $hasExplicitForeignKeyIndexes = false;
36 37 38 39

    /**
     * @var int
     */
40
    protected $maxIdentifierLength = 63;
41

42
    /**
43
     * @var string
44
     */
45 46 47 48 49 50
    protected $name;

    /**
     * @var array
     */
    protected $defaultTableOptions = array();
51

52 53 54 55 56
    /**
     * @return bool
     */
    public function hasExplicitForeignKeyIndexes()
    {
57
        return $this->hasExplicitForeignKeyIndexes;
58 59 60 61 62 63 64
    }

    /**
     * @param bool $flag
     */
    public function setExplicitForeignKeyIndexes($flag)
    {
65
        $this->hasExplicitForeignKeyIndexes = (bool)$flag;
66 67 68 69 70 71 72
    }

    /**
     * @param int $length
     */
    public function setMaxIdentifierLength($length)
    {
73
        $this->maxIdentifierLength = (int)$length;
74 75 76 77 78 79 80
    }

    /**
     * @return int
     */
    public function getMaxIdentifierLength()
    {
81
        return $this->maxIdentifierLength;
82
    }
83

84 85 86 87 88 89
    /**
     * Get default namespace of schema objects.
     *
     * @return string
     */
    public function getName()
90
    {
91
        return $this->name;
92 93
    }

94 95 96
    /**
     * set default namespace name of schema objects.
     *
97
     * @param string $name the value to set.
98 99
     */
    public function setName($name)
100
    {
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
        $this->name = $name;
    }

    /**
     * Get the default options that are passed to Table instances created with
     * Schema#createTable().
     *
     * @return array
     */
    public function getDefaultTableOptions()
    {
        return $this->defaultTableOptions;
    }

    public function setDefaultTableOptions(array $defaultTableOptions)
    {
        $this->defaultTableOptions = $defaultTableOptions;
118 119
    }
}