• 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 
<?php

/**
 * WordPress link manager property.
 */
class Papi_Property_Link extends Papi_Property {

    /**
     * The convert type.
     *
     * @var string
     */
    public $convert_type = 'object';

    /**
     * The default value.
     *
     * @var array
     */
    public $default_value = [];

    /**
     * Link fields.
     *
     * @var array
     */
    protected $link_fields = [
        'post_id',
        'url',
        'title',
        'target'
    ];

    /**
     * Delete value from the database.
     *
     * @param  string $slug
     * @param  int    $post_id
     * @param  string $type
     *
     * @return bool
     */
    public function delete_value( $slug, $post_id, $type ) {
        $values = $this->load_value( null, $slug, $post_id );
        $values = is_object( $values ) ? (array) $values : $values;
        $result = true;

        foreach ( array_keys( $values ) as $key ) {
            $out    = papi_delete_property_meta_value( $post_id, $slug . '_' . $key );
            $result = $out ? $result : $out;
        }

        if ( $result ) {
            $result = papi_delete_property_meta_value( $post_id, $slug );
        }

        return $result;
    }

    /**
     * Format the value of the property before it's returned
     * to WordPress admin or the site.
     *
     * @param  mixed  $value
     * @param  string $slug
     * @param  int    $post_id
     *
     * @return mixed
     */
    public function format_value( $value, $slug, $post_id ) {
        return (object) $this->prepare_link_array( $value, $slug );
    }

    /**
     * Get default settings.
     *
     * @return array
     */
    public function get_default_settings() {
        return [];
    }

    /**
     * Load value from database.
     *
     * @param  mixed  $value
     * @param  string $slug
     * @param  int    $post_id
     *
     * @return array
     */
    public function load_value( $value, $slug, $post_id ) {
        if ( is_array( $value ) || is_object( $value ) ) {
            $values = $value;
        } else {
            $values = $this->link_fields;

            foreach ( $values as $index => $key ) {
                $values[$key] = papi_get_property_meta_value(
                    $post_id,
                    sprintf( '%s_%s', $slug, $key ),
                    $this->get_meta_type()
                );
                unset( $values[$index] );
            }
        }

        return (object) $this->prepare_link_array( $values, $slug );
    }

    /**
     * Render property html.
     */
    public function html() {
        $value  = $this->get_value();
        $value  = is_array( $value ) || is_object( $value ) ? $value : [];
        $value  = (object) $value;
        $exists = ! empty( $value->url );
        ?>
        <div class="papi-property-link" data-replace-slug="true" data-slug="<?php echo $this->html_name(); ?>">
            <input type="hidden" name="<?php echo $this->html_name(); ?>" value="<?php echo $exists ? 1 : ''; ?>">

            <?php if ( $exists ): ?>
                <table class="papi-table link-table">
                    <tbody>
                        <tr>
                            <td><?php _e( 'URL', 'papi' ); ?></td>
                            <td>
                                <a href="<?php echo $value->url; ?>" target="_blank"><?php echo $value->url; ?></a>
                                <input type="hidden" value="<?php echo $value->title . ' - ' . $value->url; ?>" data-papi-rule="<?php echo $this->html_name(); ?>">
                                <input class="wp-link-url" type="hidden" value="<?php echo $value->url; ?>" name="<?php echo $this->html_name(); ?>[url]">
                            </td>
                        </tr>
                        <tr>
                            <td><?php _e( 'Title', 'papi' ); ?></td>
                            <td>
                                <?php echo $value->title; ?>
                                <input class="wp-link-text" type="hidden" value="<?php echo $value->title; ?>" name="<?php echo $this->html_name(); ?>[title]">
                            </td>
                        </tr>
                        <tr>
                            <td><?php _e( 'Target', 'papi' ); ?></td>
                            <td>
                                <?php echo $value->target === '_blank' ? __( 'New window', 'papi' ) : __( 'Same window', 'papi' ); ?>
                                <input class="wp-link-target" type="hidden" value="<?php echo $value->target; ?>" name="<?php echo $this->html_name(); ?>[target]">
                            </td>
                        </tr>
                    </tbody>
                </table>
            <?php endif; ?>

            <p class="papi-file-select">
                <span class="<?php echo empty( $value->url ) ? '' : 'papi-hide'; ?>">
                    <?php _e( 'No link selected', 'papi' ); ?>
                    <button class="button" data-link-action="add"><?php _e( 'Add link', 'papi' ); ?></button>
                </span>
                <span class="<?php echo empty( $value->url ) ? 'papi-hide' : ''; ?>">
                    <button class="button" data-link-action="edit"><?php _e( 'Edit link', 'papi' ); ?></button>
                    <button class="button" data-link-action="remove"><?php _e( 'Remove link', 'papi' ); ?></button>
                </span>
            </p>
        </div>
        <?php
    }

