Overview

Namespaces

  • None
  • WPGMZA
    • CustomFieldFilterWidget
    • Integration
    • MarkerListing
    • Selector

Classes

  • WPGMapsImportExport
  • WPGMZA\AddMapDialog
  • WPGMZA\AdminMarkerDataTable
  • WPGMZA\AjaxTable
  • WPGMZA\AutoLoader
  • WPGMZA\Categories
  • WPGMZA\Category
  • WPGMZA\CategoryTree
  • WPGMZA\CategoryTreeNode
  • WPGMZA\ContentEditorMapButton
  • WPGMZA\Crud
  • WPGMZA\CustomFieldFilter
  • WPGMZA\CustomFieldFilterController
  • WPGMZA\CustomFieldFilterWidget
  • WPGMZA\CustomFieldFilterWidget\Checkboxes
  • WPGMZA\CustomFieldFilterWidget\Dropdown
  • WPGMZA\CustomFieldFilterWidget\Text
  • WPGMZA\CustomFields
  • WPGMZA\CustomFieldsPage
  • WPGMZA\CustomMapObjectFields
  • WPGMZA\CustomMarkerFields
  • WPGMZA\Database
  • WPGMZA\DataTable
  • WPGMZA\Distance
  • WPGMZA\DOMDocument
  • WPGMZA\DOMElement
  • WPGMZA\Export
  • WPGMZA\Factory
  • WPGMZA\FontAwesomeIconPicker
  • WPGMZA\GDPRCompliance
  • WPGMZA\GlobalSettings
  • WPGMZA\GoogleGeocoder
  • WPGMZA\GoogleMap
  • WPGMZA\GoogleMapsAPILoader
  • WPGMZA\GoogleMapsLoader
  • WPGMZA\GoogleProMapsLoader
  • WPGMZA\Import
  • WPGMZA\ImportCSV
  • WPGMZA\ImportGPX
  • WPGMZA\ImportJSON
  • WPGMZA\ImportKML
  • WPGMZA\Integration\Gutenberg
  • WPGMZA\Integration\ProGutenberg
  • WPGMZA\Integration\WPMigrateDB
  • WPGMZA\LatLng
  • WPGMZA\Map
  • WPGMZA\MapSelect
  • WPGMZA\MapsEngineDialog
  • WPGMZA\Marker
  • WPGMZA\MarkerDataTable
  • WPGMZA\MarkerFilter
  • WPGMZA\MarkerLibraryDialog
  • WPGMZA\MarkerListing
  • WPGMZA\MarkerListing\AdvancedTable
  • WPGMZA\MarkerListing\BasicList
  • WPGMZA\MarkerListing\BasicTable
  • WPGMZA\MarkerListing\Carousel
  • WPGMZA\MarkerListing\Modern
  • WPGMZA\ModalDialog
  • WPGMZA\NominatimGeocodeCache
  • WPGMZA\OLLoader
  • WPGMZA\OLProLoader
  • WPGMZA\Plugin
  • WPGMZA\ProAdminMarkerDataTable
  • WPGMZA\ProMap
  • WPGMZA\ProMarker
  • WPGMZA\ProMarkerFilter
  • WPGMZA\ProPlugin
  • WPGMZA\ProRestAPI
  • WPGMZA\Query
  • WPGMZA\QueryFragment
  • WPGMZA\RestAPI
  • WPGMZA\ScriptLoader
  • WPGMZA\Selector\AttributeSelector
  • WPGMZA\Selector\Parser
  • WPGMZA\Selector\PseudoSelector
  • WPGMZA\Selector\Selector
  • WPGMZA\Selector\Token
  • WPGMZA\Selector\Tokenizer
  • WPGMZA\Selector\TokenStream
  • WPGMZA\Selector\XPathConverter
  • WPGMZA\Strings
  • WPGMZA\Table

Exceptions

  • WPGMZA\Selector\ConvertException
  • WPGMZA\Selector\ParseException

