Набросали phpDoc

в будущем привести в порядок надо
osben · Sep 13, 2016 · a7d5721 · a7d5721
1 parent bb122f7
commit a7d5721
Show file tree

Hide file tree

Showing 24 changed files with 1,019 additions and 360 deletions.
diff --git a/api/Blog.php b/api/Blog.php
@@ -14,13 +14,13 @@
 class Blog extends Simpla
 {
 
-    /*
-    *
-    * Функция возвращает пост по его id или url
-    * (в зависимости от типа аргумента, int - id, string - url)
-    * @param $id id или url поста
-    *
-    */
+    /**
+     * Функция возвращает пост по его id или url
+     * (в зависимости от типа аргумента, int - id, string - url)
+     *
+     * @param  int $id
+     * @return object|bool
+     */
     public function get_post($id)
     {
         if (is_int($id)) {
@@ -40,12 +40,12 @@ public function get_post($id)
         }
     }
 
-    /*
-    *
-    * Функция возвращает массив постов, удовлетворяющих фильтру
-    * @param $filter
-    *
-    */
+    /**
+     * Функция возвращает массив постов, удовлетворяющих фильтру
+     *
+     * @param array $filter
+     * @return array|bool
+     */
     public function get_posts($filter = array())
     {
         // По умолчанию
@@ -93,13 +93,12 @@ public function get_posts($filter = array())
         return $this->db->results();
     }
 
-
-    /*
-    *
-    * Функция вычисляет количество постов, удовлетворяющих фильтру
-    * @param $filter
-    *
-    */
+    /**
+     * Функция вычисляет количество постов, удовлетворяющих фильтру
+     *
+     * @param  array $filter
+     * @return int|bool
+     */
     public function count_posts($filter = array())
     {
         $post_id_filter = '';
@@ -135,12 +134,10 @@ public function count_posts($filter = array())
         }
     }
 
-    /*
-    *
-    * Создание поста
-    * @param $post
-    *
-    */
+    /**
+     * @param  object $post
+     * @return bool|int
+     */
     public function add_post($post)
     {
         if (!isset($post->date)) {
@@ -158,27 +155,26 @@ public function add_post($post)
         }
     }
 
-
-    /*
-    *
-    * Обновить пост(ы)
-    * @param $post
-    *
-    */
+    /**
+     * Обновить пост(ы)
+     *
+     * @param  int $id
+     * @param  array|object $post
+     * @return int
+     */
     public function update_post($id, $post)
     {
         $query = $this->db->placehold("UPDATE __blog SET ?% WHERE id in(?@) LIMIT ?", $post, (array)$id, count((array)$id));
         $this->db->query($query);
         return $id;
     }
 
-
-    /*
-    *
-    * Удалить пост
-    * @param $id
-    *
-    */
+    /**
+     * Удалить пост
+     *
+     * @param  int $id
+     * @return bool
+     */
     public function delete_post($id)
     {
         if (!empty($id)) {
@@ -193,13 +189,12 @@ public function delete_post($id)
         return false;
     }
 
-
-    /*
-    *
-    * Следующий пост
-    * @param $post
-    *
-    */
+    /**
+     * Следующий пост
+     *
+     * @param  int $id
+     * @return object|bool
+     */
     public function get_next_post($id)
     {
         $this->db->query("SELECT date FROM __blog WHERE id=? LIMIT 1", $id);
@@ -217,12 +212,12 @@ public function get_next_post($id)
         }
     }
 