    /**
     * Import value to the property.
     *
     * @param  mixed  $value
     * @param  string $slug
     * @param  int    $post_id
     *
     * @return mixed
     */
    public function import_value( $value, $slug, $post_id ) {
        if ( is_array( $value ) || is_object( $value ) ) {
            return $this->update_value( (array) $value, $slug, $post_id );
        }
    }

    /**
     * Prepare link array with post id. If it gets a post id
     * bigger then zero it will use the permalink as url.
     *
     * @param  array|object $link
     * @param  string       $slug
     *
     * @return array|object
     */
    protected function prepare_link_array( $link, $slug ) {
        $array  = is_array( $link );
        $values = (array) $link;

        foreach ( $values as $key => $val ) {
            unset( $values[$key] );
            $key = preg_replace( '/^' . $slug . '\_/', '', $key );
            $values[$key] = $val;
        }

        $link = (object) $values;

        // Don't continue without a url.
        if ( ! isset( $link->url ) || empty( $link->url ) ) {
            return $array ? (array) $link : $link;
        }

        // Don't overwrite existing post id.
        if ( ! isset( $link->post_id ) || empty( $link->post_id ) ) {
            $link->post_id = url_to_postid( $link->url );
        }

        // Only replace url when post id is not zero.
        if ( $link->post_id > 0 ) {
            $link->url = get_permalink( $link->post_id );
        }

        // If empty target set `_self` as default target.
        if ( empty( $link->target ) ) {
            $link->target = '_self';
        }

        // Remove slug if it exists.
        if ( isset( $link->$slug ) && is_numeric( $link->$slug ) ) {
            unset( $link->$slug );
        }

        return $array ? (array) $link : $link;
    }

    /**
     * Render link template.
     */
    public function render_link_template() {
        ?>
        <script type="text/template" id="tmpl-papi-property-link">
            <table class="papi-table link-table">
                <tbody>
                    <tr>
                        <td>
                            <?php _e( 'URL', 'papi' ); ?>
                        </td>
                        <td>
                            <%= link %>
                            <input type="hidden" value="<%= title %> - <%= href %>" data-papi-rule="<%= slug %>">
                            <input class="wp-link-url" type="hidden" value="<%= href %>" name="<%= slug %>[url]">
                        </td>
                    </tr>
                    <tr>
                        <td>
                            <?php _e( 'Title', 'papi' ); ?>
                        </td>
                        <td>
                            <%= title %>
                            <input class="wp-link-text" type="hidden" value="<%= title %>" name="<%= slug %>[title]">
                        </td>
                    </tr>
                    <tr>
                        <td>
                            <?php _e( 'Target', 'papi' ); ?>
                        </td>
                        <td>
                            <input class="wp-link-target" type="hidden" value="<%= target %>" name="<%= slug %>[target]">
                            <%= target === '_blank' ? '<?php _e( 'New window', 'papi' ) ?>' : '<?php _e( 'Same window', 'papi' ); ?>' %>
                        </td>
                    </tr>
                </tbody>
            </table>
        </script>
        <?php
    }

    /**
     * Prepare value for the database.
     *
     * @param  mixed  $values
     * @param  string $slug
     * @param  int    $post_id
     *
     * @return array
     */
    public function update_value( $values, $slug, $post_id ) {
        if ( ! isset( $values['url'] ) ) {
            $values = $this->link_fields;

            foreach ( $values as $index => $key ) {
                $values[sprintf( '%s_%s', $slug, $key )] = '';
                unset( $values[$index] );
            }

            // Delete the required field.
            $values[$slug] = '';

            return $values;
        }

        // If a url exists we can continue making the meta fields
        // that should be saved.
        $values = $this->prepare_link_array( $values, $slug );

        foreach ( $values as $key => $val ) {
            $values[sprintf( '%s_%s', $slug, $key )] = $val;
            unset( $values[$key] );
        }

        // Required field so Papi can load a value from the
        // original property slug.
        $values[$slug] = 1;

        return $values;
    }

    /**
     * Setup actions.
     */
    protected function setup_actions() {
        add_action( 'admin_head', [$this, 'render_link_template'] );
    }
}
API documentation generated by ApiGen