Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Mar 10, 2022
1 parent 5854989 commit ee3a84f
Show file tree
Hide file tree
Showing 4 changed files with 79 additions and 10 deletions.
83 changes: 75 additions & 8 deletions docs/php/master/Flarum/Discussion/DiscussionRepository.html
Original file line number Diff line number Diff line change
Expand Up @@ -134,11 +134,27 @@ <h2>Methods</h2>
</div>
<div class="col-md-6 type">
<a href="#method_getReadIds">getReadIds</a>(<a href="../../Flarum/User/User.html"><abbr title="Flarum\User\User">User</abbr></a> $user)

<small><sup><span class="label label-danger">deprecated</span></sup></small>
<p>&lt;p&gt;Get the IDs of discussions which a user has read completely.&lt;/p&gt;</p> </div>
<div class="col-md-2"></div>
<div class="col-md-2 text-right" style="padding-right: 5px;">
<a href="https://github.com/flarum/core/blob/master/src/Discussion/DiscussionRepository.php#L48" target="_blank">
<a href="https://github.com/flarum/core/blob/master/src/Discussion/DiscussionRepository.php#L50" target="_blank">
<img src="../../assets/img/code.svg" height="18" />
</a>

</div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Illuminate\Database\Eloquent\Builder">Builder</abbr>
</div>
<div class="col-md-6 type">
<a href="#method_getReadIdsQuery">getReadIdsQuery</a>(<a href="../../Flarum/User/User.html"><abbr title="Flarum\User\User">User</abbr></a> $user)

<p>&lt;p&gt;Get a query containing the IDs of discussions which a user has read completely.&lt;/p&gt;</p> </div>
<div class="col-md-2"></div>
<div class="col-md-2 text-right" style="padding-right: 5px;">
<a href="https://github.com/flarum/core/blob/master/src/Discussion/DiscussionRepository.php#L62" target="_blank">
<img src="../../assets/img/code.svg" height="18" />
</a>

Expand All @@ -154,7 +170,7 @@ <h2>Methods</h2>
<p>&lt;p&gt;Scope a query to only include records that are visible to a user.&lt;/p&gt;</p> </div>
<div class="col-md-2"></div>
<div class="col-md-2 text-right" style="padding-right: 5px;">
<a href="https://github.com/flarum/core/blob/master/src/Discussion/DiscussionRepository.php#L64" target="_blank">
<a href="https://github.com/flarum/core/blob/master/src/Discussion/DiscussionRepository.php#L77" target="_blank">
<img src="../../assets/img/code.svg" height="18" />
</a>

Expand Down Expand Up @@ -253,16 +269,23 @@ <h4>Return Value</h4>
<div class="method-item">
<h3 id="method_getReadIds">
<div class="location">
at <a href="https://github.com/flarum/core/blob/master/src/Discussion/DiscussionRepository.php#L48" target="_blank">
line 48
at <a href="https://github.com/flarum/core/blob/master/src/Discussion/DiscussionRepository.php#L50" target="_blank">
line 50
</a>
</div>
<code> array
<strong>getReadIds</strong>(<a href="../../Flarum/User/User.html"><abbr title="Flarum\User\User">User</abbr></a> $user)
</code>
<small><sup><span class="label label-danger">deprecated</span></sup></small></code>
</h3>
<div class="details">

<p>
<small><sup><span class="label label-danger">deprecated</span></sup></small>
<tr>
<td>1.3</td>
<td>Use `getReadIdsQuery` instead</td>
</tr>
</p>


<div class="method-description">
Expand Down Expand Up @@ -290,15 +313,59 @@ <h4>Return Value</h4>



</div>
</div>

</div>
<div class="method-item">
<h3 id="method_getReadIdsQuery">
<div class="location">
at <a href="https://github.com/flarum/core/blob/master/src/Discussion/DiscussionRepository.php#L62" target="_blank">
line 62
</a>
</div>
<code> <abbr title="Illuminate\Database\Eloquent\Builder">Builder</abbr>
<strong>getReadIdsQuery</strong>(<a href="../../Flarum/User/User.html"><abbr title="Flarum\User\User">User</abbr></a> $user)
</code>
</h3>
<div class="details">



<div class="method-description">
<p>&lt;p&gt;Get a query containing the IDs of discussions which a user has read completely.&lt;/p&gt;</p> </div>
<div class="tags">
<h4>Parameters</h4>

<table class="table table-condensed">
<tr>
<td><a href="../../Flarum/User/User.html"><abbr title="Flarum\User\User">User</abbr></a></td>
<td>$user</td>
<td></td>
</tr>
</table>


<h4>Return Value</h4>

<table class="table table-condensed">
<tr>
<td><abbr title="Illuminate\Database\Eloquent\Builder">Builder</abbr></td>
<td></td>
</tr>
</table>



</div>
</div>

