Skip to content
Open

PhpDoc #1558

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
46 changes: 23 additions & 23 deletions htdocs/Frameworks/art/functions.cache.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
define('FRAMEWORKS_ART_FUNCTIONS_CACHE', true);

/**
* @param null|array $groups
* @param array|null $groups
*
* @return string
*/
Expand All @@ -37,7 +37,7 @@ function mod_generateCacheId_byGroup($groups = null)
}

/**
* @param null $groups
* @param mixed $groups
*
* @return string
*/
Expand All @@ -47,9 +47,9 @@ function mod_generateCacheId($groups = null)
}

/**
* @param $data
* @param null|string $name
* @param null|string $dirname
* @param mixed $data
* @param string|null $name
* @param string|null $dirname
* @param string $root_path
*
* @return bool
Expand All @@ -68,9 +68,9 @@ function mod_createFile($data, $name = null, $dirname = null, $root_path = XOOPS
}

/**
* @param $data
* @param null $name
* @param null $dirname
* @param mixed $data
* @param string|null $name
* @param string|null $dirname
*
* @return bool
*/
Expand All @@ -80,10 +80,10 @@ function mod_createCacheFile($data, $name = null, $dirname = null)
}

/**
* @param $data
* @param null|string $name
* @param null $dirname
* @param null $groups
* @param mixed $data
* @param string|null $name
* @param string|null $dirname
* @param mixed $groups
*
* @return bool
*/
Expand All @@ -95,8 +95,8 @@ function mod_createCacheFile_byGroup($data, $name = null, $dirname = null, $grou
}

/**
* @param $name
* @param null|string $dirname
* @param string $name
* @param string|null $dirname
* @param string $root_path
*
* @return mixed|null
Expand All @@ -118,10 +118,10 @@ function mod_loadFile($name, $dirname = null, $root_path = XOOPS_CACHE_PATH)
}

/**
* @param $name
* @param null $dirname
* @param string $name
* @param string|null $dirname
*
* @return mixed|null
* @return mixed
*/
function mod_loadCacheFile($name, $dirname = null)
{
Expand All @@ -131,11 +131,11 @@ function mod_loadCacheFile($name, $dirname = null)
}

