oxboot / controller
WordPress 包,用于在使用 Sage 9 的 Blade 时启用基本控制器
Requires
- php: >=5.6.0
- brain/hierarchy: ^2.4.0
- composer/installers: ^1.0
Requires (Dev)
This package is auto-updated.
Last update: 2024-09-21 20:54:02 UTC
README
WordPress 包,用于在使用 Sage 的 Blade 时启用控制器
安装
Composer
Sage 随控制器一起发货。但是,如果您需要安装,请浏览到 Sage 主题目录并运行;
$ composer require soberwp/controller:2.1.1
升级到 2.x.x
请注意,2.x.x 版本是比 9.x.x-beta 更新的版本。9.x.x-beta 用于与 Sage 9 的版本匹配。
Controller 2.x.x 使用 PSR4 自动加载 来加载控制器类。这被认为是最佳实践。您需要从 9.0.0-beta 版本更新以下文件。
文件夹 controllers/
变为 Controllers/
,类文件名变为驼峰式 App.php
和 FrontPage.php
。控制器命名空间变为 namespace App\Controllers;
要求
- PHP >= 7.0
设置
默认情况下,Controller 使用命名空间 Controllers
。
Controller 利用 PSR-4 自动加载。要更改命名空间,请在 functions.php
中使用以下过滤器
add_filter('sober/controller/namespace', function () { return 'Data'; });
使用
概述
- Controller 类名遵循与 WordPress 相同的层次结构
- 控制器类名应与文件名匹配
- 例如,
App.php
应定义类为class App extends Controller
- 例如,
- 在控制器类中创建方法;
- 使用
public function
将数据返回到 Blade 视图/s- 方法名成为 Blade 中的变量名
- 驼峰式转换为蛇形。控制器中的
public function ExampleForUser
成为 Blade 模板中的$example_for_user
- 如果声明了相同的方法名两次,则最新实例将覆盖之前的实例
- 使用
public static function
从您的 Blade 模板中运行方法,该方法返回数据。这对于循环很有用- 方法名不转换为蛇形
- 您使用类名和方法的组合来访问该方法。在
App.php
中的public static function Example
可以在 Blade 中使用App::Example()
运行 - 如果声明了相同的方法名两次,则最新实例将覆盖之前的实例
- 使用
protected function
用于内部方法。这些方法不会暴露给 Blade。您可以在__construct
中运行它们- 通过
__construct
提供类型提示的依赖注入
- 通过
- 使用
初读时,上述内容可能看起来很复杂,因此让我们通过一些示例来看看 Controller 是如何使用的。
基本控制器;
以下示例将向 resources/views/single.blade.php
暴露 $images
app/Controllers/Single.php
<?php namespace App\Controllers; use Sober\Controller\Controller; class Single extends Controller { /** * Return images from Advanced Custom Fields * * @return array */ public function images() { return get_field('images'); } }
resources/views/single.blade.php
@if($images) <ul> @foreach($images as $image) <li><img src="{{$image['sizes']['thumbnail']}}" alt="{{$image['alt']}}"></li> @endforeach </ul> @endif
使用函数;
您可以使用静态方法从您的视图中运行函数。
这对于您在循环内并且想要为每个帖子项返回数据很有用。
app/Controllers/Archive.php
<?php namespace App\Controllers; use Sober\Controller\Controller; class Archive extends Controller { public static function title() { return get_post()->post_title; } }
resources/views/archive.php
@extends('layouts.app') @section('content') @while (have_posts()) @php(the_post()) {{ Archive::title() }} @endwhile @endsection
使用组件;
您还可以创建可重用的组件,并通过PHP特性将其包含在任何控制器类中。
app/Controllers/Partials/Images.php
<?php namespace App\Controllers\Partials; trait Images { public function images() { return get_field('images'); } }
现在,您可以将Images特性包含到任何视图中,传递变量$images;
app/Controllers/Single.php
<?php namespace App\Controllers; use Sober\Controller\Controller; class Single extends Controller { use Partials\Images; }
继承树/层次结构;
默认情况下,每个控制器根据控制器的特定性覆盖其模板层次结构(与WordPress模板类似)。
通过实现Tree,您可以继承层次结构中不太具体的控制器中的数据。
例如,以下app/Controllers/Single.php
示例将继承自app/Controllers/Singular.php
的方法;
app/Controllers/Single.php
<?php namespace App\Controllers; use Sober\Controller\Controller; use Sober\Controller\Module\Tree; class Single extends Controller implements Tree { }
如果您愿意,也可以这样做;
<?php namespace App\Controllers; use Sober\Controller\Controller; class Single extends Controller { protected $tree = true; }
您可以通过在app/Controllers/Single.php
中声明同名方法来覆盖app/Controllers/Singular.php
的方法;
创建全局属性;
在app/Controllers/App.php
中创建的方法将被所有视图继承,并且不能像resources/views/layouts/app.php
那样扩展所有视图而禁用。
app/Controllers/App.php
<?php namespace App\Controllers; use Sober\Controller\Controller; class App extends Controller { public function siteName() { return get_bloginfo('name'); } }
高级自定义字段模块;
控制器有一个有用的高级自定义字段辅助模块来自动传递字段。
自动字段将使用高级自定义字段的变量名称并将它们传递到视图中。控制器还默认传递选项值。
<?php namespace App\Controllers; use Sober\Controller\Controller; class Single extends Controller { // Pass on all fields from Advanced Custom Fields to the view protected $acf = true; // Pass on only field_1 from Advanced Custom Fields to the view protected $acf = 'field_1'; // Pass on multiple fields from Advanced Custom Fields to the view protected $acf = ['field_1', 'field_2']; }
值以对象形式返回,但您可以选择禁用此功能以保持它们为数组。
add_filter('sober/controller/acf/array', function () { return true; });
模板覆盖选项;
您应该只在边缘情况下使用覆盖。坚持使用WordPress层次结构是推荐的做法。然而,一个边缘情况是404模板。
在您的Blade视图中,您将具有404.blade.php
,因为它以数字开头。在这种情况下,您可以重命名您的控制器类为FourZeroFour.php
,并使用参数$template = '404';
<?php namespace App\Controllers; use Sober\Controller\Controller; class FourZeroFour extends Controller { protected $template = '404'; }
生命周期;
控制器类包含两个生命周期钩子,以便更好地控制。
public function __before() { // runs after this->data is set up, but before the class methods are run } public function __after() { // runs after all the class methods have run }
禁用选项;
protected $active = false;
Blade调试器;
在您的Blade视图中,resources/views
,您可以使用以下内容来帮助调试;
@debug
@dump(__var__)
Blade编码器;
在您的Blade视图中,resources/views
,您可以使用以下内容来帮助快速启动编码;
@code
@code('__name of variable as string__')
要使用if语句包裹代码,使用@codeif
@codeif
@codeif('__name of variable as string__')
更新
- 将composer.json版本更改为2.1.1
- 在更新之前检查CHANGELOG.md以查找任何破坏性更改。
$ composer update
其他
- 有关更新,请关注@withjacoby
- 您还可以雇用我进行WordPress或前端工作