Files
wp-graphql-woocommerce/includes/model/class-product-variation.php
Geoff TaylorandGitHub 088d337ef5 fix: address WordPress.org plugin review (rename + prefixing + headers) (#1019)
* fix: address WordPress.org plugin review feedback

- Prefix the session transaction queue transient with the plugin's
  graphql_woocommerce_ namespace instead of the generic "woo_" word, to
  avoid collisions (Plugin Directory: prefix data storage).
- Declare the WooCommerce dependency via the "Requires Plugins: woocommerce"
  plugin header.
- Bump README.txt "Tested up to" to 7.0.
- Ship composer.json in the distributed plugin (drop it, and composer.lock,
  from composer archive excludes) so the build is reproducible/reviewable.

* chore: rename plugin to "GraphQL for eCommerce" for trademark compliance

The WordPress.org plugin review flagged the display name/slug for beginning
with the "WPGraphQL" trademark (and the "WooGraphQL" portmanteau of the
WooCommerce mark), which can imply official affiliation.

- Display name (plugin header + readme title) -> "GraphQL for eCommerce".
- Slug/text domain -> "graphql-for-ecommerce" (header, all i18n string
  literals, and the PHPCS WordPress.WP.I18n text_domain config).
- Update user-facing notices/errors that named the old plugin.

"WooGraphQL" remains the project's informal nickname (repo, docs, community),
just not in the WordPress.org directory's official name/slug. Internal file
names and GitHub URLs are unchanged.

* fix: keep test-only dev deps out of the committed composer.json

The committed manifest mirrors develop (lint/stan dev deps only); CI adds the
test suite deps at runtime via `composer installTestEnv`. A previous commit
captured the installTestEnv-modified composer.json, desyncing it from
composer.lock and breaking `composer install` in CI.

* chore: regenerate composer.lock (refresh dev dependencies)

Regenerate the lock from the manifest so it is in sync (fixes the CI
`composer install` failure) and refresh dependencies in the process —
firebase/php-jwt v7.0.4 -> v7.1.0 plus 11 others, with vendor-prefixed
re-strauss'd to match. Full wpunit suite passes against the updated deps
(305 tests, 835 assertions).

* chore: rename text domain in createdVia/attribution strings from #1018

#1018 (createdVia + order attribution) merged into develop after the rename
commit was authored, so its new i18n strings still used the old
'wp-graphql-woocommerce' text domain. Update them to 'graphql-for-ecommerce'
to match the rename.
2026-06-30 10:16:21 -04:00

255 lines
9.0 KiB
PHP

<?php
/**
* Model - Product_Variation
*
* Resolves product variation crud object model
*
* @package WPGraphQL\WooCommerce\Model
* @since 0.0.1
*/
namespace WPGraphQL\WooCommerce\Model;
use GraphQLRelay\Relay;
/**
* Class Product_Variation
*
* @property \WC_Product_Variation $wc_data
*
* @property int $ID
* @property string $id
* @property string $name
* @property string $date
* @property string $modified
* @property string $description
* @property string $sku
* @property string $price
* @property float $priceRaw
* @property string $regularPrice
* @property float $regularPriceRaw
* @property string $salePrice
* @property float $salePriceRaw
* @property string $dateOnSaleFrom
* @property string $dateOnSaleTo
* @property bool $onSale
* @property string $status
* @property bool $purchasable
* @property bool $virtual
* @property bool $downloadable
* @property array $downloads
* @property int $downloadLimit
* @property int $downloadExpiry
* @property string $taxStatus
* @property string $taxClass
* @property bool $manageStock
* @property int $stockQuantity
* @property string $stockStatus
* @property string $backorders
* @property bool $backordersAllowed
* @property float $weight
* @property float $length
* @property float $width
* @property float $height
* @property int $menuOrder
* @property string $purchaseNote
* @property string $catalogVisibility
* @property bool $hasAttributes
* @property string $type
* @property int $parent_id
* @property string $parentId
* @property int $shipping_class_id
* @property int $image_id
* @property array $attributes
*
* @package WPGraphQL\WooCommerce\Model
*/
class Product_Variation extends WC_Post {
/**
* Product_Variation constructor
*
* @param int|\WC_Data $id - product_variation post-type ID.
*
* @throws \Exception If product variation cannot be retrieved.
*/
public function __construct( $id ) {
$data = \wc_get_product( $id );
// Check if product variation is valid.
if ( ! is_object( $data ) ) {
throw new \Exception( __( 'Failed to retrieve product variation data source', 'graphql-for-ecommerce' ) );
}
parent::__construct( $data );
}
/**
* Returns the product variation type.
*
* @return string
*/
public function get_type() {
return $this->wc_data->get_type();
}
/**
* Initializes the ProductVariation field resolvers.
*/
protected function init() {
if ( empty( $this->fields ) ) {
parent::init();
$fields = [
'ID' => function () {
return ! empty( $this->wc_data->get_id() ) ? $this->wc_data->get_id() : null;
},
'id' => function () {
return ! empty( $this->ID ) ? Relay::toGlobalId( 'post', "{$this->ID}" ) : null;
},
'name' => function () {
return ! empty( $this->wc_data->get_name() ) ? $this->wc_data->get_name() : null;
},
'date' => function () {
return ! empty( $this->wc_data ) ? $this->wc_data->get_date_created() : null;
},
'modified' => function () {
return ! empty( $this->wc_data ) ? $this->wc_data->get_date_modified() : null;
},
'description' => function () {
return ! empty( $this->wc_data->get_description() ) ? $this->wc_data->get_description() : null;
},
'sku' => function () {
return ! empty( $this->wc_data->get_sku() ) ? $this->wc_data->get_sku() : null;
},
'price' => function () {
return ! empty( $this->wc_data->get_price() )
? wc_graphql_price( \wc_get_price_to_display( $this->wc_data, [ 'price' => $this->wc_data->get_price() ] ) )
: null;
},
'regularPrice' => function () {
return ! empty( $this->wc_data->get_regular_price() )
? wc_graphql_price( \wc_get_price_to_display( $this->wc_data, [ 'price' => $this->wc_data->get_regular_price() ] ) )
: null;
},
'salePrice' => function () {
return ! empty( $this->wc_data->get_sale_price() )
? wc_graphql_price( \wc_get_price_to_display( $this->wc_data, [ 'price' => $this->wc_data->get_sale_price() ] ) )
: null;
},
'dateOnSaleFrom' => function () {
return ! empty( $this->wc_data->get_date_on_sale_from() ) ? $this->wc_data->get_date_on_sale_from() : null;
},
'dateOnSaleTo' => function () {
return ! empty( $this->wc_data->get_date_on_sale_to() ) ? $this->wc_data->get_date_on_sale_to() : null;
},
'onSale' => function () {
return $this->wc_data->is_on_sale();
},
'status' => function () {
return ! empty( $this->wc_data->get_status() ) ? $this->wc_data->get_status() : null;
},
'purchasable' => function () {
return ! empty( $this->wc_data->is_purchasable() ) ? $this->wc_data->is_purchasable() : null;
},
'virtual' => function () {
return $this->wc_data->is_virtual();
},
'downloadable' => function () {
return $this->wc_data->is_downloadable();
},
'downloads' => function () {
return ! empty( $this->wc_data->get_downloads() ) ? $this->wc_data->get_downloads() : null;
},
'downloadLimit' => function () {
return ! empty( $this->wc_data->get_download_limit() ) ? $this->wc_data->get_download_limit() : null;
},
'downloadExpiry' => function () {
return ! empty( $this->wc_data->get_download_expiry() ) ? $this->wc_data->get_download_expiry() : null;
},
'taxStatus' => function () {
return ! empty( $this->wc_data->get_tax_status() ) ? $this->wc_data->get_tax_status() : null;
},
'taxClass' => function () {
return $this->wc_data->get_tax_class();
},
'manageStock' => function () {
return ! empty( $this->wc_data->get_manage_stock() ) ? $this->wc_data->get_manage_stock() : null;
},
'stockQuantity' => function () {
return ! empty( $this->wc_data->get_stock_quantity() ) ? $this->wc_data->get_stock_quantity() : null;
},
'stockStatus' => function () {
return ! empty( $this->wc_data->get_stock_status() ) ? $this->wc_data->get_stock_status() : null;
},
'backorders' => function () {
return ! empty( $this->wc_data->get_backorders() ) ? $this->wc_data->get_backorders() : null;
},
'backordersAllowed' => function () {
return $this->wc_data->backorders_allowed();
},
'weight' => function () {
return ! empty( $this->wc_data->get_weight() ) ? $this->wc_data->get_weight() : null;
},
'length' => function () {
return ! empty( $this->wc_data->get_length() ) ? $this->wc_data->get_length() : null;
},
'width' => function () {
return ! empty( $this->wc_data->get_width() ) ? $this->wc_data->get_width() : null;
},
'height' => function () {
return ! empty( $this->wc_data->get_height() ) ? $this->wc_data->get_height() : null;
},
'menuOrder' => function () {
return $this->wc_data->get_menu_order();
},
'purchaseNote' => function () {
return ! empty( $this->wc_data->get_purchase_note() ) ? $this->wc_data->get_purchase_note() : null;
},
'catalogVisibility' => function () {
return ! empty( $this->wc_data->get_catalog_visibility() ) ? $this->wc_data->get_catalog_visibility() : null;
},
'hasAttributes' => function () {
return ! empty( $this->wc_data->has_attributes() ) ? $this->wc_data->has_attributes() : null;
},
'type' => function () {
return ! empty( $this->wc_data->get_type() ) ? $this->wc_data->get_type() : null;
},
'priceRaw' => function () {
return ! empty( $this->wc_data->get_price() ) ? $this->wc_data->get_price() : null;
},
'regularPriceRaw' => function () {
return ! empty( $this->wc_data->get_regular_price() ) ? $this->wc_data->get_regular_price() : null;
},
'salePriceRaw' => function () {
return ! empty( $this->wc_data->get_sale_price() ) ? $this->wc_data->get_sale_price() : null;
},
/**
* Connection resolvers fields
*
* These field resolvers are used in connection resolvers to define WP_Query argument.
* Note: underscore naming style is used as a quick identifier
*/
'parent_id' => function () {
return ! empty( $this->wc_data->get_parent_id() ) ? $this->wc_data->get_parent_id() : null;
},
'parentId' => function () {
return ! empty( $this->wc_data->get_parent_id() ) ? Relay::toGlobalId( 'post', (string) $this->wc_data->get_parent_id() ) : null;
},
'shipping_class_id' => function () {
return ! empty( $this->wc_data->get_shipping_class_id() ) ? $this->wc_data->get_shipping_class_id() : null;
},
'image_id' => function () {
return ! empty( $this->wc_data->get_image_id() ) ? $this->wc_data->get_image_id() : null;
},
'attributes' => function () {
return ! empty( $this->wc_data->get_attributes() ) ? $this->wc_data->get_attributes() : null;
},
];
$this->fields = array_merge( $this->fields, $fields );
}//end if
}
}