Functions

  • old_wpgmaps_list_categories
  • old_wpgmza_pro_return_category_select_list
  • wpgmaps_admin_add_poly_javascript
  • wpgmaps_admin_add_polyline_javascript
  • wpgmaps_admin_category_scripts
  • wpgmaps_admin_category_styles
  • wpgmaps_admin_edit_poly_javascript
  • wpgmaps_admin_edit_polyline_javascript
  • wpgmaps_admin_wizard_scripts
  • wpgmaps_category_head
  • wpgmaps_list_categories
  • wpgmaps_menu_category_layout
  • wpgmaps_trash_cat
  • wpgmaps_wizard_layout
  • WPGMZA\add_custom_filter_widgets
  • WPGMZA\create_marker_instance_delegate
  • WPGMZA\custom_field_filter_get_filtered_marker_ids
  • WPGMZA\get_custom_field_filter
  • WPGMZA\get_custom_field_filter_controller
  • WPGMZA\get_custom_field_filter_widget
  • WPGMZA\get_marker_custom_fields
  • WPGMZA\import_ajax_delete_schedule
  • WPGMZA\import_ajax_file_options
  • WPGMZA\import_ajax_handle_delete
  • WPGMZA\import_ajax_handle_upload
  • WPGMZA\import_ajax_import
  • WPGMZA\import_ajax_schedule
  • WPGMZA\import_cron_import
  • WPGMZA\import_cron_schedules
  • WPGMZA\import_export_admin_options
  • WPGMZA\import_export_admin_tabs
  • WPGMZA\import_export_download
  • WPGMZA\import_export_get_maps_list
  • WPGMZA\import_get_progress
  • WPGMZA\import_get_schedule
  • WPGMZA\import_mimes
  • WPGMZA\import_wp_check_filetype_and_ext
  • WPGMZA\load_advanced_menu_page_hooks
  • WPGMZA\query_nominatim_cache
  • WPGMZA\Selector\trace
  • WPGMZA\show_custom_fields_page
  • WPGMZA\store_nominatim_cache
  • wpgmza_backwards_compat_get_all_circle_data
  • wpgmza_backwards_compat_get_all_rectangle_data
  • wpgmza_build_tree
  • wpgmza_check_admin_head_backwards_compat_v6
  • wpgmza_check_cat_map
  • wpgmza_check_map_editor_backwards_compat_v6
  • wpgmza_check_pro_compat_required_v6
  • wpgmza_check_user_backwards_compat_v6
  • wpgmza_consume_tree
  • wpgmza_consume_tree_dropdown
  • wpgmza_consume_tree_main_list
  • wpgmza_get_category_localized_data
  • wpgmza_pro_add_poly
  • wpgmza_pro_add_polyline
  • wpgmza_pro_category_edit_layout
  • wpgmza_pro_category_new_layout
  • wpgmza_pro_edit_poly
  • wpgmza_pro_edit_polyline
  • wpgmza_pro_return_category_blocks
  • wpgmza_pro_return_category_checkbox_list
  • wpgmza_pro_return_category_dropdown_list
  • wpgmza_pro_return_category_select_list
  • wpgmza_pro_return_maps_linked_to_cat
  • wpgmza_return_all_categories
  • wpgmza_return_category_data
  • wpgmza_return_marker_count_by_category
  • wpgmza_return_marker_count_category_via_elements
  • wpgmza_return_poly_options
  • wpgmza_return_polygon_array
  • wpgmza_return_polygon_id_array
  • wpgmza_return_polygon_list
  • wpgmza_return_polyline_array
  • wpgmza_return_polyline_id_array
  • wpgmza_return_polyline_list
  • wpgmza_return_polyline_options
  • wpgmza_tree_marker_counter
  • wpgmza_wizard_item_control_c
  • wpgmza_wizard_item_control_gd
  • wpgmza_wizard_item_control_ml
  • wpgmza_wizard_item_control_sl
  • Overview
  • Namespace
  • Class
  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: 
<?php

namespace WPGMZA;

