Generate PHP API Ref HTML

ibexa · Jan 6, 2025 · e0fc44e · e0fc44e
1 parent bd2f142
commit e0fc44e
Showing 12 changed files with 484 additions and 484 deletions.
diff --git a/...i/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorAi-Action-ActionContext.html b/...i/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorAi-Action-ActionContext.html
@@ -38204,9 +38204,9 @@ <h1 id="ActionContext">
 
 
     <section class="phpdocumentor-description">
-        <p>Supports readonly properties by marking them as protected.
+        <p>Supports read-only properties by marking them as protected.
 In this case they will only be writable using constructor, and need to be documented
-using property-read <type> &lt;$var&gt; annotation in class doc in addition to inline property doc.
+using <code class="prettyprint">@property-read &lt;type&gt; &lt;$var&gt;</code> annotation in class doc in addition to inline property doc.
 Writable properties must be public and must be documented inline.</p>
 
     </section>
@@ -38263,7 +38263,7 @@ <h3 id="method___construct">
 <div class="phpdocumentor-label-line">
     </div>
     <section class="phpdocumentor-description">
-        <p>Readonly properties values must be set using $properties as they are not writable anymore
+        <p>Readonly properties values must be set using <code class="prettyprint">$properties</code> as they aren't writable anymore
 after object has been created.</p>
 
     </section>
@@ -38439,11 +38439,11 @@ <h3 id="method_getProperties">
         <div class="content-header__found-in copy-to-clipboard" data-copy-value="vendor/ibexa/core/src/contracts/Repository/Values/ValueObject.php">
         <abbr title="vendor/ibexa/core/src/contracts/Repository/Values/ValueObject.php">ValueObject.php</abbr>
                 :
-        <span title="at line 50">50</span>
+        <span title="at line 51">51</span>
                 <img src="./images/copy.svg" title="Copy path" />
     </div>
         </div>
-    <p>Function where list of properties are returned.</p>
+    <p>Returns list of available properties&#039; names.</p>
 
 <div class="highlight">
     <table class="highlighttable">
@@ -38456,7 +38456,7 @@ <h3 id="method_getProperties">
                 </td>
                 <td class="code">
                     <div>
-                        <pre><code><span class="phpdocumentor-signature__visibility">protected </span><span class="phpdocumentor-signature__name">getProperties</span><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">$dynamicProperties</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code></pre>
+                        <pre><code><span class="phpdocumentor-signature__visibility">protected </span><span class="phpdocumentor-signature__name">getProperties</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">array&lt;int, string&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$dynamicProperties</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;int, string&gt;</span></code></pre>
                     </div>
                 </td>
             </tr>
@@ -38466,7 +38466,7 @@ <h3 id="method_getProperties">
 <div class="phpdocumentor-label-line">
     </div>
     <section class="phpdocumentor-description">
-        <p>Used by <abbr title="\Ibexa\Contracts\Core\Repository\Values\attributes()">attributes()</abbr>, override to add dynamic properties</p>
+        <p>Override to add dynamic properties.</p>
 
     </section>
     <h4>Parameters</h4>
@@ -38485,7 +38485,7 @@ <h4>Parameters</h4>
                         $dynamicProperties
                     </td>
                     <td>
-                        array&lt;string|int, mixed&gt;
+                        array&lt;int, string&gt;
                     </td>
                     <td>
                                                                                     []
@@ -38501,7 +38501,7 @@ <h4>Parameters</h4>
                     </tbody>
     </table>
     <h4>Return values</h4>
-    <p class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</p>
+    <p class="phpdocumentor-signature__response_type">array&lt;int, string&gt;</p>
 
                             </div>
                     </article>

diff --git a/...sses/Ibexa-Contracts-ConnectorAi-ActionConfiguration-ActionConfigurationCreateStruct.html b/...sses/Ibexa-Contracts-ConnectorAi-ActionConfiguration-ActionConfigurationCreateStruct.html
@@ -38204,9 +38204,9 @@ <h1 id="ActionConfigurationCreateStruct">
 
 
     <section class="phpdocumentor-description">
-        <p>Supports readonly properties by marking them as protected.
+        <p>Supports read-only properties by marking them as protected.
 In this case they will only be writable using constructor, and need to be documented
