README

WordPress 包，在用 Sage (https://roots.io/sage/) 时启用 Blade 控制器

• 安装
• 设置
• 用法
  • 概述
  • 基本控制器
  • 使用函数
  • 使用组件
  • 继承树/层次结构
  • 创建全局属性
  • 高级自定义字段模块
  • 模板覆盖选项
  • 生命周期
  • 禁用选项
• Blade 调试器
• Blade 编码器

安装

Composer

Sage 随控制器一起提供。但是，如果您需要安装，请浏览到 Sage 主题目录并运行；

$ composer require soberwp/controller:2.1.0

升级到 2.x.x

请注意，2.x.x 版本比 9.x.x-beta 更新。9 是用来匹配当时 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 相同的层次结构。
• Controller 类名应与文件名匹配
  • 例如 App.php 应定义为 class App extends Controller
• 在 Controller 类中创建方法；
  • 使用 public function 将数据返回到 Blade 视图/s
    • 方法名成为 Blade 中的变量名
    • 驼峰式转换为蛇形。在 Controller 中的 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 特性在任何 Controller 类中包含它们。

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模板的运作方式相同）。

通过实现树，您可以继承层次结构中不那么特定的控制器的数据。

例如，以下 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.0
• 在更新之前，请检查 CHANGELOG.md 中是否有任何重大更改。

$ composer update

其他；

• 有关更新，请关注 @withjacoby
• 您还可以 雇用我 进行WordPress或前端工作