/wp-content/plugins/woocommerce/includes/cli/class-wc-cli-runner.php
PHP | 254 lines | 178 code | 20 blank | 56 comment | 23 complexity | bd27907f846169f3cec5619f124a168f MD5 | raw file
- <?php
- /**
- * WP_CLI_Runner class file.
- *
- * @package WooCommerce\CLI
- */
- if ( ! defined( 'ABSPATH' ) ) {
- exit;
- }
- /**
- * WC API to WC CLI Bridge.
- *
- * Hooks into the REST API, figures out which endpoints come from WC,
- * and registers them as CLI commands.
- *
- * Forked from wp-cli/restful (by Daniel Bachhuber, released under the MIT license https://opensource.org/licenses/MIT).
- * https://github.com/wp-cli/restful
- *
- * @version 3.0.0
- * @package WooCommerce
- */
- class WC_CLI_Runner {
- /**
- * Endpoints to disable (meaning they will not be available as CLI commands).
- * Some of these can either be done via WP already, or are offered with
- * some other changes (like tools).
- *
- * @var array
- */
- private static $disabled_endpoints = array(
- 'settings',
- 'settings/(?P<group_id>[\w-]+)',
- 'settings/(?P<group_id>[\w-]+)/batch',
- 'settings/(?P<group_id>[\w-]+)/(?P<id>[\w-]+)',
- 'system_status',
- 'system_status/tools',
- 'system_status/tools/(?P<id>[\w-]+)',
- 'reports',
- 'reports/sales',
- 'reports/top_sellers',
- );
- /**
- * The version of the REST API we should target to
- * generate commands.
- *
- * @var string
- */
- private static $target_rest_version = 'v2';
- /**
- * Register's all endpoints as commands once WP and WC have all loaded.
- */
- public static function after_wp_load() {
- global $wp_rest_server;
- $wp_rest_server = new WP_REST_Server();
- do_action( 'rest_api_init', $wp_rest_server );
- $request = new WP_REST_Request( 'GET', '/' );
- $request->set_param( 'context', 'help' );
- $response = $wp_rest_server->dispatch( $request );
- $response_data = $response->get_data();
- if ( empty( $response_data ) ) {
- return;
- }
- // Loop through all of our endpoints and register any valid WC endpoints.
- foreach ( $response_data['routes'] as $route => $route_data ) {
- // Only register endpoints for WC and our target version.
- if ( substr( $route, 0, 4 + strlen( self::$target_rest_version ) ) !== '/wc/' . self::$target_rest_version ) {
- continue;
- }
- // Only register endpoints with schemas.
- if ( empty( $route_data['schema']['title'] ) ) {
- /* translators: %s: Route to a given WC-API endpoint */
- WP_CLI::debug( sprintf( __( 'No schema title found for %s, skipping REST command registration.', 'woocommerce' ), $route ), 'wc' );
- continue;
- }
- // Ignore batch endpoints.
- if ( 'batch' === $route_data['schema']['title'] ) {
- continue;
- }
- // Disable specific endpoints.
- $route_pieces = explode( '/', $route );
- $endpoint_piece = str_replace( '/wc/' . $route_pieces[2] . '/', '', $route );
- if ( in_array( $endpoint_piece, self::$disabled_endpoints, true ) ) {
- continue;
- }
- self::register_route_commands( new WC_CLI_REST_Command( $route_data['schema']['title'], $route, $route_data['schema'] ), $route, $route_data );
- }
- }
- /**
- * Generates command information and tells WP CLI about all
- * commands available from a route.
- *
- * @param string $rest_command WC-API command.
- * @param string $route Path to route endpoint.
- * @param array $route_data Command data.
- * @param array $command_args WP-CLI command arguments.
- */
- 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,
- )
- );
- }
- }
- }