More PHPDocs work in library/cart

opencart · Jan 1, 2025 · ffb0b7e · ffb0b7e
1 parent 288dc90
commit ffb0b7e
Show file tree

Hide file tree

Showing 7 changed files with 62 additions and 62 deletions.
diff --git a/upload/system/library/cart/cart.php b/upload/system/library/cart/cart.php
@@ -63,9 +63,9 @@ public function __construct(object $registry) {
 	}
 
 	/**
-	 * getProducts
+	 * Get Products
 	 *
-	 * @return array<int, array<string, mixed>>
+	 * @return array<int, array<string, mixed>> product records
 	 */
 	public function getProducts(): array {
 		$product_data = [];
@@ -317,10 +317,10 @@ public function getProducts(): array {
 	/**
 	 * Add
 	 *
-	 * @param int          $product_id
+	 * @param int          $product_id           primary key of the product record
 	 * @param int          $quantity
 	 * @param array<mixed> $option
-	 * @param int          $subscription_plan_id
+	 * @param int          $subscription_plan_id primary key of the subscription plan record
 	 * @param bool         $override
 	 * @param float        $price
 	 *
@@ -345,7 +345,7 @@ public function add(int $product_id, int $quantity = 1, array $option = [], int
 	/**
 	 * Update
 	 *
-	 * @param int $cart_id
+	 * @param int $cart_id  primary key of the cart record
 	 * @param int $quantity
 	 *
 	 * @return void
@@ -363,7 +363,7 @@ public function update(int $cart_id, int $quantity): void {
 	/**
 	 * Remove
 	 *
-	 * @param int $cart_id
+	 * @param int $cart_id primary key of the cart record
 	 *
 	 * @return void
 	 */
@@ -385,9 +385,9 @@ public function clear(): void {
 	}
 
 	/**
-	 * getSubscriptions
+	 * Get Subscriptions
 	 *
-	 * @return array<int, array<string, mixed>>
+	 * @return array<int, array<string, mixed>> subscription records
 	 */
 	public function getSubscriptions(): array {
 		$product_data = [];
@@ -402,7 +402,7 @@ public function getSubscriptions(): array {
 	}
 
 	/**
-	 * getWeight
+	 * Get Weight
 	 *
 	 * @return float
 	 */
@@ -419,7 +419,7 @@ public function getWeight(): float {
 	}
 
 	/**
-	 * getSubtotal
+	 * Get Sub Total
 	 *
 	 * @return float
 	 */
@@ -434,9 +434,9 @@ public function getSubTotal(): float {
 	}
 
 	/**
-	 * getTaxes
+	 * Get Taxes
 	 *
-	 * @return array<int, array<string, mixed>>
+	 * @return array<int, float>
 	 */
 	public function getTaxes(): array {
 		$tax_data = [];
@@ -459,7 +459,7 @@ public function getTaxes(): array {
 	}
 
 	/**
-	 * getTotal
+	 * Get Total
 	 *
 	 * @return float
 	 */
@@ -474,7 +474,7 @@ public function getTotal(): float {
 	}
 
 	/**
-	 * countProducts
+	 * Count Products
 	 *
 	 * @return int
 	 */
@@ -491,7 +491,7 @@ public function countProducts(): int {
 	}
 
 	/**
-	 * hasProducts
+	 * Has Products
 	 *
 	 * @return bool
 	 */
@@ -500,7 +500,7 @@ public function hasProducts(): bool {
 	}
 
 	/**
-	 * hasSubscription
+	 * Has Subscription
 	 *
 	 * @return bool
 	 */
@@ -509,7 +509,7 @@ public function hasSubscription(): bool {
 	}
 
 	/**
-	 * hasStock
+	 * Has Stock
 	 *
 	 * @return bool
 	 */
@@ -524,7 +524,7 @@ public function hasStock(): bool {
 	}
 
 	/**
-	 * hasShipping
+	 * Has Shipping
 	 *
 	 * @return bool
 	 */
@@ -539,7 +539,7 @@ public function hasShipping(): bool {
 	}
 
 	/**
-	 * hasDownload
+	 * Has Download
 	 *
 	 * @return bool
 	 */

diff --git a/upload/system/library/cart/currency.php b/upload/system/library/cart/currency.php
@@ -108,7 +108,7 @@ public function convert(float $value, string $from, string $to): float {
 	}
 
 	/**
-	 * getId
+	 * Get ID
 	 *
 	 * @param string $currency
 	 *
@@ -123,7 +123,7 @@ public function getId(string $currency): int {
 	}
 
 	/**
-	 * getSymbolLeft
+	 * Get Symbol Left
 	 *
 	 * @param string $currency
 	 *
@@ -138,7 +138,7 @@ public function getSymbolLeft(string $currency): string {
 	}
 
 	/**
-	 * getSymbolRight
+	 * Get Symbol Right
 	 *
 	 * @param string $currency
 	 *
@@ -153,7 +153,7 @@ public function getSymbolRight(string $currency): string {
 	}
 
 	/**
-	 * getDecimalPlace
+	 * Get Decimal Place
 	 *
 	 * @param string $currency
 	 *
@@ -168,7 +168,7 @@ public function getDecimalPlace(string $currency): string {
 	}
 
 	/**
-	 * getValue
+	 * Get Value
 	 *
 	 * @param string $currency
 	 *

diff --git a/upload/system/library/cart/customer.php b/upload/system/library/cart/customer.php
@@ -141,7 +141,7 @@ public function logout(): void {
 	}
 
 	/**
-	 * isLogged
+	 * Is Logged
 	 *
 	 * @return bool
 	 */
@@ -150,7 +150,7 @@ public function isLogged(): bool {
 	}
 
 	/**
-	 * getId
+	 * Get ID
 	 *
 	 * @return int
 	 */
@@ -159,7 +159,7 @@ public function getId(): int {
 	}
 
 	/**
-	 * getFirstName
+	 * Get First Name
 	 *
 	 * @return string
 	 */
@@ -168,7 +168,7 @@ public function getFirstName(): string {
 	}
 
 	/**
-	 * getLastName
+	 * Get Last Name
 	 *
 	 * @return string
 	 */
@@ -177,7 +177,7 @@ public function getLastName(): string {
 	}
 
 	/**
-	 * getGroupId
+	 * Get Group ID
 	 *
 	 * @return int
 	 */
@@ -186,7 +186,7 @@ public function getGroupId(): int {
 	}
 
 	/**
-	 * getEmail
+	 * Get Email
 	 *
 	 * @return string
 	 */
@@ -195,7 +195,7 @@ public function getEmail(): string {
 	}
 
 	/**
-	 * getTelephone
+	 * Get Telephone
 	 *
 	 * @return string
 	 */
@@ -204,7 +204,7 @@ public function getTelephone(): string {
 	}
 
 	/**
-	 * getNewsletter
+	 * Get Newsletter
 	 *
 	 * @return bool
 	 */
@@ -213,7 +213,7 @@ public function getNewsletter(): bool {
 	}
 
 	/**
-	 * getAddressId
+	 * Get Address ID
 	 *
 	 * @return int
 	 */
@@ -228,7 +228,7 @@ public function getAddressId(): int {
 	}
 
 	/**
-	 * getBalance
+	 * Get Balance
 	 *
 	 * @return float
 	 */
@@ -239,7 +239,7 @@ public function getBalance(): float {
 	}
 
 	/**
-	 * getRewardPoints
+	 * Get Reward Points
 	 *
 	 * @return float
 	 */

diff --git a/upload/system/library/cart/length.php b/upload/system/library/cart/length.php
@@ -68,7 +68,7 @@ public function convert(float $value, string $from, string $to): float {
 	 * Format
 	 *
 	 * @param float  $value
-	 * @param int    $length_class_id
+	 * @param int    $length_class_id primary key of the length class record
 	 * @param string $decimal_point
 	 * @param string $thousand_point
 	 *
@@ -83,9 +83,9 @@ public function format(float $value, int $length_class_id, string $decimal_point
 	}
 
 	/**
-	 * getUnit
+	 * Get Unit
 	 *
-	 * @param int $length_class_id
+	 * @param int $length_class_id primary key of the length class record
 	 *
 	 * @return string
 	 */

diff --git a/upload/system/library/cart/tax.php b/upload/system/library/cart/tax.php
@@ -25,10 +25,10 @@ public function __construct(object $registry) {
 	}
 
 	/**
-	 * setShippingAddress
+	 * Set Shipping Address
 	 *
-	 * @param int $country_id
-	 * @param int $zone_id
+	 * @param int $country_id primary key of the country record
+	 * @param int $zone_id    primary key of the zone record
 	 *
 	 * @return void
 	 */
@@ -47,10 +47,10 @@ public function setShippingAddress(int $country_id, int $zone_id): void {
 	}
 
 	/**
-	 * setPaymentAddress
+	 * Set Payment Address
 	 *
-	 * @param int $country_id
-	 * @param int $zone_id
+	 * @param int $country_id primary key of the country record
+	 * @param int $zone_id    primary key of the zone record
 	 *
 	 * @return void
 	 */
@@ -69,10 +69,10 @@ public function setPaymentAddress(int $country_id, int $zone_id): void {
 	}
 
 	/**
-	 * setStoreAddress
+	 * Set Store Address
 	 *
-	 * @param int $country_id
-	 * @param int $zone_id
+	 * @param int $country_id primary key of the country record
+	 * @param int $zone_id    primary key of the zone record
 	 *
 	 * @return void
 	 */
@@ -94,7 +94,7 @@ public function setStoreAddress(int $country_id, int $zone_id): void {
 	 * Calculate
 	 *
 	 * @param float $value
-	 * @param int   $tax_class_id
+	 * @param int   $tax_class_id primary key of the tax class record
 	 * @param bool  $calculate
 	 *
 	 * @return float
@@ -120,10 +120,10 @@ public function calculate(float $value, int $tax_class_id, bool $calculate = tru
 	}
 
 	/**
-	 * getTax
+	 * Get Tax
 	 *
 	 * @param float $value
-	 * @param int   $tax_class_id
+	 * @param int   $tax_class_id primary key of the tax class record
 	 *
 	 * @return float
 	 */
@@ -140,9 +140,9 @@ public function getTax(float $value, int $tax_class_id): float {
 	}
 
 	/**
-	 * getRateName
+	 * Get Rate Name
 	 *
-	 * @param int $tax_rate_id
+	 * @param int $tax_rate_id primary key of the tax rate record
 	 *
 	 * @return string
 	 */
@@ -160,7 +160,7 @@ public function getRateName(int $tax_rate_id): string {
 	 * getRates
 	 *
 	 * @param float $value
-	 * @param int   $tax_class_id
+	 * @param int   $tax_class_id primary key of the tax class record
 	 *
 	 * @return array<int, array<string, mixed>>
 	 */