DataLife Engine文档-用于插件开发的API

DataLife Engine

该API专为开发与脚本的旧版本和将来版本兼容的插件而开发。如果使用API​​从数据库中检索数据,则可以确保该代码将在将来的版本中使用。在新版本中,它使代码的工作和修改变得更加容易。另外,使用API​​时,您无需编写自己的函数来检索数据,也无需连接和声明用于与数据库一起使用的类。只需连接文件API,并开始使用它的功能,其余的一切都由自己承担。

要在插件中使用API​​,您必须包含它:

包括('engine / api / api.class.php');

在这种情况下,您无需考虑是否与数据库建立连接,而不必连接必需的类。此代码可以在DLE脚本的文件和与DLE不相关的其他脚本中使用。它允许您组织DLE脚本与其他脚本的标准化集成。如论坛。

API功能列表:

$ dle_api-> take_user_by_id(int $ id [,string $ select_list]);

通过用户ID获取有关用户的信息数组。可选参数$ select_list 指向要获取的数据库字段的列表,或指向所有的* 。返回有关用户的信息数组;如果找不到用户,则返回false 。

$ dle_api-> take_user_by_name(string $ name [,string $ select_list]);

通过用户登录获取有关用户的信息数组。可选参数$ select_list 指向要获取的数据库字段的列表,或指向所有的* 。返回有关用户的信息数组;如果找不到用户,则返回false 。

$ dle_api-> take_user_by_email(string $ email [,string $ select_list]);

通过电子邮件获取有关该用户的一系列信息。可选参数$ select_list 指向要获取的数据库字段的列表,或指向所有的* 。返回有关用户的信息数组;如果找不到用户,则返回false 。

$ dle_api-> take_users_by_group(int $ group_id [,string $ select_list [,int $ limit]]);;

按用户组获取有关用户的信息数组。可选参数$ select_list 指向要获取的数据库字段的列表。可选参数$ limit 表示返回用户数的限制。返回有关用户的信息数组;如果找不到用户,则返回false 。

$ dle_api-> take_users_by_ip(字符串$ ip,[,bool $ like [,字符串$ select_list [,int $ limit]]]);

通过IP获取用户列表,第二个参数$ like 指示是对搜索使用完全匹配还是不完全匹配。可选参数$ select_list 指向要获取的数据库字段的列表。可选参数$ limit 表示返回用户数的限制。返回有关用户的信息数组;如果找不到用户,则返回false 。

$ dle_api-> change_user_name(int $ user_id,字符串$ new_name);

更改用户的登录名。user_id 是应替换登录用户的ID。new_name 是新用户的登录名。返回值:如果成功完成,则返回true;如果另一个用户已经使用了新名称,则返回false 。

$ dle_api-> change_user_pass(int $ user_id,字符串$ new_pass);

修改用户密码。user_id 是应替换密码的用户的ID。new_pass 是新用户的密码。

$ dle_api-> change_user_email(int $ user_id,字符串$ new_email);

更改用户的电子邮件。user_id 是应替换电子邮件用户的ID。new_email 是新用户的电子邮件。返回值:1-成功完成,-1-该电子邮件已被接收,-2-错误的电子邮件。

$ dle_api-> change_user_group(int $ user_id,int $ new_group);

更改用户的组。user_id 是应更改其组的用户的ID。new_group 是新用户组的ID。返回值:如果成功完成,则返回true;如果指定了不存在的组ID,则返回false 。

$ dle_api-> external_auth(字符串$ login,字符串$ password);

使用登录名和密码登录。返回值:true- 授权成功,false- 登录名或密码不正确。

$ dle_api-> external_register(字符串$ login,字符串$ password,字符串$ email,int $ group);

用户在数据库中的注册。以下信息传递给该功能:登录名,密码,电子邮件和必须在其中注册用户的组号。返回值:1-成功完成,-1-该登录名已经被使用,-2-该电子邮件已经被使用,-3-错误的电子邮件,-4-指定了不存在的组。

$ dle_api-> send_pm_to_user(int $ user_id,字符串$ subject,字符串$ text,字符串$ from);

