From 126e28116572f38acc7da437a1fce989ddb9c622 Mon Sep 17 00:00:00 2001 From: Michael Date: Tue, 8 Jun 2021 06:39:23 +0000 Subject: [PATCH] Improved documentation --- src/Module/BaseApi.php | 2 +- src/Security/BasicAuth.php | 5 ++++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/src/Module/BaseApi.php b/src/Module/BaseApi.php index e629ad9910..855f6ac23f 100644 --- a/src/Module/BaseApi.php +++ b/src/Module/BaseApi.php @@ -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 
user@server
, ignoring server part * diff --git a/src/Security/BasicAuth.php b/src/Security/BasicAuth.php index 002ecd6eb3..42e6d824c7 100644 --- a/src/Security/BasicAuth.php +++ b/src/Security/BasicAuth.php @@ -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 */