• Class
  • Tree
  • Deprecated

Classes

  • Papi_Admin
  • Papi_Admin_Ajax
  • Papi_Admin_Assets
  • Papi_Admin_Columns
  • Papi_Admin_Menu
  • Papi_Admin_Meta_Box
  • Papi_Admin_Meta_Box_Tabs
  • Papi_Admin_Meta_Handler
  • Papi_Admin_Option_Handler
  • Papi_Admin_Taxonomy
  • Papi_Admin_View
  • Papi_Attachment_Type
  • Papi_CLI
  • Papi_CLI_Command
  • Papi_CLI_Post_Command
  • Papi_CLI_Term_Command
  • Papi_CLI_Type_Command
  • Papi_Conditional_Rules
  • Papi_Container
  • Papi_Core_Autoload
  • Papi_Core_Box
  • Papi_Core_Conditional
  • Papi_Core_Conditional_Rule
  • Papi_Core_Data_Handler
  • Papi_Core_Meta_Store
  • Papi_Core_Property
  • Papi_Core_Tab
  • Papi_Core_Type
  • Papi_Entry_Type
  • Papi_Loader
  • Papi_Option_Store
  • Papi_Option_Type
  • Papi_Page_Type
  • Papi_Porter
  • Papi_Porter_Driver
  • Papi_Porter_Driver_Core
  • Papi_Post_Store
  • Papi_Property
  • Papi_Property_Bool
  • Papi_Property_Checkbox
  • Papi_Property_Color
  • Papi_Property_Datetime
  • Papi_Property_Divider
  • Papi_Property_Dropdown
  • Papi_Property_Editor
  • Papi_Property_Email
  • Papi_Property_File
  • Papi_Property_Flexible
  • Papi_Property_Gallery
  • Papi_Property_Group
  • Papi_Property_Hidden
  • Papi_Property_Html
  • Papi_Property_Image
  • Papi_Property_Link
  • Papi_Property_Number
  • Papi_Property_Post
  • Papi_Property_Radio
  • Papi_Property_Reference
  • Papi_Property_Relationship
  • Papi_Property_Repeater
  • Papi_Property_String
  • Papi_Property_Term
  • Papi_Property_Text
  • Papi_Property_Url
  • Papi_Property_User
  • Papi_Taxonomy_Type
  • Papi_Term_Store

Functions

  • papi
  • papi_action_delete_value
  • papi_append_post_type_query
  • papi_body_class
  • papi_cache_delete
  • papi_cache_get
  • papi_cache_key
  • papi_cache_set
  • papi_camel_case
  • papi_cast_string_value
  • papi_convert_to_string
  • papi_current_user_is_allowed
  • papi_delete_field
  • papi_delete_option
  • papi_delete_property_meta_value
  • papi_delete_term_field
  • papi_display_page_type
  • papi_doing_ajax
  • papi_entry_type_exists
  • papi_esc_html
  • papi_f
  • papi_field_shortcode
  • papi_field_value
  • papi_filter_conditional_rule_allowed
  • papi_filter_format_value
  • papi_filter_load_value
  • papi_filter_settings_directories
  • papi_filter_settings_only_page_type
  • papi_filter_settings_only_taxonomy_type
  • papi_filter_settings_show_page_type
  • papi_filter_settings_show_standard_page_type
  • papi_filter_settings_show_standard_page_type_in_filter
  • papi_filter_settings_show_standard_taxonomy_type
  • papi_filter_settings_sort_order
  • papi_filter_settings_standard_page_type_description
  • papi_filter_settings_standard_page_type_name
  • papi_filter_settings_standard_page_type_thumbnail
  • papi_filter_settings_standard_taxonomy_type_name
  • papi_filter_update_value
  • papi_from_property_array_slugs
  • papi_get_all_core_type_files
  • papi_get_all_entry_types
  • papi_get_all_files_in_directory
  • papi_get_all_page_types
  • papi_get_class_name
  • papi_get_core_type_base_path
  • papi_get_core_type_file_path
  • papi_get_entry_type
  • papi_get_entry_type_by_id
  • papi_get_entry_type_by_meta_id
  • papi_get_entry_type_count
  • papi_get_entry_type_css_class
  • papi_get_entry_type_id
  • papi_get_entry_type_template
  • papi_get_field
  • papi_get_file_path
  • papi_get_meta_id
  • papi_get_meta_id_column
  • papi_get_meta_store
  • papi_get_meta_type
  • papi_get_only_objects
  • papi_get_option
  • papi_get_options_and_properties
  • papi_get_or_post
  • papi_get_page
  • papi_get_page_new_url
  • papi_get_page_type_id
  • papi_get_page_type_key
  • papi_get_page_type_name
  • papi_get_parent_post_id
  • papi_get_post_id
  • papi_get_post_type
  • papi_get_post_type_label
  • papi_get_post_types
  • papi_get_property_class_name
  • papi_get_property_meta_value
  • papi_get_property_type
  • papi_get_property_type_key
  • papi_get_property_type_key_f
  • papi_get_qs
  • papi_get_sanitized_post
  • papi_get_slugs
  • papi_get_taxonomies
  • papi_get_taxonomy
  • papi_get_taxonomy_label
  • papi_get_taxonomy_type_id
  • papi_get_taxonomy_type_name
  • papi_get_template_file_name
  • papi_get_term_field
  • papi_get_term_id
  • papi_get_term_slugs
  • papi_html_name
  • papi_html_tag
  • papi_include_query_strings
  • papi_include_template
  • papi_is_empty
  • papi_is_json
  • papi_is_method
  • papi_is_option_type
  • papi_is_page_type
  • papi_is_property
  • papi_is_property_type_key
  • papi_is_rule
  • papi_load_page_type_id
  • papi_load_taxonomy_type_id
  • papi_maybe_convert_to_array
  • papi_maybe_convert_to_object
  • papi_maybe_get_callable_value
  • papi_maybe_json_decode
  • papi_maybe_json_encode
  • papi_nl2br
  • papi_option_shortcode
  • papi_option_type_exists
  • papi_populate_properties
  • papi_property
  • papi_remove_trailing_quotes
  • papi_render_html_tag
  • papi_render_properties
  • papi_render_property
  • papi_require_text
  • papi_required_html
  • papi_rule
  • papi_santize_data
  • papi_set_page_type_id
  • papi_set_taxonomy_type_id
  • papi_slugify
  • papi_sort_order
  • papi_supports_term_meta
  • papi_tab
  • papi_tabs_setup
  • papi_taxonomy_shortcode
  • papi_template
  • papi_template_include
  • papi_to_array
  • papi_to_property_array_slugs
  • papi_underscorify
  • papi_update_field
  • papi_update_option
  • papi_update_property_meta_value
  • papi_update_property_meta_value_cache_delete
  • papi_update_term_field
  • papify
  • the_papi_field
  • the_papi_option
  • the_papi_page_type_name
  • the_papi_taxonomy_type_name
  • the_papi_term_field
  • unpapify
  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 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 
