Apply suggestions from code review

Co-authored-by: Hypolite Petovan <hypolite@mrpetovan.com>
This commit is contained in:
Michael Vogel 2022-10-18 07:57:59 +02:00 committed by GitHub
parent 27e9f2b223
commit 810ea228f0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -54,6 +54,7 @@ define('GRAVITY_UNKNOWN', 9);
* Returns the user id of locally logged in user or false. * Returns the user id of locally logged in user or false.
* *
* @return int|bool user id or false * @return int|bool user id or false
* @deprecated since version 2022.12, use Core\Session::getLocalUser() instead
*/ */
function local_user() function local_user()
{ {
@ -64,6 +65,7 @@ function local_user()
* Returns the public contact id of logged in user or false. * Returns the public contact id of logged in user or false.
* *
* @return int|bool public contact id or false * @return int|bool public contact id or false
* @deprecated since version 2022.12, use Core\Session:: getPublicContact() instead
*/ */
function public_contact() function public_contact()
{ {
@ -74,6 +76,7 @@ function public_contact()
* Returns public contact id of authenticated site visitor or false * Returns public contact id of authenticated site visitor or false
* *
* @return int|bool visitor_id or false * @return int|bool visitor_id or false
* @deprecated since version 2022.12, use Core\Session:: getRemoteUser() instead
*/ */
function remote_user() function remote_user()
{ {