apuc/guild
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

the method was moved UserCard to Profile

Browse Source
This commit is contained in:
iironside 2022-03-21 19:08:39 +03:00
parent d11deb20af
commit 16db7b42d9
5 changed files with 143 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
common/services/ProfileService.php
View File

@ -8,13 +8,32 @@ use common\models\UserCard;
use frontend\modules\api\models\ProfileSearchForm; use frontend\modules\api\models\ProfileSearchForm;
use Yii; use Yii;
use yii\web\BadRequestHttpException; use yii\web\BadRequestHttpException;
use yii\web\ServerErrorHttpException;
class ProfileService class ProfileService
{ {
/**
* @throws ServerErrorHttpException
*/
public static function getMainData($user_id): array
{
$userCard = UserCard::findOne(['id_user' => $user_id]);
if (empty($userCard)) {
throw new ServerErrorHttpException(json_encode($userCard->errors));
}
return array('fio' => $userCard->fio,
'photo' => $userCard->photo,
'gender' => $userCard->gender,
'level' => $userCard->level,
'years_of_exp' => $userCard->years_of_exp,
'specification' => $userCard->specification,
'position_name' => $userCard->position->name);
}
/** /**
* @throws BadRequestHttpException * @throws BadRequestHttpException
*/ */
public static function getProfile($id, $request): ?array public static function getProfile($id, $request)//: ?array
{ {
$searchModel = new ProfileSearchForm(); $searchModel = new ProfileSearchForm();
$searchModel->attributes = $request; $searchModel->attributes = $request;

27
common/services/UserCardService.php
View File

@ -1,27 +0,0 @@
<?php
namespace common\services;
use common\models\UserCard;
use yii\web\ServerErrorHttpException;
class UserCardService
{
/**
* @throws ServerErrorHttpException
*/
public static function getUserCard($user_id): array
{
$userCard = UserCard::findOne(['id_user' => $user_id]);
if (empty($userCard)) {
throw new ServerErrorHttpException(json_encode($userCard->errors));
}
return array('fio' => $userCard->fio,
'photo' => $userCard->photo,
'gender' => $userCard->gender,
'level' => $userCard->level,
'years_of_exp' => $userCard->years_of_exp,
'specification' => $userCard->specification,
'position_name' => $userCard->position->name);
}
}

114
docs/api/profile.md
View File

@ -1,4 +1,4 @@
## Профиль # Профиль
## Методы ## Методы
<table> <table>
<tr> <tr>
@ -33,6 +33,14 @@
Получить профиль с флагом прав на просмотр отчётов этого пользователя Получить профиль с флагом прав на просмотр отчётов этого пользователя
</td> </td>
</tr> </tr>
<tr>
<td>
profile/get-main-data
</td>
<td>
Получить получить основные данные профиля
</td>
</tr>
</table> </table>
### Список ### Список
@ -194,3 +202,107 @@
</tr> </tr>
</table> </table>
## Основные данные пользователя
`https://guild.craft-group.xyz/api/profile/get-main-data?user_id=1`
<p>
Требуемые параметры:
</p>
<table>
<tr>
<th>
Параметры
</th>
<th>
Значение
</th>
</tr>
<tr>
<td>
user_id
</td>
<td>
Id профиля пользователя
</td>
</tr>
</table>
<p>
Возвращает объект <b>Пользователь</b>. <br>
Каждый объект <b>Пользователь</b> имеет такой вид:
</p>
```json5
{
"fio": "Тест менеджер для апи запроса",
"photo": null,
"gender": 1,
"level": 2,
"years_of_exp": null,
"specification": null,
"position_name": "Должность 1"
}
```
<p>
Возвращаемые параметры:
</p>
<table>
<tr>
<th>
Параметры
</th>
<th>
Значение
</th>
</tr>
<tr>
<td>
fio
</td>
<td>
ФИО
</td>
</tr>
<tr>
<td>
photo
</td>
<td>
Ссылка на фото
</td>
</tr>
<tr>
<td>
gender
</td>
<td>
Пол
</td>
</tr>
<tr>
<td>
level
</td>
<td>
Уровень
</td>
</tr>
<tr>
<td>
years_of_exp
</td>
<td>
Лет опыта
</td>
</tr>
<tr>
<td>
position_name
</td>
<td>
Должность
</td>
</tr>
</table>

11
frontend/modules/api/controllers/ProfileController.php
View File

@ -4,6 +4,7 @@ namespace frontend\modules\api\controllers;
use common\services\ProfileService; use common\services\ProfileService;
use yii\web\BadRequestHttpException; use yii\web\BadRequestHttpException;
use yii\web\ServerErrorHttpException;
class ProfileController extends ApiController class ProfileController extends ApiController
{ {
@ -15,7 +16,7 @@ class ProfileController extends ApiController
]; ];
} }
public function actionIndex($id = null) public function actionIndex($id = null): ?array
{ {
return ProfileService::getProfile($id, \Yii::$app->request->get()); return ProfileService::getProfile($id, \Yii::$app->request->get());
} }
@ -27,4 +28,12 @@ class ProfileController extends ApiController
{ {
return ProfileService::getProfileWithReportPermission($id); return ProfileService::getProfileWithReportPermission($id);
} }
/**
* @throws ServerErrorHttpException
*/
public function actionGetMainData($user_id): array
{
return ProfileService::getMainData($user_id);
}
} }

24
frontend/modules/api/controllers/UserCardController.php
View File

@ -1,24 +0,0 @@
<?php
namespace frontend\modules\api\controllers;
use common\services\UserCardService;
use yii\web\ServerErrorHttpException;
class UserCardController extends ApiController
{
public function verbs(): array
{
return [
'get-user-card' => ['get'],
];
}
/**
* @throws ServerErrorHttpException
*/
public function actionGetUserCard($user_id): array
{
return UserCardService::getUserCard($user_id);
}
}