Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TMP] Enhance PHPDoc #2583

Draft
wants to merge 14 commits into
base: 4.6
Choose a base branch
from
Draft

[TMP] Enhance PHPDoc #2583

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
177c2d8
Generate PHP API Ref HTML
adriendupuis Dec 19, 2024
f6f0894
Get #2584 enhancements
adriendupuis Dec 20, 2024
9516d43
Generate PHP API Ref HTML
adriendupuis Dec 20, 2024
723b0ce
Generate PHP API Ref HTML
adriendupuis Dec 20, 2024
b1727c7
Generate PHP API Ref HTML
adriendupuis Dec 22, 2024
bd2f142
Merge branch '4.6' into tmp-enh-phpdoc
adriendupuis Jan 6, 2025
e0fc44e
Generate PHP API Ref HTML
adriendupuis Jan 6, 2025
0ca08e8
reset PHP API Ref from 4.6
adriendupuis Feb 3, 2025
87ab607
Update changes from ibexa/core#463
adriendupuis Feb 3, 2025
6555a38
Merge remote-tracking branch 'origin/4.6' into tmp-enh-phpdoc
adriendupuis Feb 3, 2025
9cfe271
Update changes from ibexa/core#463
adriendupuis Feb 4, 2025
88b0645
Update changes from ibexa/core#463
adriendupuis Feb 4, 2025
b693d5b
Merge branch '4.6' into tmp-enh-phpdoc
adriendupuis Feb 12, 2025
ab9536d
Generate PHP API Ref HTML
adriendupuis Feb 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Generate PHP API Ref HTML
  • Loading branch information
@adriendupuis
adriendupuis committed Dec 20, 2024
commit 723b0ce75e2baf74404fc4bd105d56ba2301af99
10 changes: 5 additions & 5 deletions ...pi/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Limitation-TargetAwareType.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37344,7 +37344,7 @@ <h3 id="method_buildValue">
</td>
<td class="code">
<div>
<pre><code><span class="phpdocumentor-signature__visibility">public </span><span class="phpdocumentor-signature__name">buildValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$limitationValues</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/Ibexa-Contracts-Core-Repository-Values-User-Limitation.html"><abbr title="\Ibexa\Contracts\Core\Repository\Values\User\Limitation">Limitation</abbr></a></span></code></pre>
<pre><code><span class="phpdocumentor-signature__visibility">public </span><span class="phpdocumentor-signature__name">buildValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$limitationValues</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/Ibexa-Contracts-Core-Repository-Values-User-Limitation.html"><abbr title="\Ibexa\Contracts\Core\Repository\Values\User\Limitation">Limitation</abbr></a></span></code></pre>
</div>
</td>
</tr>
Expand All @@ -37354,7 +37354,7 @@ <h3 id="method_buildValue">
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description">
<p>The is the method to create values as Limitation type needs value knowledge anyway in acceptValue,
<p>This is the method to create values as Limitation type needs value knowledge anyway in acceptValue,
the reverse relation is provided by means of identifier lookup (Value has identifier, and so does RoleService).</p>

