Alex Savenko / analytics

Commit 4d5d538f36eb7adb68a05ce1d243b7482f4d206d

Authored by Alex Savenko
1 parent a14aee59

AP php docs

Showing 1 changed file with 45 additions and 0 deletions   Show diff stats
Inline Side-by-side
app/library/App/Controllers/AllPositionController.php
  Show/Hide comments   View file @4d5d538
... ... @@ -18,6 +18,11 @@ class AllPositionController extends CrudResourceController
18 18 {
19 19 const API_KEY = '150bb253651622507341cd7845f5b9d2';
20 20  
  21 + /**
  22 + * Данные о проекте
  23 + *
  24 + * @return array [url, cy, pr, yaca, dmoz, yahoo]
  25 + */
21 26 public function projectAction() {
22 27  
23 28 /** user params **/
... ... @@ -31,6 +36,11 @@ class AllPositionController extends CrudResourceController
31 36  
32 37 }
33 38  
  39 + /**
  40 + * Список проектов пользователя
  41 + *
  42 + * @return array[] [id_project, id_group, url, cy, pr]
  43 + */
34 44 public function projectsAction() {
35 45  
36 46 /** user params **/
... ... @@ -44,6 +54,11 @@ class AllPositionController extends CrudResourceController
44 54  
45 55 }
46 56  
  57 + /**
  58 + * Список групп проектов
  59 + *
  60 + * @return array[] [id_group, group]
  61 + */
47 62 public function projectsGroupAction() {
48 63  
49 64 $APObj = new Client(self::API_KEY);
... ... @@ -54,6 +69,11 @@ class AllPositionController extends CrudResourceController
54 69  
55 70 }
56 71  
  72 + /**
  73 + * Список запросов, по которым определяется позиция сайта
  74 + *
  75 + * @return array[] [id_query, id_group, query, freq, url]
  76 + */
57 77 public function queriesAction() {
58 78  
59 79 /** user params **/
... ... @@ -68,6 +88,11 @@ class AllPositionController extends CrudResourceController
68 88  
69 89 }
70 90  
  91 + /**
  92 + * Список групп запросов
  93 + *
  94 + * @return array[] [id_group, group]
  95 + */
71 96 public function queriesGroupAction() {
72 97  
73 98 /** user params **/
... ... @@ -81,6 +106,16 @@ class AllPositionController extends CrudResourceController
81 106  
82 107 }
83 108  
  109 + /**
  110 + * Отчет по позициям сайта
  111 + *
  112 + * @return array [
  113 + * count, top3, top10, top30, down, up, date, prev_date,
  114 + * sengines[id_se, name_se, name_region][],
  115 + * queries[id_query, query, wordstat][],
  116 + * positions[position, prev_position, change_position, url][]
  117 + * ]
  118 + */
84 119 public function reportAction() {
85 120  
86 121 /** user params **/
... ... @@ -96,6 +131,11 @@ class AllPositionController extends CrudResourceController
96 131  
97 132 }
98 133  
  134 + /**
  135 + * Данные о видимости сайта за указанный период
  136 + *
  137 + * @return array [id_project, begin_date, end_date, id_se]
  138 + */
99 139 public function visibilityAction() {
100 140  
101 141 /** user params **/
... ... @@ -112,6 +152,11 @@ class AllPositionController extends CrudResourceController
112 152  
113 153 }
114 154  
  155 + /**
  156 + * Список дат, когда обновлялись позиции сайта
  157 + *
  158 + * @return array
  159 + */
115 160 public function reportDatesAction() {
116 161  
117 162 /** user params **/
... ...