File core/class-papi-core-meta-store.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 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256

<?php

/**
 * Core class that implements a Papi meta store.
 */
abstract class Papi_Core_Meta_Store {

    /**
     * The WordPress meta id if it exists.
     *
     * @var int
     */
    public $id;

    /**
     * Current properties.
     *
     * @var array
     */
    protected $properties = [];

    /**
     * The meta type.
     *
     * @var string
     */
    protected $type = 'meta';

    /**
     * The type class.
     *
     * @var Papi_Core_Type
     */
    protected $type_class;

    /**
     * Get Papi property value.
     *
     * @param  string $slug
     *
     * @return mixed
     */
    public function __get( $slug ) {
        return $this->get_value( $slug );
    }

    /**
     * Get meta type.
     *
     * @return string
     */
    public function get_type() {
        return $this->type;
    }

    /**
     * Get type class.
     *
     * @return Papi_Core_Type
     */
    public function get_type_class() {
        return $this->type_class;
    }

    /**
     * Get value, uncached.
     *
     * @param  string $slug
     *
     * @return mixed
     */
    public function get_value( $slug ) {
        $value = $this->load_value( $slug );

        return $this->format_value( $slug, $value );
    }

    /**
     * Format property value from the property.
     *
     * @param  string $slug
     * @param  mixed  $value
     *
     * @return mixed
     */
    public function format_value( $slug, $value ) {
        $slug     = unpapify( $slug );
        $property = $this->property( $slug );

        // If no property type is found, just return null.
        if ( ! papi_is_property( $property ) ) {
            return;
        }

        // Format the value from the property class.
        $value = $property->format_value( $value, $slug, $this->id );

        // Only fired when not in admin.
        if ( ! is_admin() ) {
            $value = papi_filter_format_value(
                $property->type,
                $value,
                $slug,
                $this->id,
                papi_get_meta_type()
            );
        }

        if ( is_array( $value ) ) {
            $value = array_filter( $value );
        }

        return $value;
    }

    /**
     * Get current property.
     *
     * @param  string $slug
     *
     * @return Papi_Core_Property
     */
    protected function property( $slug = '' ) {
        if ( isset( $this->properties[$slug] ) && papi_is_property( $this->properties[$slug] ) ) {
            return $this->properties[$slug];
        }

        $this->properties[$slug] = $this->get_property( $slug );

        return $this->properties[$slug];
    }

    /**
     * Load property value from the property.
     *
     * @param  string $slug
     *
     * @return mixed
     */
    public function load_value( $slug ) {
        $slug     = unpapify( $slug );
        $property = $this->property( $slug );

        // If no property type is found, just return null.
        if ( ! papi_is_property( $property ) ) {
            return;
        }

        // Get raw property meta value.
        $value = papi_get_property_meta_value( $this->id, $slug, $this->get_type() );

        // Prepare load value, when you have `overwrite => true`
        // this value will not exist in the database and that's
        // why we need to prepare (change) the value.
        $value = $this->prepare_load_value( $property, $value );

        // Bail if value is empty and option value is empty.
        if ( papi_is_empty( $value ) ) {
            if ( ! papi_is_empty( $property->get_option( 'value' ) ) ) {
                return $property->get_option( 'value' );
            }

            return;
        }

        // A property need to know about the store.
        $this->property( $slug )->set_store( $this );

        // Run load value method right after the value has been loaded from the database.
        $value = $property->load_value( $value, $slug, $this->id );
        $value = papi_filter_load_value(
            $property->type,
            $value,
            $slug,
            $this->id,
            papi_get_meta_type()
        );

        // Remove empty values from arrays.
        if ( is_array( $value ) ) {
            $value = array_filter( $value );
        }

        return $value;
    }

    /**
     * Get store from factory.
     *
     * @param  int    $post_id
     * @param  string $type
     *
     * @return mixed
     */
    public static function factory( $post_id, $type = 'post' ) {
        $type         = papi_get_meta_type( $type );
        $class_suffix = '_' . ucfirst( $type ) . '_Store';
        $class_name   = 'Papi' . $class_suffix;

        if ( ! class_exists( $class_name ) ) {
            return;
        }

        $post_id = papi_get_post_id( $post_id );
        $page    = new $class_name( $post_id );

        if ( ! $page->valid() ) {
            return;
        }

        return $page;
    }

    /**
     * Get property from entry type.
     *
     * @param  string $slug
     * @param  string $child_slug
     *
     * @return Papi_Core_Property
     */
    abstract public function get_property( $slug, $child_slug = '' );

    /**
     * Prepare load value.
     *
     * @param  Papi_Core_Property $property
     * @param  mixed              $value
     *
     * @retrun mixed
     */
    protected function prepare_load_value( Papi_Core_Property $property, $value ) {
        return $value;
    }

    /**
     * Prepare property before returning it.
     *
     * @param  Papi_Core_Property $property
     *
     * @return Papi_Core_Property
     */
    protected function prepare_property( Papi_Core_Property $property ) {
        $property->set_store( $this );

        return $property;
    }

    /**
     * Check if it's a valid store.
     *
     * @return bool
     */
    abstract public function valid();
}

Classes

Functions