1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
|
<?php
declare(strict_types=1);
namespace Doctrine\ORM\Tools;
use Doctrine\Common\Cache\ApcuCache;
use Doctrine\Common\Cache\ArrayCache;
use Doctrine\Common\Cache\Cache;
use Doctrine\Common\Cache\CacheProvider;
use Doctrine\Common\Cache\MemcachedCache;
use Doctrine\Common\Cache\Psr6\CacheAdapter;
use Doctrine\Common\Cache\Psr6\DoctrineProvider;
use Doctrine\Common\Cache\RedisCache;
use Doctrine\Common\ClassLoader;
use Doctrine\Deprecations\Deprecation;
use Doctrine\ORM\Configuration;
use Doctrine\ORM\Mapping\Driver\AttributeDriver;
use Doctrine\ORM\Mapping\Driver\XmlDriver;
use Doctrine\ORM\Mapping\Driver\YamlDriver;
use Doctrine\ORM\ORMSetup;
use Memcached;
use Redis;
use RuntimeException;
use Symfony\Component\Cache\Adapter\ApcuAdapter;
use Symfony\Component\Cache\Adapter\ArrayAdapter;
use Symfony\Component\Cache\Adapter\MemcachedAdapter;
use Symfony\Component\Cache\Adapter\RedisAdapter;
use function apcu_enabled;
use function class_exists;
use function dirname;
use function extension_loaded;
use function file_exists;
use function md5;
use function sys_get_temp_dir;
/**
* Convenience class for setting up Doctrine from different installations and configurations.
*
* @deprecated Use {@see ORMSetup} instead.
*/
class Setup
{
/**
* Use this method to register all autoloads for a downloaded Doctrine library.
* Pick the directory the library was uncompressed into.
*
* @deprecated Use Composer's autoloader instead.
*
* @param string $directory
*
* @return void
*/
public static function registerAutoloadDirectory($directory)
{
if (! class_exists('Doctrine\Common\ClassLoader', false)) {
if (file_exists($directory . '/Doctrine/Common/ClassLoader.php')) {
require_once $directory . '/Doctrine/Common/ClassLoader.php';
} elseif (file_exists(dirname($directory) . '/src/ClassLoader.php')) {
require_once dirname($directory) . '/src/ClassLoader.php';
}
}
$loader = new ClassLoader('Doctrine', $directory);
$loader->register();
$loader = new ClassLoader('Symfony\Component', $directory . '/Doctrine');
$loader->register();
}
/**
* Creates a configuration with an annotation metadata driver.
*
* @param string[] $paths
* @param bool $isDevMode
* @param string|null $proxyDir
* @param bool $useSimpleAnnotationReader
*
* @return Configuration
*/
public static function createAnnotationMetadataConfiguration(array $paths, $isDevMode = false, $proxyDir = null, ?Cache $cache = null, $useSimpleAnnotationReader = true)
{
Deprecation::trigger(
'doctrine/orm',
'https://github.com/doctrine/orm/pull/9443',
'%s is deprecated and will be removed in Doctrine 3.0, please use %s instead.',
self::class,
ORMSetup::class
);
$config = self::createConfiguration($isDevMode, $proxyDir, $cache);
$config->setMetadataDriverImpl($config->newDefaultAnnotationDriver($paths, $useSimpleAnnotationReader));
return $config;
}
/**
* Creates a configuration with an attribute metadata driver.
*
* @param string[] $paths
* @param bool $isDevMode
* @param string|null $proxyDir
*/
public static function createAttributeMetadataConfiguration(
array $paths,
$isDevMode = false,
$proxyDir = null,
?Cache $cache = null
): Configuration {
Deprecation::trigger(
'doctrine/orm',
'https://github.com/doctrine/orm/pull/9443',
'%s is deprecated and will be removed in Doctrine 3.0, please use %s instead.',
self::class,
ORMSetup::class
);
$config = self::createConfiguration($isDevMode, $proxyDir, $cache);
$config->setMetadataDriverImpl(new AttributeDriver($paths));
return $config;
}
/**
* Creates a configuration with an XML metadata driver.
*
* @param string[] $paths
* @param bool $isDevMode
* @param string|null $proxyDir
*
* @return Configuration
*/
public static function createXMLMetadataConfiguration(array $paths, $isDevMode = false, $proxyDir = null, ?Cache $cache = null)
{
Deprecation::trigger(
'doctrine/orm',
'https://github.com/doctrine/orm/pull/9443',
'%s is deprecated and will be removed in Doctrine 3.0, please use %s instead.',
self::class,
ORMSetup::class
);
$config = self::createConfiguration($isDevMode, $proxyDir, $cache);
$config->setMetadataDriverImpl(new XmlDriver($paths));
return $config;
}
/**
* Creates a configuration with a YAML metadata driver.
*
* @deprecated YAML metadata mapping is deprecated and will be removed in 3.0
*
* @param string[] $paths
* @param bool $isDevMode
* @param string|null $proxyDir
*
* @return Configuration
*/
public static function createYAMLMetadataConfiguration(array $paths, $isDevMode = false, $proxyDir = null, ?Cache $cache = null)
{
Deprecation::trigger(
'doctrine/orm',
'https://github.com/doctrine/orm/issues/8465',
'YAML mapping driver is deprecated and will be removed in Doctrine ORM 3.0, please migrate to attribute or XML driver.'
);
$config = self::createConfiguration($isDevMode, $proxyDir, $cache);
$config->setMetadataDriverImpl(new YamlDriver($paths));
return $config;
}
/**
* Creates a configuration without a metadata driver.
*
* @param bool $isDevMode
* @param string|null $proxyDir
*
* @return Configuration
*/
public static function createConfiguration($isDevMode = false, $proxyDir = null, ?Cache $cache = null)
{
Deprecation::triggerIfCalledFromOutside(
'doctrine/orm',
'https://github.com/doctrine/orm/pull/9443',
'%s is deprecated and will be removed in Doctrine 3.0, please use %s instead.',
self::class,
ORMSetup::class
);
$proxyDir = $proxyDir ?: sys_get_temp_dir();
$cache = self::createCacheConfiguration($isDevMode, $proxyDir, $cache);
$config = new Configuration();
$config->setMetadataCache(CacheAdapter::wrap($cache));
$config->setQueryCache(CacheAdapter::wrap($cache));
$config->setResultCache(CacheAdapter::wrap($cache));
$config->setProxyDir($proxyDir);
$config->setProxyNamespace('DoctrineProxies');
$config->setAutoGenerateProxyClasses($isDevMode);
return $config;
}
private static function createCacheConfiguration(bool $isDevMode, string $proxyDir, ?Cache $cache): Cache
{
$cache = self::createCacheInstance($isDevMode, $cache);
if (! $cache instanceof CacheProvider) {
return $cache;
}
$namespace = $cache->getNamespace();
if ($namespace !== '') {
$namespace .= ':';
}
$cache->setNamespace($namespace . 'dc2_' . md5($proxyDir) . '_'); // to avoid collisions
return $cache;
}
private static function createCacheInstance(bool $isDevMode, ?Cache $cache): Cache
{
if ($cache !== null) {
return $cache;
}
if (! class_exists(ArrayCache::class) && ! class_exists(ArrayAdapter::class)) {
throw new RuntimeException('Setup tool cannot configure caches without doctrine/cache 1.11 or symfony/cache. Please add an explicit dependency to either library.');
}
if ($isDevMode === true) {
$cache = class_exists(ArrayCache::class) ? new ArrayCache() : new ArrayAdapter();
} elseif (extension_loaded('apcu') && apcu_enabled()) {
$cache = class_exists(ApcuCache::class) ? new ApcuCache() : new ApcuAdapter();
} elseif (extension_loaded('memcached') && (class_exists(MemcachedCache::class) || MemcachedAdapter::isSupported())) {
$memcached = new Memcached();
$memcached->addServer('127.0.0.1', 11211);
if (class_exists(MemcachedCache::class)) {
$cache = new MemcachedCache();
$cache->setMemcached($memcached);
} else {
$cache = new MemcachedAdapter($memcached);
}
} elseif (extension_loaded('redis')) {
$redis = new Redis();
$redis->connect('127.0.0.1');
if (class_exists(RedisCache::class)) {
$cache = new RedisCache();
$cache->setRedis($redis);
} else {
$cache = new RedisAdapter($redis);
}
} else {
$cache = class_exists(ArrayCache::class) ? new ArrayCache() : new ArrayAdapter();
}
return $cache instanceof Cache ? $cache : DoctrineProvider::wrap($cache);
}
}
|