AP php docs

Alex Savenko
1 parent a14aee59
Showing 1 changed file with 45 additions and 0 deletions Show diff stats
app/library/App/Controllers/AllPositionController.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 **/