<?php

/**
 * AppserverIo\Appserver\PersistenceContainer\Doctrine\V2\DriverFactories\DriverInterface
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Tim Wagner <tw@appserver.io>
 * @copyright 2015 TechDivision GmbH <info@appserver.io>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io/rmi
 * @link      http://www.appserver.io
 */

namespace AppserverIo\Appserver\PersistenceContainer\Doctrine\V2\DriverFactories;

use Doctrine\ORM\Configuration;

/**
 * The factory class for a new Doctrine annotation mapping driver instance.
 *
 * @author    Tim Wagner <tw@appserver.io>
 * @author    Bernhard Wick <bw@appserver.io>
 * @copyright 2015 TechDivision GmbH <info@appserver.io>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io/rmi
 * @link      http://www.appserver.io
 */
class AnnotationDriverFactory implements DriverFactoryInterface
{

    /**
     * Return's the new driver instance.
     *
     * @param \Doctrine\ORM\Configuration $configuration The DBAL configuration to create the driver for
     * @param array                       $paths         The path to the driver configuration
     * @param array                       $params        The additional configuration params
     *
     * @return \Doctrine\Common\Persistence\Mapping\Driver\MappingDriver The driver instance
     */
    public static function get(Configuration $configuration, array $paths = array(), array $params = array())
    {

        // query whether or not we want to use the simple annotation reader
        $useSimpleAnnotationReader = false;
        if (isset($params[DriverKeys::USE_SIMPLE_ANNOTATION_READER])) {
            $useSimpleAnnotationReader = $params[DriverKeys::USE_SIMPLE_ANNOTATION_READER];
        }

        // create and return the driver instance
        return $configuration->newDefaultAnnotationDriver($paths, $useSimpleAnnotationReader);
    }
}
