File core/class-papi-core-type.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

<?php

/**
 * Core class that implements a Papi type.
 */
class Papi_Core_Type {

    /**
     * The page type class name.
     *
     * @var string
     */
    private $_class_name = '';

    /**
     * The file name of the core type file.
     *
     * @var string
     */
    private $_file_name = '';

    /**
     * The file path of the core type file.
     *
     * @var string
     */
    private $_file_path = '';

    /**
     * The core type identifier.
     *
     * @var string
     */
    public $id = '';

    /**
     * The name of the core type.
     *
     * @var string
     */
    public $name = '';

    /**
     * The sort order of the core type.
     *
     * @var int
     */
    public $sort_order = 1000;

    /**
     * The type name. Used for WP CLI.
     *
     * @var string
     */
    public $type = 'core';

    /**
     * The constructor.
     *
     * Load a core type by the file.
     *
     * @param string $file_path
     */
    public function __construct( $file_path = '' ) {
        if ( is_file( $file_path ) ) {
            $this->setup_file( $file_path );
            $this->setup_meta_data();
        }
    }

    /**
     * Determine if the entry type is allowed.
     *
     * @return bool
     */
    public function allowed() {
        return true;
    }

    /**
     * Boot page type.
     *
     * @codeCoverageIgnore
     */
    public function boot() {
        $this->setup_actions();
        $this->setup_filters();
    }

    /**
     * Get the page type class name with namespace if exists.
     *
     * @return string
     */
    public function get_class_name() {
        return $this->_class_name;
    }

    /**
     * Get the page type file pat.h
     *
     * @return string
     */
    public function get_file_path() {
        return $this->_file_path;
    }

    /**
     * Get the page type identifier.
     *
     * @return string
     */
    public function get_id() {
        if ( ! empty( $this->id ) ) {
            return $this->id;
        }

        return $this->_file_name;
    }

    /**
     * Get meta data from type class and merge
     * with the parent meta data.
     *
     * @return array
     */
    private function get_meta() {
        $method = 'meta';

        if ( ! method_exists( $this, $method ) ) {
            return [];
        }

        $child_meta = call_user_func( [$this, $method] );
        $child_meta = is_array( $child_meta ) ? $child_meta : [];

        $parent_class  = get_parent_class( $this );
        $parent_exists = method_exists( $parent_class, $method );
        $parent_meta   = [];

        while ( $parent_exists ) {
            $rc = new ReflectionClass( $parent_class );

            // Bail if not instantiable.
            if ( ! $rc->isInstantiable() ) {
                break;
            }

            $parent        = $rc->newInstance();
            $output        = call_user_func( [$parent, $method] );
            $output        = is_array( $output ) ? $output : [];
            $parent_meta   = array_merge( $parent_meta, $output );
            $parent_class  = get_parent_class( $parent_class );
            $parent_exists = method_exists( $parent_class, $method );
        }

        return array_merge( $parent_meta, $child_meta );
    }

    /**
     * Get type name.
     *
     * @return string
     */
    public function get_type() {
        $class = get_class( $this );

        preg_match( '/\w+\_(\w+)\_Type$/', $class, $matches );
        $type = isset( $matches[1] ) ? $matches[1] : $this->type;

        return strtolower( $type );
    }

    /**
     * Check so we have a name on the page type.
     *
     * @return bool
     */
    public function has_name() {
        return ! empty( $this->name );
    }

    /**
     * Check if the the given identifier match the page type identifier.
     *
     * @param  string $id
     *
     * @return bool
     */
    public function match_id( $id ) {
        return $this->get_id() === $id;
    }

    /**
     * Create a new instance of the page type file.
     *
     * @return object
     */
    public function new_class() {
        if ( empty( $this->_file_path ) ) {
            return;
        }

        return new $this->_class_name;
    }

    /**
     * Setup actions.
     *
     * @codeCoverageIgnore
     */
    protected function setup_actions() {
    }

    /**
     * Load the file and setup file path, file name and class name properties.
     *
     * @param string $file_path
     */
    private function setup_file( $file_path ) {
        $this->_file_path  = $file_path;
        $this->_file_name  = papi_get_core_type_base_path( $this->_file_path );
        $this->_class_name = papi_get_class_name( $this->_file_path );
    }

    /**
     * Setup filters.
     *
     * @codeCoverageIgnore
     */
    protected function setup_filters() {
    }

    /**
     * Setup meta data.
     */
    protected function setup_meta_data() {
        foreach ( $this->get_meta() as $key => $value ) {
            if ( substr( $key, 0, 1 ) === '_' ) {
                continue;
            }

            $this->$key = papi_esc_html( $value );
        }

        if ( $this->sort_order === 1000 ) {
            $this->sort_order = papi_filter_settings_sort_order();
        }
    }
}

Classes

Functions