1import{_ as p,c as i,a as s,b as a,w as e,d as o,r as l,o as c,e as t}from"./app-ChViQP5P.js";const r={},u=s("h1",{id:"views",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#views"},[s("span",null,"Views")])],-1),d={class:"table-of-contents"},v=o(`<h2 id="introduction" tabindex="-1"><a class="header-anchor" href="#introduction"><span>Introduction</span></a></h2><p>Of course, it's not practical to return entire HTML documents strings directly from your routes and controllers. Thankfully, views provide a convenient way to place all of our HTML in separate files.</p><p>Views separate your controller / application logic from your presentation logic and are stored in the <code>resources/views</code> directory.</p><p>When using Hypervel, view templates are usually written using the <a href="/docs/blade">Blade templating language</a>. A simple view might look something like this:</p><div class="language-html line-numbers-mode" data-highlighter="prismjs" data-ext="html" data-title="html"><pre><code><span class="line"><span class="token comment"><!-- View stored in resources/views/greeting.blade.php --></span></span> 2<span class="line"></span> 3<span class="line"><span class="token tag"><span class="token tag"><span class="token punctuation"><</span>html</span><span class="token punctuation">></span></span></span> 4<span class="line"> <span class="token tag"><span class="token tag"><span class="token punctuation"><</span>body</span><span class="token punctuation">></span></span></span> 5<span class="line"> <span class="token tag"><span class="token tag"><span class="token punctuation"><</span>h1</span><span class="token punctuation">></span></span>Hello, {{ $name }}<span class="token tag"><span class="token tag"><span class="token punctuation"></</span>h1</span><span class="token punctuation">></span></span></span> 6<span class="line"> <span class="token tag"><span class="token tag"><span class="token punctuation"></</span>body</span><span class="token punctuation">></span></span></span> 7<span class="line"><span class="token tag"><span class="token tag"><span class="token punctuation"></</span>html</span><span class="token punctuation">></span></span></span> 8<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>Since this view is stored at <code>resources/views/greeting.blade.php</code>, we may return it using the global <code>view</code> helper like so:</p><div class="language-php line-numbers-mode" data-highlighter="prismjs" data-ext="php" data-title="php"><pre><code><span class="line"><span class="token class-name static-context">Route</span><span class="token operator">::</span><span class="token function">get</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'/'</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span></span> 9<span class="line"> <span class="token keyword">return</span> <span class="token function">view</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'greeting'</span><span class="token punctuation">,</span> <span class="token punctuation">[</span><span class="token string single-quoted-string">'name'</span> <span class="token operator">=></span> <span class="token string single-quoted-string">'James'</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span></span> 10<span class="line"><span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span></span> 11<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><div class="hint-container note"><p class="hint-container-title">Note</p><p>Looking for more information on how to write Blade templates? Check out the full <a href="/docs/blade">Blade documentation</a> to get started.</p></div><h2 id="creating-and-rendering-views" tabindex="-1"><a class="header-anchor" href="#creating-and-rendering-views"><span>Creating and Rendering Views</span></a></h2><p>You may create a view by placing a file with the <code>.blade.php</code> extension in your application's <code>resources/views</code> directory.</p><p>The <code>.blade.php</code> extension informs the framework that the file contains a <a href="/docs/blade">Blade template</a>. Blade templates contain HTML as well as Blade directives that allow you to easily echo values, create "if" statements, iterate over data, and more.</p><p>Once you have created a view, you may return it from one of your application's routes or controllers using the global <code>view</code> helper:</p><div class="language-php line-numbers-mode" data-highlighter="prismjs" data-ext="php" data-title="php"><pre><code><span class="line"><span class="token class-name static-context">Route</span><span class="token operator">::</span><span class="token function">
11get</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'/'</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span></span> 12<span class="line"> <span class="token keyword">return</span> <span class="token function">view</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'greeting'</span><span class="token punctuation">,</span> <span class="token punctuation">[</span><span class="token string single-quoted-string">'name'</span> <span class="token operator">=></span> <span class="token string single-quoted-string">'James'</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span></span> 13<span class="line"><span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span></span> 14<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>Views may also be returned using the <code>View</code> facade:</p><div class="language-php line-numbers-mode" data-highlighter="prismjs" data-ext="php" data-title="php"><pre><code><span class="line"><span class="token keyword">
14use</span> <span class="token package">Hypervel<span class="token punctuation">\\</span>Support<span class="token punctuation">\\</span>Facades<span class="token punctuation">\\</span>View</span><span class="token punctuation">;</span></span> 15<span class="line"></span> 16<span class="line"><span class="token keyword">return</span> <span class="token class-name static-context">View</span><span class="token operator">::</span><span class="token function">make</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'greeting'</span><span class="token punctuation">,</span> <span class="token punctuation">[</span><span class="token string single-quoted-string">'name'</span> <span class="token operator">=></span> <span class="token string single-quoted-string">'James'</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span></span> 17<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>As you can see, the first argument passed to the <code>view</code> helper corresponds to the name of the view file in the <code>resources/views</code> directory. The second argument is an array of data that should be made available to the view. In this case, we are passing the <code>name</code> variable, which is displayed in the view using <a href="/docs/blade">Blade syntax</a>.</p><h3 id="nested-view-directories" tabindex="-1"><a class="header-anchor" href="#nested-view-directories"><span>Nested View Directories</span></a></h3><p>Views may also be nested within subdirectories of the <code>resources/views</code> directory. "Dot" notation may be used to reference nested views. For example, if your view is stored at <code>resources/views/admin/profile.blade.php</code>, you may return it from one of your application's routes / controllers like so:</p><div class="language-php line-numbers-mode" data-highlighter="prismjs" data-ext="php" data-title="php"><pre><code><span class="line"><span class="token keyword">return</span> <span class="token function">view</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'admin.profile'</span><span class="token punctuation">,</span> <span class="token variable">$data</span><span class="token punctuation">)</span><span class="token punctuation">;</span></span> 18<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="hint-container warning"><p class="hint-container-title">Warning</p><p>View directory names should not contain the <code>.</code> character.</p></div><h3 id="creating-the-first-available-view" tabindex="-1"><a class="header-anchor" href="#creating-the-first-available-view"><span>Creating the First Available View</span></a></h3><p>Using the <code>View</code> facade's <code>first</code> method, you may create the first view that exists in a given array of views. This may be useful if your application or package allows views to be customized or overwritten:</p><div class="language-php line-numbers-mode" data-highlighter="prismjs" data-ext="php" data-title="php"><pre><code><span class="line"><span class="token keyword">
18use</span> <span class="token package">Hypervel<span class="token punctuation">\\</span>Support<span class="token punctuation">\\</span>Facades<span class="token punctuation">\\</span>View</span><span class="token punctuation">;</span></span> 19<span class="line"></span> 20<span class="line"><span class="token keyword">return</span> <span class="token class-name static-context">View</span><span class="token operator">::</span><span class="token function">first</span><span class="token punctuation">(</span><span class="token punctuation">[</span><span class="token string single-quoted-string">'custom.admin'</span><span class="token punctuation">,</span> <span class="token string single-quoted-string">'admin'</span><span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token variable">$data</span><span class="token punctuation">)</span><span class="token punctuation">;</span></span> 21<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><a name="determining-if-a-view-exists"></a></p><h3 id="determining-if-a-view-exists" tabindex="-1"><a class="header-anchor" href="#determining-if-a-view-exists"><span>Determining if a View Exists</span></a></h3><p>If you need to determine if a view exists, you may use the <code>View</code> facade. The <code>exists</code> method will return <code>true</code> if the view exists:</p><div class="language-php line-numbers-mode" data-highlighter="prismjs" data-ext="php" data-title="php"><pre><code><span class="line"><span class="token keyword">
21use</span> <span class="token package">Hypervel<span class="token punctuation">\\</span>Support<span class="token punctuation">\\</span>Facades<span class="token punctuation">\\</span>View</span><span class="token punctuation">;</span></span> 22<span class="line"></span> 23<span class="line"><span class="token keyword">if</span> <span class="token punctuation">(</span><span class="token class-name static-context">View</span><span class="token operator">::</span><span class="token function">exists</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'admin.profile'</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">{</span></span> 24<span class="line"> <span class="token comment">// ...</span></span> 25<span class="line"><span class="token punctuation">}</span></span> 26<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h2 id="passing-data-to-views" tabindex="-1"><a class="header-anchor" href="#passing-data-to-views"><span>Passing Data to Views</span></a></h2><p>As you saw in the previous examples, you may pass an array of data to views to make that data available to the view:</p><div class="language-php line-numbers-mode" data-highlighter="prismjs" data-ext="php" data-title="php"><pre><code><span class="line"><span class="token keyword">return</span> <span class="token function">view</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'greetings'</span><span class="token punctuation">,</span> <span class="token punctuation">[</span><span class="token string single-quoted-string">'name'</span> <span class="token operator">=></span> <span class="token string single-quoted-string">'Victoria'</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span></span> 27<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>When passing information in this manner, the data should be an array with key / value pairs. After providing data to a view, you can then access each value within your view using the data's keys, such as <code><?php echo $name; ?></code>.</p><p>As an alternative to passing a complete array of data to the <code>view</code> helper function, you may use the <code>with</code> method to add individual pieces of data to the view. The <code>with</code> method returns an instance of the view object so that you can continue chaining methods before returning the view:</p><div class="language-php line-numbers-mode" data-highlighter="prismjs" data-ext="php" data-title="php"><pre><code><span class="line"><span class="token keyword">return</span> <span class="token function">view</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'greeting'</span><span class="token punctuation">)</span></span> 28<span class="line"> <span class="token operator">-></span><span class="token function">with</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'name'</span><span class="token punctuation">,</span> <span class="token string single-quoted-string">'Victoria'</span><span class="token punctuation">)</span></span> 29<span class="line"> <span class="token operator">-></span><span class="token function">with</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'occupation'</span><span class="token punctuation">,</span> <span class="token string single-quoted-string">'Astronaut'</span><span class="token punctuation">)</span><span class="token punctuation">;</span></span> 30<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="sharing-data-with-all-views" tabindex="-1"><a class="header-anchor" href="#sharing-data-with-all-views"><span>Sharing Data With All Views</span></a></h3><p>
30Occasionally, you may need to share data with all views that are rendered by your application. You may do so using the <code>View</code> facade's <code>share</code> method. Typically, you should place calls to the <code>share</code> method within a service provider's <code>boot</code> method. You are free to add them to the <code>App\\Providers\\AppServiceProvider</code> class or generate a separate service provider to house them:</p><div class="language-php line-numbers-mode" data-highlighter="prismjs" data-ext="php" data-title="php"><pre><code><span class="line"><span class="token php language-php"><span class="token delimiter important"><?php</span></span> 31<span class="line"></span> 32<span class="line"><span class="token keyword">namespace</span> <span class="token package">App<span class="token punctuation">\\</span>Providers</span><span class="token punctuation">;</span></span> 33<span class="line"></span> 34<span class="line"><span class="token keyword">use</span> <span class="token package">Hypervel<span class="token punctuation">\\</span>Support<span class="token punctuation">\\</span>Facades<span class="token punctuation">\\</span>View</span><span class="token punctuation">;</span></span> 35<span class="line"></span> 36<span class="line"><span class="token keyword">class</span> <span class="token class-name-definition class-name">AppServiceProvider</span> <span class="token keyword">extends</span> <span class="token class-name">ServiceProvider</span></span> 37<span class="line"><span class="token punctuation">{</span></span> 38<span class="line"> <span class="token doc-comment comment">/**</span> 39<span class="line"> * Register any application services.</span> 40<span class="line"> */</span></span> 41<span class="line"> <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">register</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword return-type">void</span></span> 42<span class="line"> <span class="token punctuation">{</span></span> 43<span class="line"> <span class="token comment">// ...</span></span> 44<span class="line"> <span class="token punctuation">}</span></span> 45<span class="line"></span> 46<span class="line"> <span class="token doc-comment comment">/**</span> 47<span class="line"> * Bootstrap any application services.</span> 48<span class="line"> */</span></span> 49<span class="line"> <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">boot</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword return-type">void</span></span> 50<span class="line"> <span class="token punctuation">{</span></span> 51<span class="line"> <span class="token class-name static-context">View</span><span class="token operator">::</span><span class="token function">share</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'key'</span><span class="token punctuation">,</span> <span class="token string single-quoted-string">'value'</span><span class="token punctuation">)</span><span class="token punctuation">;</span></span> 52<span class="line"> <span class="token punctuation">}</span></span> 53<span class="line"><span class="token punctuation">}</span></span> 54<span class="line"></span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h2 id="view-composers" tabindex="-1"><a class="header-anchor" href="#view-composers"><span>View Composers</span></a></h2><p>View composers are callbacks or class methods that are called when a view is rendered. If you have data that you want to be bound to a view each time that view is rendered, a view composer can help you organize that logic into a single location. View composers may prove particularly useful if the same view is returned by multiple routes or controllers within your application and always needs a particular piece of data.</p><p>Typically, view composers will be registered within one of your application's <a href="/docs/providers">service providers</a>. In this example, we'll assume that we have created a new <code>
54App\\Providers\\ViewServiceProvider</code> to house this logic.</p><p>We'll use the <code>View</code> facade's <code>composer</code> method to register the view composer. Hypervel does not include a default directory for class based view composers, so you are free to organize them however you wish. For example, you could create an <code>app/View/Composers</code> directory to house all of your application's view composers:</p><div class="language-php line-numbers-mode" data-highlighter="prismjs" data-ext="php" data-title="php"><pre><code><span class="line"><span class="token php language-php"><span class="token delimiter important"><?php</span></span> 55<span class="line"></span> 56<span class="line"><span class="token keyword">namespace</span> <span class="token package">App<span class="token punctuation">\\</span>Providers</span><span class="token punctuation">;</span></span> 57<span class="line"></span> 58<span class="line"><span class="token keyword">use</span> <span class="token package">App<span class="token punctuation">\\</span>View<span class="token punctuation">\\</span>Composers<span class="token punctuation">\\</span>ProfileComposer</span><span class="token punctuation">;</span></span> 59<span class="line"><span class="token keyword">
59use</span> <span class="token package">Hypervel<span class="token punctuation">\\</span>Support<span class="token punctuation">\\</span>Facades</span><span class="token punctuation">;</span></span> 60<span class="line"><span class="token keyword">use</span> <span class="token package">Hypervel<span class="token punctuation">\\</span>Support<span class="token punctuation">\\</span>Support<span class="token punctuation">\\</span>ServiceProvider</span><span class="token punctuation">;</span></span> 61<span class="line"><span class="token keyword">use</span> <span class="token package">Hyperf<span class="token punctuation">\\</span>ViewEngine<span class="token punctuation">\\</span>View</span><span class="token punctuation">;</span></span> 62<span class="line"></span> 63<span class="line"><span class="token keyword">class</span> <span class="token class-name-definition class-name">ViewServiceProvider</span> <span class="token keyword">extends</span> <span class="token class-name">ServiceProvider</span></span> 64<span class="line"><span class="token punctuation">{</span></span> 65<span class="line"> <span class="token doc-comment comment">/**</span> 66<span class="line"> * Register any application services.</span> 67<span class="line"> */</span></span> 68<span class="line"> <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">register</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword return-type">void</span></span> 69<span class="line"> <span class="token punctuation">{</span></span> 70<span class="line"> <span class="token comment">// ...</span></span> 71<span class="line"> <span class="token punctuation">}</span></span> 72<span class="line"></span> 73<span class="line"> <span class="token doc-comment comment">/**</span> 74<span class="line"> * Bootstrap any application services.</span> 75<span class="line"> */</span></span> 76<span class="line"> <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">boot</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword return-type">void</span></span> 77<span class="line"> <span class="token punctuation">{</span></span> 78<span class="line"> <span class="token comment">// Using class based composers...</span></span> 79<span class="line"> <span class="token class-name class-name-fully-qualified static-context">Facades<span class="token punctuation">\\</span>View</span><span class="token operator">::</span><span class="token function">composer</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'profile'</span><span class="token punctuation">,</span> <span class="token class-name static-context">ProfileComposer</span><span class="token operator">::</span><span class="token keyword">class</span><span class="token punctuation">)</span><span class="token punctuation">;</span></span> 80<span class="line"></span> 81<span class="line"> <span class="token comment">// Using closure based composers...</span></span> 82<span class="line"> <span class="token class-name class-name-fully-qualified static-context">Facades<span class="token punctuation">\\</span>View</span><span class="token operator">::</span><span class="token function">composer</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'welcome'</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token class-name type-declaration">View</span> <span class="token variable">$view</span><span class="token punctuation">)</span> <span class="token punctuation">{</span></span> 83<span class="line"> <span class="token comment">// ...</span></span> 84<span class="line">
84 <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span></span> 85<span class="line"></span> 86<span class="line"> <span class="token class-name class-name-fully-qualified static-context">Facades<span class="token punctuation">\\</span>View</span><span class="token operator">::</span><span class="token function">composer</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'dashboard'</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token class-name type-declaration">View</span> <span class="token variable">$view</span><span class="token punctuation">)</span> <span class="token punctuation">{</span></span> 87<span class="line"> <span class="token comment">// ...</span></span> 88<span class="line"> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span></span> 89<span class="line"> <span class="token punctuation">}</span></span> 90<span class="line"><span class="token punctuation">}</span></span> 91<span class="line"></span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><div class="hint-container important"><p class="hint-container-title">Important</p><p>Remember, if you create a new service provider to contain your view composer registrations, you will need to add the service provider to the <code>providers</code> array in the <code>config/app.php</code> configuration file.</p></div><p>Now that we have registered the composer, the <code>compose</code> method of the <code>App\\View\\Composers\\ProfileComposer</code> class will be executed each time the <code>profile</code> view is being rendered. Let's take a look at an example of the composer class:</p><div class="language-php line-numbers-mode" data-highlighter="prismjs" data-ext="php" data-title="php"><pre><code><span class="line"><span class="token php language-php"><span class="token delimiter important"><?php</span></span> 92<span class="line"></span> 93<span class="line"><span class="token keyword">namespace</span> <span class="token package">App<span class="token punctuation">\\</span>View<span class="token punctuation">\\</span>Composers</span><span class="token punctuation">;</span></span> 94<span class="line"></span> 95<span class="line"><span class="token keyword">
95use</span> <span class="token package">App<span class="token punctuation">\\</span>Repositories<span class="token punctuation">\\</span>UserRepository</span><span class="token punctuation">;</span></span> 96<span class="line"><span class="token keyword">use</span> <span class="token package">Hyperf<span class="token punctuation">\\</span>ViewEngine<span class="token punctuation">\\</span>View</span><span class="token punctuation">;</span></span> 97<span class="line"></span> 98<span class="line"><span class="token keyword">class</span> <span class="token class-name-definition class-name">ProfileComposer</span></span> 99<span class="line"><span class="token punctuation">{</span></span> 100<span class="line"> <span class="token doc-comment comment">/**</span> 101<span class="line"> * Create a new profile composer.</span> 102<span class="line"> */</span></span> 103<span class="line"> <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">__construct</span><span class="token punctuation">(</span></span> 104<span class="line"> <span class="token keyword">protected</span> <span class="token class-name type-declaration">UserRepository</span> <span class="token variable">$users</span><span class="token punctuation">,</span></span> 105<span class="line"> <span class="token punctuation">)</span> <span class="token punctuation">{</span><span class="token punctuation">}</span></span> 106<span class="line"></span> 107<span class="line"> <span class="token doc-comment comment">/**</span> 108<span class="line"> * Bind data to the view.</span> 109<span class="line"> */</span></span> 110<span class="line"> <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">compose</span><span class="token punctuation">(</span><span class="token class-name type-declaration">View</span> <span class="token variable">$view</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword return-type">void</span></span> 111<span class="line"> <span class="token punctuation">{</span></span> 112<span class="line"> <span class="token variable">$view</span><span class="token operator">-></span><span class="token function">with</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'count'</span><span class="token punctuation">,</span> <span class="token variable">$this</span><span class="token operator">-></span><span class="token property">users</span><span class="token operator">-></span><span class="token function">count</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span></span> 113<span class="line"> <span class="token punctuation">}</span></span> 114<span class="line"><span class="token punctuation">}</span></span> 115<span class="line"></span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>As you can see, all view composers are resolved via the <a href="/docs/container">service container</a>, so you may type-hint any dependencies you need within a composer's constructor.</p><h4 id="attaching-a-composer-to-multiple-views" tabindex="-1"><a class="header-anchor" href="#attaching-a-composer-to-multiple-views"><span>Attaching a Composer to Multiple Views</span></a></h4><p>You may attach a view composer to multiple views at once by passing an array of views as the first argument to the <code>composer</code> method:</p><div class="language-php line-numbers-mode" data-highlighter="prismjs" data-ext="php" data-title="php"><pre><code><span class="line"><span class="token keyword">
115use</span> <span class="token package">App<span class="token punctuation">\\</span>Views<span class="token punctuation">\\</span>Composers<span class="token punctuation">\\</span>MultiComposer</span><span class="token punctuation">;</span></span> 116<span class="line"><span class="token keyword">use</span> <span class="token package">Hypervel<span class="token punctuation">\\</span>Support<span class="token punctuation">\\</span>Facades<span class="token punctuation">\\</span>View</span><span class="token punctuation">;</span></span> 117<span class="line"></span> 118<span class="line"><span class="token class-name static-context">View</span><span class="token operator">::</span><span class="token function">composer</span><span class="token punctuation">(</span></span> 119<span class="line"> <span class="token punctuation">[</span><span class="token string single-quoted-string">'profile'</span><span class="token punctuation">,</span> <span class="token string single-quoted-string">'dashboard'</span><span class="token punctuation">]</span><span class="token punctuation">,</span></span> 120<span class="line"> <span class="token class-name static-context">MultiComposer</span><span class="token operator">::</span><span class="token keyword">class</span></span> 121<span class="line"><span class="token punctuation">)</span><span class="token punctuation">;</span></span> 122<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>The <code>composer</code> method also accepts the <code>*</code> character as a wildcard, allowing you to attach a composer to all views:</p><div class="language-php line-numbers-mode" data-highlighter="prismjs" data-ext="php" data-title="php"><pre><code><span class="line"><span class="token keyword">
122use</span> <span class="token package">Hypervel<span class="token punctuation">\\</span>SupportFacades</span><span class="token punctuation">;</span></span> 123<span class="line"><span class="token keyword">use</span> <span class="token package">Hypervel<span class="token punctuation">\\</span>Support<span class="token punctuation">\\</span>Facades<span class="token punctuation">\\</span>View</span><span class="token punctuation">;</span></span> 124<span class="line"></span> 125<span class="line"><span class="token class-name class-name-fully-qualified static-context">Facades<span class="token punctuation">\\</span>View</span><span class="token operator">::</span><span class="token function">composer</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'*'</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token class-name type-declaration">View</span> <span class="token variable">$view</span><span class="token punctuation">)</span> <span class="token punctuation">{</span></span> 126<span class="line"> <span class="token comment">// ...</span></span> 127<span class="line"><span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span></span> 128<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="view-creators" tabindex="-1"><a class="header-anchor" href="#view-creators"><span>View Creators</span></a></h3><p>View "creators" are very similar to view composers; however, they are executed immediately after the view is instantiated instead of waiting until the view is about to render. To register a view creator, use the <code>
128creator</code> method:</p><div class="language-php line-numbers-mode" data-highlighter="prismjs" data-ext="php" data-title="php"><pre><code><span class="line"><span class="token keyword">use</span> <span class="token package">App<span class="token punctuation">\\</span>View<span class="token punctuation">\\</span>Creators<span class="token punctuation">\\</span>ProfileCreator</span><span class="token punctuation">;</span></span> 129<span class="line"><span class="token keyword">use</span> <span class="token package">Hypervel<span class="token punctuation">\\</span>Support<span class="token punctuation">\\</span>Facades<span class="token punctuation">\\</span>View</span><span class="token punctuation">;</span></span> 130<span class="line"></span> 131<span class="line"><span class="token class-name static-context">View</span><span class="token operator">::</span><span class="token function">creator</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'profile'</span><span class="token punctuation">,</span> <span class="token class-name static-context">ProfileCreator</span><span class="token operator">::</span><span class="token keyword">class</span><span class="token punctuation">)</span><span class="token punctuation">;</span></span> 132<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h2 id="view-caching" tabindex="-1"><a class="header-anchor" href="#view-caching"><span>View Caching</span></a></h2><p>By default, Blade template views are compiled on demand. When a request is executed that renders a view, Hypervel will determine if a compiled version of the view exists. If the file exists, Hypervel will then determine if the uncompiled view has been modified more recently than the compiled view. If the compiled view either does not exist, or the uncompiled view has been modified, Hypervel will recompile the view.</p><p>The cache is stored in the <code>storage/framework/views</code> directory by default. You can change the cache path in the <code>config/view.php</code> file.</p><div class="language-php line-numbers-mode" data-highlighter="prismjs" data-ext="php" data-title="php"><pre><code><span class="line"><span class="token string single-quoted-string">'config'</span> <span class="token operator">=></span> <span class="token punctuation">[</span></span> 133<span class="line"> <span class="token comment">//...</span></span> 134<span class="line"> <span class="token string single-quoted-string">'cache_path'</span> <span class="token operator">=></span> <span class="token function">storage_path</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'framework/views'</span><span class="token punctuation">)</span><span class="token punctuation">,</span></span> 135<span class="line"><span class="token punctuation">]</span><span class="token punctuation">,</span></span> 136<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div>`,57);function k(m,h){const n=l("router-link");return c(),i("div",null,[u,s("nav",d,[s("ul",null,[s("li",null,[a(n,{to:"#introduction"},{default:e(()=>[t("Introduction")]),_:1})]),s("li",null,[a(n,{to:"#creating-and-rendering-views"},{default:e(()=>[t("Creating and Rendering Views")]),_:1}),s("ul",null,[s("li",null,[a(n,{to:"#nested-view-directories"},{default:e(()=>[t("Nested View Directories")]),_:1})]),s("li",null,[a(n,{to:"#creating-the-first-available-view"},{default:e(()=>[t("Creating the First Available View")]),_:1})]),s("li",null,[a(n,{to:"#determining-if-a-view-exists"},{default:e(()=>[t("Determining if a View Exists")]),_:1})])])]),s("li",null,[a(n,{to:"#passing-data-to-views"},{default:e(()=>[t("Passing Data to Views")]),_:1}),s("ul",null,[s("li",null,[a(n,{to:"#sharing-data-with-all-views"},{default:e(()=>[t("Sharing Data With All Views")]),_:1})])])]),s("li",null,[a(n,{to:"#view-composers"},{default:e(()=>[t("View Composers")]),_:1}),s("ul",null,[s("li",null,[a(n,{to:"#view-creators"},{default:e(()=>[t("View Creators")]),_:1})])])]),s("li",null,[a(n,{to:"#view-caching"},{default:e(()=>[t("View Caching")]),_:1})])])]),v])}const w=p(r,[["render",k],["__file","views.html.vue"]]),b=JSON.parse(`{"path":"/docs/views.html","title":"Views","lang":"en-US","frontmatter":{"description":"Views Introduction Of course, it's not practical to return entire HTML documents strings directly from your routes and controllers. Thankfully, views provide a convenient way to...","head":[["meta",{"property":"og:url","content":"https://hypervel.org/docs/views"}],["meta",{"property":"og:site_name","content":"Hypervel"}],["meta",{"property":"og:title","content":"Hypervel - A Coroutine PHP Framework for Laravel Artisans"}],["meta",{"property":"og:description","content":"Hypervel is a Laravel-style framework with native coroutine support for ultra-high performance."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:image","content":"https://hypervel.org/home.png"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:updated_time","content":"2026-02-14T02:32:03.000Z"}],["meta",{"property":"article:modified_time","content":"2026-02-14T02:32:03.000Z"}],["meta",{"name":"twitter:title","content":"Hypervel - A Coroutine PHP Framework For Laravel Artisans"}],["meta",{"name":"twitter:description","content":"Hypervel is a Laravel-style framework with native coroutine support for ultra-high performance."}],["meta",{"name":"twitter:image","content":"https://hypervel.org/home.png"}],["meta",{"name":"twitter:card","content":"summary_large_image"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Vie
136ws\\",\\"image\\":[\\"https://hypervel.org/home.png\\"],\\"dateModified\\":\\"2026-02-14T02:32:03.000Z\\",\\"author\\":[]}"],["title",{},"Hypervel - A Coroutine PHP Framework for Laravel Artisans."]]},"headers":[{"level":2,"title":"Introduction","slug":"introduction","link":"#introduction","children":[]},{"level":2,"title":"Creating and Rendering Views","slug":"creating-and-rendering-views","link":"#creating-and-rendering-views","children":[{"level":3,"title":"Nested View Directories","slug":"nested-view-directories","link":"#nested-view-directories","children":[]},{"level":3,"title":"Creating the First Available View","slug":"creating-the-first-available-view","link":"#creating-the-first-available-view","children":[]},{"level":3,"title":"Determining if a View Exists","slug":"determining-if-a-view-exists","link":"#determining-if-a-view-exists","children":[]}]},{"level":2,"title":"Passing Data to Views","slug":"passing-data-to-views","link":"#passing-data-to-views","children":[{"level":3,"title":"Sharing Data With All Views","slug":"sharing-data-with-all-views","link":"#sharing-data-with-all-views","children":[]}]},{"level":2,"title":"View Composers","slug":"view-composers","link":"#view-composers","children":[{"level":3,"title":"View Creators","slug":"view-creators","link":"#view-creators","children":[]}]},{"level":2,"title":"View Caching","slug":"view-caching","link":"#view-caching","children":[]}],"git":{"updatedTime":1771036323000,"contributors":[{"name":"Albert Chen","email":"[email protected]","commits":1}]},"filePathRelative":"docs/views.md","autoDesc":true}`);export{w as comp,b as data};
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.