Skip to content

Commit

Permalink
Merge pull request #1408 from mambax7/feature/1196
Browse files Browse the repository at this point in the history 
PhpDoc updates #1196
  • Loading branch information
@geekwright
geekwright authored Nov 7, 2023
2 parents 838aafa + 43a864e commit 83df4b2
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 46 deletions.
9 changes: 4 additions & 5 deletions htdocs/kernel/avatar.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ public function delete(XoopsObject $avatar)
*
* @param CriteriaElement|CriteriaCompo $criteria
* @param bool $id_as_key
* @return object
* @return array
*/
public function &getObjects(CriteriaElement $criteria = null, $id_as_key = false)
{
Expand Down Expand Up @@ -379,7 +379,7 @@ public function addUser($avatar_id, $user_id)
* Get User
*
* @param XoopsAvatar $avatar
* @return array
* @return array|false
*/
public function getUser(XoopsAvatar $avatar)
{
Expand All @@ -406,7 +406,7 @@ public function getUser(XoopsAvatar $avatar)
/**
* Get a list of Avatars
*
* @param string $avatar_type 'S' for system, 'C' for custom
* @param string|null $avatar_type 'S' for system, 'C' for custom
* @param bool|null $avatar_display null lists all, bool respects avatar_display
* @return array
*/
Expand All @@ -421,8 +421,7 @@ public function getList($avatar_type = null, $avatar_display = null)
$criteria->add(new Criteria('avatar_display', (int)$avatar_display));
}
$avatars = &$this->getObjects($criteria, true);
$ret = array(
'blank.gif' => _NONE);
$ret = array('blank.gif' => _NONE);
foreach (array_keys($avatars) as $i) {
$ret[$avatars[$i]->getVar('avatar_file')] = $avatars[$i]->getVar('avatar_name');
}
Expand Down
50 changes: 25 additions & 25 deletions htdocs/kernel/object.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@ public function destroyVars($var)
}