<?php

/**
 * Get entry type css class, it will split the entry type id
 * on slash and take the last part of the id.
 *
 * @param  int $id
 * @param  string $type
 *
 * @return string
 */
function papi_get_entry_type_css_class( $id = 0, $type = 'post' ) {
    $entry_type = papi_get_entry_type_id( $id, $type );

    if ( empty( $entry_type ) ) {
        return '';
    }

    $parts = explode( '/', $entry_type );

    if ( empty( $parts ) || empty( $parts[0] ) ) {
        return '';
    }

    return array_pop( $parts );
}

/**
 * Count entry types in the database for the
 * given entry type.
 *
 * @param  string|Papi_Entry_Type $entry_type
 *
 * @return int
 */
function papi_get_entry_type_count( $entry_type ) {
    global $wpdb;

    if ( empty( $entry_type ) || ( ! is_string( $entry_type ) && ( ! is_object( $entry_type ) ) ) ) {
        return 0;
    }

    if ( is_string( $entry_type ) ) {
        $entry_type = papi_get_entry_type_by_id( $entry_type );
    }

    if ( $entry_type instanceof Papi_Entry_Type === false ) {
        return 0;
    }

    $table = sprintf( '%s%smeta', $wpdb->prefix, papi_get_meta_type( $entry_type->type ) );
    $sql   = "SELECT COUNT(*) FROM $table WHERE `meta_key` = '%s' AND `meta_value` = '%s'";
    $sql   = $wpdb->prepare( $sql, papi_get_page_type_key(), $entry_type->get_id() );

    return intval( $wpdb->get_var( $sql ) );
}

/**
 * Check if entry type exists.
 *
 * @param  string $id
 *
 * @return bool
 */
function papi_entry_type_exists( $id ) {
    $page_types = papi_get_all_entry_types();

    foreach ( $page_types as $page_type ) {
        if ( $page_type->match_id( $id ) ) {
            return true;
        }
    }

    return false;
}

/**
 * Get all entry types that exists.
 *
 * @param  array $args {
 *   @type bool         $all
 *   @type mixed        $args
 *   @type bool         $cache
 *   @type array|string $id
 *   @type string       $mode
 *   @type array|string $types
 * }
 *
 * @return array
 */
