在error_reporting为ON的doc注释中使用@class标记时出现Luracast Restler错误

时间:2012-05-03 07:40:19

标签: php documentation restler

我使用Luracast Restler API在PHP中实现了一个REST Web服务。

如果我向自定义类中的文档注释添加任何@class标记,公开API方法,或者在实现身份验证的iAuthenticate方法的类中,如果错误报告为ON,则restler无法解析请求。< / p>

我认为问题是DocParser类试图将@class标记作为PHP Class声明处理。类formatClass()的方法会生成undefined index通知。如果错误报告为ON,则会发送标头,因此当稍后Restler尝试发送响应时,它将无法更改标头以指示发送了JSON内容并且触发了Cannot modify header information - headers already sent

是否有任何解决方法或只是Restler Api中的错误? (除了设置我的错误报告级别以避免发送通知)。

1 个答案:

答案 0 :(得分:1)


更新:已在Restler 2.1.5

中修复

这是由DocParser引起的Restler 2.1.4中存在的错误,因为它期望以特定格式发表@class条评论,如下所示

/**
 * @class ClassName(property=value&property2=value2)
 */

用于在初始化后设置另一个类的属性。例如,我们可以使用它来告诉XmlFormat设置根名称,定义应该转换为属性等等,让我们采用已知的BMI示例,添加PHPDoc注释,如下所示,

<?php
class BMI {
    /**
    * @class XmlFormat(root_name=self&attribute_names=height,weight)
    */
    function index($height=162.6, $weight=84) {
        $result = new stdClass();
        $cm = $height;
        $kg = $weight;

        $meter = $cm / 100;
        $inches = $meter * 39.3700787;
        $feet = round($inches/12);
        $inches = $inches % 12; 

        $result->bmi = round($kg/($meter*$meter),2);
        $lb = round($kg/0.45359237,2);

        if($result->bmi<18.5){
            $result->message = 'Underweight';
        }elseif ($result->bmi<=24.9){
            $result->message = 'Normal weight';
        }elseif ($result->bmi<=29.9){
            $result->message = 'Overweight';
        }else{
            $result->message = 'Obesity';
        }
        $result->metric = array('height'=>"$cm centimeter", 'weight'=>"$weight kilograms");
        $result->imperial = array('height'=>"$feet feet $inches inches", 'weight'=>"$lb pounds");
        return $result;
    }
}

返回以下XML

<?xml version="1.0"?>
<self>
    <bmi>31.77</bmi>
    <message>Obesity</message>
    <metric height="162.6 centimeter" weight="84 kilograms"/>
    <imperial height="5 feet 4 inches" weight="185.19 pounds"/>
</self>

否则将

<?xml version="1.0"?>
<response>
  <bmi>31.77</bmi>
  <message>Obesity</message>
  <metric>
    <height>162.6 centimeter</height>
    <weight>84 kilograms</weight>
  </metric>
  <imperial>
    <height>5 feet 4 inches</height>
    <weight>185.19 pounds</weight>
  </imperial>
</response>

可以找到更多用例和解释here

如果以意外格式定义@class,则不应抛出错误。我们将在下一个版本中修复它。