</section>
Expand All @@ -37374,7 +37374,7 @@ <h4>Parameters</h4>
$limitationValues
</td>
<td>
array&lt;string|int, mixed&gt;
array&lt;int, mixed&gt;
</td>
<td class="empty">
-
Expand Down Expand Up @@ -37655,7 +37655,7 @@ <h3 id="method_validate">
</td>
<td class="code">
<div>
<pre><code><span class="phpdocumentor-signature__visibility">public </span><span class="phpdocumentor-signature__name">validate</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Ibexa-Contracts-Core-Repository-Values-User-Limitation.html"><abbr title="\Ibexa\Contracts\Core\Repository\Values\User\Limitation">Limitation</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$limitationValue</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, <a href="classes/Ibexa-Contracts-Core-FieldType-ValidationError.html"><abbr title="\Ibexa\Contracts\Core\FieldType\ValidationError">ValidationError</abbr></a>&gt;</span></code></pre>
<pre><code><span class="phpdocumentor-signature__visibility">public </span><span class="phpdocumentor-signature__name">validate</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Ibexa-Contracts-Core-Repository-Values-User-Limitation.html"><abbr title="\Ibexa\Contracts\Core\Repository\Values\User\Limitation">Limitation</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$limitationValue</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;int, <a href="classes/Ibexa-Contracts-Core-FieldType-ValidationError.html"><abbr title="\Ibexa\Contracts\Core\FieldType\ValidationError">ValidationError</abbr></a>&gt;</span></code></pre>
</div>
</td>
</tr>
Expand Down Expand Up @@ -37696,7 +37696,7 @@ <h4>Parameters</h4>
</tbody>
</table>
<h4>Return values</h4>
<p class="phpdocumentor-signature__response_type">array&lt;string|int, <a href="classes/Ibexa-Contracts-Core-FieldType-ValidationError.html"><abbr title="\Ibexa\Contracts\Core\FieldType\ValidationError">ValidationError</abbr></a>&gt;</p>
<p class="phpdocumentor-signature__response_type">array&lt;int, <a href="classes/Ibexa-Contracts-Core-FieldType-ValidationError.html"><abbr title="\Ibexa\Contracts\Core\FieldType\ValidationError">ValidationError</abbr></a>&gt;</p>

<div class="content-header">
<h3 id="method_valueSchema">
Expand Down
14 changes: 7 additions & 7 deletions docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Limitation-Type.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37323,7 +37323,7 @@ <h3 id="method_buildValue">
</td>
<td class="code">
<div>
<pre><code><span class="phpdocumentor-signature__visibility">public </span><span class="phpdocumentor-signature__name">buildValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$limitationValues</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/Ibexa-Contracts-Core-Repository-Values-User-Limitation.html"><abbr title="\Ibexa\Contracts\Core\Repository\Values\User\Limitation">Limitation</abbr></a></span></code></pre>
<pre><code><span class="phpdocumentor-signature__visibility">public </span><span class="phpdocumentor-signature__name">buildValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$limitationValues</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/Ibexa-Contracts-Core-Repository-Values-User-Limitation.html"><abbr title="\Ibexa\Contracts\Core\Repository\Values\User\Limitation">Limitation</abbr></a></span></code></pre>
</div>
</td>
</tr>
Expand All @@ -37333,7 +37333,7 @@ <h3 id="method_buildValue">
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description">
<p>The is the method to create values as Limitation type needs value knowledge anyway in acceptValue,
<p>This is the method to create values as Limitation type needs value knowledge anyway in acceptValue,
the reverse relation is provided by means of identifier lookup (Value has identifier, and so does RoleService).</p>

