Skip to content

add PhpDoc @deprecated #1592

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
+86 −7
Open

add PhpDoc @deprecated #1592

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7c013ee
add PhpDoc @deprecated
mambax7 Nov 15, 2025
3061eca
Apply suggestion from @Copilot
mambax7 Nov 15, 2025
ec79baf
co-pilot cosmetics
mambax7 Nov 15, 2025
88c39cb
Scrutinizer
mambax7 Nov 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions htdocs/Frameworks/art/functions.user.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
* @param bool $asString
*
* @return mixed
* @deprecated
*/
function mod_getIP($asString = false)
{
Expand All @@ -32,6 +33,7 @@ function mod_getIP($asString = false)
* @param bool $linked
*
* @return array
* @deprecated
*/
function &mod_getUnameFromIds($uid, $usereal = false, $linked = false)
{
Expand All @@ -47,6 +49,7 @@ function &mod_getUnameFromIds($uid, $usereal = false, $linked = false)
* @param bool $linked
*
* @return string
* @deprecated
*/
function mod_getUnameFromId($uid, $usereal = 0, $linked = false)
{
Expand Down
1 change: 1 addition & 0 deletions htdocs/class/database/database.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,7 @@ abstract public function exec(string $sql);

/**
* Legacy alias for writes; kept for BC.
* @deprecated
*/
public function queryF(string $sql)
{
Expand Down
1 change: 1 addition & 0 deletions htdocs/class/errorhandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
* @author Kazumi Ono <onokazu@xoops.org>
* @author John Neill <catzwolf@xoops.org>
* @copyright (c) 2000-2025 XOOPS Project (https://xoops.org)
* @deprecated
Copy link

Copilot AI Nov 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The @deprecated tag should follow PHPDoc standards with additional information. According to PHPDoc standards, the @deprecated tag should include a version number and optionally a description or replacement suggestion. For example: @deprecated since version X.X.X Use AlternativeClass instead.

This applies to all deprecated items in this file.

Copilot uses AI. Check for mistakes.
*/
class XoopsErrorHandler extends XoopsLogger
{
Expand Down
2 changes: 2 additions & 0 deletions htdocs/class/model/read.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,7 @@ public function &getIds(?CriteriaElement $criteria = null)
* @param array $fields variables to fetch
* @param bool $asObject flag indicating as object, otherwise as array
* @return array of objects {@link XoopsObject}
* @deprecated
*/
public function &getByLimit($limit = 0, $start = 0, ?CriteriaElement $criteria = null, $fields = null, $asObject = true)
{
Expand All @@ -222,6 +223,7 @@ public function &getByLimit($limit = 0, $start = 0, ?CriteriaElement $criteria =
* @param bool $id_as_key - should NOT be used with joint keys
* @param bool $as_object
* @return array
* @deprecated
*/
public function convertResultSet($result, $id_as_key = false, $as_object = true)
{
Expand Down
1 change: 1 addition & 0 deletions htdocs/class/module.errorhandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
* @package kernel
* @subpackage core
* @author Goghs (http://www.eqiao.com/)
* @deprecated
Copy link

Copilot AI Nov 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The @deprecated tag should follow PHPDoc standards with additional information. According to PHPDoc standards, the @deprecated tag should include a version number and optionally a description or replacement suggestion. For example: @deprecated since version X.X.X Use AlternativeClass instead.

This applies to all deprecated items in this file.

Copilot uses AI. Check for mistakes.
*/
class ErrorHandler
{
Expand Down
1 change: 1 addition & 0 deletions htdocs/class/module.textsanitizer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -843,6 +843,7 @@ public function nl2Br($text)
*
* @param string $text
* @return string
* @deprecated
*/
public function addSlashes($text)
{
Expand Down
33 changes: 33 additions & 0 deletions htdocs/class/template.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,6 +298,7 @@ public function xoops_setCacheTime($num = 0)
*
* @param string $tpl_var the template variable name
* @param mixed &$value the referenced value to assign
* @deprecated
*/
public function assign_by_ref($tpl_var, &$value)
{
Expand All @@ -311,6 +312,7 @@ public function assign_by_ref($tpl_var, &$value)
* @param string $tpl_var the template variable name
* @param mixed &$value the referenced value to append
* @param boolean $merge flag if array elements shall be merged
* @deprecated
*/
public function append_by_ref($tpl_var, &$value, $merge = false)
{
Expand All @@ -322,6 +324,7 @@ public function append_by_ref($tpl_var, &$value, $merge = false)
* deprecated clear_assign
*
* @param string $tpl_var the template variable to clear
* @deprecated
*/
public function clear_assign($tpl_var)
{
Expand All @@ -338,6 +341,7 @@ public function clear_assign($tpl_var)
* @param mixed $cache_attrs
*
* @throws \SmartyException
* @deprecated
*/
public function register_function($function, $function_impl, $cacheable = true, $cache_attrs = null)
{
Expand All @@ -349,6 +353,7 @@ public function register_function($function, $function_impl, $cacheable = true,
* deprecated unregister_function
*
* @param string $function name of template function
* @deprecated
*/
public function unregister_function($function)
{
Expand All @@ -367,6 +372,7 @@ public function unregister_function($function)
*
* @throws SmartyException
* @internal param array $block_functs list of methods that are block format
* @deprecated
*/
public function register_object(
$object,
Expand All @@ -385,6 +391,7 @@ public function register_object(
* deprecated unregister_object
*
* @param string $object name of template object
* @deprecated
*/
public function unregister_object($object)
{
Expand All @@ -401,6 +408,7 @@ public function unregister_object($object)
* @param mixed $cache_attrs
*
* @throws \SmartyException
* @deprecated
*/
public function register_block($block, $block_impl, $cacheable = true, $cache_attrs = null)
{
Expand All @@ -412,6 +420,7 @@ public function register_block($block, $block_impl, $cacheable = true, $cache_at
* deprecated unregister_block
*
* @param string $block name of template function
* @deprecated
*/
public function unregister_block($block)
{
Expand All @@ -427,6 +436,7 @@ public function unregister_block($block)
* @param bool $cacheable
*
* @throws \SmartyException
* @deprecated
*/
public function register_compiler_function($function, $function_impl, $cacheable = true)
{
Expand All @@ -438,6 +448,7 @@ public function register_compiler_function($function, $function_impl, $cacheable
* deprecated unregister_compiler_function
*
* @param string $function name of template function
* @deprecated
*/
public function unregister_compiler_function($function)
{
Expand All @@ -452,6 +463,7 @@ public function unregister_compiler_function($function)
* @param string $modifier_impl name of PHP function to register
*
* @throws \SmartyException
* @deprecated
*/
public function register_modifier($modifier, $modifier_impl)
{
Expand All @@ -463,6 +475,7 @@ public function register_modifier($modifier, $modifier_impl)
* deprecated unregister_modifier
*
* @param string $modifier name of template modifier
* @deprecated
*/
public function unregister_modifier($modifier)
{
Expand All @@ -475,6 +488,7 @@ public function unregister_modifier($modifier)
*
* @param string $type name of resource
* @param array $functions array of functions to handle resource
* @deprecated
*/
public function register_resource($type, $functions)
{
Expand All @@ -486,6 +500,7 @@ public function register_resource($type, $functions)
* deprecated unregister_resource
*
* @param string $type name of resource
* @deprecated
*/
public function unregister_resource($type)
{
Expand All @@ -499,6 +514,7 @@ public function unregister_resource($type)
* @param callable $function
*
* @throws \SmartyException
* @deprecated
*/
public function register_prefilter($function)
{
Expand All @@ -510,6 +526,7 @@ public function register_prefilter($function)
* deprecated unregister_prefilter
*
* @param callable $function
* @deprecated
*/
public function unregister_prefilter($function)
{
Expand All @@ -523,6 +540,7 @@ public function unregister_prefilter($function)
* @param callable $function
*
* @throws \SmartyException
* @deprecated
*/
public function register_postfilter($function)
{
Expand All @@ -534,6 +552,7 @@ public function register_postfilter($function)
* deprecated unregister_postfilter
*
* @param callable $function
* @deprecated
*/
public function unregister_postfilter($function)
{
Expand All @@ -547,6 +566,7 @@ public function unregister_postfilter($function)
* @param callable $function
*
* @throws \SmartyException
* @deprecated
*/
public function register_outputfilter($function)
{
Expand All @@ -558,6 +578,7 @@ public function register_outputfilter($function)
* deprecated unregister_outputfilter
*
* @param callable $function
* @deprecated
*/
public function unregister_outputfilter($function)
{
Expand All @@ -572,6 +593,7 @@ public function unregister_outputfilter($function)
* @param string $name filter name
*
* @throws \SmartyException
* @deprecated
*/
public function load_filter($type, $name)
{
Expand All @@ -588,6 +610,7 @@ public function load_filter($type, $name)
* @param string $exp_time expiration time
*
* @return boolean
* @deprecated
*/
public function clear_cache($tpl_file = null, $cache_id = null, $compile_id = null, $exp_time = null)
{
Expand All @@ -601,6 +624,7 @@ public function clear_cache($tpl_file = null, $cache_id = null, $compile_id = nu
* @param string $exp_time expire time
*
* @return boolean
* @deprecated
*/
public function clear_all_cache($exp_time = null)
{
Expand All @@ -618,6 +642,7 @@ public function clear_all_cache($exp_time = null)
* @return bool
* @throws \Exception
* @throws \SmartyException
* @deprecated
*/
public function is_cached($tpl_file, $cache_id = null, $compile_id = null)
{
Expand All @@ -627,6 +652,7 @@ public function is_cached($tpl_file, $cache_id = null, $compile_id = null)

/**
* deprecated clear_all_assign
* @deprecated
*/
public function clear_all_assign()
{
Expand All @@ -642,6 +668,7 @@ public function clear_all_assign()
* @param string $exp_time
*
* @return boolean results of {@link smarty_core_rm_auto()}
* @deprecated
*/
public function clear_compiled_tpl($tpl_file = null, $compile_id = null, $exp_time = null)
{
Expand All @@ -656,6 +683,7 @@ public function clear_compiled_tpl($tpl_file = null, $compile_id = null, $exp_ti
*
* @return bool
* @throws \SmartyException
* @deprecated
*/
public function template_exists($tpl_file)
{
Expand All @@ -669,6 +697,7 @@ public function template_exists($tpl_file)
* @param string $name
*
* @return array
* @deprecated
*/
public function get_template_vars($name = null)
{
Expand All @@ -682,6 +711,7 @@ public function get_template_vars($name = null)
* @param string $name
*
* @return array
* @deprecated
*/
public function get_config_vars($name = null)
{
Expand All @@ -695,6 +725,7 @@ public function get_config_vars($name = null)
* @param string $file
* @param string $section
* @param string $scope
* @deprecated
*/
public function config_load($file, $section = null, $scope = 'global')
{
Expand All @@ -708,6 +739,7 @@ public function config_load($file, $section = null, $scope = 'global')
* @param string $name
*
* @return object
* @deprecated
*/
public function get_registered_object($name)
{
Expand All @@ -719,6 +751,7 @@ public function get_registered_object($name)
* deprecated clear_config
*
* @param string $var
* @deprecated
*/
public function clear_config($var = null)
{
Expand Down
1 change: 1 addition & 0 deletions htdocs/class/xoopscomments.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
* @package kernel
* @subpackage comments
* @access public
* @deprecated
Copy link

Copilot AI Nov 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The @deprecated tag should follow PHPDoc standards with additional information. According to PHPDoc standards, the @deprecated tag should include a version number and optionally a description or replacement suggestion. For example: @deprecated since version X.X.X Use AlternativeClass instead.

This applies to all deprecated items in this file.

Suggested change
* @deprecated
* @deprecated since 2.5.4 Use \XoopsComment in /kernel/comment.php instead.

Copilot uses AI. Check for mistakes.
*/
class XoopsComments extends XoopsObject
{
Expand Down
3 changes: 2 additions & 1 deletion htdocs/class/xoopseditor/xoopseditor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,8 @@ public function getList($noHtml = false)
* XoopsEditorHandler::render()
*
* @param mixed $editor
* @return
* @return string
* @deprecated
*/
public function render($editor)
{
Expand Down
1 change: 1 addition & 0 deletions htdocs/class/xoopstopic.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@

/**
* Class XoopsTopic
* @deprecated
Copy link

Copilot AI Nov 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The @deprecated tag should follow PHPDoc standards with additional information. According to PHPDoc standards, the @deprecated tag should include a version number and optionally a description or replacement suggestion. For example: @deprecated since version X.X.X Use AlternativeClass instead.

This applies to all deprecated items in this file.

Copilot uses AI. Check for mistakes.
*/
class XoopsTopic
{
Expand Down
1 change: 1 addition & 0 deletions htdocs/include/cp_functions.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,7 @@ function xoops_module_get_admin_menu()
*
* @param string $content
* @return bool
* @deprecated
Copy link

Copilot AI Nov 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The @deprecated tag should follow PHPDoc standards with additional information. According to PHPDoc standards, the @deprecated tag should include a version number and optionally a description or replacement suggestion. For example: @deprecated since version X.X.X Use alternativeFunction() instead.

This applies to all deprecated items in this file.

Suggested change
* @deprecated
* @deprecated since version 2.5.0 This function is deprecated and should not be used. No replacement available.

Copilot uses AI. Check for mistakes.
*/
function xoops_module_write_admin_menu($content)
{
Expand Down
Loading