-    /*
-    *
-    * Предыдущий пост
-    * @param $post
-    *
-    */
+    /**
+     * Предыдущий пост
+     *
+     * @param  int $id
+     * @return object|bool
+     */
     public function get_prev_post($id)
     {
         $this->db->query("SELECT date FROM __blog WHERE id=? LIMIT 1", $id);

diff --git a/api/Brands.php b/api/Brands.php
@@ -13,12 +13,12 @@
 
 class Brands extends Simpla
 {
-    /*
-    *
-    * Функция возвращает массив брендов, удовлетворяющих фильтру
-    * @param $filter
-    *
-    */
+    /**
+     * Функция возвращает массив брендов, удовлетворяющих фильтру
+     *
+     * @param array $filter
+     * @return array|bool
+     */
     public function get_brands($filter = array())
     {
         $category_id_filter = '';
@@ -47,13 +47,13 @@ public function get_brands($filter = array())
         return $this->db->results();
     }
 
-    /*
-    *
-    * Функция возвращает бренд по его id или url
-    * (в зависимости от типа аргумента, int - id, string - url)
-    * @param $id id или url поста
-    *
-    */
+    /**
+     * Функция возвращает бренд по его id или url
+     * (в зависимости от типа аргумента, int - id, string - url)
+     *
+     * @param  int|string $id
+     * @return bool|object
+     */
     public function get_brand($id)
     {
         if (is_int($id)) {
@@ -70,12 +70,12 @@ public function get_brand($id)
         return $this->db->result();
     }
 
-    /*
-    *
-    * Добавление бренда
-    * @param $brand
-    *
-    */
+    /**
+     * Добавление бренда
+     *
+     * @param  array|object $brand
+     * @return mixed
+     */
     public function add_brand($brand)
     {
         $brand = (array)$brand;
@@ -88,42 +88,45 @@ public function add_brand($brand)
         return $this->db->insert_id();
     }
 
-    /*
-    *
-    * Обновление бренда(ов)
-    * @param $brand
-    *
-    */
+    /**
+     * Обновление бренда(ов)
+     *
+     * @param  int $id
+     * @param  array|object $brand
+     * @return mixed
+     */
     public function update_brand($id, $brand)
     {
         $query = $this->db->placehold("UPDATE __brands SET ?% WHERE id=? LIMIT 1", $brand, intval($id));
         $this->db->query($query);
         return $id;
     }
 
-    /*
-    *
-    * Удаление бренда
-    * @param $id
-    *
-    */
+    /**
+     * Удаление бренда
+     *
+     * @param int $id
+     * @return void
+     */
     public function delete_brand($id)
     {
         if (!empty($id)) {
             $this->delete_image($id);
+
             $query = $this->db->placehold("DELETE FROM __brands WHERE id=? LIMIT 1", $id);
             $this->db->query($query);
+
             $query = $this->db->placehold("UPDATE __products SET brand_id=NULL WHERE brand_id=?", $id);
             $this->db->query($query);
         }
     }
 
-    /*
-    *
-    * Удаление изображения бренда
-    * @param $id
-    *
-    */
+    /**
+     * Удаление изображения бренда
+     *
+     * @param  int $brand_id
+     * @return void
+     */
     public function delete_image($brand_id)
     {
         $query = $this->db->placehold("SELECT image FROM __brands WHERE id=?", intval($brand_id));

diff --git a/api/Cart.php b/api/Cart.php
@@ -14,11 +14,11 @@
 class Cart extends Simpla
 {
 
-    /*
-    *
-    * Функция возвращает корзину
-    *
-    */
+    /**
+     * Функция возвращает корзину
+     *
+     * @return stdClass
+     */
     public function get_cart()
     {
         $cart = new stdClass();
@@ -97,11 +97,12 @@ public function get_cart()
         return $cart;
     }
 
-    /*
-    *
-    * Добавление варианта товара в корзину
-    *
-    */
+    /**
+     * Добавление варианта товара в корзину
+     *
+     * @param $variant_id
+     * @param int $amount
+     */
     public function add_item($variant_id, $amount = 1)
     {
         $amount = max(1, $amount);
@@ -122,11 +123,12 @@ public function add_item($variant_id, $amount = 1)
         }
     }
 
-    /*
-    *
-    * Обновление количества товара
-    *
-    */
+    /**
+     * Обновление количества товара
+     *
+     * @param $variant_id
+     * @param int $amount
+     */
     public function update_item($variant_id, $amount = 1)
     {
         $amount = max(1, $amount);
@@ -144,32 +146,30 @@ public function update_item($variant_id, $amount = 1)
     }
 
 
-    /*
-    *
-    * Удаление товара из корзины
-    *
-    */
+    /**
+     * Удаление товара из корзины
+     *
+     * @param $variant_id
+     */
     public function delete_item($variant_id)
     {
         unset($_SESSION['shopping_cart'][$variant_id]);
     }
 
-    /*
-    *
-    * Очистка корзины
-    *
-    */
+    /**
+     * Очистка корзины
+     */
     public function empty_cart()
     {
         unset($_SESSION['shopping_cart']);
         unset($_SESSION['coupon_code']);
     }
 
-    /*
-    *
-    * Применить купон
-    *
-    */
+    /**
+     * Применить купон
+     *
+     * @param $coupon_code
+     */
     public function apply_coupon($coupon_code)
     {
         $coupon = $this->coupons->get_coupon((string)$coupon_code);