global $wpdb;
global $WPGMZA_TABLE_NAME_CUSTOM_FIELDS;
global $WPGMZA_TABLE_NAME_MAPS_HAS_CUSTOM_FIELDS_FILTERS;

$WPGMZA_TABLE_NAME_CUSTOM_FIELDS = $wpdb->prefix . 'wpgmza_custom_fields';
$WPGMZA_TABLE_NAME_MAPS_HAS_CUSTOM_FIELDS_FILTERS = $wpdb->prefix . 'wpgmza_maps_has_custom_fields_filters';

/**
 * This class deals with custom fields on a specific map object (marker, polygon, polyline, etc.)
 */
class CustomMapObjectFields implements \IteratorAggregate, \JsonSerializable, \Countable
{
    private static $installed = null;
    
    protected static $field_names_by_id = null;
    protected static $field_ids_by_name = null;
    
    protected $meta_table_name = null;
    private $object_id;
    
    private $meta;
    private $attributes;
    private $icon;
    
    /**
     * Constructor. DO NOT call this directly. Use the hooks, for example wpgmza_get_marker_custom_fields
     * @return WPGMZA\CustomFields
     */
    public function __construct($object_id)
    {
        global $wpdb;
        global $WPGMZA_TABLE_NAME_CUSTOM_FIELDS;
        
        if(!CustomFields::installed())
            CustomFields::install();
        
        if(!CustomMapObjectFields::$field_names_by_id)
        {
            CustomMapObjectFields::$field_names_by_id = array();
            
            $fields = $wpdb->get_results("SELECT id, name FROM $WPGMZA_TABLE_NAME_CUSTOM_FIELDS");
            
            foreach($fields as $obj)
                CustomMapObjectFields::$field_names_by_id[(int)$obj->id] = $obj->name;
                
            CustomMapObjectFields::$field_ids_by_name = array_flip(CustomMapObjectFields::$field_names_by_id);
        }
        
        if(!$this->meta_table_name)
            throw new \Exception('No table name');
        
        $this->object_id = (int)$object_id;
        $this->meta = array();
        
        $qstr = "
            SELECT
            name, 
            value,
            icon, 
            attributes 
            FROM `$WPGMZA_TABLE_NAME_CUSTOM_FIELDS`
            LEFT JOIN `{$this->meta_table_name}`
            ON `id`=`{$this->meta_table_name}`.`field_id`
            WHERE `object_id`=%d
            AND LENGTH(value)
            ";
        $params = array($object_id);
        $stmt = $wpdb->prepare($qstr, $params);
        
        $results = $wpdb->get_results($stmt);
        
        foreach($results as $obj)
        {
            $this->meta[$obj->name] = $obj->value;
            
            if(!empty($obj->icon))
                $this->icon[$obj->name] = $obj->icon;

            if(!empty($obj->attributes))
                $this->attributes[$obj->name] = json_decode($obj->attributes);
            else
                $this->attributes = (object)array();
        }
    }
    
    public function count()
    {
        return count($this->meta);
    }
    
    /**
     * Get iterator for looping over fields with foreach
     * @return \ArrayIterator
     */
    public function getIterator()
    {
        return new \ArrayIterator($this->meta);
    }
    
    /**
     * Gets the fields to be serialized as JSON, useful for export
     * @return array
     */
    public function jsonSerialize()
    {
        return $this->meta;
    }
    
    /**
     * Returns true if the named meta field is set
     * @return bool
     */
    public function __isset($name)
    {
        return isset($this->meta[$name]);
    }
    
    /**
     * Gets the named meta field from this objects cache
     * @return mixed
     */
    public function __get($name)
    {
        if($name == 'object_id')
            return $this->object_id;
        
        if(isset($this->meta[$name]))
            return $this->meta[$name];
        
        return null;
    }
    
