编辑“使用XOOPS应用程序接口”（章节）

===XOOPS ORM应用实例===
以newbb[[论坛]]模块为例，描述数据操作的常用方法和范例。示例中涉及的类声明，按出现顺序：

*Forum类的定义
<pre>
class Forum extends XoopsObject
{ … }
class NewbbForumHandler extends XoopsPersistableObjectHandler
{ … }
</pre>
*Moderate类的定义
<pre>
class Moderate extends XoopsObject
{ … }
class NewbbModerateHandler extends XoopsPersistableObjectHandler
{ … }
</pre>
*Category类的定义
<pre>
class Category extends XoopsObject
{ … }
class NewbbCategoryHandler extends XoopsPersistableObjectHandler
{ … }
</pre>
*Post类的定义
<pre>
class Post extends XoopsObject
{ … }
class NewbbPostHandler extends XoopsPersistableObjectHandler
{ … }
</pre>
*Post类的定义
<pre>
class Topic extends XoopsObject
{ … }
class NewbbTopicHandler extends XoopsPersistableObjectHandler
{ … }
</pre>

*获取单个对象实例的数据
<pre>
/modules/newbb/viewforum.php
// 获取forum ID
$forum_id = intval($_GET['forum']);
// 创建NewbbForumObjectHandler
$forum_handler =& xoops_getmodulehandler('forum', 'newbb');
// 实例化NewbbForumObject
$forum_obj =& $forum_handler->get($forum_id);
</pre>

*按条件获取多个对象实例的数据
<pre>
/modules/newbb/moderate.php
//确定forum_id需满足的条件
$criteria = new Criteria("forum_id", "(0, {$forum_id})", "IN");
//确定要读取的数据量上限
$criteria->setLimit($xoopsModuleConfig['topics_per_page']);
//要读取的数据初始位置
$criteria->setStart($start);
//排序所依据的规则，即字段名
$criteria->setSort($sort);
//正序或倒序
$criteria->setOrder($order);
//读取满足条件的数据并实例化到$moderate_objs
$moderate_objs = $moderate_handler->getObjects($criteria);
</pre>

*新建对象实例并保存到数据库
<pre>
/modules/newbb/admin/admin_cat_manager.php
//创建category新对象
$category_obj =& $category_handler->create();
...
//从POST提交的数据赋值
$category_obj->setVar('cat_title', @$_POST['title']);
$category_obj->setVar('cat_image', @$_POST['cat_image']);
$category_obj->setVar('cat_order', $_POST['cat_order']);
$category_obj->setVar('cat_description', @$_POST['cat_description']);
$category_obj->setVar('cat_url', @$_POST['cat_url']);
...
//将对象数据插入到数据库中
if (!$category_handler->insert($category_obj)) {
...
}
</pre>

*更新单个对象实例的数据
<pre>
/modules/newbb/admin/admin_cat_manager.php
//创建category对象并从数据库读取数据
$category_obj =& $category_handler->get($cat_id);
...
//从POST提交的数据赋值
$category_obj->setVar('cat_title', @$_POST['title']);
$category_obj->setVar('cat_image', @$_POST['cat_image']);
$category_obj->setVar('cat_order', $_POST['cat_order']);
$category_obj->setVar('cat_description', @$_POST['cat_description']);
$category_obj->setVar('cat_url', @$_POST['cat_url']);
...
//更新对象在数据库中的数据
if (!$category_handler->insert($category_obj)) {
...
}
</pre>

*按条件更新多个对象实例的数据
<pre>
/modules/newbb/admin/topicmanager.php
//建立条件查询类
$criteria_topic = new Criteria("topic_id", $topic_id);
$criteria = new CriteriaCompo($criteria_topic);
$criteria->add(new Criteria('pid', 0));
//更新所有满足条件的post对象的pid值
$post_handler->updateAll("pid", $topic_handler->getTopPostId($newtopic), $criteria, true);
//更新所有满足条件的post对象的topic_id值
$post_handler->updateAll("topic_id", $newtopic, $criteria_topic, true);
</pre>

*删除单个对象实例的数据
<pre>
/modules/newbb/admin/admin_forum_manager.php
//创建forum对象并从数据库读取数据
$forum_obj =& $forum_handler->get($_POST['forum']);
//从数据库中删除该对象的数据
$forum_handler->delete($forum_obj);

*按条件删除多个对象实例的数据
<pre>
/modules/newbb/admin/admin_forum_manager.php
// forum类的delete方法 
function delete(&$forum)
{
	…
    // Get list of all topics in forum, to delete them too
$topic_handler =& xoops_getmodulehandler('topic', 'newbb');
//删除forum_id等于当前forum ID的所有主题
$topic_handler->deleteAll(new Criteria("forum_id", $forum->getVar('forum_id')), true, true);
…
//调用父类删除当前论坛版面的数据
    return parent::delete($forum);
}
</pre>












[[category:Xoops模块开发指南]]
说明	输入内容	输出结果
斜体	''斜体文字''	斜体文字
粗体	'''粗体文字'''	粗体文字
粗斜体	'''''粗斜体文字'''''	*粗斜体文字*