sample.php
<?php declare(strict_types=1);
/*
You may not change or alter any portion of this comment or credits
of supporting developers from this source code or any supporting source code
which is considered copyrighted (c) material of the original comment or credit authors.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/
use Xmf\Request;
use XoopsModules\Tag\FormTag;
use XoopsModules\Tag\Utility;
/** {@internal - DO NOT INCLUDE THE FOLLOWING LINE IN YOUR PLUGIN, IT IS INCLUDED
* HERE TO PREVENT THIS INSTRUCTIONAL FILE FROM BEING EXECUTED }}
*/
redirect_header('../../index.php', 0);
/**
* XOOPS tag management module
*
* @copyright XOOPS Project (https://xoops.org)
* @license https://www.fsf.org/copyleft/gpl.html GNU public license
* @since 1.00
* @author Taiwen Jiang <phppp@users.sourceforge.net>
* */
/*
This module provides a centralized toolkit including input, display, stats and
substantially more for applications, so that each module does not need
to develop its own tag handling scripts.
Check https://en.wikipedia.org/wiki/Tags for more info about "tag"
*/
/*
terms:
itemid: unique ID of the object to which the tag belonging, for instance topic_id for newbb topic, art_id for article article;
modid: module ID of the object
catid: extra parameter to identify an object. Only useful when you have more than one types of objects in the same module, for instance in a gallery module, type #1 tags are for images, type #2 tags for albums: (IDofImage, mid, catid=1), (IDofAlbum, mid, catid=2)
*/
/*
The following steps are needed to enable tag for a module ("mymodule"):
1. add tag input box to your item edit form (required)
2. add tag storage to your item submission page (required)
3. define functions to build info of tagged items (required)
4. add tag display API to your item display page and include tag template in your item template (optional)
5. add module tag view page and tag list page (optional)
6. add module tag blocks (optional)
*/
//----------- Step 1: add tag input box to your item edit form -----------
// File: edit.item.php
if (\class_exists(\XoopsModules\Tag\FormTag::class) && xoops_isActiveModule('tag')) {
$itemid = $item_obj->isNew() ? 0 : $item_obj->getVar('itemid');
$form_item->addElement(new \XoopsModules\Tag\FormTag('item_tag', 60, 255, $itemid, $catid = 0));
}
//----------- Step 2: add tag storage after item storage -----------
// File: submit.item.php
use XoopsModules\Tag\Helper as TagHelper;
/** @var \XoopsModules\Tag\TagHandler $tagHandler */
$tagHandler = TagHelper::getInstance()->getHandler('Tag'); // xoops_getModuleHandler('tag', 'tag');
if (is_array($_POST['item_tag'])) {
$item_tag = Request::getArray('item_tag', [], 'POST');
} elseif (is_string($_POST['item_tag'])) {
$item_tag = Request::getString('item_tag', '', 'POST');
}
$tagHandler->updateByItem($item_tag, $itemid, $GLOBALS['xoopsModule']->getVar('dirname'), $catid = 0);
//----------- Step 3: define functions to build info of tagged items -----------
// File: /modules/tag/plugin/mymodule.php OR /modules/mymodule/include/plugin.tag.php
/** Get item fields: title, content, time, link, uid, uname, tags *
*/
function mymodule_tag_iteminfo(array $items): bool
{
if (empty($items)) {
return false;
}
$helper = XoopsModules\Mymodule\Helper::getInstance();
$items_id = [];
foreach (array_keys($items) as $cat_id) {
// Some handling here to build the link upon catid
// If catid is not used, just skip it
foreach (array_keys($items[$cat_id]) as $item_id) {
// In article, the item_id is "art_id"
$items_id[] = (int)$item_id;
}
}
$itemHandler = $helper->getHandler('Item');
$items_obj = $itemHandler->getObjects(new \Criteria('itemid', '(' . implode(', ', $items_id) . ')', 'IN'), true);
foreach (array_keys($items) as $cat_id) {
foreach (array_keys($items[$cat_id]) as $item_id) {
$item_obj = $items_obj[$item_id];
$items[$cat_id][$item_id] = [
'title' => $item_obj->getVar('item_title'),
'uid' => $item_obj->getVar('uid'),
'link' => "view.item.php?itemid={$item_id}",
'time' => $item_obj->getVar('item_time'),
'tags' => XoopsModules\Tag\Utility::tag_parse_tag($item_obj->getVar('item_tags', 'n')), // optional
'content' => '',
];
}
}
unset($items_obj);
return true;
}
/** Remove orphan tag-item links *
*/
function mymodule_tag_synchronization(int $mid): void
{
// Optional
}
//----------- Step 4: Display tags on our item page ----------------
// File: view.item.php
use XoopsModules\Tag\Tagbar;
$tagBar = new Tagbar();
$GLOBALS['xoopsTpl']->assign('tagbar', $tagBar->getTagbar($itemid, $catid = 0));
// File: mymodule_item_template.tpl
$GLOBALS['xoopsTpl']->display('db:tag_bar.tpl');
/* Step 5: create tag list page and tag view page */
// File: list.tag.php
require_once __DIR__ . '/header.php';
require_once $GLOBALS['xoops']->path('/modules/tag/list.tag.php');
// File: view.tag.php
require_once __DIR__ . '/header.php';
require_once $GLOBALS['xoops']->path('/modules/tag/view.tag.php');
//----------- Step 6: create tag blocks ----------------
// File: xoops_version.php
/*
* $options:
* $options[0] - number of tags to display
* $options[1] - time duration, in days, 0 for all the time
* $options[2] - max font size (px or %)
* $options[3] - min font size (px or %)
*/
$modversion['blocks'][] = [
'file' => 'mymodule_block_tag.php',
'name' => 'Module Tag Cloud',
'description' => 'Show tag cloud',
'show_func' => 'mymodule_tag_block_cloud_show',
'edit_func' => 'mymodule_tag_block_cloud_edit',
'options' => '100|0|150|80',
'template' => 'mymodule_tag_block_cloud.tpl',
];
/*
* $options:
* $options[0] - number of tags to display
* $options[1] - time duration, in days, 0 for all the time
* $options[2] - sort: a - alphabet; c - count; t - time
*/
$modversion['blocks'][] = [
'file' => 'mymodule_block_tag.php',
'name' => 'Module Top Tags',
'description' => 'Show top tags',
'show_func' => 'mymodule_tag_block_top_show',
'edit_func' => 'mymodule_tag_block_top_edit',
'options' => '50|30|c',
'template' => 'mymodule_tag_block_top.tpl',
];
// File: module_block_tag.php
/**
* @param array $options
* @return array|bool
*/
function mymodule_tag_block_cloud_show(array $options)
{
require_once $GLOBALS['xoops']->path('/modules/tag/blocks/block.php');
$moduleDirName = \basename(\dirname(__DIR__));
return tag_block_cloud_show($options, $moduleDirName);
}
/**
* @param array $options
*/
function mymodule_tag_block_cloud_edit(array $options): string
{
require_once $GLOBALS['xoops']->path('/modules/tag/blocks/block.php');
return tag_block_cloud_edit($options);
}
/**
* @param array $options
* @return array|bool
*/
function mymodule_tag_block_top_show(array $options)
{
require_once $GLOBALS['xoops']->path('/modules/tag/blocks/block.php');
$moduleDirName = \basename(\dirname(__DIR__));
return tag_block_top_show($options, $moduleDirName);
}
/**
* @param array $options
*/
function mymodule_tag_block_top_edit(array $options): string
{
require_once $GLOBALS['xoops']->path('/modules/tag/blocks/block.php');
return tag_block_top_edit($options);
}
// File: mymodule_tag_block_cloud.tpl
//<{include file = 'db:tag_block_cloud.tpl'}>
$GLOBALS['xoopsTpl']->display('db:tag_block_cloud.tpl');
// File: mymodule_tag_block_top.tpl
//<{include file = 'db:tag_block_top.tpl'}>
$GLOBALS['xoopsTpl']->display('db:tag_block_top.tpl');
/* End */