friendica/friendica
6
0
Fork 1
mirror of https://github.com/friendica/friendica synced 2024-05-22 06:34:59 +02:00
Code Issues Packages Projects Releases 1 Wiki Activity

Improved documentation

Browse source
This commit is contained in:
Michael 2021-06-08 06:39:23 +00:00
parent acbe9ebf9e
commit 126e281165
2 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/Module/BaseApi.php
View file

@ -173,7 +173,7 @@ class BaseApi extends BaseModule
} }
/** /**
* Log in user via OAuth1 or Simple HTTP Auth. * Log in user via OAuth or Simple HTTP Auth.
* *
* Simple Auth allow username in form of <pre>user@server</pre>, ignoring server part * Simple Auth allow username in form of <pre>user@server</pre>, ignoring server part
* *

5
src/Security/BasicAuth.php
View file

@ -68,7 +68,10 @@ class BasicAuth
} }
/** /**
* Get current user id, returns 0 if not logged in * Get current user id, returns 0 if $login is set to false and not logged in.
* When $login is true, the execution will stop when not logged in.
*
* @param bool $login Perform a login request if "true"
* *
* @return int User ID * @return int User ID
*/ */