khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-02 09:49:33 +07:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #10354 from nextcloud/fix/devmanual/modernize-user-manager-user-session

Browse Source 
fix(devmanual): Modernize user manager and user session docs
This commit is contained in:
Christoph Wurst
2023-05-10 10:54:22 +02:00
committed by GitHub
parent 8e89481127 3b9ff4a92e
commit fab844a901
2 changed files with 41 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
developer_manual/basics/events.rst
View File

@@ -742,7 +742,7 @@ The hook logic should be in a separate class that is being registered in the `Ap
*/
$container->registerService('UserHooks', function($c) {
return new UserHooks(
$c->query('ServerContainer')->getUserManager()
$c->get(\OCP\IUserManager::class)
);
});
}
@@ -804,7 +804,7 @@ The following hooks are available:
Session
```````
Injectable from the ServerContainer by calling the method **getUserSession()**.
Injectable from the ServerContainer with the ``\OCP\IUserSession`` service.
Hooks available in scope **\\OC\\User**:
@@ -822,7 +822,7 @@ Hooks available in scope **\\OC\\User**:
UserManager
```````````
Injectable from the ServerContainer by calling the method **getUserManager()**.
Injectable from the ServerContainer with the ``\OCP\IUserManager`` service.
Hooks available in scope **\\OC\\User**:

103
developer_manual/digging_deeper/users.rst
View File

@@ -4,64 +4,54 @@ User management
.. sectionauthor:: Bernhard Posselt <dev@bernhard-posselt.com>
Users can be managed using the UserManager which is injected from the ServerContainer:
Users can be managed using the IUserManager service that can be :ref:`injected<dependency-injection>`.
.. code-block:: php
:caption: lib/Service/UserService.php
:emphasize-lines: 8, 10-12
<?php
namespace OCA\MyApp\AppInfo;
use \OCP\AppFramework\App;
namespace OCA\MyApp\Service;
use \OCA\MyApp\Service\UserService;
use OCP\IUserManager;
class UserService {
private IUserManager $userManager;
class Application extends App {
public function __construct(IUserManager $userManager){
$this->userManager = $userManager;
}
public function __construct(array $urlParams=array()){
parent::__construct('myapp', $urlParams);
$container = $this->getContainer();
/**
* Controllers
*/
$container->registerService('UserService', function($c) {
return new UserService(
$c->query('UserManager')
);
});
$container->registerService('UserManager', function($c) {
return $c->query('ServerContainer')->getUserManager();
});
public function createUser($userId, $password) {
return $this->userManager->create($userId, $password);
}
}
Creating users
--------------
Creating a user is done by passing a username and password to the create method:
.. code-block:: php
:caption: lib/Service/UserService.php
:emphasize-lines: 13
<?php
namespace OCA\MyApp\Service;
class UserService {
private IUserManager $userManager;
private $userManager;
public function __construct($userManager){
public function __construct(IUserManager $userManager){
$this->userManager = $userManager;
}
public function create($userId, $password) {
return $this->userManager->create($userId, $password);
}
}
Modifying users
@@ -75,15 +65,16 @@ Users can be modified by getting a user by the userId or by a search pattern. Th
* Get their home directory
.. code-block:: php
:emphasize-lines: 13
<?php
namespace OCA\MyApp\Service;
class UserService {
private $userManager;
private IUserManager $userManager;
public function __construct($userManager){
public function __construct(IUserManager $userManager){
$this->userManager = $userManager;
}
@@ -108,68 +99,50 @@ Users can be modified by getting a user by the userId or by a search pattern. Th
User session information
------------------------
To login, logout or getting the currently logged in user, the UserSession has to be injected from the ServerContainer:
To login, logout or getting the currently logged in user, the IUserSession service that can be :ref:`injected<dependency-injection>`.
.. code-block:: php
:caption: lib/Service/UserService.php
<?php
namespace OCA\MyApp\AppInfo;
use \OCP\AppFramework\App;
namespace OCA\MyApp\Service;
use \OCA\MyApp\Service\UserService;
use OCP\IUserSession;
class UserService {
private IUserSession $userSession;
class Application extends App {
public function __construct(array $urlParams=array()){
parent::__construct('myapp', $urlParams);
$container = $this->getContainer();
/**
* Controllers
*/
$container->registerService('UserService', function($c) {
return new UserService(
$c->query('UserSession')
);
});
$container->registerService('UserSession', function($c) {
return $c->query('ServerContainer')->getUserSession();
});
// currently logged in user, userId can be gotten by calling the
// getUID() method on it
$container->registerService('User', function($c) {
return $c->query('UserSession')->getUser();
});
public function __construct(IUserSession $userSession){
$this->userSession = $userSession;
}
}
Then users can be logged in by using:
Then users can be logged in and out by using:
.. code-block:: php
:caption: lib/Service/UserService.php
:emphasize-lines: 15,19
<?php
namespace OCA\MyApp\Service;
use OCP\IUserSession;
class UserService {
private IUserSession $userSession;
private $userSession;
public function __construct($userSession){
public function __construct(IUserSession $userSession){
$this->userSession = $userSession;
}
public function login($userId, $password) {
public function login(string $userId, string $password): void {
return $this->userSession->login($userId, $password);
}
public function logout() {
public function logout(): void {
$this->userSession->logout();
}
}