/**
* @param $name
* @param null $dirname
* @param null $groups
* @param string $name
* @param string|null $dirname
* @param mixed $groups
*
* @return mixed|null
* @return mixed
*/
function mod_loadCacheFile_byGroup($name, $dirname = null, $groups = null)
{
Expand All @@ -149,7 +149,7 @@ function mod_loadCacheFile_byGroup($name, $dirname = null, $groups = null)

/**
* @param string $name
* @param null $dirname
* @param string|null $dirname
* @param string $root_path
*
* @return bool
Expand Down Expand Up @@ -178,7 +178,7 @@ function mod_clearFile($name = '', $dirname = null, $root_path = XOOPS_CACHE_PAT

/**
* @param string $name
* @param null $dirname
* @param string|null $dirname
*
* @return bool
*/
Expand Down
2 changes: 1 addition & 1 deletion htdocs/Frameworks/art/functions.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
*
* In some cases mysql_get_client_info is required instead
*
* @param null $conn
* @param mysqli|null $conn
*
* @return string
*/
Expand Down
2 changes: 1 addition & 1 deletion htdocs/Frameworks/art/object.php
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ public function __construct(XoopsMySQLDatabase $db, $table = '', $className = ''
/**
* get MySQL server version
*
* @param null|XoopsDatabase|mysqli $conn
* @param XoopsDatabase|mysqli|null $conn
*
* @return string
*/
Expand Down
4 changes: 3 additions & 1 deletion htdocs/class/auth/auth.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@
* @author Pierre-Eric MENUET <[email protected]>
*/

defined('XOOPS_ROOT_PATH') || exit('Restricted access');
if (!defined('XOOPS_ROOT_PATH')) {
throw new \RuntimeException('Restricted access');
}

/**
*
Expand Down
4 changes: 3 additions & 1 deletion htdocs/class/auth/auth_ads.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@
* @author Pierre-Eric MENUET <[email protected]>
*/

defined('XOOPS_ROOT_PATH') || exit('Restricted access');
if (!defined('XOOPS_ROOT_PATH')) {
throw new \RuntimeException('Restricted access');
}

/**
*
Expand Down
49 changes: 34 additions & 15 deletions htdocs/class/auth/auth_ldap.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@
* @since 2.0
* @author Pierre-Eric MENUET <[email protected]>
*/
defined('XOOPS_ROOT_PATH') || exit('Restricted access');
if (!defined('XOOPS_ROOT_PATH')) {
throw new \RuntimeException('Restricted access');
}

/**
*
Expand Down Expand Up @@ -157,19 +159,36 @@ class XoopsAuthLdap extends XoopsAuth
* LATIN CAPITAL LETTER Y WITH DIAERESIS
*/

public $ldap_server;
public $ldap_port = '389';
public $ldap_version = '3';
public $ldap_base_dn;
public $ldap_loginname_asdn;
public $ldap_loginldap_attr;
public $ldap_mail_attr;
public $ldap_name_attr;
public $ldap_surname_attr;
public $ldap_givenname_attr;
public $ldap_manager_dn;
public $ldap_manager_pass;
public $_ds;
public string $ldap_server;
public int $ldap_port = 389;
public string $ldap_version = '3';
public string $ldap_base_dn;
public bool $ldap_loginname_asdn;
public string $ldap_loginldap_attr;
public string $ldap_mail_attr;
public string $ldap_name_attr;
public string $ldap_surname_attr;
public string $ldap_givenname_attr;
public string $ldap_manager_dn;
public string $ldap_manager_pass;
public string $ldap_filter_person;
public bool $ldap_use_TLS;
public string $ldap_domain_name;
public string $ldap_provisionning;
public string $ldap_provisionning_upd;
public array $ldap_provisionning_group;
public string $ldap_field_mapping;
public array $ldap_users_bypass;
public string $ldap_filter_person_adv;
public string $ldap_filter_attr;
public string $ldap_filter_value;
public string $ldap_filter_operator;
public string $ldap_filter_groupattr;
public string $ldap_filter_groupvalue;
public string $ldap_filter_member;
public string $ldap_filter_memberattr;
public string $ldap_filter_membervalue;
public mixed $_ds;

/**
* Authentication Service constructor
Expand Down Expand Up @@ -285,7 +304,7 @@ public function getUserDN($uname)
* Load user from XOOPS Database
*
* @param string $uname
* @return XoopsUser object
* @return string XoopsUser object
*/
public function getFilter($uname)
{
Expand Down
60 changes: 37 additions & 23 deletions htdocs/class/auth/auth_provisionning.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@
* @since 2.0
* @author Pierre-Eric MENUET <[email protected]>
*/
defined('XOOPS_ROOT_PATH') || exit('Restricted access');
if (!defined('XOOPS_ROOT_PATH')) {
throw new \RuntimeException('Restricted access');
}

/**
*
Expand All @@ -29,7 +31,15 @@
*/
class XoopsAuthProvisionning
{
protected $_auth_instance;
protected ?XoopsAuth $_auth_instance;
protected string $ldap_provisionning;
protected string $ldap_provisionning_upd;
protected array $ldap_provisionning_group;
protected string $ldap_field_mapping;
protected string $default_TZ;
protected string $theme_set;
protected string $com_mode;
protected string $com_order;

/**
* XoopsAuthProvisionning::getInstance()
Expand All @@ -50,7 +60,7 @@ public static function getInstance(?XoopsAuth $auth_instance = null)

/**
* Authentication Service constructor
* @param XoopsAuth $auth_instance
* @param XoopsAuth|null $auth_instance
*/
public function __construct(?XoopsAuth $auth_instance = null)
{
Expand All @@ -71,8 +81,8 @@ public function __construct(?XoopsAuth $auth_instance = null)
/**
* Return a Xoops User Object
*
* @param $uname
* @return XoopsUser or false
* @param string $uname
* @return XoopsUser|false
*/
public function getXoopsUser($uname)
{
Expand All @@ -90,19 +100,23 @@ public function getXoopsUser($uname)
/**
* Launch the synchronisation process
*
* @param $datas
* @param $uname
* @param null $pwd
* @return bool
* @param array $datas
* @param string $uname
* @param string|null $pwd
* @return XoopsUser|false
*/
public function sync($datas, $uname, $pwd = null)
{
$xoopsUser = $this->getXoopsUser($uname);
if (!$xoopsUser) { // Xoops User Database not exists
if ($this->ldap_provisionning) {
$xoopsUser = $this->add($datas, $uname, $pwd);
} else {
} elseif ($this->_auth_instance) {
$this->_auth_instance->setErrors(0, sprintf(_AUTH_LDAP_XOOPS_USER_NOTFOUND, $uname));
} else {
// If no auth instance, we cannot set errors
// This is a fallback for legacy code
trigger_error(sprintf(_AUTH_LDAP_XOOPS_USER_NOTFOUND, $uname), E_USER_WARNING);
}
} else { // Xoops User Database exists
if ($this->ldap_provisionning && $this->ldap_provisionning_upd) {
Expand All @@ -116,20 +130,20 @@ public function sync($datas, $uname, $pwd = null)
/**
* Add a new user to the system
*
* @param $datas
* @param $uname
* @param null $pwd
* @return bool
* @param array $datas
* @param string $uname
* @param string|null $pwd
* @return XoopsUser|false
*/
public function add($datas, $uname, $pwd = null)
{
$ret = false;
$ret = false;
/** @var XoopsMemberHandler $member_handler */
$member_handler = xoops_getHandler('member');
// Create XOOPS Database User
$newuser = $member_handler->createUser();
$newuser->setVar('uname', $uname);
$newuser->setVar('pass', password_hash(stripslashes($pwd), PASSWORD_DEFAULT));
$newuser->setVar('pass', password_hash(stripslashes((string)$pwd), PASSWORD_DEFAULT));
$newuser->setVar('rank', 0);
$newuser->setVar('level', 1);
$newuser->setVar('timezone_offset', $this->default_TZ);
Expand Down Expand Up @@ -160,18 +174,18 @@ public function add($datas, $uname, $pwd = null)
/**
* Modify user information
*
* @param $xoopsUser
* @param $datas
* @param $uname
* @param null $pwd
* @return bool
* @param XoopsUser $xoopsUser
* @param array $datas
* @param string $uname
* @param string|null $pwd
* @return XoopsUser|false
*/
public function change($xoopsUser, $datas, $uname, $pwd = null)
{
$ret = false;
$ret = false;
/** @var XoopsMemberHandler $member_handler */
$member_handler = xoops_getHandler('member');
$xoopsUser->setVar('pass', password_hash(stripcslashes($pwd), PASSWORD_DEFAULT));
$xoopsUser->setVar('pass', password_hash(stripcslashes((string)$pwd), PASSWORD_DEFAULT));
$tab_mapping = explode('|', $this->ldap_field_mapping);
foreach ($tab_mapping as $mapping) {
$fields = explode('=', trim($mapping));
Expand Down
8 changes: 5 additions & 3 deletions htdocs/class/auth/auth_xoops.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@
* @author Pierre-Eric MENUET <[email protected]>
*/

defined('XOOPS_ROOT_PATH') || exit('Restricted access');
if (!defined('XOOPS_ROOT_PATH')) {
throw new \RuntimeException('Restricted access');
}

/**
*
Expand All @@ -43,8 +45,8 @@ public function __construct(?XoopsDatabase $dao = null)
* Authenticate user
*
* @param string $uname
* @param string $pwd
* @return bool
* @param string|null $pwd
* @return XoopsUser|bool
*/
public function authenticate($uname, $pwd = null)
{
Expand Down
4 changes: 3 additions & 1 deletion htdocs/class/auth/authfactory.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@
* @author Pierre-Eric MENUET <[email protected]>
*/

defined('XOOPS_ROOT_PATH') || exit('Restricted access');
if (!defined('XOOPS_ROOT_PATH')) {
throw new \RuntimeException('Restricted access');
}

/**
*
Expand Down
Loading