From a6ce67151fbf7fdff1e0bb4ae5b9422f08f0f9ea Mon Sep 17 00:00:00 2001 From: Jitendra Singh Date: Thu, 5 Mar 2020 11:04:57 +0530 Subject: [PATCH] Improved comments in code --- .../Controllers/Shop/AddressController.php | 8 +- .../Http/Controllers/Shop/CartController.php | 23 ++- .../Controllers/Shop/CategoryController.php | 4 +- .../Controllers/Shop/CheckoutController.php | 10 +- .../Controllers/Shop/CustomerController.php | 10 +- .../Controllers/Shop/ProductController.php | 7 +- .../Controllers/Shop/ResourceController.php | 4 +- .../Controllers/Shop/ReviewController.php | 5 +- .../Controllers/Shop/SessionController.php | 14 +- .../Controllers/Shop/WishlistController.php | 12 +- .../Admin/src/DataGrids/AddressDataGrid.php | 8 +- .../Admin/src/DataGrids/AttributeDataGrid.php | 4 +- .../Admin/src/DataGrids/CMSPageDataGrid.php | 10 +- .../src/DataGrids/CartRuleCouponDataGrid.php | 4 +- .../Admin/src/DataGrids/CartRuleDataGrid.php | 10 +- .../src/DataGrids/CatalogRuleDataGrid.php | 2 +- .../Admin/src/DataGrids/CategoryDataGrid.php | 16 +- .../Admin/src/DataGrids/CouponsDataGrid.php | 4 +- .../Admin/src/DataGrids/CustomerDataGrid.php | 6 +- .../src/DataGrids/CustomerReviewDataGrid.php | 8 +- .../src/DataGrids/ExchangeRatesDataGrid.php | 4 +- .../Admin/src/DataGrids/OrderDataGrid.php | 4 +- .../src/DataGrids/OrderInvoicesDataGrid.php | 4 +- .../src/DataGrids/OrderShipmentsDataGrid.php | 2 +- .../Admin/src/DataGrids/ProductDataGrid.php | 26 +-- .../Webkul/Admin/src/Exceptions/Handler.php | 6 +- .../Controllers/ConfigurationController.php | 7 +- .../Customer/AddressController.php | 10 +- .../Customer/CustomerController.php | 10 +- .../Http/Controllers/DashboardController.php | 16 +- .../Controllers/Sales/InvoiceController.php | 4 +- .../Controllers/Sales/OrderController.php | 2 +- .../Controllers/Sales/RefundController.php | 14 +- .../Controllers/Sales/ShipmentController.php | 12 +- packages/Webkul/Admin/src/Listeners/Order.php | 24 +-- .../src/Mail/CancelOrderNotification.php | 6 +- .../Admin/src/Mail/NewAdminNotification.php | 5 +- .../src/Mail/NewCustomerNotification.php | 13 +- .../Mail/NewInventorySourceNotification.php | 4 +- .../Admin/src/Mail/NewInvoiceNotification.php | 4 +- .../Admin/src/Mail/NewOrderNotification.php | 3 +- .../Admin/src/Mail/NewRefundNotification.php | 4 +- .../src/Mail/NewShipmentNotification.php | 4 +- .../Http/Controllers/AttributeController.php | 6 +- .../Controllers/AttributeFamilyController.php | 10 +- .../AttributeFamilyRepository.php | 26 +-- .../AttributeOptionRepository.php | 18 +- .../src/Repositories/AttributeRepository.php | 33 ++-- .../src/Helpers/AppointmentSlot.php | 4 +- .../BookingProduct/src/Helpers/Booking.php | 50 +++--- .../src/Helpers/DefaultSlot.php | 12 +- .../src/Helpers/EventTicket.php | 16 +- .../BookingProduct/src/Helpers/RentalSlot.php | 12 +- .../BookingProduct/src/Helpers/TableSlot.php | 2 +- .../Shop/BookingProductController.php | 19 +-- .../BookingProduct/src/Listeners/Order.php | 6 +- .../BookingProductEventTicketRepository.php | 4 +- .../Repositories/BookingProductRepository.php | 28 ++-- .../src/Repositories/BookingRepository.php | 4 +- .../BookingProduct/src/Type/Booking.php | 43 ++--- .../Http/Controllers/Admin/PageController.php | 11 +- .../Shop/PagePresenterController.php | 6 +- .../CMS/src/Repositories/CmsRepository.php | 22 +-- .../Webkul/CartRule/src/Helpers/CartRule.php | 46 +++--- .../Http/Controllers/CartRuleController.php | 19 +-- .../Controllers/CartRuleCouponController.php | 4 +- .../Webkul/CartRule/src/Listeners/Cart.php | 6 +- .../Webkul/CartRule/src/Listeners/Order.php | 18 +- .../Repositories/CartRuleCouponRepository.php | 8 +- .../src/Repositories/CartRuleRepository.php | 42 ++--- .../src/Console/Commands/PriceRuleIndex.php | 6 +- .../src/Helpers/CatalogRuleIndex.php | 18 +- .../src/Helpers/CatalogRuleProduct.php | 37 +++-- .../src/Helpers/CatalogRuleProductPrice.php | 28 ++-- .../Controllers/CatalogRuleController.php | 12 +- .../CatalogRule/src/Listeners/Product.php | 6 +- .../Repositories/CatalogRuleRepository.php | 30 ++-- .../Http/Controllers/CategoryController.php | 15 +- .../src/Observers/CategoryObserver.php | 4 +- .../src/Repositories/CategoryRepository.php | 52 +++--- packages/Webkul/Checkout/src/Cart.php | 122 ++++++-------- .../src/Listeners/CustomerEventsHandler.php | 2 +- .../src/Repositories/CartItemRepository.php | 13 +- .../src/Repositories/CartRepository.php | 30 ++-- packages/Webkul/Core/src/Core.php | 155 ++++++++++-------- .../Webkul/Core/src/Eloquent/Repository.php | 31 ++-- .../Core/src/Eloquent/TranslatableModel.php | 5 +- .../src/Helpers/Exchange/FixerExchange.php | 14 ++ .../Core/src/Helpers/Laravel5Helper.php | 44 +++-- packages/Webkul/Core/src/Helpers/Locales.php | 3 + .../Http/Controllers/ChannelController.php | 4 +- .../Controllers/CountryStateController.php | 12 +- .../Http/Controllers/CurrencyController.php | 9 +- .../Controllers/ExchangeRateController.php | 9 +- .../src/Http/Controllers/LocaleController.php | 4 +- .../src/Http/Controllers/SliderController.php | 17 +- .../Controllers/SubscriptionController.php | 10 +- .../Core/src/Observers/SliderObserver.php | 2 +- .../src/Repositories/ChannelRepository.php | 17 +- .../src/Repositories/CoreConfigRepository.php | 15 +- .../src/Repositories/CurrencyRepository.php | 6 + .../src/Repositories/SliderRepository.php | 16 +- .../SubscribersListRepository.php | 4 +- packages/Webkul/Core/src/Tree.php | 17 +- .../Webkul/Customer/src/Helpers/Wishlist.php | 6 +- .../Http/Controllers/AddressController.php | 34 ++-- .../Http/Controllers/CustomerController.php | 19 ++- .../Controllers/RegistrationController.php | 17 +- .../Http/Controllers/WishlistController.php | 20 ++- .../Http/Middleware/RedirectIfNotCustomer.php | 4 +- .../Customer/src/Mail/RegistrationEmail.php | 12 +- .../Customer/src/Mail/VerificationEmail.php | 12 +- .../CustomerAddressRepository.php | 13 +- .../Repositories/CustomerGroupRepository.php | 14 +- .../src/Repositories/WishlistRepository.php | 28 ++-- .../Webkul/Customer/src/Rules/VatIdRule.php | 2 +- .../Customer/src/Rules/VatValidator.php | 9 +- 117 files changed, 931 insertions(+), 860 deletions(-) diff --git a/packages/Webkul/API/Http/Controllers/Shop/AddressController.php b/packages/Webkul/API/Http/Controllers/Shop/AddressController.php index 8a909c8ca..ee8df36b8 100644 --- a/packages/Webkul/API/Http/Controllers/Shop/AddressController.php +++ b/packages/Webkul/API/Http/Controllers/Shop/AddressController.php @@ -30,18 +30,16 @@ class AddressController extends Controller /** * CustomerAddressRepository object * - * @var Object + * @var \Webkul\Customer\Repositories\CustomerAddressRepository */ protected $customerAddressRepository; /** * Controller instance * - * @param Webkul\Customer\Repositories\CustomerAddressRepository $customerAddressRepository + * @param Webkul\Customer\Repositories\CustomerAddressRepository $customerAddressRepository */ - public function __construct( - CustomerAddressRepository $customerAddressRepository - ) + public function __construct(CustomerAddressRepository $customerAddressRepository) { $this->guard = request()->has('token') ? 'api' : 'customer'; diff --git a/packages/Webkul/API/Http/Controllers/Shop/CartController.php b/packages/Webkul/API/Http/Controllers/Shop/CartController.php index 4c10fea5c..25bda2b47 100644 --- a/packages/Webkul/API/Http/Controllers/Shop/CartController.php +++ b/packages/Webkul/API/Http/Controllers/Shop/CartController.php @@ -27,30 +27,30 @@ class CartController extends Controller /** * CartRepository object * - * @var Object + * @var \Webkul\Checkout\Repositories\CartRepository */ protected $cartRepository; /** * CartItemRepository object * - * @var Object + * @var \Webkul\Checkout\Repositories\CartItemRepository */ protected $cartItemRepository; /** * WishlistRepository object * - * @var Object + * @var \Webkul\Checkout\Repositories\WishlistRepository */ protected $wishlistRepository; /** * Controller instance * - * @param Webkul\Checkout\Repositories\CartRepository $cartRepository - * @param Webkul\Checkout\Repositories\CartItemRepository $cartItemRepository - * @param Webkul\Checkout\Repositories\WishlistRepository $wishlistRepository + * @param \Webkul\Checkout\Repositories\CartRepository $cartRepository + * @param \Webkul\Checkout\Repositories\CartItemRepository $cartItemRepository + * @param \Webkul\Checkout\Repositories\WishlistRepository $wishlistRepository */ public function __construct( CartRepository $cartRepository, @@ -92,8 +92,7 @@ class CartController extends Controller /** * Store a newly created resource in storage. * - * @param int $id - * + * @param int $id * @return \Illuminate\Http\Response */ public function store($id) @@ -189,8 +188,7 @@ class CartController extends Controller /** * Remove the specified resource from storage. * - * @param int $id - * + * @param int $id * @return \Illuminate\Http\Response */ public function destroyItem($id) @@ -212,10 +210,9 @@ class CartController extends Controller } /** - * Function to move a already added product to wishlist - * will run only on customer authentication. + * Function to move a already added product to wishlist will run only on customer authentication. * - * @param instance cartItem $id + * @param \Webkul\Checkout\Repositories\CartItemRepository $id */ public function moveToWishlist($id) { diff --git a/packages/Webkul/API/Http/Controllers/Shop/CategoryController.php b/packages/Webkul/API/Http/Controllers/Shop/CategoryController.php index 9b0045bbe..53a8cfa4b 100755 --- a/packages/Webkul/API/Http/Controllers/Shop/CategoryController.php +++ b/packages/Webkul/API/Http/Controllers/Shop/CategoryController.php @@ -17,14 +17,14 @@ class CategoryController extends Controller /** * CategoryRepository object * - * @var array + * @var \Webkul\Category\Repositories\CategoryRepository */ protected $categoryRepository; /** * Create a new controller instance. * - * @param Webkul\Category\Repositories\CategoryRepository $categoryRepository + * @param Webkul\Category\Repositories\CategoryRepository $categoryRepository * @return void */ public function __construct(CategoryRepository $categoryRepository) diff --git a/packages/Webkul/API/Http/Controllers/Shop/CheckoutController.php b/packages/Webkul/API/Http/Controllers/Shop/CheckoutController.php index 6fbca5923..8c5c445a7 100644 --- a/packages/Webkul/API/Http/Controllers/Shop/CheckoutController.php +++ b/packages/Webkul/API/Http/Controllers/Shop/CheckoutController.php @@ -33,23 +33,23 @@ class CheckoutController extends Controller /** * CartRepository object * - * @var Object + * @var \Webkul\Checkout\Repositories\CartRepository */ protected $cartRepository; /** * CartItemRepository object * - * @var Object + * @var \Webkul\Checkout\Repositories\CartItemRepository */ protected $cartItemRepository; /** * Controller instance * - * @param Webkul\Checkout\Repositories\CartRepository $cartRepository - * @param Webkul\Checkout\Repositories\CartItemRepository $cartItemRepository - * @param Webkul\Sales\Repositories\OrderRepository $orderRepository + * @param \Webkul\Checkout\Repositories\CartRepository $cartRepository + * @param \Webkul\Checkout\Repositories\CartItemRepository $cartItemRepository + * @param \Webkul\Sales\Repositories\OrderRepository $orderRepository */ public function __construct( CartRepository $cartRepository, diff --git a/packages/Webkul/API/Http/Controllers/Shop/CustomerController.php b/packages/Webkul/API/Http/Controllers/Shop/CustomerController.php index 63c5260f1..0cabce0b9 100644 --- a/packages/Webkul/API/Http/Controllers/Shop/CustomerController.php +++ b/packages/Webkul/API/Http/Controllers/Shop/CustomerController.php @@ -25,22 +25,22 @@ class CustomerController extends Controller /** * Repository object * - * @var array + * @var \Webkul\Customer\Repositories\CustomerRepository */ protected $customerRepository; /** * Repository object * - * @var array + * @var \Webkul\Customer\Repositories\CustomerGroupRepository */ protected $customerGroupRepository; /** * Create a new controller instance. * - * @param \Webkul\Customer\Repositories\CustomerRepository $customerRepository - * @param \Webkul\Customer\Repositories\CustomerGroupRepository $customerGroupRepository + * @param \Webkul\Customer\Repositories\CustomerRepository $customerRepository + * @param \Webkul\Customer\Repositories\CustomerGroupRepository $customerGroupRepository * @return void */ public function __construct( @@ -57,7 +57,7 @@ class CustomerController extends Controller /** * Method to store user's sign up form data to DB. * - * @return Mixed + * @return \Illuminate\Http\Response */ public function create() { diff --git a/packages/Webkul/API/Http/Controllers/Shop/ProductController.php b/packages/Webkul/API/Http/Controllers/Shop/ProductController.php index ebcac1ea1..1a3854d9a 100755 --- a/packages/Webkul/API/Http/Controllers/Shop/ProductController.php +++ b/packages/Webkul/API/Http/Controllers/Shop/ProductController.php @@ -18,14 +18,14 @@ class ProductController extends Controller /** * ProductRepository object * - * @var array + * @var \Webkul\Product\Repositories\ProductRepository */ protected $productRepository; /** * Create a new controller instance. * - * @param Webkul\Product\Repositories\ProductRepository $productRepository + * @param \Webkul\Product\Repositories\ProductRepository $productRepository * @return void */ public function __construct(ProductRepository $productRepository) @@ -46,6 +46,7 @@ class ProductController extends Controller /** * Returns a individual resource. * + * @param int $id * @return \Illuminate\Http\Response */ public function get($id) @@ -58,6 +59,7 @@ class ProductController extends Controller /** * Returns product's additional information. * + * @param int $id * @return \Illuminate\Http\Response */ public function additionalInformation($id) @@ -70,6 +72,7 @@ class ProductController extends Controller /** * Returns product's additional information. * + * @param int $id * @return \Illuminate\Http\Response */ public function configurableConfig($id) diff --git a/packages/Webkul/API/Http/Controllers/Shop/ResourceController.php b/packages/Webkul/API/Http/Controllers/Shop/ResourceController.php index 500d50a45..e3bc2d6db 100644 --- a/packages/Webkul/API/Http/Controllers/Shop/ResourceController.php +++ b/packages/Webkul/API/Http/Controllers/Shop/ResourceController.php @@ -29,7 +29,7 @@ class ResourceController extends Controller /** * Repository object * - * @var array + * @var \Webkul\Core\Eloquent\Repository */ protected $repository; @@ -87,6 +87,7 @@ class ResourceController extends Controller /** * Returns a individual resource. * + * @param int $id * @return \Illuminate\Http\Response */ public function get($id) @@ -99,6 +100,7 @@ class ResourceController extends Controller /** * Delete's a individual resource. * + * @param int $id * @return \Illuminate\Http\Response */ public function destroy($id) diff --git a/packages/Webkul/API/Http/Controllers/Shop/ReviewController.php b/packages/Webkul/API/Http/Controllers/Shop/ReviewController.php index dbe44d6ed..3ceb76e1e 100644 --- a/packages/Webkul/API/Http/Controllers/Shop/ReviewController.php +++ b/packages/Webkul/API/Http/Controllers/Shop/ReviewController.php @@ -24,14 +24,14 @@ class ReviewController extends Controller /** * ProductReviewRepository object * - * @var array + * @var \Webkul\Product\Repositories\ProductReviewRepository */ protected $reviewRepository; /** * Controller instance * - * @param Webkul\Product\Repositories\ProductReviewRepository $reviewRepository + * @param Webkul\Product\Repositories\ProductReviewRepository $reviewRepository */ public function __construct(ProductReviewRepository $reviewRepository) { @@ -46,6 +46,7 @@ class ReviewController extends Controller * Store a newly created resource in storage. * * @param \Illuminate\Http\Request $request + * @param int $id * @return \Illuminate\Http\Response */ public function store(Request $request, $id) diff --git a/packages/Webkul/API/Http/Controllers/Shop/SessionController.php b/packages/Webkul/API/Http/Controllers/Shop/SessionController.php index 0c37aed69..291f10331 100644 --- a/packages/Webkul/API/Http/Controllers/Shop/SessionController.php +++ b/packages/Webkul/API/Http/Controllers/Shop/SessionController.php @@ -17,7 +17,7 @@ class SessionController extends Controller /** * Contains current guard * - * @var array + * @var string */ protected $guard; @@ -31,7 +31,7 @@ class SessionController extends Controller /** * Controller instance * - * @param Webkul\Customer\Repositories\CustomerRepository $customerRepository + * @param \Webkul\Customer\Repositories\CustomerRepository $customerRepository */ public function __construct(CustomerRepository $customerRepository) { @@ -49,7 +49,7 @@ class SessionController extends Controller /** * Method to store user's sign up form data to DB. * - * @return Mixed + * @return \Illuminate\Http\Response */ public function create() { @@ -71,10 +71,10 @@ class SessionController extends Controller $customer = auth($this->guard)->user(); return response()->json([ - 'token' => $jwtToken, - 'message' => 'Logged in successfully.', - 'data' => new CustomerResource($customer), - ]); + 'token' => $jwtToken, + 'message' => 'Logged in successfully.', + 'data' => new CustomerResource($customer), + ]); } /** diff --git a/packages/Webkul/API/Http/Controllers/Shop/WishlistController.php b/packages/Webkul/API/Http/Controllers/Shop/WishlistController.php index 53cc9873b..f5d06a9d6 100644 --- a/packages/Webkul/API/Http/Controllers/Shop/WishlistController.php +++ b/packages/Webkul/API/Http/Controllers/Shop/WishlistController.php @@ -20,20 +20,20 @@ class WishlistController extends Controller /** * WishlistRepository object * - * @var object + * @var \Webkul\Customer\Repositories\WishlistRepository */ protected $wishlistRepository; /** * ProductRepository object * - * @var object + * @var \Webkul\Customer\Repositories\ProductRepository */ protected $productRepository; /** - * @param Webkul\Customer\Repositories\WishlistRepository $wishlistRepository - * @param Webkul\Product\Repositories\ProductRepository $productRepository + * @param \Webkul\Customer\Repositories\WishlistRepository $wishlistRepository + * @param \Webkul\Product\Repositories\ProductRepository $productRepository */ public function __construct( WishlistRepository $wishlistRepository, @@ -54,7 +54,7 @@ class WishlistController extends Controller /** * Function to add item to the wishlist. * - * @param integer $id + * @param int $id * @return \Illuminate\Http\Response */ public function create($id) @@ -93,7 +93,7 @@ class WishlistController extends Controller /** * Move product from wishlist to cart. * - * @param integer $id + * @param int $id * @return \Illuminate\Http\Response */ public function moveToCart($id) diff --git a/packages/Webkul/Admin/src/DataGrids/AddressDataGrid.php b/packages/Webkul/Admin/src/DataGrids/AddressDataGrid.php index 7a843df26..8cd92e450 100644 --- a/packages/Webkul/Admin/src/DataGrids/AddressDataGrid.php +++ b/packages/Webkul/Admin/src/DataGrids/AddressDataGrid.php @@ -49,10 +49,10 @@ class AddressDataGrid extends DataGrid $customer = $this->customerRepository->find(request('id')); $queryBuilder = DB::table('customer_addresses as ca') - ->leftJoin('countries', 'ca.country', '=', 'countries.code') - ->leftJoin('customers as c', 'ca.customer_id', '=', 'c.id') - ->addSelect('ca.id as address_id', 'ca.company_name', 'ca.address1', 'ca.country', DB::raw('' . DB::getTablePrefix() . 'countries.name as country_name'), 'ca.state', 'ca.city', 'ca.postcode', 'ca.phone', 'ca.default_address') - ->where('c.id', $customer->id); + ->leftJoin('countries', 'ca.country', '=', 'countries.code') + ->leftJoin('customers as c', 'ca.customer_id', '=', 'c.id') + ->addSelect('ca.id as address_id', 'ca.company_name', 'ca.address1', 'ca.country', DB::raw('' . DB::getTablePrefix() . 'countries.name as country_name'), 'ca.state', 'ca.city', 'ca.postcode', 'ca.phone', 'ca.default_address') + ->where('c.id', $customer->id); $queryBuilder = $queryBuilder->leftJoin('country_states', function($qb) { $qb->on('ca.state', 'country_states.code') diff --git a/packages/Webkul/Admin/src/DataGrids/AttributeDataGrid.php b/packages/Webkul/Admin/src/DataGrids/AttributeDataGrid.php index 8031902ff..bfcfe0f63 100755 --- a/packages/Webkul/Admin/src/DataGrids/AttributeDataGrid.php +++ b/packages/Webkul/Admin/src/DataGrids/AttributeDataGrid.php @@ -20,8 +20,8 @@ class AttributeDataGrid extends DataGrid public function prepareQueryBuilder() { $queryBuilder = DB::table('attributes') - ->select('id') - ->addSelect('id', 'code', 'admin_name', 'type', 'is_required', 'is_unique', 'value_per_locale', 'value_per_channel'); + ->select('id') + ->addSelect('id', 'code', 'admin_name', 'type', 'is_required', 'is_unique', 'value_per_locale', 'value_per_channel'); $this->setQueryBuilder($queryBuilder); } diff --git a/packages/Webkul/Admin/src/DataGrids/CMSPageDataGrid.php b/packages/Webkul/Admin/src/DataGrids/CMSPageDataGrid.php index c2fb98aea..f9c443e6c 100644 --- a/packages/Webkul/Admin/src/DataGrids/CMSPageDataGrid.php +++ b/packages/Webkul/Admin/src/DataGrids/CMSPageDataGrid.php @@ -20,11 +20,11 @@ class CMSPageDataGrid extends DataGrid public function prepareQueryBuilder() { $queryBuilder = DB::table('cms_pages') - ->select('cms_pages.id', 'cms_page_translations.page_title', 'cms_page_translations.url_key') - ->leftJoin('cms_page_translations', function($leftJoin) { - $leftJoin->on('cms_pages.id', '=', 'cms_page_translations.cms_page_id') - ->where('cms_page_translations.locale', app()->getLocale()); - }); + ->select('cms_pages.id', 'cms_page_translations.page_title', 'cms_page_translations.url_key') + ->leftJoin('cms_page_translations', function($leftJoin) { + $leftJoin->on('cms_pages.id', '=', 'cms_page_translations.cms_page_id') + ->where('cms_page_translations.locale', app()->getLocale()); + }); $this->addFilter('id', 'cms_pages.id'); diff --git a/packages/Webkul/Admin/src/DataGrids/CartRuleCouponDataGrid.php b/packages/Webkul/Admin/src/DataGrids/CartRuleCouponDataGrid.php index 28f458eeb..7d71d6ded 100644 --- a/packages/Webkul/Admin/src/DataGrids/CartRuleCouponDataGrid.php +++ b/packages/Webkul/Admin/src/DataGrids/CartRuleCouponDataGrid.php @@ -20,8 +20,8 @@ class CartRuleCouponDataGrid extends DataGrid public function prepareQueryBuilder() { $queryBuilder = DB::table('cart_rule_coupons') - ->addSelect('id', 'code', 'created_at', 'expired_at', 'times_used') - ->where('cart_rule_coupons.cart_rule_id', collect(request()->segments())->last()); + ->addSelect('id', 'code', 'created_at', 'expired_at', 'times_used') + ->where('cart_rule_coupons.cart_rule_id', collect(request()->segments())->last()); $this->setQueryBuilder($queryBuilder); } diff --git a/packages/Webkul/Admin/src/DataGrids/CartRuleDataGrid.php b/packages/Webkul/Admin/src/DataGrids/CartRuleDataGrid.php index 38e5a9238..5c1fb4b72 100644 --- a/packages/Webkul/Admin/src/DataGrids/CartRuleDataGrid.php +++ b/packages/Webkul/Admin/src/DataGrids/CartRuleDataGrid.php @@ -20,11 +20,11 @@ class CartRuleDataGrid extends DataGrid public function prepareQueryBuilder() { $queryBuilder = DB::table('cart_rules') - ->leftJoin('cart_rule_coupons', function($leftJoin) { - $leftJoin->on('cart_rule_coupons.cart_rule_id', '=', 'cart_rules.id') - ->where('cart_rule_coupons.is_primary', 1); - }) - ->addSelect('cart_rules.id', 'name', 'cart_rule_coupons.code as coupon_code', 'status', 'starts_from', 'ends_till', 'sort_order'); + ->leftJoin('cart_rule_coupons', function($leftJoin) { + $leftJoin->on('cart_rule_coupons.cart_rule_id', '=', 'cart_rules.id') + ->where('cart_rule_coupons.is_primary', 1); + }) + ->addSelect('cart_rules.id', 'name', 'cart_rule_coupons.code as coupon_code', 'status', 'starts_from', 'ends_till', 'sort_order'); $this->addFilter('id', 'cart_rules.id'); $this->addFilter('coupon_code', 'cart_rule_coupons.code'); diff --git a/packages/Webkul/Admin/src/DataGrids/CatalogRuleDataGrid.php b/packages/Webkul/Admin/src/DataGrids/CatalogRuleDataGrid.php index 9a9a12494..e9d497e92 100644 --- a/packages/Webkul/Admin/src/DataGrids/CatalogRuleDataGrid.php +++ b/packages/Webkul/Admin/src/DataGrids/CatalogRuleDataGrid.php @@ -20,7 +20,7 @@ class CatalogRuleDataGrid extends DataGrid public function prepareQueryBuilder() { $queryBuilder = DB::table('catalog_rules') - ->addSelect('catalog_rules.id', 'name', 'status', 'starts_from', 'ends_till', 'sort_order'); + ->addSelect('catalog_rules.id', 'name', 'status', 'starts_from', 'ends_till', 'sort_order'); $this->setQueryBuilder($queryBuilder); } diff --git a/packages/Webkul/Admin/src/DataGrids/CategoryDataGrid.php b/packages/Webkul/Admin/src/DataGrids/CategoryDataGrid.php index 9b670a064..26a16b55a 100755 --- a/packages/Webkul/Admin/src/DataGrids/CategoryDataGrid.php +++ b/packages/Webkul/Admin/src/DataGrids/CategoryDataGrid.php @@ -20,14 +20,14 @@ class CategoryDataGrid extends DataGrid public function prepareQueryBuilder() { $queryBuilder = DB::table('categories as cat') - ->select('cat.id as category_id', 'ct.name', 'cat.position', 'cat.status', 'ct.locale', - DB::raw('COUNT(DISTINCT ' . DB::getTablePrefix() . 'pc.product_id) as count')) - ->leftJoin('category_translations as ct', function($leftJoin) { - $leftJoin->on('cat.id', '=', 'ct.category_id') - ->where('ct.locale', app()->getLocale()); - }) - ->leftJoin('product_categories as pc', 'cat.id', '=', 'pc.category_id') - ->groupBy('cat.id'); + ->select('cat.id as category_id', 'ct.name', 'cat.position', 'cat.status', 'ct.locale', + DB::raw('COUNT(DISTINCT ' . DB::getTablePrefix() . 'pc.product_id) as count')) + ->leftJoin('category_translations as ct', function($leftJoin) { + $leftJoin->on('cat.id', '=', 'ct.category_id') + ->where('ct.locale', app()->getLocale()); + }) + ->leftJoin('product_categories as pc', 'cat.id', '=', 'pc.category_id') + ->groupBy('cat.id'); $this->addFilter('category_id', 'cat.id'); diff --git a/packages/Webkul/Admin/src/DataGrids/CouponsDataGrid.php b/packages/Webkul/Admin/src/DataGrids/CouponsDataGrid.php index c73932aa2..474854788 100644 --- a/packages/Webkul/Admin/src/DataGrids/CouponsDataGrid.php +++ b/packages/Webkul/Admin/src/DataGrids/CouponsDataGrid.php @@ -20,8 +20,8 @@ class CartRuleCouponsDataGrid extends DataGrid public function prepareQueryBuilder() { $queryBuilder = DB::table('cart_rules') - ->select('id') - ->addSelect('id', 'code', 'limit', 'usage_per_customer', 'usage_throttle'); + ->select('id') + ->addSelect('id', 'code', 'limit', 'usage_per_customer', 'usage_throttle'); $this->setQueryBuilder($queryBuilder); } diff --git a/packages/Webkul/Admin/src/DataGrids/CustomerDataGrid.php b/packages/Webkul/Admin/src/DataGrids/CustomerDataGrid.php index 59b14bc0c..de1cd8f03 100755 --- a/packages/Webkul/Admin/src/DataGrids/CustomerDataGrid.php +++ b/packages/Webkul/Admin/src/DataGrids/CustomerDataGrid.php @@ -23,9 +23,9 @@ class CustomerDataGrid extends DataGrid public function prepareQueryBuilder() { $queryBuilder = DB::table('customers') - ->leftJoin('customer_groups', 'customers.customer_group_id', '=', 'customer_groups.id') - ->addSelect('customers.id as customer_id', 'customers.email', 'customer_groups.name', 'customers.phone', 'customers.gender', 'status') - ->addSelect(DB::raw('CONCAT(' . DB::getTablePrefix() . 'customers.first_name, " ", ' . DB::getTablePrefix() . 'customers.last_name) as full_name')); + ->leftJoin('customer_groups', 'customers.customer_group_id', '=', 'customer_groups.id') + ->addSelect('customers.id as customer_id', 'customers.email', 'customer_groups.name', 'customers.phone', 'customers.gender', 'status') + ->addSelect(DB::raw('CONCAT(' . DB::getTablePrefix() . 'customers.first_name, " ", ' . DB::getTablePrefix() . 'customers.last_name) as full_name')); $this->addFilter('customer_id', 'customers.id'); $this->addFilter('full_name', DB::raw('CONCAT(' . DB::getTablePrefix() . 'customers.first_name, " ", ' . DB::getTablePrefix() . 'customers.last_name)')); diff --git a/packages/Webkul/Admin/src/DataGrids/CustomerReviewDataGrid.php b/packages/Webkul/Admin/src/DataGrids/CustomerReviewDataGrid.php index a02d43aa8..ef313d463 100755 --- a/packages/Webkul/Admin/src/DataGrids/CustomerReviewDataGrid.php +++ b/packages/Webkul/Admin/src/DataGrids/CustomerReviewDataGrid.php @@ -20,10 +20,10 @@ class CustomerReviewDataGrid extends DataGrid public function prepareQueryBuilder() { $queryBuilder = DB::table('product_reviews as pr') - ->leftjoin('product_flat as pf', 'pr.product_id', '=', 'pf.product_id') - ->select('pr.id as product_review_id', 'pr.title', 'pr.comment', 'pf.name as product_name', 'pr.status as product_review_status') - ->where('channel', core()->getCurrentChannelCode()) - ->where('locale', app()->getLocale()); + ->leftjoin('product_flat as pf', 'pr.product_id', '=', 'pf.product_id') + ->select('pr.id as product_review_id', 'pr.title', 'pr.comment', 'pf.name as product_name', 'pr.status as product_review_status') + ->where('channel', core()->getCurrentChannelCode()) + ->where('locale', app()->getLocale()); $this->addFilter('product_review_id', 'pr.id'); $this->addFilter('product_review_status', 'pr.status'); diff --git a/packages/Webkul/Admin/src/DataGrids/ExchangeRatesDataGrid.php b/packages/Webkul/Admin/src/DataGrids/ExchangeRatesDataGrid.php index 439d2ad6c..ce3852fdb 100755 --- a/packages/Webkul/Admin/src/DataGrids/ExchangeRatesDataGrid.php +++ b/packages/Webkul/Admin/src/DataGrids/ExchangeRatesDataGrid.php @@ -19,7 +19,9 @@ class ExchangeRatesDataGrid extends DataGrid public function prepareQueryBuilder() { - $queryBuilder = DB::table('currency_exchange_rates as cer')->addSelect('cer.id as currency_exch_id', 'curr.name', 'cer.rate')->leftJoin('currencies as curr', 'cer.target_currency', '=', 'curr.id'); + $queryBuilder = DB::table('currency_exchange_rates as cer') + ->leftJoin('currencies as curr', 'cer.target_currency', '=', 'curr.id') + ->addSelect('cer.id as currency_exch_id', 'curr.name', 'cer.rate'); $this->addFilter('currency_exch_id', 'cer.id'); diff --git a/packages/Webkul/Admin/src/DataGrids/OrderDataGrid.php b/packages/Webkul/Admin/src/DataGrids/OrderDataGrid.php index e57a31a69..87788ad48 100755 --- a/packages/Webkul/Admin/src/DataGrids/OrderDataGrid.php +++ b/packages/Webkul/Admin/src/DataGrids/OrderDataGrid.php @@ -22,11 +22,11 @@ class OrderDataGrid extends DataGrid $queryBuilder = DB::table('orders') ->leftJoin('order_address as order_address_shipping', function($leftJoin) { $leftJoin->on('order_address_shipping.order_id', '=', 'orders.id') - ->where('order_address_shipping.address_type', 'shipping'); + ->where('order_address_shipping.address_type', 'shipping'); }) ->leftJoin('order_address as order_address_billing', function($leftJoin) { $leftJoin->on('order_address_billing.order_id', '=', 'orders.id') - ->where('order_address_billing.address_type', 'billing'); + ->where('order_address_billing.address_type', 'billing'); }) ->addSelect('orders.id','orders.increment_id', 'orders.base_sub_total', 'orders.base_grand_total', 'orders.created_at', 'channel_name', 'status') ->addSelect(DB::raw('CONCAT(' . DB::getTablePrefix() . 'order_address_billing.first_name, " ", ' . DB::getTablePrefix() . 'order_address_billing.last_name) as billed_to')) diff --git a/packages/Webkul/Admin/src/DataGrids/OrderInvoicesDataGrid.php b/packages/Webkul/Admin/src/DataGrids/OrderInvoicesDataGrid.php index 204f9bdb5..e994b530d 100755 --- a/packages/Webkul/Admin/src/DataGrids/OrderInvoicesDataGrid.php +++ b/packages/Webkul/Admin/src/DataGrids/OrderInvoicesDataGrid.php @@ -20,8 +20,8 @@ class OrderInvoicesDataGrid extends DataGrid public function prepareQueryBuilder() { $queryBuilder = DB::table('invoices') - ->leftJoin('orders as ors', 'invoices.order_id', '=', 'ors.id') - ->select('invoices.id as id', 'ors.increment_id as order_id', 'invoices.state as state', 'invoices.base_grand_total as base_grand_total', 'invoices.created_at as created_at'); + ->leftJoin('orders as ors', 'invoices.order_id', '=', 'ors.id') + ->select('invoices.id as id', 'ors.increment_id as order_id', 'invoices.state as state', 'invoices.base_grand_total as base_grand_total', 'invoices.created_at as created_at'); $this->addFilter('id', 'invoices.id'); $this->addFilter('order_id', 'ors.increment_id'); diff --git a/packages/Webkul/Admin/src/DataGrids/OrderShipmentsDataGrid.php b/packages/Webkul/Admin/src/DataGrids/OrderShipmentsDataGrid.php index 3000d664a..41f2355df 100755 --- a/packages/Webkul/Admin/src/DataGrids/OrderShipmentsDataGrid.php +++ b/packages/Webkul/Admin/src/DataGrids/OrderShipmentsDataGrid.php @@ -22,7 +22,7 @@ class OrderShipmentsDataGrid extends DataGrid $queryBuilder = DB::table('shipments') ->leftJoin('order_address as order_address_shipping', function($leftJoin) { $leftJoin->on('order_address_shipping.order_id', '=', 'shipments.order_id') - ->where('order_address_shipping.address_type', 'shipping'); + ->where('order_address_shipping.address_type', 'shipping'); }) ->leftJoin('orders as ors', 'shipments.order_id', '=', 'ors.id') ->leftJoin('inventory_sources as is', 'shipments.inventory_source_id', '=', 'is.id') diff --git a/packages/Webkul/Admin/src/DataGrids/ProductDataGrid.php b/packages/Webkul/Admin/src/DataGrids/ProductDataGrid.php index 5fac94c34..8d89b3c5c 100644 --- a/packages/Webkul/Admin/src/DataGrids/ProductDataGrid.php +++ b/packages/Webkul/Admin/src/DataGrids/ProductDataGrid.php @@ -39,19 +39,19 @@ class ProductDataGrid extends DataGrid public function prepareQueryBuilder() { $queryBuilder = DB::table('product_flat') - ->leftJoin('products', 'product_flat.product_id', '=', 'products.id') - ->leftJoin('attribute_families', 'products.attribute_family_id', '=', 'attribute_families.id') - ->leftJoin('product_inventories', 'product_flat.product_id', '=', 'product_inventories.product_id') - ->select( - 'product_flat.product_id as product_id', - 'products.sku as product_sku', - 'product_flat.name as product_name', - 'products.type as product_type', - 'product_flat.status', - 'product_flat.price', - 'attribute_families.name as attribute_family', - DB::raw('SUM(DISTINCT ' . DB::getTablePrefix() . 'product_inventories.qty) as quantity') - )->where('locale', $this->locale)->where('locale', $this->locale); + ->leftJoin('products', 'product_flat.product_id', '=', 'products.id') + ->leftJoin('attribute_families', 'products.attribute_family_id', '=', 'attribute_families.id') + ->leftJoin('product_inventories', 'product_flat.product_id', '=', 'product_inventories.product_id') + ->select( + 'product_flat.product_id as product_id', + 'products.sku as product_sku', + 'product_flat.name as product_name', + 'products.type as product_type', + 'product_flat.status', + 'product_flat.price', + 'attribute_families.name as attribute_family', + DB::raw('SUM(DISTINCT ' . DB::getTablePrefix() . 'product_inventories.qty) as quantity') + )->where('locale', $this->locale)->where('locale', $this->locale); $queryBuilder->groupBy('product_flat.product_id'); diff --git a/packages/Webkul/Admin/src/Exceptions/Handler.php b/packages/Webkul/Admin/src/Exceptions/Handler.php index 59fea81bb..aba8ab21a 100755 --- a/packages/Webkul/Admin/src/Exceptions/Handler.php +++ b/packages/Webkul/Admin/src/Exceptions/Handler.php @@ -22,7 +22,7 @@ class Handler extends ExceptionHandler * Render an exception into an HTTP response. * * @param \Illuminate\Http\Request $request - * @param \Exception $exception + * @param \Exception $exception * @return \Illuminate\Http\Response */ public function render($request, Exception $exception) @@ -45,8 +45,8 @@ class Handler extends ExceptionHandler /** * Convert an authentication exception into a response. * - * @param \Illuminate\Http\Request $request - * @param \Illuminate\Auth\AuthenticationException $exception + * @param \Illuminate\Http\Request $request + * @param \Illuminate\Auth\AuthenticationException $exception * @return \Illuminate\Http\Response */ protected function unauthenticated($request, AuthenticationException $exception) diff --git a/packages/Webkul/Admin/src/Http/Controllers/ConfigurationController.php b/packages/Webkul/Admin/src/Http/Controllers/ConfigurationController.php index 5efc71bdf..1e0618f7e 100755 --- a/packages/Webkul/Admin/src/Http/Controllers/ConfigurationController.php +++ b/packages/Webkul/Admin/src/Http/Controllers/ConfigurationController.php @@ -39,7 +39,7 @@ class ConfigurationController extends Controller /** * Create a new controller instance. * - * @param \Webkul\Core\Repositories\CoreConfigRepository $coreConfigRepository + * @param \Webkul\Core\Repositories\CoreConfigRepository $coreConfigRepository * @return void */ public function __construct(CoreConfigRepository $coreConfigRepository) @@ -113,7 +113,7 @@ class ConfigurationController extends Controller /** * Store a newly created resource in storage. * - * @param \Webkul\Admin\Http\Requests\ConfigurationForm $request + * @param \Webkul\Admin\Http\Requests\ConfigurationForm $request * @return \Illuminate\Http\Response */ public function store(ConfigurationForm $request) @@ -146,8 +146,7 @@ class ConfigurationController extends Controller } /** - * @param $secondItem - * + * @param string $secondItem * @return array */ private function getSlugs($secondItem): array diff --git a/packages/Webkul/Admin/src/Http/Controllers/Customer/AddressController.php b/packages/Webkul/Admin/src/Http/Controllers/Customer/AddressController.php index b28ecefdd..37a0a8309 100644 --- a/packages/Webkul/Admin/src/Http/Controllers/Customer/AddressController.php +++ b/packages/Webkul/Admin/src/Http/Controllers/Customer/AddressController.php @@ -127,10 +127,10 @@ class AddressController extends Controller } /** - * Edit's the premade resource of customer called - * Address. + * Edit's the premade resource of customer called Address. * - * @return redirect + * @param int $id + * @return \Illuminate\Http\Response */ public function update($id) { @@ -165,7 +165,6 @@ class AddressController extends Controller * Remove the specified resource from storage. * * @param int $id - * * @return \Illuminate\Http\Response */ public function destroy($id) @@ -180,7 +179,8 @@ class AddressController extends Controller /** * Mass Delete the customer's addresses * - * @return response + * @param int $id + * @return \Illuminate\Http\Response */ public function massDestroy($id) { diff --git a/packages/Webkul/Admin/src/Http/Controllers/Customer/CustomerController.php b/packages/Webkul/Admin/src/Http/Controllers/Customer/CustomerController.php index 1cdb15d41..f127937c1 100755 --- a/packages/Webkul/Admin/src/Http/Controllers/Customer/CustomerController.php +++ b/packages/Webkul/Admin/src/Http/Controllers/Customer/CustomerController.php @@ -137,7 +137,6 @@ class CustomerController extends Controller * Show the form for editing the specified resource. * * @param int $id - * * @return \Illuminate\View\View */ public function edit($id) @@ -155,7 +154,6 @@ class CustomerController extends Controller * Update the specified resource in storage. * * @param int $id - * * @return \Illuminate\Http\Response */ public function update($id) @@ -183,7 +181,6 @@ class CustomerController extends Controller * Remove the specified resource from storage. * * @param int $id - * * @return \Illuminate\Http\Response */ public function destroy($id) @@ -206,6 +203,7 @@ class CustomerController extends Controller /** * To load the note taking screen for the customers * + * @param int $id * @return \Illuminate\View\View */ public function createNote($id) @@ -218,7 +216,7 @@ class CustomerController extends Controller /** * To store the response of the note in storage * - * @return redirect + * @return \Illuminate\Http\Response */ public function storeNote() { @@ -242,7 +240,7 @@ class CustomerController extends Controller /** * To mass update the customer * - * @return redirect + * @return \Illuminate\Http\Response */ public function massUpdate() { @@ -263,7 +261,7 @@ class CustomerController extends Controller /** * To mass delete the customer * - * @return redirect + * @return \Illuminate\Http\Response */ public function massDestroy() { diff --git a/packages/Webkul/Admin/src/Http/Controllers/DashboardController.php b/packages/Webkul/Admin/src/Http/Controllers/DashboardController.php index f95d442d2..3d1a7d050 100755 --- a/packages/Webkul/Admin/src/Http/Controllers/DashboardController.php +++ b/packages/Webkul/Admin/src/Http/Controllers/DashboardController.php @@ -83,10 +83,10 @@ class DashboardController extends Controller /** * Create a new controller instance. * - * @param \Webkul\Sales\Repositories\OrderRepository $orderRepository - * @param \Webkul\Sales\Repositories\OrderItemRepository $orderItemRepository - * @param \Webkul\Customer\Repositories\CustomerRepository $customerRepository - * @param \Webkul\Product\Repositories\ProductInventoryRepository $productInventoryRepository + * @param \Webkul\Sales\Repositories\OrderRepository $orderRepository + * @param \Webkul\Sales\Repositories\OrderItemRepository $orderItemRepository + * @param \Webkul\Customer\Repositories\CustomerRepository $customerRepository + * @param \Webkul\Product\Repositories\ProductInventoryRepository $productInventoryRepository * @return void */ public function __construct( @@ -174,7 +174,7 @@ class DashboardController extends Controller /** * Returns the list of top selling categories * - * @return Collection + * @return \Illuminate\Support\Collection */ public function getTopSellingCategories() { @@ -199,7 +199,7 @@ class DashboardController extends Controller /** * Return stock threshold. * - * @return Collection + * @return \Illuminate\Support\Collection */ public function getStockThreshold() { @@ -215,7 +215,7 @@ class DashboardController extends Controller /** * Returns top selling products - * @return Collection + * @return \Illuminate\Support\Collection */ public function getTopSellingProducts() { @@ -234,7 +234,7 @@ class DashboardController extends Controller /** * Returns top selling products * - * @return Collection + * @return \Illuminate\Support\Collection */ public function getCustomerWithMostSales() { diff --git a/packages/Webkul/Admin/src/Http/Controllers/Sales/InvoiceController.php b/packages/Webkul/Admin/src/Http/Controllers/Sales/InvoiceController.php index 2512356fe..9ba68037e 100755 --- a/packages/Webkul/Admin/src/Http/Controllers/Sales/InvoiceController.php +++ b/packages/Webkul/Admin/src/Http/Controllers/Sales/InvoiceController.php @@ -70,7 +70,7 @@ class InvoiceController extends Controller /** * Show the form for creating a new resource. * - * @param int $orderId + * @param int $orderId * @return \Illuminate\View\View */ public function create($orderId) @@ -83,7 +83,7 @@ class InvoiceController extends Controller /** * Store a newly created resource in storage. * - * @param int $orderId + * @param int $orderId * @return \Illuminate\Http\Response */ public function store($orderId) diff --git a/packages/Webkul/Admin/src/Http/Controllers/Sales/OrderController.php b/packages/Webkul/Admin/src/Http/Controllers/Sales/OrderController.php index de438a152..835747a3e 100755 --- a/packages/Webkul/Admin/src/Http/Controllers/Sales/OrderController.php +++ b/packages/Webkul/Admin/src/Http/Controllers/Sales/OrderController.php @@ -30,7 +30,7 @@ class OrderController extends Controller /** * Create a new controller instance. * - * @param \Webkul\Sales\Repositories\OrderRepository $orderRepository + * @param \Webkul\Sales\Repositories\OrderRepository $orderRepository * @return void */ public function __construct(OrderRepository $orderRepository) diff --git a/packages/Webkul/Admin/src/Http/Controllers/Sales/RefundController.php b/packages/Webkul/Admin/src/Http/Controllers/Sales/RefundController.php index cf9d1b048..6a731b49c 100755 --- a/packages/Webkul/Admin/src/Http/Controllers/Sales/RefundController.php +++ b/packages/Webkul/Admin/src/Http/Controllers/Sales/RefundController.php @@ -46,9 +46,9 @@ class RefundController extends Controller /** * Create a new controller instance. * - * @param \Webkul\Sales\Repositories\OrderRepository $orderRepository - * @param \Webkul\Sales\Repositories\OrderItemRepository $orderItemRepository - * @param \Webkul\Sales\Repositories\RefundRepository $refundRepository + * @param \Webkul\Sales\Repositories\OrderRepository $orderRepository + * @param \Webkul\Sales\Repositories\OrderItemRepository $orderItemRepository + * @param \Webkul\Sales\Repositories\RefundRepository $refundRepository * @return void */ public function __construct( @@ -81,7 +81,7 @@ class RefundController extends Controller /** * Show the form for creating a new resource. * - * @param int $orderId + * @param int $orderId * @return \Illuminate\Http\View */ public function create($orderId) @@ -94,7 +94,7 @@ class RefundController extends Controller /** * Store a newly created resource in storage. * - * @param int $orderId + * @param int $orderId * @return \Illuminate\Http\Response */ public function store($orderId) @@ -141,7 +141,7 @@ class RefundController extends Controller /** * Store a newly created resource in storage. * - * @param int $orderId + * @param int $orderId * @return \Illuminate\Http\JsonResponse */ public function updateQty($orderId) @@ -158,7 +158,7 @@ class RefundController extends Controller /** * Show the view for the specified resource. * - * @param int $id + * @param int $id * @return \Illuminate\Http\View */ public function view($id) diff --git a/packages/Webkul/Admin/src/Http/Controllers/Sales/ShipmentController.php b/packages/Webkul/Admin/src/Http/Controllers/Sales/ShipmentController.php index 53b13fbca..eab184b82 100755 --- a/packages/Webkul/Admin/src/Http/Controllers/Sales/ShipmentController.php +++ b/packages/Webkul/Admin/src/Http/Controllers/Sales/ShipmentController.php @@ -46,9 +46,9 @@ class ShipmentController extends Controller /** * Create a new controller instance. * - * @param \Webkul\Sales\Repositories\ShipmentRepository $shipmentRepository - * @param \Webkul\Sales\Repositories\OrderRepository $orderRepository - * @param \Webkul\Sales\Repositories\OrderitemRepository $orderItemRepository + * @param \Webkul\Sales\Repositories\ShipmentRepository $shipmentRepository + * @param \Webkul\Sales\Repositories\OrderRepository $orderRepository + * @param \Webkul\Sales\Repositories\OrderitemRepository $orderItemRepository * @return void */ public function __construct( @@ -81,7 +81,7 @@ class ShipmentController extends Controller /** * Show the form for creating a new resource. * - * @param int $orderId + * @param int $orderId * @return \Illuminate\View\View */ public function create($orderId) @@ -100,7 +100,7 @@ class ShipmentController extends Controller /** * Store a newly created resource in storage. * - * @param int $orderId + * @param int $orderId * @return \Illuminate\Http\Response */ public function store($orderId) @@ -138,7 +138,7 @@ class ShipmentController extends Controller /** * Checks if requested quantity available or not * - * @param array $data + * @param array $data * @return boolean */ public function isInventoryValidate(&$data) diff --git a/packages/Webkul/Admin/src/Listeners/Order.php b/packages/Webkul/Admin/src/Listeners/Order.php index c6b7e7947..ae15cce7d 100755 --- a/packages/Webkul/Admin/src/Listeners/Order.php +++ b/packages/Webkul/Admin/src/Listeners/Order.php @@ -21,9 +21,10 @@ class Order { /** - * @param mixed $order - * * Send new order Mail to the customer and admin + * + * @param \Webkul\Sales\Contracts\Order $order + * @return void */ public function sendNewOrderMail($order) { @@ -43,9 +44,10 @@ class Order } /** - * @param mixed $invoice - * * Send new invoice mail to the customer + * + * @param \Webkul\Sales\Contracts\Invoice $invoice + * @return void */ public function sendNewInvoiceMail($invoice) { @@ -64,9 +66,10 @@ class Order } /** - * @param mixed $refund - * * Send new refund mail to the customer + * + * @param \Webkul\Sales\Contracts\Refund $refund + * @return void */ public function sendNewRefundMail($refund) { @@ -81,9 +84,10 @@ class Order } /** - * @param mixed $shipment - * * Send new shipment mail to the customer + * + * @param \Webkul\Sales\Contracts\Shipment $refund + * @return void */ public function sendNewShipmentMail($shipment) { @@ -107,8 +111,8 @@ class Order } /** - * @param mixed $order - * + * @param \Webkul\Sales\Contracts\Order $order + * @return void */ public function sendCancelOrderMail($order) { diff --git a/packages/Webkul/Admin/src/Mail/CancelOrderNotification.php b/packages/Webkul/Admin/src/Mail/CancelOrderNotification.php index 5b20bc946..1a75b86bc 100644 --- a/packages/Webkul/Admin/src/Mail/CancelOrderNotification.php +++ b/packages/Webkul/Admin/src/Mail/CancelOrderNotification.php @@ -12,11 +12,15 @@ class CancelOrderNotification extends Mailable use Queueable, SerializesModels; /** - * @var Order + * @var \Webkul\Sales\Contracts\Order * */ public $order; + /** + * @param \Webkul\Sales\Contracts\Order $order + * @return void + */ public function __construct($order) { $this->order = $order; diff --git a/packages/Webkul/Admin/src/Mail/NewAdminNotification.php b/packages/Webkul/Admin/src/Mail/NewAdminNotification.php index b64e058b5..c3cdbccdf 100644 --- a/packages/Webkul/Admin/src/Mail/NewAdminNotification.php +++ b/packages/Webkul/Admin/src/Mail/NewAdminNotification.php @@ -20,13 +20,14 @@ class NewAdminNotification extends Mailable /** * The order instance. * - * @var Order + * @var \Webkul\Sales\Contracts\Order */ public $order; /** * Create a new message instance. - * + * + * @param \Webkul\Sales\Contracts\Order $order * @return void */ public function __construct($order) diff --git a/packages/Webkul/Admin/src/Mail/NewCustomerNotification.php b/packages/Webkul/Admin/src/Mail/NewCustomerNotification.php index 8615c144f..31724e651 100644 --- a/packages/Webkul/Admin/src/Mail/NewCustomerNotification.php +++ b/packages/Webkul/Admin/src/Mail/NewCustomerNotification.php @@ -20,23 +20,28 @@ class NewCustomerNotification extends Mailable /** * The customer instance. * - * @var customer + * @var \Webkul\Customer\Contracts\Customer */ public $customer; /** * The password instance. * - * @var password + * @var string */ public $password; /** * Create a new message instance. - * + * + * @param \Webkul\Customer\Contracts\Customer $order + * @param string $password * @return void */ - public function __construct($customer, $password) + public function __construct( + $customer, + $password + ) { $this->customer = $customer; diff --git a/packages/Webkul/Admin/src/Mail/NewInventorySourceNotification.php b/packages/Webkul/Admin/src/Mail/NewInventorySourceNotification.php index c2fe37427..da1d80b8b 100644 --- a/packages/Webkul/Admin/src/Mail/NewInventorySourceNotification.php +++ b/packages/Webkul/Admin/src/Mail/NewInventorySourceNotification.php @@ -20,14 +20,14 @@ class NewInventorySourceNotification extends Mailable /** * The shipment instance. * - * @var Shipment + * @var \Webkul\Customer\Contracts\Shipment */ public $shipment; /** * Create a new message instance. * - * @param mixed $shipment + * @param \Webkul\Customer\Contracts\Shipment $shipment * @return void */ public function __construct($shipment) diff --git a/packages/Webkul/Admin/src/Mail/NewInvoiceNotification.php b/packages/Webkul/Admin/src/Mail/NewInvoiceNotification.php index f8d0af641..d68e46ba0 100755 --- a/packages/Webkul/Admin/src/Mail/NewInvoiceNotification.php +++ b/packages/Webkul/Admin/src/Mail/NewInvoiceNotification.php @@ -20,14 +20,14 @@ class NewInvoiceNotification extends Mailable /** * The invoice instance. * - * @var Invoice + * @param \Webkul\Customer\Contracts\Invoice $invoice */ public $invoice; /** * Create a new message instance. * - * @param mixed $invoice + * @param \Webkul\Customer\Contracts\Invoice $invoice * @return void */ public function __construct($invoice) diff --git a/packages/Webkul/Admin/src/Mail/NewOrderNotification.php b/packages/Webkul/Admin/src/Mail/NewOrderNotification.php index 77ca3bd58..dc98622a9 100755 --- a/packages/Webkul/Admin/src/Mail/NewOrderNotification.php +++ b/packages/Webkul/Admin/src/Mail/NewOrderNotification.php @@ -20,13 +20,14 @@ class NewOrderNotification extends Mailable /** * The order instance. * - * @var Order + * @var \Webkul\Sales\Contracts\Order $order */ public $order; /** * Create a new message instance. * + * @param \Webkul\Sales\Contracts\Order $order * @return void */ public function __construct($order) diff --git a/packages/Webkul/Admin/src/Mail/NewRefundNotification.php b/packages/Webkul/Admin/src/Mail/NewRefundNotification.php index e4fda215d..b18882aab 100644 --- a/packages/Webkul/Admin/src/Mail/NewRefundNotification.php +++ b/packages/Webkul/Admin/src/Mail/NewRefundNotification.php @@ -20,14 +20,14 @@ class NewRefundNotification extends Mailable /** * The refund instance. * - * @var Refund + * @var \Webkul\Sales\Contracts\Refund */ public $refund; /** * Create a new message instance. * - * @param mixed $refund + * @param \Webkul\Sales\Contracts\Refund $refund * @return void */ public function __construct($refund) diff --git a/packages/Webkul/Admin/src/Mail/NewShipmentNotification.php b/packages/Webkul/Admin/src/Mail/NewShipmentNotification.php index c8287c0ef..16c1ea2ff 100755 --- a/packages/Webkul/Admin/src/Mail/NewShipmentNotification.php +++ b/packages/Webkul/Admin/src/Mail/NewShipmentNotification.php @@ -20,14 +20,14 @@ class NewShipmentNotification extends Mailable /** * The shipment instance. * - * @var Shipment + * @var \Webkul\Sales\Contracts\Shipment */ public $shipment; /** * Create a new message instance. * - * @param mixed $shipment + * @param \Webkul\Sales\Contracts\Shipment $shipment * @return void */ public function __construct($shipment) diff --git a/packages/Webkul/Attribute/src/Http/Controllers/AttributeController.php b/packages/Webkul/Attribute/src/Http/Controllers/AttributeController.php index b56a2c13b..80976f61a 100755 --- a/packages/Webkul/Attribute/src/Http/Controllers/AttributeController.php +++ b/packages/Webkul/Attribute/src/Http/Controllers/AttributeController.php @@ -23,14 +23,14 @@ class AttributeController extends Controller /** * AttributeRepository object * - * @var array + * @var \Webkul\Attribute\Repositories\AttributeRepository */ protected $attributeRepository; /** * Create a new controller instance. * - * @param \Webkul\Attribute\Repositories\AttributeRepository $attributeRepository + * @param \Webkul\Attribute\Repositories\AttributeRepository $attributeRepository * @return void */ public function __construct(AttributeRepository $attributeRepository) @@ -148,7 +148,7 @@ class AttributeController extends Controller /** * Remove the specified resources from database * - * @return response \Illuminate\Http\Response + * @return \Illuminate\Http\Response */ public function massDestroy() { diff --git a/packages/Webkul/Attribute/src/Http/Controllers/AttributeFamilyController.php b/packages/Webkul/Attribute/src/Http/Controllers/AttributeFamilyController.php index 205e605a8..7f433da61 100755 --- a/packages/Webkul/Attribute/src/Http/Controllers/AttributeFamilyController.php +++ b/packages/Webkul/Attribute/src/Http/Controllers/AttributeFamilyController.php @@ -23,22 +23,22 @@ class AttributeFamilyController extends Controller /** * AttributeFamilyRepository object * - * @var Object + * @var \Webkul\Attribute\Repositories\AttributeFamilyRepository */ protected $attributeFamilyRepository; /** * AttributeRepository object * - * @var Object + * @var \Webkul\Attribute\Repositories\AttributeRepository */ protected $attributeRepository; /** * Create a new controller instance. * - * @param \Webkul\Attribute\Repositories\AttributeFamilyRepository $attributeFamilyRepository - * @param \Webkul\Attribute\Repositories\AttributeRepository $attributeRepository + * @param \Webkul\Attribute\Repositories\AttributeFamilyRepository $attributeFamilyRepository + * @param \Webkul\Attribute\Repositories\AttributeRepository $attributeRepository * @return void */ public function __construct( @@ -165,7 +165,7 @@ class AttributeFamilyController extends Controller /** * Remove the specified resources from database * - * @return response \Illuminate\Http\Response + * @return \Illuminate\Http\Response */ public function massDestroy() { diff --git a/packages/Webkul/Attribute/src/Repositories/AttributeFamilyRepository.php b/packages/Webkul/Attribute/src/Repositories/AttributeFamilyRepository.php index f35468c60..9459ecaa3 100755 --- a/packages/Webkul/Attribute/src/Repositories/AttributeFamilyRepository.php +++ b/packages/Webkul/Attribute/src/Repositories/AttributeFamilyRepository.php @@ -20,22 +20,22 @@ class AttributeFamilyRepository extends Repository /** * AttributeRepository object * - * @var Object + * @var \Webkul\Attribute\Repositories\AttributeRepository */ protected $attributeRepository; /** * AttributeGroupRepository object * - * @var Object + * @var \Webkul\Attribute\Repositories\AttributeGroupRepository */ protected $attributeGroupRepository; /** * Create a new controller instance. * - * @param Webkul\Attribute\Repositories\AttributeRepository $attributeRepository - * @param Webkul\Attribute\Repositories\AttributeGroupRepository $attributeGroupRepository + * @param \Webkul\Attribute\Repositories\AttributeRepository $attributeRepository + * @param \Webkul\Attribute\Repositories\AttributeGroupRepository $attributeGroupRepository * @return void */ public function __construct( @@ -62,8 +62,8 @@ class AttributeFamilyRepository extends Repository } /** - * @param array $data - * @return mixed + * @param array $data + * @return \Webkul\Attribute\Contracts\AttributeFamily */ public function create(array $data) { @@ -99,10 +99,10 @@ class AttributeFamilyRepository extends Repository } /** - * @param array $data - * @param $id - * @param string $attribute - * @return mixed + * @param array $data + * @param int $id + * @param string $attribute + * @return \Webkul\Attribute\Contracts\AttributeFamily */ public function update(array $data, $id, $attribute = "id") { @@ -165,6 +165,10 @@ class AttributeFamilyRepository extends Repository return $family; } + + /** + * @return array + */ public function getPartial() { $attributeFamilies = $this->model->all(); @@ -185,7 +189,7 @@ class AttributeFamilyRepository extends Repository } /** - * @param $id + * @param int $id * @return void */ public function delete($id) diff --git a/packages/Webkul/Attribute/src/Repositories/AttributeOptionRepository.php b/packages/Webkul/Attribute/src/Repositories/AttributeOptionRepository.php index aadffee0d..ccff4be01 100755 --- a/packages/Webkul/Attribute/src/Repositories/AttributeOptionRepository.php +++ b/packages/Webkul/Attribute/src/Repositories/AttributeOptionRepository.php @@ -24,8 +24,8 @@ class AttributeOptionRepository extends Repository } /** - * @param array $data - * @return mixed + * @param array $data + * @return \Webkul\Attribute\Contracts\AttributeOption */ public function create(array $data) { @@ -37,10 +37,10 @@ class AttributeOptionRepository extends Repository } /** - * @param array $data - * @param $id - * @param string $attribute - * @return mixed + * @param array $data + * @param int $id + * @param string $attribute + * @return \Webkul\Attribute\Contracts\AttributeOption */ public function update(array $data, $id, $attribute = "id") { @@ -52,9 +52,9 @@ class AttributeOptionRepository extends Repository } /** - * @param array $data - * @param mixed $optionId - * @return mixed + * @param array $data + * @param int $optionId + * @return void */ public function uploadSwatchImage($data, $optionId) { diff --git a/packages/Webkul/Attribute/src/Repositories/AttributeRepository.php b/packages/Webkul/Attribute/src/Repositories/AttributeRepository.php index be7da949f..6b615307a 100755 --- a/packages/Webkul/Attribute/src/Repositories/AttributeRepository.php +++ b/packages/Webkul/Attribute/src/Repositories/AttributeRepository.php @@ -19,14 +19,14 @@ class AttributeRepository extends Repository /** * AttributeOptionRepository object * - * @var Object + * @var \Webkul\Attribute\Repositories\AttributeOptionRepository */ protected $attributeOptionRepository; /** * Create a new repository instance. * - * @param Webkul\Attribute\Repositories\AttributeOptionRepository $attributeOptionRepository + * @param \Webkul\Attribute\Repositories\AttributeOptionRepository $attributeOptionRepository * @return void */ public function __construct( @@ -50,8 +50,8 @@ class AttributeRepository extends Repository } /** - * @param array $data - * @return mixed + * @param array $data + * @return \Webkul\Attribute\Contracts\Attribute */ public function create(array $data) { @@ -79,10 +79,10 @@ class AttributeRepository extends Repository } /** - * @param array $data - * @param $id - * @param string $attribute - * @return mixed + * @param array $data + * @param int $id + * @param string $attribute + * @return \Webkul\Attribute\Contracts\Attribute */ public function update(array $data, $id, $attribute = "id") { @@ -124,7 +124,7 @@ class AttributeRepository extends Repository } /** - * @param $id + * @param int $id * @return void */ public function delete($id) @@ -137,7 +137,7 @@ class AttributeRepository extends Repository } /** - * @param array $data + * @param array $data * @return array */ public function validateUserInput($data) @@ -166,6 +166,8 @@ class AttributeRepository extends Repository } /** + * + * @param array $codes * @return array */ public function getProductDefaultAttributes($codes = null) @@ -193,7 +195,8 @@ class AttributeRepository extends Repository } /** - * @return Object + * @param string $code + * @return \Webkul\Attribute\Contracts\Attribute */ public function getAttributeByCode($code) { @@ -207,7 +210,8 @@ class AttributeRepository extends Repository } /** - * @return Object + * @param \Webkul\Attribute\Contracts\AttributeFamily $attributeFamily + * @return \Webkul\Attribute\Contracts\Attribute */ public function getFamilyAttributes($attributeFamily) { @@ -221,12 +225,13 @@ class AttributeRepository extends Repository } /** - * @return Object + * @return array */ public function getPartial() { $attributes = $this->model->all(); - $trimmed = array(); + + $trimmed = []; foreach($attributes as $key => $attribute) { if ($attribute->code != 'tax_category_id' diff --git a/packages/Webkul/BookingProduct/src/Helpers/AppointmentSlot.php b/packages/Webkul/BookingProduct/src/Helpers/AppointmentSlot.php index 94f17433e..f23c86a69 100644 --- a/packages/Webkul/BookingProduct/src/Helpers/AppointmentSlot.php +++ b/packages/Webkul/BookingProduct/src/Helpers/AppointmentSlot.php @@ -11,8 +11,8 @@ namespace Webkul\BookingProduct\Helpers; class AppointmentSlot extends Booking { /** - * @param integer $qty - * @param BookingProduct $bookingProduct + * @param int $qty + * @param \Webkul\BookingProduct\Contracts\BookingProduct $bookingProduct * @return bool */ public function haveSufficientQuantity($qty, $bookingProduct) diff --git a/packages/Webkul/BookingProduct/src/Helpers/Booking.php b/packages/Webkul/BookingProduct/src/Helpers/Booking.php index 318921646..80439fd3f 100644 --- a/packages/Webkul/BookingProduct/src/Helpers/Booking.php +++ b/packages/Webkul/BookingProduct/src/Helpers/Booking.php @@ -23,7 +23,7 @@ class Booking /** * BookingProductRepository * - * @return object + * @return \Webkul\BookingProduct\Repositories\BookingProductRepository */ protected $bookingProductRepository; @@ -35,7 +35,7 @@ class Booking /** * BookingRepository * - * @return object + * @return \Webkul\BookingProduct\Repositories\BookingRepository */ protected $bookingRepository; @@ -58,13 +58,13 @@ class Booking /** * Create a new helper instance. * - * @param Webkul\BookingProduct\Repositories\BookingProductRepository $bookingProductRepository - * @param Webkul\BookingProduct\Repositories\BookingProductDefaultSlotRepository $bookingProductDefaultSlotRepository - * @param Webkul\BookingProduct\Repositories\BookingProductAppointmentSlotRepository $bookingProductAppointmentSlotRepository - * @param Webkul\BookingProduct\Repositories\BookingProductEventTicketRepository $bookingProductEventTicketRepository - * @param Webkul\BookingProduct\Repositories\BookingProductRentalSlotRepository $bookingProductRentalSlotRepository - * @param Webkul\BookingProduct\Repositories\BookingProductTableSlotRepository $bookingProductTableSlotRepository - * @param Webkul\BookingProduct\Repositories\BookingRepository $bookingRepository + * @param \Webkul\BookingProduct\Repositories\BookingProductRepository $bookingProductRepository + * @param \Webkul\BookingProduct\Repositories\BookingProductDefaultSlotRepository $bookingProductDefaultSlotRepository + * @param \Webkul\BookingProduct\Repositories\BookingProductAppointmentSlotRepository $bookingProductAppointmentSlotRepository + * @param \Webkul\BookingProduct\Repositories\BookingProductEventTicketRepository $bookingProductEventTicketRepository + * @param \Webkul\BookingProduct\Repositories\BookingProductRentalSlotRepository $bookingProductRentalSlotRepository + * @param \Webkul\BookingProduct\Repositories\BookingProductTableSlotRepository $bookingProductTableSlotRepository + * @param \Webkul\BookingProduct\Repositories\BookingRepository $bookingRepository * @return void */ public function __construct( @@ -95,7 +95,7 @@ class Booking /** * Returns the booking type hepler instance * - * @param string $type + * @param string $type * @return array */ public function getTypeHepler($type) @@ -106,7 +106,7 @@ class Booking /** * Returns the booking information * - * @param BookingProduct $bookingProduct + * @param \Webkul\BookingProduct\Contracts\BookingProduct $bookingProduct * @return array */ public function getWeekSlotDurations($bookingProduct) @@ -136,7 +136,7 @@ class Booking /** * Returns html of slots for a current day * - * @param BookingProduct $bookingProduct + * @param \Webkul\BookingProduct\Contracts\BookingProduct $bookingProduct * @return string */ public function getTodaySlotsHtml($bookingProduct) @@ -155,7 +155,7 @@ class Booking /** * Returns slots for a current day * - * @param BookingProduct $bookingProduct + * @param \Webkul\BookingProduct\Contracts\BookingProduct $bookingProduct * @return array */ public function getTodaySlots($bookingProduct) @@ -168,7 +168,7 @@ class Booking /** * Returns the available week days * - * @param Object $bookingProduct + * @param \Webkul\BookingProduct\Contracts\BookingProduct $bookingProduct * @return array */ public function getAvailableWeekDays($bookingProduct) @@ -204,7 +204,7 @@ class Booking /** * Sort days * - * @param array $days + * @param array $days * @return array */ public function sortDaysOfWeek($days) @@ -227,7 +227,7 @@ class Booking /** * Convert time from 24 to 12 hour format * - * @param array $slots + * @param array $slots * @return array */ public function conver24To12Hours($slots) @@ -247,8 +247,8 @@ class Booking /** * Returns slots for a perticular day * - * @param BookingProduct $bookingProduct - * @param string $date + * @param \Webkul\BookingProduct\Contracts\BookingProduct $bookingProduct + * @param string $date * @return array */ public function getSlotsByDate($bookingProduct, $date) @@ -331,7 +331,7 @@ class Booking } /** - * @param CartItem|array $cartItem + * @param \Webkul\Ceckout\Contracts\CartItem|array $cartItem * @return bool */ public function isItemHaveQuantity($cartItem) @@ -346,7 +346,7 @@ class Booking } /** - * @param array $cartProducts + * @param array $cartProducts * @return bool */ public function isSlotAvailable($cartProducts) @@ -361,8 +361,8 @@ class Booking } /** - * @param array $data - * @return integer + * @param array $data + * @return int */ public function getBookedQuantity($data) { @@ -382,7 +382,7 @@ class Booking /** * Returns additional cart item information * - * @param array $data + * @param array $data * @return array */ public function getCartItemOptions($data) @@ -495,7 +495,7 @@ class Booking /** * Add booking additional prices to cart item * - * @param array $products + * @param array $products * @return array */ public function addAdditionalPrices($products) @@ -506,7 +506,7 @@ class Booking /** * Validate cart item product price * - * @param CartItem $item + * @param \Webkul\Checkout\Contracts\CartItem $item * @return float */ public function validateCartItem($item) diff --git a/packages/Webkul/BookingProduct/src/Helpers/DefaultSlot.php b/packages/Webkul/BookingProduct/src/Helpers/DefaultSlot.php index 595605238..298c201d2 100644 --- a/packages/Webkul/BookingProduct/src/Helpers/DefaultSlot.php +++ b/packages/Webkul/BookingProduct/src/Helpers/DefaultSlot.php @@ -20,8 +20,8 @@ class DefaultSlot extends Booking /** * Returns slots for a perticular day * - * @param BookingProduct $bookingProduct - * @param string $date + * @param \Webkul\BookingProduct\Contracts\BookingProduct $bookingProduct + * @param string $date * @return array */ public function getSlotsByDate($bookingProduct, $date) @@ -61,8 +61,8 @@ class DefaultSlot extends Booking /** * Returns slots for One Booking For Many Days * - * @param BookingProductSlot $bookingProductSlot - * @param string $requestedDate + * @param \Webkul\BookingProduct\Contracts\BookingProduct $bookingProduct + * @param string $requestedDate * @return array */ public function getOneBookingForManyDaysSlots($bookingProductSlot, $requestedDate) @@ -91,8 +91,8 @@ class DefaultSlot extends Booking /** * Returns slots for Many Bookings for One Day * - * @param BookingProductSlot $bookingProductSlot - * @param string $requestedDate + * @param \Webkul\BookingProduct\Contracts\BookingProductSlot $bookingProductSlot + * @param string $requestedDate * @return array */ public function getManyBookingsforOneDaySlots($bookingProductSlot, $requestedDate) diff --git a/packages/Webkul/BookingProduct/src/Helpers/EventTicket.php b/packages/Webkul/BookingProduct/src/Helpers/EventTicket.php index 3b2c3cd1a..2729a930b 100644 --- a/packages/Webkul/BookingProduct/src/Helpers/EventTicket.php +++ b/packages/Webkul/BookingProduct/src/Helpers/EventTicket.php @@ -16,7 +16,7 @@ class EventTicket extends Booking /** * Returns event date * - * @param BookingProduct $bookingProduct + * @param \Webkul\BookingProduct\Contracts\BookingProduct $bookingProduct * @return string */ public function getEventDate($bookingProduct) @@ -31,7 +31,7 @@ class EventTicket extends Booking /** * Returns tickets * - * @param BookingProduct $bookingProduct + * @param \Webkul\BookingProduct\Contracts\BookingProduct $bookingProduct * @return array */ public function getTickets($bookingProduct) @@ -46,7 +46,7 @@ class EventTicket extends Booking /** * Format ticket price * - * @param array $tickets + * @param array $tickets * @return array */ public function formatPrice($tickets) @@ -62,7 +62,7 @@ class EventTicket extends Booking } /** - * @param CartItem|array $cartItem + * @param \Webkul\Checkout\Contracts\CartItem|array $cartItem * @return bool */ public function isItemHaveQuantity($cartItem) @@ -79,8 +79,8 @@ class EventTicket extends Booking } /** - * @param array $data - * @return integer + * @param array $data + * @return int */ public function getBookedQuantity($data) { @@ -97,7 +97,7 @@ class EventTicket extends Booking /** * Add booking additional prices to cart item * - * @param array $products + * @param array $products * @return array */ public function addAdditionalPrices($products) @@ -119,7 +119,7 @@ class EventTicket extends Booking /** * Validate cart item product price * - * @param CartItem $item + * @param \Webkul\Checkout\Contracts\CartItem $item * @return float */ public function validateCartItem($item) diff --git a/packages/Webkul/BookingProduct/src/Helpers/RentalSlot.php b/packages/Webkul/BookingProduct/src/Helpers/RentalSlot.php index c9e11af40..8d1c811e9 100644 --- a/packages/Webkul/BookingProduct/src/Helpers/RentalSlot.php +++ b/packages/Webkul/BookingProduct/src/Helpers/RentalSlot.php @@ -16,8 +16,8 @@ class RentalSlot extends Booking /** * Returns slots for a perticular day * - * @param BookingProduct $bookingProduct - * @param string $date + * @param \Webkul\BookingProduct\Contracts\BookingProduct $bookingProduct + * @param string $date * @return array */ public function getSlotsByDate($bookingProduct, $date) @@ -96,8 +96,8 @@ class RentalSlot extends Booking } /** - * @param array $data - * @return integer + * @param array $data + * @return int */ public function getBookedQuantity($data) { @@ -135,7 +135,7 @@ class RentalSlot extends Booking /** * Add booking additional prices to cart item * - * @param array $products + * @param array $products * @return array */ public function addAdditionalPrices($products) @@ -167,7 +167,7 @@ class RentalSlot extends Booking /** * Validate cart item product price * - * @param CartItem $item + * @param \Webkul\Checkout\Contracts\CartItem $item * @return float */ public function validateCartItem($item) diff --git a/packages/Webkul/BookingProduct/src/Helpers/TableSlot.php b/packages/Webkul/BookingProduct/src/Helpers/TableSlot.php index 9b7674203..0d6cc7a30 100644 --- a/packages/Webkul/BookingProduct/src/Helpers/TableSlot.php +++ b/packages/Webkul/BookingProduct/src/Helpers/TableSlot.php @@ -11,7 +11,7 @@ namespace Webkul\BookingProduct\Helpers; class TableSlot extends Booking { /** - * @param CartItem|array $cartItem + * @param \Webkul\Checkout\Contracts\CartItem|array $cartItem * @return bool */ public function isItemHaveQuantity($cartItem) diff --git a/packages/Webkul/BookingProduct/src/Http/Controllers/Shop/BookingProductController.php b/packages/Webkul/BookingProduct/src/Http/Controllers/Shop/BookingProductController.php index 6b1a0a23f..8ce8cb2eb 100644 --- a/packages/Webkul/BookingProduct/src/Http/Controllers/Shop/BookingProductController.php +++ b/packages/Webkul/BookingProduct/src/Http/Controllers/Shop/BookingProductController.php @@ -17,13 +17,6 @@ use Webkul\BookingProduct\Helpers\TableSlot as TableSlotHelper; */ class BookingProductController extends Controller { - /** - * Booking object - * - * @var Object - */ - protected $bookingHelper; - /** * @return array */ @@ -32,12 +25,12 @@ class BookingProductController extends Controller /** * Create a new helper instance. * - * @param Webkul\BookingProduct\Repositories\BookingProductRepository $bookingProductRepository - * @param Webkul\BookingProduct\Helpers\DefaultSlot $defaultSlotHelper - * @param Webkul\BookingProduct\Helpers\AppointmentSlot $appointmentSlotHelper - * @param Webkul\BookingProduct\Helpers\RentalSlot $rentalSlotHelper - * @param Webkul\BookingProduct\Helpers\EventTicket $EventTicketHelper - * @param Webkul\BookingProduct\Helpers\TableSlot $tableSlotHelper + * @param \Webkul\BookingProduct\Repositories\BookingProductRepository $bookingProductRepository + * @param \Webkul\BookingProduct\Helpers\DefaultSlot $defaultSlotHelper + * @param \Webkul\BookingProduct\Helpers\AppointmentSlot $appointmentSlotHelper + * @param \Webkul\BookingProduct\Helpers\RentalSlot $rentalSlotHelper + * @param \Webkul\BookingProduct\Helpers\EventTicket $EventTicketHelper + * @param \Webkul\BookingProduct\Helpers\TableSlot $tableSlotHelper * @return void */ public function __construct( diff --git a/packages/Webkul/BookingProduct/src/Listeners/Order.php b/packages/Webkul/BookingProduct/src/Listeners/Order.php index c70bec3bc..7e62cecec 100644 --- a/packages/Webkul/BookingProduct/src/Listeners/Order.php +++ b/packages/Webkul/BookingProduct/src/Listeners/Order.php @@ -15,14 +15,14 @@ class Order /** * BookingRepository Object * - * @var Object + * @var \Webkul\BookingProduct\Repositories\BookingRepository */ protected $bookingRepository; /** * Create a new listener instance. * - * @param Webkul\Booking\Repositories\BookingRepository $bookingRepository + * @param \Webkul\Booking\Repositories\BookingRepository $bookingRepository * @return void */ public function __construct(BookingRepository $bookingRepository) @@ -33,7 +33,7 @@ class Order /** * After sales order creation, add entry to bookings table * - * @param mixed $order + * @param \Webkul\Sales\Contracts\Order $order */ public function afterPlaceOrder($order) { diff --git a/packages/Webkul/BookingProduct/src/Repositories/BookingProductEventTicketRepository.php b/packages/Webkul/BookingProduct/src/Repositories/BookingProductEventTicketRepository.php index 0c7f612b7..48477f53e 100644 --- a/packages/Webkul/BookingProduct/src/Repositories/BookingProductEventTicketRepository.php +++ b/packages/Webkul/BookingProduct/src/Repositories/BookingProductEventTicketRepository.php @@ -24,8 +24,8 @@ class BookingProductEventTicketRepository extends Repository } /** - * @param array $data - * @param BookingProduct $bookingProduct + * @param array $data + * @param \Webkul\BookingProduct\Contracts\BookingProduct $bookingProduct * @return void */ public function saveEventTickets($data, $bookingProduct) diff --git a/packages/Webkul/BookingProduct/src/Repositories/BookingProductRepository.php b/packages/Webkul/BookingProduct/src/Repositories/BookingProductRepository.php index d51418e19..50fc0ec08 100644 --- a/packages/Webkul/BookingProduct/src/Repositories/BookingProductRepository.php +++ b/packages/Webkul/BookingProduct/src/Repositories/BookingProductRepository.php @@ -22,11 +22,11 @@ class BookingProductRepository extends Repository /** * Create a new repository instance. * - * @param Webkul\BookingProduct\Repositories\BookingProductDefaultSlotRepository $bookingProductDefaultSlotRepository - * @param Webkul\BookingProduct\Repositories\BookingProductAppointmentSlotRepository $bookingProductAppointmentSlotRepository - * @param Webkul\BookingProduct\Repositories\BookingProductEventTicketRepository $bookingProductEventTicketRepository - * @param Webkul\BookingProduct\Repositories\BookingProductRentalSlotRepository $bookingProductRentalSlotRepository - * @param Webkul\BookingProduct\Repositories\BookingProductTableSlotRepository $bookingProductTableSlotRepository + * @param \Webkul\BookingProduct\Repositories\BookingProductDefaultSlotRepository $bookingProductDefaultSlotRepository + * @param \Webkul\BookingProduct\Repositories\BookingProductAppointmentSlotRepository $bookingProductAppointmentSlotRepository + * @param \Webkul\BookingProduct\Repositories\BookingProductEventTicketRepository $bookingProductEventTicketRepository + * @param \Webkul\BookingProduct\Repositories\BookingProductRentalSlotRepository $bookingProductRentalSlotRepository + * @param \Webkul\BookingProduct\Repositories\BookingProductTableSlotRepository $bookingProductTableSlotRepository * @return void */ public function __construct( @@ -62,8 +62,8 @@ class BookingProductRepository extends Repository } /** - * @param array $data - * @return mixed + * @param array $data + * @return \Webkul\BookingProduct\Contracts\BookingProduct */ public function create(array $data) { @@ -79,10 +79,10 @@ class BookingProductRepository extends Repository } /** - * @param array $data - * @param integer $id - * @param string $attribute - * @return mixed + * @param array $data + * @param int $id + * @param string $attribute + * @return \Webkul\BookingProduct\Contracts\BookingProduct */ public function update(array $data, $id, $attribute = "id") { @@ -116,7 +116,7 @@ class BookingProductRepository extends Repository } /** - * @param array $data + * @param array $data * @return array */ public function formatSlots($data) @@ -147,7 +147,7 @@ class BookingProductRepository extends Repository } /** - * @param array $data + * @param array $data * @return array */ public function validateSlots($data) @@ -168,7 +168,7 @@ class BookingProductRepository extends Repository } /** - * @param array $data + * @param array $data * @return array */ public function skipOverLappingSlots($slots) diff --git a/packages/Webkul/BookingProduct/src/Repositories/BookingRepository.php b/packages/Webkul/BookingProduct/src/Repositories/BookingRepository.php index e6100e828..6b793aa37 100644 --- a/packages/Webkul/BookingProduct/src/Repositories/BookingRepository.php +++ b/packages/Webkul/BookingProduct/src/Repositories/BookingRepository.php @@ -26,8 +26,8 @@ class BookingRepository extends Repository } /** - * @param array $data - * @return mixed + * @param array $data + * @return \Webkul\BookingProduct\Contracts\Booking */ public function create(array $data) { diff --git a/packages/Webkul/BookingProduct/src/Type/Booking.php b/packages/Webkul/BookingProduct/src/Type/Booking.php index 73be09f6d..d8badeb72 100644 --- a/packages/Webkul/BookingProduct/src/Type/Booking.php +++ b/packages/Webkul/BookingProduct/src/Type/Booking.php @@ -23,14 +23,14 @@ class Booking extends Virtual /** * BookingProductRepository instance * - * @var BookingProductRepository + * @var \Webkul\BookingProduct\Repositories\BookingProductRepository */ protected $bookingProductRepository; /** * Booking helper instance * - * @var Booking + * @var \Webkul\BookingProduct\Helpers\Booking */ protected $bookingHelper; @@ -48,14 +48,14 @@ class Booking extends Virtual /** * Create a new product type instance. * - * @param Webkul\Attribute\Repositories\AttributeRepository $attributeRepository - * @param Webkul\Product\Repositories\ProductRepository $productRepository - * @param Webkul\Product\Repositories\ProductAttributeValueRepository $attributeValueRepository - * @param Webkul\Product\Repositories\ProductInventoryRepository $productInventoryRepository - * @param Webkul\Product\Repositories\ProductImageRepository $productImageRepository - * @param Webkul\Product\Helpers\ProductImage $productImageHelper - * @param Webkul\BookingProduct\Repositories\BookingProductRepository $bookingProductRepository - * @param Webkul\BookingProduct\Helpers\BookingHelper $bookingHelper + * @param \Webkul\Attribute\Repositories\AttributeRepository $attributeRepository + * @param \Webkul\Product\Repositories\ProductRepository $productRepository + * @param \Webkul\Product\Repositories\ProductAttributeValueRepository $attributeValueRepository + * @param \Webkul\Product\Repositories\ProductInventoryRepository $productInventoryRepository + * @param \Webkul\Product\Repositories\ProductImageRepository $productImageRepository + * @param \Webkul\Product\Helpers\ProductImage $productImageHelper + * @param \Webkul\BookingProduct\Repositories\BookingProductRepository $bookingProductRepository + * @param \Webkul\BookingProduct\Helpers\BookingHelper $bookingHelper * @return void */ public function __construct( @@ -84,10 +84,10 @@ class Booking extends Virtual } /** - * @param array $data - * @param $id - * @param string $attribute - * @return Product + * @param array $data + * @param int $id + * @param string $attribute + * @return \Webkul\Product\Contracts\Product */ public function update(array $data, $id, $attribute = "id") { @@ -111,6 +111,7 @@ class Booking extends Virtual /** * Returns additional views * + * @param int $id * @return array */ public function getBookingProduct($productId) @@ -127,7 +128,7 @@ class Booking extends Virtual /** * Return true if this product can have inventory * - * @return boolean + * @return bool */ public function showQuantityBox() { @@ -141,7 +142,7 @@ class Booking extends Virtual } /** - * @param CartItem $cartItem + * @param \Webkul\Checkout\Contracts\CartItem $cartItem * @return bool */ public function isItemHaveQuantity($cartItem) @@ -154,7 +155,7 @@ class Booking extends Virtual /** * Add product. Returns error message if can't prepare product. * - * @param array $data + * @param array $data * @return array */ public function prepareForCart($data) @@ -204,8 +205,8 @@ class Booking extends Virtual /** * - * @param array $options1 - * @param array $options2 + * @param array $options1 + * @param array $options2 * @return boolean */ public function compareOptions($options1, $options2) @@ -220,7 +221,7 @@ class Booking extends Virtual /** * Returns additional information for items * - * @param array $data + * @param array $data * @return array */ public function getAdditionalOptions($data) @@ -231,7 +232,7 @@ class Booking extends Virtual /** * Validate cart item product price * - * @param CartItem $item + * @param \Webkul\Checkout\Contracts\CartItem $item * @return float */ public function validateCartItem($item) diff --git a/packages/Webkul/CMS/src/Http/Controllers/Admin/PageController.php b/packages/Webkul/CMS/src/Http/Controllers/Admin/PageController.php index e93d89b65..a72d6b8ae 100644 --- a/packages/Webkul/CMS/src/Http/Controllers/Admin/PageController.php +++ b/packages/Webkul/CMS/src/Http/Controllers/Admin/PageController.php @@ -23,14 +23,14 @@ use Webkul\CMS\Repositories\CmsRepository; /** * To hold the CMSRepository instance * - * @var Object + * @var \Webkul\CMS\Repositories\CmsRepository */ protected $cmsRepository; /** * Create a new controller instance. * - * @param \Webkul\CMS\Repositories\CmsRepository $cmsRepository + * @param \Webkul\CMS\Repositories\CmsRepository $cmsRepository * @return void */ public function __construct(CmsRepository $cmsRepository) @@ -88,7 +88,7 @@ use Webkul\CMS\Repositories\CmsRepository; /** * To edit a previously created CMS page * - * @param integer $id + * @param int $id * @return \Illuminate\View\View */ public function edit($id) @@ -101,7 +101,7 @@ use Webkul\CMS\Repositories\CmsRepository; /** * To update the previously created CMS page in storage * - * @param integer $id + * @param int $id * @return \Illuminate\Http\Response */ public function update($id) @@ -129,8 +129,7 @@ use Webkul\CMS\Repositories\CmsRepository; /** * To delete the previously create CMS page * - * @param integer $id - * + * @param int $id * @return \Illuminate\Http\Response */ public function delete($id) diff --git a/packages/Webkul/CMS/src/Http/Controllers/Shop/PagePresenterController.php b/packages/Webkul/CMS/src/Http/Controllers/Shop/PagePresenterController.php index 01b7c89b9..b547b7b9e 100644 --- a/packages/Webkul/CMS/src/Http/Controllers/Shop/PagePresenterController.php +++ b/packages/Webkul/CMS/src/Http/Controllers/Shop/PagePresenterController.php @@ -16,14 +16,14 @@ class PagePresenterController extends Controller /** * CmsRepository object * - * @var Object + * @var \Webkul\CMS\Repositories\CmsRepository */ protected $cmsRepository; /** * Create a new controller instance. * - * @param \Webkul\CMS\Repositories\CmsRepository $cmsRepository + * @param \Webkul\CMS\Repositories\CmsRepository $cmsRepository * @return void */ public function __construct(CmsRepository $cmsRepository) @@ -34,7 +34,7 @@ class PagePresenterController extends Controller /** * To extract the page content and load it in the respective view file * - * @param string $urlKey + * @param string $urlKey * @return \Illuminate\View\View */ public function presenter($urlKey) diff --git a/packages/Webkul/CMS/src/Repositories/CmsRepository.php b/packages/Webkul/CMS/src/Repositories/CmsRepository.php index 898bd48bb..2c0b15e65 100644 --- a/packages/Webkul/CMS/src/Repositories/CmsRepository.php +++ b/packages/Webkul/CMS/src/Repositories/CmsRepository.php @@ -26,8 +26,8 @@ class CmsRepository extends Repository } /** - * @param array $data - * @return mixed + * @param array $data + * @return \Webkul\CMS\Contracts\CmsPage */ public function create(array $data) { @@ -53,10 +53,10 @@ class CmsRepository extends Repository } /** - * @param array $data - * @param integer $id - * @param string $attribute - * @return mixed + * @param array $data + * @param int $id + * @param string $attribute + * @return \Webkul\CMS\Contracts\CmsPage */ public function update(array $data, $id, $attribute = "id") { @@ -76,9 +76,9 @@ class CmsRepository extends Repository /** * Checks slug is unique or not based on locale * - * @param integer $id - * @param string $urlKey - * @return boolean + * @param int $id + * @param string $urlKey + * @return bool */ public function isUrlKeyUnique($id, $urlKey) { @@ -94,8 +94,8 @@ class CmsRepository extends Repository /** * Retrive category from slug * - * @param string $urlKey - * @return mixed + * @param string $urlKey + * @return \Webkul\CMS\Contracts\CmsPage|\Exception */ public function findByUrlKeyOrFail($urlKey) { diff --git a/packages/Webkul/CartRule/src/Helpers/CartRule.php b/packages/Webkul/CartRule/src/Helpers/CartRule.php index fa25075fb..2aea194f9 100644 --- a/packages/Webkul/CartRule/src/Helpers/CartRule.php +++ b/packages/Webkul/CartRule/src/Helpers/CartRule.php @@ -17,42 +17,42 @@ class CartRule /** * CartRuleRepository object * - * @var CartRuleRepository + * @var \Webkul\CartRule\Repositories\CartRuleRepository */ protected $cartRuleRepository; /** * CartRuleCouponRepository object * - * @var CartRuleCouponRepository + * @var \Webkul\CartRule\Repositories\CartRuleCouponRepository */ protected $cartRuleCouponRepository; /** * CartRuleCouponUsageRepository object * - * @var CartRuleCouponUsageRepository + * @var \Webkul\CartRule\Repositories\CartRuleCouponUsageRepository */ protected $cartRuleCouponUsageRepository; /** * CartRuleCustomerRepository object * - * @var CartRuleCustomerRepository + * @var \Webkul\CartRule\Repositories\CartRuleCustomerRepository */ protected $cartRuleCustomerRepository; /** * CustomerGroupRepository object * - * @var CustomerGroupRepository + * @var \Webkul\Customer\Repositories\CustomerGroupRepository */ protected $customerGroupRepository; /** * Validator object * - * @var Validator + * @var \Webkul\Rule\Helpers\Validator */ protected $validator; @@ -64,12 +64,12 @@ class CartRule /** * Create a new helper instance. * - * @param Webkul\CartRule\Repositories\CartRuleRepository $cartRuleRepository - * @param Webkul\CartRule\Repositories\CartRuleCouponRepository $cartRuleCouponRepository - * @param Webkul\CartRule\Repositories\CartRuleCouponUsageRepository $cartRuleCouponUsageRepository - * @param Webkul\CartRule\Repositories\CartRuleCustomerRepository $cartRuleCustomerRepository - * @param Webkul\Customer\Repositories\CustomerGroupRepository $customerGroupRepository - * @param Webkul\Rule\Helpers\Validator $validator + * @param \Webkul\CartRule\Repositories\CartRuleRepository $cartRuleRepository + * @param \Webkul\CartRule\Repositories\CartRuleCouponRepository $cartRuleCouponRepository + * @param \Webkul\CartRule\Repositories\CartRuleCouponUsageRepository $cartRuleCouponUsageRepository + * @param \Webkul\CartRule\Repositories\CartRuleCustomerRepository $cartRuleCustomerRepository + * @param \Webkul\Customer\Repositories\CustomerGroupRepository $customerGroupRepository + * @param \Webkul\Rule\Helpers\Validator $validator * * @return void */ @@ -130,7 +130,7 @@ class CartRule /** * Returns cart rules * - * @return Collection + * @return \Illuminate\Support\Collection */ public function getCartRules() { @@ -172,9 +172,8 @@ class CartRule /** * Check if cart rule can be applied * - * @param CartRule $rule - * - * @return boolean + * @param \Webkul\CartRule\Contracts\CartRule $rule + * @return bool */ public function canProcessRule($rule): bool { @@ -228,7 +227,6 @@ class CartRule * Cart item discount calculation process * * @param \Webkul\Checkout\Models\CartItem $item - * * @return array */ public function process(CartItem $item): array @@ -338,8 +336,7 @@ class CartRule /** * Cart shipping discount calculation process * - * @param Cart $cart - * + * @param \Webkul\Checkout\Contracts\Cart $cart * @return void */ public function processShippingDiscount($cart) @@ -420,8 +417,7 @@ class CartRule /** * Cart free shipping discount calculation process * - * @param Cart $cart - * + * @param \Webkul\Checkout\Contracts\Cart $cart * @return void */ public function processFreeShippingDiscount($cart) @@ -476,9 +472,8 @@ class CartRule /** * Calculate cart item totals for each rule * - * @param mixed $items - * - * @return Validator + * @param \Illuminate\Support\Collecton $items + * @return \Webkul\Rule\Helpers\Validator */ public function calculateCartItemTotals($items) { @@ -529,8 +524,7 @@ class CartRule /** * Divide discount amount to children * - * @param CartItem $item - * + * @param \Webkul\Checkout\Contracts\CartItem $item * @return void */ protected function divideDiscount($item) diff --git a/packages/Webkul/CartRule/src/Http/Controllers/CartRuleController.php b/packages/Webkul/CartRule/src/Http/Controllers/CartRuleController.php index 32165d15b..337afec7a 100644 --- a/packages/Webkul/CartRule/src/Http/Controllers/CartRuleController.php +++ b/packages/Webkul/CartRule/src/Http/Controllers/CartRuleController.php @@ -25,22 +25,22 @@ class CartRuleController extends Controller /** * To hold Cart repository instance * - * @var CartRuleRepository + * @var \Webkul\CartRule\Repositories\CartRuleRepository */ protected $cartRuleRepository; /** * To hold CartRuleCouponRepository repository instance * - * @var CartRuleCouponRepository + * @var \Webkul\CartRule\Repositories\CartRuleCouponRepository */ protected $cartRuleCouponRepository; /** * Create a new controller instance. * - * @param \Webkul\CartRule\Repositories\CartRuleRepository $cartRuleRepository - * @param \Webkul\CartRule\Repositories\CartRuleCouponRepository $cartRuleCouponRepository + * @param \Webkul\CartRule\Repositories\CartRuleRepository $cartRuleRepository + * @param \Webkul\CartRule\Repositories\CartRuleCouponRepository $cartRuleCouponRepository * * @return void */ @@ -112,8 +112,7 @@ class CartRuleController extends Controller /** * Show the form for editing the specified resource. * - * @param int $id - * + * @param int $id * @return \Illuminate\Http\Response */ public function edit($id) @@ -126,9 +125,8 @@ class CartRuleController extends Controller /** * Update the specified resource in storage. * - * @param \Illuminate\Http\Request $request - * @param int $id - * + * @param \Illuminate\Http\Request $request + * @param int $id * @return \Illuminate\Http\Response */ public function update(Request $request, $id) @@ -162,8 +160,7 @@ class CartRuleController extends Controller /** * Remove the specified resource from storage. * - * @param int $id - * + * @param int $id * @return \Illuminate\Http\Response */ public function destroy($id) diff --git a/packages/Webkul/CartRule/src/Http/Controllers/CartRuleCouponController.php b/packages/Webkul/CartRule/src/Http/Controllers/CartRuleCouponController.php index af3161cc7..e4268ee84 100644 --- a/packages/Webkul/CartRule/src/Http/Controllers/CartRuleCouponController.php +++ b/packages/Webkul/CartRule/src/Http/Controllers/CartRuleCouponController.php @@ -16,14 +16,14 @@ class CartRuleCouponController extends Controller /** * To hold CartRuleCouponRepository repository instance * - * @var CartRuleCouponRepository + * @var \Webkul\CartRule\Repositories\CartRuleCouponRepository */ protected $cartRuleCouponRepository; /** * Create a new controller instance. * - * @param \Webkul\CartRule\Repositories\CartRuleCouponRepository $cartRuleCouponRepository + * @param \Webkul\CartRule\Repositories\CartRuleCouponRepository $cartRuleCouponRepository * @return void */ public function __construct(CartRuleCouponRepository $cartRuleCouponRepository) diff --git a/packages/Webkul/CartRule/src/Listeners/Cart.php b/packages/Webkul/CartRule/src/Listeners/Cart.php index f039059c1..da8e1e0e0 100644 --- a/packages/Webkul/CartRule/src/Listeners/Cart.php +++ b/packages/Webkul/CartRule/src/Listeners/Cart.php @@ -15,14 +15,14 @@ class Cart /** * CartRule object * - * @var CartRule + * @var \Webkul\CartRule\Helpers\CartRule */ protected $cartRuleHepler; /** * Create a new listener instance. * - * @param Webkul\CartRule\Repositories\CartRule $cartRuleHepler + * @param \Webkul\CartRule\Repositories\CartRule $cartRuleHepler * @return void */ public function __construct(CartRule $cartRuleHepler) @@ -33,7 +33,7 @@ class Cart /** * Aplly valid cart rules to cart * - * @param Cart $cart + * @param \Webkul\Checkout\Contracts\Cart $cart * @return void */ public function applyCartRules($cart) diff --git a/packages/Webkul/CartRule/src/Listeners/Order.php b/packages/Webkul/CartRule/src/Listeners/Order.php index 7e521c062..13c5e59b1 100755 --- a/packages/Webkul/CartRule/src/Listeners/Order.php +++ b/packages/Webkul/CartRule/src/Listeners/Order.php @@ -18,38 +18,38 @@ class Order /** * CartRuleRepository object * - * @var CartRuleRepository + * @var \Webkul\CartRule\Repositories\CartRuleRepository */ protected $cartRuleRepository; /** * CartRuleCustomerRepository object * - * @var CartRuleCustomerRepository + * @var Webkul\CartRule\Repositories\\CartRuleCustomerRepository */ protected $cartRuleCustomerRepository; /** * CartRuleCouponRepository object * - * @var CartRuleCouponRepository + * @var Webkul\CartRule\Repositories\\CartRuleCouponRepository */ protected $cartRuleCouponRepository; /** * CartRuleCouponUsageRepository object * - * @var CartRuleCouponUsageRepository + * @var \Webkul\CartRule\Repositories\CartRuleCouponUsageRepository */ protected $cartRuleCouponUsageRepository; /** * Create a new listener instance. * - * @param Webkul\CartRule\Repositories\CartRuleRepository $cartRuleRepository - * @param Webkul\CartRule\Repositories\CartRuleCustomerRepository $cartRuleCustomerRepository - * @param Webkul\CartRule\Repositories\CartRuleCouponRepository $cartRuleCouponRepository - * @param Webkul\CartRule\Repositories\CartRuleCouponUsageRepository $cartRuleCouponUsageRepository + * @param \Webkul\CartRule\Repositories\CartRuleRepository $cartRuleRepository + * @param \Webkul\CartRule\Repositories\CartRuleCustomerRepository $cartRuleCustomerRepository + * @param \Webkul\CartRule\Repositories\CartRuleCouponRepository $cartRuleCouponRepository + * @param \Webkul\CartRule\Repositories\CartRuleCouponUsageRepository $cartRuleCouponUsageRepository * @return void */ public function __construct( @@ -71,7 +71,7 @@ class Order /** * Save cart rule and cart rule coupon properties after place order * - * @param Order $order + * @param \Webkul\Sales\Contracts\Order $order * @return void */ public function manageCartRule($order) diff --git a/packages/Webkul/CartRule/src/Repositories/CartRuleCouponRepository.php b/packages/Webkul/CartRule/src/Repositories/CartRuleCouponRepository.php index ef6ac1dda..53efb3f2a 100755 --- a/packages/Webkul/CartRule/src/Repositories/CartRuleCouponRepository.php +++ b/packages/Webkul/CartRule/src/Repositories/CartRuleCouponRepository.php @@ -34,8 +34,8 @@ class CartRuleCouponRepository extends Repository /** * Creates coupons for cart rule * - * @param array $data - * @param integer $cartRuleId + * @param array $data + * @param int $cartRuleId * @return void */ public function generateCoupons($data, $cartRuleId) @@ -57,8 +57,8 @@ class CartRuleCouponRepository extends Repository /** * Creates coupons for cart rule * - * @param string $format - * @param integer $length + * @param string $format + * @param int $length * @return string */ public function getRandomString($format, $length) diff --git a/packages/Webkul/CartRule/src/Repositories/CartRuleRepository.php b/packages/Webkul/CartRule/src/Repositories/CartRuleRepository.php index 1d3e217a2..ae804c922 100755 --- a/packages/Webkul/CartRule/src/Repositories/CartRuleRepository.php +++ b/packages/Webkul/CartRule/src/Repositories/CartRuleRepository.php @@ -22,63 +22,63 @@ class CartRuleRepository extends Repository /** * AttributeFamilyRepository object * - * @var AttributeFamilyRepository + * @var \Webkul\Attribute\Repositories\AttributeFamilyRepository */ protected $attributeFamilyRepository; /** * AttributeRepository object * - * @var AttributeRepository + * @var \Webkul\Attribute\Repositories\AttributeRepository */ protected $attributeRepository; /** * CategoryRepository class * - * @var CategoryRepository + * @var \Webkul\Category\Repositories\CategoryRepository */ protected $categoryRepository; /** * CartRuleCouponRepository object * - * @var CartRuleCouponRepository + * @var Webkul\CartRule\Repositories\CartRuleCouponRepository */ protected $cartRuleCouponRepository; /** * TaxCategoryRepository class * - * @var TaxCategoryRepository + * @var \Webkul\Tax\Repositories\TaxCategoryRepository */ protected $taxCategoryRepository; /** * CountryRepository class * - * @var CountryRepository + * @var \Webkul\Core\Repositories\CountryRepository */ protected $countryRepository; /** * CountryStateRepository class * - * @var CountryStateRepository + * @var \Webkul\Core\Repositories\CountryStateRepository */ protected $countryStateRepository; /** * Create a new repository instance. * - * @param Webkul\Attribute\Repositories\AttributeFamilyRepository $attributeFamilyRepository - * @param Webkul\Attribute\Repositories\AttributeRepository $attributeRepository - * @param Webkul\Category\Repositories\CategoryRepository $categoryRepository - * @param Webkul\CartRule\Repositories\CartRuleCouponRepository $cartRuleCouponRepository - * @param Webkul\Tax\Repositories\TaxCategoryRepository $taxCategoryRepository - * @param Webkul\Core\Repositories\CountryRepository $countryRepository - * @param Webkul\Core\Repositories\CountryStateRepository $countryStateRepository - * @param Illuminate\Container\Container $app + * @param \Webkul\Attribute\Repositories\AttributeFamilyRepository $attributeFamilyRepository + * @param \Webkul\Attribute\Repositories\AttributeRepository $attributeRepository + * @param \Webkul\Category\Repositories\CategoryRepository $categoryRepository + * @param \Webkul\CartRule\Repositories\CartRuleCouponRepository $cartRuleCouponRepository + * @param \Webkul\Tax\Repositories\TaxCategoryRepository $taxCategoryRepository + * @param \Webkul\Core\Repositories\CountryRepository $countryRepository + * @param \Webkul\Core\Repositories\CountryStateRepository $countryStateRepository + * @param \Illuminate\Container\Container $app * @return void */ public function __construct( @@ -120,8 +120,8 @@ class CartRuleRepository extends Repository } /** - * @param array $data - * @return mixed + * @param array $data + * @return \Webkul\CartRule\Contracts\CartRule */ public function create(array $data) { @@ -152,10 +152,10 @@ class CartRuleRepository extends Repository } /** - * @param array $data - * @param array $id - * @param string $attribute - * @return mixed + * @param array $data + * @param int $id + * @param string $attribute + * @return \Webkul\CartRule\Contracts\CartRule */ public function update(array $data, $id, $attribute = "id") { diff --git a/packages/Webkul/CatalogRule/src/Console/Commands/PriceRuleIndex.php b/packages/Webkul/CatalogRule/src/Console/Commands/PriceRuleIndex.php index adaff0a96..53f7e7d43 100644 --- a/packages/Webkul/CatalogRule/src/Console/Commands/PriceRuleIndex.php +++ b/packages/Webkul/CatalogRule/src/Console/Commands/PriceRuleIndex.php @@ -24,14 +24,14 @@ class PriceRuleIndex extends Command /** * CatalogRuleIndex object * - * @var Object + * @var \Webkul\CatalogRule\Helpers\CatalogRuleIndex */ protected $catalogRuleIndexHelper; /** * Create a new command instance. * - * @param Webkul\CatalogRuleProduct\Helpers\CatalogRuleIndex $catalogRuleIndexHelper + * @param \Webkul\CatalogRuleProduct\Helpers\CatalogRuleIndex $catalogRuleIndexHelper * @return void */ public function __construct(CatalogRuleIndex $catalogRuleIndexHelper) @@ -44,7 +44,7 @@ class PriceRuleIndex extends Command /** * Execute the console command. * - * @return mixed + * @return void */ public function handle() { diff --git a/packages/Webkul/CatalogRule/src/Helpers/CatalogRuleIndex.php b/packages/Webkul/CatalogRule/src/Helpers/CatalogRuleIndex.php index 5cd65d51c..ef3fdb68b 100644 --- a/packages/Webkul/CatalogRule/src/Helpers/CatalogRuleIndex.php +++ b/packages/Webkul/CatalogRule/src/Helpers/CatalogRuleIndex.php @@ -10,30 +10,30 @@ class CatalogRuleIndex /** * CatalogRuleRepository object * - * @var Object + * @var \Webkul\CatalogRule\Repositories\CatalogRuleRepository */ protected $catalogRuleRepository; /** * CatalogRuleProduct object * - * @var Object + * @var \Webkul\CatalogRule\Helpers\CatalogRuleProduct */ protected $catalogRuleHelper; /** * CatalogRuleProductPrice object * - * @var Object + * @var \Webkul\CatalogRule\Helpers\CatalogRuleProductPrice */ protected $catalogRuleProductPriceHelper; /** * Create a new helper instance. * - * @param Webkul\CatalogRule\Repositories\CatalogRuleRepository $catalogRuleRepository - * @param Webkul\CatalogRuleProduct\Helpers\CatalogRuleProduct $catalogRuleProductHelper - * @param Webkul\CatalogRuleProduct\Helpers\CatalogRuleProductPrice $catalogRuleProductPriceHelper + * @param \Webkul\CatalogRule\Repositories\CatalogRuleRepository $catalogRuleRepository + * @param \Webkul\CatalogRuleProduct\Helpers\CatalogRuleProduct $catalogRuleProductHelper + * @param \Webkul\CatalogRuleProduct\Helpers\CatalogRuleProductPrice $catalogRuleProductPriceHelper * @return void */ public function __construct( @@ -72,7 +72,7 @@ class CatalogRuleIndex /** * Full reindex * - * @param Product $product + * @param \Webkul\Product\Contracts\Product $product * @return void */ public function reindexProduct($product) @@ -101,7 +101,7 @@ class CatalogRuleIndex /** * Deletes catalog rule product and catalog rule product price indexes * - * @param array $productIds + * @param array $productIds * @return void */ public function cleanIndexes($productIds = []) @@ -114,7 +114,7 @@ class CatalogRuleIndex /** * Returns catalog rules * - * @return Collection + * @return \Illuminate\Support\Collection */ public function getCatalogRules() { diff --git a/packages/Webkul/CatalogRule/src/Helpers/CatalogRuleProduct.php b/packages/Webkul/CatalogRule/src/Helpers/CatalogRuleProduct.php index ca20c560c..7beef9136 100644 --- a/packages/Webkul/CatalogRule/src/Helpers/CatalogRuleProduct.php +++ b/packages/Webkul/CatalogRule/src/Helpers/CatalogRuleProduct.php @@ -14,38 +14,38 @@ class CatalogRuleProduct /** * AttributeRepository object * - * @var AttributeRepository + * @var \Webkul\Attribute\Repositories\AttributeRepository */ protected $attributeRepository; /** * ProductRepository object * - * @var ProductRepository + * @var \Webkul\Product\Repositories\ProductRepository */ protected $productRepository; /** * CatalogRuleProductRepository object * - * @var CatalogRuleProductRepository + * @var \Webkul\CatalogRule\Repositories\CatalogRuleProductRepository */ protected $catalogRuleProductRepository; /** * Validator object * - * @var Validator + * @var \Webkul\Rule\Helpers\ValidatorValidator */ protected $validator; /** * Create a new helper instance. * - * @param Webkul\Attribute\Repositories\AttributeRepository $attributeRepository - * @param Webkul\Product\Repositories\ProductRepository $productRepository - * @param Webkul\CatalogRule\Repositories\CatalogRuleProductRepository $catalogRuleProductRepository - * @param Webkul\Rule\Helpers\Validator $validator + * @param \Webkul\Attribute\Repositories\AttributeRepository $attributeRepository + * @param \Webkul\Product\Repositories\ProductRepository $productRepository + * @param \Webkul\CatalogRule\Repositories\CatalogRuleProductRepository $catalogRuleProductRepository + * @param \Webkul\Rule\Helpers\Validator $validator * @return void */ public function __construct( @@ -67,8 +67,8 @@ class CatalogRuleProduct /** * Collect discount on cart * - * @param CatalogRule $rule - * @param integer $batchCount + * @param \Webkul\CatalogRule\Contracts\CatalogRule $rule + * @param int $batchCount * @return void */ public function insertRuleProduct($rule, $batchCount = 1000, $product = null) @@ -114,8 +114,8 @@ class CatalogRuleProduct /** * Get array of product ids which are matched by rule * - * @param CatalogRule $rule - * @param Product $product + * @param \Webkul\CatalogRule\Contracts\CatalogRule $rule + * @param \Webkul\Product\Contracts\Product $product * @return array */ public function getMatchingProductIds($rule, $product = null) @@ -179,12 +179,13 @@ class CatalogRuleProduct /** * Add product attribute condition to query * - * @param string $attributeCode - * @param QueryBuilder $query - * @return QueryBuilder + * @param string $attributeCode + * @param \Illuminate\Database\Eloquent\Builder $query + * @return \Illuminate\Database\Eloquent\Builder */ public function addAttributeToSelect($attributeCode, $query) { + dd($query); $attribute = $this->attributeRepository->findOneByField('code', $attributeCode); if (! $attribute) { @@ -207,8 +208,8 @@ class CatalogRuleProduct /** * Returns catalog rule products * - * @param Product $product - * @return Collection + * @param \Webkul\Product\Contracts\Product $product + * @return \Illuminate\Support\Collection */ public function getCatalogRuleProducts($product = null) { @@ -245,7 +246,7 @@ class CatalogRuleProduct /** * Returns catalog rules * - * @param CatalogRule $rule + * @param \Webkul\CatalogRule\Contracts\CatalogRule $rule * @return void */ public function cleanProductIndex($productIds = []) diff --git a/packages/Webkul/CatalogRule/src/Helpers/CatalogRuleProductPrice.php b/packages/Webkul/CatalogRule/src/Helpers/CatalogRuleProductPrice.php index 47e1d031d..89310556e 100644 --- a/packages/Webkul/CatalogRule/src/Helpers/CatalogRuleProductPrice.php +++ b/packages/Webkul/CatalogRule/src/Helpers/CatalogRuleProductPrice.php @@ -11,30 +11,30 @@ class CatalogRuleProductPrice /** * CatalogRuleProductPriceRepository object * - * @var CatalogRuleProductPriceRepository + * @var \Webkul\CatalogRule\Repositories\CatalogRuleProductPriceRepository */ protected $catalogRuleProductPriceRepository; /** * CatalogRuleProduct object * - * @var CatalogRuleProduct + * @var \Webkul\CatalogRule\Helpers\CatalogRuleProduct */ protected $catalogRuleProductHelper; /** * CustomerGroupRepository object * - * @var CustomerGroupRepository + * @var \Webkul\Customer\Repositories\CustomerGroupRepository */ protected $customerGroupRepository; /** * Create a new helper instance. * - * @param Webkul\Attribute\Repositories\CatalogRuleProductPriceRepository $catalogRuleProductPriceRepository - * @param Webkul\CatalogRule\Repositories\CatalogRuleProduct $catalogRuleProductHelper - * @param Webkul\Customer\Repositories\CustomerGroupRepository $customerGroupRepository + * @param \Webkul\Attribute\Repositories\CatalogRuleProductPriceRepository $catalogRuleProductPriceRepository + * @param \Webkul\CatalogRule\Repositories\CatalogRuleProduct $catalogRuleProductHelper + * @param \Webkul\Customer\Repositories\CustomerGroupRepository $customerGroupRepository * @return void */ public function __construct( @@ -53,7 +53,7 @@ class CatalogRuleProductPrice /** * Return current logged in customer * - * @return Customer | Boolean + * @return Customer|bool */ public function getCurrentCustomer() { @@ -65,8 +65,8 @@ class CatalogRuleProductPrice /** * Collect discount on cart * - * @param integer $batchCount - * @param Product $product + * @param int $batchCount + * @param \Webkul\Product\Contracts\Product $product * @return void */ public function indexRuleProductPrice($batchCount, $product = null) @@ -140,8 +140,8 @@ class CatalogRuleProductPrice /** * Calculates product price based on rule * - * @param array $rule - * @param Product|null $productData + * @param array $rule + * @param \Webkul\Product\Contracts\Product|null $productData * @return float */ public function calculate($rule, $productData = null) @@ -176,7 +176,7 @@ class CatalogRuleProductPrice /** * Clean product price index * - * @param array $productIds + * @param array $productIds * @return void */ public function cleanProductPriceIndex($productIds = []) @@ -193,8 +193,8 @@ class CatalogRuleProductPrice /** * Get catalog rules product price for specific date, channel and customer group * - * @param Product $product - * @return void + * @param \Webkul\Product\Contracts\Product $product + * @return array|void */ public function getRulePrice($product) { diff --git a/packages/Webkul/CatalogRule/src/Http/Controllers/CatalogRuleController.php b/packages/Webkul/CatalogRule/src/Http/Controllers/CatalogRuleController.php index 1f0070803..22f75a38b 100644 --- a/packages/Webkul/CatalogRule/src/Http/Controllers/CatalogRuleController.php +++ b/packages/Webkul/CatalogRule/src/Http/Controllers/CatalogRuleController.php @@ -25,22 +25,22 @@ class CatalogRuleController extends Controller /** * To hold Catalog repository instance * - * @var CatalogRuleRepository + * @var \Webkul\CatalogRule\Repositories\CatalogRuleRepository */ protected $catalogRuleRepository; /** * CatalogRuleIndex * - * @var CatalogRuleIndex + * @var \Webkul\CatalogRule\Helpers\CatalogRuleIndex */ protected $catalogRuleIndexHelper; /** * Create a new controller instance. * - * @param \Webkul\CatalogRule\Repositories\CatalogRuleRepository $catalogRuleRepository - * @param \Webkul\CatalogRule\Helpers\CatalogRuleIndex $catalogRuleIndexHelper + * @param \Webkul\CatalogRule\Repositories\CatalogRuleRepository $catalogRuleRepository + * @param \Webkul\CatalogRule\Helpers\CatalogRuleIndex $catalogRuleIndexHelper * @return void */ public function __construct( @@ -110,7 +110,7 @@ class CatalogRuleController extends Controller /** * Show the form for editing the specified resource. * - * @param int $id + * @param int $id * @return \Illuminate\Http\Response */ public function edit($id) @@ -124,7 +124,7 @@ class CatalogRuleController extends Controller * Update the specified resource in storage. * * @param \Illuminate\Http\Request $request - * @param int $id + * @param int $id * @return \Illuminate\Http\Response */ public function update(Request $request, $id) diff --git a/packages/Webkul/CatalogRule/src/Listeners/Product.php b/packages/Webkul/CatalogRule/src/Listeners/Product.php index ef5dc2b51..af3797a84 100755 --- a/packages/Webkul/CatalogRule/src/Listeners/Product.php +++ b/packages/Webkul/CatalogRule/src/Listeners/Product.php @@ -15,14 +15,14 @@ class Product /** * Product Repository Object * - * @var Object + * @var \Webkul\CatalogRule\Helpers\CatalogRuleIndex */ protected $catalogRuleIndexHelper; /** * Create a new listener instance. * - * @param Webkul\CatalogRule\Helpers\CatalogRuleIndex $catalogRuleIndexHelper + * @param \Webkul\CatalogRule\Helpers\CatalogRuleIndex $catalogRuleIndexHelper * @return void */ public function __construct(CatalogRuleIndex $catalogRuleIndexHelper) @@ -31,7 +31,7 @@ class Product } /** - * @param Product $product + * @param \Webkul\Product\Contracts\Product $product * @return void */ public function createProductRuleIndex($product) diff --git a/packages/Webkul/CatalogRule/src/Repositories/CatalogRuleRepository.php b/packages/Webkul/CatalogRule/src/Repositories/CatalogRuleRepository.php index c79ea21a1..12e58be11 100644 --- a/packages/Webkul/CatalogRule/src/Repositories/CatalogRuleRepository.php +++ b/packages/Webkul/CatalogRule/src/Repositories/CatalogRuleRepository.php @@ -20,39 +20,39 @@ class CatalogRuleRepository extends Repository /** * AttributeFamilyRepository object * - * @var AttributeFamilyRepository + * @var \Webkul\Attribute\Repositories\AttributeFamilyRepository */ protected $attributeFamilyRepository; /** * AttributeRepository object * - * @var AttributeRepository + * @var \Webkul\Attribute\Repositories\AttributeRepository */ protected $attributeRepository; /** * CategoryRepository class * - * @var CategoryRepository + * @var \Webkul\Category\Repositories\CategoryRepository */ protected $categoryRepository; /** * TaxCategoryRepository class * - * @var TaxCategoryRepository + * @var \Webkul\CaTaxtegory\Repositories\axCategoryRepository */ protected $taxCategoryRepository; /** * Create a new repository instance. * - * @param Webkul\Attribute\Repositories\AttributeFamilyRepository $attributeFamilyRepository - * @param Webkul\Attribute\Repositories\AttributeRepository $attributeRepository - * @param Webkul\Category\Repositories\CategoryRepository $categoryRepository - * @param Webkul\Tax\Repositories\TaxCategoryRepository $taxCategoryRepository - * @param Illuminate\Container\Container $app + * @param \Webkul\Attribute\Repositories\AttributeFamilyRepository $attributeFamilyRepository + * @param \Webkul\Attribute\Repositories\AttributeRepository $attributeRepository + * @param \Webkul\Category\Repositories\CategoryRepository $categoryRepository + * @param \Webkul\Tax\Repositories\TaxCategoryRepository $taxCategoryRepository + * @param \Illuminate\Container\Container $app * @return void */ public function __construct( @@ -85,8 +85,8 @@ class CatalogRuleRepository extends Repository } /** - * @param array $data - * @return mixed + * @param array $data + * @return \Webkul\CatalogRule\Contracts\CatalogRule */ public function create(array $data) { @@ -106,10 +106,10 @@ class CatalogRuleRepository extends Repository } /** - * @param array $data - * @param array $id - * @param string $attribute - * @return mixed + * @param array $data + * @param int $id + * @param string $attribute + * @return \Webkul\CatalogRule\Contracts\CatalogRule */ public function update(array $data, $id, $attribute = "id") { diff --git a/packages/Webkul/Category/src/Http/Controllers/CategoryController.php b/packages/Webkul/Category/src/Http/Controllers/CategoryController.php index 8ab339ca6..36e098be6 100755 --- a/packages/Webkul/Category/src/Http/Controllers/CategoryController.php +++ b/packages/Webkul/Category/src/Http/Controllers/CategoryController.php @@ -25,22 +25,22 @@ class CategoryController extends Controller /** * CategoryRepository object * - * @var Object + * @var \Webkul\Category\Repositories\CategoryRepository */ protected $categoryRepository; /** * AttributeRepository object * - * @var Object + * @var \Webkul\Attribute\Repositories\AttributeRepository */ protected $attributeRepository; /** * Create a new controller instance. * - * @param \Webkul\Category\Repositories\CategoryRepository $categoryRepository - * @param \Webkul\Attribute\Repositories\AttributeRepository $attributeRepository + * @param \Webkul\Category\Repositories\CategoryRepository $categoryRepository + * @param \Webkul\Attribute\Repositories\AttributeRepository $attributeRepository * @return void */ public function __construct( @@ -115,7 +115,7 @@ class CategoryController extends Controller /** * Show the form for editing the specified resource. * - * @param int $id + * @param int $id * @return \Illuminate\View\View */ public function edit($id) @@ -190,9 +190,10 @@ class CategoryController extends Controller /** * Remove the specified resources from database * - * @return response \Illuminate\Http\Response + * @return \Illuminate\Http\Response */ - public function massDestroy() { + public function massDestroy() + { $suppressFlash = false; if (request()->isMethod('delete') || request()->isMethod('post')) { diff --git a/packages/Webkul/Category/src/Observers/CategoryObserver.php b/packages/Webkul/Category/src/Observers/CategoryObserver.php index 6603dd624..e0d38ab8e 100644 --- a/packages/Webkul/Category/src/Observers/CategoryObserver.php +++ b/packages/Webkul/Category/src/Observers/CategoryObserver.php @@ -11,7 +11,7 @@ class CategoryObserver /** * Handle the Category "deleted" event. * - * @param Category $category + * @param \Webkul\Category\Contracts\Category $category * @return void */ public function deleted($category) @@ -22,7 +22,7 @@ class CategoryObserver /** * Handle the Category "saved" event. * - * @param Category $category + * @param \Webkul\Category\Contracts\Category $category */ public function saved($category) { diff --git a/packages/Webkul/Category/src/Repositories/CategoryRepository.php b/packages/Webkul/Category/src/Repositories/CategoryRepository.php index c6ba31f60..eec44e05e 100755 --- a/packages/Webkul/Category/src/Repositories/CategoryRepository.php +++ b/packages/Webkul/Category/src/Repositories/CategoryRepository.php @@ -30,8 +30,8 @@ class CategoryRepository extends Repository } /** - * @param array $data - * @return mixed + * @param array $data + * @return \Webkul\Category\Contracts\Category */ public function create(array $data) { @@ -66,8 +66,8 @@ class CategoryRepository extends Repository /** * Specify category tree * - * @param integer $id - * @return mixed + * @param int $id + * @return \Webkul\Category\Contracts\Category */ public function getCategoryTree($id = null) { @@ -79,8 +79,8 @@ class CategoryRepository extends Repository /** * Specify category tree * - * @param integer $id - * @return mixed + * @param int $id + * @return \Illuminate\Support\Collection */ public function getCategoryTreeWithoutDescendant($id = null) { @@ -92,7 +92,7 @@ class CategoryRepository extends Repository /** * Get root categories * - * @return mixed + * @return \Illuminate\Support\Collection */ public function getRootCategories() { @@ -102,8 +102,8 @@ class CategoryRepository extends Repository /** * get visible category tree * - * @param integer $id - * @return mixed + * @param int $id + * @return \Illuminate\Support\Collection */ public function getVisibleCategoryTree($id = null) { @@ -121,9 +121,9 @@ class CategoryRepository extends Repository /** * Checks slug is unique or not based on locale * - * @param integer $id - * @param string $slug - * @return boolean + * @param int $id + * @param string $slug + * @return bool */ public function isSlugUnique($id, $slug) { @@ -140,7 +140,7 @@ class CategoryRepository extends Repository * Retrive category from slug * * @param string $slug - * @return mixed + * @return \Webkul\Category\Contracts\Category */ public function findBySlugOrFail($slug) { @@ -156,9 +156,8 @@ class CategoryRepository extends Repository } /** - * @param string $urlPath - * - * @return mixed + * @param string $urlPath + * @return \Webkul\Category\Contracts\Category */ public function findByPath(string $urlPath) { @@ -166,10 +165,10 @@ class CategoryRepository extends Repository } /** - * @param array $data - * @param $id - * @param string $attribute - * @return mixed + * @param array $data + * @param int $id + * @param string $attribute + * @return \Webkul\Category\Contracts\Category */ public function update(array $data, $id, $attribute = "id") { @@ -191,7 +190,7 @@ class CategoryRepository extends Repository } /** - * @param $id + * @param int $id * @return void */ public function delete($id) @@ -204,8 +203,8 @@ class CategoryRepository extends Repository } /** - * @param array $data - * @param mixed $category + * @param array $data + * @param \Webkul\Category\Contracts\Category $category * @return void */ public function uploadImages($data, $category, $type = "image") @@ -236,10 +235,15 @@ class CategoryRepository extends Repository } } + /** + * @param array|null $columns + * @return array + */ public function getPartial($columns = null) { $categories = $this->model->all(); - $trimmed = array(); + + $trimmed = []; foreach ($categories as $key => $category) { if ($category->name != null || $category->name != "") { diff --git a/packages/Webkul/Checkout/src/Cart.php b/packages/Webkul/Checkout/src/Cart.php index 220310a4f..4d6ae2070 100755 --- a/packages/Webkul/Checkout/src/Cart.php +++ b/packages/Webkul/Checkout/src/Cart.php @@ -29,65 +29,62 @@ class Cart /** * CartRepository instance * - * @var mixed + * @var \Webkul\Checkout\Repositories\CartRepository */ protected $cartRepository; /** * CartItemRepository instance * - * @var mixed + * @var \Webkul\Checkout\Repositories\CartItemRepository */ protected $cartItemRepository; /** * CartAddressRepository instance * - * @var mixed + * @var \Webkul\Checkout\Repositories\CartAddressRepository */ protected $cartAddressRepository; /** * ProductRepository instance * - * @var mixed + * @var \Webkul\Checkout\Repositories\ProductRepository */ protected $productRepository; /** * TaxCategoryRepository instance * - * @var mixed + * @var \Webkul\Tax\Repositories\TaxCategoryRepository */ protected $taxCategoryRepository; /** * WishlistRepository instance * - * @var mixed + * @var \Webkul\Customer\Repositories\WishlistRepository */ protected $wishlistRepository; /** * CustomerAddressRepository instance * - * @var mixed + * @var \Webkul\Customer\Repositories\CustomerAddressRepository */ protected $customerAddressRepository; /** - * Create a new controller instance. - * - * @param Webkul\Checkout\Repositories\CartRepository $cart - * @param Webkul\Checkout\Repositories\CartItemRepository $cartItem - * @param Webkul\Checkout\Repositories\CartAddressRepository $cartAddress - * @param Webkul\Product\Repositories\ProductRepository $product - * @param Webkul\Product\Repositories\TaxCategoryRepository $taxCategory - * @param Webkul\Product\Repositories\CustomerAddressRepository $customerAddress - * @param Webkul\Product\Repositories\CustomerAddressRepository $customerAddress - * @param Webkul\Discount\Repositories\CartRuleRepository $cartRule - * @param Webkul\Helpers\Discount $discount + * Create a new class instance. * + * @param \Webkul\Checkout\Repositories\CartRepository $cartRepository + * @param \Webkul\Checkout\Repositories\CartItemRepository $cartItemRepository + * @param \Webkul\Checkout\Repositories\CartAddressRepository $cartAddressRepository + * @param \Webkul\Product\Repositories\ProductRepository $productRepository + * @param \Webkul\Tax\Repositories\TaxCategoryRepository $taxCategoryRepository + * @param \Webkul\Customer\Repositories\WishlistRepository $wishlistRepository + * @param \Webkul\Customer\Repositories\CustomerAddressRepository $customerAddressRepository * @return void */ public function __construct( @@ -98,7 +95,8 @@ class Cart TaxCategoryRepository $taxCategoryRepository, WishlistRepository $wishlistRepository, CustomerAddressRepository $customerAddressRepository - ) { + ) + { $this->cartRepository = $cartRepository; $this->cartItemRepository = $cartItemRepository; @@ -117,7 +115,7 @@ class Cart /** * Return current logged in customer * - * @return Customer|boolean + * @return \Webkul\Customer\Contracts\Customer|bool */ public function getCurrentCustomer() { @@ -129,10 +127,9 @@ class Cart /** * Add Items in a cart with some cart and item details. * - * @param integer $productId - * @param array $data - * - * @return Mixed Cart on success, array with warning otherwise + * @param int $productId + * @param array $data + * @return \Webkul\Checkout\Contracts\Cart|\Exception|array */ public function addProduct($productId, $data) { @@ -198,9 +195,8 @@ class Cart /** * Create new cart instance. * - * @param array $data - * - * @return Cart|null + * @param array $data + * @return \Webkul\Checkout\Contracts\Cart|null */ public function create($data) { @@ -240,9 +236,8 @@ class Cart /** * Update cart items information * - * @param array $data - * - * @return string|boolean + * @param array $data + * @return bool|void|\Exception */ public function updateItems($data) { @@ -286,9 +281,8 @@ class Cart /** * Get cart item by product * - * @param array $data - * - * @return CartItem|void + * @param array $data + * @return \Webkul\Checkout\Contracts\CartItem|void */ public function getItemByProduct($data) { @@ -310,9 +304,8 @@ class Cart /** * Remove the item from the cart * - * @param integer $itemId - * - * @return boolean + * @param int $itemId + * @return bool */ public function removeItem($itemId) { @@ -342,7 +335,7 @@ class Cart /** * This function handles when guest has some of cart products and then logs in. * - * @return boolean + * @return bool */ public function mergeCart() { @@ -425,8 +418,7 @@ class Cart /** * Save cart * - * @param Cart $cart - * + * @param \Webkul\Checkout\Contracts\Cart $cart * @return void */ public function putCart($cart) @@ -439,7 +431,7 @@ class Cart /** * Returns cart * - * @return Cart|null + * @return \Webkul\Checkout\Contracts\Cart|null */ public function getCart() { @@ -486,9 +478,8 @@ class Cart /** * Save customer address * - * @param array $data - * - * @return boolean + * @param array $data + * @return bool */ public function saveCustomerAddress($data) { @@ -602,9 +593,8 @@ class Cart /** * Save shipping method for cart * - * @param string $shippingMethodCode - * - * @return boolean + * @param string $shippingMethodCode + * @return bool */ public function saveShippingMethod($shippingMethodCode) { @@ -621,9 +611,8 @@ class Cart /** * Save payment method for cart * - * @param string $payment - * - * @return CartPayment + * @param string $payment + * @return \Webkul\Checkout\Contracts\CartPayment */ public function savePaymentMethod($payment) { @@ -710,7 +699,7 @@ class Cart /** * To validate if the product information is changed by admin and the items have been added to the cart before it. * - * @return boolean + * @return bool */ public function validateItems() { @@ -823,8 +812,8 @@ class Cart /** * Set Item tax to zero. * - * @param CartItem $item - * @return CartItem + * @param \Webkul\Checkout\Contracts\CartItem $item + * @return \Webkul\Checkout\Contracts\CartItem */ protected function setItemTaxToZero(CartItem $item): CartItem { @@ -838,7 +827,7 @@ class Cart /** * Checks if cart has any error * - * @return boolean + * @return bool */ public function hasError() { @@ -856,7 +845,7 @@ class Cart /** * Checks if all cart items have sufficient quantity. * - * @return boolean + * @return bool */ public function isItemsHaveSufficientQuantity() { @@ -872,9 +861,8 @@ class Cart /** * Checks if all cart items have sufficient quantity. * - * @param CartItem $item - * - * @return boolean + * @param \Webkul\Checkout\Contracts\CartItem $item + * @return bool */ public function isItemHaveQuantity($item) { @@ -957,8 +945,7 @@ class Cart /** * Prepares data for order item * - * @param array $data - * + * @param array $data * @return array */ public function prepareDataForOrderItem($data) @@ -998,9 +985,8 @@ class Cart /** * Move a wishlist item to cart * - * @param WishlistItem $wishlistItem - * - * @return boolean + * @param \Webkul\Customer\Contracts\WishlistItem $wishlistItem + * @return bool */ public function moveToCart($wishlistItem) { @@ -1028,9 +1014,8 @@ class Cart /** * Function to move a already added product to wishlist will run only on customer authentication. * - * @param integer $itemId - * - * @return boolean|void + * @param int $itemId + * @return bool */ public function moveToWishlist($itemId) { @@ -1084,9 +1069,8 @@ class Cart /** * Set coupon code to the cart * - * @param string $code - * - * @return Cart + * @param string $code + * @return \Webkul\Checkout\Contracts\Cart */ public function setCouponCode($code) { @@ -1102,7 +1086,7 @@ class Cart /** * Remove coupon code from cart * - * @return Cart + * @return \Webkul\Checkout\Contracts\Cart */ public function removeCouponCode() { diff --git a/packages/Webkul/Checkout/src/Listeners/CustomerEventsHandler.php b/packages/Webkul/Checkout/src/Listeners/CustomerEventsHandler.php index 9aa1af366..a72116f26 100755 --- a/packages/Webkul/Checkout/src/Listeners/CustomerEventsHandler.php +++ b/packages/Webkul/Checkout/src/Listeners/CustomerEventsHandler.php @@ -22,7 +22,7 @@ class CustomerEventsHandler { /** * Register the listeners for the subscriber. * - * @param Illuminate\Events\Dispatcher $events + * @param \Illuminate\Events\Dispatcher $events * @return void */ public function subscribe($events) diff --git a/packages/Webkul/Checkout/src/Repositories/CartItemRepository.php b/packages/Webkul/Checkout/src/Repositories/CartItemRepository.php index 2c33af0b9..0fae0dfd2 100755 --- a/packages/Webkul/Checkout/src/Repositories/CartItemRepository.php +++ b/packages/Webkul/Checkout/src/Repositories/CartItemRepository.php @@ -25,12 +25,11 @@ class CartItemRepository extends Repository } /** - * @param array $data - * @param $id - * @param string $attribute - * @return mixed + * @param array $data + * @param int $id + * @param string $attribute + * @return \Webkul\Checkout\Contracts\CartItem */ - public function update(array $data, $id, $attribute = "id") { $item = $this->find($id); @@ -40,6 +39,10 @@ class CartItemRepository extends Repository return $item; } + /** + * @param int $cartItemId + * @return int + */ public function getProduct($cartItemId) { return $this->model->find($cartItemId)->product->id; diff --git a/packages/Webkul/Checkout/src/Repositories/CartRepository.php b/packages/Webkul/Checkout/src/Repositories/CartRepository.php index 1b6805df9..357a461bf 100755 --- a/packages/Webkul/Checkout/src/Repositories/CartRepository.php +++ b/packages/Webkul/Checkout/src/Repositories/CartRepository.php @@ -25,10 +25,9 @@ class CartRepository extends Repository } /** - * @param array $data - * @return Mixed + * @param array $data + * @return \Webkul\Checkout\Contracts\Cart */ - public function create(array $data) { $cart = $this->model->create($data); @@ -37,10 +36,10 @@ class CartRepository extends Repository } /** - * @param array $data - * @param $id - * @param string $attribute - * @return Mixed + * @param array $data + * @param int $id + * @param string $attribute + * @return \Webkul\Checkout\Contracts\Cart */ public function update(array $data, $id, $attribute = "id") { @@ -52,17 +51,14 @@ class CartRepository extends Repository } /** - * Method to detach - * associations. - * - * Use this only with - * guest cart only. - * - * @return Mixed + * Method to detach associations. Use this only with guest cart only. + * + * @param int $cartId + * @return bool */ - public function deleteParent($cart_id) { - $cart = $this->model->find($cart_id); + public function deleteParent($cartId) { + $cart = $this->model->find($cartId); - return $this->model->destroy($cart_id); + return $this->model->destroy($cartId); } } \ No newline at end of file diff --git a/packages/Webkul/Core/src/Core.php b/packages/Webkul/Core/src/Core.php index 30ce00867..5383b9f18 100755 --- a/packages/Webkul/Core/src/Core.php +++ b/packages/Webkul/Core/src/Core.php @@ -18,62 +18,62 @@ class Core /** * ChannelRepository class * - * @var mixed + * @var \Webkul\Core\Repositories\ChannelRepository */ protected $channelRepository; /** * CurrencyRepository class * - * @var mixed + * @var \Webkul\Core\Repositories\CurrencyRepository */ protected $currencyRepository; /** * ExchangeRateRepository class * - * @var mixed + * @var \Webkul\Core\Repositories\ExchangeRateRepository */ protected $exchangeRateRepository; /** * CountryRepository class * - * @var mixed + * @var \Webkul\Core\Repositories\CountryRepository */ protected $countryRepository; /** * CountryStateRepository class * - * @var mixed + * @var \Webkul\Core\Repositories\CountryStateRepository */ protected $countryStateRepository; /** * LocaleRepository class * - * @var mixed + * @var \Webkul\Core\Repositories\LocaleRepository */ protected $localeRepository; /** * CoreConfigRepository class * - * @var mixed + * @var \Webkul\Core\Repositories\CoreConfigRepository */ protected $coreConfigRepository; /** * Create a new instance. * - * @param Webkul\Core\Repositories\ChannelRepository $channelRepository - * @param Webkul\Core\Repositories\CurrencyRepository $currencyRepository - * @param Webkul\Core\Repositories\ExchangeRateRepository $exchangeRateRepository - * @param Webkul\Core\Repositories\CountryRepository $countryRepository - * @param Webkul\Core\Repositories\CountryStateRepository $countryStateRepository - * @param Webkul\Core\Repositories\LocaleRepository $localeRepository - * @param Webkul\Core\Repositories\CoreConfigRepository $coreConfigRepository + * @param \Webkul\Core\Repositories\ChannelRepository $channelRepository + * @param \Webkul\Core\Repositories\CurrencyRepository $currencyRepository + * @param \Webkul\Core\Repositories\ExchangeRateRepository $exchangeRateRepository + * @param \Webkul\Core\Repositories\CountryRepository $countryRepository + * @param \Webkul\Core\Repositories\CountryStateRepository $countryStateRepository + * @param \Webkul\Core\Repositories\LocaleRepository $localeRepository + * @param \Webkul\Core\Repositories\CoreConfigRepository $coreConfigRepository * * @return void */ @@ -105,7 +105,7 @@ class Core /** * Returns all channels * - * @return Collection + * @return \Illuminate\Support\Collection */ public function getAllChannels() { @@ -121,7 +121,7 @@ class Core /** * Returns currenct channel models * - * @return mixed + * @return \Webkul\Core\Contracts\Channel */ public function getCurrentChannel() { @@ -147,7 +147,7 @@ class Core /** * Returns currenct channel code * - * @return string + * @return \Webkul\Core\Contracts\Channel */ public function getCurrentChannelCode(): string { @@ -163,7 +163,7 @@ class Core /** * Returns default channel models * - * @return null or Channel + * @return \Webkul\Core\Contracts\Channel */ public function getDefaultChannel(): ?Channel { @@ -201,7 +201,7 @@ class Core /** * Returns all locales * - * @return Collection + * @return \Illuminate\Support\Collection */ public function getAllLocales() { @@ -217,7 +217,7 @@ class Core /** * Returns current locale * - * @return Object + * @return \Webkul\Core\Contracts\Locale */ public function getCurrentLocale() { @@ -239,7 +239,7 @@ class Core /** * Returns all currencies * - * @return Collection + * @return \Illuminate\Support\Collection */ public function getAllCurrencies() { @@ -255,7 +255,7 @@ class Core /** * Returns base channel's currency model * - * @return mixed + * @return \Webkul\Core\Contracts\Currency */ public function getBaseCurrency() { @@ -293,7 +293,7 @@ class Core /** * Returns base channel's currency model * - * @return mixed + * @return \Webkul\Core\Contracts\Currency */ public function getChannelBaseCurrency() { @@ -327,7 +327,7 @@ class Core /** * Returns current channel's currency model * - * @return mixed + * @return \Webkul\Core\Contracts\Currency */ public function getCurrentCurrency() { @@ -365,10 +365,9 @@ class Core /** * Converts price * - * @param float $amount - * @param string $targetCurrencyCode - * @param string $orderCurrencyCode - * + * @param float $amount + * @param string $targetCurrencyCode + * @param string $orderCurrencyCode * @return string */ public function convertPrice($amount, $targetCurrencyCode = null, $orderCurrencyCode = null) @@ -419,9 +418,8 @@ class Core /** * Converts to base price * - * @param float $amount - * @param string $targetCurrencyCode - * + * @param float $amount + * @param string $targetCurrencyCode * @return string */ public function convertToBasePrice($amount, $targetCurrencyCode = null) @@ -448,8 +446,7 @@ class Core /** * Format and convert price with currency symbol * - * @param float $price - * + * @param float $price * @return string */ public function currency($amount = 0) @@ -464,8 +461,7 @@ class Core /** * Return currency symbol from currency code * - * @param float $price - * + * @param float $price * @return string */ public function currencySymbol($code) @@ -478,9 +474,8 @@ class Core /** * Format and convert price with currency symbol * - * @param float $price - * @param string $currencyCode - * + * @param float $price + * @param string $currencyCode * @return string */ public function formatPrice($price, $currencyCode) @@ -537,8 +532,7 @@ class Core /** * Format price with base currency symbol * - * @param float $price - * + * @param float $price * @return string */ public function formatBasePrice($price) @@ -565,10 +559,9 @@ class Core /** * Checks if current date of the given channel (in the channel timezone) is within the range * - * @param int|string|Channel $channel - * @param string|null $dateFrom - * @param string|null $dateTo - * + * @param int|string|\Webkul\Core\Contracts\Channel $channel + * @param string|null $dateFrom + * @param string|null $dateTo * @return bool */ public function isChannelDateInInterval($dateFrom = null, $dateTo = null) @@ -597,11 +590,9 @@ class Core } /** - * Get channel timestamp - * Timstamp will be builded with channel timezone settings - * - * @param mixed $channel + * Get channel timestamp, timstamp will be builded with channel timezone settings * + * @param \Webkul\Core\Contracts\Channel $channel * @return int */ public function channelTimeStamp($channel) @@ -622,9 +613,8 @@ class Core /** * Check whether sql date is empty * - * @param string $date - * - * @return boolean + * @param string $date + * @return bool */ function is_empty_date($date) { @@ -634,8 +624,8 @@ class Core /** * Format date using current channel. * - * @param date|null $date - * @param string $format + * @param \Illuminate\Support\Carbon|null $date + * @param string $format * * @return string */ @@ -655,8 +645,9 @@ class Core /** * Retrieve information from payment configuration * - * @param string $field - * @param int|string|null $channelId + * @param string $field + * @param int|string|null $channelId + * @param string|null $locale * * @return mixed */ @@ -711,7 +702,9 @@ class Core if (! $coreConfigValue) { $fields = explode(".", $field); + array_shift($fields); + $field = implode(".", $fields); return Config::get($field); @@ -723,7 +716,8 @@ class Core /** * Retrieve a group of information from the core config table * - * @return array + * @param mixed $criteria + * @return mixed */ public function retrieveGroupConfig($criteria) { @@ -733,7 +727,7 @@ class Core /** * Retrieve all countries * - * @return Collection + * @return \Illuminate\Support\Collection */ public function countries() { @@ -743,8 +737,7 @@ class Core /** * Returns country name by code * - * @param string $code - * + * @param string $code * @return string */ public function country_name($code) @@ -757,7 +750,8 @@ class Core /** * Retrieve all country states * - * @return Collection + * @param string $countryCode + * @return \Illuminate\Support\Collection */ public function states($countryCode) { @@ -767,7 +761,7 @@ class Core /** * Retrieve all grouped states by country code * - * @return Collection + * @return \Illuminate\Support\Collection */ public function groupedStatesByCountries() { @@ -783,7 +777,7 @@ class Core /** * Retrieve all grouped states by country code * - * @return Collection + * @return \Illuminate\Support\Collection */ public function findStateByCountryCode($countryCode = null, $stateCode = null) { @@ -801,6 +795,8 @@ class Core /** * Returns time intervals * + * @param \Illuminate\Support\Carbon $startDate + * @param \Illuminate\Support\Carbon $endDate * @return array */ public function getTimeInterval($startDate, $endDate) @@ -856,6 +852,9 @@ class Core } /** + * + * @param string $date + * @param int $day * @return string */ public function xWeekRange($date, $day) @@ -876,7 +875,8 @@ class Core /** * Method to sort through the acl items and put them in order * - * @return void + * @param array $items + * @return array */ public function sortItems($items) { @@ -898,8 +898,7 @@ class Core } /** - * @param string $fieldName - * + * @param string $fieldName * @return array */ public function getConfigField($fieldName) @@ -917,6 +916,10 @@ class Core } } + /** + * @param array $items + * @return array + */ public function convertToAssociativeArray($items) { foreach ($items as $key1 => $level1) { @@ -946,6 +949,12 @@ class Core return $items; } + /** + * @param array $items + * @param string $key + * @param string|int|float $value + * @return array + */ public function array_set(&$array, $key, $value) { if (is_null($key)) { @@ -976,6 +985,11 @@ class Core return $array; } + /** + * @param array $array1 + * @param array $array2 + * @return array + */ protected function arrayMerge(array &$array1, array &$array2) { $merged = $array1; @@ -991,6 +1005,10 @@ class Core return $merged; } + /** + * @param array $array1 + * @return array + */ public function convertEmptyStringsToNull($array) { foreach ($array as $key => $value) { @@ -1005,8 +1023,7 @@ class Core /** * Create singletom object through single facade * - * @param string $className - * + * @param string $className * @return object */ public function getSingletonInstance($className) @@ -1022,8 +1039,8 @@ class Core /** * Returns a string as selector part for identifying elements in views - * @param float $taxRate - * + * + * @param float $taxRate * @return string */ public static function taxRateAsIdentifier(float $taxRate): string diff --git a/packages/Webkul/Core/src/Eloquent/Repository.php b/packages/Webkul/Core/src/Eloquent/Repository.php index f274b2d62..74bc42d70 100755 --- a/packages/Webkul/Core/src/Eloquent/Repository.php +++ b/packages/Webkul/Core/src/Eloquent/Repository.php @@ -17,10 +17,9 @@ abstract class Repository extends BaseRepository { /** * Find data by field and value * - * @param $field - * @param $value - * @param array $columns - * + * @param string $field + * @param string $value + * @param array $columns * @return mixed */ public function findOneByField($field, $value = null, $columns = ['*']) @@ -33,10 +32,9 @@ abstract class Repository extends BaseRepository { /** * Find data by field and value * - * @param $field - * @param $value - * @param array $columns - * + * @param string $field + * @param string $value + * @param array $columns * @return mixed */ public function findOneWhere(array $where, $columns = ['*']) @@ -49,9 +47,8 @@ abstract class Repository extends BaseRepository { /** * Find data by id * - * @param $id - * @param array $columns - * + * @param int $id + * @param array $columns * @return mixed */ public function find($id, $columns = ['*']) @@ -67,9 +64,8 @@ abstract class Repository extends BaseRepository { /** * Find data by id * - * @param $id - * @param array $columns - * + * @param int $id + * @param array $columns * @return mixed */ public function findOrFail($id, $columns = ['*']) @@ -85,9 +81,8 @@ abstract class Repository extends BaseRepository { /** * Count results of repository * - * @param array $where - * @param string $columns - * + * @param array $where + * @param string $columns * @return int */ public function count(array $where = [], $columns = '*') @@ -107,6 +102,7 @@ abstract class Repository extends BaseRepository { } /** + * @param string $columns * @return mixed */ public function sum($columns) @@ -121,6 +117,7 @@ abstract class Repository extends BaseRepository { } /** + * @param string $columns * @return mixed */ public function avg($columns) diff --git a/packages/Webkul/Core/src/Eloquent/TranslatableModel.php b/packages/Webkul/Core/src/Eloquent/TranslatableModel.php index 985c1dd97..afffe3458 100755 --- a/packages/Webkul/Core/src/Eloquent/TranslatableModel.php +++ b/packages/Webkul/Core/src/Eloquent/TranslatableModel.php @@ -17,8 +17,7 @@ class TranslatableModel extends Model } /** - * @param string $key - * + * @param string $key * @return bool */ protected function isKeyALocale($key) @@ -53,7 +52,7 @@ class TranslatableModel extends Model } /** - * @return boolean + * @return bool */ protected function isChannelBased() { diff --git a/packages/Webkul/Core/src/Helpers/Exchange/FixerExchange.php b/packages/Webkul/Core/src/Helpers/Exchange/FixerExchange.php index 172e39a65..c68ffabb4 100644 --- a/packages/Webkul/Core/src/Helpers/Exchange/FixerExchange.php +++ b/packages/Webkul/Core/src/Helpers/Exchange/FixerExchange.php @@ -9,19 +9,30 @@ class FixerExchange extends ExchangeRate { /** * API key + * + * @var string */ protected $apiKey; /** * API endpoint + * + * @var string */ protected $apiEndPoint; /** * Holds ExchangeRateRepository instance + * + * @var \Webkul\Core\Helpers\Exchange\ExchangeRate */ protected $exchangeRate; + /** + * Create a new helper instance. + * + * @return void + */ public function __construct() { $this->apiKey = config('services.exchange-api')['fixer']['key']; @@ -29,6 +40,9 @@ class FixerExchange extends ExchangeRate $this->apiEndPoint = 'http://data.fixer.io/api/latest?access_key=' . $this->apiKey; } + /** + * @return array + */ public function fetchRates() { $rates = array(); diff --git a/packages/Webkul/Core/src/Helpers/Laravel5Helper.php b/packages/Webkul/Core/src/Helpers/Laravel5Helper.php index 22fc99438..4a0044597 100644 --- a/packages/Webkul/Core/src/Helpers/Laravel5Helper.php +++ b/packages/Webkul/Core/src/Helpers/Laravel5Helper.php @@ -22,8 +22,7 @@ class Laravel5Helper extends Laravel5 /** * Returns field name of given attribute. * - * @param string $attribute - * + * @param string $attribute * @return string|null * @part ORM */ @@ -69,10 +68,9 @@ class Laravel5Helper extends Laravel5 /** * Helper function to generate products for testing * - * @param int $productType - * @param array $configs - * @param array $productStates - * + * @param int $productType + * @param array $configs + * @param array $productStates * @return \Webkul\Product\Models\Product * @part ORM */ @@ -104,10 +102,9 @@ class Laravel5Helper extends Laravel5 } /** - * @param array $configs - * @param array $productStates - * - * @return \Webkul\Product\Models\Product + * @param array $configs + * @param array $productStates + * @return \Webkul\Product\Contracts\Product */ private function haveSimpleProduct(array $configs = [], array $productStates = []): Product { @@ -128,10 +125,9 @@ class Laravel5Helper extends Laravel5 } /** - * @param array $configs - * @param array $productStates - * - * @return \Webkul\Product\Models\Product + * @param array $configs + * @param array $productStates + * @return \Webkul\Product\Contracts\Product */ private function haveVirtualProduct(array $configs = [], array $productStates = []): Product { @@ -152,10 +148,9 @@ class Laravel5Helper extends Laravel5 } /** - * @param array $configs - * @param array $productStates - * - * @return \Webkul\Product\Models\Product + * @param array $configs + * @param array $productStates + * @return \Webkul\Product\Contracts\Product */ private function haveDownloadableProduct(array $configs = [], array $productStates = []): Product { @@ -187,8 +182,9 @@ class Laravel5Helper extends Laravel5 } /** - * @param int $productId - * @param array $inventoryConfig + * @param int $productId + * @param array $inventoryConfig + * @return void */ private function createInventory(int $productId, array $inventoryConfig = []): void { @@ -201,7 +197,8 @@ class Laravel5Helper extends Laravel5 } /** - * @param int $productId + * @param int $productId + * @return void */ private function createDownloadableLink(int $productId): void { @@ -217,8 +214,9 @@ class Laravel5Helper extends Laravel5 } /** - * @param int $productId - * @param array $attributeValues + * @param int $productId + * @param array $attributeValues + * @return void */ private function createAttributeValues(int $productId, array $attributeValues = []): void { diff --git a/packages/Webkul/Core/src/Helpers/Locales.php b/packages/Webkul/Core/src/Helpers/Locales.php index 7aede9c52..9ce84623d 100644 --- a/packages/Webkul/Core/src/Helpers/Locales.php +++ b/packages/Webkul/Core/src/Helpers/Locales.php @@ -6,6 +6,9 @@ use Astrotomic\Translatable\Locales as BaseLocales; class Locales extends BaseLocales { + /** + * @return void + */ public function load(): void { $this->locales = []; diff --git a/packages/Webkul/Core/src/Http/Controllers/ChannelController.php b/packages/Webkul/Core/src/Http/Controllers/ChannelController.php index e41b78674..5f933fd73 100755 --- a/packages/Webkul/Core/src/Http/Controllers/ChannelController.php +++ b/packages/Webkul/Core/src/Http/Controllers/ChannelController.php @@ -23,14 +23,14 @@ class ChannelController extends Controller /** * ChannelRepository object * - * @var Object + * @var \Webkul\Core\Repositories\ChannelRepository */ protected $channelRepository; /** * Create a new controller instance. * - * @param \Webkul\Core\Repositories\ChannelRepository $channelRepository + * @param \Webkul\Core\Repositories\ChannelRepository $channelRepository * @return void */ public function __construct(ChannelRepository $channelRepository) diff --git a/packages/Webkul/Core/src/Http/Controllers/CountryStateController.php b/packages/Webkul/Core/src/Http/Controllers/CountryStateController.php index b3a933701..dcf5b75db 100755 --- a/packages/Webkul/Core/src/Http/Controllers/CountryStateController.php +++ b/packages/Webkul/Core/src/Http/Controllers/CountryStateController.php @@ -23,22 +23,22 @@ class CountryStateController extends Controller /** * CountryRepository object * - * @var array + * @var \Webkul\Core\Repositories\CountryRepository */ protected $countryRepository; /** * CountryStateRepository object * - * @var array + * @var Webkul\Core\Repositories\CountryStateRepository */ protected $countryStateRepository; /** * Create a new controller instance. * - * @param \Webkul\Core\Repositories\CountryRepository $countryRepository - * @param \Webkul\Core\Repositories\CountryStateRepository $countryStateRepository + * @param \Webkul\Core\Repositories\CountryRepository $countryRepository + * @param \Webkul\Core\Repositories\CountryStateRepository $countryStateRepository * @return void */ public function __construct( @@ -77,6 +77,10 @@ class CountryStateController extends Controller return view($this->_config['view'])->with('statesCountries', $nestedArray); } + /** + * + * @return \Illuminate\View\View + */ public function getStates($country) { $countries = $this->countryRepository->all(); diff --git a/packages/Webkul/Core/src/Http/Controllers/CurrencyController.php b/packages/Webkul/Core/src/Http/Controllers/CurrencyController.php index 0e0323522..023b35270 100755 --- a/packages/Webkul/Core/src/Http/Controllers/CurrencyController.php +++ b/packages/Webkul/Core/src/Http/Controllers/CurrencyController.php @@ -23,14 +23,14 @@ class CurrencyController extends Controller /** * CurrencyRepository object * - * @var array + * @var \Webkul\Core\Repositories\CurrencyRepository */ protected $currencyRepository; /** * Create a new controller instance. * - * @param \Webkul\Core\Repositories\CurrencyRepository $currencyRepository + * @param \Webkul\Core\Repositories\CurrencyRepository $currencyRepository * @return void */ public function __construct(CurrencyRepository $currencyRepository) @@ -155,9 +155,10 @@ class CurrencyController extends Controller /** * Remove the specified resources from database * - * @return response \Illuminate\Http\Response + * @return \Illuminate\Http\Response */ - public function massDestroy() { + public function massDestroy() + { $suppressFlash = false; if (request()->isMethod('post')) { diff --git a/packages/Webkul/Core/src/Http/Controllers/ExchangeRateController.php b/packages/Webkul/Core/src/Http/Controllers/ExchangeRateController.php index 562a40103..e47240412 100755 --- a/packages/Webkul/Core/src/Http/Controllers/ExchangeRateController.php +++ b/packages/Webkul/Core/src/Http/Controllers/ExchangeRateController.php @@ -24,22 +24,22 @@ class ExchangeRateController extends Controller /** * ExchangeRateRepository instance * - * @var Object + * @var \Webkul\Core\Repositories\ExchangeRateRepository */ protected $exchangeRateRepository; /** * CurrencyRepository object * - * @var Object + * @var \Webkul\Core\Repositories\CurrencyRepository */ protected $currencyRepository; /** * Create a new controller instance. * - * @param \Webkul\Core\Repositories\ExchangeRateRepository $exchangeRateRepository - * @param \Webkul\Core\Repositories\CurrencyRepository $currencyRepository + * @param \Webkul\Core\Repositories\ExchangeRateRepository $exchangeRateRepository + * @param \Webkul\Core\Repositories\CurrencyRepository $currencyRepository * @return void */ public function __construct( @@ -143,6 +143,7 @@ class ExchangeRateController extends Controller /** * Update Rates Using Exchange Rates API * + * @param string $service * @return \Illuminate\Http\JsonResponse */ public function updateRates($service) diff --git a/packages/Webkul/Core/src/Http/Controllers/LocaleController.php b/packages/Webkul/Core/src/Http/Controllers/LocaleController.php index f3754bac8..55b6dfe51 100755 --- a/packages/Webkul/Core/src/Http/Controllers/LocaleController.php +++ b/packages/Webkul/Core/src/Http/Controllers/LocaleController.php @@ -23,14 +23,14 @@ class LocaleController extends Controller /** * LocaleRepository object * - * @var array + * @var \Webkul\Core\Repositories\LocaleRepository */ protected $localeRepository; /** * Create a new controller instance. * - * @param \Webkul\Core\Repositories\LocaleRepository $localeRepository + * @param \Webkul\Core\Repositories\LocaleRepository $localeRepository * @return void */ public function __construct(LocaleRepository $localeRepository) diff --git a/packages/Webkul/Core/src/Http/Controllers/SliderController.php b/packages/Webkul/Core/src/Http/Controllers/SliderController.php index 578962224..1300897cb 100755 --- a/packages/Webkul/Core/src/Http/Controllers/SliderController.php +++ b/packages/Webkul/Core/src/Http/Controllers/SliderController.php @@ -22,7 +22,7 @@ class SliderController extends Controller /** * SliderRepository * - * @var Object + * @var \Webkul\Core\Repositories\SliderRepository */ protected $sliderRepository; @@ -34,7 +34,7 @@ class SliderController extends Controller /** * Create a new controller instance. * - * @param \Webkul\Core\Repositories\SliderRepository $sliderRepository + * @param \Webkul\Core\Repositories\SliderRepository $sliderRepository * @return void */ public function __construct(SliderRepository $sliderRepository) @@ -69,7 +69,7 @@ class SliderController extends Controller /** * Creates the new sider item. * - * @return response + * @return \Illuminate\Http\Response */ public function store() { @@ -81,10 +81,11 @@ class SliderController extends Controller $result = $this->sliderRepository->save(request()->all()); - if ($result) + if ($result) { session()->flash('success', trans('admin::app.settings.sliders.created-success')); - else + } else { session()->flash('success', trans('admin::app.settings.sliders.created-fail')); + } return redirect()->route($this->_config['redirect']); } @@ -104,7 +105,8 @@ class SliderController extends Controller /** * Edit the previously created slider item. * - * @return response + * @param int $id + * @return \Illuminate\Http\Response */ public function update($id) { @@ -134,7 +136,8 @@ class SliderController extends Controller /** * Delete a slider item and preserve the last one from deleting * - * @return mixed + * @param int $id + * @return \Illuminate\Http\Response */ public function destroy($id) { diff --git a/packages/Webkul/Core/src/Http/Controllers/SubscriptionController.php b/packages/Webkul/Core/src/Http/Controllers/SubscriptionController.php index c1fb07f5b..eae51332d 100755 --- a/packages/Webkul/Core/src/Http/Controllers/SubscriptionController.php +++ b/packages/Webkul/Core/src/Http/Controllers/SubscriptionController.php @@ -24,14 +24,14 @@ class SubscriptionController extends Controller /** * SubscribersListRepository * - * @var Object + * @var \Webkul\Core\Repositories\SubscribersListRepository */ protected $subscribersListRepository; /** * Create a new controller instance. * - * @param \Webkul\Core\Repositories\SubscribersListRepository $subscribersListRepository + * @param \Webkul\Core\Repositories\SubscribersListRepository $subscribersListRepository * @return void */ public function __construct(SubscribersListRepository $subscribersListRepository) @@ -54,7 +54,7 @@ class SubscriptionController extends Controller /** * To unsubscribe the user without deleting the resource of the subscribed user * - * @param integer $id + * @param int $id * @return \Illuminate\View\View */ public function edit($id) @@ -67,8 +67,8 @@ class SubscriptionController extends Controller /** * To unsubscribe the user without deleting the resource of the subscribed user * - * @param integer $id - * @return mixed + * @param int $id + * @return \Illuminate\Http\Response */ public function update($id) { diff --git a/packages/Webkul/Core/src/Observers/SliderObserver.php b/packages/Webkul/Core/src/Observers/SliderObserver.php index caa6ad54e..d541f7042 100644 --- a/packages/Webkul/Core/src/Observers/SliderObserver.php +++ b/packages/Webkul/Core/src/Observers/SliderObserver.php @@ -9,7 +9,7 @@ class SliderObserver /** * Handle the Slider "deleted" event. * - * @param Slider $slider + * @param \Webkul\Core\Contracts\Slider $slider * @return void */ public function deleted($slider) diff --git a/packages/Webkul/Core/src/Repositories/ChannelRepository.php b/packages/Webkul/Core/src/Repositories/ChannelRepository.php index 6513e1cb2..6344faaf1 100755 --- a/packages/Webkul/Core/src/Repositories/ChannelRepository.php +++ b/packages/Webkul/Core/src/Repositories/ChannelRepository.php @@ -24,8 +24,8 @@ class ChannelRepository extends Repository } /** - * @param array $data - * @return mixed + * @param array $data + * @return \Webkul\Core\Contracts\Channel */ public function create(array $data) { @@ -45,10 +45,10 @@ class ChannelRepository extends Repository } /** - * @param array $data - * @param $id - * @param string $attribute - * @return mixed + * @param array $data + * @param int $id + * @param string $attribute + * @return \Webkul\Core\Contracts\Channel */ public function update(array $data, $id, $attribute = "id") { @@ -70,8 +70,9 @@ class ChannelRepository extends Repository } /** - * @param array $data - * @param mixed $channel + * @param array $data + * @param \Webkul\Core\Contratcs\Channel $channel + * @param string $type * @return void */ public function uploadImages($data, $channel, $type = "logo") diff --git a/packages/Webkul/Core/src/Repositories/CoreConfigRepository.php b/packages/Webkul/Core/src/Repositories/CoreConfigRepository.php index 1f0a78ed1..80d91ed8c 100755 --- a/packages/Webkul/Core/src/Repositories/CoreConfigRepository.php +++ b/packages/Webkul/Core/src/Repositories/CoreConfigRepository.php @@ -24,8 +24,8 @@ class CoreConfigRepository extends Repository } /** - * @param array $data - * @return mixed + * @param array $data + * @return \Webkul\Core\Contracts\CoreConfig */ public function create(array $data) { @@ -111,8 +111,8 @@ class CoreConfigRepository extends Repository } /** - * @param array $formData - * @param string $method + * @param array $formData + * @param string $method * @return array */ public function recuressiveArray(array $formData, $method) { @@ -150,9 +150,10 @@ class CoreConfigRepository extends Repository } /** - * return dimension of array - * @param array $array - * @return integer + * Return dimension of array + * + * @param array $array + * @return int */ public function countDim($array) { diff --git a/packages/Webkul/Core/src/Repositories/CurrencyRepository.php b/packages/Webkul/Core/src/Repositories/CurrencyRepository.php index 72b589ddb..37e2de594 100755 --- a/packages/Webkul/Core/src/Repositories/CurrencyRepository.php +++ b/packages/Webkul/Core/src/Repositories/CurrencyRepository.php @@ -22,6 +22,12 @@ class CurrencyRepository extends Repository return 'Webkul\Core\Contracts\Currency'; } + /** + * Specify Model class name + * + * @param int $id + * @return bool + */ public function delete($id) { if ($this->model->count() == 1) { return false; diff --git a/packages/Webkul/Core/src/Repositories/SliderRepository.php b/packages/Webkul/Core/src/Repositories/SliderRepository.php index c1b62445b..7c39342dd 100755 --- a/packages/Webkul/Core/src/Repositories/SliderRepository.php +++ b/packages/Webkul/Core/src/Repositories/SliderRepository.php @@ -20,14 +20,15 @@ class SliderRepository extends Repository /** * ChannelRepository object * - * @var Object + * @var \Webkul\Core\Repositories\ChannelRepository */ protected $channelRepository; /** * Create a new repository instance. * - * @param \Webkul\Core\Repositories\ChannelRepository $channelRepository + * @param \Webkul\Core\Repositories\ChannelRepository $channelRepository + * @param \Illuminate\Container\Container $channelRepository * @return void */ public function __construct( @@ -51,8 +52,8 @@ class SliderRepository extends Repository } /** - * @param array $data - * @return mixed + * @param array $data + * @return \Webkul\Core\Contracts\Slider */ public function save(array $data) { @@ -94,8 +95,8 @@ class SliderRepository extends Repository } /** - * @param array $data - * @return mixed + * @param array $data + * @return bool */ public function updateItem(array $data, $id) { @@ -139,7 +140,8 @@ class SliderRepository extends Repository /** * Delete a slider item and delete the image from the disk or where ever it is * - * @return Boolean + * @param int $id + * @return bool */ public function destroy($id) { diff --git a/packages/Webkul/Core/src/Repositories/SubscribersListRepository.php b/packages/Webkul/Core/src/Repositories/SubscribersListRepository.php index f85319fc8..cdec7d072 100755 --- a/packages/Webkul/Core/src/Repositories/SubscribersListRepository.php +++ b/packages/Webkul/Core/src/Repositories/SubscribersListRepository.php @@ -23,11 +23,11 @@ class SubscribersListRepository extends Repository return 'Webkul\Core\Contracts\SubscribersList'; } - /** * Delete a slider item and delete the image from the disk or where ever it is * - * @return Boolean + * @param int $id + * @return bool */ public function destroy($id) { return $this->model->destroy($id); diff --git a/packages/Webkul/Core/src/Tree.php b/packages/Webkul/Core/src/Tree.php index 9003a47df..ac1889694 100755 --- a/packages/Webkul/Core/src/Tree.php +++ b/packages/Webkul/Core/src/Tree.php @@ -45,7 +45,8 @@ class Tree { * * @return void */ - public function __construct() { + public function __construct() + { $this->current = Request::url(); } @@ -53,10 +54,11 @@ class Tree { * Shortcut method for create a Config with a callback. * This will allow you to do things like fire an event on creation. * - * @param callable $callback Callback to use after the Config creation + * @param callable $callback Callback to use after the Config creation * @return object */ - public static function create($callback = null) { + public static function create($callback = null) + { $tree = new Tree(); if ($callback) { @@ -69,7 +71,8 @@ class Tree { /** * Add a Config item to the item stack * - * @param string $item Dot seperated heirarchy + * @param string $item + * @return void */ public function add($item, $type = '') { @@ -83,20 +86,20 @@ class Tree { } } elseif ($type == 'acl') { $item['name'] = trans($item['name']); + $this->roles[$item['route']] = $item['key']; } $children = str_replace('.', '.children.', $item['key']); core()->array_set($this->items, $children, $item); - } /** * Method to find the active links * - * @param array $item Item that needs to be checked if active - * @return string + * @param array $item + * @return string|void */ public function getActive($item) { diff --git a/packages/Webkul/Customer/src/Helpers/Wishlist.php b/packages/Webkul/Customer/src/Helpers/Wishlist.php index 935baa377..039b54c40 100644 --- a/packages/Webkul/Customer/src/Helpers/Wishlist.php +++ b/packages/Webkul/Customer/src/Helpers/Wishlist.php @@ -9,14 +9,14 @@ class Wishlist /** * WishlistRepository object * - * @var array + * @var \Webkul\Customer\Repositories\WishlistRepository */ protected $wishlistRepository; /** * Create a new controller instance. * - * @param Webkul\Customer\Repositories\WishlistRepository + * @param \Webkul\Customer\Repositories\WishlistRepository * @return void */ public function __construct(WishlistRepository $wishlistRepository) @@ -27,7 +27,7 @@ class Wishlist /** * Returns wishlist products for current customer. * - * @param Product $product + * @param \Webkul\Product\Contracts\Product $product * @return boolean */ public function getWishlistProduct($product) diff --git a/packages/Webkul/Customer/src/Http/Controllers/AddressController.php b/packages/Webkul/Customer/src/Http/Controllers/AddressController.php index c63d5e4f4..29842c8f3 100755 --- a/packages/Webkul/Customer/src/Http/Controllers/AddressController.php +++ b/packages/Webkul/Customer/src/Http/Controllers/AddressController.php @@ -27,12 +27,16 @@ class AddressController extends Controller /** * CustomerAddressRepository object * - * @param \Webkul\Customer\Repositories\CustomerAddressRepository $customerAddressRepository - * - * @var Object + * @var \Webkul\Customer\Repositories\CustomerAddressRepository */ protected $customerAddressRepository; + /** + * Create a new controller instance. + * + * @param \Webkul\Customer\Repositories\CustomerAddressRepository $customerAddressRepository + * @return void + */ public function __construct(CustomerAddressRepository $customerAddressRepository) { $this->middleware('customer'); @@ -126,17 +130,16 @@ class AddressController extends Controller abort(404); } - return view($this->_config['view'], array_merge( - compact('address'), - ['defaultCountry' => config('app.default_country')] - )); + return view($this->_config['view'], array_merge(compact('address'), [ + 'defaultCountry' => config('app.default_country') + ])); } /** - * Edit's the premade resource of customer called - * Address. + * Edit's the premade resource of customer called Address. * - * @return redirect + * @param int $id + * @return \Illuminate\Http\Response */ public function update($id) { @@ -175,10 +178,10 @@ class AddressController extends Controller } /** - * To change the default address or make the default address, by default when first address is - * created will be the default address + * To change the default address or make the default address, + * by default when first address is created will be the default address * - * @return Response + * @return \Illuminate\Http\Response */ public function makeDefault($id) { @@ -198,9 +201,8 @@ class AddressController extends Controller /** * Delete address of the current customer * - * @param integer $id - * - * @return response mixed + * @param int $id + * @return \Illuminate\Http\Response */ public function destroy($id) { diff --git a/packages/Webkul/Customer/src/Http/Controllers/CustomerController.php b/packages/Webkul/Customer/src/Http/Controllers/CustomerController.php index 614e4d1e7..a7c472d7f 100755 --- a/packages/Webkul/Customer/src/Http/Controllers/CustomerController.php +++ b/packages/Webkul/Customer/src/Http/Controllers/CustomerController.php @@ -25,26 +25,28 @@ class CustomerController extends Controller /** * CustomerRepository object * - * @var Object + * @var \Webkul\Customer\Repositories\CustomerRepository */ protected $customerRepository; /** * ProductReviewRepository object * - * @var array + * @var \Webkul\Customer\Repositories\ProductReviewRepository */ protected $productReviewRepository; /** * Create a new controller instance. * - * @param \Webkul\Customer\Repositories\CustomerRepository $customer - * @param \Webkul\Product\Repositories\ProductReviewRepository $productReview - * + * @param \Webkul\Customer\Repositories\CustomerRepository $customer + * @param \Webkul\Product\Repositories\ProductReviewRepository $productReview * @return void */ - public function __construct(CustomerRepository $customerRepository, ProductReviewRepository $productReviewRepository) + public function __construct( + CustomerRepository $customerRepository, + ProductReviewRepository $productReviewRepository + ) { $this->middleware('customer'); @@ -82,7 +84,7 @@ class CustomerController extends Controller /** * Edit function for editing customer profile. * - * @return response + * @return \Illuminate\Http\Response */ public function update() { @@ -133,8 +135,7 @@ class CustomerController extends Controller /** * Remove the specified resource from storage. * - * @param int $id - * + * @param int $id * @return \Illuminate\Http\Response */ public function destroy($id) diff --git a/packages/Webkul/Customer/src/Http/Controllers/RegistrationController.php b/packages/Webkul/Customer/src/Http/Controllers/RegistrationController.php index 1ebe18272..0221dc719 100755 --- a/packages/Webkul/Customer/src/Http/Controllers/RegistrationController.php +++ b/packages/Webkul/Customer/src/Http/Controllers/RegistrationController.php @@ -30,22 +30,22 @@ class RegistrationController extends Controller /** * CustomerRepository object * - * @var Object + * @var \Webkul\Customer\Repositories\CustomerRepository */ protected $customerRepository; /** * CustomerGroupRepository object * - * @var Object + * @var \Webkul\Customer\Repositories\CustomerGroupRepository */ protected $customerGroupRepository; /** * Create a new Repository instance. * - * @param \Webkul\Customer\Repositories\CustomerRepository $customer - * @param \Webkul\Customer\Repositories\CustomerGroupRepository $customerGroupRepository + * @param \Webkul\Customer\Repositories\CustomerRepository $customer + * @param \Webkul\Customer\Repositories\CustomerGroupRepository $customerGroupRepository * * @return void */ @@ -74,7 +74,7 @@ class RegistrationController extends Controller /** * Method to store user's sign up form data to DB. * - * @return Response + * @return \Illuminate\Http\Response */ public function create() { @@ -148,7 +148,8 @@ class RegistrationController extends Controller /** * Method to verify account * - * @param string $token + * @param string $token + * @return \Illuminate\Http\Response */ public function verifyAccount($token) { @@ -165,6 +166,10 @@ class RegistrationController extends Controller return redirect()->route('customer.session.index'); } + /** + * @param string $email + * @return \Illuminate\Http\Response + */ public function resendVerificationEmail($email) { $verificationData['email'] = $email; diff --git a/packages/Webkul/Customer/src/Http/Controllers/WishlistController.php b/packages/Webkul/Customer/src/Http/Controllers/WishlistController.php index a8c80ce04..d679094a1 100755 --- a/packages/Webkul/Customer/src/Http/Controllers/WishlistController.php +++ b/packages/Webkul/Customer/src/Http/Controllers/WishlistController.php @@ -25,22 +25,22 @@ class WishlistController extends Controller /** * ProductRepository object * - * @var Object + * @var \Webkul\Customer\Repositories\WishlistRepository */ protected $wishlistRepository; /** * WishlistRepository object * - * @var Object + * @var \Webkul\Product\Repositories\ProductRepository */ protected $productRepository; /** * Create a new controller instance. * - * @param \Webkul\Customer\Repositories\WishlistRepository $wishlistRepository - * @param \Webkul\Product\Repositories\ProductRepository $productRepository + * @param \Webkul\Customer\Repositories\WishlistRepository $wishlistRepository + * @param \Webkul\Product\Repositories\ProductRepository $productRepository * @return void */ public function __construct( @@ -72,7 +72,8 @@ class WishlistController extends Controller /** * Function to add item to the wishlist. * - * @param integer $itemId + * @param int $itemId + * @return \Illuminate\Http\Response */ public function add($itemId) { @@ -123,7 +124,8 @@ class WishlistController extends Controller /** * Function to remove item to the wishlist. * - * @param integer $itemId + * @param int $itemId + * @return \Illuminate\Http\Response */ public function remove($itemId) { @@ -147,7 +149,8 @@ class WishlistController extends Controller /** * Function to move item from wishlist to cart. * - * @param integer $itemId + * @param int $itemId + * @return \Illuminate\Http\Response */ public function move($itemId) { @@ -174,6 +177,7 @@ class WishlistController extends Controller return redirect()->back(); } catch (\Exception $e) { report($e); + session()->flash('warning', $e->getMessage()); return redirect()->route('shop.productOrCategory.index', $wishlistItem->product->url_key); @@ -183,7 +187,7 @@ class WishlistController extends Controller /** * Function to remove all of the items items in the customer's wishlist * - * @return Mixed Response & Boolean + * @return \Illuminate\Http\Response */ public function removeAll() { diff --git a/packages/Webkul/Customer/src/Http/Middleware/RedirectIfNotCustomer.php b/packages/Webkul/Customer/src/Http/Middleware/RedirectIfNotCustomer.php index 310ef5da6..5911b3c79 100755 --- a/packages/Webkul/Customer/src/Http/Middleware/RedirectIfNotCustomer.php +++ b/packages/Webkul/Customer/src/Http/Middleware/RedirectIfNotCustomer.php @@ -11,8 +11,8 @@ class RedirectIfNotCustomer * Handle an incoming request. * * @param \Illuminate\Http\Request $request - * @param \Closure $next - * @param string|null $guard + * @param \Closure $next + * @param string|null $guard * @return mixed */ public function handle($request, Closure $next, $guard = 'customer') diff --git a/packages/Webkul/Customer/src/Mail/RegistrationEmail.php b/packages/Webkul/Customer/src/Mail/RegistrationEmail.php index 9a89d4c61..8521fcd78 100644 --- a/packages/Webkul/Customer/src/Mail/RegistrationEmail.php +++ b/packages/Webkul/Customer/src/Mail/RegistrationEmail.php @@ -17,9 +17,19 @@ class RegistrationEmail extends Mailable { use Queueable, SerializesModels; + /** + * @var array + */ public $data; - public function __construct($data) { + /** + * Create a new mailable instance. + * + * @param array $data + * @return void + */ + public function __construct($data) + { $this->data = $data; } diff --git a/packages/Webkul/Customer/src/Mail/VerificationEmail.php b/packages/Webkul/Customer/src/Mail/VerificationEmail.php index 23ebb05a4..76349ee2a 100755 --- a/packages/Webkul/Customer/src/Mail/VerificationEmail.php +++ b/packages/Webkul/Customer/src/Mail/VerificationEmail.php @@ -17,9 +17,19 @@ class VerificationEmail extends Mailable { use Queueable, SerializesModels; + /** + * @var array + */ public $verificationData; - public function __construct($verificationData) { + /** + * Create a new mailable instance. + * + * @param array $verificationData + * @return void + */ + public function __construct($verificationData) + { $this->verificationData = $verificationData; } diff --git a/packages/Webkul/Customer/src/Repositories/CustomerAddressRepository.php b/packages/Webkul/Customer/src/Repositories/CustomerAddressRepository.php index 6fd6f81ad..c5e336ff6 100755 --- a/packages/Webkul/Customer/src/Repositories/CustomerAddressRepository.php +++ b/packages/Webkul/Customer/src/Repositories/CustomerAddressRepository.php @@ -18,16 +18,14 @@ class CustomerAddressRepository extends Repository * * @return mixed */ - function model() { return 'Webkul\Customer\Contracts\CustomerAddress'; } /** - * @param array $data - * - * @return mixed + * @param array $data + * @return \Webkul\Customer\Contracts\CustomerAddress */ public function create(array $data) { @@ -51,10 +49,9 @@ class CustomerAddressRepository extends Repository } /** - * @param array $data - * @param $id - * - * @return mixed + * @param array $data + * @param int $id + * @return \Webkul\Customer\Contracts\CustomerAddress */ public function update(array $data, $id) { diff --git a/packages/Webkul/Customer/src/Repositories/CustomerGroupRepository.php b/packages/Webkul/Customer/src/Repositories/CustomerGroupRepository.php index ea5b06c80..d04c2d822 100755 --- a/packages/Webkul/Customer/src/Repositories/CustomerGroupRepository.php +++ b/packages/Webkul/Customer/src/Repositories/CustomerGroupRepository.php @@ -25,10 +25,9 @@ class CustomerGroupRepository extends Repository } /** - * @param array $data - * @return mixed + * @param array $data + * @return \Webkul\Customer\Contracts\CustomerGroup */ - public function create(array $data) { $customer = $this->model->create($data); @@ -37,12 +36,11 @@ class CustomerGroupRepository extends Repository } /** - * @param array $data - * @param $id - * @param string $attribute - * @return mixed + * @param array $data + * @param int $id + * @param string $id + * @return \Webkul\Customer\Contracts\CustomerGroup */ - public function update(array $data, $id, $attribute = "id") { $customer = $this->find($id); diff --git a/packages/Webkul/Customer/src/Repositories/WishlistRepository.php b/packages/Webkul/Customer/src/Repositories/WishlistRepository.php index 2c678657a..5fc6ddb45 100755 --- a/packages/Webkul/Customer/src/Repositories/WishlistRepository.php +++ b/packages/Webkul/Customer/src/Repositories/WishlistRepository.php @@ -25,10 +25,9 @@ class WishlistRepository extends Repository } /** - * @param array $data - * @return mixed + * @param array $data + * @return \Webkul\Customer\Contracts\Wishlist */ - public function create(array $data) { $wishlist = $this->model->create($data); @@ -37,12 +36,11 @@ class WishlistRepository extends Repository } /** - * @param array $data - * @param $id - * @param string $attribute - * @return mixed + * @param array $data + * @param int $id + * @param string $attribute + * @return \Webkul\Customer\Contracts\Wishlist */ - public function update(array $data, $id, $attribute = "id") { $wishlist = $this->find($id); @@ -53,21 +51,23 @@ class WishlistRepository extends Repository } /** - * To retrieve products with wishlist m - * for a listing resource. + * To retrieve products with wishlist for a listing resource. * - * @param integer $id + * @param int $id + * @return \Webkul\Customer\Contracts\Wishlist */ - public function getItemsWithProducts($id) { + public function getItemsWithProducts($id) + { return $this->model->find($id)->item_wishlist; } /** * get customer wishlist Items. * - * @return mixed + * @return \Illuminate\Support\Collection */ - public function getCustomerWhishlist() { + public function getCustomerWhishlist() + { return $this->model->where([ 'channel_id' => core()->getCurrentChannel()->id, 'customer_id' => auth()->guard('customer')->user()->id, diff --git a/packages/Webkul/Customer/src/Rules/VatIdRule.php b/packages/Webkul/Customer/src/Rules/VatIdRule.php index 5967002a5..ed960e00b 100644 --- a/packages/Webkul/Customer/src/Rules/VatIdRule.php +++ b/packages/Webkul/Customer/src/Rules/VatIdRule.php @@ -20,7 +20,7 @@ class VatIdRule implements Rule * @see https://raw.githubusercontent.com/danielebarbaro/laravel-vat-eu-validator/master/src/VatValidator.php * * @param string $attribute - * @param mixed $value + * @param mixed $value * @return bool */ public function passes($attribute, $value) diff --git a/packages/Webkul/Customer/src/Rules/VatValidator.php b/packages/Webkul/Customer/src/Rules/VatValidator.php index 816e10df3..f6640995a 100644 --- a/packages/Webkul/Customer/src/Rules/VatValidator.php +++ b/packages/Webkul/Customer/src/Rules/VatValidator.php @@ -57,8 +57,7 @@ class VatValidator /** * Validate a VAT number format. * - * @param string $vatNumber - * + * @param string $vatNumber * @return boolean */ public function validate(string $vatNumber): bool @@ -75,8 +74,7 @@ class VatValidator } /** - * @param string $vatNumber - * + * @param string $vatNumber * @return string */ private function vatCleaner(string $vatNumber): string @@ -87,8 +85,7 @@ class VatValidator } /** - * @param string $vatNumber - * + * @param string $vatNumber * @return array */ private function splitVat(string $vatNumber): array