Skip to content

Commit ad55361

Browse files
committed
update all
1 parent ff36e8d commit ad55361

8 files changed

+89
-66
lines changed

.travis.yml

Lines changed: 0 additions & 16 deletions
This file was deleted.

api.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
## Table of contents
2+
- [Creational\LazyInitialization\MemoryUser](#creational_lazyinitialization_memoryuser)
3+
- [Creational\LazyInitialization\ServiceInterface](#creational_lazyinitialization_serviceinterface)
4+
- [Creational\LazyInitialization\UserInterface](#creational_lazyinitialization_userinterface)
5+
- [Creational\LazyInitialization\UserService](#creational_lazyinitialization_userservice)
6+
<hr>
7+
8+
<a id="creational_lazyinitialization_memoryuser"></a>
9+
10+
### Class: Creational\LazyInitialization\MemoryUser
11+
##### implements [Creational\LazyInitialization\UserInterface](#creational_lazyinitialization_userinterface)
12+
| Visibility | Function |
13+
|:-----------|:---------|
14+
|public|<em><strong>__construct</strong>( string $name )</em><br>Sets the name<br>Устанавливает имя|
15+
|public|<em><strong>getName</strong>(): string</em><br>Gets a name<br>Получает имя|
16+
17+
18+
<a id="creational_lazyinitialization_serviceinterface"></a>
19+
20+
### Class: Creational\LazyInitialization\ServiceInterface
21+
| Visibility | Function |
22+
|:-----------|:---------|
23+
|abstract public|<em><strong>register</strong>( string $name ): string</em><br>|
24+
|abstract public|<em><strong>login</strong>( string $name ): string</em><br>|
25+
26+
27+
<a id="creational_lazyinitialization_userinterface"></a>
28+
29+
### Class: Creational\LazyInitialization\UserInterface
30+
| Visibility | Function |
31+
|:-----------|:---------|
32+
|abstract public|<em><strong>getName</strong>(): string</em><br>|
33+
34+
35+
<a id="creational_lazyinitialization_userservice"></a>
36+
37+
### Class: Creational\LazyInitialization\UserService
38+
##### implements [Creational\LazyInitialization\ServiceInterface](#creational_lazyinitialization_serviceinterface)
39+
| Visibility | Function |
40+
|:-----------|:---------|
41+
|public|<em><strong>register</strong>( string $name ): string</em><br>Registers a new user<br>Регистрирует нового пользователя|
42+
|public|<em><strong>login</strong>( string $name ): string</em><br>Identifies the user<br>Идентифицируетпользователя|
43+
<hr>
44+
45+
###### created with [Rudra-Documentation-Collector](#https://github.com/Jagepard/Rudra-Documentation-Collector)

composer.json

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,8 @@
2020
"skype": "jagepard.ru"
2121
},
2222
"require": {
23-
"php": ">=7.4"
24-
},
25-
"require-dev" : {
26-
"phpunit/phpunit": "^7"
23+
"php": ">=7.4",
24+
"rudra/docs": "dev-master"
2725
},
2826
"autoload": {
2927
"psr-4": {

docs.md

Lines changed: 0 additions & 46 deletions
This file was deleted.

src/MemoryUser.php

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,25 @@ class MemoryUser implements UserInterface
1313
{
1414
private string $name;
1515

16+
/**
17+
* Sets the name
18+
* -------------
19+
* Устанавливает имя
20+
*
21+
* @param string $name
22+
*/
1623
public function __construct(string $name)
1724
{
1825
$this->name = $name;
1926
}
2027

28+
/**
29+
* Gets a name
30+
* -----------
31+
* Получает имя
32+
*
33+
* @return string
34+
*/
2135
public function getName(): string
2236
{
2337
return $this->name;

src/ServiceInterface.php

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,15 @@
99

1010
interface ServiceInterface
1111
{
12+
/**
13+
* @param string $name
14+
* @return string
15+
*/
1216
public function register(string $name): string;
17+
18+
/**
19+
* @param string $name
20+
* @return string
21+
*/
1322
public function login(string $name): string;
1423
}

src/UserInterface.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,8 @@
99

1010
interface UserInterface
1111
{
12+
/**
13+
* @return string
14+
*/
1215
public function getName(): string;
1316
}

src/UserService.php

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,14 @@ class UserService implements ServiceInterface
1414
private array $users = [];
1515
private bool $authenticated = false;
1616

17+
/**
18+
* Registers a new user
19+
* --------------------
20+
* Регистрирует нового пользователя
21+
*
22+
* @param string $name
23+
* @return string
24+
*/
1725
public function register(string $name): string
1826
{
1927
if (!array_key_exists($name, $this->users)) {
@@ -25,6 +33,14 @@ public function register(string $name): string
2533
return $this->login($this->users[$name]->getName());
2634
}
2735

36+
/**
37+
* Identifies the user
38+
* -------------------
39+
* Идентифицирует пользователя
40+
*
41+
* @param string $name
42+
* @return string
43+
*/
2844
public function login(string $name): string
2945
{
3046
if (array_key_exists($name, $this->users)){

0 commit comments

Comments
 (0)