function papi_get_all_entry_types( array $args = [] ) {
    $default_args = [
        'all'   => true,
        'args'  => [],
        'cache' => true,
        'mode'  => 'include',
        'types' => []
    ];

    $args = array_merge( $default_args, $args );

    if ( ! is_array( $args['types'] ) ) {
        $args['types'] = [$args['types']];
    }

    if ( ! is_array( $args['args'] ) ) {
        $args['args'] = [$args['args']];
    }

    $args['args'] = array_filter( $args['args'] );

    if ( ! empty( $args['types'] ) ) {
        $args['all'] = false;
    }

    $cache_key = papi_cache_key( __FUNCTION__, md5( serialize( $args ) ) );

    if ( ! $args['cache'] ) {
        papi()->remove( 'papi_get_all_core_type_files' );
        papi()->remove( $cache_key );
    }

    if ( papi()->exists( $cache_key ) ) {
        return papi()->make( $cache_key );
    }

    $singletons  = [];
    $entry_types = [];
    $files       = papi_get_all_core_type_files();

    foreach ( $files as $file ) {
        $entry_type = papi_get_entry_type( $file );

        if ( is_null( $entry_type ) ) {
            continue;
        }

        // Only entry types can be loaded.
        // @codeCoverageIgnoreStart
        if ( $entry_type instanceof Papi_Entry_Type === false ) {
            continue;
        }
        // @codeCoverageIgnoreEnd

        if ( $entry_type->singleton() ) {
            if ( isset( $singletons[$entry_type->type] ) ) {
                continue;
            } else {
                $singletons[$entry_type->type] = true;
            }
        }

        $id         = $entry_type->get_id();
        $valid_type = in_array( $entry_type->type, $args['types'] );
        $valid_type = $args['mode'] === 'include' ? $valid_type : ! $valid_type;

        if ( $args['all'] || ( $valid_type && call_user_func_array( [$entry_type, 'allowed'], $args['args'] ) ) ) {
            $entry_type->boot();
            $entry_types[$id] = $entry_type;
        }
    }

    $entry_types = array_values( $entry_types );

    if ( is_array( $entry_types ) ) {
        usort( $entry_types, function ( $a, $b ) {
            return strcmp( $a->name, $b->name );
        } );
    }

    $entry_types = papi_sort_order( array_reverse( $entry_types ) );

    if ( ! papi()->exists( $cache_key ) ) {
        papi()->singleton( $cache_key, $entry_types );
    }

    return $entry_types;
}

/**
 * Get a entry type by file path.
 *
 * @param  string $file_path
 *
 * @return null|Papi_entry_type
 */
function papi_get_entry_type( $file_path ) {
    if ( ! is_file( $file_path ) || ! is_string( $file_path ) ) {
        return;
    }

    $class_name = papi_get_class_name( $file_path );

    if ( empty( $class_name ) ) {
        return;
    }

    // Try to add the page type to the container.
    if ( ! papi()->exists( $class_name ) ) {

        // @codeCoverageIgnoreStart
        if ( ! class_exists( $class_name ) ) {
            require_once $file_path;
        }

        if ( ! class_exists( $class_name ) ) {
            return;
        }
        // @codeCoverageIgnoreEnd

        $rc = new ReflectionClass( $class_name );

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

        $entry_type = $rc->newInstanceArgs( [$file_path] );

        // If the page type don't have a name we can't use it.
        if ( ! $entry_type->has_name() ) {
            return;
        }

        papi()->singleton( $class_name, $entry_type );
    }

    return papi()->make( $class_name );
}

/**
 * Get entry type by identifier.
 *
 * @param  string $id
 *
 * @return Papi_Entry_Type
 */
function papi_get_entry_type_by_id( $id ) {
    if ( ! is_string( $id ) || empty( $id ) ) {
        return;
    }

    $result      = null;
    $entry_types = papi_get_all_entry_types();

    foreach ( $entry_types as $entry_type ) {
        if ( $entry_type->match_id( $id ) ) {
            $result = $entry_type;
            break;
        }
    }

    if ( is_null( $result ) ) {
        $path   = papi_get_file_path( $id );
        $result = papi_get_entry_type( $path );
    }

    return $result;
}

/**
 * Get entry type from meta id.
 *
 * @param  int    $id
 * @param  string $type
 *
 * @return Papi_Entry_Type
 */
function papi_get_entry_type_by_meta_id( $id = 0, $type = 'post' ) {
    if ( ! is_numeric( $id ) ) {
        return;
    }

    $type = papi_get_meta_type( $type );
    $id   = papi_get_meta_id( $type, $id );

    if ( $id === 0 ) {
        return;
    }

    if ( $entry_type = papi_get_entry_type_id( $id, $type === 'post' ? null : $type ) ) {
        return papi_get_entry_type_by_id( $entry_type );
    }
}

/**
 * Get entry type id.
 *
 * @param  int $id
 * @param  string $type
 *
 * @return string
 */
function papi_get_entry_type_id( $id = 0, $type = null ) {
    $type = papi_get_meta_type( $type );
    $id   = papi_get_meta_id( $type, $id );

    if ( $id > 0 ) {
        if ( $meta_value = get_metadata( $type, $id, papi_get_page_type_key(), true ) ) {
            return $meta_value;
        }
    }

    $entry_type_id = papi_get_qs( 'entry_type' );

    /**
     * Change entry type id.
     *
     * @param  string $entry_type_id
     * @param  string $type
     *
     * @return string
     */
    return apply_filters( 'papi/entry_type_id', $entry_type_id, $type );
}

/**
 * Get entry template file from meta id.
 *
 * @param  int    $id
 * @param  string $type
 *
 * @return null|string
 */
function papi_get_entry_type_template( $id = 0, $type = 'post' ) {
    if ( empty( $id ) && ! is_numeric( $id ) ) {
        return;
    }

    $data = papi_get_entry_type_by_meta_id( $id, $type );

    if ( isset( $data, $data->template ) ) {
        return papi_get_template_file_name( $data->template );
    }
}
API documentation generated by ApiGen