raulfraile/ladybug-bundle

此包已被弃用且不再维护。作者建议使用 symfony/var-dumper 包代替。

Symfony2 Ladybug库的Bundle(简单的PHP Dumper扩展库)

安装次数: 941,021

依赖者: 19

建议者: 0

安全: 0

星标: 331

关注者: 10

分支: 50

开放问题: 14

类型:symfony-bundle

v1.0.6 2014-10-10 06:09 UTC

This package is not auto-updated.

Last update: 2022-02-01 12:20:52 UTC


README

Build Status Latest Stable Version Total Downloads Latest Unstable Version

此Bundle为Symfony2项目提供了一种简单且可扩展的var_dump/print_r替代方案,可用于控制器或Twig模板中。例如,使用此Bundle可以实现以下功能

<?php
    class UserController extends Controller
    {
        public function userAction($username) {
            ladybug_dump($username); // or just ld($username)
        }
    }
{{ user.username|ladybug_dump }}

结果如下

string_example.png

安装

步骤 1: Composer

将以下行添加到 composer.json 文件中

{
    "require": {
        "raulfraile/ladybug-bundle": "~1.0"
    }
}

要实际安装Ladybug到您的项目中,下载composer二进制文件并运行它

wget https://getcomposer.org.cn/composer.phar
# or
curl -O https://getcomposer.org.cn/composer.phar

php composer.phar install

步骤 2: 启用Bundle

最后,在kernel中启用此Bundle

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new RaulFraile\Bundle\LadybugBundle\RaulFraileLadybugBundle(),
    );
}

示例

可以转储任何变量,包括数组、对象和资源

转储数组

<?php
    $var = array(1, 2, 3);
    ladybug_dump($var)

array_example.png

转储对象

<?php
    ladybug_dump($this->getRequest())

request_example.png

同样可以使用Twig过滤器 ladybug_dump 实现。

辅助函数

有5个辅助函数可以在任何控制器中使用

ladybug_dump($var1[, $var2[, ...]]): 转储一个或多个变量

ladybug_dump_die($var1[, $var2[, ...]]): 转储一个或多个变量并终止当前脚本

ladybug_dump_return($format, $var1[, $var2[, ...]]): 转储一个或多个变量并返回以下任一格式的转储

  • yml: 返回YAML格式的转储
  • json: 返回JSON格式的转储
  • xml: 返回XML格式的转储
  • php: 返回PHP数组格式的转储

ladybug_dump_ini([$extension]): 转储所有配置选项

ladybug_dump_ext(): 转储已加载的扩展

还有一些快捷方式,以防您不使用这些函数名称

ld($var1[, $var2[, ...]]): ladybug_dump的快捷方式

ldd($var1[, $var2[, ...]]): ladybug_dump_die的快捷方式

ldr($format, $var1[, $var2[, ...]]): ladybug_return的快捷方式

只有 ladybug_dump 可以在Twig模板中使用。

Symfony分析器集成

您可以使用Ladybug日志记录器而不是在HTML文档中打印转储树,并在Symfony分析器的标签中查看结果

profiler.png

要使用Ladybug日志记录器,从DIC获取 ladybug 服务并调用 log 方法

<?php
class TestController
{
    public function testAction()
    {
        $var = 1;
        $this->get('ladybug')->log($var);
    }

API参考

Ladybug会自动检测Symfony、Doctrine、Twig、Silex和其他类,并将它们链接到官方文档。

doc_example.png

配置

您可以直接在您的 config.yml 文件中配置Ladybug库。以下是默认值

raul_fraile_ladybug:
    theme: modern # select the theme: base, modern or custom themes
    expanded: false # true to expand all the variables tree by default
    silenced: false # true to ignore all ladybug calls

致谢

授权

LadybugBundle 采用 MIT 许可证发布。请参阅捆绑的 LICENSE 文件以获取详细信息。