    /**
     * Sets the named meta field in this objects cache and the database
     * @return void
     */
    public function __set($name, $value)
    {
        global $wpdb;
        
        if($name == 'object_id')
            throw new \Exception('Property is read only');
        
        if(is_numeric($name))
        {
            $field_id = (int)$name;
            $name = CustomMapObjectFields::$field_names_by_id[ (int)$name ];
        }
        else
            $field_id = CustomMapObjectFields::$field_ids_by_name[$name];
        
        $this->meta[$name] = $value;
        
        $stmt = $wpdb->prepare("INSERT INTO {$this->meta_table_name}
            (field_id, object_id, value)
            VALUES
            (%d, %d, %s)
            ON DUPLICATE KEY UPDATE value = %s",
            array(
                $field_id,
                $this->object_id,
                $value,
                $value
            )
        );
        
        $wpdb->query($stmt);
    }
    
    /**
     * Removes the named meta field from the cache and deletes it from the database
     * @return void
     */
    public function __unset($name)
    {
        global $wpdb;
        
        unset($this->meta[$name]);
        
        $stmt = $wpdb->prepare("DELETE FROM {$this->meta_table_name} WHERE name=%s AND object_id=%d", array($name, $this->object_id));
        $wpdb->query($stmt);
    }
    
    public function remove()
    {
        global $wpdb;
        
        $this->meta = array();
        
        $stmt = $wpdb->prepare("DELETE FROM {$this->meta_table_name} WHERE object_id=%d", array($this->object_id));
        $wpdb->query($stmt);
    }

    /**
     * Returns the default HTML for the custom fields (front end)
     * TODO: This should be changed to use DOMDocument instead of plain strings, it's vulnerable to XSS attacks through UGM at the moment.
     * @return string
     */
    public function html()
    {
        $html = '';

        foreach($this->meta as $key => $value)
        {
            if(empty($key) || empty($value))
                continue;
            
            $id = CustomMapObjectFields::$field_ids_by_name[$key];
            
            $item = '<p data-custom-field-id="' . $id . '" data-custom-field-name="' . htmlspecialchars($key) . '" ';
            
            foreach($this->attributes[$key] as $attr_name => $attr_value)
            {
                // NB: Temporary fix for blank attribute names
                if(empty($attr_name))
                    continue;
                
                $item .= "$attr_name=\"" . addcslashes($attr_value, '"') . "\"";
            }

            $item .= '>';
            
            if(!empty($this->icon[$key]))
                $item .= '<span class="wpgmza-custom-field fa ' . $this->icon[$key] . '"></span>';
            
            $item .= __($value, 'wp-google-maps');
            
            $item .= '</p>';
            
            $html .= apply_filters('wpgmza_custom_fields_row_html', $item);
        }
        
        return apply_filters('wpgmza_custom_fields_html', $html);
    }
    
    /**
     * Shows the admin controls for these custom fields
     * @return string
     */
    public static function adminHtml()
    {
        global $wpdb;
        global $WPGMZA_TABLE_NAME_CUSTOM_FIELDS;
        
        if(!CustomFields::installed())
            CustomFields::install();
        
        $fields = $wpdb->get_results("SELECT * FROM $WPGMZA_TABLE_NAME_CUSTOM_FIELDS");
        $html = '';
        
        foreach($fields as $field)
        {
            $attributes = '';
            
            foreach(json_decode($field->attributes) as $attr_name => $attr_value)
            {
                // NB: Temporary fix for blank attribute names
                if(empty($attr_name))
                    continue;
                
                $attributes .= " $attr_name=\"" . addcslashes($attr_value, '"') . "\"";
            }
            
            $item = '<tr data-custom-field-id="' . $field->id . '">
                <td>
                    ' . htmlspecialchars($field->name) . '
                </td>
                <td>
                    <input placeholder="' . htmlspecialchars($field->name) . '" data-custom-field-name="' . addcslashes($field->name, '"') . '" name="wpgmza-custom-field-' . $field->id . '" ' . $attributes . '/>
                </td>
            </tr>';
            
            $html .= $item;
        }
        
        return $html;
    }
}
API documentation generated by ApiGen