</section>
Expand All @@ -37353,7 +37353,7 @@ <h4>Parameters</h4>
$limitationValues
</td>
<td>
array&lt;string|int, mixed&gt;
array&lt;int, mixed&gt;
</td>
<td class="empty">
-
Expand Down Expand Up @@ -37392,7 +37392,7 @@ <h3 id="method_evaluate">
</td>
<td class="code">
<div>
<pre><code><span class="phpdocumentor-signature__visibility">public </span><span class="phpdocumentor-signature__name">evaluate</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Ibexa-Contracts-Core-Repository-Values-User-Limitation.html"><abbr title="\Ibexa\Contracts\Core\Repository\Values\User\Limitation">Limitation</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Ibexa-Contracts-Core-Repository-Values-User-UserReference.html"><abbr title="\Ibexa\Contracts\Core\Repository\Values\User\UserReference">UserReference</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$currentUser</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Ibexa-Contracts-Core-Repository-Values-ValueObject.html"><abbr title="\Ibexa\Contracts\Core\Repository\Values\ValueObject">ValueObject</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$object</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, <a href="classes/Ibexa-Contracts-Core-Repository-Values-ValueObject.html"><abbr title="\Ibexa\Contracts\Core\Repository\Values\ValueObject">ValueObject</abbr></a>&gt;|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$targets</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|null</span></code></pre>
<pre><code><span class="phpdocumentor-signature__visibility">public </span><span class="phpdocumentor-signature__name">evaluate</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Ibexa-Contracts-Core-Repository-Values-User-Limitation.html"><abbr title="\Ibexa\Contracts\Core\Repository\Values\User\Limitation">Limitation</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Ibexa-Contracts-Core-Repository-Values-User-UserReference.html"><abbr title="\Ibexa\Contracts\Core\Repository\Values\User\UserReference">UserReference</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$currentUser</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Ibexa-Contracts-Core-Repository-Values-ValueObject.html"><abbr title="\Ibexa\Contracts\Core\Repository\Values\ValueObject">ValueObject</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$object</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;int, <a href="classes/Ibexa-Contracts-Core-Repository-Values-ValueObject.html"><abbr title="\Ibexa\Contracts\Core\Repository\Values\ValueObject">ValueObject</abbr></a>&gt;|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$targets</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|null</span></code></pre>
</div>
</td>
</tr>
Expand Down Expand Up @@ -37459,7 +37459,7 @@ <h4>Parameters</h4>
$targets
</td>
<td>
array&lt;string|int, <a href="classes/Ibexa-Contracts-Core-Repository-Values-ValueObject.html"><abbr title="\Ibexa\Contracts\Core\Repository\Values\ValueObject">ValueObject</abbr></a>&gt;|null
array&lt;int, <a href="classes/Ibexa-Contracts-Core-Repository-Values-ValueObject.html"><abbr title="\Ibexa\Contracts\Core\Repository\Values\ValueObject">ValueObject</abbr></a>&gt;|null
</td>
<td>
null
Expand Down Expand Up @@ -37637,7 +37637,7 @@ <h3 id="method_validate">
</td>
<td class="code">
<div>
<pre><code><span class="phpdocumentor-signature__visibility">public </span><span class="phpdocumentor-signature__name">validate</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Ibexa-Contracts-Core-Repository-Values-User-Limitation.html"><abbr title="\Ibexa\Contracts\Core\Repository\Values\User\Limitation">Limitation</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$limitationValue</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, <a href="classes/Ibexa-Contracts-Core-FieldType-ValidationError.html"><abbr title="\Ibexa\Contracts\Core\FieldType\ValidationError">ValidationError</abbr></a>&gt;</span></code></pre>
<pre><code><span class="phpdocumentor-signature__visibility">public </span><span class="phpdocumentor-signature__name">validate</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Ibexa-Contracts-Core-Repository-Values-User-Limitation.html"><abbr title="\Ibexa\Contracts\Core\Repository\Values\User\Limitation">Limitation</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$limitationValue</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;int, <a href="classes/Ibexa-Contracts-Core-FieldType-ValidationError.html"><abbr title="\Ibexa\Contracts\Core\FieldType\ValidationError">ValidationError</abbr></a>&gt;</span></code></pre>
</div>
</td>
</tr>
Expand Down Expand Up @@ -37678,7 +37678,7 @@ <h4>Parameters</h4>
</tbody>
</table>
<h4>Return values</h4>
<p class="phpdocumentor-signature__response_type">array&lt;string|int, <a href="classes/Ibexa-Contracts-Core-FieldType-ValidationError.html"><abbr title="\Ibexa\Contracts\Core\FieldType\ValidationError">ValidationError</abbr></a>&gt;</p>
<p class="phpdocumentor-signature__response_type">array&lt;int, <a href="classes/Ibexa-Contracts-Core-FieldType-ValidationError.html"><abbr title="\Ibexa\Contracts\Core\FieldType\ValidationError">ValidationError</abbr></a>&gt;</p>

<div class="content-header">
<h3 id="method_valueSchema">
Expand Down
Loading