diff --git a/upload/admin/model/catalog/attribute.php b/upload/admin/model/catalog/attribute.php index 77925417a..de8db2bbe 100644 --- a/upload/admin/model/catalog/attribute.php +++ b/upload/admin/model/catalog/attribute.php @@ -179,13 +179,13 @@ public function getDescriptions(int $attribute_id): array { /** * Get Total Attributes - * + * * Get the total number of attribute records in the database. - * + * * @return int - * + * * @example - * + * * $attribute_total = $this->model_catalog_attribute->getTotalAttributes(); */ public function getTotalAttributes(): int { @@ -196,15 +196,15 @@ public function getTotalAttributes(): int { /** * Get Total Attributes By Attribute Group ID - * + * * Get the total number of attribute records with group ID in the database. - * + * * @param int $attribute_group_id - * + * * @return int - * - * @example - * + * + * @example + * * $attribute_total = $this->model_catalog_attribute->getTotalAttributesByAttributeGroupId($attribute_group_id); */ public function getTotalAttributesByAttributeGroupId(int $attribute_group_id): int { diff --git a/upload/admin/model/catalog/attribute_group.php b/upload/admin/model/catalog/attribute_group.php index bc2a138be..50b6e9dd6 100644 --- a/upload/admin/model/catalog/attribute_group.php +++ b/upload/admin/model/catalog/attribute_group.php @@ -160,9 +160,9 @@ public function getDescriptions(int $attribute_group_id): array { * Get Total Attribute Groups * * @return int total number of attribute group records - * - * @example - * + * + * @example + * * $attribute_group_total = $this->model_catalog_attribute_group->getTotalAttributeGroups(); */ public function getTotalAttributeGroups(): int { diff --git a/upload/admin/model/catalog/category.php b/upload/admin/model/catalog/category.php index 4fd4dfe89..44b1556c3 100644 --- a/upload/admin/model/catalog/category.php +++ b/upload/admin/model/catalog/category.php @@ -407,9 +407,9 @@ public function getFilters(int $category_id): array { * @param int $category_id primary key of the category record * * @return array store records that have category ID - * - * @example - * + * + * @example + * * $results = $this->model_catalog_category->getCategoryStores($category_id); */ public function getCategoryStores(int $category_id): array { @@ -430,9 +430,9 @@ public function getCategoryStores(int $category_id): array { * @param int $category_id primary key of the category record * * @return array> SEO URL records that have category ID - * - * @example - * + * + * @example + * * $results = $this->model_catalog_category->getCategorySeoUrls($category_id); */ public function getCategorySeoUrls(int $category_id): array { @@ -493,9 +493,9 @@ public function getTotalCategories(): int { * @param int $layout_id primary key of the layout record * * @return int total number of layout records that have layout ID - * - * @example - * + * + * @example + * * $category_total = $this->model_catalog_category->getTotalCategoriesByLayoutId($layout_id); */ public function getTotalCategoriesByLayoutId(int $layout_id): int { diff --git a/upload/admin/model/catalog/filter.php b/upload/admin/model/catalog/filter.php index 657ad1bdc..158ea1001 100644 --- a/upload/admin/model/catalog/filter.php +++ b/upload/admin/model/catalog/filter.php @@ -46,7 +46,7 @@ public function addFilter(array $data): int { * Edit Filter * * @param int $filter_group_id primary key of the filter group record - * @param array $data array of data + * @param array $data array of data * * @example * @@ -105,9 +105,9 @@ public function deleteFilter(int $filter_group_id): void { * @param int $filter_group_id primary key of the filter group record * * @return array filter group record that has filter group ID - * - * @example - * + * + * @example + * * $filter_group_info = $this->model_catalog_filter->getGroup($filter_group_id); */ public function getGroup(int $filter_group_id): array { @@ -122,9 +122,9 @@ public function getGroup(int $filter_group_id): array { * @param array $data array of filters * * @return array> filter group records - * - * @example - * + * + * @example + * * $results = $this->model_catalog_filter->getGroups(); */ public function getGroups(array $data = []): array { @@ -170,9 +170,9 @@ public function getGroups(array $data = []): array { * @param int $filter_group_id primary key of the filter group record * * @return array> description records that have filter group ID - * - * @example - * + * + * @example + * * $filter_group_description = $this->model_catalog_filter->getGroupDescriptions($filter_group_id); */ public function getGroupDescriptions(int $filter_group_id): array { @@ -247,9 +247,9 @@ public function getFilters(array $data): array { * @param int $filter_group_id primary key of the filter group record * * @return array> description records that have filter group ID - * - * @example - * + * + * @example + * * $results = $this->model_catalog_filter->getDescriptions($filter_group_id); */ public function getDescriptions(int $filter_group_id): array { @@ -280,9 +280,9 @@ public function getDescriptions(int $filter_group_id): array { * Get Total Groups * * @return int total number of filter group records - * - * @example - * + * + * @example + * * $filter_group_total = $this->model_catalog_filter->getTotalGroups(); */ public function getTotalGroups(): int { diff --git a/upload/admin/model/catalog/information.php b/upload/admin/model/catalog/information.php index 84b6d9289..b006142c2 100644 --- a/upload/admin/model/catalog/information.php +++ b/upload/admin/model/catalog/information.php @@ -213,9 +213,9 @@ public function getInformations(array $data = []): array { * @param int $information_id primary key of the information record * * @return array> information description records that have information ID - * - * @example - * + * + * @example + * * $results = $this->model_catalog_information->getDescriptions($information_id); */ public function getDescriptions(int $information_id): array { @@ -265,9 +265,9 @@ public function getStores(int $information_id): array { * @param int $information_id primary key of the information record * * @return array> SEO URL records that have information ID - * - * @example - * + * + * @example + * * $results = $this->model_catalog_information->getInformationSeoUrls($information_id); */ public function getInformationSeoUrls(int $information_id): array { @@ -288,9 +288,9 @@ public function getInformationSeoUrls(int $information_id): array { * @param int $information_id primary key of the information record * * @return array> layout records that have information ID - * - * @example - * + * + * @example + * * $results = $this->model_catalog_information->getInformationLayouts($information_id); */ public function getInformationLayouts(int $information_id): array { @@ -309,9 +309,9 @@ public function getInformationLayouts(int $information_id): array { * Get Total Information(s) * * @return int total number of information records - * - * @example - * + * + * @example + * * $information_total = $this->model_catalog_information->getTotalInformations(); */ public function getTotalInformations(): int { @@ -326,9 +326,9 @@ public function getTotalInformations(): int { * @param int $layout_id primary key of the information record * * @return int total number of layout records that have layout ID - * - * @example - * + * + * @example + * * $information_total = $this->model_catalog_information->getTotalInformationsByLayoutId($layout_id); */ public function getTotalInformationsByLayoutId(int $layout_id): int { diff --git a/upload/admin/model/catalog/manufacturer.php b/upload/admin/model/catalog/manufacturer.php index 8a5eb924b..745a8091c 100644 --- a/upload/admin/model/catalog/manufacturer.php +++ b/upload/admin/model/catalog/manufacturer.php @@ -208,9 +208,9 @@ public function getStores(int $manufacturer_id): array { * @param int $manufacturer_id primary key of the manufacturer record * * @return array> SEO URL records that have manufacturer ID - * - * @example - * + * + * @example + * * $results = $this->model_catalog_manufacturer->getSeoUrls($manufacturer_id); */ public function getSeoUrls(int $manufacturer_id): array { @@ -229,9 +229,9 @@ public function getSeoUrls(int $manufacturer_id): array { * Get Total Manufacturers * * @return int total number of manufacturer records - * - * @example - * + * + * @example + * * $manufacturer_total = $this->model_catalog_manufacturer->getTotalManufacturers(); */ public function getTotalManufacturers(): int { diff --git a/upload/admin/model/catalog/option.php b/upload/admin/model/catalog/option.php index 245402c98..2a5314f70 100644 --- a/upload/admin/model/catalog/option.php +++ b/upload/admin/model/catalog/option.php @@ -200,9 +200,9 @@ public function getDescriptions(int $option_id): array { * @param int $option_value_id primary key of the option value record * * @return array value record that has option value ID - * - * @example - * + * + * @example + * * $option_value_info = $this->model_catalog_option->getValue($option_value_id); */ public function getValue(int $option_value_id): array { @@ -217,9 +217,9 @@ public function getValue(int $option_value_id): array { * @param int $option_id primary key of the option record * * @return array> value records that have option ID - * - * @example - * + * + * @example + * * $option_values = $this->model_catalog_option->getValues($option_id); */ public function getValues(int $option_id): array { @@ -245,9 +245,9 @@ public function getValues(int $option_id): array { * @param int $option_id primary key of the option record * * @return array> value description records that have option ID - * - * @example - * + * + * @example + * * $option_value_description = $this->model_catalog_option->getValueDescriptions($option_id); */ public function getValueDescriptions(int $option_id): array { diff --git a/upload/admin/model/catalog/product.php b/upload/admin/model/catalog/product.php index e1ce762cb..3dc07249c 100644 --- a/upload/admin/model/catalog/product.php +++ b/upload/admin/model/catalog/product.php @@ -508,9 +508,9 @@ public function getProducts(array $data = []): array { * @param int $category_id primary key of the category record * * @return array> product records that have category ID - * - * @example - * + * + * @example + * * $results = $this->model_catalog_product->getProductsByCategoryId($category_id); */ public function getProductsByCategoryId(int $category_id): array { @@ -555,9 +555,9 @@ public function getDescriptions(int $product_id): array { * @param int $product_id primary key of the product record * * @return array category records that have product ID - * - * @example - * + * + * @example + * * $results = $this->model_catalog_product->getCategories($product_id); */ public function getCategories(int $product_id): array { @@ -720,9 +720,9 @@ public function getImages(int $product_id): array { * @param int $product_id primary key of the product record * * @return array> discount records that have product ID - * - * @example - * + * + * @example + * * $results = $this->model_catalog_product->getDiscounts($product_id); */ public function getDiscounts(int $product_id): array { @@ -737,9 +737,9 @@ public function getDiscounts(int $product_id): array { * @param int $product_id primary key of the product record * * @return array> special records that have product ID - * - * @example - * + * + * @example + * * $results = $this->model_catalog_product->getSpecials($product_id); */ public function getSpecials(int $product_id): array { @@ -909,9 +909,9 @@ public function getSubscriptions(int $product_id): array { * @param array $data * * @return int total number of product records - * - * @example - * + * + * @example + * * $product_total = $this->model_catalog_product->getTotalProducts(); */ public function getTotalProducts(array $data = []): int { @@ -1024,9 +1024,9 @@ public function getTotalProductsByLengthClassId(int $length_class_id): int { * @param int $download_id primary key of the download record * * @return int total number of product records that have download ID - * - * @example - * + * + * @example + * * $product_total = $this->model_catalog_product->getTotalProductsByDownloadId($download_id); */ public function getTotalProductsByDownloadId(int $download_id): int { @@ -1058,9 +1058,9 @@ public function getTotalProductsByManufacturerId(int $manufacturer_id): int { * @param int $attribute_id primary key of the attribute record * * @return int total number of product records that have attribute ID - * - * @example - * + * + * @example + * * $product_total = $this->model_catalog_product->getTotalProductsByAttributeId($attribute_id); */ public function getTotalProductsByAttributeId(int $attribute_id): int { @@ -1075,9 +1075,9 @@ public function getTotalProductsByAttributeId(int $attribute_id): int { * @param int $subscription_plan_id primary key of the subscription plan record * * @return int total number of product records that have subscription plan ID - * - * @example - * + * + * @example + * * $product_total = $this->model_catalog_product->getTotalProductsBySubscriptionPlanId($subscription_plan_id); */ public function getTotalProductsBySubscriptionPlanId(int $subscription_plan_id): int { @@ -1092,9 +1092,9 @@ public function getTotalProductsBySubscriptionPlanId(int $subscription_plan_id): * @param int $option_id primary key of the option record * * @return int total number of option records that have option ID - * - * @example - * + * + * @example + * * $product_total = $this->model_catalog_product->getTotalProductsByOptionId($option_id); */ public function getTotalProductsByOptionId(int $option_id): int { @@ -1109,9 +1109,9 @@ public function getTotalProductsByOptionId(int $option_id): int { * @param int $layout_id primary key of the layout record * * @return int total number of layout records that have layout ID - * - * @example - * + * + * @example + * * $product_total = $this->model_catalog_product->getTotalProductsByLayoutId($layout_id); */ public function getTotalProductsByLayoutId(int $layout_id): int { diff --git a/upload/admin/model/catalog/subscription_plan.php b/upload/admin/model/catalog/subscription_plan.php index 4845bddee..39dc62e4a 100644 --- a/upload/admin/model/catalog/subscription_plan.php +++ b/upload/admin/model/catalog/subscription_plan.php @@ -113,9 +113,9 @@ public function getSubscriptionPlan(int $subscription_plan_id): array { * @param int $subscription_plan_id primary key of the subscription plan record * * @return array> description records that have subscription plan ID - * - * @example - * + * + * @example + * * $subscription_plan_description = $this->model_catalog_subscription_plan->getSubscriptionPlanDescription($subscription_plan_id); */ public function getSubscriptionPlanDescription(int $subscription_plan_id): array { diff --git a/upload/admin/model/customer/customer.php b/upload/admin/model/customer/customer.php index fcb980c39..090cb77fc 100644 --- a/upload/admin/model/customer/customer.php +++ b/upload/admin/model/customer/customer.php @@ -331,7 +331,8 @@ public function getAddresses(int $customer_id): array { /** * Get Total Addresses * - * @param int $customer_id primary key of the customer record + * @param array $data + * @param int $customer_id primary key of the customer record * * @return int total number of address records that have customer ID * @@ -387,9 +388,9 @@ public function getTotalCustomers(array $data = []): int { * @param string $tracking * * @return array - * - * @example - * + * + * @example + * * $affiliate_info = $this->model_customer_customer->getAffiliateByTracking($tracking); */ public function getAffiliateByTracking(string $tracking): array { @@ -404,9 +405,9 @@ public function getAffiliateByTracking(string $tracking): array { * @param int $customer_id primary key of the customer record * * @return array affiliate record that has customer ID - * - * @example - * + * + * @example + * * $affiliate_info = $this->model_customer_customer->getAffiliate($customer_id); */ public function getAffiliate(int $customer_id): array { @@ -421,9 +422,9 @@ public function getAffiliate(int $customer_id): array { * @param array $data array of filters * * @return array> affiliate records - * - * @example - * + * + * @example + * * $results = $this->model_customer_customer->getAffiliates(); */ public function getAffiliates(array $data = []): array { @@ -462,9 +463,9 @@ public function getAffiliates(array $data = []): array { * @param array $data array of filters * * @return int total number of affiliate records - * - * @example - * + * + * @example + * * $affiliate_total = $this->model_customer_customer->getTotalAffiliates(); */ public function getTotalAffiliates($data = []): int { @@ -491,9 +492,9 @@ public function getTotalAffiliates($data = []): int { * @param int $customer_id primary key of the customer record * * @return int total number of address records that have customer ID - * - * @example - * + * + * @example + * * $address_total = $this->model_customer_customer->getTotalAddressesByCustomerId($customer_id); */ public function getTotalAddressesByCustomerId(int $customer_id): int { @@ -542,9 +543,9 @@ public function getTotalAddressesByZoneId(int $zone_id): int { * @param int $customer_group_id primary key of the customer group record * * @return int total number of customer group records that have customer group ID - * - * @example - * + * + * @example + * * $customer_group_total = $this->model_customer_customer->getTotalCustomersByCustomerGroupId($customer_group_id); */ public function getTotalCustomersByCustomerGroupId(int $customer_group_id): int { @@ -637,9 +638,9 @@ public function addTransaction(int $customer_id, string $description = '', float * @param int $order_id primary key of the order record * * @return void - * - * @example - * + * + * @example + * * $this->model_customer_customer->deleteTransactionByOrderId($order_id); */ public function deleteTransactionByOrderId(int $order_id): void { @@ -713,9 +714,9 @@ public function getTransactionTotal(int $customer_id): float { * @param int $order_id primary key of the order record * * @return int total number of transaction records that have order ID - * - * @example - * + * + * @example + * * $transaction_total = $this->model_customer_customer->getTotalTransactionsByOrderId($order_id); */ public function getTotalTransactionsByOrderId(int $order_id): int { @@ -748,9 +749,9 @@ public function addReward(int $customer_id, string $description = '', int $point * @param int $order_id primary key of the order record * * @return void - * - * @example - * + * + * @example + * * $this->model_customer_customer->deleteReward($order_id); */ public function deleteReward(int $order_id): void { @@ -820,9 +821,9 @@ public function getRewardTotal(int $customer_id): int { * @param int $order_id primary key of the order record * * @return int total number of customer reward records that have order ID - * - * @example - * + * + * @example + * * $reward_total = $this->model_customer_customer->getTotalCustomerRewardsByOrderId($order_id); */ public function getTotalCustomerRewardsByOrderId(int $order_id): int { @@ -881,9 +882,9 @@ public function getTotalIps(int $customer_id): int { * @param string $ip * * @return int - * - * @example - * + * + * @example + * * $customer_total = $this->model_customer_customer->getTotalCustomersByIp($ip); */ public function getTotalCustomersByIp(string $ip): int { @@ -898,9 +899,9 @@ public function getTotalCustomersByIp(string $ip): int { * @param string $email * * @return array - * - * @example - * + * + * @example + * * $login_total = $this->model_customer_customer->getTotalLoginAttempts($email); */ public function getTotalLoginAttempts(string $email): array { @@ -915,9 +916,9 @@ public function getTotalLoginAttempts(string $email): array { * @param string $email * * @return void - * - * @example - * + * + * @example + * * $this->model_customer_customer->deleteLoginAttempts($email); */ public function deleteLoginAttempts(string $email): void { diff --git a/upload/admin/model/customer/gdpr.php b/upload/admin/model/customer/gdpr.php index f9b6fc465..870be20f9 100644 --- a/upload/admin/model/customer/gdpr.php +++ b/upload/admin/model/customer/gdpr.php @@ -157,9 +157,9 @@ public function getExpires(): array { * @param int $status * * @return void - * - * @example - * + * + * @example + * * $this->model_customer_gdpr->editStatus($gdpr_id, $status); */ public function editStatus($gdpr_id, $status): void { diff --git a/upload/admin/model/design/seo_url.php b/upload/admin/model/design/seo_url.php index 88c45a145..ca565575c 100644 --- a/upload/admin/model/design/seo_url.php +++ b/upload/admin/model/design/seo_url.php @@ -13,9 +13,9 @@ class ModelDesignSeoUrl extends Model { * @param array $data array of data * * @return void - * - * @example - * + * + * @example + * * $seo_url_id = $this->model_design_seo_url->addSeoUrl($data); */ public function addSeoUrl(array $data): void { @@ -29,9 +29,9 @@ public function addSeoUrl(array $data): void { * @param array $data array of data * * @return void - * + * * @example - * + * * $this->model_design_seo_url->editSeoUrl($seo_url_id, $data); */ public function editSeoUrl(int $seo_url_id, array $data): void { @@ -189,9 +189,9 @@ public function getTotalSeoUrls(array $data = []): int { * @param string $keyword * * @return array> - * - * @example - * + * + * @example + * * $seo_urls = $this->model_design_seo_url->getSeoUrlsByKeyword($keyword); */ public function getSeoUrlsByKeyword(string $keyword): array { @@ -206,9 +206,9 @@ public function getSeoUrlsByKeyword(string $keyword): array { * @param string $query * * @return array> - * - * @example - * + * + * @example + * * $seo_urls = $this->model_design_seo_url->getSeoUrlsByQuery($query); */ public function getSeoUrlsByQuery(string $query): array { @@ -224,9 +224,9 @@ public function getSeoUrlsByQuery(string $query): array { * @param string $query * * @return array> seo url records that have seo url ID - * - * @example - * + * + * @example + * * $seo_urls = $this->model_design_seo_url->getSeoUrlsByQueryId($seo_url_id, $query); */ public function getSeoUrlsByQueryId(int $seo_url_id, string $query): array { @@ -242,9 +242,9 @@ public function getSeoUrlsByQueryId(int $seo_url_id, string $query): array { * @param string $keyword * * @return array> seo url records that have seo url ID - * - * @example - * + * + * @example + * * $seo_urls = $this->model_design_seo_url->getSeoUrlsByKeywordId($seo_url_id, $keyword); */ public function getSeoUrlsByKeywordId(int $seo_url_id, string $keyword): array { diff --git a/upload/admin/model/design/theme.php b/upload/admin/model/design/theme.php index d0fe2da1f..2fae6392b 100644 --- a/upload/admin/model/design/theme.php +++ b/upload/admin/model/design/theme.php @@ -16,9 +16,9 @@ class ModelDesignTheme extends Model { * @param string $code * * @return void - * - * @example - * + * + * @example + * * $this->model_design_theme->editTheme($store_id, $theme, $route, $code); */ public function editTheme(int $store_id, string $theme, string $route, string $code): void { @@ -49,9 +49,9 @@ public function deleteTheme(int $theme_id): void { * @param string $route * * @return array - * - * @example - * + * + * @example + * * $theme_info = $this->model_design_theme->getTheme($store_id, $theme, $route); */ public function getTheme(int $store_id, string $theme, string $route): array { diff --git a/upload/admin/model/localisation/currency.php b/upload/admin/model/localisation/currency.php index f94379e7d..6e392287f 100644 --- a/upload/admin/model/localisation/currency.php +++ b/upload/admin/model/localisation/currency.php @@ -191,9 +191,9 @@ public function getCurrencies(array $data = []): array { * Refresh * * @return void - * - * @example - * + * + * @example + * * $this->model_localisation_currency->refresh(); */ public function refresh(): void { diff --git a/upload/admin/model/localisation/geo_zone.php b/upload/admin/model/localisation/geo_zone.php index 10df3c9bc..58564efcf 100644 --- a/upload/admin/model/localisation/geo_zone.php +++ b/upload/admin/model/localisation/geo_zone.php @@ -182,9 +182,9 @@ public function getTotalGeoZones(): int { * @param int $geo_zone_id primary key of the geo zone record * * @return array> geo zone records that have geo zone ID - * - * @example - * + * + * @example + * * $zone_to_geo_zones = $this->model_localisation_geo_zone->geoZoneToGeoZones($geo_zone_id); */ public function getZoneToGeoZones(int $geo_zone_id): array { @@ -199,9 +199,9 @@ public function getZoneToGeoZones(int $geo_zone_id): array { * @param int $geo_zone_id primary key of the geo zone record * * @return int total number of geo zone records that have geo zone ID - * - * @example - * + * + * @example + * * $zone_to_geo_zones = $this->model_localisation_geo_zone->getTotalZoneToGeoZoneByGeoZoneId($geo_zone_id); */ public function getTotalZoneToGeoZoneByGeoZoneId(int $geo_zone_id): int { @@ -216,9 +216,9 @@ public function getTotalZoneToGeoZoneByGeoZoneId(int $geo_zone_id): int { * @param int $country_id primary key of the country record * * @return int total number of geo zone records that have country ID - * - * @example - * + * + * @example + * * $geo_zone_total = $this->model_localisation_geo_zone->getTotalZoneToGeoZoneByCountryId($country_id); */ public function getTotalZoneToGeoZoneByCountryId(int $country_id): int { @@ -233,9 +233,9 @@ public function getTotalZoneToGeoZoneByCountryId(int $country_id): int { * @param int $zone_id primary key of the zone record * * @return int total number of geo zone records that have zone ID - * - * @example - * + * + * @example + * * $geo_zone_total = $this->model_localisation_geo_zone->getTotalZoneToGeoZoneByZoneId($zone_id); */ public function getTotalZoneToGeoZoneByZoneId(int $zone_id): int { diff --git a/upload/admin/model/localisation/language.php b/upload/admin/model/localisation/language.php index 7f849bfd3..cea20449f 100644 --- a/upload/admin/model/localisation/language.php +++ b/upload/admin/model/localisation/language.php @@ -354,9 +354,9 @@ public function getLanguages(array $data = []): array { * @param string $code * * @return array - * - * @example - * + * + * @example + * * $language_info = $this->model_localisation_language->getLanguageByCode($code); */ public function getLanguageByCode(string $code): array { @@ -369,9 +369,9 @@ public function getLanguageByCode(string $code): array { * Get Total Languages * * @return int total number of language records - * - * @example - * + * + * @example + * * $language_total = $this->model_localisation_language->getTotalLanguages(); */ public function getTotalLanguages(): int { diff --git a/upload/admin/model/localisation/length_class.php b/upload/admin/model/localisation/length_class.php index 3cd15f8a7..71852282e 100644 --- a/upload/admin/model/localisation/length_class.php +++ b/upload/admin/model/localisation/length_class.php @@ -160,9 +160,9 @@ public function getLengthClass(int $length_class_id): array { * @param string $unit * * @return array - * - * @example - * + * + * @example + * * $length_class_info = $this->model_localisation_length_class->getDescriptionByUnit($unit); */ public function getDescriptionByUnit(string $unit): array { diff --git a/upload/admin/model/localisation/tax_rate.php b/upload/admin/model/localisation/tax_rate.php index 2c229e079..e4b8a90bd 100644 --- a/upload/admin/model/localisation/tax_rate.php +++ b/upload/admin/model/localisation/tax_rate.php @@ -147,9 +147,9 @@ public function getTaxRates(array $data = []): array { * @param int $tax_rate_id primary key of the tax rate record * * @return array customer group records that have tax rate ID - * - * @example - * + * + * @example + * * $results = $this->model_localisation_tax_rate->getCustomerGroups($tax_rate_id); */ public function getCustomerGroups(int $tax_rate_id): array { @@ -185,9 +185,9 @@ public function getTotalTaxRates(): int { * @param int $geo_zone_id primary key of the geo zone record * * @return int total number of tax rate records that have geo zone ID - * - * @example - * + * + * @example + * * $tax_rate_total = $this->model_localisation_tax_rate->getTotalTaxRatesByGeoZoneId($geo_zone_id); */ public function getTotalTaxRatesByGeoZoneId(int $geo_zone_id): int { diff --git a/upload/admin/model/sale/order.php b/upload/admin/model/sale/order.php index 4558b1a98..c27c4f064 100644 --- a/upload/admin/model/sale/order.php +++ b/upload/admin/model/sale/order.php @@ -13,9 +13,9 @@ class ModelSaleOrder extends Model { * @param int $order_id primary key of the order record * * @return array order record that has order ID - * - * @example - * + * + * @example + * * $order_info = $this->model_sale_order->getOrder($order_id); */ public function getOrder(int $order_id): array { @@ -175,9 +175,9 @@ public function getOrder(int $order_id): array { * @param array $data array of filters * * @return array> order records - * - * @example - * + * + * @example + * * $results = $this->model_sale_order->getOrders(); */ public function getOrders(array $data = []): array { @@ -265,9 +265,9 @@ public function getOrders(array $data = []): array { * @param int $order_id primary key of the order record * * @return array> product records that have order ID - * - * @example - * + * + * @example + * * $order_products = $this->model_sale_order->getProducts($order_id); */ public function getProducts(int $order_id): array { @@ -283,9 +283,9 @@ public function getProducts(int $order_id): array { * @param int $order_product_id primary key of the order product record * * @return array product records that have order ID, order product ID - * + * * @example - * + * * $order_product = $this->model_sale_order->getProductByOrderProductId($order_id, $order_product_id); */ public function getProductByOrderProductId(int $order_id, int $order_product_id): array { @@ -301,9 +301,9 @@ public function getProductByOrderProductId(int $order_id, int $order_product_id) * @param int $order_product_id primary key of the order product record * * @return array> option records that have order ID, order product ID - * + * * @example - * + * * $order_options = $this->model_sale_order->getOptions($order_id, $order_product_id); */ public function getOptions(int $order_id, int $order_product_id): array { @@ -319,9 +319,9 @@ public function getOptions(int $order_id, int $order_product_id): array { * @param int $order_product_id primary key of the order product record * * @return array subscription records that have order ID - * + * * @example - * + * * $order_subscription_info = $this->model_sale_order->getSubscription($order_id, $order_product_id); */ public function getSubscription(int $order_id, int $order_product_id): array { @@ -336,9 +336,9 @@ public function getSubscription(int $order_id, int $order_product_id): array { * @param int $order_id primary key of the order record * * @return array> voucher records that have order ID - * - * @example - * + * + * @example + * * $order_vouchers = $this->model_sale_order->getVouchers($order_id); */ public function getVouchers(int $order_id): array { @@ -353,9 +353,9 @@ public function getVouchers(int $order_id): array { * @param int $voucher_id voucher record that has voucher ID * * @return array - * - * @example - * + * + * @example + * * $order_voucher_info = $this->model_sale_order->getOrderVoucherByVoucherId($voucher_id); */ public function getOrderVoucherByVoucherId(int $voucher_id): array { @@ -370,9 +370,9 @@ public function getOrderVoucherByVoucherId(int $voucher_id): array { * @param int $order_id primary key of the order record * * @return array> total records that have order ID - * - * @example - * + * + * @example + * * $order_totals = $this->model_sale_order->getTotals($order_id); */ public function getTotals(int $order_id): array { @@ -387,9 +387,9 @@ public function getTotals(int $order_id): array { * @param array $data array of filters * * @return int total number of order records - * - * @example - * + * + * @example + * * $order_total = $this->model_sale_order->getTotalOrders(); */ public function getTotalOrders(array $data = []): int { @@ -444,9 +444,9 @@ public function getTotalOrders(array $data = []): int { * @param int $store_id * * @return int - * - * @example - * + * + * @example + * * $order_total = $this->model_sale_order->getTotalOrdersByStoreId($store_id); */ public function getTotalOrdersByStoreId(int $store_id): int { @@ -461,9 +461,9 @@ public function getTotalOrdersByStoreId(int $store_id): int { * @param int $order_status_id primary key of the order status record * * @return int total number of order records that have order status ID - * - * @example - * + * + * @example + * * $order_total = $this->model_sale_order->getTotalOrdersByOrderStatusId($order_status_id); */ public function getTotalOrdersByOrderStatusId(int $order_status_id): int { @@ -476,9 +476,9 @@ public function getTotalOrdersByOrderStatusId(int $order_status_id): int { * Get Total Orders By Processing Status * * @return int total number of order processing status records - * - * @example - * + * + * @example + * * $order_total = $this->model_sale_order->getTotalOrdersByProcessingStatus(); */ public function getTotalOrdersByProcessingStatus(): int { @@ -503,9 +503,9 @@ public function getTotalOrdersByProcessingStatus(): int { * Get Total Orders By Complete Status * * @return int total number of order complete status records - * - * @example - * + * + * @example + * * $order_total = $this->model_sale_order->getTotalOrdersByCompleteStatus(); */ public function getTotalOrdersByCompleteStatus(): int { @@ -532,9 +532,9 @@ public function getTotalOrdersByCompleteStatus(): int { * @param int $language_id primary key of the language record * * @return int total number of order records that have language ID - * - * @example - * + * + * @example + * * $order_total = $this->model_sale_order->getTotalOrdersByLanguageId($language_id); */ public function getTotalOrdersByLanguageId(int $language_id): int { @@ -549,9 +549,9 @@ public function getTotalOrdersByLanguageId(int $language_id): int { * @param int $currency_id primary key of the currency record * * @return int total number of order records that have currency ID - * - * @example - * + * + * @example + * * $order_total = $this->model_sale_order->getTotalOrdersByCurrencyId($currency_id); */ public function getTotalOrdersByCurrencyId(int $currency_id): int { @@ -566,9 +566,9 @@ public function getTotalOrdersByCurrencyId(int $currency_id): int { * @param array $data array of filters * * @return int total number of sale records - * - * @example - * + * + * @example + * * $sale_total = $this->model_sale_order->getTotalSales(); */ public function getTotalSales(array $data = []): int { @@ -623,9 +623,9 @@ public function getTotalSales(array $data = []): int { * @param int $order_id primary key of the order record * * @return string - * - * @example - * + * + * @example + * * $invoice_no = $this->model_sale_order->createInvoiceNo($order_id); */ public function createInvoiceNo(int $order_id): string { @@ -656,9 +656,9 @@ public function createInvoiceNo(int $order_id): string { * @param int $limit * * @return array> history records that have order ID - * - * @example - * + * + * @example + * * $results = $this->model_sale_order->getHistories($order_id, $start, $limit); */ public function getHistories(int $order_id, int $start = 0, int $limit = 10): array { @@ -681,9 +681,9 @@ public function getHistories(int $order_id, int $start = 0, int $limit = 10): ar * @param int $order_id primary key of the order record * * @return int total number of history records that have order ID - * - * @example - * + * + * @example + * * $history_total = $this->model_sale_order->getTotalHistories($order_id); */ public function getTotalHistories(int $order_id): int { @@ -698,9 +698,9 @@ public function getTotalHistories(int $order_id): int { * @param int $order_status_id primary key of the order status record * * @return int total number of history records that have order status ID - * - * @example - * + * + * @example + * * $history_total = $this->model_sale_order->getTotalHistoriesByOrderStatusId($order_status_id); */ public function getTotalHistoriesByOrderStatusId(int $order_status_id): int { @@ -717,9 +717,9 @@ public function getTotalHistoriesByOrderStatusId(int $order_status_id): int { * @param int $end * * @return array> - * - * @example - * + * + * @example + * * $results = $this->model_sale_order->getEmailsByProductsOrdered($products, $start, $end); */ public function getEmailsByProductsOrdered(array $products, int $start, int $end): array { @@ -740,9 +740,9 @@ public function getEmailsByProductsOrdered(array $products, int $start, int $end * @param array $products * * @return int - * - * @example - * + * + * @example + * * $product_total = $this->model_sale_order->getTotalEmailsByProductsOrdered($products); */ public function getTotalEmailsByProductsOrdered(array $products): int { diff --git a/upload/admin/model/sale/returns.php b/upload/admin/model/sale/returns.php index 11b8b019c..a7ac04797 100644 --- a/upload/admin/model/sale/returns.php +++ b/upload/admin/model/sale/returns.php @@ -13,9 +13,9 @@ class ModelSaleReturns extends Model { * @param array $data array of data * * @return int returns the primary key of the new return record - * - * @example - * + * + * @example + * * $return_id = $this->model_sale_returns->addReturn($data); */ public function addReturn(array $data): int { @@ -31,9 +31,9 @@ public function addReturn(array $data): int { * @param array $data array of data * * @return void - * - * @example - * + * + * @example + * * $this->model_sale_returns->editReturn($return_id, $data); */ public function editReturn(int $return_id, array $data): void { @@ -46,9 +46,9 @@ public function editReturn(int $return_id, array $data): void { * @param int $return_id primary key of the return record * * @return void - * - * @example - * + * + * @example + * * $this->model_sale_returns->deleteReturn($return_id); */ public function deleteReturn(int $return_id): void { @@ -62,9 +62,9 @@ public function deleteReturn(int $return_id): void { * @param int $return_id primary key of the return record * * @return array return record that has return ID - * - * @example - * + * + * @example + * * $return_info = $this->model_sale_returns->getReturn($return_id); */ public function getReturn(int $return_id): array { @@ -79,9 +79,9 @@ public function getReturn(int $return_id): array { * @param array $data array of filters * * @return array> return records - * - * @example - * + * + * @example + * * $returns = $this->model_sale_returns->getReturns(); */ public function getReturns(array $data = []): array { @@ -171,9 +171,9 @@ public function getReturns(array $data = []): array { * @param array $data array of filters * * @return int total number of return records - * - * @example - * + * + * @example + * * $return_total = $this->model_sale_returns->getTotalReturns(); */ public function getTotalReturns(array $data = []): int { @@ -228,9 +228,9 @@ public function getTotalReturns(array $data = []): int { * @param int $return_status_id primary key of the return status record * * @return int total number of return status records that have return status ID - * - * @example - * + * + * @example + * * $return_total = $this->model_sale_returns->getTotalReturnsByReturnStatusId($return_status_id); */ public function getTotalReturnsByReturnStatusId(int $return_status_id): int { @@ -245,9 +245,9 @@ public function getTotalReturnsByReturnStatusId(int $return_status_id): int { * @param int $return_reason_id primary key of the return reason record * * @return int total number of return reason records that have return reason ID - * - * @example - * + * + * @example + * * $return_total = $this->model_sale_returns->getTotalReturnsByReturnReasonId($return_reason_id); */ public function getTotalReturnsByReturnReasonId(int $return_reason_id): int { @@ -262,9 +262,9 @@ public function getTotalReturnsByReturnReasonId(int $return_reason_id): int { * @param int $return_action_id primary key of the return reason record * * @return int total number of return action records that have return action ID - * - * @example - * + * + * @example + * * $return_total = $this->model_sale_returns->getTotalReturnsByReturnActionId($return_action_id); */ public function getTotalReturnsByReturnActionId(int $return_action_id): int { @@ -282,9 +282,9 @@ public function getTotalReturnsByReturnActionId(int $return_action_id): int { * @param bool $notify * * @return void - * - * @example - * + * + * @example + * * $this->model_sale_returns->addHistory($return_id, $return_status_id, $comment, $notify); */ public function addHistory(int $return_id, int $return_status_id, string $comment, bool $notify): void { @@ -301,9 +301,9 @@ public function addHistory(int $return_id, int $return_status_id, string $commen * @param int $limit * * @return array> history records that have return ID - * - * @example - * + * + * @example + * * $results = $this->model_sale_returns->getHistories($return_id, $start, $limit); */ public function getHistories(int $return_id, int $start = 0, int $limit = 10): array { @@ -326,9 +326,9 @@ public function getHistories(int $return_id, int $start = 0, int $limit = 10): a * @param int $return_id primary key of the return record * * @return int total number of history records that have return ID - * - * @example - * + * + * @example + * * $history_total = $this->model_sale_returns->getTotalHistories($return_id); */ public function getTotalHistories(int $return_id): int { @@ -343,9 +343,9 @@ public function getTotalHistories(int $return_id): int { * @param int $return_status_id primary key of the return status record * * @return int total number of history records that have return status ID - * - * @example - * + * + * @example + * * $history_total = $this->model_sale_returns->getTotalReturnHistoriesByReturnStatusId($return_status_id); */ public function getTotalReturnHistoriesByReturnStatusId(int $return_status_id): int { diff --git a/upload/admin/model/sale/subscription.php b/upload/admin/model/sale/subscription.php index a6eec9200..6ddbb83ef 100644 --- a/upload/admin/model/sale/subscription.php +++ b/upload/admin/model/sale/subscription.php @@ -14,9 +14,9 @@ class ModelSaleSubscription extends Model { * @param array $data array of data * * @return void - * - * @example - * + * + * @example + * * $this->model_sale_subscription->editSubscription($subscription_id, $data); */ public function editSubscription(int $subscription_id, array $data): void { @@ -30,9 +30,9 @@ public function editSubscription(int $subscription_id, array $data): void { * @param int $customer_payment_id primary key of the customer payment record * * @return void - * - * @example - * + * + * @example + * * $this->model_sale_subscription->editPaymentMethod($subscription_id, $customer_payment_id); */ public function editPaymentMethod(int $subscription_id, int $customer_payment_id): void { @@ -46,9 +46,9 @@ public function editPaymentMethod(int $subscription_id, int $customer_payment_id * @param int $subscription_plan_id primary key of the subscription plan record * * @return void - * - * @example - * + * + * @example + * * $this->model_sale_subscription->editSubscriptionPlan($subscription_id, $subscription_plan_id); */ public function editSubscriptionPlan(int $subscription_id, int $subscription_plan_id): void { @@ -62,9 +62,9 @@ public function editSubscriptionPlan(int $subscription_id, int $subscription_pla * @param int $remaining * * @return void - * - * @example - * + * + * @example + * * $this->model_sale_subscription->editRemaining($subscription_id, $remaining); */ public function editRemaining(int $subscription_id, int $remaining): void { @@ -78,9 +78,9 @@ public function editRemaining(int $subscription_id, int $remaining): void { * @param int $trial_remaining * * @return void - * - * @example - * + * + * @example + * * $this->model_sale_subscription->editTrialRemaining($subscription_id, $trial_remaining); */ public function editTrialRemaining(int $subscription_id, int $trial_remaining): void { @@ -94,9 +94,9 @@ public function editTrialRemaining(int $subscription_id, int $trial_remaining): * @param string $date_next * * @return void - * - * @example - * + * + * @example + * * $this->model_sale_subscription->editDateNext($subscription_id, $date_next); */ public function editDateNext(int $subscription_id, string $date_next): void { @@ -109,9 +109,9 @@ public function editDateNext(int $subscription_id, string $date_next): void { * @param int $customer_payment_id primary key of the customer payment record * * @return void - * - * @example - * + * + * @example + * * $this->model_sale_subscription->deleteSubscriptionByCustomerPaymentId($customer_payment_id); */ public function deleteSubscriptionByCustomerPaymentId(int $customer_payment_id): void { @@ -124,9 +124,9 @@ public function deleteSubscriptionByCustomerPaymentId(int $customer_payment_id): * @param int $subscription_id primary key of the subscription record * * @return array subscription record that has subscription ID - * - * @example - * + * + * @example + * * $subscription_info = $this->model_sale_subscription->getSubscription($subscription_id); */ public function getSubscription(int $subscription_id): array { @@ -154,9 +154,9 @@ public function getSubscription(int $subscription_id): array { * @param int $order_product_id primary key of the order product record * * @return array subscription record that has order ID - * - * @example - * + * + * @example + * * $subscription_info = $this->model_sale_subscription->getSubscriptionByOrderProductId($order_id, $order_product_id); */ public function getSubscriptionByOrderProductId(int $order_id, int $order_product_id): array { @@ -179,9 +179,9 @@ public function getSubscriptionByOrderProductId(int $order_id, int $order_produc * @param array $data array of filters * * @return array> subscription records - * - * @example - * + * + * @example + * * $results = $this->model_sale_subscription->getSubscriptions(); */ public function getSubscriptions(array $data): array { @@ -273,9 +273,9 @@ public function getSubscriptions(array $data): array { * @param array $data array of filters * * @return int total number of subscription records - * - * @example - * + * + * @example + * * $subscription_total = $this->model_sale_subscription->getTotalSubscriptions(); */ public function getTotalSubscriptions(array $data = []): int { @@ -326,9 +326,9 @@ public function getTotalSubscriptions(array $data = []): int { * @param int $store_id * * @return int total number of subscription records that have store ID - * - * @example - * + * + * @example + * * $subscription_total = $this->model_sale_subscription->getTotalSubscriptionsByStoreId($store_id); */ public function getTotalSubscriptionsByStoreId(int $store_id): int { @@ -343,9 +343,9 @@ public function getTotalSubscriptionsByStoreId(int $store_id): int { * @param int $subscription_status_id primary key of the subscription status record * * @return int total number of subscription records that have subscription status ID - * - * @example - * + * + * @example + * * $subscription_total = $this->model_sale_subscription->getTotalSubscriptionsBySubscriptionStatusId($subscription_status_id); */ public function getTotalSubscriptionsBySubscriptionStatusId(int $subscription_status_id): int { @@ -363,9 +363,9 @@ public function getTotalSubscriptionsBySubscriptionStatusId(int $subscription_st * @param bool $notify * * @return void - * - * @example - * + * + * @example + * * $this->model_sale_subscription->addHistory($subscription_id, $subscription_status_id, $comment, $notify); */ public function addHistory(int $subscription_id, int $subscription_status_id, string $comment = '', bool $notify = false): void { @@ -382,9 +382,9 @@ public function addHistory(int $subscription_id, int $subscription_status_id, st * @param int $limit * * @return array> history records that have subscription ID - * - * @example - * + * + * @example + * * $results = $this->model_sale_subscription->getHistories($subscription_id, $start, $limit); */ public function getHistories(int $subscription_id, int $start = 0, int $limit = 10): array { @@ -407,9 +407,9 @@ public function getHistories(int $subscription_id, int $start = 0, int $limit = * @param int $subscription_id primary key of the subscription record * * @return int total number of history records that have subscription ID - * - * @example - * + * + * @example + * * $history_total = $this->model_sale_subscription->getTotalHistories($subscription_id); */ public function getTotalHistories(int $subscription_id): int { @@ -424,9 +424,9 @@ public function getTotalHistories(int $subscription_id): int { * @param int $subscription_status_id primary key of the subscription status record * * @return int total number of subscription status records that have subscription status ID - * - * @example - * + * + * @example + * * $history_total = $this->model_sale_subscription->getTotalHistoriesBySubscriptionStatusId($subscription_status_id); */ public function getTotalHistoriesBySubscriptionStatusId(int $subscription_status_id): int { diff --git a/upload/admin/model/sale/voucher.php b/upload/admin/model/sale/voucher.php index aa4608dc7..8235a6564 100644 --- a/upload/admin/model/sale/voucher.php +++ b/upload/admin/model/sale/voucher.php @@ -1,7 +1,7 @@ load->model('sale/voucher'); * * @package Admin\Model\Sale @@ -13,9 +13,9 @@ class ModelSaleVoucher extends Model { * @param array $data array of data * * @return int returns the primary key of the new voucher record - * - * @example - * + * + * @example + * * $voucher_id = $this->model_sale_voucher->addVoucher($data); */ public function addVoucher(array $data): int { @@ -31,9 +31,9 @@ public function addVoucher(array $data): int { * @param array $data array of data * * @return void - * - * @example - * + * + * @example + * * $this->model_sale_voucher->editVoucher($voucher_id, $data); */ public function editVoucher(int $voucher_id, array $data): void { @@ -46,9 +46,9 @@ public function editVoucher(int $voucher_id, array $data): void { * @param int $voucher_id primary key of the voucher record * * @return void - * - * @example - * + * + * @example + * * $this->model_sale_voucher->deleteVoucher($voucher_id); */ public function deleteVoucher(int $voucher_id): void { @@ -62,9 +62,9 @@ public function deleteVoucher(int $voucher_id): void { * @param int $voucher_id primary key of the voucher record * * @return array voucher record that has voucher ID - * - * @example - * + * + * @example + * * $voucher_info = $this->model_sale_voucher->getVoucher($voucher_id); */ public function getVoucher(int $voucher_id): array { @@ -79,9 +79,9 @@ public function getVoucher(int $voucher_id): array { * @param string $code * * @return array - * - * @example - * + * + * @example + * * $voucher_info = $this->model_sale_voucher->getVoucherByCode($code); */ public function getVoucherByCode(string $code): array { @@ -96,9 +96,9 @@ public function getVoucherByCode(string $code): array { * @param array $data array of filters * * @return array> voucher records - * - * @example - * + * + * @example + * * $results = $this->model_sale_order->getVouchers(); */ public function getVouchers(array $data = []): array { @@ -147,9 +147,9 @@ public function getVouchers(array $data = []): array { * Get Total Vouchers * * @return int total number of voucher records - * - * @example - * + * + * @example + * * $voucher_total = $this->model_sale_voucher->getTotalVouchers(); */ public function getTotalVouchers(): int { @@ -164,9 +164,9 @@ public function getTotalVouchers(): int { * @param int $voucher_theme_id primary key of the voucher record * * @return int total number of voucher records that have voucher theme ID - * - * @example - * + * + * @example + * * $voucher_total = $this->model_sale_voucher->getTotalVouchersByVoucherThemeId($voucher_theme_id); */ public function getTotalVouchersByVoucherThemeId(int $voucher_theme_id): int { @@ -183,9 +183,9 @@ public function getTotalVouchersByVoucherThemeId(int $voucher_theme_id): int { * @param int $limit * * @return array> history records that have voucher ID - * - * @example - * + * + * @example + * * $results = $this->model_sale_voucher->getHistories($voucher_id, $start, $limit); */ public function getHistories(int $voucher_id, int $start = 0, int $limit = 10): array { @@ -208,9 +208,9 @@ public function getHistories(int $voucher_id, int $start = 0, int $limit = 10): * @param int $voucher_id primary key of the voucher record * * @return int total number of history records that have voucher ID - * - * @example - * + * + * @example + * * $history_total = $this->model_sale_voucher->getTotalHistories($voucher_id); */ public function getTotalHistories(int $voucher_id): int { diff --git a/upload/admin/model/sale/voucher_theme.php b/upload/admin/model/sale/voucher_theme.php index 158f35d1d..7c992adbc 100644 --- a/upload/admin/model/sale/voucher_theme.php +++ b/upload/admin/model/sale/voucher_theme.php @@ -1,7 +1,7 @@ load->model('sale/voucher_theme'); * * @package Admin\Model\Sale @@ -13,9 +13,9 @@ class ModelSaleVoucherTheme extends Model { * @param array $data array of data * * @return int returns the primary key of the new voucher theme record - * - * @example - * + * + * @example + * * $voucher_theme_id = $this->model_sale_voucher_theme->addVoucherTheme($data); */ public function addVoucherTheme(array $data): int { @@ -39,9 +39,9 @@ public function addVoucherTheme(array $data): int { * @param array $data array of data * * @return void - * - * @example - * + * + * @example + * * $this->model_sale_voucher_theme->editVoucherTheme($voucher_theme_id, $data); */ public function editVoucherTheme(int $voucher_theme_id, array $data): void { @@ -62,9 +62,9 @@ public function editVoucherTheme(int $voucher_theme_id, array $data): void { * @param int $voucher_theme_id primary key of the voucher theme record * * @return void - * - * @example - * + * + * @example + * * $this->model_sale_voucher_theme->deleteVoucherTheme($voucher_theme_id); */ public function deleteVoucherTheme(int $voucher_theme_id): void { @@ -80,9 +80,9 @@ public function deleteVoucherTheme(int $voucher_theme_id): void { * @param int $voucher_theme_id primary key of the voucher theme record * * @return array voucher theme record that has voucher theme ID - * - * @example - * + * + * @example + * * $voucher_theme_info = $this->model_sale_voucher_theme->getVoucherTheme($voucher_theme_id); */ public function getVoucherTheme(int $voucher_theme_id): array { @@ -97,9 +97,9 @@ public function getVoucherTheme(int $voucher_theme_id): array { * @param array $data array of filters * * @return array> voucher theme records - * + * * @example - * + * * $results = $this->model_sale_voucher_themes = $this->model_sale_voucher_theme->getVoucherThemes(); */ public function getVoucherThemes(array $data = []): array { @@ -148,9 +148,9 @@ public function getVoucherThemes(array $data = []): array { * @param int $voucher_theme_id primary key of the voucher theme record * * @return array> description records that have voucher theme ID - * - * @example - * + * + * @example + * * $voucher_theme_description = $this->model_sale_voucher_theme->getDescriptions($voucher_theme_id); */ public function getDescriptions(int $voucher_theme_id): array { @@ -169,9 +169,9 @@ public function getDescriptions(int $voucher_theme_id): array { * Get Total Voucher Themes * * @return int total number of voucher theme records - * - * @example - * + * + * @example + * * $voucher_total = $this->model_sale_voucher_theme->getTotalVoucherThemes(); */ public function getTotalVoucherThemes(): int { diff --git a/upload/admin/model/setting/event.php b/upload/admin/model/setting/event.php index e1c4d30be..67bb0cbb7 100644 --- a/upload/admin/model/setting/event.php +++ b/upload/admin/model/setting/event.php @@ -17,9 +17,9 @@ class ModelSettingEvent extends Model { * @param int $sort_order * * @return int returns the primary key of the new event record - * - * @example - * + * + * @example + * * $event_id = $this->model_setting_event->addEvent($code, $trigger, $action, $status, $sort_order); */ public function addEvent(string $code, string $trigger, string $action, int $status = 1, int $sort_order = 0): int { @@ -34,9 +34,9 @@ public function addEvent(string $code, string $trigger, string $action, int $sta * @param int $event_id primary key of the event record * * @return void - * + * * @example - * + * * $this->model_setting_event->deleteEvent($event_id); */ public function deleteEvent(int $event_id): void { @@ -49,9 +49,9 @@ public function deleteEvent(int $event_id): void { * @param string $code * * @return void - * - * @example - * + * + * @example + * * $this->model_setting_event->deleteEventByCode($code); */ public function deleteEventByCode(string $code): void { @@ -64,9 +64,9 @@ public function deleteEventByCode(string $code): void { * @param int $event_id primary key of the event record * * @return void - * - * @example - * + * + * @example + * * $this->model_setting_event->enableEvent($event_id); */ public function enableEvent(int $event_id): void { @@ -79,9 +79,9 @@ public function enableEvent(int $event_id): void { * @param int $event_id primary key of the event record * * @return void - * - * @example - * + * + * @example + * * $this->model_setting_event->disableEvent($event_id); */ public function disableEvent(int $event_id): void { @@ -95,9 +95,9 @@ public function disableEvent(int $event_id): void { * @param string $code * * @return void - * - * @example - * + * + * @example + * * $this->model_setting_event->uninstall($type, $code); */ public function uninstall(string $type, string $code): void { @@ -111,9 +111,9 @@ public function uninstall(string $type, string $code): void { * @param int $event_id primary key of the event record * * @return array event record that has event ID - * - * @example - * + * + * @example + * * $event_info = $this->model_setting_event->getEvent($event_id); */ public function getEvent(int $event_id): array { @@ -128,9 +128,9 @@ public function getEvent(int $event_id): array { * @param string $code * * @return array - * - * @example - * + * + * @example + * * $event_info = $this->model_setting_event->getEventByCode($code); */ public function getEventByCode(string $code): array { @@ -145,9 +145,9 @@ public function getEventByCode(string $code): array { * @param array $data array of filters * * @return array> event records - * - * @example - * + * + * @example + * * $results = $this->model_setting_event->getEvents(); */ public function getEvents(array $data = []): array { @@ -195,9 +195,9 @@ public function getEvents(array $data = []): array { * Get Total Events * * @return int total number of event records - * - * @example - * + * + * @example + * * $event_total = $this->model_setting_event->getTotalEvents(); */ public function getTotalEvents(): int { diff --git a/upload/admin/model/setting/extension.php b/upload/admin/model/setting/extension.php index 89fd9c1ec..175b1e1b9 100644 --- a/upload/admin/model/setting/extension.php +++ b/upload/admin/model/setting/extension.php @@ -13,9 +13,9 @@ class ModelSettingExtension extends Model { * @param string $type * * @return array> - * - * @example - * + * + * @example + * * $extensions = $this->model_setting_extension->getExtensionsByType($type); */ public function getExtensionsByType(string $type): array { @@ -37,9 +37,9 @@ public function getExtensionsByType(string $type): array { * @param string $code * * @return array - * - * @example - * + * + * @example + * * $extension_info = $this->model_setting_extension->getExtensionByCode($type, $code); */ public function getExtensionByCode(string $type, string $code): array { @@ -55,9 +55,9 @@ public function getExtensionByCode(string $type, string $code): array { * @param string $code * * @return void - * - * @example - * + * + * @example + * * $this->model_setting_extension->install($type, $code); */ public function install(string $type, string $code): void { @@ -75,9 +75,9 @@ public function install(string $type, string $code): void { * @param string $code * * @return void - * - * @example - * + * + * @example + * * $this->model_setting_extension->uninstall($type, $code); */ public function uninstall(string $type, string $code): void { @@ -92,9 +92,9 @@ public function uninstall(string $type, string $code): void { * @param int $extension_download_id primary key of the extension download record * * @return int install record that has extension download ID - * - * @example - * + * + * @example + * * $this->model_setting_extension->addExtensionInstall($filename, $extension_download_id); */ public function addExtensionInstall(string $filename, int $extension_download_id = 0): int { @@ -109,9 +109,9 @@ public function addExtensionInstall(string $filename, int $extension_download_id * @param int $extension_install_id primary key of the extension install record * * @return void - * - * @example - * + * + * @example + * * $this->model_setting_extension->deleteExtensionInstall($extension_download_id); */ public function deleteExtensionInstall(int $extension_install_id): void { @@ -125,9 +125,9 @@ public function deleteExtensionInstall(int $extension_install_id): void { * @param int $limit * * @return array> install records - * - * @example - * + * + * @example + * * $results = $this->model_setting_extension->getInstalls(); */ public function getInstalls(int $start = 0, int $limit = 10): array { @@ -150,9 +150,9 @@ public function getInstalls(int $start = 0, int $limit = 10): array { * @param int $extension_download_id primary key of the extension download record * * @return array install record that has extension download ID - * - * @example - * + * + * @example + * * $extension_install_info = $this->model_setting_extension->getInstallByExtensionDownloadId($extension_download_id); */ public function getInstallByExtensionDownloadId(int $extension_download_id): array { @@ -167,9 +167,9 @@ public function getInstallByExtensionDownloadId(int $extension_download_id): arr * @param string $code * * @return array - * - * @example - * + * + * @example + * * $extension_install_info = $this->model_setting_extension->getExtensionInstallByCode($code); */ public function getExtensionInstallByCode(string $code): array { @@ -182,9 +182,9 @@ public function getExtensionInstallByCode(string $code): array { * Get Total Installs * * @return int total number of install records - * - * @example - * + * + * @example + * * $install_total = $this->model_setting_extension->getTotalInstalls(); */ public function getTotalInstalls(): int { @@ -200,9 +200,9 @@ public function getTotalInstalls(): int { * @param string $path * * @return void - * - * @example - * + * + * @example + * * $this->model_setting_extension->addPath($extension_install_id, $path); */ public function addPath(int $extension_install_id, string $path): void { @@ -215,9 +215,9 @@ public function addPath(int $extension_install_id, string $path): void { * @param int $extension_path_id primary key of the extension path record * * @return void - * - * @example - * + * + * @example + * * $this->model_setting_extension->deletePath($extension_path_id); */ public function deletePath(int $extension_path_id): void { @@ -230,9 +230,9 @@ public function deletePath(int $extension_path_id): void { * @param int $extension_install_id primary key of the extension install record * * @return array> - * - * @example - * + * + * @example + * * $paths = $this->model_setting_extension->getPathsByExtensionInstallId($extension_install_id); */ public function getPathsByExtensionInstallId(int $extension_install_id): array { @@ -247,9 +247,9 @@ public function getPathsByExtensionInstallId(int $extension_install_id): array { * @param string $path * * @return array> - * - * @example - * + * + * @example + * * $paths = $this->model_setting_extension->getPaths($path); */ public function getPaths(string $path): array { @@ -264,9 +264,9 @@ public function getPaths(string $path): array { * @param string $path * * @return int - * - * @example - * + * + * @example + * * $path_total = $this->model_setting_extension->getTotalPaths($path); */ public function getTotalPaths(string $path): int { diff --git a/upload/admin/model/setting/modification.php b/upload/admin/model/setting/modification.php index a4d539e6a..40f62c599 100644 --- a/upload/admin/model/setting/modification.php +++ b/upload/admin/model/setting/modification.php @@ -13,9 +13,9 @@ class ModelSettingModification extends Model { * @param array $data array of data * * @return void - * - * @example - * + * + * @example + * * $this->model_setting_modification->addModification($data); */ public function addModification(array $data): void { @@ -28,9 +28,9 @@ public function addModification(array $data): void { * @param int $modification_id primary key of the modification record * * @return void - * - * @example - * + * + * @example + * * $this->model_setting_modification->deleteModification($modification_id); */ public function deleteModification(int $modification_id): void { @@ -43,9 +43,9 @@ public function deleteModification(int $modification_id): void { * @param int $extension_install_id primary key of the extension install record * * @return void - * - * @example - * + * + * @example + * * $this->model_setting_modification->deleteModificationsByExtensionInstallId($extension_install_id); */ public function deleteModificationsByExtensionInstallId(int $extension_install_id): void { @@ -58,9 +58,9 @@ public function deleteModificationsByExtensionInstallId(int $extension_install_i * @param int $modification_id primary key of the modification record * * @return void - * - * @example - * + * + * @example + * * $this->model_setting_modification->enableModification($modification_id); */ public function enableModification(int $modification_id): void { @@ -73,9 +73,9 @@ public function enableModification(int $modification_id): void { * @param int $modification_id primary key of the modification record * * @return void - * - * @example - * + * + * @example + * * $this->model_setting_modification->disableModification($modification_id); */ public function disableModification(int $modification_id): void { @@ -88,9 +88,9 @@ public function disableModification(int $modification_id): void { * @param int $modification_id primary key of the modification record * * @return array modification record that has modification ID - * + * * @example - * + * * $modification_info = $this->model_setting_modification->getModification($modification_id); */ public function getModification(int $modification_id): array { @@ -105,9 +105,9 @@ public function getModification(int $modification_id): array { * @param array $data array of filters * * @return array> modification records - * - * @example - * + * + * @example + * * $results = $this->model_setting_modification->getModifications(); */ public function getModifications(array $data = []): array { @@ -154,9 +154,9 @@ public function getModifications(array $data = []): array { * Get Total Modifications * * @return int total number of modification records - * - * @example - * + * + * @example + * * $modification_total = $this->model_setting_modification->getTotalModifications(); */ public function getTotalModifications(): int { @@ -171,9 +171,9 @@ public function getTotalModifications(): int { * @param string $code * * @return array - * - * @example - * + * + * @example + * * $modification_info = $this->model_setting_modification->getModificationByCode($code); */ public function getModificationByCode(string $code): array { diff --git a/upload/admin/model/setting/module.php b/upload/admin/model/setting/module.php index 38a728661..fc0c11954 100644 --- a/upload/admin/model/setting/module.php +++ b/upload/admin/model/setting/module.php @@ -14,9 +14,9 @@ class ModelSettingModule extends Model { * @param array $data array of data * * @return void - * - * @example - * + * + * @example + * * $this->model_setting_module->addModule($code, $data); */ public function addModule(string $code, array $data): void { @@ -30,9 +30,9 @@ public function addModule(string $code, array $data): void { * @param array $data * * @return void - * - * @example - * + * + * @example + * * $this->model_setting_module->editModule($module_id, $data); */ public function editModule(int $module_id, array $data): void { @@ -45,9 +45,9 @@ public function editModule(int $module_id, array $data): void { * @param int $module_id primary key of the module record * * @return void - * - * @example - * + * + * @example + * * $this->model_setting_module->deleteModule($module_id); */ public function deleteModule(int $module_id): void { @@ -61,9 +61,9 @@ public function deleteModule(int $module_id): void { * @param int $module_id primary key of the module record * * @return array module record that has the module ID - * - * @example - * + * + * @example + * * $module_info = $this->model_setting_module->getModule($module_id); */ public function getModule(int $module_id): array { @@ -80,9 +80,9 @@ public function getModule(int $module_id): array { * Get Modules * * @return array> module records - * - * @example - * + * + * @example + * * $results = $this->model_setting_module->getModules(); */ public function getModules(): array { @@ -97,9 +97,9 @@ public function getModules(): array { * @param string $code * * @return array> - * - * @example - * + * + * @example + * * $results = $this->model_setting_module->getModulesByCode($code); */ public function getModulesByCode(string $code): array { @@ -114,9 +114,9 @@ public function getModulesByCode(string $code): array { * @param string $code * * @return void - * - * @example - * + * + * @example + * * $this->model_setting_module->deleteModulesByCode($code); */ public function deleteModulesByCode(string $code): void { diff --git a/upload/admin/model/setting/setting.php b/upload/admin/model/setting/setting.php index b67ef1881..4a1dc244d 100644 --- a/upload/admin/model/setting/setting.php +++ b/upload/admin/model/setting/setting.php @@ -13,9 +13,9 @@ class ModelSettingSetting extends Model { * @param int $store_id * * @return array> setting records that have store ID - * - * @example - * + * + * @example + * * $results = $this->model_setting_setting->getSettings(); */ public function getSettings(int $store_id = 0): array { @@ -31,9 +31,9 @@ public function getSettings(int $store_id = 0): array { * @param int $store_id * * @return array - * - * @example - * + * + * @example + * * $setting_info = $this->model_setting_setting->getSetting($code, $store_id); */ public function getSetting(string $code, int $store_id = 0): array { @@ -60,9 +60,9 @@ public function getSetting(string $code, int $store_id = 0): array { * @param int $store_id * * @return void - * - * @example - * + * + * @example + * * $this->model_setting_setting->editSetting($code, $data, $store_id); */ public function editSetting(string $code, array $data, int $store_id = 0): void { @@ -86,9 +86,9 @@ public function editSetting(string $code, array $data, int $store_id = 0): void * @param int $store_id * * @return void - * - * @example - * + * + * @example + * * $this->model_setting_setting->deleteSetting($code, $store_id); */ public function deleteSetting(string $code, int $store_id = 0): void { @@ -102,9 +102,9 @@ public function deleteSetting(string $code, int $store_id = 0): void { * @param int $store_id * * @return string - * - * @example - * + * + * @example + * * $value = $this->model_setting_setting->getValue($key, $store_id); */ public function getValue(string $key, int $store_id = 0): string { @@ -126,9 +126,9 @@ public function getValue(string $key, int $store_id = 0): string { * @param int $store_id * * @return void - * - * @example - * + * + * @example + * * $this->model_setting_setting->editValue($code, $key, $value, $store_id); */ public function editValue(string $code = '', string $key = '', $value = '', int $store_id = 0): void { diff --git a/upload/admin/model/setting/store.php b/upload/admin/model/setting/store.php index 93aa8379a..ceee850ba 100644 --- a/upload/admin/model/setting/store.php +++ b/upload/admin/model/setting/store.php @@ -13,9 +13,9 @@ class ModelSettingStore extends Model { * @param array $data array of data * * @return int returns the primary key of the new store record - * - * @example - * + * + * @example + * * $store_id = $this->model_setting_store->addStore($data); */ public function addStore(array $data): int { @@ -42,9 +42,9 @@ public function addStore(array $data): int { * @param array $data array of data * * @return void - * - * @example - * + * + * @example + * * $this->model_setting_store->editStore($store_id, $data); */ public function editStore(int $store_id, array $data): void { @@ -59,9 +59,9 @@ public function editStore(int $store_id, array $data): void { * @param int $store_id * * @return void - * - * @example - * + * + * @example + * * $this->model_setting_store->deleteStore($store_id); */ public function deleteStore(int $store_id): void { @@ -96,9 +96,9 @@ public function deleteStore(int $store_id): void { * @param int $store_id * * @return array store record that has store ID - * - * @example - * + * + * @example + * * $store_info = $this->model_setting_store->getStore($store_id); */ public function getStore(int $store_id): array { @@ -113,9 +113,9 @@ public function getStore(int $store_id): array { * @param array $data array of filters * * @return array> store records - * - * @example - * + * + * @example + * * $stores = $this->model_setting_store->getStores(); */ public function getStores(array $data = []): array { @@ -136,9 +136,9 @@ public function getStores(array $data = []): array { * Get Total Stores * * @return int total number of store records - * - * @example - * + * + * @example + * * $store_total = $this->model_setting_store->getTotalStores(); */ public function getTotalStores(): int { @@ -153,9 +153,9 @@ public function getTotalStores(): int { * @param int $layout_id total number of store records that have layout ID * * @return int - * - * @example - * + * + * @example + * * $store_total = $this->model_setting_store->getTotalStoresByLayoutId($layout_id); */ public function getTotalStoresByLayoutId(int $layout_id): int { @@ -170,9 +170,9 @@ public function getTotalStoresByLayoutId(int $layout_id): int { * @param string $language * * @return int - * - * @example - * + * + * @example + * * $store_total = $this->model_setting_store->getTotalStoresByLanguage($language); */ public function getTotalStoresByLanguage(string $language): int { @@ -187,9 +187,9 @@ public function getTotalStoresByLanguage(string $language): int { * @param string $currency * * @return int - * - * @example - * + * + * @example + * * $store_total = $this->model_setting_store->getTotalStoresByCurrency($currency); */ public function getTotalStoresByCurrency(string $currency): int { @@ -204,9 +204,9 @@ public function getTotalStoresByCurrency(string $currency): int { * @param int $country_id primary key of the country record * * @return int total number of store records that have country ID - * - * @example - * + * + * @example + * * $store_total = $this->model_setting_store->getTotalStoresByCountryId($country_id); */ public function getTotalStoresByCountryId(int $country_id): int { @@ -221,9 +221,9 @@ public function getTotalStoresByCountryId(int $country_id): int { * @param int $zone_id primary key of the zone record * * @return int total number of store records that have zone ID - * - * @example - * + * + * @example + * * $store_total = $this->model_setting_store->getTotalStoresByZoneId($zone_id); */ public function getTotalStoresByZoneId(int $zone_id): int { @@ -238,9 +238,9 @@ public function getTotalStoresByZoneId(int $zone_id): int { * @param int $customer_group_id primary key of the customer group record * * @return int total number of store records that have customer group ID - * - * @example - * + * + * @example + * * $store_total = $this->model_setting_store->getTotalStoresByCustomerGroupId($customer_group_id); */ public function getTotalStoresByCustomerGroupId(int $customer_group_id): int { @@ -255,9 +255,9 @@ public function getTotalStoresByCustomerGroupId(int $customer_group_id): int { * @param int $information_id primary key of the information record * * @return int total number of store records that have information ID - * - * @example - * + * + * @example + * * $store_total = $this->model_setting_store->getTotalStoresByInformationId($information_id); */ public function getTotalStoresByInformationId(int $information_id): int { @@ -273,9 +273,9 @@ public function getTotalStoresByInformationId(int $information_id): int { * @param int $order_status_id primary key of the order status record * * @return int total number of store records that have order status ID - * - * @example - * + * + * @example + * * $store_total = $this->model_setting_store->getTotalStoresByOrderStatusId($order_status_id); */ public function getTotalStoresByOrderStatusId(int $order_status_id): int { diff --git a/upload/admin/model/tool/backup.php b/upload/admin/model/tool/backup.php index 01924d162..0ce42bc9f 100644 --- a/upload/admin/model/tool/backup.php +++ b/upload/admin/model/tool/backup.php @@ -11,9 +11,9 @@ class ModelToolBackup extends Model { * Get Tables * * @return array - * - * @example - * + * + * @example + * * $results = $this->model_tool_backup->getTables(); */ public function getTables(): array { @@ -40,9 +40,9 @@ public function getTables(): array { * @param int $limit * * @return array> - * - * @example - * + * + * @example + * * $results = $this->model_tool_backup->getRecords($table, $start, $limit); */ public function getRecords(string $table, int $start = 0, int $limit = 100): array { @@ -69,9 +69,9 @@ public function getRecords(string $table, int $start = 0, int $limit = 100): arr * @param string $table * * @return int - * - * @example - * + * + * @example + * * $record_total = $this->model_tool_backup->getTotalRecords($table); */ public function getTotalRecords(string $table): int { @@ -90,9 +90,9 @@ public function getTotalRecords(string $table): int { * @param array $tables * * @return string - * - * @example - * + * + * @example + * * $this->response->setOutput($this->model_tool_backup->backup($tables)); */ public function backup(array $tables): string { diff --git a/upload/admin/model/tool/image.php b/upload/admin/model/tool/image.php index add702a60..54531b725 100644 --- a/upload/admin/model/tool/image.php +++ b/upload/admin/model/tool/image.php @@ -18,9 +18,9 @@ class ModelToolImage extends Model { * @throws \Exception * * @return string - * - * @example - * + * + * @example + * * $placeholder = $this->model_tool_image->resize($filename, $width, $height, $default); */ public function resize(string $filename, int $width, int $height, string $default = ''): string { diff --git a/upload/admin/model/tool/upload.php b/upload/admin/model/tool/upload.php index 4df4d4e14..1e5f4decb 100644 --- a/upload/admin/model/tool/upload.php +++ b/upload/admin/model/tool/upload.php @@ -14,9 +14,9 @@ class ModelToolUpload extends Model { * @param string $filename * * @return string - * - * @example - * + * + * @example + * * $code = $this->model_tool_upload->addUpload($name, $filename); */ public function addUpload(string $name, string $filename): string { @@ -33,9 +33,9 @@ public function addUpload(string $name, string $filename): string { * @param int $upload_id primary key of the upload record * * @return void - * - * @example - * + * + * @example + * * $this->model_tool_upload->deleteUpload($upload_id); */ public function deleteUpload(int $upload_id): void { @@ -48,9 +48,9 @@ public function deleteUpload(int $upload_id): void { * @param int $upload_id primary key of the upload record * * @return array upload record that has upload ID - * - * @example - * + * + * @example + * * $upload_info = $this->model_tool_upload->getUpload($upload_id); */ public function getUpload(int $upload_id): array { @@ -65,9 +65,9 @@ public function getUpload(int $upload_id): array { * @param string $code * * @return array - * - * @example - * + * + * @example + * * $upload_info = $this->model_tool_upload->getUploadByCode($code); */ public function getUploadByCode(string $code): array { @@ -82,9 +82,9 @@ public function getUploadByCode(string $code): array { * @param array $data array of filters * * @return array> upload records - * - * @example - * + * + * @example + * * $results = $this->model_tool_upload->getUploads(); */ public function getUploads(array $data = []): array { @@ -149,9 +149,9 @@ public function getUploads(array $data = []): array { * @param array $data array of filters * * @return int total number of upload records - * - * @example - * + * + * @example + * * $upload_total = $this->model_tool_upload->getTotalUploads(); */ public function getTotalUploads($data = []): int { diff --git a/upload/admin/model/user/api.php b/upload/admin/model/user/api.php index fd1cafb08..00499051d 100644 --- a/upload/admin/model/user/api.php +++ b/upload/admin/model/user/api.php @@ -13,9 +13,9 @@ class ModelUserApi extends Model { * @param array $data array of data * * @return int returns the primary key of the new api record - * - * @example - * + * + * @example + * * $api_id = $this->model_user_api->addApi($data); */ public function addApi(array $data): int { @@ -41,9 +41,9 @@ public function addApi(array $data): int { * @param array $data array of data * * @return void - * - * @example - * + * + * @example + * * $this->model_user_api->editApi($api_id, $data); */ public function editApi(int $api_id, array $data): void { @@ -66,9 +66,9 @@ public function editApi(int $api_id, array $data): void { * @param int $api_id primary key of the api record * * @return void - * - * @example - * + * + * @example + * * $this->model_user_spi->deleteApi($api_id); */ public function deleteApi(int $api_id): void { @@ -81,9 +81,9 @@ public function deleteApi(int $api_id): void { * @param int $api_id primary key of the api record * * @return array api record that has api ID - * - * @example - * + * + * @example + * * $api_info = $this->model_user_api->getApi($api_id); */ public function getApi(int $api_id): array { @@ -98,9 +98,9 @@ public function getApi(int $api_id): array { * @param array $data array of filters * * @return array> api records - * - * @example - * + * + * @example + * * $results = $this->model_user_api->getApis(); */ public function getApis(array $data = []): array { @@ -146,9 +146,9 @@ public function getApis(array $data = []): array { * Get Total Apis * * @return int total number of api records - * - * @example - * + * + * @example + * * $api_total = $this->model_user_api->getTotalApis(); */ public function getTotalApis(): int { @@ -164,9 +164,9 @@ public function getTotalApis(): int { * @param string $ip * * @return void - * - * @example - * + * + * @example + * * $this->model_user_api->addIp($api_id, $ip); */ public function addIp(int $api_id, string $ip): void { @@ -179,9 +179,9 @@ public function addIp(int $api_id, string $ip): void { * @param int $api_id primary key of the api record * * @return array ip records that have api ID - * - * @example - * + * + * @example + * * $results = $this->model_user_api->getIps($api_id); */ public function getIps(int $api_id): array { @@ -198,9 +198,9 @@ public function getIps(int $api_id): array { * @param string $ip * * @return int returns the primary key of the new api session record - * - * @example - * + * + * @example + * * $api_session_id = $this->model_user_api->addSession($api_id, $session_id, $ip); */ public function addSession(int $api_id, string $session_id, string $ip): int { @@ -221,9 +221,9 @@ public function addSession(int $api_id, string $session_id, string $ip): int { * @param int $api_id primary key of the api record * * @return array> session records that have api ID - * - * @example - * + * + * @example + * * $results = $this->model_user_api->getSessions($api_id); */ public function getSessions(int $api_id): array { @@ -238,9 +238,9 @@ public function getSessions(int $api_id): array { * @param int $api_session_id primary key of the api session record * * @return void - * - * @example - * + * + * @example + * * $this->model_user_api->deleteSession($api_session_id); */ public function deleteSession(int $api_session_id): void { @@ -253,9 +253,9 @@ public function deleteSession(int $api_session_id): void { * @param string $session_id * * @return void - * - * @example - * + * + * @example + * * $this->model_user_api->deleteSessionBySessionId($session_id); */ public function deleteSessionBySessionId(string $session_id): void { diff --git a/upload/admin/model/user/user.php b/upload/admin/model/user/user.php index 23d8203a3..b43cc76e2 100644 --- a/upload/admin/model/user/user.php +++ b/upload/admin/model/user/user.php @@ -13,9 +13,9 @@ class ModelUserUser extends Model { * @param array $data array of data * * @return int returns the primary key of the new user record - * - * @example - * + * + * @example + * * $user_id = $this->model_user_user->addUser($data); */ public function addUser(array $data): int { @@ -31,9 +31,9 @@ public function addUser(array $data): int { * @param array $data array of data * * @return void - * - * @example - * + * + * @example + * * $this->model_user_user->editUser($user_id, $data); */ public function editUser(int $user_id, array $data): void { @@ -51,9 +51,9 @@ public function editUser(int $user_id, array $data): void { * @param string $password * * @return void - * - * @example - * + * + * @example + * * $this->model_user_user->editPassword($user_id, $password); */ public function editPassword(int $user_id, $password): void { @@ -67,9 +67,9 @@ public function editPassword(int $user_id, $password): void { * @param string $code * * @return void - * - * @example - * + * + * @example + * * $this->model_user_user->editCode($email, $code); */ public function editCode(string $email, string $code): void { @@ -82,9 +82,9 @@ public function editCode(string $email, string $code): void { * @param int $user_id primary key of the user record * * @return void - * - * @example - * + * + * @example + * * $this->model_user_user->deleteUser($user_id); */ public function deleteUser(int $user_id): void { @@ -97,9 +97,9 @@ public function deleteUser(int $user_id): void { * @param int $user_id primary key of the user record * * @return array user record that has user ID - * - * @example - * + * + * @example + * * $user_info = $this->model_user_user->getUser($user_id); */ public function getUser(int $user_id): array { @@ -114,9 +114,9 @@ public function getUser(int $user_id): array { * @param string $username * * @return array - * - * @example - * + * + * @example + * * $user_info = $this->model_user_user->getUserByUsername($username); */ public function getUserByUsername(string $username): array { @@ -131,9 +131,9 @@ public function getUserByUsername(string $username): array { * @param string $email * * @return array - * - * @example - * + * + * @example + * * $user_info = $this->model_user_user->getUserByEmail($email); */ public function getUserByEmail(string $email): array { @@ -148,9 +148,9 @@ public function getUserByEmail(string $email): array { * @param string $code * * @return array - * - * @example - * + * + * @example + * * $user_info = $this->model_user_user->getUserByCode($code); */ public function getUserByCode(string $code): array { @@ -165,9 +165,9 @@ public function getUserByCode(string $code): array { * @param array $data array of filters * * @return array> user records - * - * @example - * + * + * @example + * * $results = $this->model_user_user->getUsers(); */ public function getUsers(array $data = []): array { @@ -212,9 +212,9 @@ public function getUsers(array $data = []): array { * Get Total Users * * @return int total number of user records - * - * @example - * + * + * @example + * * $user_total = $this->model_user_user->getTotalUsers(); */ public function getTotalUsers(): int { @@ -229,9 +229,9 @@ public function getTotalUsers(): int { * @param int $user_group_id primary key of the user group record * * @return int total number of user records that have user group ID - * - * @example - * + * + * @example + * * $user_total = $this->model_user_user->getTotalUsersByGroupId($user_group_id); */ public function getTotalUsersByGroupId(int $user_group_id): int { @@ -246,9 +246,9 @@ public function getTotalUsersByGroupId(int $user_group_id): int { * @param string $email * * @return int - * - * @example - * + * + * @example + * * $user_total = $this->model_user_user->getTotalUsersByEmail($email); */ public function getTotalUsersByEmail(string $email): int { @@ -264,9 +264,9 @@ public function getTotalUsersByEmail(string $email): int { * @param array $data array of data * * @return void - * - * @example - * + * + * @example + * * $this->model_user_user->addLogin($user_id, $data); */ public function addLogin(int $user_id, array $data): void { @@ -281,9 +281,9 @@ public function addLogin(int $user_id, array $data): void { * @param int $limit * * @return array> login records that have user ID - * - * @example - * + * + * @example + * * $results = $this->model_user_user->getLogins($user_id, $start, $limit); */ public function getLogins(int $user_id, int $start = 0, int $limit = 10): array { @@ -310,9 +310,9 @@ public function getLogins(int $user_id, int $start = 0, int $limit = 10): array * @param int $user_id primary key of the user record * * @return int total number of login records that have user ID - * - * @example - * + * + * @example + * * $login_total = $this->model_user_user->getTotalLogins($user_id); */ public function getTotalLogins(int $user_id): int { diff --git a/upload/admin/model/user/user_group.php b/upload/admin/model/user/user_group.php index 20fef5941..8f52402e6 100644 --- a/upload/admin/model/user/user_group.php +++ b/upload/admin/model/user/user_group.php @@ -13,9 +13,9 @@ class ModelUserUserGroup extends Model { * @param array $data array of data * * @return int returns the primary key of the new user group record - * - * @example - * + * + * @example + * * $user_group_id = $this->model_user_user_group->addUserGroup($data); */ public function addUserGroup(array $data): int { @@ -31,9 +31,9 @@ public function addUserGroup(array $data): int { * @param array $data array of data * * @return void - * - * @example - * + * + * @example + * * $this->model_user_user_group->editUserGroup($user_group_id, $data); */ public function editUserGroup(int $user_group_id, array $data): void { @@ -46,9 +46,9 @@ public function editUserGroup(int $user_group_id, array $data): void { * @param int $user_group_id primary key of the user group record * * @return void - * - * @example - * + * + * @example + * * $this->model_user_user_group->deleteUserGroup($user_group_id); */ public function deleteUserGroup(int $user_group_id): void { @@ -61,9 +61,9 @@ public function deleteUserGroup(int $user_group_id): void { * @param int $user_group_id primary key of the user group record * * @return array user group that has user group ID - * - * @example - * + * + * @example + * * $usergroup_info = $this->model_user_user_group->getUserGroup($user_group_id); */ public function getUserGroup(int $user_group_id): array { @@ -81,9 +81,9 @@ public function getUserGroup(int $user_group_id): array { * @param array $data array of filters * * @return array> user group records - * - * @example - * + * + * @example + * * $results = $this->model_user_user_group->getUserGroups(); */ public function getUserGroups(array $data = []): array { @@ -118,9 +118,9 @@ public function getUserGroups(array $data = []): array { * Get Total User Groups * * @return int total number of user group records - * - * @example - * + * + * @example + * * $usergroup_total = $this->model_user_user_group->getTotalUserGroups(); */ public function getTotalUserGroups(): int { @@ -137,9 +137,9 @@ public function getTotalUserGroups(): int { * @param string $route * * @return void - * - * @example - * + * + * @example + * * $this->model_user_user_group->addPermission($user_group_id, $type, $route); */ public function addPermission(int $user_group_id, string $type, string $route): void { @@ -161,9 +161,9 @@ public function addPermission(int $user_group_id, string $type, string $route): * @param string $route * * @return void - * - * @example - * + * + * @example + * * $this->model_user_user_group->removePermission($user_group_id, $type, $route); */ public function removePermission(int $user_group_id, string $type, string $route): void {