Use @return instead of @returns

This commit is contained in:
Lukas Reschke 2014-05-11 16:27:18 +02:00
parent cd3ed01483
commit 416f8b186d
3 changed files with 9 additions and 9 deletions

View File

@ -765,7 +765,7 @@ class Access extends LDAPUtility {
* @param bool $pagedSearchOK whether a paged search has been executed * @param bool $pagedSearchOK whether a paged search has been executed
* @param bool $skipHandling required for paged search when cookies to * @param bool $skipHandling required for paged search when cookies to
* prior results need to be gained * prior results need to be gained
* @returns array|false array with the search result as first value and pagedSearchOK as * @return array|false array with the search result as first value and pagedSearchOK as
* second | false if not successful * second | false if not successful
*/ */
private function processPagedSearchStatus($sr, $filter, $base, $iFoundItems, $limit, $offset, $pagedSearchOK, $skipHandling) { private function processPagedSearchStatus($sr, $filter, $base, $iFoundItems, $limit, $offset, $pagedSearchOK, $skipHandling) {
@ -805,7 +805,7 @@ class Access extends LDAPUtility {
* @param int $offset optional, a starting point * @param int $offset optional, a starting point
* @param bool $skipHandling indicates whether the pages search operation is * @param bool $skipHandling indicates whether the pages search operation is
* completed * completed
* @returns int|false Integer or false if the search could not be initialized * @return int|false Integer or false if the search could not be initialized
* *
*/ */
private function count($filter, $base, $attr = null, $limit = null, $offset = null, $skipHandling = false) { private function count($filter, $base, $attr = null, $limit = null, $offset = null, $skipHandling = false) {
@ -1111,7 +1111,7 @@ class Access extends LDAPUtility {
* @param string $dn a known DN used to check against * @param string $dn a known DN used to check against
* @param bool $isUser * @param bool $isUser
* @param bool $force the detection should be run, even if it is not set to auto * @param bool $force the detection should be run, even if it is not set to auto
* @returns true on success, false otherwise * @return bool true on success, false otherwise
*/ */
private function detectUuidAttribute($dn, $isUser = true, $force = false) { private function detectUuidAttribute($dn, $isUser = true, $force = false) {
if($isUser) { if($isUser) {
@ -1245,7 +1245,7 @@ class Access extends LDAPUtility {
* @param string $filter the search filter to identify the correct search * @param string $filter the search filter to identify the correct search
* @param int $limit the limit (or 'pageSize'), to identify the correct search well * @param int $limit the limit (or 'pageSize'), to identify the correct search well
* @param int $offset the offset for the new search to identify the correct search really good * @param int $offset the offset for the new search to identify the correct search really good
* @returns string containing the key or empty if none is cached * @return string containing the key or empty if none is cached
*/ */
private function getPagedResultCookie($base, $filter, $limit, $offset) { private function getPagedResultCookie($base, $filter, $limit, $offset) {
if($offset === 0) { if($offset === 0) {

View File

@ -434,7 +434,7 @@ class Connection extends LDAPUtility {
/** /**
* @brief Validates the user specified configuration * @brief Validates the user specified configuration
* @returns true if configuration seems OK, false otherwise * @return true if configuration seems OK, false otherwise
*/ */
private function validateConfiguration() { private function validateConfiguration() {

View File

@ -236,7 +236,7 @@ class Wizard extends LDAPUtility {
/** /**
* @brief detects the available LDAP groups * @brief detects the available LDAP groups
* @returns WizardResult the instance's WizardResult instance * @return WizardResult the instance's WizardResult instance
*/ */
public function determineGroupsForGroups() { public function determineGroupsForGroups() {
return $this->determineGroups('ldap_groupfilter_groups', return $this->determineGroups('ldap_groupfilter_groups',
@ -246,7 +246,7 @@ class Wizard extends LDAPUtility {
/** /**
* @brief detects the available LDAP groups * @brief detects the available LDAP groups
* @returns WizardResult the instance's WizardResult instance * @return WizardResult the instance's WizardResult instance
*/ */
public function determineGroupsForUsers() { public function determineGroupsForUsers() {
return $this->determineGroups('ldap_userfilter_groups', return $this->determineGroups('ldap_userfilter_groups',
@ -441,7 +441,7 @@ class Wizard extends LDAPUtility {
/** /**
* Tries to determine the port, requires given Host, User DN and Password * Tries to determine the port, requires given Host, User DN and Password
* @returns WizardResult|false WizardResult on success, false otherwise * @return WizardResult|false WizardResult on success, false otherwise
* @throws \Exception * @throws \Exception
*/ */
public function guessPortAndTLS() { public function guessPortAndTLS() {
@ -480,7 +480,7 @@ class Wizard extends LDAPUtility {
/** /**
* @brief tries to determine a base dn from User DN or LDAP Host * @brief tries to determine a base dn from User DN or LDAP Host
* @returns mixed WizardResult on success, false otherwise * @return mixed WizardResult on success, false otherwise
*/ */
public function guessBaseDN() { public function guessBaseDN() {
if(!$this->checkRequirements(array('ldapHost', if(!$this->checkRequirements(array('ldapHost',