-using property-read <type> &lt;$var&gt; annotation in class doc in addition to inline property doc.
+using <code class="prettyprint">@property-read &lt;type&gt; &lt;$var&gt;</code> annotation in class doc in addition to inline property doc.
 Writable properties must be public and must be documented inline.</p>
 
     </section>
@@ -38263,7 +38263,7 @@ <h3 id="method___construct">
 <div class="phpdocumentor-label-line">
     </div>
     <section class="phpdocumentor-description">
-        <p>Readonly properties values must be set using $properties as they are not writable anymore
+        <p>Readonly properties values must be set using <code class="prettyprint">$properties</code> as they aren't writable anymore
 after object has been created.</p>
 
     </section>
@@ -39107,11 +39107,11 @@ <h3 id="method_getProperties">
         <div class="content-header__found-in copy-to-clipboard" data-copy-value="vendor/ibexa/core/src/contracts/Repository/Values/ValueObject.php">
         <abbr title="vendor/ibexa/core/src/contracts/Repository/Values/ValueObject.php">ValueObject.php</abbr>
                 :
-        <span title="at line 50">50</span>
+        <span title="at line 51">51</span>
                 <img src="./images/copy.svg" title="Copy path" />
     </div>
         </div>
-    <p>Function where list of properties are returned.</p>
+    <p>Returns list of available properties&#039; names.</p>
 
 <div class="highlight">
     <table class="highlighttable">
@@ -39124,7 +39124,7 @@ <h3 id="method_getProperties">
                 </td>
                 <td class="code">
                     <div>
-                        <pre><code><span class="phpdocumentor-signature__visibility">protected </span><span class="phpdocumentor-signature__name">getProperties</span><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">$dynamicProperties</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code></pre>
+                        <pre><code><span class="phpdocumentor-signature__visibility">protected </span><span class="phpdocumentor-signature__name">getProperties</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">array&lt;int, string&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$dynamicProperties</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;int, string&gt;</span></code></pre>
                     </div>
                 </td>
             </tr>
@@ -39134,7 +39134,7 @@ <h3 id="method_getProperties">
 <div class="phpdocumentor-label-line">
     </div>
     <section class="phpdocumentor-description">
-        <p>Used by <abbr title="\Ibexa\Contracts\Core\Repository\Values\attributes()">attributes()</abbr>, override to add dynamic properties</p>
+        <p>Override to add dynamic properties.</p>
 
     </section>
     <h4>Parameters</h4>
@@ -39153,7 +39153,7 @@ <h4>Parameters</h4>
                         $dynamicProperties
                     </td>
                     <td>
-                        array&lt;string|int, mixed&gt;
+                        array&lt;int, string&gt;
                     </td>
                     <td>
                                                                                     []
@@ -39169,7 +39169,7 @@ <h4>Parameters</h4>
                     </tbody>
     </table>
     <h4>Return values</h4>
-    <p class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</p>
+    <p class="phpdocumentor-signature__response_type">array&lt;int, string&gt;</p>
 
                             </div>
                     </article>

diff --git a/...sses/Ibexa-Contracts-ConnectorAi-ActionConfiguration-ActionConfigurationUpdateStruct.html b/...sses/Ibexa-Contracts-ConnectorAi-ActionConfiguration-ActionConfigurationUpdateStruct.html
@@ -38204,9 +38204,9 @@ <h1 id="ActionConfigurationUpdateStruct">
 
 
     <section class="phpdocumentor-description">
-        <p>Supports readonly properties by marking them as protected.
+        <p>Supports read-only properties by marking them as protected.
 In this case they will only be writable using constructor, and need to be documented
-using property-read <type> &lt;$var&gt; annotation in class doc in addition to inline property doc.
+using <code class="prettyprint">@property-read &lt;type&gt; &lt;$var&gt;</code> annotation in class doc in addition to inline property doc.
 Writable properties must be public and must be documented inline.</p>
 
     </section>
@@ -38253,7 +38253,7 @@ <h3 id="method___construct">
                 </td>
                 <td class="code">
                     <div>
