Skip to content

Commit

Permalink
rebuild docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@danharrin
danharrin committed Jan 27, 2025
1 parent 31a9be2 commit b540ece
Show file tree
Hide file tree
Showing 5 changed files with 3 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/dist/3.x/actions/prebuilt-actions/export/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1349,7 +1349,7 @@ <h3 id="customizing-the-export-job-batch-name"><a class="heading-anchor" href="#
}
</textarea></code></pre>
<h2 id="authorization"><a class="heading-anchor" href="#authorization"><span class="heading-anchor-icon" aria-hidden="true">#</span></a>Authorization</h2>
<p>By default, only the user who started the export may download files that get generated. If you&#39;d like to customize the authorization logic, you may create an <code>ExportPolicy</code> class, and <a href="https://laravel.com/docs/10.x/authorization#registering-policies">register it in your <code>AuthServiceProvider</code></a>:</p>
<p>By default, only the user who started the export may download files that get generated. If you&#39;d like to customize the authorization logic, you may create an <code>ExportPolicy</code> class, and <a href="https://laravel.com/docs/authorization#registering-policies">register it in your <code>AuthServiceProvider</code></a>:</p>
<pre class="torchlight" style="background-color: #292D3E; --theme-selection-background: #00000080;" data-torchlight-processed="3449c9e5e332f1dbb81505cd739fbf3f"><code class="language-php"><!-- Syntax highlighted by torchlight.dev --><div class='line'><span style="color: #F78C6C;">use</span><span style="color: #FFCB6B;"> </span><span style="color: #A6ACCD;">App</span><span style="color: #89DDFF;">\</span><span style="color: #A6ACCD;">Policies</span><span style="color: #89DDFF;">\</span><span style="color: #A6ACCD;">ExportPolicy</span><span style="color: #89DDFF;">;</span></div><div class='line'><span style="color: #F78C6C;">use</span><span style="color: #FFCB6B;"> </span><span style="color: #A6ACCD;">Filament</span><span style="color: #89DDFF;">\</span><span style="color: #A6ACCD;">Actions</span><span style="color: #89DDFF;">\</span><span style="color: #A6ACCD;">Exports</span><span style="color: #89DDFF;">\</span><span style="color: #A6ACCD;">Models</span><span style="color: #89DDFF;">\</span><span style="color: #A6ACCD;">Export</span><span style="color: #89DDFF;">;</span></div><div class='line'>&nbsp;</div><div class='line'><span style="color: #C792EA;">protected</span><span style="color: #A6ACCD;"> </span><span style="color: #89DDFF;">$</span><span style="color: #A6ACCD;">policies </span><span style="color: #89DDFF;">=</span><span style="color: #A6ACCD;"> </span><span style="color: #89DDFF;">[</span></div><div class='line'><span style="color: #A6ACCD;"> </span><span style="color: #FFCB6B;">Export</span><span style="color: #89DDFF;">::</span><span style="color: #F78C6C;">class</span><span style="color: #A6ACCD;"> </span><span style="color: #89DDFF;">=&gt;</span><span style="color: #A6ACCD;"> </span><span style="color: #FFCB6B;">ExportPolicy</span><span style="color: #89DDFF;">::</span><span style="color: #F78C6C;">class</span><span style="color: #89DDFF;">,</span></div><div class='line'><span style="color: #89DDFF;">];</span></div><textarea data-torchlight-original="true" style="display: none !important;">use App\Policies\ExportPolicy;
use Filament\Actions\Exports\Models\Export;

