Skip to content

Commit 1546a0c

Browse files
ezrobotibexa-workflow-automation-1[bot]
ezrobot
and
ibexa-workflow-automation-1[bot]
authored
PHP API Ref HTML (#3041)
Co-authored-by: ibexa-workflow-automation-1[bot] <ibexa-workflow-automation-1[bot]@users.noreply.github.com>
1 parent 4027cb7 commit 1546a0c

33 files changed

Lines changed: 2009 additions & 131 deletions

File tree

‎docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Ibexa.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ <h3 id="constant_VERSION">
280280
</td>
281281
<td class="code">
282282
<div>
283-
<pre><code><span class="phpdocumentor-signature__visibility">public </span><span class="phpdocumentor-signature__type">mixed </span><span class="phpdocumentor-signature__name">VERSION</span> = <span class="phpdocumentor-signature__default-value">&#039;4.6.26&#039;</span></code></pre>
283+
<pre><code><span class="phpdocumentor-signature__visibility">public </span><span class="phpdocumentor-signature__type">mixed </span><span class="phpdocumentor-signature__name">VERSION</span> = <span class="phpdocumentor-signature__default-value">&#039;4.6.27&#039;</span></code></pre>
284284
</div>
285285
</td>
286286
</tr>

‎docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Content-Search-AggregationResultCollection.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -730,7 +730,7 @@ <h3 id="method_toArray">
730730
</td>
731731
<td class="code">
732732
<div>
733-
<pre><code><span class="phpdocumentor-signature__visibility">public </span><span class="phpdocumentor-signature__name">toArray</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, <a href="classes/Ibexa-Contracts-Core-Repository-Values-ContentType-FieldDefinition.html"><abbr title="\Ibexa\Contracts\Core\Repository\Values\ContentType\FieldDefinition">FieldDefinition</abbr></a>&gt;</span></code></pre>
733+
<pre><code><span class="phpdocumentor-signature__visibility">public </span><span class="phpdocumentor-signature__name">toArray</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, <a href="classes/Ibexa-Contracts-Core-Repository-Values-Content-Search-AggregationResult.html"><abbr title="\Ibexa\Contracts\Core\Repository\Values\Content\Search\AggregationResult">AggregationResult</abbr></a>&gt;</span></code></pre>
734734
</div>
735735
</td>
736736
</tr>
@@ -740,7 +740,7 @@ <h3 id="method_toArray">
740740
<div class="phpdocumentor-label-line">
741741
</div>
742742
<h4>Return values</h4>
743-
<p class="phpdocumentor-signature__response_type">array&lt;string|int, <a href="classes/Ibexa-Contracts-Core-Repository-Values-ContentType-FieldDefinition.html"><abbr title="\Ibexa\Contracts\Core\Repository\Values\ContentType\FieldDefinition">FieldDefinition</abbr></a>&gt;</p>
743+
<p class="phpdocumentor-signature__response_type">array&lt;string|int, <a href="classes/Ibexa-Contracts-Core-Repository-Values-Content-Search-AggregationResult.html"><abbr title="\Ibexa\Contracts\Core\Repository\Values\Content\Search\AggregationResult">AggregationResult</abbr></a>&gt;</p>
744744

745745

746746
</div>

‎docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Search-Embedding-EmbeddingProviderExceptionInterface.html‎

Lines changed: 300 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,300 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<title>EmbeddingProviderExceptionInterface | PHP API Reference (Ibexa Documentation)</title>
6+
7+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
8+
<meta name="description" content="" />
9+
10+
<base href="../">
11+
<link rel="icon" href="images/favicon.png"/>
12+
<link rel="stylesheet" href="css/base.css">
13+
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css">
14+
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
15+
<script src="js/search.js"></script>
16+
<script defer src="js/searchIndex.js"></script>
17+
18+
19+
<script>
20+
window.symfonyVersion = '5.4';
21+
window.addEventListener('keyup', (event) => {
22+
if (event.key === '/') {
23+
event.stopImmediatePropagation();
24+
}
25+
});
26+
</script>
27+
</head>
28+
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="blue-grey" data-md-color-accent="deep-orange">
29+
<div class="popover popover--copied">Copied!</div>
30+
31+
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
32+
33+
<header class="md-header" data-md-component="header">
34+
<nav class="md-header__inner md-grid" aria-label="">
35+
36+
<a href="../php_api/"
37+
title="PHP API Reference"
38+
aria-label="PHP API Reference"
39+
class="md-header__button md-logo"
40+
>
41+
<img src="./images/ibexa-dxp-logo.png">
42+
</a>
43+
<div class="md-header__switcher push">
44+
<div class="md-flex__ellipsis md-header__title switcher docs-switcher" data-md-component="title">
45+
<div class="switcher__selected-item" tab-index="-1">
46+
<div class="switcher__label" title="Developer Documentation">Developer Documentation</div>
47+
</div>
48+
<div class="switcher__list">
49+
<dl>
50+
<strong>
51+
<dd>
52+
<a href="/" title="Developer Documentation">Developer Documentation</a>
53+
</dd>
54+
</strong>
55+
<dd>
56+
<a href="/projects/userguide" title="User Documentation">User Documentation</a>
57+
</dd>
58+
<dd>
59+
<a href="/projects/connect" title="Connect Documentation">Connect Documentation</a>
60+
</dd>
61+
</dl>
62+
</div>
63+
</div>
64+
</div>
65+
<div class="md-header__switcher">
66+
<div class="md-flex__ellipsis md-header__title switcher version-switcher" data-md-component="title">
67+
<div class="rst-other-versions switcher__list"></div>
68+
</div>
69+
</div>
70+
<div class="md-search" data-md-component="search" role="dialog">
71+
<label class="md-search__overlay" for="__search"></label>
72+
<div class="md-search__inner phpdocumentor-search" role="search" data-search-form>
73+
<form class="md-search__form" name="search" >
74+
<span class="algolia-autocomplete algolia-autocomplete-left">
75+
<input
76+
type="search"
77+
id="search_input"
78+
class="md-search__input phpdocumentor-field phpdocumentor-search__field"
79+
name="query"
80+
aria-label="Search"
81+
placeholder="Search"
82+
autocapitalize="off"
83+
autocorrect="off"
84+
autocomplete="off"
85+
spellcheck="false"
86+
data-md-component="search-query"
87+
data-md-state="active"
88+
required
89+
>
90+
<label class="md-search__icon md-icon" for="__search">
91+
<img src="images/search.svg" alt="search">
92+
</label>
93+
<span
94+
class="ds-dropdown-menu ds-with-1 phpdocumentor-search-results phpdocumentor-search-results--hidden"
95+
role="listbox"
96+
data-search-results
97+
>
98+
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
99+
<div class="ds-dataset-1">
100+
<ul class="ds-suggestions phpdocumentor-search-results__entries">
101+
</ul>
102+
</div>
103+
</span>
104+
</span>
105+
</form>
106+
</div>
107+
</div>
108+
<div class="md-header__source">
109+
<a href="https://github.com/ibexa/core/blob/main/src/contracts/Search/Embedding/EmbeddingProviderExceptionInterface.php" title="" class="source-github">
110+
<div class="md-source__icon md-icon">
111+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 480 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M186.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1zM480 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2zm-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3.2-15.2 0-30.1-.9-45.1-3.2-18.7-2.6-37-6-56-6-46.8 0-73.5 38.7-73.5 82.6 0 87.8 80.4 101.3 150.4 101.3h48.2c70.3 0 150.6-13.4 150.6-101.3zm-82.6-55.1c-25.8 0-36.7 34.2-36.7 55.1s10.9 55.1 36.7 55.1 36.7-34.2 36.7-55.1-10.9-55.1-36.7-55.1z"></path></svg>
112+
</div>
113+
View on GitHub
114+
</a>
115+
</div>
116+
</nav>
117+
</header>
118+
119+
<div class="md-container" data-md-component="container">
120+
<main class="md-main" data-md-component="main">
121+
<div class="md-main__inner md-grid">
122+
123+
<div class="main_nav" id="nav-container">
124+
<div class="nav-loading-wrapper" style="padding: 2rem; text-align: center; color: #666;">
125+
<p>Loading navigation...</p>
126+
</div>
127+
</div>
128+
129+
<script>
130+
(function() {
131+
var navPath = document.baseURI + '/index.html';
132+
var cached = sessionStorage.getItem('phpdoc-nav');
133+
var navContainer = document.getElementById('nav-container');
134+
135+
function loadNav(html) {
136+
// Use innerHTML to replace content while keeping the nav-container div
137+
navContainer.innerHTML = html;
138+
139+
// Restore scroll position if saved
140+
var scrollWrap = navContainer.querySelector('.md-sidebar__scrollwrap');
141+
if (scrollWrap) {
142+
var scrollPos = sessionStorage.getItem('nav-scroll');
143+
if (scrollPos) {
144+
scrollWrap.scrollTop = parseInt(scrollPos, 10);
145+
}
146+
147+
// Save scroll position on scroll
148+
scrollWrap.addEventListener('scroll', function() {
149+
sessionStorage.setItem('nav-scroll', scrollWrap.scrollTop);
150+
});
151+
}
152+
153+
// Highlight current page in navigation
154+
activeMenu(window, window.document);
155+
}
156+
157+
if (cached) {
158+
// Use cached navigation
159+
loadNav(cached);
160+
} else {
161+
// Fetch navigation
162+
fetch(navPath)
163+
.then(function(r) {
164+
if (!r.ok) throw new Error('HTTP ' + r.status);
165+
return r.text();
166+
})
167+
.then(function(html) {
168+
parser = new DOMParser();
169+
doc = parser.parseFromString(html, 'text/html');
170+
nav = doc.querySelector('.main_nav_content');
171+
sessionStorage.setItem('phpdoc-nav', nav.outerHTML);
172+
loadNav(nav.outerHTML);
173+
})
174+
.catch(function(err) {
175+
console.error('Navigation load failed:', err);
176+
navContainer.innerHTML = '<div class="main_nav_content"><div style="padding: 1rem; color: #c00;">Navigation failed to load. <a href="index.html">Go to index</a></div></div><div class="main_nav__resize-handler"></div>';
177+
})
178+
;
179+
}
180+
})();
181+
</script>
182+
183+
<noscript>
184+
<div class="main_nav">
185+
<div class="main_nav_content">
186+
<div class="site-header" id="site-name">
187+
<a href=".">PHP API Reference</a>
188+
</div>
189+
<div style="padding: 1rem; background: #ffe; border: 1px solid #cc0;">
190+
<p><strong>JavaScript is disabled.</strong></p>
191+
<p>Navigation requires JavaScript. Please enable it or go to <a href="namespaces/ibexa-contracts.html"><code>Ibexa\\Contracts</code></a> to navigate.</p>
192+
</div>
193+
</div>
194+
<div class="main_nav__resize-handler"></div>
195+
</div>
196+
</noscript>
197+
198+
199+
<div class="md-content" data-md-component="content">
200+
<article class="md-content__inner md-typeset">
201+
<div>
202+
203+
<ul class="breadcrumbs">
204+
<li class="breadcrumb-item">
205+
<a href="namespaces/ibexa.html">Ibexa</a>
206+
&gt;
207+
</li>
208+
<li class="breadcrumb-item">
209+
<a href="namespaces/ibexa-contracts.html">Contracts</a>
210+
&gt;
211+
</li>
212+
<li class="breadcrumb-item">
213+
<a href="namespaces/ibexa-contracts-core.html">Core</a>
214+
&gt;
215+
</li>
216+
<li class="breadcrumb-item">
217+
<a href="namespaces/ibexa-contracts-core-search.html">Search</a>
218+
&gt;
219+
</li>
220+
<li class="breadcrumb-item">
221+
<a href="namespaces/ibexa-contracts-core-search-embedding.html">Embedding</a>
222+
&gt;
223+
</li>
224+
<li class="breadcrumb-item breadcrumb-item-current">
225+
<span>
226+
EmbeddingProviderExceptionInterface
227+
</span>
228+
</li>
229+
</ul>
230+
231+
<div class="content-header">
232+
<div class="pills">
233+
234+
235+
</div>
236+
<h1 id="EmbeddingProviderExceptionInterface">
237+
EmbeddingProviderExceptionInterface </h1>
238+
<button class="content-header__copy-fqcn copy-to-clipboard" title="Ibexa\Contracts\Core\Search\Embedding\EmbeddingProviderExceptionInterface" data-copy-value="Ibexa\Contracts\Core\Search\Embedding\EmbeddingProviderExceptionInterface">Copy FQCN</button>
239+
<div class="content-header__found-in copy-to-clipboard" data-copy-value="vendor/ibexa/core/src/contracts/Search/Embedding/EmbeddingProviderExceptionInterface.php">
240+
<abbr title="vendor/ibexa/core/src/contracts/Search/Embedding/EmbeddingProviderExceptionInterface.php">EmbeddingProviderExceptionInterface.php</abbr>
241+
:
242+
<span title="at line 13">13</span>
243+
<img src="./images/copy.svg" title="Copy path" />
244+
</div>
245+
<div class="content-header__subheader">Interface</div>
246+
247+
<div class="content-header__subheader">
248+
Extends
249+
<abbr title="\Throwable">Throwable</abbr> </div>
250+
</div>
251+
252+
253+
254+
255+
256+
257+
258+
259+
260+
261+
262+
263+
264+
265+
266+
</div>
267+
</article>
268+
</div>
269+
270+
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
271+
<div class="md-sidebar__scrollwrap">
272+
<div class="md-sidebar__inner">
273+
<nav class="md-nav md-nav--secondary" aria-label="">
274+
275+
276+
<ul class="md-nav__list">
277+
</ul>
278+
279+
</nav>
280+
</div>
281+
</div>
282+
</div>
283+
</div>
284+
</main>
285+
</div>
286+
<script
287+
src="https://code.jquery.com/jquery-3.7.1.min.js"
288+
integrity="sha256-/JqT3SQfawRcv/BIHPThkBvs0OEvtFFmqPF/lYI/Cxo="
289+
crossorigin="anonymous">
290+
</script>
291+
<script src="js/active-menu.js"></script>
292+
<script src="js/menu-resizer.js"></script>
293+
<script src="js/docs.switcher.js"></script>
294+
<script src="js/toc.js"></script>
295+
<script src="js/search_custom.js"></script>
296+
<script src="js/copy_to_clipboard.js"></script>
297+
<script src="js/version_switcher_custom.js"></script>
298+
<script src="js/external-links.js"></script>
299+
</body>
300+
</html>

‎docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Search-Embedding-EmbeddingProviderInterface.html‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,7 @@ <h3 id="method_getEmbedding">
272272
<div class="content-header__found-in copy-to-clipboard" data-copy-value="vendor/ibexa/core/src/contracts/Search/Embedding/EmbeddingProviderInterface.php">
273273
<abbr title="vendor/ibexa/core/src/contracts/Search/Embedding/EmbeddingProviderInterface.php">EmbeddingProviderInterface.php</abbr>
274274
:
275-
<span title="at line 16">16</span>
275+
<span title="at line 18">18</span>
276276
<img src="./images/copy.svg" title="Copy path" />
277277
</div>
278278
</div>
@@ -354,7 +354,21 @@ <h4>Parameters</h4>
354354
</table>
355355
<h4>Return values</h4>
356356
<p class="phpdocumentor-signature__response_type">array&lt;string|int, float&gt;</p>
357-
357+
358+
<h5 class="phpdocumentor-tag-list__heading">
359+
Tags
360+
<a href="classes/Ibexa-Contracts-Core-Search-Embedding-EmbeddingProviderInterface.html#method_getEmbedding#tags" class="headerlink"><i class="fas fa-link"></i></a>
361+
362+
</h5>
363+
<dl class="phpdocumentor-tag-list">
364+
<dt class="phpdocumentor-tag-list__entry">
365+
<span class="phpdocumentor-tag__name">Throws</span>
366+
</dt>
367+
<dd class="phpdocumentor-tag-list__definition">
368+
<span class="phpdocumentor-tag-link"><a href="classes/Ibexa-Contracts-Core-Search-Embedding-EmbeddingProviderExceptionInterface.html"><abbr title="\Ibexa\Contracts\Core\Search\Embedding\EmbeddingProviderExceptionInterface">EmbeddingProviderExceptionInterface</abbr></a></span>
369+
370+
</dd>
371+
</dl>
358372

359373
</div>
360374
</article>

0 commit comments

Comments
 (0)