-                        <pre><code><span class="phpdocumentor-signature__visibility">public </span><span class="phpdocumentor-signature__name">__construct</span><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">$properties</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span></code></pre>
+                        <pre><code><span class="phpdocumentor-signature__visibility">public </span><span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">array&lt;string, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$properties</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span></code></pre>
                     </div>
                 </td>
             </tr>
@@ -38263,7 +38263,7 @@ <h3 id="method___construct">
 <div class="phpdocumentor-label-line">
     </div>
     <section class="phpdocumentor-description">
-        <p>Readonly properties values must be set using $properties as they are not writable anymore
+        <p>Readonly properties values must be set using <code class="prettyprint">$properties</code> as they aren't writable anymore
 after object has been created.</p>
 
     </section>
@@ -38283,7 +38283,7 @@ <h4>Parameters</h4>
                         $properties
                     </td>
                     <td>
-                        array&lt;string|int, mixed&gt;
+                        array&lt;string, mixed&gt;
                     </td>
                     <td>
                                                                                     []
@@ -39035,11 +39035,11 @@ <h3 id="method_getProperties">
         <div class="content-header__found-in copy-to-clipboard" data-copy-value="vendor/ibexa/core/src/contracts/Repository/Values/ValueObject.php">
         <abbr title="vendor/ibexa/core/src/contracts/Repository/Values/ValueObject.php">ValueObject.php</abbr>
                 :
-        <span title="at line 50">50</span>
+        <span title="at line 51">51</span>
                 <img src="./images/copy.svg" title="Copy path" />
     </div>
         </div>
-    <p>Function where list of properties are returned.</p>
+    <p>Returns list of available properties&#039; names.</p>
 
 <div class="highlight">
     <table class="highlighttable">
@@ -39052,7 +39052,7 @@ <h3 id="method_getProperties">
                 </td>
                 <td class="code">
                     <div>
-                        <pre><code><span class="phpdocumentor-signature__visibility">protected </span><span class="phpdocumentor-signature__name">getProperties</span><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">$dynamicProperties</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code></pre>
+                        <pre><code><span class="phpdocumentor-signature__visibility">protected </span><span class="phpdocumentor-signature__name">getProperties</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">array&lt;int, string&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$dynamicProperties</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;int, string&gt;</span></code></pre>
                     </div>
                 </td>
             </tr>
@@ -39062,7 +39062,7 @@ <h3 id="method_getProperties">
 <div class="phpdocumentor-label-line">
     </div>
     <section class="phpdocumentor-description">
-        <p>Used by <abbr title="\Ibexa\Contracts\Core\Repository\Values\attributes()">attributes()</abbr>, override to add dynamic properties</p>
+        <p>Override to add dynamic properties.</p>
 
     </section>
     <h4>Parameters</h4>
@@ -39081,7 +39081,7 @@ <h4>Parameters</h4>
                         $dynamicProperties
                     </td>
                     <td>
-                        array&lt;string|int, mixed&gt;
+                        array&lt;int, string&gt;
                     </td>
                     <td>
                                                                                     []
@@ -39097,7 +39097,7 @@ <h4>Parameters</h4>
                     </tbody>
     </table>
     <h4>Return values</h4>
-    <p class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</p>
+    <p class="phpdocumentor-signature__response_type">array&lt;int, string&gt;</p>
 
                             </div>
                     </article>

diff --git a/...pi/php_api_reference/classes/Ibexa-Contracts-Core-FieldType-BinaryBase-PathGenerator.html b/...pi/php_api_reference/classes/Ibexa-Contracts-Core-FieldType-BinaryBase-PathGenerator.html
@@ -38208,7 +38208,7 @@ <h1 id="PathGenerator">
             <div class="phpdocumentor-admonition">
         <svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
             <article>
-                <p>use \Ibexa\Contracts\Core\FieldType\BinaryBase\PathGeneratorInterface instead.</p>
+                <p>use <a href="classes/Ibexa-Contracts-Core-FieldType-BinaryBase-PathGeneratorInterface.html"><abbr title="\Ibexa\Contracts\Core\FieldType\BinaryBase\PathGeneratorInterface">PathGeneratorInterface</abbr></a> instead.</p>
 
             </article>
         </div>
