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

1556 lines
70 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-cache.html">Cache</a></li>
</ul>
<article class="phpdocumentor-element -interface">
<h2 class="phpdocumentor-content__title">
ConcurrentRegion
<span class="phpdocumentor-element__extends">
extends
<a href="classes/Doctrine-ORM-Cache-Region.html"><abbr title="\Doctrine\ORM\Cache\Region">Region</abbr></a> </span>
<div class="phpdocumentor-element__package">
in
<ul class="phpdocumentor-breadcrumbs">
<li><a href="packages/Application.html">Application</a></li>
</ul>
</div>
</h2>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/doctrine/orm/lib/Doctrine/ORM/Cache/ConcurrentRegion.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-cache-concurrentregion.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Cache/ConcurrentRegion.php">ConcurrentRegion.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">14</span>
</aside>
<p class="phpdocumentor-summary">Defines contract for concurrently managed data region.</p>
<section class="phpdocumentor-description"><p>It should be able to lock an specific cache entry in an atomic operation.</p>
<p>When a entry is locked another process should not be able to read or write the entry.
All evict operation should not consider locks, even though an entry is locked evict should be able to delete the entry and its lock.</p>
</section>
<h3 id="toc">
Table of Contents
<a href="classes/Doctrine-ORM-Cache-ConcurrentRegion.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<h4 id="toc-methods">
Methods
<a href="classes/Doctrine-ORM-Cache-ConcurrentRegion.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-Cache-Region.html#method_contains">contains()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Determine whether this region contains data for the given key.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Cache-Region.html#method_evict">evict()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Remove an item from the cache.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Cache-Region.html#method_evictAll">evictAll()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Remove all contents of this particular cache region.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Cache-Region.html#method_get">get()</a>
<span>
&nbsp;: <a href="classes/Doctrine-ORM-Cache-CacheEntry.html"><abbr title="\Doctrine\ORM\Cache\CacheEntry">CacheEntry</abbr></a>|null </span>
</dt>
<dd>Get an item from the cache.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Cache-MultiGetRegion.html#method_getMultiple">getMultiple()</a>
<span>
&nbsp;: array&lt;string|int, <a href="classes/Doctrine-ORM-Cache-CacheEntry.html"><abbr title="\Doctrine\ORM\Cache\CacheEntry">CacheEntry</abbr></a>&gt;|null </span>
</dt>
<dd>Get all items from the cache identified by $keys.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Cache-Region.html#method_getName">getName()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Retrieve the name of this region.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Cache-ConcurrentRegion.html#method_lock">lock()</a>
<span>
&nbsp;: <a href="classes/Doctrine-ORM-Cache-Lock.html"><abbr title="\Doctrine\ORM\Cache\Lock">Lock</abbr></a>|null </span>
</dt>
<dd>Attempts to read lock the mapping for the given key.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Cache-Region.html#method_put">put()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Put an item into the cache.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Doctrine-ORM-Cache-ConcurrentRegion.html#method_unlock">unlock()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Attempts to read unlock the mapping for the given key.</dd>
</dl>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/Doctrine-ORM-Cache-ConcurrentRegion.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_contains">
contains()
<a href="classes/Doctrine-ORM-Cache-Region.html#method_contains" 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/Cache/Region.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-cache-region.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Cache/Region.php">Region.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">28</span>
</aside>
<p class="phpdocumentor-summary">Determine whether this region contains data for the given key.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">contains</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Cache-CacheKey.html"><abbr title="\Doctrine\ORM\Cache\CacheKey">CacheKey</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$key</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">$key</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Cache-CacheKey.html"><abbr title="\Doctrine\ORM\Cache\CacheKey">CacheKey</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The cache key</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
&mdash;
<section class="phpdocumentor-description"><p>TRUE if the underlying cache contains corresponding data; FALSE otherwise.</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_evict">
evict()
<a href="classes/Doctrine-ORM-Cache-Region.html#method_evict" 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/Cache/Region.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-cache-region.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Cache/Region.php">Region.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">63</span>
</aside>
<p class="phpdocumentor-summary">Remove an item from the cache.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">evict</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Cache-CacheKey.html"><abbr title="\Doctrine\ORM\Cache\CacheKey">CacheKey</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$key</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">$key</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Cache-CacheKey.html"><abbr title="\Doctrine\ORM\Cache\CacheKey">CacheKey</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The key under which to cache the item.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Doctrine-ORM-Cache-Region.html#method_evict#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">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Doctrine-ORM-Cache-Exception-CacheException.html"><abbr title="\Doctrine\ORM\Cache\Exception\CacheException">CacheException</abbr></a></span>
<section class="phpdocumentor-description"><p>Indicates a problem accessing the region.</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_evictAll">
evictAll()
<a href="classes/Doctrine-ORM-Cache-Region.html#method_evictAll" 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/Cache/Region.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-cache-region.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Cache/Region.php">Region.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">72</span>
</aside>
<p class="phpdocumentor-summary">Remove all contents of this particular cache region.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">evictAll</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Doctrine-ORM-Cache-Region.html#method_evictAll#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">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Doctrine-ORM-Cache-Exception-CacheException.html"><abbr title="\Doctrine\ORM\Cache\Exception\CacheException">CacheException</abbr></a></span>
<section class="phpdocumentor-description"><p>Indicates problem accessing the region.</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_get">
get()
<a href="classes/Doctrine-ORM-Cache-Region.html#method_get" 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/Cache/Region.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-cache-region.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Cache/Region.php">Region.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<p class="phpdocumentor-summary">Get an item from the cache.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Cache-CacheKey.html"><abbr title="\Doctrine\ORM\Cache\CacheKey">CacheKey</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$key</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/Doctrine-ORM-Cache-CacheEntry.html"><abbr title="\Doctrine\ORM\Cache\CacheEntry">CacheEntry</abbr></a>|null</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">$key</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Cache-CacheKey.html"><abbr title="\Doctrine\ORM\Cache\CacheKey">CacheKey</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The key of the item to be retrieved.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Doctrine-ORM-Cache-Region.html#method_get#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">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Doctrine-ORM-Cache-Exception-CacheException.html"><abbr title="\Doctrine\ORM\Cache\Exception\CacheException">CacheException</abbr></a></span>
<section class="phpdocumentor-description"><p>Indicates a problem accessing the item or region.</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-Cache-CacheEntry.html"><abbr title="\Doctrine\ORM\Cache\CacheEntry">CacheEntry</abbr></a>|null</span>
&mdash;
<section class="phpdocumentor-description"><p>The cached entry or NULL</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getMultiple">
getMultiple()
<a href="classes/Doctrine-ORM-Cache-MultiGetRegion.html#method_getMultiple" 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/Cache/MultiGetRegion.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-cache-multigetregion.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Cache/MultiGetRegion.php">MultiGetRegion.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">24</span>
</aside>
<p class="phpdocumentor-summary">Get all items from the cache identified by $keys.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getMultiple</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Cache-CollectionCacheEntry.html"><abbr title="\Doctrine\ORM\Cache\CollectionCacheEntry">CollectionCacheEntry</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$collection</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, <a href="classes/Doctrine-ORM-Cache-CacheEntry.html"><abbr title="\Doctrine\ORM\Cache\CacheEntry">CacheEntry</abbr></a>&gt;|null</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>It returns NULL if some elements can not be found.</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">$collection</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Cache-CollectionCacheEntry.html"><abbr title="\Doctrine\ORM\Cache\CollectionCacheEntry">CollectionCacheEntry</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The collection of the items to be retrieved.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, <a href="classes/Doctrine-ORM-Cache-CacheEntry.html"><abbr title="\Doctrine\ORM\Cache\CacheEntry">CacheEntry</abbr></a>&gt;|null</span>
&mdash;
<section class="phpdocumentor-description"><p>The cached entries or NULL if one or more entries can not be found</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getName">
getName()
<a href="classes/Doctrine-ORM-Cache-Region.html#method_getName" 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/Cache/Region.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-cache-region.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Cache/Region.php">Region.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">19</span>
</aside>
<p class="phpdocumentor-summary">Retrieve the name of this region.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getName</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>
&mdash;
<section class="phpdocumentor-description"><p>The region name</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_lock">
lock()
<a href="classes/Doctrine-ORM-Cache-ConcurrentRegion.html#method_lock" 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/Cache/ConcurrentRegion.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-cache-concurrentregion.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Cache/ConcurrentRegion.php">ConcurrentRegion.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">25</span>
</aside>
<p class="phpdocumentor-summary">Attempts to read lock the mapping for the given key.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">lock</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Cache-CacheKey.html"><abbr title="\Doctrine\ORM\Cache\CacheKey">CacheKey</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$key</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/Doctrine-ORM-Cache-Lock.html"><abbr title="\Doctrine\ORM\Cache\Lock">Lock</abbr></a>|null</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">$key</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Cache-CacheKey.html"><abbr title="\Doctrine\ORM\Cache\CacheKey">CacheKey</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The key of the item to lock.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Doctrine-ORM-Cache-ConcurrentRegion.html#method_lock#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">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Doctrine-ORM-Cache-LockException.html"><abbr title="\Doctrine\ORM\Cache\LockException">LockException</abbr></a></span>
<section class="phpdocumentor-description"><p>Indicates a problem accessing the region.</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-Cache-Lock.html"><abbr title="\Doctrine\ORM\Cache\Lock">Lock</abbr></a>|null</span>
&mdash;
<section class="phpdocumentor-description"><p>A lock instance or NULL if the lock already exists.</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_put">
put()
<a href="classes/Doctrine-ORM-Cache-Region.html#method_put" 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/Cache/Region.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-cache-region.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Cache/Region.php">Region.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">52</span>
</aside>
<p class="phpdocumentor-summary">Put an item into the cache.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">put</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Cache-CacheKey.html"><abbr title="\Doctrine\ORM\Cache\CacheKey">CacheKey</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$key</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Cache-CacheEntry.html"><abbr title="\Doctrine\ORM\Cache\CacheEntry">CacheEntry</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$entry</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Cache-Lock.html"><abbr title="\Doctrine\ORM\Cache\Lock">Lock</abbr></a>|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$lock</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">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">$key</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Cache-CacheKey.html"><abbr title="\Doctrine\ORM\Cache\CacheKey">CacheKey</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The key under which to cache the item.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entry</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Cache-CacheEntry.html"><abbr title="\Doctrine\ORM\Cache\CacheEntry">CacheEntry</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The entry to cache.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$lock</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Cache-Lock.html"><abbr title="\Doctrine\ORM\Cache\Lock">Lock</abbr></a>|null</span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The lock previously obtained.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Doctrine-ORM-Cache-Region.html#method_put#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">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Doctrine-ORM-Cache-Exception-CacheException.html"><abbr title="\Doctrine\ORM\Cache\Exception\CacheException">CacheException</abbr></a></span>
<section class="phpdocumentor-description"><p>Indicates a problem accessing the region.</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_unlock">
unlock()
<a href="classes/Doctrine-ORM-Cache-ConcurrentRegion.html#method_unlock" 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/Cache/ConcurrentRegion.php"><a href="files/vendor-doctrine-orm-lib-doctrine-orm-cache-concurrentregion.html"><abbr title="vendor/doctrine/orm/lib/Doctrine/ORM/Cache/ConcurrentRegion.php">ConcurrentRegion.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">37</span>
</aside>
<p class="phpdocumentor-summary">Attempts to read unlock the mapping for the given key.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">unlock</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Cache-CacheKey.html"><abbr title="\Doctrine\ORM\Cache\CacheKey">CacheKey</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$key</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Cache-Lock.html"><abbr title="\Doctrine\ORM\Cache\Lock">Lock</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$lock</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">$key</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Cache-CacheKey.html"><abbr title="\Doctrine\ORM\Cache\CacheKey">CacheKey</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The key of the item to unlock.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$lock</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Doctrine-ORM-Cache-Lock.html"><abbr title="\Doctrine\ORM\Cache\Lock">Lock</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The lock previously obtained from <a href="readLock"></a></p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Doctrine-ORM-Cache-ConcurrentRegion.html#method_unlock#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">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Doctrine-ORM-Cache-LockException.html"><abbr title="\Doctrine\ORM\Cache\LockException">LockException</abbr></a></span>
<section class="phpdocumentor-description"><p>Indicates a problem accessing the region.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
</section>
<div class="phpdocumentor-modal" id="source-view">
<div class="phpdocumentor-modal-bg" data-exit-button></div>
<div class="phpdocumentor-modal-container">
<div class="phpdocumentor-modal-content">
<pre style="max-height: 500px; overflow-y: scroll" data-src="files/vendor/doctrine/orm/lib/Doctrine/ORM/Cache/ConcurrentRegion.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-Cache-ConcurrentRegion.html#toc-constants">Constants</a></li>
<li><a href="classes/Doctrine-ORM-Cache-ConcurrentRegion.html#toc-methods">Methods</a></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-Cache-Region.html#method_contains">contains()</a></li>
<li><a href="classes/Doctrine-ORM-Cache-Region.html#method_evict">evict()</a></li>
<li><a href="classes/Doctrine-ORM-Cache-Region.html#method_evictAll">evictAll()</a></li>
<li><a href="classes/Doctrine-ORM-Cache-Region.html#method_get">get()</a></li>
<li><a href="classes/Doctrine-ORM-Cache-MultiGetRegion.html#method_getMultiple">getMultiple()</a></li>
<li><a href="classes/Doctrine-ORM-Cache-Region.html#method_getName">getName()</a></li>
<li><a href="classes/Doctrine-ORM-Cache-ConcurrentRegion.html#method_lock">lock()</a></li>
<li><a href="classes/Doctrine-ORM-Cache-Region.html#method_put">put()</a></li>
<li><a href="classes/Doctrine-ORM-Cache-ConcurrentRegion.html#method_unlock">unlock()</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-Cache-ConcurrentRegion.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>