darkfoxdeveloper/sage9-controller

WordPress 包，用于在Sage 9中使用Blade时启用基本控制器

维护者

详细信息

github.com/darkfoxdeveloper/sage9-controller

主页

源代码

问题

安装: 2

依赖项: 0

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 0

开放问题: 0

类型：package

v1.0 2024-06-06 09:18 UTC

Requires

Requires (Dev)

MIT 6aa807ed40373c28d73ab10414fc4f849ba0a31b

wordpress

This package is auto-updated.

Last update: 2024-09-06 10:06:46 UTC

README

WordPress 包，用于在 Sage 9 中使用Blade时启用控制器（请注意，Sage 10使用Composers而不是此包。）


安装

Composer

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

$ composer require soberwp/controller:2.1.2

升级到 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;

需求

设置

默认情况下，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 的使用是多么简单。

基本控制器；

以下示例将 $images 暴露给 resources/views/single.blade.php

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() @endphp
    {{ 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('__变量名称作为字符串__')

要使用if语句包裹代码，请使用@codeif

  • @codeif
  • @codeif('__变量名称作为字符串__')

支持；

更新；

  • 将composer.json版本更改为2.1.2；
  • 在更新之前，检查CHANGELOG.md以查看任何破坏性更改。
$ composer update