mirror of
https://forge.chapril.org/tykayn/caisse-bliss
synced 2025-10-04 17:04:54 +02:00
2715 lines
137 KiB
HTML
2715 lines
137 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Documentation</title>
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<base href="../">
|
|
<link rel="icon" href="images/favicon.ico"/>
|
|
<link rel="stylesheet" href="css/normalize.css">
|
|
<link rel="stylesheet" href="css/base.css">
|
|
<link rel="preconnect" href="https://fonts.gstatic.com">
|
|
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
|
|
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
|
|
<link rel="stylesheet" href="css/template.css">
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
|
|
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
|
|
<script src="js/template.js"></script>
|
|
<script src="js/search.js"></script>
|
|
<script defer src="js/searchIndex.js"></script>
|
|
</head>
|
|
<body id="top">
|
|
<header class="phpdocumentor-header phpdocumentor-section">
|
|
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
|
|
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
|
|
<label class="phpdocumentor-header__menu-icon" for="menu-button">
|
|
<i class="fas fa-bars"></i>
|
|
</label>
|
|
<section data-search-form class="phpdocumentor-search">
|
|
<label>
|
|
<span class="visually-hidden">Search for</span>
|
|
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
|
|
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
|
|
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
|
|
</svg>
|
|
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
|
|
</label>
|
|
</section>
|
|
|
|
<nav class="phpdocumentor-topnav">
|
|
<ul class="phpdocumentor-topnav__menu">
|
|
</ul>
|
|
</nav>
|
|
</header>
|
|
|
|
<main class="phpdocumentor">
|
|
<div class="phpdocumentor-section">
|
|
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
|
|
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
|
|
Menu
|
|
</label>
|
|
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
|
|
<section class="phpdocumentor-sidebar__category">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/doctrinemigrations.html" class="">DoctrineMigrations</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/hwi.html" class="">HWI</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/hwi-bundle.html" class="">Bundle</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/caissebliss.html" class="">CaisseBliss</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/caissebliss-controller.html" class="">Controller</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/caissebliss-entity.html" class="">Entity</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/caissebliss-form.html" class="">Form</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/caissebliss-repository.html" class="">Repository</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/caissebliss-security.html" class="">Security</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/caissebliss-service.html" class="">Service</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/caissebliss-tests.html" class="">Tests</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/caissebliss-traits.html" class="">Traits</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/tests.html" class="">Tests</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/tests-appbundle.html" class="">AppBundle</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/app.html" class="">App</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/app-controller.html" class="">Controller</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/app-datafixtures.html" class="">DataFixtures</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/app-entity.html" class="">Entity</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/app-form.html" class="">Form</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/app-repository.html" class="">Repository</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/app-security.html" class="">Security</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/app-traits.html" class="">Traits</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/app-tests.html" class="">Tests</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/containervvrt4pd.html" class="">ContainerVvRT4pd</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/symfony.html" class="">Symfony</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/symfony-config.html" class="">Config</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/symfony-component.html" class="">Component</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/symfony-contracts.html" class="">Contracts</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/symfony-bundle.html" class="">Bundle</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/symfony-bridge.html" class="">Bridge</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/symfony-flex.html" class="">Flex</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/symfony-polyfill.html" class="">Polyfill</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/symfony-runtime.html" class="">Runtime</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/symfony-webpackencorebundle.html" class="">WebpackEncoreBundle</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/composer.html" class="">Composer</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/composer-autoload.html" class="">Autoload</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/doctrine.html" class="">Doctrine</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/doctrine-common.html" class="">Common</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/doctrine-dbal.html" class="">DBAL</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/doctrine-deprecations.html" class="">Deprecations</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/doctrine-bundle.html" class="">Bundle</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/doctrine-inflector.html" class="">Inflector</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/doctrine-instantiator.html" class="">Instantiator</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/doctrine-migrations.html" class="">Migrations</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/doctrine-orm.html" class="">ORM</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/doctrine-persistence.html" class="">Persistence</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/doctrine-sqlformatter.html" class="">SqlFormatter</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/easycorp.html" class="">EasyCorp</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/easycorp-bundle.html" class="">Bundle</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/egulias.html" class="">Egulias</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/egulias-emailvalidator.html" class="">EmailValidator</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/proxymanager.html" class="">ProxyManager</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/proxymanager-autoloader.html" class="">Autoloader</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/proxymanager-exception.html" class="">Exception</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/proxymanager-factory.html" class="">Factory</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/proxymanager-filelocator.html" class="">FileLocator</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/proxymanager-generator.html" class="">Generator</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/proxymanager-generatorstrategy.html" class="">GeneratorStrategy</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/proxymanager-inflector.html" class="">Inflector</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/proxymanager-proxy.html" class="">Proxy</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/proxymanager-proxygenerator.html" class="">ProxyGenerator</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/proxymanager-signature.html" class="">Signature</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/proxymanager-stub.html" class="">Stub</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/laminas.html" class="">Laminas</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/laminas-code.html" class="">Code</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/monolog.html" class="">Monolog</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/monolog-attribute.html" class="">Attribute</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/monolog-formatter.html" class="">Formatter</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/monolog-handler.html" class="">Handler</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/monolog-processor.html" class="">Processor</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/monolog-test.html" class="">Test</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/deepcopy.html" class="">DeepCopy</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/deepcopy-exception.html" class="">Exception</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/deepcopy-filter.html" class="">Filter</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/deepcopy-matcher.html" class="">Matcher</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/deepcopy-reflection.html" class="">Reflection</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/deepcopy-typefilter.html" class="">TypeFilter</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/deepcopy-typematcher.html" class="">TypeMatcher</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/phpparser.html" class="">PhpParser</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/phpparser-builder.html" class="">Builder</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/phpparser-comment.html" class="">Comment</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/phpparser-errorhandler.html" class="">ErrorHandler</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/phpparser-internal.html" class="">Internal</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/phpparser-lexer.html" class="">Lexer</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/phpparser-node.html" class="">Node</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/phpparser-nodevisitor.html" class="">NodeVisitor</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/phpparser-parser.html" class="">Parser</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/phpparser-prettyprinter.html" class="">PrettyPrinter</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/phario.html" class="">PharIo</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/phario-manifest.html" class="">Manifest</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/phario-version.html" class="">Version</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/phpdocumentor.html" class="">phpDocumentor</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/phpdocumentor-reflection.html" class="">Reflection</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/phpstan.html" class="">PHPStan</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/phpstan-phpdocparser.html" class="">PhpDocParser</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/phpunit.html" class="">PHPUnit</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/phpunit-framework.html" class="">Framework</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/phpunit-runner.html" class="">Runner</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/phpunit-textui.html" class="">TextUI</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/phpunit-util.html" class="">Util</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/psr.html" class="">Psr</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/psr-cache.html" class="">Cache</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/psr-container.html" class="">Container</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/psr-eventdispatcher.html" class="">EventDispatcher</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/psr-link.html" class="">Link</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/psr-log.html" class="">Log</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/sebastianbergmann.html" class="">SebastianBergmann</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/sebastianbergmann-codecoverage.html" class="">CodeCoverage</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/sebastianbergmann-fileiterator.html" class="">FileIterator</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/sebastianbergmann-invoker.html" class="">Invoker</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/sebastianbergmann-template.html" class="">Template</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/sebastianbergmann-timer.html" class="">Timer</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/sebastianbergmann-cliparser.html" class="">CliParser</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/sebastianbergmann-codeunit.html" class="">CodeUnit</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/sebastianbergmann-codeunitreverselookup.html" class="">CodeUnitReverseLookup</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/sebastianbergmann-comparator.html" class="">Comparator</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/sebastianbergmann-complexity.html" class="">Complexity</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/sebastianbergmann-diff.html" class="">Diff</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/sebastianbergmann-environment.html" class="">Environment</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/sebastianbergmann-exporter.html" class="">Exporter</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/sebastianbergmann-globalstate.html" class="">GlobalState</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/sebastianbergmann-linesofcode.html" class="">LinesOfCode</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/sebastianbergmann-objectenumerator.html" class="">ObjectEnumerator</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/sebastianbergmann-objectreflector.html" class="">ObjectReflector</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/sebastianbergmann-recursioncontext.html" class="">RecursionContext</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/sebastianbergmann-resourceoperations.html" class="">ResourceOperations</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/sebastianbergmann-type.html" class="">Type</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/theseer.html" class="">TheSeer</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/theseer-tokenizer.html" class="">Tokenizer</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/twig.html" class="">Twig</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/twig-extra.html" class="">Extra</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/twig-cache.html" class="">Cache</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/twig-error.html" class="">Error</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/twig-extension.html" class="">Extension</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/twig-loader.html" class="">Loader</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/twig-node.html" class="">Node</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/twig-nodevisitor.html" class="">NodeVisitor</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/twig-profiler.html" class="">Profiler</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/twig-runtimeloader.html" class="">RuntimeLoader</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/twig-sandbox.html" class="">Sandbox</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/twig-test.html" class="">Test</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/twig-tokenparser.html" class="">TokenParser</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/twig-util.html" class="">Util</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/webmozart.html" class="">Webmozart</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/webmozart-assert.html" class="">Assert</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
</section>
|
|
<section class="phpdocumentor-sidebar__category">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/Application.html" class="">Application</a>
|
|
</h4>
|
|
|
|
</section>
|
|
|
|
<section class="phpdocumentor-sidebar__category">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-sidebar__category">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
|
|
</section>
|
|
</aside>
|
|
|
|
<div class="phpdocumentor-column -nine phpdocumentor-content">
|
|
<section>
|
|
<ul class="phpdocumentor-breadcrumbs">
|
|
<li class="phpdocumentor-breadcrumb"><a href="namespaces/doctrine.html">Doctrine</a></li>
|
|
<li class="phpdocumentor-breadcrumb"><a href="namespaces/doctrine-orm.html">ORM</a></li>
|
|
<li class="phpdocumentor-breadcrumb"><a href="namespaces/doctrine-orm-tools.html">Tools</a></li>
|
|
</ul>
|
|
|
|
<article class="phpdocumentor-element -class">
|
|
<h2 class="phpdocumentor-content__title">
|
|
SchemaTool
|
|
|
|
|
|
<div class="phpdocumentor-element__package">
|
|
in package
|
|
<ul class="phpdocumentor-breadcrumbs">
|
|
<li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
</h2>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
|
|
|
|
</div>
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-tools-schematool.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php">SchemaTool.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">55</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">The SchemaTool is a tool to create/drop/update database schemas based on
|
|
<tt>ClassMetadata</tt> class descriptors.</p>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">link</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<a class="phpdocumentor-tag-link" href="www.doctrine-project.org"> www.doctrine-project.org </a>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">psalm-import-type</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>AssociationMapping from ClassMetadata</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">psalm-import-type</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>DiscriminatorColumnMapping from ClassMetadata</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">psalm-import-type</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>FieldMapping from ClassMetadata</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">psalm-import-type</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>JoinColumnData from ClassMetadata</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h3 id="toc">
|
|
Table of Contents
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h3>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4 id="toc-constants">
|
|
Constants
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#toc-constants" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -private">
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#constant_KNOWN_COLUMN_OPTIONS">KNOWN_COLUMN_OPTIONS</a>
|
|
<span>
|
|
= ['comment', 'unsigned', 'fixed', 'default'] </span>
|
|
</dt>
|
|
|
|
</dl>
|
|
|
|
|
|
<h4 id="toc-properties">
|
|
Properties
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#property_em">$em</a>
|
|
<span>
|
|
: <a href="classes/Doctrine-ORM-EntityManagerInterface.html"><abbr title="\Doctrine\ORM\EntityManagerInterface">EntityManagerInterface</abbr></a> </span>
|
|
</dt>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#property_platform">$platform</a>
|
|
<span>
|
|
: <a href="classes/Doctrine-DBAL-Platforms-AbstractPlatform.html"><abbr title="\Doctrine\DBAL\Platforms\AbstractPlatform">AbstractPlatform</abbr></a> </span>
|
|
</dt>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#property_quoteStrategy">$quoteStrategy</a>
|
|
<span>
|
|
: <a href="classes/Doctrine-ORM-Mapping-QuoteStrategy.html"><abbr title="\Doctrine\ORM\Mapping\QuoteStrategy">QuoteStrategy</abbr></a> </span>
|
|
</dt>
|
|
<dd>The quote strategy.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#property_schemaManager">$schemaManager</a>
|
|
<span>
|
|
: <a href="classes/Doctrine-DBAL-Schema-AbstractSchemaManager.html"><abbr title="\Doctrine\DBAL\Schema\AbstractSchemaManager">AbstractSchemaManager</abbr></a> </span>
|
|
</dt>
|
|
|
|
</dl>
|
|
|
|
<h4 id="toc-methods">
|
|
Methods
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method___construct">__construct()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Initializes a new SchemaTool instance that uses the connection of the
|
|
provided EntityManager.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_createSchema">createSchema()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Creates the database schema for the given array of ClassMetadata instances.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_dropDatabase">dropDatabase()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Drops all elements in the database of the current connection.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_dropSchema">dropSchema()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Drops the database schema for the given classes.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_getCreateSchemaSql">getCreateSchemaSql()</a>
|
|
<span>
|
|
: array<int, string> </span>
|
|
</dt>
|
|
<dd>Gets the list of DDL statements that are required to create the database schema for
|
|
the given list of ClassMetadata instances.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_getDropDatabaseSQL">getDropDatabaseSQL()</a>
|
|
<span>
|
|
: array<int, string> </span>
|
|
</dt>
|
|
<dd>Gets the SQL needed to drop the database schema for the connections database.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_getDropSchemaSQL">getDropSchemaSQL()</a>
|
|
<span>
|
|
: array<int, string> </span>
|
|
</dt>
|
|
<dd>Gets SQL to drop the tables defined by the passed classes.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_getSchemaFromMetadata">getSchemaFromMetadata()</a>
|
|
<span>
|
|
: <a href="classes/Doctrine-DBAL-Schema-Schema.html"><abbr title="\Doctrine\DBAL\Schema\Schema">Schema</abbr></a> </span>
|
|
</dt>
|
|
<dd>Creates a Schema instance from a given set of metadata classes.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_getUpdateSchemaSql">getUpdateSchemaSql()</a>
|
|
<span>
|
|
: array<int, string> </span>
|
|
</dt>
|
|
<dd>Gets the sequence of SQL statements that need to be performed in order
|
|
to bring the given class mappings in-synch with the relational schema.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_updateSchema">updateSchema()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Updates the database schema of the given classes by comparing the ClassMetadata
|
|
instances to the current database schema that is inspected.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_addDiscriminatorColumnDefinition">addDiscriminatorColumnDefinition()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Gets a portable column definition as required by the DBAL for the discriminator
|
|
column of a class.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_createSchemaForComparison">createSchemaForComparison()</a>
|
|
<span>
|
|
: <a href="classes/Doctrine-DBAL-Schema-Schema.html"><abbr title="\Doctrine\DBAL\Schema\Schema">Schema</abbr></a> </span>
|
|
</dt>
|
|
<dd>Creates the schema from the database, ensuring tables from the target schema are whitelisted for comparison.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_gatherColumn">gatherColumn()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Creates a column definition as required by the DBAL from an ORM field mapping definition.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_gatherColumnOptions">gatherColumnOptions()</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_gatherColumns">gatherColumns()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Gathers the column definitions as required by the DBAL of all field mappings
|
|
found in the given class.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_gatherRelationJoinColumns">gatherRelationJoinColumns()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Gathers columns and fk constraints that are required for one part of relationship.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_gatherRelationsSql">gatherRelationsSql()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Gathers the SQL for properly setting up the relations of the given class.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_getDefiningClass">getDefiningClass()</a>
|
|
<span>
|
|
: array<string|int, mixed>|null </span>
|
|
</dt>
|
|
<dd>Gets the class metadata that is responsible for the definition of the referenced column name.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_getIndexColumns">getIndexColumns()</a>
|
|
<span>
|
|
: array<int, string> </span>
|
|
</dt>
|
|
<dd>Resolves fields in index mapping to column names</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_introspectSchema">introspectSchema()</a>
|
|
<span>
|
|
: <a href="classes/Doctrine-DBAL-Schema-Schema.html"><abbr title="\Doctrine\DBAL\Schema\Schema">Schema</abbr></a> </span>
|
|
</dt>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_processingNotRequired">processingNotRequired()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Detects instances of ClassMetadata that don't need to be processed in the SchemaTool context.</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-constants">
|
|
<h3 class="phpdocumentor-elements__header" id="constants">
|
|
Constants
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h3>
|
|
<article class="phpdocumentor-element -constant -private ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_KNOWN_COLUMN_OPTIONS">
|
|
KNOWN_COLUMN_OPTIONS
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#constant_KNOWN_COLUMN_OPTIONS" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-tools-schematool.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php">SchemaTool.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">57</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">KNOWN_COLUMN_OPTIONS</span>
|
|
= <span class="phpdocumentor-signature__default-value">['comment', 'unsigned', 'fixed', 'default']</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
</section>
|
|
|
|
|
|
<section class="phpdocumentor-properties">
|
|
<h3 class="phpdocumentor-elements__header" id="properties">
|
|
Properties
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h3>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_em">
|
|
$em
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#property_em" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-tools-schematool.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php">SchemaTool.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">60</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__type"><a href="classes/Doctrine-ORM-EntityManagerInterface.html"><abbr title="\Doctrine\ORM\EntityManagerInterface">EntityManagerInterface</abbr></a></span>
|
|
<span class="phpdocumentor-signature__name">$em</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_platform">
|
|
$platform
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#property_platform" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-tools-schematool.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php">SchemaTool.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">63</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__type"><a href="classes/Doctrine-DBAL-Platforms-AbstractPlatform.html"><abbr title="\Doctrine\DBAL\Platforms\AbstractPlatform">AbstractPlatform</abbr></a></span>
|
|
<span class="phpdocumentor-signature__name">$platform</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_quoteStrategy">
|
|
$quoteStrategy
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#property_quoteStrategy" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-tools-schematool.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php">SchemaTool.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">70</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">The quote strategy.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__type"><a href="classes/Doctrine-ORM-Mapping-QuoteStrategy.html"><abbr title="\Doctrine\ORM\Mapping\QuoteStrategy">QuoteStrategy</abbr></a></span>
|
|
<span class="phpdocumentor-signature__name">$quoteStrategy</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_schemaManager">
|
|
$schemaManager
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#property_schemaManager" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-tools-schematool.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php">SchemaTool.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">73</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__type"><a href="classes/Doctrine-DBAL-Schema-AbstractSchemaManager.html"><abbr title="\Doctrine\DBAL\Schema\AbstractSchemaManager">AbstractSchemaManager</abbr></a></span>
|
|
<span class="phpdocumentor-signature__name">$schemaManager</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-methods">
|
|
<h3 class="phpdocumentor-elements__header" id="methods">
|
|
Methods
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h3>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method___construct">
|
|
__construct()
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-tools-schematool.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php">SchemaTool.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">79</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Initializes a new SchemaTool instance that uses the connection of the
|
|
provided EntityManager.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-EntityManagerInterface.html"><abbr title="\Doctrine\ORM\EntityManagerInterface">EntityManagerInterface</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$em</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$em</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-EntityManagerInterface.html"><abbr title="\Doctrine\ORM\EntityManagerInterface">EntityManagerInterface</abbr></a></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_createSchema">
|
|
createSchema()
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_createSchema" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-tools-schematool.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php">SchemaTool.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">98</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Creates the database schema for the given array of ClassMetadata instances.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">createSchema</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$classes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$classes</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_createSchema#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">psalm-param</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>list<ClassMetadata> $classes</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">throws</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/Doctrine-ORM-Tools-ToolsException.html"><abbr title="\Doctrine\ORM\Tools\ToolsException">ToolsException</abbr></a></span>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_dropDatabase">
|
|
dropDatabase()
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_dropDatabase" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-tools-schematool.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php">SchemaTool.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">852</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Drops all elements in the database of the current connection.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">dropDatabase</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_dropSchema">
|
|
dropSchema()
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_dropSchema" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-tools-schematool.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php">SchemaTool.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">833</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Drops the database schema for the given classes.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">dropSchema</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$classes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
<section class="phpdocumentor-description"><p>In any way when an exception is thrown it is suppressed since drop was
|
|
issued for all classes of the schema and some probably just don't exist.</p>
|
|
</section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$classes</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_dropSchema#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">psalm-param</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>list<ClassMetadata> $classes</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getCreateSchemaSql">
|
|
getCreateSchemaSql()
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_getCreateSchemaSql" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-tools-schematool.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php">SchemaTool.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">120</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Gets the list of DDL statements that are required to create the database schema for
|
|
the given list of ClassMetadata instances.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">getCreateSchemaSql</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$classes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<int, string></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$classes</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_getCreateSchemaSql#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">psalm-param</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>list<ClassMetadata> $classes</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<int, string></span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>The SQL statements needed to create the schema for the classes.</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getDropDatabaseSQL">
|
|
getDropDatabaseSQL()
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_getDropDatabaseSQL" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-tools-schematool.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php">SchemaTool.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">867</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Gets the SQL needed to drop the database schema for the connections database.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">getDropDatabaseSQL</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<int, string></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<int, string></span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getDropSchemaSQL">
|
|
getDropSchemaSQL()
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_getDropSchemaSQL" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-tools-schematool.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php">SchemaTool.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">885</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Gets SQL to drop the tables defined by the passed classes.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">getDropSchemaSQL</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$classes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<int, string></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$classes</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_getDropSchemaSQL#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">psalm-param</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>list<ClassMetadata> $classes</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<int, string></span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getSchemaFromMetadata">
|
|
getSchemaFromMetadata()
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_getSchemaFromMetadata" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-tools-schematool.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php">SchemaTool.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">195</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Creates a Schema instance from a given set of metadata classes.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">getSchemaFromMetadata</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$classes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/Doctrine-DBAL-Schema-Schema.html"><abbr title="\Doctrine\DBAL\Schema\Schema">Schema</abbr></a></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$classes</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_getSchemaFromMetadata#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">psalm-param</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>list<ClassMetadata> $classes</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">throws</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/Doctrine-ORM-Tools-Exception-NotSupported.html"><abbr title="\Doctrine\ORM\Tools\Exception\NotSupported">NotSupported</abbr></a></span>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type"><a href="classes/Doctrine-DBAL-Schema-Schema.html"><abbr title="\Doctrine\DBAL\Schema\Schema">Schema</abbr></a></span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getUpdateSchemaSql">
|
|
getUpdateSchemaSql()
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_getUpdateSchemaSql" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-tools-schematool.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php">SchemaTool.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">962</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Gets the sequence of SQL statements that need to be performed in order
|
|
to bring the given class mappings in-synch with the relational schema.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">getUpdateSchemaSql</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<int, <a href="classes/Doctrine-ORM-Mapping-ClassMetadata.html"><abbr title="\Doctrine\ORM\Mapping\ClassMetadata">ClassMetadata</abbr></a>> </span><span class="phpdocumentor-signature__argument__name">$classes</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$saveMode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<int, string></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$classes</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<int, <a href="classes/Doctrine-ORM-Mapping-ClassMetadata.html"><abbr title="\Doctrine\ORM\Mapping\ClassMetadata">ClassMetadata</abbr></a>></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>The classes to consider.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$saveMode</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">false</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>If TRUE, only generates SQL for a partial update
|
|
that does not include SQL for dropping assets which are scheduled for deletion.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<int, string></span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>The sequence of SQL statements.</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_updateSchema">
|
|
updateSchema()
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_updateSchema" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-tools-schematool.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php">SchemaTool.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">933</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Updates the database schema of the given classes by comparing the ClassMetadata
|
|
instances to the current database schema that is inspected.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">updateSchema</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$classes</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$saveMode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$classes</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$saveMode</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">false</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>If TRUE, only performs a partial update
|
|
without dropping assets which are scheduled for deletion.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addDiscriminatorColumnDefinition">
|
|
addDiscriminatorColumnDefinition()
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_addDiscriminatorColumnDefinition" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-tools-schematool.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php">SchemaTool.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">427</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Gets a portable column definition as required by the DBAL for the discriminator
|
|
column of a class.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">addDiscriminatorColumnDefinition</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Mapping-ClassMetadata.html"><abbr title="\Doctrine\ORM\Mapping\ClassMetadata">ClassMetadata</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$class</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-DBAL-Schema-Table.html"><abbr title="\Doctrine\DBAL\Schema\Table">Table</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$table</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$class</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Mapping-ClassMetadata.html"><abbr title="\Doctrine\ORM\Mapping\ClassMetadata">ClassMetadata</abbr></a></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$table</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-DBAL-Schema-Table.html"><abbr title="\Doctrine\DBAL\Schema\Table">Table</abbr></a></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_createSchemaForComparison">
|
|
createSchemaForComparison()
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_createSchemaForComparison" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-tools-schematool.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php">SchemaTool.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">998</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Creates the schema from the database, ensuring tables from the target schema are whitelisted for comparison.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">createSchemaForComparison</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-DBAL-Schema-Schema.html"><abbr title="\Doctrine\DBAL\Schema\Schema">Schema</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$toSchema</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/Doctrine-DBAL-Schema-Schema.html"><abbr title="\Doctrine\DBAL\Schema\Schema">Schema</abbr></a></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$toSchema</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-DBAL-Schema-Schema.html"><abbr title="\Doctrine\DBAL\Schema\Schema">Schema</abbr></a></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type"><a href="classes/Doctrine-DBAL-Schema-Schema.html"><abbr title="\Doctrine\DBAL\Schema\Schema">Schema</abbr></a></span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_gatherColumn">
|
|
gatherColumn()
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_gatherColumn" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-tools-schematool.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php">SchemaTool.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">479</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Creates a column definition as required by the DBAL from an ORM field mapping definition.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">gatherColumn</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Mapping-ClassMetadata.html"><abbr title="\Doctrine\ORM\Mapping\ClassMetadata">ClassMetadata</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$class</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$mapping</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-DBAL-Schema-Table.html"><abbr title="\Doctrine\DBAL\Schema\Table">Table</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$table</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$class</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Mapping-ClassMetadata.html"><abbr title="\Doctrine\ORM\Mapping\ClassMetadata">ClassMetadata</abbr></a></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>The class that owns the field mapping.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$mapping</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$table</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-DBAL-Schema-Table.html"><abbr title="\Doctrine\DBAL\Schema\Table">Table</abbr></a></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_gatherColumn#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">psalm-param</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>FieldMapping $mapping The field mapping.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_gatherColumnOptions">
|
|
gatherColumnOptions()
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_gatherColumnOptions" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-tools-schematool.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php">SchemaTool.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">801</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">gatherColumnOptions</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$mapping</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$mapping</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_gatherColumnOptions#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">psalm-param</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>JoinColumnData|FieldMapping|DiscriminatorColumnMapping $mapping</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_gatherColumns">
|
|
gatherColumns()
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_gatherColumns" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-tools-schematool.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php">SchemaTool.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">456</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Gathers the column definitions as required by the DBAL of all field mappings
|
|
found in the given class.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">gatherColumns</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Mapping-ClassMetadata.html"><abbr title="\Doctrine\ORM\Mapping\ClassMetadata">ClassMetadata</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$class</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-DBAL-Schema-Table.html"><abbr title="\Doctrine\DBAL\Schema\Table">Table</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$table</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$class</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Mapping-ClassMetadata.html"><abbr title="\Doctrine\ORM\Mapping\ClassMetadata">ClassMetadata</abbr></a></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$table</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-DBAL-Schema-Table.html"><abbr title="\Doctrine\DBAL\Schema\Table">Table</abbr></a></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_gatherRelationJoinColumns">
|
|
gatherRelationJoinColumns()
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_gatherRelationJoinColumns" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-tools-schematool.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php">SchemaTool.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">677</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Gathers columns and fk constraints that are required for one part of relationship.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">gatherRelationJoinColumns</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$joinColumns</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-DBAL-Schema-Table.html"><abbr title="\Doctrine\DBAL\Schema\Table">Table</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$theJoinTable</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Mapping-ClassMetadata.html"><abbr title="\Doctrine\ORM\Mapping\ClassMetadata">ClassMetadata</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$class</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$mapping</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$primaryKeyColumns</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$addedFks</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$blacklistedFks</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$joinColumns</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$theJoinTable</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-DBAL-Schema-Table.html"><abbr title="\Doctrine\DBAL\Schema\Table">Table</abbr></a></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$class</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Mapping-ClassMetadata.html"><abbr title="\Doctrine\ORM\Mapping\ClassMetadata">ClassMetadata</abbr></a></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$mapping</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$primaryKeyColumns</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$addedFks</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$blacklistedFks</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_gatherRelationJoinColumns#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">psalm-param</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>array<string, JoinColumnData> $joinColumns</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">psalm-param</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>AssociationMapping $mapping</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">psalm-param</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>list<string> $primaryKeyColumns</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">psalm-param</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>array<string, array{
|
|
foreignTableName: string,
|
|
foreignColumns: list<string>
|
|
}> $addedFks</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">psalm-param</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>array<string,bool> $blacklistedFks</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">throws</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/Doctrine-ORM-Tools-Exception-MissingColumnException.html"><abbr title="\Doctrine\ORM\Tools\Exception\MissingColumnException">MissingColumnException</abbr></a></span>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_gatherRelationsSql">
|
|
gatherRelationsSql()
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_gatherRelationsSql" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-tools-schematool.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php">SchemaTool.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">554</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Gathers the SQL for properly setting up the relations of the given class.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">gatherRelationsSql</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Mapping-ClassMetadata.html"><abbr title="\Doctrine\ORM\Mapping\ClassMetadata">ClassMetadata</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$class</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-DBAL-Schema-Table.html"><abbr title="\Doctrine\DBAL\Schema\Table">Table</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$table</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-DBAL-Schema-Schema.html"><abbr title="\Doctrine\DBAL\Schema\Schema">Schema</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$schema</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$addedFks</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$blacklistedFks</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
<section class="phpdocumentor-description"><p>This includes the SQL for foreign key constraints and join tables.</p>
|
|
</section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$class</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Mapping-ClassMetadata.html"><abbr title="\Doctrine\ORM\Mapping\ClassMetadata">ClassMetadata</abbr></a></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$table</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-DBAL-Schema-Table.html"><abbr title="\Doctrine\DBAL\Schema\Table">Table</abbr></a></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$schema</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-DBAL-Schema-Schema.html"><abbr title="\Doctrine\DBAL\Schema\Schema">Schema</abbr></a></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$addedFks</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$blacklistedFks</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_gatherRelationsSql#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">psalm-param</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>array<string, array{
|
|
foreignTableName: string,
|
|
foreignColumns: list<string>
|
|
}> $addedFks</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">psalm-param</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>array<string, bool> $blacklistedFks</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">throws</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/Doctrine-ORM-Tools-Exception-NotSupported.html"><abbr title="\Doctrine\ORM\Tools\Exception\NotSupported">NotSupported</abbr></a></span>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getDefiningClass">
|
|
getDefiningClass()
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_getDefiningClass" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-tools-schematool.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php">SchemaTool.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">637</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Gets the class metadata that is responsible for the definition of the referenced column name.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">getDefiningClass</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Mapping-ClassMetadata.html"><abbr title="\Doctrine\ORM\Mapping\ClassMetadata">ClassMetadata</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$class</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$referencedColumnName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed>|null</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
<section class="phpdocumentor-description"><p>Previously this was a simple task, but with DDC-117 this problem is actually recursive. If its
|
|
not a simple field, go through all identifier field names that are associations recursively and
|
|
find that referenced column name.</p>
|
|
<p>TODO: Is there any way to make this code more pleasing?</p>
|
|
</section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$class</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Mapping-ClassMetadata.html"><abbr title="\Doctrine\ORM\Mapping\ClassMetadata">ClassMetadata</abbr></a></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$referencedColumnName</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_getDefiningClass#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">psalm-return</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>array{ClassMetadata, string}|null</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed>|null</span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getIndexColumns">
|
|
getIndexColumns()
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_getIndexColumns" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-tools-schematool.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php">SchemaTool.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">150</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Resolves fields in index mapping to column names</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">getIndexColumns</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Mapping-ClassMetadata.html"><abbr title="\Doctrine\ORM\Mapping\ClassMetadata">ClassMetadata</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$class</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$indexData</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<int, string></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$class</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Mapping-ClassMetadata.html"><abbr title="\Doctrine\ORM\Mapping\ClassMetadata">ClassMetadata</abbr></a></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$indexData</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>index or unique constraint data</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<int, string></span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Column names from combined fields and columns mappings</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_introspectSchema">
|
|
introspectSchema()
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_introspectSchema" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-tools-schematool.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php">SchemaTool.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">1025</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">introspectSchema</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/Doctrine-DBAL-Schema-Schema.html"><abbr title="\Doctrine\DBAL\Schema\Schema">Schema</abbr></a></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type"><a href="classes/Doctrine-DBAL-Schema-Schema.html"><abbr title="\Doctrine\DBAL\Schema\Schema">Schema</abbr></a></span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_processingNotRequired">
|
|
processingNotRequired()
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_processingNotRequired" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-tools-schematool.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php">SchemaTool.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">132</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Detects instances of ClassMetadata that don't need to be processed in the SchemaTool context.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">processingNotRequired</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Mapping-ClassMetadata.html"><abbr title="\Doctrine\ORM\Mapping\ClassMetadata">ClassMetadata</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$class</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$processedClasses</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$class</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Mapping-ClassMetadata.html"><abbr title="\Doctrine\ORM\Mapping\ClassMetadata">ClassMetadata</abbr></a></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$processedClasses</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_processingNotRequired#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">psalm-param</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>array<string, bool> $processedClasses</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
</section>
|
|
|
|
</article>
|
|
</section>
|
|
|
|
<div class="phpdocumentor-modal" id="source-view">
|
|
<div class="phpdocumentor-modal-bg" data-exit-button></div>
|
|
<div class="phpdocumentor-modal-container">
|
|
<div class="phpdocumentor-modal-content">
|
|
<pre style="max-height: 500px; overflow-y: scroll" data-src="files/vendor/doctrine/orm/lib/Doctrine/ORM/Tools/SchemaTool.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
|
|
</div>
|
|
<button data-exit-button class="phpdocumentor-modal__close">×</button>
|
|
</div>
|
|
</div>
|
|
|
|
<script type="text/javascript">
|
|
(function () {
|
|
function loadExternalCodeSnippet(el, url, line) {
|
|
Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
|
|
const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
|
|
const language = 'php';
|
|
|
|
const code = document.createElement('code');
|
|
code.className = 'language-' + language;
|
|
pre.textContent = '';
|
|
pre.setAttribute('data-line', line)
|
|
code.textContent = 'Loading…';
|
|
pre.appendChild(code);
|
|
|
|
var xhr = new XMLHttpRequest();
|
|
|
|
xhr.open('GET', src, true);
|
|
|
|
xhr.onreadystatechange = function () {
|
|
if (xhr.readyState !== 4) {
|
|
return;
|
|
}
|
|
|
|
if (xhr.status < 400 && xhr.responseText) {
|
|
code.textContent = xhr.responseText;
|
|
Prism.highlightElement(code);
|
|
return;
|
|
}
|
|
|
|
if (xhr.status === 404) {
|
|
code.textContent = '✖ Error: File could not be found';
|
|
return;
|
|
}
|
|
|
|
if (xhr.status >= 400) {
|
|
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
|
|
return;
|
|
}
|
|
|
|
code.textContent = '✖ Error: An unknown error occurred';
|
|
};
|
|
|
|
xhr.send(null);
|
|
});
|
|
}
|
|
|
|
const modalButtons = document.querySelectorAll("[data-modal]");
|
|
const openedAsLocalFile = window.location.protocol === 'file:';
|
|
if (modalButtons.length > 0 && openedAsLocalFile) {
|
|
console.warn(
|
|
'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
|
|
'browsers block XHR requests when a page is opened this way'
|
|
);
|
|
}
|
|
|
|
modalButtons.forEach(function (trigger) {
|
|
if (openedAsLocalFile) {
|
|
trigger.setAttribute("hidden", "hidden");
|
|
}
|
|
|
|
trigger.addEventListener("click", function (event) {
|
|
event.preventDefault();
|
|
const modal = document.getElementById(trigger.dataset.modal);
|
|
if (!modal) {
|
|
console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
|
|
return;
|
|
}
|
|
modal.classList.add("phpdocumentor-modal__open");
|
|
|
|
loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
|
|
const exits = modal.querySelectorAll("[data-exit-button]");
|
|
exits.forEach(function (exit) {
|
|
exit.addEventListener("click", function (event) {
|
|
event.preventDefault();
|
|
modal.classList.remove("phpdocumentor-modal__open");
|
|
});
|
|
});
|
|
});
|
|
});
|
|
})();
|
|
</script>
|
|
|
|
</article>
|
|
</section>
|
|
<section class="phpdocumentor-on-this-page__sidebar">
|
|
|
|
<section class="phpdocumentor-on-this-page__content">
|
|
<strong class="phpdocumentor-on-this-page__title">On this page</strong>
|
|
|
|
<ul class="phpdocumentor-list -clean">
|
|
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
|
|
<li>
|
|
<ul class="phpdocumentor-list -clean">
|
|
<li><a href="classes/Doctrine-ORM-Tools-SchemaTool.html#toc-constants">Constants</a></li>
|
|
<li><a href="classes/Doctrine-ORM-Tools-SchemaTool.html#toc-properties">Properties</a></li>
|
|
<li><a href="classes/Doctrine-ORM-Tools-SchemaTool.html#toc-methods">Methods</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="phpdocumentor-on-this-page-section__title">Constants</li>
|
|
<li>
|
|
<ul class="phpdocumentor-list -clean">
|
|
<li><a href="classes/Doctrine-ORM-Tools-SchemaTool.html#constant_KNOWN_COLUMN_OPTIONS">KNOWN_COLUMN_OPTIONS</a></li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="phpdocumentor-on-this-page-section__title">Properties</li>
|
|
<li>
|
|
<ul class="phpdocumentor-list -clean">
|
|
<li><a href="classes/Doctrine-ORM-Tools-SchemaTool.html#property_em">$em<a href="classes/Doctrine-ORM-Tools-SchemaTool.html"></li>
|
|
<li><a href="classes/Doctrine-ORM-Tools-SchemaTool.html#property_platform">$platform<a href="classes/Doctrine-ORM-Tools-SchemaTool.html"></li>
|
|
<li><a href="classes/Doctrine-ORM-Tools-SchemaTool.html#property_quoteStrategy">$quoteStrategy<a href="classes/Doctrine-ORM-Tools-SchemaTool.html"></li>
|
|
<li><a href="classes/Doctrine-ORM-Tools-SchemaTool.html#property_schemaManager">$schemaManager<a href="classes/Doctrine-ORM-Tools-SchemaTool.html"></li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="phpdocumentor-on-this-page-section__title">Methods</li>
|
|
<li>
|
|
<ul class="phpdocumentor-list -clean">
|
|
<li><a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method___construct">__construct()</a></li>
|
|
<li><a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_createSchema">createSchema()</a></li>
|
|
<li><a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_dropDatabase">dropDatabase()</a></li>
|
|
<li><a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_dropSchema">dropSchema()</a></li>
|
|
<li><a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_getCreateSchemaSql">getCreateSchemaSql()</a></li>
|
|
<li><a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_getDropDatabaseSQL">getDropDatabaseSQL()</a></li>
|
|
<li><a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_getDropSchemaSQL">getDropSchemaSQL()</a></li>
|
|
<li><a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_getSchemaFromMetadata">getSchemaFromMetadata()</a></li>
|
|
<li><a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_getUpdateSchemaSql">getUpdateSchemaSql()</a></li>
|
|
<li><a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_updateSchema">updateSchema()</a></li>
|
|
<li><a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_addDiscriminatorColumnDefinition">addDiscriminatorColumnDefinition()</a></li>
|
|
<li><a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_createSchemaForComparison">createSchemaForComparison()</a></li>
|
|
<li><a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_gatherColumn">gatherColumn()</a></li>
|
|
<li><a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_gatherColumnOptions">gatherColumnOptions()</a></li>
|
|
<li><a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_gatherColumns">gatherColumns()</a></li>
|
|
<li><a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_gatherRelationJoinColumns">gatherRelationJoinColumns()</a></li>
|
|
<li><a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_gatherRelationsSql">gatherRelationsSql()</a></li>
|
|
<li><a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_getDefiningClass">getDefiningClass()</a></li>
|
|
<li><a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_getIndexColumns">getIndexColumns()</a></li>
|
|
<li><a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_introspectSchema">introspectSchema()</a></li>
|
|
<li><a href="classes/Doctrine-ORM-Tools-SchemaTool.html#method_processingNotRequired">processingNotRequired()</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
|
|
</section>
|
|
</div>
|
|
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
|
|
<section class="phpdocumentor-search-results__dialog">
|
|
<header class="phpdocumentor-search-results__header">
|
|
<h2 class="phpdocumentor-search-results__title">Search results</h2>
|
|
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
|
|
</header>
|
|
<section class="phpdocumentor-search-results__body">
|
|
<ul class="phpdocumentor-search-results__entries"></ul>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<a href="classes/Doctrine-ORM-Tools-SchemaTool.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
|
|
|
|
</main>
|
|
|
|
<script>
|
|
cssVars({});
|
|
</script>
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
|
|
</body>
|
|
</html>
|