Skip to content

Add option to Change the created_via field. #609

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: develop
Choose a base branch
from
Open

Add option to Change the created_via field. #609

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3a0db73
Add option to Change the created_via field.
scottyzen May 22, 2023
c3235c0
Rebase
scottyzen May 22, 2023
c981aec
Add createdVia to unit tests
scottyzen Jan 23, 2023
4563748
Add createdVia to unit tests
scottyzen Jan 23, 2023
8317b39
Rebase
scottyzen May 22, 2023
0492ead
Merge remote-tracking branch 'upstream/master' into develop
scottyzen Mar 30, 2025
231622a
refactor: Replace array() with short array syntax in OrderMutationsTest
scottyzen Mar 30, 2025
1628fdb
fix: Remove unused 'createdVia' field from CheckoutMutationTest
scottyzen Mar 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
387 changes: 198 additions & 189 deletions includes/mutation/class-order-create.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,193 +20,202 @@
/**
* Class Order_Create
*/
class Order_Create {
/**
* Registers mutation
*
* @return void
*/
public static function register_mutation() {
register_graphql_mutation(
'createOrder',
[
'inputFields' => self::get_input_fields(),
'outputFields' => self::get_output_fields(),
'mutateAndGetPayload' => self::mutate_and_get_payload(),
]
);
}

/**
* Defines the mutation input field configuration
*
* @return array
*/
public static function get_input_fields() {
return [
'parentId' => [
'type' => 'Int',
'description' => __( 'Parent order ID.', 'wp-graphql-woocommerce' ),
],
'currency' => [
'type' => 'CurrencyEnum',
'description' => __( 'Currency the order was created with, in ISO format.', 'wp-graphql-woocommerce' ),
],
'customerId' => [
'type' => 'Int',
'description' => __( 'Order customer ID', 'wp-graphql-woocommerce' ),
],
'customerNote' => [
'type' => 'String',
'description' => __( 'Note left by customer during checkout.', 'wp-graphql-woocommerce' ),
],
'coupons' => [
'type' => [ 'list_of' => 'String' ],
'description' => __( 'Coupons codes to be applied to order', 'wp-graphql-woocommerce' ),
],
'status' => [
'type' => 'OrderStatusEnum',
'description' => __( 'Order status', 'wp-graphql-woocommerce' ),
],
'paymentMethod' => [
'type' => 'String',
'description' => __( 'Payment method ID.', 'wp-graphql-woocommerce' ),
],
'paymentMethodTitle' => [
'type' => 'String',
'description' => __( 'Payment method title.', 'wp-graphql-woocommerce' ),
],
'transactionId' => [
'type' => 'String',
'description' => __( 'Order transaction ID', 'wp-graphql-woocommerce' ),
],
'billing' => [
'type' => 'CustomerAddressInput',
'description' => __( 'Order billing address', 'wp-graphql-woocommerce' ),
],
'shipping' => [
'type' => 'CustomerAddressInput',
'description' => __( 'Order shipping address', 'wp-graphql-woocommerce' ),
],
'lineItems' => [
'type' => [ 'list_of' => 'LineItemInput' ],
'description' => __( 'Order line items', 'wp-graphql-woocommerce' ),
],
'shippingLines' => [
'type' => [ 'list_of' => 'ShippingLineInput' ],
'description' => __( 'Order shipping lines', 'wp-graphql-woocommerce' ),
],
'feeLines' => [
'type' => [ 'list_of' => 'FeeLineInput' ],
'description' => __( 'Order shipping lines', 'wp-graphql-woocommerce' ),
],
'metaData' => [
'type' => [ 'list_of' => 'MetaDataInput' ],
'description' => __( 'Order meta data', 'wp-graphql-woocommerce' ),
],
'isPaid' => [
'type' => 'Boolean',
'description' => __( 'Define if the order is paid. It will set the status to processing and reduce stock items.', 'wp-graphql-woocommerce' ),
],
];
}

/**
* Defines the mutation output field configuration
*
* @return array
*/
public static function get_output_fields() {
return [
'order' => [
'type' => 'Order',
'resolve' => static function ( $payload ) {
return new Order( $payload['id'] );
},
],
'orderId' => [
'type' => 'Int',
'resolve' => static function ( $payload ) {
return $payload['id'];
},
],
];
}

/**
* Defines the mutation data modification closure.
*
* @return callable
*/
public static function mutate_and_get_payload() {
return static function ( $input, AppContext $context, ResolveInfo $info ) {
// Check if authorized to create this order.
if ( ! Order_Mutation::authorized( $input, $context, $info, 'create', null ) ) {
throw new UserError( __( 'User does not have the capabilities necessary to create an order.', 'wp-graphql-woocommerce' ) );
}

// Create order.
$order = null;
try {
$order_id = Order_Mutation::create_order( $input, $context, $info );
Order_Mutation::add_order_meta( $order_id, $input, $context, $info );
Order_Mutation::add_items( $input, $order_id, $context, $info );

// Apply coupons.
if ( ! empty( $input['coupons'] ) ) {
Order_Mutation::apply_coupons( $order_id, $input['coupons'] );
}

$order = WC_Order_Factory::get_order( $order_id );

if ( ! is_object( $order ) ) {
throw new UserError( __( 'Order could not be created.', 'wp-graphql-woocommerce' ) );
}

// Make sure gateways are loaded so hooks from gateways fire on save/create.
WC()->payment_gateways();

// Validate customer ID, if set.
if ( ! empty( $input['customerId'] ) && ! Order_Mutation::validate_customer( $input['customerId'] ) ) {
throw new UserError( __( 'Customer ID is invalid.', 'wp-graphql-woocommerce' ) );
}

$order->set_created_via( 'graphql-api' );
$order->set_prices_include_tax( 'yes' === get_option( 'woocommerce_prices_include_tax' ) );
$order->calculate_totals( true );

// Set status.
if ( ! empty( $input['status'] ) ) {
$order->set_status( $input['status'] );
}

// Actions for after the order is saved.
if ( true === $input['isPaid'] ) {
$order->payment_complete(
! empty( $input['transactionId'] ) ? $input['transactionId'] : ''
);
}

/**
* Action called after order is created.
*
* @param \WC_Order $order WC_Order instance.
* @param array $input Input data describing order.
* @param \WPGraphQL\AppContext $context Request AppContext instance.
* @param \GraphQL\Type\Definition\ResolveInfo $info Request ResolveInfo instance.
*/
do_action( 'graphql_woocommerce_after_order_create', $order, $input, $context, $info );

return [ 'id' => $order->get_id() ];
} catch ( \Throwable $e ) {
// Delete order if it was created.
if ( is_object( $order ) ) {
Order_Mutation::purge( $order );
}

// Throw error.
throw new UserError( $e->getMessage() );
}//end try
};
}
class Order_Create
{
/**
* Registers mutation
*
* @return void
*/
public static function register_mutation()
{
register_graphql_mutation(
'createOrder',
[
'inputFields' => self::get_input_fields(),
'outputFields' => self::get_output_fields(),
'mutateAndGetPayload' => self::mutate_and_get_payload(),
]
);
}

/**
* Defines the mutation input field configuration
*
* @return array
*/
public static function get_input_fields()
{
return [
'parentId' => [
'type' => 'Int',
'description' => __('Parent order ID.', 'wp-graphql-woocommerce'),
],
'currency' => [
'type' => 'CurrencyEnum',
'description' => __('Currency the order was created with, in ISO format.', 'wp-graphql-woocommerce'),
],
'customerId' => [
'type' => 'Int',
'description' => __('Order customer ID', 'wp-graphql-woocommerce'),
],
'customerNote' => [
'type' => 'String',
'description' => __('Note left by customer during checkout.', 'wp-graphql-woocommerce'),
],
'coupons' => [
'type' => ['list_of' => 'String'],
'description' => __('Coupons codes to be applied to order', 'wp-graphql-woocommerce'),
],
'status' => [
'type' => 'OrderStatusEnum',
'description' => __('Order status', 'wp-graphql-woocommerce'),
],
'paymentMethod' => [
'type' => 'String',
'description' => __('Payment method ID.', 'wp-graphql-woocommerce'),
],
'paymentMethodTitle' => [
'type' => 'String',
'description' => __('Payment method title.', 'wp-graphql-woocommerce'),
],
'transactionId' => [
'type' => 'String',
'description' => __('Order transaction ID', 'wp-graphql-woocommerce'),
],
'billing' => [
'type' => 'CustomerAddressInput',
'description' => __('Order billing address', 'wp-graphql-woocommerce'),
],
'shipping' => [
'type' => 'CustomerAddressInput',
'description' => __('Order shipping address', 'wp-graphql-woocommerce'),
],
'lineItems' => [
'type' => ['list_of' => 'LineItemInput'],
'description' => __('Order line items', 'wp-graphql-woocommerce'),
],
'shippingLines' => [
'type' => ['list_of' => 'ShippingLineInput'],
'description' => __('Order shipping lines', 'wp-graphql-woocommerce'),
],
'feeLines' => [
'type' => ['list_of' => 'FeeLineInput'],
'description' => __('Order shipping lines', 'wp-graphql-woocommerce'),
],
'metaData' => [
'type' => ['list_of' => 'MetaDataInput'],
'description' => __('Order meta data', 'wp-graphql-woocommerce'),
],
'isPaid' => [
'type' => 'Boolean',
'description' => __('Define if the order is paid. It will set the status to processing and reduce stock items.', 'wp-graphql-woocommerce'),
],
'createdVia' => [
'type' => 'String',
'description' => __('Order created via', 'wp-graphql-woocommerce'),
],
];
}

/**
* Defines the mutation output field configuration
*
* @return array
*/
public static function get_output_fields()
{
return [
'order' => [
'type' => 'Order',
'resolve' => static function ($payload) {
return new Order($payload['id']);
},
],
'orderId' => [
'type' => 'Int',
'resolve' => static function ($payload) {
return $payload['id'];
},
],
];
}

/**
* Defines the mutation data modification closure.
*
* @return callable
*/
public static function mutate_and_get_payload()
{
return static function ($input, AppContext $context, ResolveInfo $info) {
// Check if authorized to create this order.
if (! Order_Mutation::authorized($input, $context, $info, 'create', null)) {
throw new UserError(__('User does not have the capabilities necessary to create an order.', 'wp-graphql-woocommerce'));
}

// Create order.
$order = null;
try {
$order_id = Order_Mutation::create_order($input, $context, $info);
Order_Mutation::add_order_meta($order_id, $input, $context, $info);
Order_Mutation::add_items($input, $order_id, $context, $info);

// Apply coupons.
if (! empty($input['coupons'])) {
Order_Mutation::apply_coupons($order_id, $input['coupons']);
}

$order = WC_Order_Factory::get_order($order_id);

if (! is_object($order)) {
throw new UserError(__('Order could not be created.', 'wp-graphql-woocommerce'));
}

// Make sure gateways are loaded so hooks from gateways fire on save/create.
WC()->payment_gateways();

// Validate customer ID, if set.
if (! empty($input['customerId']) && ! Order_Mutation::validate_customer($input['customerId'])) {
throw new UserError(__('Customer ID is invalid.', 'wp-graphql-woocommerce'));
}

$order->set_created_via(! empty($input['createdVia']) ? $input['createdVia'] : 'graphql-api');
$order->set_prices_include_tax('yes' === get_option('woocommerce_prices_include_tax'));
$order->calculate_totals(true);

// Set status.
if (! empty($input['status'])) {
$order->set_status($input['status']);
}

// Actions for after the order is saved.
if (true === $input['isPaid']) {
$order->payment_complete(
! empty($input['transactionId']) ? $input['transactionId'] : ''
);
}

/**
* Action called after order is created.
*
* @param \WC_Order $order WC_Order instance.
* @param array $input Input data describing order.
* @param \WPGraphQL\AppContext $context Request AppContext instance.
* @param \GraphQL\Type\Definition\ResolveInfo $info Request ResolveInfo instance.
*/
do_action('graphql_woocommerce_after_order_create', $order, $input, $context, $info);

return ['id' => $order->get_id()];
} catch (\Throwable $e) {
// Delete order if it was created.
if (is_object($order)) {
Order_Mutation::purge($order);
}

// Throw error.
throw new UserError($e->getMessage());
} //end try
};
}
}
Loading