Code commenting

aashish-t-magar · Mar 28, 2024 · a505871 · a505871
1 parent b04bd6e
commit a505871
Show file tree

Hide file tree

Showing 8 changed files with 116 additions and 0 deletions.
diff --git a/app/Repositories/AdminCategoryRepository.php b/app/Repositories/AdminCategoryRepository.php
@@ -11,11 +11,19 @@
 
 class AdminCategoryRepository implements AdminCategoryRepositoryInterface
 {
+    /**
+     * Get all Parent category
+     * @return mixed
+     */
     public function getAll()
     {
         return Category::whereNull('parent_id')->paginate(10);
     }
 
+    /**
+     * Get existing category for new category
+     * @return mixed
+     */
     public function create()
     {
         $data = Category::whereNull('parent_id')
@@ -24,6 +32,12 @@ public function create()
         return $data;
     }
 
+    /**
+     * Store new category
+     * @param array $data
+     * @return array
+     * @throws \Exception
+     */
     public function store(array $data)
     {
         try {
@@ -44,6 +58,11 @@ public function store(array $data)
         }
     }
 
+    /**
+     * Get existing data to edit
+     * @param string $categoryId
+     * @return array
+     */
     public function edit(string $categoryId): array
     {
         $editableData = Category::select('id', 'category_name', 'parent_id')->findOrFail($categoryId);
@@ -54,6 +73,11 @@ public function edit(string $categoryId): array
         return ['editableData' => $editableData, 'datas' => $data];
     }
 
+    /**
+     * Update the existing category
+     * @param array $data
+     * @return \Illuminate\Http\RedirectResponse
+     */
     public function update(array $data): \Illuminate\Http\RedirectResponse
     {
         try {
@@ -77,11 +101,22 @@ public function update(array $data): \Illuminate\Http\RedirectResponse
         }
     }
 
+    /**
+     * Delete category
+     * @param string $categoryId
+     * @return void
+     */
     public function destroy(string $categoryId)
     {
         Category::find($categoryId)->delete();
     }
 
+    /**
+     * get paginated category
+     * @param string $term
+     * @return \Illuminate\Http\JsonResponse
+     *
+     */
     public function getPaginatedCategory(string $term): \Illuminate\Http\JsonResponse
     {
         $mainParent = Category::where('category_name', 'like', '%' . $term . '%')
@@ -91,6 +126,12 @@ public function getPaginatedCategory(string $term): \Illuminate\Http\JsonRespons
         return response()->json(['items' => $mainParent->items()]);
     }
 
+    /**
+     * Category Search module
+     * @param string $parentId
+     * @param string $term
+     * @return array
+     */
     public function displayChildCategory(string $parentId, string $term): array
     {
         $data = Category::where('category_name', 'like', '%' . $term . '%')

diff --git a/app/Repositories/CartRepository.php b/app/Repositories/CartRepository.php
@@ -13,6 +13,7 @@
 class CartRepository implements CartRepositoryInterface
 {
     /**
+     * Display cart items
      * @param string $userId
      * @return mixed
      */
@@ -26,6 +27,7 @@ public function showCartItems(string $userId)
     }
 
     /**
+     * Store cart items
      * @param array $data
      * @return bool
      */
@@ -62,6 +64,11 @@ public function store(array $data): bool
     }
 
 
+    /**
+     * Update cart quantity
+     * @param array $data
+     * @return bool
+     */
     public function updateQuantity(array $data): bool
     {
         try {
@@ -82,6 +89,7 @@ public function updateQuantity(array $data): bool
     }
 
     /**
+     * Remove items from cart
      * @param string $cartId
      * @return bool
      */

diff --git a/app/Repositories/CheckoutRepository.php b/app/Repositories/CheckoutRepository.php
@@ -9,6 +9,11 @@
 
 class CheckoutRepository implements CheckoutRepositoryInterface
 {
+    /**
+     * Find product to checkout
+     * @param string $productId
+     * @return mixed
+     */
     public function getCheckoutProducts(string $productId)
     {
         return Product::find($productId);

diff --git a/app/Repositories/CommentRepository.php b/app/Repositories/CommentRepository.php
@@ -11,6 +11,7 @@
 class CommentRepository implements CommentRepositoryInterface
 {
     /**
+     * Fetch all comment
      * @return Collection
      */
     public function all(): Collection
@@ -19,6 +20,7 @@ public function all(): Collection
     }
 
     /**
+     * Stoe new comment/reply
      * @param $data
      * @return mixed
      */

diff --git a/app/Repositories/OrderRepository.php b/app/Repositories/OrderRepository.php
@@ -13,6 +13,11 @@
 
 class OrderRepository implements OrderRepositoryInterface
 {
+    /**
+     * Store new order
+     * @param array $data
+     * @return bool
+     */
     public function storeOrder(array $data): bool
     {
         try {
@@ -42,6 +47,12 @@ public function storeOrder(array $data): bool
         }
     }
 
+    /**
+     * Send email receipt to customer
+     * @param $userDetails
+     * @param array $orderInfo
+     * @return void
+     */
     public function sendEmailReceipt($userDetails, array $orderInfo)
     {
         $nameOfUser = $userDetails->name;

diff --git a/app/Repositories/ProductRepository.php b/app/Repositories/ProductRepository.php
@@ -10,6 +10,12 @@
 
 class ProductRepository implements ProductRepositoryInterface
 {
+    /**
+     * FInd particular product
+     * @param string $productId
+     * @return \Illuminate\Database\Eloquent\Model|\Illuminate\Database\Eloquent\Collection|\Illuminate\Database\Eloquent\Builder|array|null
+     * @throws \Exception
+     */
     public function show(string $productId): \Illuminate\Database\Eloquent\Model|\Illuminate\Database\Eloquent\Collection|\Illuminate\Database\Eloquent\Builder|array|null
     {
         try {
@@ -21,6 +27,13 @@ public function show(string $productId): \Illuminate\Database\Eloquent\Model|\Il
         }
     }
 
+
+    /**
+     * Fetch product of particular category
+     * @param string $categoryId
+     * @return array
+     * @throws \Exception
+     */
     public function categoryProductList(string $categoryId): array
     {
         try {
@@ -47,6 +60,12 @@ public function categoryProductList(string $categoryId): array
         }
     }
 
+
+    /**
+     * fetch all child category
+     * @param $parentId
+     * @return array
+     */
     public function getAllChildrenCategory($parentId)
     {
         $childrenIds = Category::where('parent_id', $parentId)->pluck('id')->toArray();

diff --git a/app/Repositories/SellerProductRepository.php b/app/Repositories/SellerProductRepository.php
@@ -12,6 +12,10 @@
 use Illuminate\Support\Facades\Storage;
 class SellerProductRepository implements SellerProductRepositoryInterface
 {
+    /**
+     * Fetch all self product
+     * @return \Illuminate\Contracts\Pagination\LengthAwarePaginator
+     */
     public function getAll(): \Illuminate\Contracts\Pagination\LengthAwarePaginator
     {
         $user = auth()->user();
@@ -24,6 +28,12 @@ public function getById($id){
     }
 
 
+    /**
+     * Store new product to sell
+     * @param array $data
+     * @return array|string[]
+     * @throws \Exception
+     */
     public function store(array $data): array
     {
         try {
@@ -61,6 +71,14 @@ public function store(array $data): array
             throw $e;
         }
     }
+
+    /**
+     * update existing product
+     * @param $productId
+     * @param array $data
+     * @return array|string[]
+     * @throws \Exception
+     */
     public function update($productId, array $data): array
     {
         try {
@@ -105,6 +123,12 @@ public function update($productId, array $data): array
         }
     }
 
+    /**
+     * Remove existing product
+     * @param $productId
+     * @return array
+     * @throws \Exception
+     */
     public function delete($productId): array
     {
         try {

diff --git a/app/Repositories/UserRepository.php b/app/Repositories/UserRepository.php
@@ -11,6 +11,12 @@
 
 class UserRepository implements UserRepositoryInterface
 {
+
+    /**
+     * Create new user module
+     * @param array $data
+     * @return \Illuminate\Http\RedirectResponse
+     */
     public function createUser(array $data): \Illuminate\Http\RedirectResponse
     {
         try {