向用户发送个人消息。$ user_id- 收件人的ID。$ subject- 消息的主题。$ text- 消息的文本。$ from -sender的登录名。返回值:1-成功完成,-1-找不到收件人,0-数据库错误。

$ dle_api-> load_table(字符串$ table [,字符串$ fields [,字符串$ where [,布尔$ multirow [,整数$ start [,整数$ limit [,字符串$ sort [,字符串$ sort_order]]]]]]]] ]);

从数据库表获取信息。

$ table-表名

$ fields-必填字段,以逗号分隔,或*全部

$ where-采样条件

$ multirow-进行一行或更多行

$ start-样本的初始值

$ limit-样本条目数,0-全选

$ sort-字段,用于排序

$ sort_order-排序顺序

返回数据数组,如果在指定条件下在数据库中找不到任何内容,则返回false。

$ dle_api-> save_to_cache(字符串$ fname,混合$ vars);

将数据写入缓存文件。$ fname 表示不带扩展名的缓存文件的名称。$ vars- 要写入缓存的数据。

$ dle_api-> load_from_cache(字符串$ fname,[,int $ timeout [,字符串$ type]]);

从缓存文件读取数据。$ fname 表示不带扩展名的缓存文件的名称。可选参数$ timeout 指示从缓存中获取的信息被视为相关的秒数。如果缓存文件已过时,则该函数返回false 。可选参数$ type 表示要存储在缓存中的数据类型。如果不是“文本” ,则认为已存储数组并返回了数据数组。

$ dle_api-> clean_cache([string $ name]);

删除缓存。可选参数$ name 表示一个特定的文件名,没有要删除的扩展名。

$ dle_api-> get_cached_files();

获取一个包含缓存文件名称的数组。

$ dle_api-> edit_config(混合$ key,[,字符串$ new_value]);

更改并保存脚本设置。

参数$ key 可以是字符串或数组

              string :参数名称

              array :关联参数数组

$ new_value- 参数值。如果$ key 是数组,则不使用。

$ dle_api-> take_news(字符串$ cat,[,字符串$ fields [,整数$ start [,整数$ limit [,字符串$ sort [,字符串$ sort_order]]]]]));

取得新闻

$ cat-新闻类别,以逗号分隔

$ fields-接收到的新闻字段列表,或全部为*

$ start-样本的初始值

$ limit-样本的文章数,0-全选

$ sort-字段,用于排序

$ sort_order-排序顺序

返回与新闻相关的二维数组

$ dle_api-> checkGroup(int $ group);

检查该组是否存在。返回值:如果组存在,则返回true;如果组不存在,则返回false 。

$ dle_api-> install_admin_module(字符串$ name,字符串$ title,字符串$ descr,字符串$ icon [,字符串$ perm]);

在脚本的“管理面板”中安装第三方插件。

$ name-即,它是来自engine / inc / 文件夹的.php 文件,但没有文件扩展名。

$ title-您插件的标题。

$ descr-您的插件说明。

$ icon-包含模块图标的名称,但不包含其路径。图标必须位于引擎/皮肤/图像/中(必填)。推荐的图标大小为70 x 70像素。

$ perm-包含有关允许使用此插件的组的信息。该字段可以采用以下值:全部或以逗号分隔的组ID 。例如:1、2、3。如果指定了所有值,那么将为所有有权访问管理面板的用户显示插件。

$ dle_api-> uninstall_admin_module(字符串$ name);

从“管理面板”中删除第三方插件。

$ name-要删除的模块的名称。

$ dle_api-> change_admin_module_perms(字符串$ name,字符串$ perm);

更改允许在“管理面板”中查看第三方插件的用户组。

$ name-您的插件标题。

$ perm-包含有关允许使用此插件的组的信息。该字段可以采用以下值:全部或以逗号分隔的组ID 。例如:1、2、3。如果指定了所有值,那么将为所有有权访问管理面板的用户显示插件。

完整API的开发才刚刚开始,目前API具有有限的功能集。因此,我们请对THS API开发感兴趣的所有人访问论坛中专门创建的线程,并留下您希望在新版本中看到哪些新功能的反馈。您可以帮助我们创建一个完整的API,涵盖与脚本交互的所有方面。

参与评论

游客评论不支持回复他人评论内容,如需回复他人评论内容请