CodeIgniter 用户指南 版本 2.0.0

PHP100中文网
查看原文

引用通告类

这个类提供了一组函数使你能够发送和接收引用通告的数据.

如果你对引用通告不太熟悉的话可以在这里查看更多的信息.

初始化类

和其它大多数类一样,Trackback 类 也是使用$this->load->library function:

$this->load->library('trackback');

加载完毕后,Trackback 对象就能够用: $this->trackback方式使用.

发送引用通告(Trackbacks)

引用通告可以从任何控制器函数中使用与示例相似的代码来发送:

$this->load->library('trackback');

$tb_data = array(
                'ping_url'  => 'http://example.com/trackback/456',
                'url'       => 'http://www.my-example.com/blog/entry/123',
                'title'     => 'The Title of My Entry',
                'excerpt'   => 'The entry content.',
                'blog_name' => 'My Blog Name',
                'charset'   => 'utf-8'
                );

if ( ! $this->trackback->send($tb_data))
{
     echo $this->trackback->display_errors();
}
else
{
     echo 'Trackback was sent!';
}

数组数据说明:

根据发送的成功与否,引用通告发送函数将分别返回 TRUE/FALSE(布尔值)。如果发送失败,你可以通过下面的方式获取到错误信息:

$this->trackback->display_errors();

接收引用通告

在接收引用通告之前你必须得创建一个博客。如果你连博客都没有,那就没有必要继续下去了。

接收引用通告要比发送复杂一点,这仅仅是因为你将需要一个数据表来存储它们,而且你还得验证发送过来的引用通告数据。我们鼓励你去实现一个完整的验证过程,目的是防范垃圾信息和重复数据。你也许还想限制某个给定的时间范围内某个特定IP所能发送给你的引用通告数量,这样可以防范今后的垃圾邮件。接收引用通告的处理过程是很简单的;只不过验证过程占用了大部分的工作量。

你的 Ping URL

为了接受引用通告,你必须在每个博客日志旁边显示一个引用通告URL。这就是人们向你发送引用通告时用到的URL(我们把这个称为你的"Ping URL")。

你的Ping URL必须指向一个包含了引用通告接收代码的控制器,而且URL也必须包含每个特定的日志条目的ID,因此当你接收到引用通告的时候,你就能够将它与某篇日志关联起来。

例如,如果你的控制器类叫做 Trackback,接收函数叫做 receive,那么你的Ping URL看起来应该是这样的:

http://example.com/index.php/trackback/receive/entry_id

其中 entry_id 代表了你的每篇日志单独的ID号。

创建一个引用通告表

在接收引用通告之前你必须创建一个表来存储它们。 下面是表的基础原型:

引用通告规范只需要发送四部分信息(url,title,excerpt,blog_name)到引用通告,但是为了使数据更有用,我们在上面的数据表架构中添加了一些字段(日期、IP地址等等)。

处理一个引用通告

这里有一个关于如何接收和处理引用通告的范例。下面这些代码应该被用在你要接收引用通告的控制器函数里面。

$this->load->library('trackback');
$this->load->database();

if ($this->uri->segment(3) == FALSE)
{
    $this->trackback->send_error("Unable to determine the entry ID");
}

if ( ! $this->trackback->receive())
{
    $this->trackback->send_error("The Trackback did not contain valid data");
}

$data = array(
                'tb_id'      => '',
                'entry_id'   => $this->uri->segment(3),
                'url'        => $this->trackback->data('url'),
                'title'      => $this->trackback->data('title'),
                'excerpt'    => $this->trackback->data('excerpt'),
                'blog_name'  => $this->trackback->data('blog_name'),
                'tb_date'    => time(),
                'ip_address' => $this->input->ip_address()
                );

$sql = $this->db->insert_string('trackbacks', $data);
$this->db->query($sql);

$this->trackback->send_success();

说明:

条目ID号应该出现在你的URL的第三段中。这个的依据是我们之前给出的URI范例:

http://example.com/index.php/trackback/receive/entry_id

注意 entry_id 位于URI的第三段,这样你就可以通过下面这种方式获取到它:

$this->uri->segment(3);

在上面的引用通告接收代码中,如果缺少第三段,我们将发出错误警告。缺少有效的条目ID,也就没有理由继续下去了。

$this->trackback->receive() 函数只是一个简单的验证函数,作用是检查输入的数据以确保其中包含了必需的四部分数据(url, title, excerpt, blog_name)。如果成功则返回 TRUE,失败则返回 FALSE。如果失败,你将看到一条错误信息。

可以使用下面的函数获取输入的引用通告数据:

$this->trackback->data('item')

其中 item 代表这四部分信息中的一部分: url, title, excerpt, 或者 blog_name。

如果引用通告数据被成功地接收,你将可以使用下面的方式获取到一条成功信息:

$this->trackback->send_success();

注意: 上面的代码不包含数据验证,那正是我们鼓励你去添加的。

 

翻译贡献者: Drice, Hex, shnwqshnwq, yinzhili
最后修改: 2010-11-10 11:48:26