Merge branch 'restart' of gitlab.artweb.com.ua:Alex/analytics into restart

Alex Savenko
2 parents da19e117 8baf4948
Showing 2 changed files with 81 additions and 29 deletions Show diff stats
app/library/App/Controllers/AllPositionController.php
app/library/App/Resources/UserResource.php
@@ -18,6 +18,11 @@ class AllPositionController extends CrudResourceController
 {
     const API_KEY = '150bb253651622507341cd7845f5b9d2';
+    /**
+     * Данные о проекте
+     *
+     * @return array [url, cy, pr, yaca, dmoz, yahoo]
+     */
     public function projectAction() {
         /** user params **/
@@ -31,6 +36,11 @@ class AllPositionController extends CrudResourceController
     }
+    /**
+     * Список проектов пользователя
+     *
+     * @return array[] [id_project, id_group, url, cy, pr]
+     */
     public function projectsAction() {
         /** user params **/
@@ -44,6 +54,11 @@ class AllPositionController extends CrudResourceController
     }
+    /**
+     * Список групп проектов
+     *
+     * @return array[] [id_group, group]
+     */
     public function projectsGroupAction() {
         $APObj = new Client(self::API_KEY);
@@ -54,6 +69,11 @@ class AllPositionController extends CrudResourceController
     }
+    /**
+     * Список запросов, по которым определяется позиция сайта
+     *
+     * @return array[] [id_query, id_group, query, freq, url]
+     */
     public function queriesAction() {
         /** user params **/
@@ -68,6 +88,11 @@ class AllPositionController extends CrudResourceController
     }
+    /**
+     * Список групп запросов
+     *
+     * @return array[] [id_group, group]
+     */
     public function queriesGroupAction() {
         /** user params **/
@@ -81,6 +106,16 @@ class AllPositionController extends CrudResourceController
     }
+    /**
+     * Отчет по позициям сайта
+     *
+     * @return array [
+     * count, top3, top10, top30, down, up, date, prev_date,
+     * sengines[id_se, name_se, name_region][],
+     * queries[id_query, query, wordstat][],
+     * positions[position, prev_position, change_position, url][]
+     * ]
+     */
     public function reportAction() {
         /** user params **/
@@ -96,6 +131,11 @@ class AllPositionController extends CrudResourceController
     }
+    /**
+     * Данные о видимости сайта за указанный период
+     *
+     * @return array [id_project, begin_date, end_date, id_se]
+     */
     public function visibilityAction() {
         /** user params **/
@@ -112,6 +152,11 @@ class AllPositionController extends CrudResourceController
     }
+    /**
+     * Список дат, когда обновлялись позиции сайта
+     *
+     * @return array
+     */
     public function reportDatesAction() {
         /** user params **/
@@ -22,27 +22,26 @@ class UserResource extends ApiResource {
             ->itemKey('user')
             ->collectionKey('users')
             ->deny(AclRoles::UNAUTHORIZED, AclRoles::USER)
-            ->handler(UserController::class);
+            ->handler(UserController::class)
-        $this
-            ->endpoint(ApiEndpoint::all()
-                ->allow(AclRoles::USER)
-                ->name('all')
-                ->description('Возвращает всех зарегистрированных пользователей')
-            );
+            /** -------------------- [GET] users -------------------------------- **/
+                ->endpoint(ApiEndpoint::all()
+                    ->allow(AclRoles::USER)
+                    ->name('all')
+                    ->description('Возвращает всех зарегистрированных пользователей')
+                )
+            /** ----------------------------------------------------------------- **/
-        $this
-            ->endpoint(ApiEndpoint::remove()
-                ->name('remove')
-                ->description('Удаление пользователя')
+            /** -------------------- [GET] users/me ----------------------------- **/
+                ->endpoint(ApiEndpoint::factory('/me', HttpMethods::GET, 'meAction')
+                ->name('me')
+                ->description('Возвращает текущего залогиненного пользователя')
                 ->allow(AclRoles::USER)
-                ->exampleResponse([
-                    "result"  => "OK"
-                ])
             )
-        ;
-        $this
-            ->endpoint(ApiEndpoint::update()
+            /** ----------------------------------------------------------------- **/
+
+            /** -------------------- [PUT] users/{id}  -------------------------- **/
+                ->endpoint(ApiEndpoint::update()
                 ->name('update')
                 ->description('Изменение данных пользователя')
                 ->allow(AclRoles::ADMINISTRATOR)
@@ -62,17 +61,21 @@ class UserResource extends ApiResource {
                     ]
                 ])
             )
-        ;
+            /** ----------------------------------------------------------------- **/
-        $this
-            ->endpoint(ApiEndpoint::factory('/me', HttpMethods::GET, 'meAction')
-                ->name('me')
-                ->description('Возвращает текущего залогиненного пользователя')
+            /** -------------------- [DELETE] users/{id} ------------------------ **/
+                ->endpoint(ApiEndpoint::remove()
+                ->name('remove')
+                ->description('Удаление пользователя')
                 ->allow(AclRoles::USER)
-            );
+                ->exampleResponse([
+                    "result"  => "OK"
+                ])
+            )
+            /** ----------------------------------------------------------------- **/
-        $this
-            ->endpoint(ApiEndpoint::factory('/authenticate', HttpMethods::POST, 'authenticateAction')
+            /** -------------------- [POST] users/authenticate ------------------ **/
+                ->endpoint(ApiEndpoint::factory('/authenticate', HttpMethods::POST, 'authenticateAction')
                 ->name('authenticate')
                 ->description('Авторизация пользователя через BasicAuth и возвращает токен доступа')
                 ->allow(AclRoles::UNAUTHORIZED)
@@ -93,9 +96,11 @@ class UserResource extends ApiResource {
                     ]
                 ])
-            );
-        $this
-            ->endpoint(ApiEndpoint::factory('/', HttpMethods::POST, 'registerAction')
+            )
+            /** ----------------------------------------------------------------- **/
+
+            /** -------------------- [POST] users -------------------------------- **/
+                ->endpoint(ApiEndpoint::factory('/', HttpMethods::POST, 'registerAction')
                 ->name('register')
                 ->description('Регистрация нового пользователя')
                 ->allow(AclRoles::UNAUTHORIZED)
@@ -111,6 +116,8 @@ class UserResource extends ApiResource {
                         "updatedAt" => "2017-02-16 17:57:52"
                     ]
                 ])
-            );
+            )
+            /** ----------------------------------------------------------------- **/
+        ;
     }
 }
 \ No newline at end of file