WC_CLI_Runner::register_route_commands() │ private static │ WC 1.0

Generates command information and tells WP CLI about all commands available from a route.

Method of the class: WC_CLI_Runner{}

No Hooks.

Return

null. Nothing (null).

Usage

$result = WC_CLI_Runner::register_route_commands( $rest_command, $route, $route_data, $command_args );

$rest_command(WC_CLI_REST_Command) (required)

WC-API command.

$route(string) (required)

Path to route endpoint.

$route_data(array) (required)

Command data.

$command_args(array)

WP-CLI command arguments.
Default: array()

WC_CLI_Runner::register_route_commands() WC CLI Runner::register route commands code ^{WC 9.3.3}

private static function register_route_commands( $rest_command, $route, $route_data, $command_args = array() ) {
	// Define IDs that we are looking for in the routes (in addition to id)
	// so that we can pass it to the rest command, and use it here to generate documentation.
	$supported_ids = array(
		'product_id'   => __( 'Product ID.', 'woocommerce' ),
		'customer_id'  => __( 'Customer ID.', 'woocommerce' ),
		'order_id'     => __( 'Order ID.', 'woocommerce' ),
		'refund_id'    => __( 'Refund ID.', 'woocommerce' ),
		'attribute_id' => __( 'Attribute ID.', 'woocommerce' ),
		'zone_id'      => __( 'Zone ID.', 'woocommerce' ),
		'instance_id'  => __( 'Instance ID.', 'woocommerce' ),
		'id'           => __( 'The ID for the resource.', 'woocommerce' ),
		'slug'         => __( 'The slug for the resource.', 'woocommerce' ),
	);
	$rest_command->set_supported_ids( $supported_ids );
	$positional_args = array_keys( $supported_ids );
	$parent             = "wc {$route_data['schema']['title']}";
	$supported_commands = array();

	// Get a list of supported commands for each route.
	foreach ( $route_data['endpoints'] as $endpoint ) {
		preg_match_all( '#\([^\)]+\)#', $route, $matches );
		$resource_id   = ! empty( $matches[0] ) ? array_pop( $matches[0] ) : null;
		$trimmed_route = rtrim( $route );
		$is_singular   = substr( $trimmed_route, - strlen( $resource_id ?? '' ) ) === $resource_id;

		// List a collection.
		if ( array( 'GET' ) === $endpoint['methods'] && ! $is_singular ) {
			$supported_commands['list'] = ! empty( $endpoint['args'] ) ? $endpoint['args'] : array();
		}
		// Create a specific resource.
		if ( array( 'POST' ) === $endpoint['methods'] && ! $is_singular ) {
			$supported_commands['create'] = ! empty( $endpoint['args'] ) ? $endpoint['args'] : array();
		}
		// Get a specific resource.
		if ( array( 'GET' ) === $endpoint['methods'] && $is_singular ) {
			$supported_commands['get'] = ! empty( $endpoint['args'] ) ? $endpoint['args'] : array();
		}
		// Update a specific resource.
		if ( in_array( 'POST', $endpoint['methods'], true ) && $is_singular ) {
			$supported_commands['update'] = ! empty( $endpoint['args'] ) ? $endpoint['args'] : array();
		}
		// Delete a specific resource.
		if ( array( 'DELETE' ) === $endpoint['methods'] && $is_singular ) {
			$supported_commands['delete'] = ! empty( $endpoint['args'] ) ? $endpoint['args'] : array();
		}
	}

	foreach ( $supported_commands as $command => $endpoint_args ) {
		$synopsis = array();
		$arg_regs = array();
		$ids      = array();

		foreach ( $supported_ids as $id_name => $id_desc ) {
			if ( strpos( $route, '<' . $id_name . '>' ) !== false ) {
				$synopsis[] = array(
					'name'        => $id_name,
					'type'        => 'positional',
					'description' => $id_desc,
					'optional'    => false,
				);
				$ids[]      = $id_name;
			}
		}

		foreach ( $endpoint_args as $name => $args ) {
			if ( ! in_array( $name, $positional_args, true ) || strpos( $route, '<' . $id_name . '>' ) === false ) {
				$arg_regs[] = array(
					'name'        => $name,
					'type'        => 'assoc',
					'description' => ! empty( $args['description'] ) ? $args['description'] : '',
					'optional'    => empty( $args['required'] ),
				);
			}
		}

		foreach ( $arg_regs as $arg_reg ) {
			$synopsis[] = $arg_reg;
		}

		if ( in_array( $command, array( 'list', 'get' ), true ) ) {
			$synopsis[] = array(
				'name'        => 'fields',
				'type'        => 'assoc',
				'description' => __( 'Limit response to specific fields. Defaults to all fields.', 'woocommerce' ),
				'optional'    => true,
			);
			$synopsis[] = array(
				'name'        => 'field',
				'type'        => 'assoc',
				'description' => __( 'Get the value of an individual field.', 'woocommerce' ),
				'optional'    => true,
			);
			$synopsis[] = array(
				'name'        => 'format',
				'type'        => 'assoc',
				'description' => __( 'Render response in a particular format.', 'woocommerce' ),
				'optional'    => true,
				'default'     => 'table',
				'options'     => array(
					'table',
					'json',
					'csv',
					'ids',
					'yaml',
					'count',
					'headers',
					'body',
					'envelope',
				),
			);
		}

		if ( in_array( $command, array( 'create', 'update', 'delete' ), true ) ) {
			$synopsis[] = array(
				'name'        => 'porcelain',
				'type'        => 'flag',
				'description' => __( 'Output just the id when the operation is successful.', 'woocommerce' ),
				'optional'    => true,
			);
		}

		$methods = array(
			'list'   => 'list_items',
			'create' => 'create_item',
			'delete' => 'delete_item',
			'get'    => 'get_item',
			'update' => 'update_item',
		);

		$before_invoke = null;
		if ( empty( $command_args['when'] ) && \WP_CLI::get_config( 'debug' ) ) {
			$before_invoke = function() {
				wc_maybe_define_constant( 'SAVEQUERIES', true );
			};
		}

		WP_CLI::add_command(
			"{$parent} {$command}",
			array( $rest_command, $methods[ $command ] ),
			array(
				'synopsis'      => $synopsis,
				'when'          => ! empty( $command_args['when'] ) ? $command_args['when'] : '',
				'before_invoke' => $before_invoke,
			)
		);
	}
}