@@ -38226,7 +38226,7 @@ <h5 class="phpdocumentor-tag-list__heading">
                 </dt>
                 <dd class="phpdocumentor-tag-list__definition">
                                                                                                              <section class="phpdocumentor-description">
-        <p>use \Ibexa\Contracts\Core\FieldType\BinaryBase\PathGeneratorInterface instead.</p>
+        <p>use <a href="classes/Ibexa-Contracts-Core-FieldType-BinaryBase-PathGeneratorInterface.html"><abbr title="\Ibexa\Contracts\Core\FieldType\BinaryBase\PathGeneratorInterface">PathGeneratorInterface</abbr></a> instead.</p>
 
     </section>
 

diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-IO-BinaryFile.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-IO-BinaryFile.html
@@ -38307,7 +38307,7 @@ <h5 class="phpdocumentor-tag-list__heading">
                 </dt>
                 <dd class="phpdocumentor-tag-list__definition">
                                                                                                              <section class="phpdocumentor-description">
-        <p>Since 5.3.3, use IO\Handler::getMimeType()</p>
+        <p>Since 5.3.3, use <abbr title="\Ibexa\Core\IO\IOServiceInterface::getMimeType()">IOServiceInterface::getMimeType()</abbr> or <abbr title="\Ibexa\Core\IO\IOMetadataHandler::getMimeType()">IOMetadataHandler::getMimeType()</abbr></p>
 
     </section>
 

diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Ibexa.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Ibexa.html
@@ -38233,7 +38233,7 @@ <h3 id="constant_VERSION">
                 </td>
                 <td class="code">
                     <div>
-                        <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.14&#039;</span></code></pre>
+                        <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.15&#039;</span></code></pre>
                     </div>
                 </td>
             </tr>

diff --git a/...p_api/php_api_reference/classes/Ibexa-Contracts-Core-Persistence-Content-ContentInfo.html b/...p_api/php_api_reference/classes/Ibexa-Contracts-Core-Persistence-Content-ContentInfo.html
@@ -38268,7 +38268,7 @@ <h5 class="phpdocumentor-tag-list__heading">
                 </dt>
                 <dd class="phpdocumentor-tag-list__definition">
                                                                                                              <section class="phpdocumentor-description">
-        <p>Use ContentInfo::STATUS_TRASHED</p>
+        <p>Use <a href="classes/Ibexa-Contracts-Core-Persistence-Content-ContentInfo.html#constant_STATUS_TRASHED"><abbr title="\Ibexa\Contracts\Core\Persistence\Content\ContentInfo::STATUS_TRASHED">ContentInfo::STATUS_TRASHED</abbr></a></p>
 
     </section>
 
@@ -38596,7 +38596,7 @@ <h5 class="phpdocumentor-tag-list__heading">
                 </dt>
                 <dd class="phpdocumentor-tag-list__definition">
                                                                                                              <section class="phpdocumentor-description">
-        <p>Use SPI\ContentInfo::$status (with value ContentInfo::STATUS_PUBLISHED)</p>
+        <p>Use <a href="classes/Ibexa-Contracts-Core-Persistence-Content-ContentInfo.html#property_status"><abbr title="\Ibexa\Contracts\Core\Persistence\Content\ContentInfo::$status">ContentInfo::$status</abbr></a> (with value <a href="classes/Ibexa-Contracts-Core-Persistence-Content-ContentInfo.html#constant_STATUS_PUBLISHED"><abbr title="\Ibexa\Contracts\Core\Persistence\Content\ContentInfo::STATUS_PUBLISHED">ContentInfo::STATUS_PUBLISHED</abbr></a>)</p>
 <p>Flag indicating if content is currently published.</p>
 
     </section>
@@ -38923,7 +38923,7 @@ <h3 id="property_status">
     </table>
 </div>
     <section class="phpdocumentor-description">
-        <p>Replaces deprecated SPI\ContentInfo::$isPublished.</p>
+        <p>Replaces deprecated <a href="classes/Ibexa-Contracts-Core-Persistence-Content-ContentInfo.html#property_isPublished"><abbr title="\Ibexa\Contracts\Core\Persistence\Content\ContentInfo::$isPublished">ContentInfo::$isPublished</abbr></a>.</p>
 
     </section>