</div>
<div class="method-item">
<h3 id="method_scopeVisibleTo">
<div class="location">
at <a href="https://github.com/flarum/core/blob/master/src/Discussion/DiscussionRepository.php#L64" target="_blank">
line 64
at <a href="https://github.com/flarum/core/blob/master/src/Discussion/DiscussionRepository.php#L77" target="_blank">
line 77
</a>
</div>
<code> protected <abbr title="Illuminate\Database\Eloquent\Builder">Builder</abbr>
Expand Down
3 changes: 2 additions & 1 deletion docs/php/master/doc-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1247,7 +1247,8 @@ <h2 id="letterA">A</h2>
<dd><p>Get the ran migrations for the given extension.</p></dd><dt><a href="Flarum/Database/Migrator.html#method_getMigrationFiles"><abbr title="Flarum\Database\Migrator">Migrator</abbr>::getMigrationFiles</a>() &mdash; <em>Method in class <a href="Flarum/Database/Migrator.html"><abbr title="Flarum\Database\Migrator">Migrator</abbr></a></em></dt>
<dd><p>Get all of the migration files in a given path.</p></dd><dt><a href="Flarum/Discussion/Discussion.html#method_getModifiedPosts"><abbr title="Flarum\Discussion\Discussion">Discussion</abbr>::getModifiedPosts</a>() &mdash; <em>Method in class <a href="Flarum/Discussion/Discussion.html"><abbr title="Flarum\Discussion\Discussion">Discussion</abbr></a></em></dt>
<dd><p>Get the posts that have been modified during this request.</p></dd><dt><a href="Flarum/Discussion/DiscussionRepository.html#method_getReadIds"><abbr title="Flarum\Discussion\DiscussionRepository">DiscussionRepository</abbr>::getReadIds</a>() &mdash; <em>Method in class <a href="Flarum/Discussion/DiscussionRepository.html"><abbr title="Flarum\Discussion\DiscussionRepository">DiscussionRepository</abbr></a></em></dt>
<dd><p>Get the IDs of discussions which a user has read completely.</p></dd><dt><a href="Flarum/Discussion/Filter/DiscussionFilterer.html#method_getQuery"><abbr title="Flarum\Discussion\Filter\DiscussionFilterer">DiscussionFilterer</abbr>::getQuery</a>() &mdash; <em>Method in class <a href="Flarum/Discussion/Filter/DiscussionFilterer.html"><abbr title="Flarum\Discussion\Filter\DiscussionFilterer">DiscussionFilterer</abbr></a></em></dt>
<dd><p>Get the IDs of discussions which a user has read completely.</p></dd><dt><a href="Flarum/Discussion/DiscussionRepository.html#method_getReadIdsQuery"><abbr title="Flarum\Discussion\DiscussionRepository">DiscussionRepository</abbr>::getReadIdsQuery</a>() &mdash; <em>Method in class <a href="Flarum/Discussion/DiscussionRepository.html"><abbr title="Flarum\Discussion\DiscussionRepository">DiscussionRepository</abbr></a></em></dt>
<dd><p>Get a query containing the IDs of discussions which a user has read completely.</p></dd><dt><a href="Flarum/Discussion/Filter/DiscussionFilterer.html#method_getQuery"><abbr title="Flarum\Discussion\Filter\DiscussionFilterer">DiscussionFilterer</abbr>::getQuery</a>() &mdash; <em>Method in class <a href="Flarum/Discussion/Filter/DiscussionFilterer.html"><abbr title="Flarum\Discussion\Filter\DiscussionFilterer">DiscussionFilterer</abbr></a></em></dt>
<dd></dd><dt><a href="Flarum/Discussion/Query/AuthorFilterGambit.html#method_getGambitPattern"><abbr title="Flarum\Discussion\Query\AuthorFilterGambit">AuthorFilterGambit</abbr>::getGambitPattern</a>() &mdash; <em>Method in class <a href="Flarum/Discussion/Query/AuthorFilterGambit.html"><abbr title="Flarum\Discussion\Query\AuthorFilterGambit">AuthorFilterGambit</abbr></a></em></dt>
<dd><p>The regex pattern to match the bit against.</p></dd><dt><a href="Flarum/Discussion/Query/AuthorFilterGambit.html#method_getFilterKey"><abbr title="Flarum\Discussion\Query\AuthorFilterGambit">AuthorFilterGambit</abbr>::getFilterKey</a>() &mdash; <em>Method in class <a href="Flarum/Discussion/Query/AuthorFilterGambit.html"><abbr title="Flarum\Discussion\Query\AuthorFilterGambit">AuthorFilterGambit</abbr></a></em></dt>
<dd><p>This filter will only be run when a query contains a filter param with this key.</p></dd><dt><a href="Flarum/Discussion/Query/CreatedFilterGambit.html#method_getGambitPattern"><abbr title="Flarum\Discussion\Query\CreatedFilterGambit">CreatedFilterGambit</abbr>::getGambitPattern</a>() &mdash; <em>Method in class <a href="Flarum/Discussion/Query/CreatedFilterGambit.html"><abbr title="Flarum\Discussion\Query\CreatedFilterGambit">CreatedFilterGambit</abbr></a></em></dt>
Expand Down
2 changes: 1 addition & 1 deletion docs/php/master/renderer.index

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/php/master/sami.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit ee3a84f

Please sign in to comment.