/**
* @param $var
* @param mixed $var
* @return bool
* @deprecated use destroyVars() instead, destoryVars() will be removed in the next major release
*/
Expand Down Expand Up @@ -1009,7 +1009,7 @@ public function __clone()
/**
* add an error
*
* @param $err_str
* @param array|string $err_str
* @internal param string $value error to add
* @access public
*/
Expand Down Expand Up @@ -1375,8 +1375,8 @@ public function create($isNew = true)
*
* @access protected
* @param mixed $id ID
* @param array $fields fields to fetch
* @return XoopsObject {@link XoopsObject}
* @param array|null $fields fields to fetch
* @return XoopsObject|null {@link XoopsObject}
*/
public function get($id = null, $fields = null)
{
Expand Down Expand Up @@ -1447,10 +1447,10 @@ public function delete(XoopsObject $object, $force = false)
/**
* delete all objects matching the conditions
*
* @param CriteriaElement $criteria {@link CriteriaElement} with conditions to meet
* @param \CriteriaElement|null $criteria {@link CriteriaElement} with conditions to meet
* @param bool $force force to delete
* @param bool $asObject delete in object way: instantiate all objects and delete one by one
* @return bool
* @return bool|int
*/
public function deleteAll(CriteriaElement $criteria = null, $force = true, $asObject = false)
{
Expand All @@ -1464,7 +1464,7 @@ public function deleteAll(CriteriaElement $criteria = null, $force = true, $asOb
*
* @param string $fieldname Name of the field
* @param mixed $fieldvalue Value to write
* @param CriteriaElement $criteria {@link CriteriaElement}
* @param \CriteriaElement|null $criteria {@link CriteriaElement}
* @param bool $force force to query
* @return bool
*/
Expand All @@ -1485,7 +1485,7 @@ public function updateAll($fieldname, $fieldvalue, CriteriaElement $criteria = n
/**
* Retrieve objects from the database
*
* @param CriteriaElement $criteria {@link CriteriaElement} conditions to be met
* @param \CriteriaElement|null $criteria {@link CriteriaElement} conditions to be met
* @param bool $id_as_key use the ID as key for the array
* @param bool $as_object return an array of objects
* @return array
Expand All @@ -1501,8 +1501,8 @@ public function &getObjects(CriteriaElement $criteria = null, $id_as_key = false
/**
* get all objects matching a condition
*
* @param CriteriaElement $criteria {@link CriteriaElement} to match
* @param array $fields variables to fetch
* @param \CriteriaElement|null $criteria {@link CriteriaElement} to match
* @param array|null $fields variables to fetch
* @param bool $asObject flag indicating as object, otherwise as array
* @param bool $id_as_key use the ID as key for the array
* @return array of objects/array {@link XoopsObject}
Expand All @@ -1518,7 +1518,7 @@ public function &getAll(CriteriaElement $criteria = null, $fields = null, $asObj
/**
* Retrieve a list of objects data
*
* @param CriteriaElement $criteria {@link CriteriaElement} conditions to be met
* @param \CriteriaElement|null $criteria {@link CriteriaElement} conditions to be met
* @param int $limit Max number of objects to fetch
* @param int $start Which record to start at
* @return array
Expand All @@ -1534,7 +1534,7 @@ public function getList(CriteriaElement $criteria = null, $limit = 0, $start = 0
/**
* get IDs of objects matching a condition
*
* @param CriteriaElement $criteria {@link CriteriaElement} to match
* @param \CriteriaElement|null $criteria {@link CriteriaElement} to match
* @return array of object IDs
*/
public function &getIds(CriteriaElement $criteria = null)
Expand All @@ -1552,8 +1552,8 @@ public function &getIds(CriteriaElement $criteria = null)
*
* @param int $limit Max number of objects to fetch
* @param int $start Which record to start at
* @param CriteriaElement $criteria {@link CriteriaElement} to match
* @param array $fields variables to fetch
* @param \CriteriaElement|null $criteria {@link CriteriaElement} to match
* @param array|null $fields variables to fetch
* @param bool $asObject flag indicating as object, otherwise as array
* @return array of objects {@link XoopsObject}
*/
Expand All @@ -1575,7 +1575,7 @@ public function &getByLimit($limit = 0, $start = 0, CriteriaElement $criteria =
/**
* count objects matching a condition
*
* @param CriteriaElement $criteria {@link CriteriaElement} to match
* @param \CriteriaElement|null $criteria {@link CriteriaElement} to match
* @return int count of objects
*/
public function getCount(CriteriaElement $criteria = null)
Expand All @@ -1588,7 +1588,7 @@ public function getCount(CriteriaElement $criteria = null)
/**
* Get counts of objects matching a condition
*
* @param CriteriaElement $criteria {@link CriteriaElement} to match
* @param \CriteriaElement|null $criteria {@link CriteriaElement} to match
* @return array of counts
*/
public function getCounts(CriteriaElement $criteria = null)
Expand All @@ -1608,11 +1608,11 @@ public function getCounts(CriteriaElement $criteria = null)
/**
* get a list of objects matching a condition joint with another related object
*
* @param CriteriaElement $criteria {@link CriteriaElement} to match
* @param array $fields variables to fetch
* @param \CriteriaElement|null $criteria {@link CriteriaElement} to match
* @param array|null $fields variables to fetch
* @param bool $asObject flag indicating as object, otherwise as array
* @param string $field_link field of linked object for JOIN
* @param string $field_object field of current object for JOIN
* @param string|null $field_link field of linked object for JOIN
* @param string|null $field_object field of current object for JOIN
* @return array of objects {@link XoopsObject}
*/
public function &getByLink(CriteriaElement $criteria = null, $fields = null, $asObject = true, $field_link = null, $field_object = null)
Expand All @@ -1626,7 +1626,7 @@ public function &getByLink(CriteriaElement $criteria = null, $fields = null, $as
/**
* Count of objects matching a condition
*
* @param CriteriaElement $criteria {@link CriteriaElement} to match
* @param \CriteriaElement|null $criteria {@link CriteriaElement} to match
* @return int count of objects
*/
public function getCountByLink(CriteriaElement $criteria = null)
Expand All @@ -1640,7 +1640,7 @@ public function getCountByLink(CriteriaElement $criteria = null)
/**
* array of count of objects matching a condition of, groupby linked object keyname
*
* @param CriteriaElement $criteria {@link CriteriaElement} to match
* @param \CriteriaElement|null $criteria {@link CriteriaElement} to match
* @return int count of objects
*/
public function getCountsByLink(CriteriaElement $criteria = null)
Expand All @@ -1655,7 +1655,7 @@ public function getCountsByLink(CriteriaElement $criteria = null)
* update objects matching a condition against linked objects
*
* @param array $data array of key => value
* @param CriteriaElement $criteria {@link CriteriaElement} to match
* @param \CriteriaElement|null $criteria {@link CriteriaElement} to match
* @return int count of objects
*/
public function updateByLink($data, CriteriaElement $criteria = null)
Expand All @@ -1669,8 +1669,8 @@ public function updateByLink($data, CriteriaElement $criteria = null)
/**
* Delete objects matching a condition against linked objects
*
* @param CriteriaElement $criteria {@link CriteriaElement} to match
* @return int count of objects
* @param \CriteriaElement|null $criteria {@link CriteriaElement} to match
* @return int|null count of objects
*/
public function deleteByLink(CriteriaElement $criteria = null)
{
Expand Down
6 changes: 3 additions & 3 deletions htdocs/kernel/online.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,8 @@ public function gc($expire)
/**
* Get an array of online information
*
* @param CriteriaElement|CriteriaCompo $criteria {@link CriteriaElement}
* @return array Array of associative arrays of online information
* @param CriteriaElement|CriteriaCompo|null $criteria {@link CriteriaElement}
* @return array|false Array of associative arrays of online information
*/
public function getAll(CriteriaElement $criteria = null)
{
Expand All @@ -184,7 +184,7 @@ public function getAll(CriteriaElement $criteria = null)
/**
* Count the number of online users
*
* @param CriteriaElement|CriteriaCompo $criteria {@link CriteriaElement}
* @param CriteriaElement|CriteriaCompo|null $criteria {@link CriteriaElement}
*
* @return int
*/
Expand Down
26 changes: 13 additions & 13 deletions htdocs/kernel/tplfile.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -204,12 +204,12 @@ public function getLastModified()
class XoopsTplfileHandler extends XoopsObjectHandler
{
/**
* create a new Tplfile
* create a new XoopsTplfile
*
* @see XoopsBlock
* @see \XoopsBlock
* @param bool $isNew is the new Tplfile new??
* @return XoopsTplfile XoopsTplfile reference to the new Tplfile
**/
* @return \XoopsTplfile reference to the new XoopsTplfile
*/
public function create($isNew = true)
{
$tplfile = new XoopsTplfile();
Expand All @@ -223,12 +223,12 @@ public function create($isNew = true)
/**
* retrieve a specific {@link XoopsTplfile}
*
* @see XoopsBlock
* @see \XoopsBlock
*
* @param int $id tpl_id of the block to retrieve
* @param bool $getsource
*
* @return object|false XoopsTplfile reference to the Tplfile
* @return \XoopsTplfile|false reference to the Tplfile
*/
public function get($id, $getsource = false)
{
Expand Down Expand Up @@ -339,7 +339,7 @@ public function insert(XoopsObject $tplfile)
}

/**
* Update Tplfile, even if a safe transaction (i.e. http get)
* Update XoopsTplfile, even if a safe transaction (i.e. http get)
*
* @param XoopsTplfile $tplfile
* @return bool true on success, otherwise false
Expand Down Expand Up @@ -489,13 +489,13 @@ public function getModuleTplCount($tplset)
/**
* Find Template File
*
* @param string $tplset
* @param string|array $type
* @param string $refid
* @param string $module
* @param string $file
* @param string|null $tplset
* @param string|array|null $type
* @param string|null $refid
* @param string|null $module
* @param string|null $file
* @param bool|string $getsource
* @return object
* @return array
*/
public function find($tplset = null, $type = null, $refid = null, $module = null, $file = null, $getsource = false)
{
Expand Down

0 comments on commit 83df4b2

Please sign in to comment.