Expand Down
2 changes: 1 addition & 1 deletion docs/dist/3.x/actions/prebuilt-actions/import/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1476,7 +1476,7 @@ <h2 id="lifecycle-hooks"><a class="heading-anchor" href="#lifecycle-hooks"><span
<p>Inside these hooks, you can access the current row&#39;s data using <code>$this-&gt;data</code>. You can also access the original row of data from the CSV, before it was <a href="#casting-state">cast</a> or mapped, using <code>$this-&gt;originalData</code>.</p>
<p>The current record (if it exists yet) is accessible in <code>$this-&gt;record</code>, and the <a href="#using-import-options">import form options</a> using <code>$this-&gt;options</code>.</p>
<h2 id="authorization"><a class="heading-anchor" href="#authorization"><span class="heading-anchor-icon" aria-hidden="true">#</span></a>Authorization</h2>
<p>By default, only the user who started the import may access the failure CSV file that gets generated if part of an import fails. If you&#39;d like to customize the authorization logic, you may create an <code>ImportPolicy</code> class, and <a href="https://laravel.com/docs/10.x/authorization#registering-policies">register it in your <code>AuthServiceProvider</code></a>:</p>
<p>By default, only the user who started the import may access the failure CSV file that gets generated if part of an import fails. If you&#39;d like to customize the authorization logic, you may create an <code>ImportPolicy</code> class, and <a href="https://laravel.com/docs/authorization#registering-policies">register it in your <code>AuthServiceProvider</code></a>:</p>
<pre class="torchlight" style="background-color: #292D3E; --theme-selection-background: #00000080;" data-torchlight-processed="3449c9e5e332f1dbb81505cd739fbf3f"><code class="language-php"><!-- Syntax highlighted by torchlight.dev --><div class='line'><span style="color: #F78C6C;">use</span><span style="color: #FFCB6B;"> </span><span style="color: #A6ACCD;">App</span><span style="color: #89DDFF;">\</span><span style="color: #A6ACCD;">Policies</span><span style="color: #89DDFF;">\</span><span style="color: #A6ACCD;">ImportPolicy</span><span style="color: #89DDFF;">;</span></div><div class='line'><span style="color: #F78C6C;">use</span><span style="color: #FFCB6B;"> </span><span style="color: #A6ACCD;">Filament</span><span style="color: #89DDFF;">\</span><span style="color: #A6ACCD;">Actions</span><span style="color: #89DDFF;">\</span><span style="color: #A6ACCD;">Imports</span><span style="color: #89DDFF;">\</span><span style="color: #A6ACCD;">Models</span><span style="color: #89DDFF;">\</span><span style="color: #A6ACCD;">Import</span><span style="color: #89DDFF;">;</span></div><div class='line'>&nbsp;</div><div class='line'><span style="color: #C792EA;">protected</span><span style="color: #A6ACCD;"> </span><span style="color: #89DDFF;">$</span><span style="color: #A6ACCD;">policies </span><span style="color: #89DDFF;">=</span><span style="color: #A6ACCD;"> </span><span style="color: #89DDFF;">[</span></div><div class='line'><span style="color: #A6ACCD;"> </span><span style="color: #FFCB6B;">Import</span><span style="color: #89DDFF;">::</span><span style="color: #F78C6C;">class</span><span style="color: #A6ACCD;"> </span><span style="color: #89DDFF;">=&gt;</span><span style="color: #A6ACCD;"> </span><span style="color: #FFCB6B;">ImportPolicy</span><span style="color: #89DDFF;">::</span><span style="color: #F78C6C;">class</span><span style="color: #89DDFF;">,</span></div><div class='line'><span style="color: #89DDFF;">];</span></div><textarea data-torchlight-original="true" style="display: none !important;">use App\Policies\ImportPolicy;
use Filament\Actions\Imports\Models\Import;

