File cli/class-papi-cli-command.php

 1  2  3  4  5  6  7  8  9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61

<?php

/**
 * Base class that must be extended by any Papi sub commands.
 */
class Papi_CLI_Command extends WP_CLI_Command {

    /**
     * Get formatter object based on supplied arguments.
     *
     * @param  array $assoc_args Associative args from CLI to determine formattin
     *
     * @return \WP_CLI\Formatter
     */
    protected function get_formatter( $assoc_args ) {
        $args = $this->get_format_args( $assoc_args );

        return new \WP_CLI\Formatter( $args );
    }

    /**
     * Get default fields for formatter.
     *
     * Class that extends Papi_CLI_Command should override this method.
     *
     * @return null|string|array
     */
    protected function get_default_format_fields() {
        return null;
    }

    /**
     * Get format args that will be passed into CLI Formatter.
     *
     * @param  array $assoc_args Associative args from CLI
     *
     * @return array Formatter args
     */
    protected function get_format_args( $assoc_args ) {
        $format_args = [
            'fields' => $this->get_default_format_fields(),
            'field'  => null,
            'format' => 'table',
        ];

        if ( isset( $assoc_args['fields'] ) ) {
            $format_args['fields'] = $assoc_args['fields'];
        }

        if ( isset( $assoc_args['field'] ) ) {
            $format_args['field'] = $assoc_args['field'];
        }

        if ( ! empty( $assoc_args['format'] ) && in_array( $assoc_args['format'], ['count', 'ids', 'table', 'csv', 'json'] ) ) {
            $format_args['format'] = $assoc_args['format'];
        }

        return $format_args;
    }
}

Classes

Functions