README

关于Flame

Flame 是一个以功能开发驱动的框架，它将改善您构建 Laravel 应用程序功能的方式。

此免费软件包将允许您

以标准代码约定方式创建组织良好的功能，每个功能都在一个目录内。
创建并重复使用“智能”小部件，称为 Twinkles，这将使您改进布局代码结构。
根据请求中调用的路由操作自动渲染面板和 Twinkles。
能够在屏幕渲染之前执行 Twinkle 控制器操作。
将应用程序结构为功能模块，具有更好的代码可读性、结构和可重用性！

为什么选择Flame

我创建 Flame 是因为我开始构建中型网络应用（如 Laraning 或 Laraflash），其中包含大量 Blade 视图、Blade 组件等。开始难以以某种方式组织功能，以便在给定的控制器操作中加载数据。

我想到一个想法：“如果我有办法自动知道我在运行哪些操作，然后自动根据该操作加载相应的图形布局，而不是仅仅创建更多视图，那会怎么样？”

这就是 Flame 开始的地方。Flame 将为您自动化这种行为。让我们看看它是如何工作的。

安装

您可以通过以下命令使用 composer 安装此软件包

composer require brunocfalcao/flame

软件包将自动注册自己（使用 auto-discover）。

下一步是将 flame.php 配置文件发布到您的配置文件夹。

php artisan vendor:publish --tag=flame-configuration

全部完成！😄

它的工作原理

flame.php 配置文件已经有一个条目，将所有功能放入 App\Flame\Features 命名空间。

使用以下命令创建一个新的功能

php artisan make:feature

选择“flame”命名空间组，然后创建一个“管理汽车”功能，以及动作“index”。最后，命令提供的路由示例将是

Route::get('manage-cars', '\App\Flame\Features\ManageCars\Controllers\ManageCarsController@index')
     ->name('manage-cars.index');

👉 将此路由示例复制粘贴到您的 web.php 文件中（或您正在使用的其他 web 中间件的路由文件）。

💾 在您的 "app\Flame\Features" 文件夹内创建了一个名为 "ManagesCars" 的新文件夹。

功能“管理汽车”文件结构

  + ManageCars
    + Controllers
      > ManageCarsController.php
      > WelcomeController.php
    + Panels
      > index.blade.php
    + Twinkles
      > welcome.blade.php

现在让我们看看这些文件上构建了什么。魔法从这里开始 ❤️ ！

Controllers/ManageCarsController.php

class ManageCarsController extends Controller
{
    public function index()
    {
        return flame();
    }

🎉 这是您映射路由文件的地方。您只需返回 flame() 助手，Flame 将加载相应面板和 Twinkles 的“index”动作。这意味着，如果您的 Twinkles 中定义了“index”动作，它们将在面板内容渲染之前运行。

如果您没有具有相同名称的面板，则将回退到 default.blade.php。如果您有具有此名称的面板，则将为所有没有特定面板动作的操作加载它。双倍甜蜜！

Panels/welcome.blade.php

@twinkle('welcome')

Twinkle 的工作方式就像一个“智能小部件”。它将根据传递的参数渲染 Twinkes/ 文件夹中定义的内容。在这种情况下，Twinkle 将加载 "welcome.blade.php"。

但是！还有更多的魔法发生 ❤️ ...

在渲染Twinkle之前，它会尝试找到其各自对应的控制器（大写命名）名称。在我们的例子中，我们在Controllers/WelcomeController.php中找到了它，所以我们来看看

Controllers/WelcomeController.php

class WelcomeController extends Controller
{
    public function index()
    {
        return ['text' => 'Hi there! This is a Twinkle!'];
    }

由于当前路由动作已经定义了相同的动作，它将使用反射来运行方法并将数据作为数组传递。因此，您可以在Twinkle内部将其用作Blade变量。这意味着在这种情况下，它将运行"index"方法并将数据返回给Welcome Twinkle。

Twinkle方法也与隐式绑定一起工作。这意味着如果您从路由参数中定义了参数，它们将被动态注入到方法参数中！

当前开发状态

完成核心开发。
完成Alpha版本0.1.x的识别问题/改进。
关闭Alpha（0.1.x）版本。
完成Beta版本0.2.x的识别问题/改进。
关闭Beta（0.2.x）版本。
测试覆盖率 > 90%。
完成文档。
完成视频教程。
公开发布。

入门指南

Flame在您的/flame URL上创建了一个演示路由。您可以尝试一下，应该能看到

这意味着您可以在Brunocfalcao\Flame\Features\Demo命名空间中找到位于Demo功能的演示功能。

创建您的第一个功能

非常简单。只需写下以下命令

php artisan make:feature

贡献

目前您不需要贡献，因为Flame仍在开发中。

许可证

Waygou Flame是开源软件，根据MIT许可证授权。

brunocfalcao / cerebrus

维护者

详细信息