Configuration.php 3.21 KB
Newer Older
1
<?php 
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
/*
 *  $Id$
 *
 * 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
 * and is licensed under the LGPL. For more information, see
19
 * <http://www.doctrine-project.org>.
20
 */
21

22 23 24
namespace Doctrine\DBAL;

use Doctrine\DBAL\Types\Type;
25 26

/**
27
 * Configuration container for the Doctrine DBAL.
28
 *
29 30 31 32 33 34 35 36
 * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
 * @link    www.doctrine-project.org
 * @since   2.0
 * @version $Revision: 3938 $
 * @author  Guilherme Blanco <guilhermeblanco@hotmail.com>
 * @author  Jonathan Wage <jonwage@gmail.com>
 * @author  Roman Borschel <roman@code-factory.org>
 *
37 38
 * @internal When adding a new configuration option just write a getter/setter
 *           pair and add the option to the _attributes array with a proper default value.
39
 */
40
class Configuration
41 42 43
{
    /**
     * The attributes that are contained in the configuration.
44
     * Values are default values.
45 46 47
     *
     * @var array
     */
48
    protected $_attributes = array();
49
    
50
    /**
51
     * Creates a new DBAL configuration instance.
52
     */
53
    public function __construct()
54 55
    {
        $this->_attributes = array(
56
            'sqlLogger' => null
57 58
        );
    }
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
    
    /**
     * Sets the SQL logger to use. Defaults to NULL which means SQL logging is disabled.
     *
     * @param SqlLogger $logger
     */
    public function setSqlLogger($logger)
    {
        $this->_attributes['sqlLogger'] = $logger;
    }
    
    /**
     * Gets the SQL logger that is used.
     * 
     * @return SqlLogger
     */
    public function getSqlLogger()
    {
        return $this->_attributes['sqlLogger'];
    }
79

80 81 82 83 84 85 86
    /**
     * Defines new custom types to be supported by Doctrine
     *
     * @param array $types Key-value map of types to include
     * @param boolean $override Optional flag to support only inclusion or also override
     */
    public function setCustomTypes(array $types, $override = false)
87 88
    {
        foreach ($types as $name => $typeClassName) {
89
            $method = (Type::hasType($name) && $override ? 'override' : 'add') . 'Type';
90 91
            
            Type::$method($name, $typeClassName);
92 93
        }
    }
94

95 96 97 98 99
    /**
     * Overrides existent types in Doctrine
     *
     * @param array $types Key-value map of types to override
     */
100
    public function setTypeOverrides(array $overrides)
101
    {
102
        foreach ($override as $name => $typeClassName) {
103
            Type::overrideType($name, $typeClassName);
104
        }
105 106
    }
}