mirror/php-e107
1
0
Fork 0
mirror of https://github.com/e107inc/e107.git synced 2025-08-10 16:46:50 +02:00
Code Issues Releases Wiki Activity

Generated PHPDoc for all classes in e107_handlers where one was missing. toNumber() updated to always return int or float.

Browse Source
This commit is contained in:
Cameron
2022-04-04 10:54:24 -07:00
parent 813f2bf38f
commit 55980a29a8
104 changed files with 5498 additions and 1221 deletions
Download Patch File Download Diff File Expand all files Collapse all files

241
e107_handlers/pcltar.lib.php
View File

@@ -98,7 +98,15 @@ if (!defined("PCL_TAR"))
// Return Values :
// 1 on success, or an error code (see table at the beginning).
// --------------------------------------------------------------------------------
function PclTarCreate($p_tarname, $p_filelist = "", $p_mode = "", $p_add_dir = "", $p_remove_dir = "")
/**
* @param $p_tarname
* @param $p_filelist
* @param $p_mode
* @param $p_add_dir
* @param $p_remove_dir
* @return int|mixed
*/
function PclTarCreate($p_tarname, $p_filelist = "", $p_mode = "", $p_add_dir = "", $p_remove_dir = "")
{
TrFctStart(__FILE__, __LINE__, "PclTarCreate", "tar={$p_tarname}, file='{$p_filelist}', mode={$p_mode}, add_dir='{$p_add_dir}', remove_dir='{$p_remove_dir}'");
$v_result=1;
@@ -166,7 +174,12 @@ if (!defined("PCL_TAR"))
// 1 on success,
// Or an error code (see list on top).
// --------------------------------------------------------------------------------
function PclTarAdd($p_tarname, $p_filelist)
/**
* @param $p_tarname
* @param $p_filelist
* @return int|mixed
*/
function PclTarAdd($p_tarname, $p_filelist)
{
TrFctStart(__FILE__, __LINE__, "PclTarAdd", "tar={$p_tarname}, file={$p_filelist}");
$v_result=1;
@@ -238,7 +251,15 @@ if (!defined("PCL_TAR"))
// 1 on success,
// Or an error code (see list on top).
// --------------------------------------------------------------------------------
function PclTarAddList($p_tarname, $p_filelist, $p_add_dir="", $p_remove_dir="", $p_mode="")
/**
* @param $p_tarname
* @param $p_filelist
* @param $p_add_dir
* @param $p_remove_dir
* @param $p_mode
* @return array|int|mixed
*/
function PclTarAddList($p_tarname, $p_filelist, $p_add_dir="", $p_remove_dir="", $p_mode="")
{
TrFctStart(__FILE__, __LINE__, "PclTarAddList", "tar={$p_tarname}, file={$p_filelist}, p_add_dir='{$p_add_dir}', p_remove_dir='{$p_remove_dir}', mode={$p_mode}");
$v_result=1;
@@ -312,7 +333,12 @@ if (!defined("PCL_TAR"))
// for ($i=0; $i<sizeof($v_list); $i++)
// echo "Filename :'".$v_list[$i][filename]."'<br>";
// --------------------------------------------------------------------------------
function PclTarList($p_tarname, $p_mode="")
/**
* @param $p_tarname
* @param $p_mode
* @return array|int
*/
function PclTarList($p_tarname, $p_mode="")
{
TrFctStart(__FILE__, __LINE__, "PclTarList", "tar={$p_tarname}, mode='{$p_mode}'");
$v_result=1;
@@ -366,7 +392,14 @@ if (!defined("PCL_TAR"))
// Return Values :
// Same as PclTarList()
// --------------------------------------------------------------------------------
function PclTarExtract($p_tarname, $p_path="./", $p_remove_path="", $p_mode="")
/**
* @param $p_tarname
* @param $p_path
* @param $p_remove_path
* @param $p_mode
* @return int|mixed
*/
function PclTarExtract($p_tarname, $p_path="./", $p_remove_path="", $p_mode="")
{
TrFctStart(__FILE__, __LINE__, "PclTarExtract", "tar='{$p_tarname}', path='{$p_path}', remove_path='{$p_remove_path}', mode='{$p_mode}'");
$v_result=1;
@@ -425,7 +458,15 @@ if (!defined("PCL_TAR"))
// Return Values :
// Same as PclTarList()
// --------------------------------------------------------------------------------
function PclTarExtractList($p_tarname, $p_filelist, $p_path="./", $p_remove_path="", $p_mode="")
/**
* @param $p_tarname
* @param $p_filelist
* @param $p_path
* @param $p_remove_path
* @param $p_mode
* @return int|mixed
*/
function PclTarExtractList($p_tarname, $p_filelist, $p_path="./", $p_remove_path="", $p_mode="")
{
TrFctStart(__FILE__, __LINE__, "PclTarExtractList", "tar={$p_tarname}, list, path={$p_path}, remove_path='{$p_remove_path}', mode='{$p_mode}'");
$v_result=1;
@@ -514,7 +555,15 @@ if (!defined("PCL_TAR"))
// Return Values :
// Same as PclTarList()
// --------------------------------------------------------------------------------
function PclTarExtractIndex($p_tarname, $p_index, $p_path="./", $p_remove_path="", $p_mode="")
/**
* @param $p_tarname
* @param $p_index
* @param $p_path
* @param $p_remove_path
* @param $p_mode
* @return int|mixed
*/
function PclTarExtractIndex($p_tarname, $p_index, $p_path="./", $p_remove_path="", $p_mode="")
{
TrFctStart(__FILE__, __LINE__, "PclTarExtractIndex", "tar={$p_tarname}, index='{$p_index}', path={$p_path}, remove_path='{$p_remove_path}', mode='{$p_mode}'");
$v_result=1;
@@ -583,7 +632,13 @@ if (!defined("PCL_TAR"))
// Return Values :
// List of the files which are kept in the archive (same format as PclTarList())
// --------------------------------------------------------------------------------
function PclTarDelete($p_tarname, $p_filelist, $p_mode="")
/**
* @param $p_tarname
* @param $p_filelist
* @param $p_mode
* @return int|mixed
*/
function PclTarDelete($p_tarname, $p_filelist, $p_mode="")
{
TrFctStart(__FILE__, __LINE__, "PclTarDelete", "tar='{$p_tarname}', list='{$p_filelist}', mode='{$p_mode}'");
$v_result=1;
@@ -656,7 +711,15 @@ if (!defined("PCL_TAR"))
// List of the files contained in the archive. The field status contains
// "updated", "not_updated", "added" or "ok" for the files not concerned.
// --------------------------------------------------------------------------------
function PclTarUpdate($p_tarname, $p_filelist, $p_mode="", $p_add_dir="", $p_remove_dir="")
/**
* @param $p_tarname
* @param $p_filelist
* @param $p_mode
* @param $p_add_dir
* @param $p_remove_dir
* @return int|mixed
*/
function PclTarUpdate($p_tarname, $p_filelist, $p_mode="", $p_add_dir="", $p_remove_dir="")
{
TrFctStart(__FILE__, __LINE__, "PclTarUpdate", "tar='{$p_tarname}', list='{$p_filelist}', mode='{$p_mode}'");
$v_result=1;
@@ -730,7 +793,14 @@ if (!defined("PCL_TAR"))
// List of the files contained in the archive. The field status contains
// "updated", "not_updated", "added" or "ok" for the files not concerned.
// --------------------------------------------------------------------------------
function PclTarMerge($p_tarname, $p_tarname_add, $p_mode="", $p_mode_add="")
/**
* @param $p_tarname
* @param $p_tarname_add
* @param $p_mode
* @param $p_mode_add
* @return int|mixed
*/
function PclTarMerge($p_tarname, $p_tarname_add, $p_mode="", $p_mode_add="")
{
TrFctStart(__FILE__, __LINE__, "PclTarMerge", "tar='{$p_tarname}', tar_add='{$p_tarname_add}', mode='{$p_mode}', mode_add='{$p_mode_add}'");
$v_result=1;
@@ -1045,7 +1115,15 @@ if (!defined("PCL_TAR"))
// $p_mode : "tar" for normal tar archive, "tgz" for gzipped tar archive
// Return Values :
// --------------------------------------------------------------------------------
function PclTarHandleCreate($p_tarname, $p_list, $p_mode, $p_add_dir="", $p_remove_dir="")
/**
* @param $p_tarname
* @param $p_list
* @param $p_mode
* @param $p_add_dir
* @param $p_remove_dir
* @return int|mixed
*/
function PclTarHandleCreate($p_tarname, $p_list, $p_mode, $p_add_dir="", $p_remove_dir="")
{
TrFctStart(__FILE__, __LINE__, "PclTarHandleCreate", "tar=$p_tarname, list, mode=$p_mode, add_dir='$p_add_dir', remove_dir='$p_remove_dir'");
$v_result=1;
@@ -1129,7 +1207,16 @@ if (!defined("PCL_TAR"))
// $p_mode : "tar" for normal tar archive, "tgz" for gzipped tar archive
// Return Values :
// --------------------------------------------------------------------------------
function PclTarHandleAppend($p_tarname, $p_list, $p_mode, &$p_list_detail, $p_add_dir, $p_remove_dir)
/**
* @param $p_tarname
* @param $p_list
* @param $p_mode
* @param $p_list_detail
* @param $p_add_dir
* @param $p_remove_dir
* @return int|mixed
*/
function PclTarHandleAppend($p_tarname, $p_list, $p_mode, &$p_list_detail, $p_add_dir, $p_remove_dir)
{
TrFctStart(__FILE__, __LINE__, "PclTarHandleAppend", "tar=$p_tarname, list, mode=$p_mode");
$v_result=1;
@@ -1314,7 +1401,16 @@ if (!defined("PCL_TAR"))
// $p_remove_dir : Path to remove in the filename path archived
// Return Values :
// --------------------------------------------------------------------------------
function PclTarHandleAddList($p_tar, $p_list, $p_mode, &$p_list_detail, $p_add_dir, $p_remove_dir)
/**
* @param $p_tar
* @param $p_list
* @param $p_mode
* @param $p_list_detail
* @param $p_add_dir
* @param $p_remove_dir
* @return int|mixed
*/
function PclTarHandleAddList($p_tar, $p_list, $p_mode, &$p_list_detail, $p_add_dir, $p_remove_dir)
{
TrFctStart(__FILE__, __LINE__, "PclTarHandleAddList", "tar='$p_tar', list, mode='$p_mode', add_dir='$p_add_dir', remove_dir='$p_remove_dir'");
$v_result=1;
@@ -1464,7 +1560,16 @@ if (!defined("PCL_TAR"))
// Parameters :
// Return Values :
// --------------------------------------------------------------------------------
function PclTarHandleAddFile($p_tar, $p_filename, $p_mode, &$p_header, $p_add_dir, $p_remove_dir)
/**
* @param $p_tar
* @param $p_filename
* @param $p_mode
* @param $p_header
* @param $p_add_dir
* @param $p_remove_dir
* @return int|mixed
*/
function PclTarHandleAddFile($p_tar, $p_filename, $p_mode, &$p_header, $p_add_dir, $p_remove_dir)
{
TrFctStart(__FILE__, __LINE__, "PclTarHandleAddFile", "tar='$p_tar', filename='$p_filename', p_mode='$p_mode', add_dir='$p_add_dir', remove_dir='$p_remove_dir'");
$v_result=1;
@@ -1614,7 +1719,15 @@ if (!defined("PCL_TAR"))
// $p_header : A pointer to a array where will be set the file properties
// Return Values :
// --------------------------------------------------------------------------------
function PclTarHandleHeader($p_tar, $p_filename, $p_mode, &$p_header, $p_stored_filename)
/**
* @param $p_tar
* @param $p_filename
* @param $p_mode
* @param $p_header
* @param $p_stored_filename
* @return int|mixed
*/
function PclTarHandleHeader($p_tar, $p_filename, $p_mode, &$p_header, $p_stored_filename)
{
TrFctStart(__FILE__, __LINE__, "PclTarHandleHeader", "tar=$p_tar, file='$p_filename', mode='$p_mode', stored_filename='$p_stored_filename'");
$v_result=1;
@@ -1760,7 +1873,12 @@ if (!defined("PCL_TAR"))
// Parameters :
// Return Values :
// --------------------------------------------------------------------------------
function PclTarHandleFooter($p_tar, $p_mode)
/**
* @param $p_tar
* @param $p_mode
* @return int
*/
function PclTarHandleFooter($p_tar, $p_mode)
{
TrFctStart(__FILE__, __LINE__, "PclTarHandleFooter", "tar='$p_tar', p_mode=$p_mode");
$v_result=1;
@@ -1798,7 +1916,17 @@ if (!defined("PCL_TAR"))
// $p_path and $p_remove_path are commulative.
// Return Values :
// --------------------------------------------------------------------------------
function PclTarHandleExtract($p_tarname, $p_file_list, &$p_list_detail, $p_mode, $p_path, $p_tar_mode, $p_remove_path)
/**
* @param $p_tarname
* @param $p_file_list
* @param $p_list_detail
* @param $p_mode
* @param $p_path
* @param $p_tar_mode
* @param $p_remove_path
* @return int|mixed
*/
function PclTarHandleExtract($p_tarname, $p_file_list, &$p_list_detail, $p_mode, $p_path, $p_tar_mode, $p_remove_path)
{
TrFctStart(__FILE__, __LINE__, "PclTarHandleExtract", "archive='$p_tarname', list, mode=$p_mode, path=$p_path, tar_mode=$p_tar_mode, remove_path='$p_remove_path'");
$v_result=1;
@@ -2212,7 +2340,16 @@ if (!defined("PCL_TAR"))
// are allowed.
// Return Values :
// --------------------------------------------------------------------------------
function PclTarHandleExtractByIndexList($p_tarname, $p_index_string, &$p_list_detail, $p_path, $p_remove_path, $p_tar_mode)
/**
* @param $p_tarname
* @param $p_index_string
* @param $p_list_detail
* @param $p_path
* @param $p_remove_path
* @param $p_tar_mode
* @return int|mixed
*/
function PclTarHandleExtractByIndexList($p_tarname, $p_index_string, &$p_list_detail, $p_path, $p_remove_path, $p_tar_mode)
{
TrFctStart(__FILE__, __LINE__, "PclTarHandleExtractByIndexList", "archive='$p_tarname', index_string='$p_index_string', list, path=$p_path, remove_path='$p_remove_path', tar_mode=$p_tar_mode");
$v_result=1;
@@ -2301,7 +2438,18 @@ if (!defined("PCL_TAR"))
// Parameters :
// Return Values :
// --------------------------------------------------------------------------------
function PclTarHandleExtractByIndex($p_tar, &$p_index_current, $p_index_start, $p_index_stop, &$p_list_detail, $p_path, $p_remove_path, $p_tar_mode)
/**
* @param $p_tar
* @param $p_index_current
* @param $p_index_start
* @param $p_index_stop
* @param $p_list_detail
* @param $p_path
* @param $p_remove_path
* @param $p_tar_mode
* @return int|mixed
*/
function PclTarHandleExtractByIndex($p_tar, &$p_index_current, $p_index_start, $p_index_stop, &$p_list_detail, $p_path, $p_remove_path, $p_tar_mode)
{
TrFctStart(__FILE__, __LINE__, "PclTarHandleExtractByIndex", "archive_descr='$p_tar', index_current=$p_index_current, index_start='$p_index_start', index_stop='$p_index_stop', list, path=$p_path, remove_path='$p_remove_path', tar_mode=$p_tar_mode");
$v_result=1;
@@ -2433,7 +2581,15 @@ if (!defined("PCL_TAR"))
// Parameters :
// Return Values :
// --------------------------------------------------------------------------------
function PclTarHandleExtractFile($p_tar, &$v_header, $p_path, $p_remove_path, $p_tar_mode)
/**
* @param $p_tar
* @param $v_header
* @param $p_path
* @param $p_remove_path
* @param $p_tar_mode
* @return int|mixed
*/
function PclTarHandleExtractFile($p_tar, &$v_header, $p_path, $p_remove_path, $p_tar_mode)
{
TrFctStart(__FILE__, __LINE__, "PclTarHandleExtractFile", "archive_descr='$p_tar', path=$p_path, remove_path='$p_remove_path', tar_mode=$p_tar_mode");
$v_result=1;
@@ -2631,7 +2787,14 @@ if (!defined("PCL_TAR"))
// Parameters :
// Return Values :
// --------------------------------------------------------------------------------
function PclTarHandleDelete($p_tarname, $p_file_list, &$p_list_detail, $p_tar_mode)
/**
* @param $p_tarname
* @param $p_file_list
* @param $p_list_detail
* @param $p_tar_mode
* @return int|mixed
*/
function PclTarHandleDelete($p_tarname, $p_file_list, &$p_list_detail, $p_tar_mode)
{
TrFctStart(__FILE__, __LINE__, "PclTarHandleDelete", "archive='$p_tarname', list, tar_mode=$p_tar_mode");
$v_result=1;
@@ -2884,7 +3047,16 @@ if (!defined("PCL_TAR"))
// Parameters :
// Return Values :
// --------------------------------------------------------------------------------
function PclTarHandleUpdate($p_tarname, $p_file_list, &$p_list_detail, $p_tar_mode, $p_add_dir, $p_remove_dir)
/**
* @param $p_tarname
* @param $p_file_list
* @param $p_list_detail
* @param $p_tar_mode
* @param $p_add_dir
* @param $p_remove_dir
* @return int|mixed
*/
function PclTarHandleUpdate($p_tarname, $p_file_list, &$p_list_detail, $p_tar_mode, $p_add_dir, $p_remove_dir)
{
TrFctStart(__FILE__, __LINE__, "PclTarHandleUpdate", "archive='$p_tarname', list, tar_mode=$p_tar_mode");
$v_result=1;
@@ -3262,7 +3434,12 @@ if (!defined("PCL_TAR"))
// Parameters :
// Return Values :
// --------------------------------------------------------------------------------
function PclTarHandleReadHeader($v_binary_data, &$v_header)
/**
* @param $v_binary_data
* @param $v_header
* @return int|mixed
*/
function PclTarHandleReadHeader($v_binary_data, &$v_header)
{
TrFctStart(__FILE__, __LINE__, "PclTarHandleReadHeader", "");
$v_result=1;
@@ -3408,7 +3585,11 @@ if (!defined("PCL_TAR"))
// 1 : OK
// -1 : Unable to create directory
// --------------------------------------------------------------------------------
function PclTarHandlerDirCheck($p_dir)
/**
* @param $p_dir
* @return int|mixed
*/
function PclTarHandlerDirCheck($p_dir)
{
$v_result = 1;
@@ -3472,7 +3653,11 @@ if (!defined("PCL_TAR"))
// Parameters :
// Return Values :
// --------------------------------------------------------------------------------
function PclTarHandleExtension($p_tarname)
/**
* @param $p_tarname
* @return string
*/
function PclTarHandleExtension($p_tarname)
{
TrFctStart(__FILE__, __LINE__, "PclTarHandleExtension", "tar=$p_tarname");
@@ -3510,7 +3695,11 @@ if (!defined("PCL_TAR"))
// Parameters :
// Return Values :
// --------------------------------------------------------------------------------
function PclTarHandlePathReduction($p_dir)
/**
* @param $p_dir
* @return string
*/
function PclTarHandlePathReduction($p_dir)
{
TrFctStart(__FILE__, __LINE__, "PclTarHandlePathReduction", "dir='$p_dir'");
$v_result = "";