caisse-bliss/v1/.phpdoc/build/classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html
2025-02-09 16:45:35 +01:00

4353 lines
224 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-query.html">Query</a></li>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
ResultSetMappingBuilder
<span class="phpdocumentor-element__extends">
extends <a href="classes/Doctrine-ORM-Query-ResultSetMapping.html"><abbr title="\Doctrine\ORM\Query\ResultSetMapping">ResultSetMapping</abbr></a>
</span>
<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>
<span class="phpdocumentor-element__extends">
Uses
<abbr title="\Doctrine\ORM\Internal\SQLResultCasing">SQLResultCasing</abbr> </span>
</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/Query/ResultSetMappingBuilder.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmappingbuilder.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMappingBuilder.php">ResultSetMappingBuilder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">A ResultSetMappingBuilder uses the EntityManager to automatically populate entity fields.</p>
<h3 id="toc">
Table of Contents
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<h4 id="toc-constants">
Constants
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.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 -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#constant_COLUMN_RENAMING_CUSTOM">COLUMN_RENAMING_CUSTOM</a>
<span>
&nbsp;= 2 </span>
</dt>
<dd>Picking custom renaming allows the user to define the renaming
of specific columns with a rename array that contains column names as
keys and result alias as values.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#constant_COLUMN_RENAMING_INCREMENT">COLUMN_RENAMING_INCREMENT</a>
<span>
&nbsp;= 3 </span>
</dt>
<dd>Incremental renaming uses a result set mapping internal counter to add a
number to each column result, leading to uniqueness. This only works if
you use {@see generateSelectClause()} to generate the SELECT clause for
you.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#constant_COLUMN_RENAMING_NONE">COLUMN_RENAMING_NONE</a>
<span>
&nbsp;= 1 </span>
</dt>
<dd>Picking this rename mode will register entity columns as is,
as they are in the database. This can cause clashes when multiple
entities are fetched that have columns with the same name.</dd>
</dl>
<h4 id="toc-properties">
Properties
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.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 -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#property_discriminatorParameters">$discriminatorParameters</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Contains query parameter names to be resolved as discriminator values</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#property_isIdentifierColumn">$isIdentifierColumn</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>This is necessary to hydrate derivate foreign keys correctly.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#property_metadataParameterMapping">$metadataParameterMapping</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Maps metadata parameter names to the metadata attribute.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#property_newObjectMappings">$newObjectMappings</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Maps column names in the result set to field names for each new object expression.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#property_defaultRenameMode">$defaultRenameMode</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Default column renaming mode.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#property_em">$em</a>
<span>
&nbsp;: <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-Query-ResultSetMappingBuilder.html#property_sqlCounter">$sqlCounter</a>
<span>
&nbsp;: int </span>
</dt>
</dl>
<h4 id="toc-methods">
Methods
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.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-Query-ResultSetMappingBuilder.html#method___construct">__construct()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method___toString">__toString()</a>
<span>
&nbsp;: string </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addEntityResult">addEntityResult()</a>
<span>
&nbsp;: $this </span>
</dt>
<dd>Adds an entity result to this ResultSetMapping.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addEnumResult">addEnumResult()</a>
<span>
&nbsp;: $this </span>
</dt>
<dd>Adds a scalar result mapping.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addFieldResult">addFieldResult()</a>
<span>
&nbsp;: $this </span>
</dt>
<dd>Adds a field to the result that belongs to an entity or joined entity.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addIndexBy">addIndexBy()</a>
<span>
&nbsp;: $this </span>
</dt>
<dd>Sets a field to use for indexing an entity result or joined entity result.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addIndexByColumn">addIndexByColumn()</a>
<span>
&nbsp;: $this </span>
</dt>
<dd>Sets a column to use for indexing an entity or joined entity result by the given alias name.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addIndexByScalar">addIndexByScalar()</a>
<span>
&nbsp;: $this </span>
</dt>
<dd>Sets to index by a scalar result column name.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_addJoinedEntityFromClassMetadata">addJoinedEntityFromClassMetadata()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Adds a joined entity and all of its fields to the result set.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addJoinedEntityResult">addJoinedEntityResult()</a>
<span>
&nbsp;: $this </span>
</dt>
<dd>Adds a joined entity result.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addMetadataParameterMapping">addMetadataParameterMapping()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Adds a metadata parameter mappings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addMetaResult">addMetaResult()</a>
<span>
&nbsp;: $this </span>
</dt>
<dd>Adds a meta column (foreign key or discriminator column) to the result set.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_addNamedNativeQueryEntityResultMapping">addNamedNativeQueryEntityResultMapping()</a>
<span>
&nbsp;: $this </span>
</dt>
<dd>Adds the entity result mapping of the results of native SQL queries to the result set.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_addNamedNativeQueryMapping">addNamedNativeQueryMapping()</a>
<span>
&nbsp;: <a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html"><abbr title="\Doctrine\ORM\Query\ResultSetMappingBuilder">ResultSetMappingBuilder</abbr></a> </span>
</dt>
<dd>Adds the mappings of the results of native SQL queries to the result set.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_addNamedNativeQueryResultClassMapping">addNamedNativeQueryResultClassMapping()</a>
<span>
&nbsp;: $this </span>
</dt>
<dd>Adds the class mapping of the results of native SQL queries to the result set.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_addNamedNativeQueryResultSetMapping">addNamedNativeQueryResultSetMapping()</a>
<span>
&nbsp;: $this </span>
</dt>
<dd>Adds the result set mapping of the results of native SQL queries to the result set.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_addRootEntityFromClassMetadata">addRootEntityFromClassMetadata()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Adds a root entity and all of its fields to the result set.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addScalarResult">addScalarResult()</a>
<span>
&nbsp;: $this </span>
</dt>
<dd>Adds a scalar result mapping.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_generateSelectClause">generateSelectClause()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Generates the Select clause from this ResultSetMappingBuilder.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_getAliasMap">getAliasMap()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_getClassName">getClassName()</a>
<span>
&nbsp;: class-string </span>
</dt>
<dd>Gets the name of the class of an entity result or joined entity result,
identified by the given unique alias.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_getDeclaringClass">getDeclaringClass()</a>
<span>
&nbsp;: class-string </span>
</dt>
<dd>Gets the name of the class that owns a field mapping for the specified column.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_getEntityAlias">getEntityAlias()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Gets the alias of the class that owns a field mapping for the specified column.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_getEntityResultCount">getEntityResultCount()</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Gets the number of different entities that appear in the mapped result.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_getFieldName">getFieldName()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Gets the field name for a column name.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_getParentAlias">getParentAlias()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Gets the parent alias of the given alias.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_getRelation">getRelation()</a>
<span>
&nbsp;: string </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_getScalarAlias">getScalarAlias()</a>
<span>
&nbsp;: string|int </span>
</dt>
<dd>Gets the field alias for a column that is mapped as a scalar value.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_hasIndexBy">hasIndexBy()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Checks whether an entity result or joined entity result with a given alias has
a field set for indexing.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_hasParentAlias">hasParentAlias()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Checks whether the given alias has a parent alias.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_isFieldResult">isFieldResult()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Checks whether the column with the given name is mapped as a field result
as part of an entity result or joined entity result.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_isMixedResult">isMixedResult()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Checks whether this ResultSetMapping defines a mixed result.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_isRelation">isRelation()</a>
<span>
&nbsp;: bool </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_isScalarResult">isScalarResult()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Checks whether a column with a given name is mapped as a scalar result.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_setDiscriminatorColumn">setDiscriminatorColumn()</a>
<span>
&nbsp;: $this </span>
</dt>
<dd>Sets a discriminator column for an entity result or joined entity result.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_addAllClassFields">addAllClassFields()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Adds all fields of the given class to the result set mapping (columns and meta fields).</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_getColumnAlias">getColumnAlias()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Gets column alias for a given column.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_getColumnAliasMap">getColumnAliasMap()</a>
<span>
&nbsp;: array&lt;string|int, string&gt; </span>
</dt>
<dd>Retrieves a class columns and join columns aliases that are used in the SELECT clause.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_isInheritanceSupported">isInheritanceSupported()</a>
<span>
&nbsp;: bool </span>
</dt>
</dl>
<section class="phpdocumentor-constants">
<h3 class="phpdocumentor-elements__header" id="constants">
Constants
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_COLUMN_RENAMING_CUSTOM">
COLUMN_RENAMING_CUSTOM
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#constant_COLUMN_RENAMING_CUSTOM" 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/Query/ResultSetMappingBuilder.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmappingbuilder.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMappingBuilder.php">ResultSetMappingBuilder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">43</span>
</aside>
<p class="phpdocumentor-summary">Picking custom renaming allows the user to define the renaming
of specific columns with a rename array that contains column names as
keys and result alias as values.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">COLUMN_RENAMING_CUSTOM</span>
= <span class="phpdocumentor-signature__default-value">2</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_COLUMN_RENAMING_INCREMENT">
COLUMN_RENAMING_INCREMENT
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#constant_COLUMN_RENAMING_INCREMENT" 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/Query/ResultSetMappingBuilder.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmappingbuilder.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMappingBuilder.php">ResultSetMappingBuilder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">51</span>
</aside>
<p class="phpdocumentor-summary">Incremental renaming uses a result set mapping internal counter to add a
number to each column result, leading to uniqueness. This only works if
you use {@see generateSelectClause()} to generate the SELECT clause for
you.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">COLUMN_RENAMING_INCREMENT</span>
= <span class="phpdocumentor-signature__default-value">3</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_COLUMN_RENAMING_NONE">
COLUMN_RENAMING_NONE
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#constant_COLUMN_RENAMING_NONE" 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/Query/ResultSetMappingBuilder.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmappingbuilder.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMappingBuilder.php">ResultSetMappingBuilder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">36</span>
</aside>
<p class="phpdocumentor-summary">Picking this rename mode will register entity columns as is,
as they are in the database. This can cause clashes when multiple
entities are fetched that have columns with the same name.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">COLUMN_RENAMING_NONE</span>
= <span class="phpdocumentor-signature__default-value">1</span>
</code>
</article>
</section>
<section class="phpdocumentor-properties">
<h3 class="phpdocumentor-elements__header" id="properties">
Properties
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_discriminatorParameters">
$discriminatorParameters
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#property_discriminatorParameters" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">170</span>
</aside>
<p class="phpdocumentor-summary">Contains query parameter names to be resolved as discriminator values</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">$discriminatorParameters</span>
= <span class="phpdocumentor-signature__default-value">[]</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#property_discriminatorParameters#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-var</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>array&lt;string, string&gt;</p>
</section>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_isIdentifierColumn">
$isIdentifierColumn
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#property_isIdentifierColumn" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">149</span>
</aside>
<p class="phpdocumentor-summary">This is necessary to hydrate derivate foreign keys correctly.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">$isIdentifierColumn</span>
= <span class="phpdocumentor-signature__default-value">[]</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#property_isIdentifierColumn#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-var</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>array&lt;string, array&lt;string, bool&gt;&gt;</p>
</section>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_metadataParameterMapping">
$metadataParameterMapping
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#property_metadataParameterMapping" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">163</span>
</aside>
<p class="phpdocumentor-summary">Maps metadata parameter names to the metadata attribute.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">$metadataParameterMapping</span>
= <span class="phpdocumentor-signature__default-value">[]</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#property_metadataParameterMapping#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-var</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>array&lt;int|string, string&gt;</p>
</section>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_newObjectMappings">
$newObjectMappings
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#property_newObjectMappings" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">156</span>
</aside>
<p class="phpdocumentor-summary">Maps column names in the result set to field names for each new object expression.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">$newObjectMappings</span>
= <span class="phpdocumentor-signature__default-value">[]</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#property_newObjectMappings#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-var</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>array&lt;string, array&lt;string, mixed&gt;&gt;</p>
</section>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_defaultRenameMode">
$defaultRenameMode
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#property_defaultRenameMode" 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/Query/ResultSetMappingBuilder.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmappingbuilder.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMappingBuilder.php">ResultSetMappingBuilder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">65</span>
</aside>
<p class="phpdocumentor-summary">Default column renaming mode.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">$defaultRenameMode</span>
</code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#property_defaultRenameMode#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-var</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>self::COLUMN_RENAMING_*</p>
</section>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_em">
$em
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.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/Query/ResultSetMappingBuilder.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmappingbuilder.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMappingBuilder.php">ResultSetMappingBuilder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">57</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_sqlCounter">
$sqlCounter
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#property_sqlCounter" 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/Query/ResultSetMappingBuilder.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmappingbuilder.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMappingBuilder.php">ResultSetMappingBuilder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">54</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">$sqlCounter</span>
= <span class="phpdocumentor-signature__default-value">0</span></code>
</article>
</section>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.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-Query-ResultSetMappingBuilder.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/Query/ResultSetMappingBuilder.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmappingbuilder.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMappingBuilder.php">ResultSetMappingBuilder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">71</span>
</aside>
<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>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$em</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$defaultRenameMode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">self::COLUMN_RENAMING_NONE</span><span> ]</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>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$defaultRenameMode</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">self::COLUMN_RENAMING_NONE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method___construct#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>self::COLUMN_RENAMING_* $defaultRenameMode</p>
</section>
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method___toString">
__toString()
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method___toString" 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/Query/ResultSetMappingBuilder.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmappingbuilder.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMappingBuilder.php">ResultSetMappingBuilder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">491</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">__toString</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">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">string</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_addEntityResult">
addEntityResult()
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addEntityResult" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">186</span>
</aside>
<p class="phpdocumentor-summary">Adds an entity result to this ResultSetMapping.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addEntityResult</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</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&nbsp;</span><span class="phpdocumentor-signature__argument__name">$alias</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$resultAlias</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">$this</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">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The class name of the entity.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$alias</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The alias for the class. The alias must be unique among all entity
results or joined entity results within this ResultSetMapping.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$resultAlias</span>
: <span class="phpdocumentor-signature__argument__return-type">string|null</span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The result alias with which the entity result should be
placed in the result structure.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addEntityResult#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>class-string $class</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Rename: addRootEntity</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">$this</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_addEnumResult">
addEnumResult()
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addEnumResult" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">403</span>
</aside>
<p class="phpdocumentor-summary">Adds a scalar result mapping.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addEnumResult</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$columnName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$enumType</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">$this</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">$columnName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The name of the column in the SQL result set.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$enumType</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The enum type</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">$this</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_addFieldResult">
addFieldResult()
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addFieldResult" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">333</span>
</aside>
<p class="phpdocumentor-summary">Adds a field to the result that belongs to an entity or joined entity.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addFieldResult</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$alias</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$columnName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$fieldName</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$declaringClass</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">$this</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">$alias</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The alias of the root entity or joined entity to which the field belongs.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$columnName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The name of the column in the SQL result set.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The name of the field on the declaring class.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$declaringClass</span>
: <span class="phpdocumentor-signature__argument__return-type">string|null</span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The name of the class that declares/owns the specified field.
When $alias refers to a superclass in a mapped hierarchy but
the field $fieldName is defined on a subclass, specify that here.
If not specified, the field is assumed to belong to the class
designated by $alias.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addFieldResult#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>class-string|null $declaringClass</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Rename: addField</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">$this</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_addIndexBy">
addIndexBy()
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addIndexBy" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">227</span>
</aside>
<p class="phpdocumentor-summary">Sets a field to use for indexing an entity result or joined entity result.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addIndexBy</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$alias</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$fieldName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">$this</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">$alias</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The alias of an entity result or joined entity result.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The name of the field to use for indexing.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">$this</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_addIndexByColumn">
addIndexByColumn()
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addIndexByColumn" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">279</span>
</aside>
<p class="phpdocumentor-summary">Sets a column to use for indexing an entity or joined entity result by the given alias name.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addIndexByColumn</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$alias</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$resultColumnName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">$this</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">$alias</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$resultColumnName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</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">$this</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_addIndexByScalar">
addIndexByScalar()
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addIndexByScalar" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">264</span>
</aside>
<p class="phpdocumentor-summary">Sets to index by a scalar result column name.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addIndexByScalar</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$resultColumnName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">$this</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">$resultColumnName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</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">$this</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_addJoinedEntityFromClassMetadata">
addJoinedEntityFromClassMetadata()
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_addJoinedEntityFromClassMetadata" 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/Query/ResultSetMappingBuilder.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmappingbuilder.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMappingBuilder.php">ResultSetMappingBuilder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">Adds a joined entity and all of its fields to the result set.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addJoinedEntityFromClassMetadata</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</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&nbsp;</span><span class="phpdocumentor-signature__argument__name">$alias</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$parentAlias</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$relation</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, string&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$renamedColumns</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$renameMode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</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">$class</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The class name of the joined entity.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$alias</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The unique alias to use for the joined entity.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentAlias</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The alias of the entity result that is the parent of this joined result.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$relation</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The association field that connects the parent entity result
with the joined entity result.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$renamedColumns</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, string&gt;</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Columns that have been renamed (tableColumnName =&gt; queryColumnName).</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$renameMode</span>
: <span class="phpdocumentor-signature__argument__return-type">int|null</span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>One of the COLUMN_RENAMING_* constants or array for BC reasons (CUSTOM).</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_addJoinedEntityFromClassMetadata#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>class-string $class</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&lt;string, string&gt; $renamedColumns</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>self::COLUMN_RENAMING_*|null $renameMode</p>
</section>
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_addJoinedEntityResult">
addJoinedEntityResult()
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addJoinedEntityResult" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">363</span>
</aside>
<p class="phpdocumentor-summary">Adds a joined entity result.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addJoinedEntityResult</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</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&nbsp;</span><span class="phpdocumentor-signature__argument__name">$alias</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$parentAlias</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$relation</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">$this</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">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The class name of the joined entity.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$alias</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The unique alias to use for the joined entity.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentAlias</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The alias of the entity result that is the parent of this joined result.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$relation</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The association field that connects the parent entity result
with the joined entity result.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addJoinedEntityResult#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>class-string $class</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Rename: addJoinedEntity</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">$this</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_addMetadataParameterMapping">
addMetadataParameterMapping()
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addMetadataParameterMapping" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">418</span>
</aside>
<p class="phpdocumentor-summary">Adds a metadata parameter mappings.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addMetadataParameterMapping</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string|int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$parameter</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$attribute</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">$parameter</span>
: <span class="phpdocumentor-signature__argument__return-type">string|int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The parameter name in the SQL result set.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$attribute</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The metadata attribute.</p>
</section>
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_addMetaResult">
addMetaResult()
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addMetaResult" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">586</span>
</aside>
<p class="phpdocumentor-summary">Adds a meta column (foreign key or discriminator column) to the result set.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addMetaResult</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$alias</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$columnName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$fieldName</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$isIdentifierColumn</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">$this</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">$alias</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The result alias with which the meta result should be placed in the result structure.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$columnName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The name of the column in the SQL result set.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The name of the field on the declaring class.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$isIdentifierColumn</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">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$type</span>
: <span class="phpdocumentor-signature__argument__return-type">string|null</span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The column type</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addMetaResult#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">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Make all methods of this class require all parameters and not infer anything</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">$this</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
-deprecated "
>
<h4 class="phpdocumentor-element__name" id="method_addNamedNativeQueryEntityResultMapping">
addNamedNativeQueryEntityResultMapping()
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_addNamedNativeQueryEntityResultMapping" 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/Query/ResultSetMappingBuilder.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmappingbuilder.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMappingBuilder.php">ResultSetMappingBuilder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">395</span>
</aside>
<p class="phpdocumentor-summary">Adds the entity result mapping of the results of native SQL queries to the result set.</p>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addNamedNativeQueryEntityResultMapping</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Mapping-ClassMetadataInfo.html"><abbr title="\Doctrine\ORM\Mapping\ClassMetadataInfo">ClassMetadataInfo</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$classMetadata</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$entityMapping</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$alias</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">$this</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">$classMetadata</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Mapping-ClassMetadataInfo.html"><abbr title="\Doctrine\ORM\Mapping\ClassMetadataInfo">ClassMetadataInfo</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entityMapping</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$alias</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-Query-ResultSetMappingBuilder.html#method_addNamedNativeQueryEntityResultMapping#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">deprecated</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>This method is deprecated and will be removed in Doctrine ORM 3.0.</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-Mapping-MappingException.html"><abbr title="\Doctrine\ORM\Mapping\MappingException">MappingException</abbr></a></span>
</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"><abbr title="\InvalidArgumentException">InvalidArgumentException</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">$this</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
-deprecated "
>
<h4 class="phpdocumentor-element__name" id="method_addNamedNativeQueryMapping">
addNamedNativeQueryMapping()
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_addNamedNativeQueryMapping" 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/Query/ResultSetMappingBuilder.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmappingbuilder.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMappingBuilder.php">ResultSetMappingBuilder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">270</span>
</aside>
<p class="phpdocumentor-summary">Adds the mappings of the results of native SQL queries to the result set.</p>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addNamedNativeQueryMapping</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Mapping-ClassMetadataInfo.html"><abbr title="\Doctrine\ORM\Mapping\ClassMetadataInfo">ClassMetadataInfo</abbr></a>&nbsp;</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&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$queryMapping</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html"><abbr title="\Doctrine\ORM\Query\ResultSetMappingBuilder">ResultSetMappingBuilder</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">$class</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Mapping-ClassMetadataInfo.html"><abbr title="\Doctrine\ORM\Mapping\ClassMetadataInfo">ClassMetadataInfo</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$queryMapping</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_addNamedNativeQueryMapping#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">deprecated</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>This method is deprecated and will be removed in Doctrine ORM 3.0.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html"><abbr title="\Doctrine\ORM\Query\ResultSetMappingBuilder">ResultSetMappingBuilder</abbr></a></span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
-deprecated "
>
<h4 class="phpdocumentor-element__name" id="method_addNamedNativeQueryResultClassMapping">
addNamedNativeQueryResultClassMapping()
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_addNamedNativeQueryResultClassMapping" 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/Query/ResultSetMappingBuilder.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmappingbuilder.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMappingBuilder.php">ResultSetMappingBuilder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">288</span>
</aside>
<p class="phpdocumentor-summary">Adds the class mapping of the results of native SQL queries to the result set.</p>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addNamedNativeQueryResultClassMapping</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Mapping-ClassMetadataInfo.html"><abbr title="\Doctrine\ORM\Mapping\ClassMetadataInfo">ClassMetadataInfo</abbr></a>&nbsp;</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&nbsp;</span><span class="phpdocumentor-signature__argument__name">$resultClassName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">$this</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-ClassMetadataInfo.html"><abbr title="\Doctrine\ORM\Mapping\ClassMetadataInfo">ClassMetadataInfo</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$resultClassName</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-Query-ResultSetMappingBuilder.html#method_addNamedNativeQueryResultClassMapping#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">deprecated</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>This method is deprecated and will be removed in Doctrine ORM 3.0.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">$this</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
-deprecated "
>
<h4 class="phpdocumentor-element__name" id="method_addNamedNativeQueryResultSetMapping">
addNamedNativeQueryResultSetMapping()
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_addNamedNativeQueryResultSetMapping" 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/Query/ResultSetMappingBuilder.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmappingbuilder.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMappingBuilder.php">ResultSetMappingBuilder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">336</span>
</aside>
<p class="phpdocumentor-summary">Adds the result set mapping of the results of native SQL queries to the result set.</p>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addNamedNativeQueryResultSetMapping</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Mapping-ClassMetadataInfo.html"><abbr title="\Doctrine\ORM\Mapping\ClassMetadataInfo">ClassMetadataInfo</abbr></a>&nbsp;</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&nbsp;</span><span class="phpdocumentor-signature__argument__name">$resultSetMappingName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">$this</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-ClassMetadataInfo.html"><abbr title="\Doctrine\ORM\Mapping\ClassMetadataInfo">ClassMetadataInfo</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$resultSetMappingName</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-Query-ResultSetMappingBuilder.html#method_addNamedNativeQueryResultSetMapping#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">deprecated</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>This method is deprecated and will be removed in Doctrine ORM 3.0.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">$this</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_addRootEntityFromClassMetadata">
addRootEntityFromClassMetadata()
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_addRootEntityFromClassMetadata" 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/Query/ResultSetMappingBuilder.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmappingbuilder.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMappingBuilder.php">ResultSetMappingBuilder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">90</span>
</aside>
<p class="phpdocumentor-summary">Adds a root entity and all of its fields to the result set.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addRootEntityFromClassMetadata</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</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&nbsp;</span><span class="phpdocumentor-signature__argument__name">$alias</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, string&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$renamedColumns</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$renameMode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</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">$class</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The class name of the root entity.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$alias</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The unique alias to use for the root entity.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$renamedColumns</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, string&gt;</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Columns that have been renamed (tableColumnName =&gt; queryColumnName).</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$renameMode</span>
: <span class="phpdocumentor-signature__argument__return-type">int|null</span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>One of the COLUMN_RENAMING_* constants or array for BC reasons (CUSTOM).</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_addRootEntityFromClassMetadata#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>class-string $class</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&lt;string, string&gt; $renamedColumns</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>self::COLUMN_RENAMING_*|null $renameMode</p>
</section>
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_addScalarResult">
addScalarResult()
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addScalarResult" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">383</span>
</aside>
<p class="phpdocumentor-summary">Adds a scalar result mapping.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addScalarResult</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$columnName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$alias</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;string&#039;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">$this</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">$columnName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The name of the column in the SQL result set.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$alias</span>
: <span class="phpdocumentor-signature__argument__return-type">string|int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The result alias with which the scalar result should be placed in the result structure.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$type</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">&#039;string&#039;</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The column type</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addScalarResult#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">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Rename: addScalar</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">$this</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_generateSelectClause">
generateSelectClause()
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_generateSelectClause" 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/Query/ResultSetMappingBuilder.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmappingbuilder.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMappingBuilder.php">ResultSetMappingBuilder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">455</span>
</aside>
<p class="phpdocumentor-summary">Generates the Select clause from this ResultSetMappingBuilder.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">generateSelectClause</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, string&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$tableAliases</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>Works only for all the entity results. The select parts for scalar
expressions have to be written manually.</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">$tableAliases</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, string&gt;</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_generateSelectClause#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&lt;string, string&gt; $tableAliases</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getAliasMap">
getAliasMap()
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_getAliasMap" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">543</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getAliasMap</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_getAliasMap#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&lt;string, class-string&gt;</p>
</section>
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getClassName">
getClassName()
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_getClassName" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">445</span>
</aside>
<p class="phpdocumentor-summary">Gets the name of the class of an entity result or joined entity result,
identified by the given unique alias.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getClassName</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$alias</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">class-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">$alias</span>
: <span class="phpdocumentor-signature__argument__return-type">string</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">class-string</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getDeclaringClass">
getDeclaringClass()
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_getDeclaringClass" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">469</span>
</aside>
<p class="phpdocumentor-summary">Gets the name of the class that owns a field mapping for the specified column.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getDeclaringClass</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$columnName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">class-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">$columnName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</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">class-string</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getEntityAlias">
getEntityAlias()
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_getEntityAlias" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">501</span>
</aside>
<p class="phpdocumentor-summary">Gets the alias of the class that owns a field mapping for the specified column.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getEntityAlias</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$columnName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">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">$columnName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</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">string</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getEntityResultCount">
getEntityResultCount()
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_getEntityResultCount" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">554</span>
</aside>
<p class="phpdocumentor-summary">Gets the number of different entities that appear in the mapped result.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getEntityResultCount</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_getEntityResultCount#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>0|positive-int</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getFieldName">
getFieldName()
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_getFieldName" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">537</span>
</aside>
<p class="phpdocumentor-summary">Gets the field name for a column name.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getFieldName</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$columnName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">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">$columnName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</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">string</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getParentAlias">
getParentAlias()
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_getParentAlias" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">513</span>
</aside>
<p class="phpdocumentor-summary">Gets the parent alias of the given alias.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getParentAlias</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$alias</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">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">$alias</span>
: <span class="phpdocumentor-signature__argument__return-type">string</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">string</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getRelation">
getRelation()
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_getRelation" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">479</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getRelation</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$alias</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">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">$alias</span>
: <span class="phpdocumentor-signature__argument__return-type">string</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">string</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getScalarAlias">
getScalarAlias()
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_getScalarAlias" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">457</span>
</aside>
<p class="phpdocumentor-summary">Gets the field alias for a column that is mapped as a scalar value.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getScalarAlias</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$columnName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|int</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">$columnName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The name of the column in the SQL result set.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string|int</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_hasIndexBy">
hasIndexBy()
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_hasIndexBy" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">296</span>
</aside>
<p class="phpdocumentor-summary">Checks whether an entity result or joined entity result with a given alias has
a field set for indexing.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">hasIndexBy</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$alias</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">$alias</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-Query-ResultSetMapping.html#method_hasIndexBy#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">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Rename: isIndexed($alias)</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_hasParentAlias">
hasParentAlias()
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_hasParentAlias" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">525</span>
</aside>
<p class="phpdocumentor-summary">Checks whether the given alias has a parent alias.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">hasParentAlias</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$alias</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">$alias</span>
: <span class="phpdocumentor-signature__argument__return-type">string</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">bool</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_isFieldResult">
isFieldResult()
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_isFieldResult" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">311</span>
</aside>
<p class="phpdocumentor-summary">Checks whether the column with the given name is mapped as a field result
as part of an entity result or joined entity result.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">isFieldResult</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$columnName</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">$columnName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The name of the column in the SQL result set.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_isFieldResult#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">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Rename: isField</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_isMixedResult">
isMixedResult()
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_isMixedResult" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">568</span>
</aside>
<p class="phpdocumentor-summary">Checks whether this ResultSetMapping defines a mixed result.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">isMixedResult</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>Mixed results can only occur in object and array (graph) hydration. In such a
case a mixed result means that scalar values are mixed with objects/array in
the result.</p>
</section>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_isRelation">
isRelation()
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_isRelation" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">489</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">isRelation</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$alias</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">$alias</span>
: <span class="phpdocumentor-signature__argument__return-type">string</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">bool</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_isScalarResult">
isScalarResult()
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_isScalarResult" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">432</span>
</aside>
<p class="phpdocumentor-summary">Checks whether a column with a given name is mapped as a scalar result.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">isScalarResult</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$columnName</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">$columnName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The name of the column in the SQL result set.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_isScalarResult#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">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Rename: isScalar</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setDiscriminatorColumn">
setDiscriminatorColumn()
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_setDiscriminatorColumn" 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/Query/ResultSetMapping.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmapping.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMapping.php">ResultSetMapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">211</span>
</aside>
<p class="phpdocumentor-summary">Sets a discriminator column for an entity result or joined entity result.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setDiscriminatorColumn</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$alias</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$discrColumn</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">$this</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>The discriminator column will be used to determine the concrete class name to
instantiate.</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">$alias</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The alias of the entity result or joined entity result the discriminator
column should be used for.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$discrColumn</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The name of the discriminator column in the SQL result set.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_setDiscriminatorColumn#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">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Rename: addDiscriminatorColumn</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">$this</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_addAllClassFields">
addAllClassFields()
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_addAllClassFields" 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/Query/ResultSetMappingBuilder.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmappingbuilder.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMappingBuilder.php">ResultSetMappingBuilder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">136</span>
</aside>
<p class="phpdocumentor-summary">Adds all fields of the given class to the result set mapping (columns and meta fields).</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">addAllClassFields</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</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&nbsp;</span><span class="phpdocumentor-signature__argument__name">$alias</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, string&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$columnAliasMap</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</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">$class</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$alias</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$columnAliasMap</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, string&gt;</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_addAllClassFields#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&lt;string, string&gt; $columnAliasMap</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"><abbr title="\InvalidArgumentException">InvalidArgumentException</abbr></span>
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-private
"
>
<h4 class="phpdocumentor-element__name" id="method_getColumnAlias">
getColumnAlias()
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_getColumnAlias" 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/Query/ResultSetMappingBuilder.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmappingbuilder.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMappingBuilder.php">ResultSetMappingBuilder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">201</span>
</aside>
<p class="phpdocumentor-summary">Gets column alias for a given column.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">getColumnAlias</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$columnName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$mode</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$customRenameColumns</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">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">$columnName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$mode</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$customRenameColumns</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_getColumnAlias#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&lt;string, string&gt; $customRenameColumns</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">psalm-assert</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>self::COLUMN_RENAMING_* $mode</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-private
"
>
<h4 class="phpdocumentor-element__name" id="method_getColumnAliasMap">
getColumnAliasMap()
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_getColumnAliasMap" 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/Query/ResultSetMappingBuilder.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmappingbuilder.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMappingBuilder.php">ResultSetMappingBuilder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">233</span>
</aside>
<p class="phpdocumentor-summary">Retrieves a class columns and join columns aliases that are used in the SELECT clause.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">getColumnAliasMap</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$className</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$mode</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$customRenameColumns</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, string&gt;</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>This depends on the renaming mode selected by the user.</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">$className</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$mode</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$customRenameColumns</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_getColumnAliasMap#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>class-string $className</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>self::COLUMN_RENAMING_* $mode</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&lt;string, string&gt; $customRenameColumns</p>
</section>
</dd>
<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&lt;array-key, string&gt;</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, string&gt;</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-private
"
>
<h4 class="phpdocumentor-element__name" id="method_isInheritanceSupported">
isInheritanceSupported()
<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_isInheritanceSupported" 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/Query/ResultSetMappingBuilder.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-query-resultsetmappingbuilder.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Query/ResultSetMappingBuilder.php">ResultSetMappingBuilder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">isInheritanceSupported</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>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$classMetadata</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">$classMetadata</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>
</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/Query/ResultSetMappingBuilder.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
</div>
<button data-exit-button class="phpdocumentor-modal__close">&times;</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-Query-ResultSetMappingBuilder.html#toc-constants">Constants</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#toc-properties">Properties</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.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-Query-ResultSetMappingBuilder.html#constant_COLUMN_RENAMING_CUSTOM">COLUMN_RENAMING_CUSTOM</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#constant_COLUMN_RENAMING_INCREMENT">COLUMN_RENAMING_INCREMENT</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#constant_COLUMN_RENAMING_NONE">COLUMN_RENAMING_NONE</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-Query-ResultSetMapping.html#property_discriminatorParameters">$discriminatorParameters<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html"></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#property_isIdentifierColumn">$isIdentifierColumn<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html"></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#property_metadataParameterMapping">$metadataParameterMapping<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html"></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#property_newObjectMappings">$newObjectMappings<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html"></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#property_defaultRenameMode">$defaultRenameMode<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html"></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#property_em">$em<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html"></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#property_sqlCounter">$sqlCounter<a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.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-Query-ResultSetMappingBuilder.html#method___construct">__construct()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method___toString">__toString()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addEntityResult">addEntityResult()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addEnumResult">addEnumResult()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addFieldResult">addFieldResult()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addIndexBy">addIndexBy()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addIndexByColumn">addIndexByColumn()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addIndexByScalar">addIndexByScalar()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_addJoinedEntityFromClassMetadata">addJoinedEntityFromClassMetadata()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addJoinedEntityResult">addJoinedEntityResult()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addMetadataParameterMapping">addMetadataParameterMapping()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addMetaResult">addMetaResult()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_addNamedNativeQueryEntityResultMapping">addNamedNativeQueryEntityResultMapping()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_addNamedNativeQueryMapping">addNamedNativeQueryMapping()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_addNamedNativeQueryResultClassMapping">addNamedNativeQueryResultClassMapping()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_addNamedNativeQueryResultSetMapping">addNamedNativeQueryResultSetMapping()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_addRootEntityFromClassMetadata">addRootEntityFromClassMetadata()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_addScalarResult">addScalarResult()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_generateSelectClause">generateSelectClause()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_getAliasMap">getAliasMap()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_getClassName">getClassName()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_getDeclaringClass">getDeclaringClass()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_getEntityAlias">getEntityAlias()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_getEntityResultCount">getEntityResultCount()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_getFieldName">getFieldName()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_getParentAlias">getParentAlias()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_getRelation">getRelation()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_getScalarAlias">getScalarAlias()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_hasIndexBy">hasIndexBy()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_hasParentAlias">hasParentAlias()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_isFieldResult">isFieldResult()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_isMixedResult">isMixedResult()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_isRelation">isRelation()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_isScalarResult">isScalarResult()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMapping.html#method_setDiscriminatorColumn">setDiscriminatorColumn()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_addAllClassFields">addAllClassFields()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_getColumnAlias">getColumnAlias()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_getColumnAliasMap">getColumnAliasMap()</a></li>
<li><a href="classes/Doctrine-ORM-Query-ResultSetMappingBuilder.html#method_isInheritanceSupported">isInheritanceSupported()</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-Query-ResultSetMappingBuilder.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>