File porter/class-papi-porter-driver.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  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202

<?php

/**
 * Abstract implementation of Papi Porter driver.
 */
abstract class Papi_Porter_Driver {

    /**
     * The driver name.
     *
     * @var string
     */
    protected $name = '';

    /**
     * Alias for driver name.
     *
     * @var array|string
     */
    protected $alias = [];

    /**
     * Options per property.
     *
     * @var array
     */
    protected $options = [
        'custom'    => [],
        'meta_id'   => 0,
        'meta_type' => 'post',
        'property'  => null,
        'slug'      => '',
        'value'     => null
    ];

    /**
     * Papi Porter instance.
     *
     * @var Papi_Porter
     */
    protected $porter;

    /**
     * The constructor.
     *
     * @codeCoverageIgnore
     */
    public function __construct() {
    }

    /**
     * Call closure value if any.
     *
     * @param  mixed $value
     *
     * @return mixed
     */
    protected function call_value( $value ) {
        if ( $value instanceof Closure ) {
            return $value();
        }

        return $value;
    }

    /**
     * Bootstrap the driver.
     */
    public function bootstrap() {
    }

    /**
     * Get filter key.
     *
     * @param  string $type
     * @param  string $filter
     *
     * @return string
     */
    public function filter( $type, $filter ) {
        if ( ! is_string( $filter ) ) {
            $filter = '';
        }

        return sprintf(
            'papi/porter/driver/%s/%s/%s',
            $this->name,
            $type,
            $filter
        );
    }

    /**
     * Get the driver name.
     *
     * @return string
     */
    public function get_driver_name() {
        return $this->name;
    }

    /**
     * Get options.
     *
     * @return array
     */
    public function get_options() {
        return $this->options;
    }

    /**
     * Get the import value for a property.
     *
     * @param  array  $options
     *
     * @return mixed
     */
    abstract public function get_value( array $options );

    /**
     * Set driver alias.
     */
    protected function set_driver_alias() {
        foreach ( papi_to_array( $this->alias ) as $alias ) {
            if ( is_string( $alias ) && ! $this->porter->exists( 'driver.' . $alias ) ) {
                $this->set_driver_name( $alias );
            }
        }
    }

    /**
     * Set driver name.
     *
     * @param  string $name
     *
     * @throws InvalidArgumentException if driver name is empty or not a string.
     * @throws Exception if driver name exists.
     */
    protected function set_driver_name( $name ) {
        if ( empty( $name ) || ! is_string( $name ) ) {
            throw new InvalidArgumentException(
                'Driver name is empty or not a string.'
            );
        }

        $name = strtolower( $name );

        if ( $this->porter->exists( 'driver.' . $name ) ) {
            throw new Exception( sprintf( '`%s` driver exists.', $name ) );
        }

        $this->porter->singleton( 'driver.' . $name, get_class( $this ) );
    }

    /**
     * Set Porter instance.
     *
     * @param Papi_Porter $porter
     */
    public function set_porter( Papi_Porter $porter ) {
        $this->porter = $porter;
        $this->set_driver_name( $this->name );
        $this->set_driver_alias();
    }

    /**
     * Set options for properties.
     *
     * @param array $options
     */
    public function set_options( array $options = [] ) {
        $this->options = array_merge( $this->options, $options );
    }

    /**
     * Determine if a property should update existing array or not.
     *
     * @param  string $slug
     *
     * @return bool
     */
    protected function should_update_array( $slug ) {
        return is_string( $slug ) &&
            isset( $this->options['custom'] ) &&
            isset( $this->options['custom'][$slug] ) &&
            $this->options['custom'][$slug]['update_array'];
    }

    /**
     * Return the given object. Useful for chaining.
     *
     * @codeCoverageIgnore
     *
     * @param  mixed $obj
     *
     * @return mixed
     */
    protected function with( $obj ) {
        return $obj;
    }
}

Classes

Functions