Expand Down
2 changes: 1 addition & 1 deletion docs/dist/3.x/panels/installation/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1033,7 +1033,7 @@ <h3 id="optimizing-your-laravel-app"><a class="heading-anchor" href="#optimizing
<p>You should also consider optimizing your Laravel app for production by running <code>php artisan optimize</code> in your deployment script. This will cache the configuration files and routes.</p>
<h2 id="deploying-to-production"><a class="heading-anchor" href="#deploying-to-production"><span class="heading-anchor-icon" aria-hidden="true">#</span></a>Deploying to production</h2>
<h3 id="allowing-users-to-access-a-panel"><a class="heading-anchor" href="#allowing-users-to-access-a-panel"><span class="heading-anchor-icon" aria-hidden="true">#</span></a>Allowing users to access a panel</h3>
<p>By default, all <code>User</code> models can access Filament locally. However, when deploying to production, you must update your <code>App\Models\User.php</code> to implement the <code>FilamentUser</code> contract — ensuring that only the correct users can access your panel:</p>
<p>By default, all <code>User</code> models can access Filament locally. However, when deploying to production or running unit tests, you must update your <code>App\Models\User.php</code> to implement the <code>FilamentUser</code> contract — ensuring that only the correct users can access your panel:</p>
<pre class="torchlight" style="background-color: #292D3E; --theme-selection-background: #00000080;" data-torchlight-processed="3449c9e5e332f1dbb81505cd739fbf3f"><code class="language-php"><!-- Syntax highlighted by torchlight.dev --><div class='line'><span style="color: #89DDFF;">&lt;?php</span></div><div class='line'>&nbsp;</div><div class='line'><span style="color: #F78C6C;">namespace</span><span style="color: #A6ACCD;"> </span><span style="color: #FFCB6B;">App</span><span style="color: #89DDFF;">\</span><span style="color: #FFCB6B;">Models</span><span style="color: #89DDFF;">;</span></div><div class='line'>&nbsp;</div><div class='line'><span style="color: #F78C6C;">use</span><span style="color: #FFCB6B;"> </span><span style="color: #A6ACCD;">Filament</span><span style="color: #89DDFF;">\</span><span style="color: #A6ACCD;">Models</span><span style="color: #89DDFF;">\</span><span style="color: #A6ACCD;">Contracts</span><span style="color: #89DDFF;">\</span><span style="color: #A6ACCD;">FilamentUser</span><span style="color: #89DDFF;">;</span></div><div class='line'><span style="color: #F78C6C;">use</span><span style="color: #FFCB6B;"> </span><span style="color: #A6ACCD;">Filament</span><span style="color: #89DDFF;">\</span><span style="color: #A6ACCD;">Panel</span><span style="color: #89DDFF;">;</span></div><div class='line'><span style="color: #F78C6C;">use</span><span style="color: #FFCB6B;"> </span><span style="color: #A6ACCD;">Illuminate</span><span style="color: #89DDFF;">\</span><span style="color: #A6ACCD;">Foundation</span><span style="color: #89DDFF;">\</span><span style="color: #A6ACCD;">Auth</span><span style="color: #89DDFF;">\</span><span style="color: #A6ACCD;">User</span><span style="color: #FFCB6B;"> </span><span style="color: #F78C6C;">as</span><span style="color: #FFCB6B;"> Authenticatable</span><span style="color: #89DDFF;">;</span></div><div class='line'>&nbsp;</div><div class='line'><span style="color: #C792EA;">class</span><span style="color: #A6ACCD;"> </span><span style="color: #FFCB6B;">User</span><span style="color: #A6ACCD;"> </span><span style="color: #C792EA;">extends</span><span style="color: #A6ACCD;"> </span><span style="color: #FFCB6B;">Authenticatable</span><span style="color: #A6ACCD;"> </span><span style="color: #C792EA;">implements</span><span style="color: #A6ACCD;"> </span><span style="color: #FFCB6B;">FilamentUser</span></div><div class='line'><span style="color: #89DDFF;">{</span></div><div class='line'><span style="color: #89DDFF;"> </span><span style="color: #676E95;">// ...</span></div><div class='line'>&nbsp;</div><div class='line'><span style="color: #A6ACCD;"> </span><span style="color: #C792EA;">public</span><span style="color: #A6ACCD;"> </span><span style="color: #C792EA;">function</span><span style="color: #A6ACCD;"> </span><span style="color: #82AAFF;">canAccessPanel</span><span style="color: #89DDFF;">(</span><span style="color: #FFCB6B;">Panel</span><span style="color: #A6ACCD;"> </span><span style="color: #89DDFF;">$</span><span style="color: #A6ACCD;">panel</span><span style="color: #89DDFF;">):</span><span style="color: #A6ACCD;"> </span><span style="color: #F78C6C;">bool</span></div><div class='line'><span style="color: #A6ACCD;"> </span><span style="color: #89DDFF;">{</span></div><div class='line'><span style="color: #A6ACCD;"> </span><span style="color: #89DDFF;">return</span><span style="color: #A6ACCD;"> </span><span style="color: #82AAFF;">str_ends_with</span><span style="color: #89DDFF;">($this-&gt;</span><span style="color: #A6ACCD;">email</span><span style="color: #89DDFF;">,</span><span style="color: #A6ACCD;"> </span><span style="color: #89DDFF;">&#39;</span><span style="color: #C3E88D;">@yourdomain.com</span><span style="color: #89DDFF;">&#39;</span><span style="color: #89DDFF;">)</span><span style="color: #A6ACCD;"> </span><span style="color: #89DDFF;">&amp;&amp;</span><span style="color: #A6ACCD;"> </span><span style="color: #89DDFF;">$this-&gt;</span><span style="color: #82AAFF;">hasVerifiedEmail</span><span style="color: #89DDFF;">();</span></div><div class='line'><span style="color: #A6ACCD;"> </span><span style="color: #89DDFF;">}</span></div><div class='line'><span style="color: #89DDFF;">}</span></div><textarea data-torchlight-original="true" style="display: none !important;">&lt;?php

namespace App\Models;
Expand Down
4 changes: 0 additions & 4 deletions docs/dist/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1038,10 +1038,6 @@ <h3 class="text-2xl md:text-3xl text-center font-medium dark:text-white">
<img src="https://github.com/filamentphp/filament/assets/41773797/2e253117-8308-4f5f-9081-aaed455a508f" alt="Agiledrop" class="block rounded-xl">
</a>

<a href="https://autoload.dev/?ref=filament" target="_blank" class="block my-auto">
<img src="https://github.com/user-attachments/assets/f6877c33-b20b-4dd7-9536-df8923216c9a" alt="Autoload" class="block rounded-xl">
</a>

<a href="https://borah.digital/?ref=filament" target="_blank" class="block my-auto">
<img src="https://github.com/user-attachments/assets/e055a138-e9bd-4ac3-a5ee-a3af4db05260" alt="Borah" class="block rounded-xl">
</a>
Expand Down
4 changes: 0 additions & 4 deletions docs/src/components/Hero.astro
View file
Original file line number Diff line number Diff line change
Expand Up @@ -773,10 +773,6 @@ const { getStartedLink } = Astro.props
<img src="https://github.com/filamentphp/filament/assets/41773797/2e253117-8308-4f5f-9081-aaed455a508f" alt="Agiledrop" class="block rounded-xl">
</a>

<a href="https://autoload.dev/?ref=filament" target="_blank" class="block my-auto">
<img src="https://github.com/user-attachments/assets/f6877c33-b20b-4dd7-9536-df8923216c9a" alt="Autoload" class="block rounded-xl">
</a>

<a href="https://borah.digital/?ref=filament" target="_blank" class="block my-auto">
<img src="https://github.com/user-attachments/assets/e055a138-e9bd-4ac3-a5ee-a3af4db05260" alt="Borah" class="block rounded-xl">
</a>
Expand Down

0 comments on commit b540ece

Please sign in to comment.