<?php

if ( ! defined( 'ABSPATH' ) ) exit; // Exit if accessed directly

/**
 * Property
 *
 * The PropertyHive property class handles property data.
 *
 * @class       PH_Property
 * @version     1.0.0
 * @package     PropertyHive/Classes
 * @category    Class
 * @author      PropertyHive
 */
// phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedClassFound -- Legacy public global class PH_Property; preserving the existing PH_* class name is required for plugin and extension compatibility.
class PH_Property {

    /** @public int Property (post) ID */
    public $id;

    /** @public string Property (post) Title */
    public $post_title;

    /** @public string Property (post) Status */
    public $post_status;

    /** @public string Property (post) Excerpt */
    public $post_excerpt;

    /**
     * Get the property if ID is passed, otherwise the property is new and empty.
     *
     * @access public
     * @param string|object $id (default: '')
     * @return void
     */
    public function __construct( $id = '' ) {
        if ( $id != '' ) 
        {
            if ( is_int($id) && $id > 0 )
            {
                
            }
            else
            {
                // Must be post object
                $id = $id->ID;
            }       
            $this->get_property( $id );
        }
    }

    /**
     * Gets a property from the database.
     *
     * @access public
     * @param int $id (default: 0)
     * @return bool
     */
    public function get_property( $id = 0 ) {
        if ( ! $id ) {
            return false;
        }
        if ( $result = get_post( $id ) ) {
            $this->populate( $result );
            return true;
        }
        return false;
    }
    
    /**
     * __isset function.
     *
     * @access public
     * @param mixed $key
     * @return bool
     */
    public function __isset( $key ) {
        if ( ! $this->id ) {
            return false;
        }
        return metadata_exists( 'post', $this->id, $key );
    }

    /**
     * __get function.
     *
     * @access public
     * @param mixed $key
     * @return mixed
     */
    public function __get( $key ) {

        $value = '';

        if ( method_exists($this, 'get_' . $key) && 'available_date' != $key ) 
        {
            $value = $this->{'get_' . $key}();
        }
        else
        {
            $value = get_post_meta( $this->id, $key, true );
            if ($value == '')
            {
                $value = get_post_meta( $this->id, '_' . $key, true );
            }
            // Sanitize stored description HTML before trusted extension callbacks run.
            // This also protects descriptions saved before the write-boundary checks.
            if ( preg_match( '/^_?(?:room_(?:name|dimensions|description)|description(?:_name)?)_[0-9]+$/', $key ) ) {
                $value = is_scalar( $value ) ? (string) $value : '';
                $value = preg_match( '/^_?(?:room_description|description)_[0-9]+$/', $key ) ? propertyhive_sanitize_description( $value ) : wp_kses_post( $value );
            }
        }
        
        $value = apply_filters( 'propertyhive_get_detail', $value, $key, $this );

        return $value;
    }
    
    /**
     * Populates a property from the loaded post data.
     *
     * @access public
     * @param mixed $result
     * @return void
     */
    public function populate( $result ) {
        // Standard post data
        $this->id                  = $result->ID;
        $this->post_title          = $result->post_title;
        $this->post_status         = $result->post_status;
        $this->post_excerpt        = apply_filters( 'propertyhive_property_post_excerpt', $result->post_excerpt );
    }
    
    /**
     * get_gallery_attachment_ids function.
     *
     * @access public
     * @return array
     */
    public function get_gallery_attachment_ids() 
    {
        $photos = $this->photos;
        if ( is_array($photos) )
        {
            $photos = array_filter( $photos );
        }
        else
        {
            $photos = array();
        }
        return apply_filters( 'propertyhive_property_gallery_attachment_ids', $photos, $this );
    }
    
    /**
     * Gets the first photo
     *
     * @access public
     * @param string $size
     * @return string
     */
    public function get_main_photo_src( $size = 'thumbnail' ) {
        
        $return = false;

        if ( get_option('propertyhive_images_stored_as', '') == 'urls' )
        {
            $photos = $this->_photo_urls;

            if (isset($photos) && is_array($photos) && !empty($photos) && isset($photos[0]) && isset($photos[0]['url']))
            {
                $return = $photos[0]['url'];
            }
        }
        else
        {
            $photos = $this->_photos;
        
            
            if (isset($photos) && is_array($photos) && !empty($photos) && isset($photos[0]))
            {
                $image_attributes = wp_get_attachment_image_src( $photos[0], $size );
                if( $image_attributes ) 
                {
                    $return = $image_attributes[0];
                }
            }
        }
        
        
        return $return;
    }
    
    /**
     * get_floorplan_attachment_ids function.
     *
     * @access public
     * @return array
     */
    public function get_floorplan_attachment_ids() 
    {
        $floorplans = $this->_floorplans;
        if ( is_array($floorplans) )
        {
            $floorplans = array_filter( $floorplans );
        }
        else
        {
            $floorplans = array();
        }
        return apply_filters( 'propertyhive_property_floorplan_attachment_ids', $floorplans, $this );
    }
    
    /**
     * get_brochure_attachment_ids function.
     *
     * @access public
     * @return array
     */
    public function get_brochure_attachment_ids() 
    {
        $brochures = $this->_brochures;
        if ( is_array($brochures) )
        {
            $brochures = array_filter( $brochures );
        }
        else
        {
            $brochures = array();
        }
        return apply_filters( 'propertyhive_property_brochure_attachment_ids', $brochures, $this );
    }
    
    /**
     * get_epc_attachment_ids function.
     *
     * @access public
     * @return array
     */
    public function get_epc_attachment_ids() 
    {
        $epcs = $this->_epcs;
        if ( is_array($epcs) )
        {
            $epcs = array_filter( $epcs );
        }
        else
        {
            $epcs = array();
        }
        return apply_filters( 'propertyhive_property_epc_attachment_ids', $epcs, $this );
    }

    /**
     * get_virtual_tours function.
     *
     * @access public
     * @return array
     */
    public function get_virtual_tours() 
    {
        $num_property_virtual_tours = get_post_meta($this->id, '_virtual_tours', TRUE);
        if ($num_property_virtual_tours == '') { $num_property_virtual_tours = 0; }

        $virtual_tours = array();
        for ($i = 0; $i < $num_property_virtual_tours; ++$i)
        {
            $label = get_post_meta($this->id, '_virtual_tour_label_' . $i, TRUE);
            $virtual_tours[] = array(
                'url' => get_post_meta($this->id, '_virtual_tour_' . $i, TRUE),
                'label' => ( $label != '' ? $label : __( 'Virtual Tour', 'propertyhive' ) ),
            );
        }

        return apply_filters( 'propertyhive_property_virtual_tours', array_filter( $virtual_tours ), $this );
    }

    /**
     * get_virtual_tour_urls function.
     * deprecated
     *
     * @access public
     * @return array
     */
    public function get_virtual_tour_urls() 
    {
        $num_property_virtual_tours = get_post_meta($this->id, '_virtual_tours', TRUE);
        if ($num_property_virtual_tours == '') { $num_property_virtual_tours = 0; }

        $virtual_tour_urls = array();
        for ($i = 0; $i < $num_property_virtual_tours; ++$i)
        {
            $virtual_tour_urls[] = get_post_meta($this->id, '_virtual_tour_' . $i, TRUE);
        }

        return apply_filters( 'propertyhive_property_virtual_tour_urls', array_filter( $virtual_tour_urls ), $this );
    }

    /**
     * Get the formatted price based on department. Show POA if on frontend and 'POA' ticked
     *
     * @access public
     * @return string
     */
    public function get_formatted_price( $plain_text = false ) {
        
        $return = '';

        $currency = array();
        $prefix = '';
        $suffix = '';

        $is_admin = ( !is_admin() || ( is_admin() && defined('DOING_AJAX') && DOING_AJAX ) ) ? false : true;

        if ( $this->_department == 'commercial' || ph_get_custom_department_based_on( $this->_department ) == 'commercial' )
        {
            if ( 
                !$is_admin &&
                $this->_for_sale == 'yes' && $this->_price_poa == 'yes' &&
                $this->_to_rent == 'yes' && $this->_rent_poa == 'yes'
            )
            {
                $return = esc_html__( 'POA', 'propertyhive' );
            }
            else
            {
                // Price Details
                $price = $this->get_formatted_commercial_price();

                if ( $price != '' && !$plain_text ) 
                { 
                    $price = '<span class="commercial-price">' . $price . '</span>';
                }

                // Rent Details
                $rent = $this->get_formatted_commercial_rent();

                if ( $rent != '' && !$plain_text ) { $rent = '<span class="commercial-rent">' . $rent . '</span>'; }

                if ( $price != '' && $rent != '' )
                {
                    $price .= !$plain_text ? '<br>' : "\n";
                }
                $price .= $rent;

                $return = $price;
            }
        }
        else
        {
            if ( !$is_admin && $this->_poa == 'yes')
            {
                $return = esc_html__( 'POA', 'propertyhive' );
            }
            else
            {
                $ph_countries = new PH_Countries();

                if ( !$is_admin )
                {
                    // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Public currency choice only affects displayed prices.
                    if ( isset($_GET['currency']) && is_string( $_GET['currency'] ) )
                    {
                        // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Public currency choice only affects displayed prices.
                        $currency_code = sanitize_text_field( wp_unslash( $_GET['currency'] ) );
                        if ( $currency_code != '' )
                        {
                            $requested_currency = $ph_countries->get_currency( $currency_code );
                            if ( $requested_currency !== FALSE )
                            {
                                $currency = $requested_currency;
                                $currency['exchange_rate'] = 1;
                                $exchange_rates = get_option( 'propertyhive_currency_exchange_rates', array() );
                                if ( isset($exchange_rates[$currency_code]) )
                                {
                                    $currency['exchange_rate'] = $exchange_rates[$currency_code];
                                }
                            }
                        }
                        else
                        {
                            $default_currency = apply_filters( 'propertyhive_default_display_currency', '' );
                            if ( $default_currency != '' )
                            {
                                $requested_currency = $ph_countries->get_currency( $default_currency );
                                if ( $requested_currency !== FALSE )
                                {
                                    $currency = $requested_currency;
                                    $currency['exchange_rate'] = 1;
                                    $exchange_rates = get_option( 'propertyhive_currency_exchange_rates', array() );
                                    if ( isset($exchange_rates[$default_currency]) )
                                    {
                                        $currency['exchange_rate'] = $exchange_rates[$default_currency];
                                    }
                                }
                            }
                        }
                    }
                    elseif ( false !== ( $cookie_currency = $ph_countries->get_currency_from_cookie() ) )
                    {
                        $currency = $cookie_currency;
                    }
                    else
                    {
                        $default_currency = apply_filters( 'propertyhive_default_display_currency', '' );
                        if ( $default_currency != '' )
                        {
                            $requested_currency = $ph_countries->get_currency( $default_currency );
                            if ( $requested_currency !== FALSE )
                            {
                                $currency = $requested_currency;
                                $currency['exchange_rate'] = 1;
                                $exchange_rates = get_option( 'propertyhive_currency_exchange_rates', array() );
                                if ( isset($exchange_rates[$default_currency]) )
                                {
                                    $currency['exchange_rate'] = $exchange_rates[$default_currency];
                                }
                            }
                        }
                    }
                }

                if ( empty($currency) )
                {
                    if ($this->_currency != '')
                    {
                        $currency = $ph_countries->get_currency( $this->_currency );
                    }
                    else
                    {
                        $currency = $ph_countries->get_currency( 'GBP' );
                    }
                }
                $prefix = ( ($currency['currency_prefix']) ? $currency['currency_symbol'] : '' );
                $suffix = ( (!$currency['currency_prefix']) ? $currency['currency_symbol'] : '' );

                $department = $this->_department;
                if ( ph_get_custom_department_based_on( $department ) !== false )
                {
                    $department = ph_get_custom_department_based_on( $department );
                }
                switch ($department)
                {
                    case "residential-sales":
                    {
                        $price = $this->_price;

                        if ( $currency['currency_code'] != $this->currency && isset($currency['exchange_rate']) && $price != '' )
                        {
                            // Round this after calculation
                            $price = round($this->_price_actual * $currency['exchange_rate'], 0);
                        }

                        $return = ( ( $price != '' ) ? $prefix . esc_html( ph_display_price_field($price, !$is_admin) ) . $suffix : '-' );
                        break;
                    }
                    case "residential-lettings":
                    {
                        $price = $this->_rent;
                        if ( $currency['currency_code'] != $this->currency && isset($currency['exchange_rate']) && $price != '' )
                        {
                            // Round this after calculation as we only want to check the first two decimal places
                            $price = round($this->_price_actual * $currency['exchange_rate'], 2);
                            switch ( $this->_rent_frequency )
                            {
                                case "pd": { $price = ($price * 365) / 52; break; }
                                case "pw": { $price = ($price * 12) / 52; break; }
                                case "pq": { $price = ($price * 12) / 4; break; }
                                case "pa": { $price = ($price * 12); break; }
                            }
                        }

                        $return = ( ( $price != '' ) ? $prefix . esc_html( ph_display_price_field($price, !$is_admin) ) . $suffix . ' ' . esc_html( propertyhive_get_rent_frequency_label( $this->_rent_frequency ) ) : '-' );
                        break;
                    }
                }
            }

        }
        
        // Stored price/frequency text is escaped above; currency and commercial HTML filters remain trusted.
        return apply_filters( 'propertyhive_price_output', $return, $this, $currency, $prefix, $suffix );
    }

    /**
     * Get the formatted commercial price. Show POA if on frontend and 'POA' ticked
     *
     * @access public
     * @return string
     */
    public function get_formatted_commercial_price( ) {

        $price = '';

        if ( $this->_for_sale == 'yes' )
        {
            $is_admin = ( !is_admin() || ( is_admin() && defined('DOING_AJAX') && DOING_AJAX ) ) ? false : true;

            if ( !$is_admin && $this->_price_poa == 'yes' )
            {
                $price .= esc_html__( 'POA', 'propertyhive' );
            }
            else
            {
                $ph_countries = new PH_Countries();
                if ( $this->_commercial_price_currency != '' )
                {
                    $currency = $ph_countries->get_currency( $this->_commercial_price_currency );
                }
                else
                {
                    $currency = $ph_countries->get_currency( 'GBP' );
                }
                $prefix = ( ($currency['currency_prefix']) ? $currency['currency_symbol'] : '' );
                $suffix = ( (!$currency['currency_prefix']) ? $currency['currency_symbol'] : '' );

                if ( $this->_price_from != '' )
                {
                    $price .= $prefix . esc_html( ph_display_price_field($this->_price_from, !$is_admin) ) . $suffix;
                }
                if ( $this->_price_to != '' && $this->_price_to != $this->_price_from )
                {
                    if ( $price != '' )
                    {
                        $price .= ' - ';
                    }
                    $price .= $prefix . esc_html( ph_display_price_field($this->_price_to, !$is_admin) ) . $suffix;
                }
                if ( $price != '' )
                {
                    $price_units = get_commercial_price_units( );
                    $price .= ( isset($price_units[$this->_price_units]) ) ? ' ' . esc_html( $price_units[$this->_price_units] ) : '';
                }
            }
        }

        // Stored price/unit text is escaped above; preserve trusted currency and price filter HTML.
        return apply_filters( 'propertyhive_commercial_price_output', $price, $this );
    }

    /**
     * Get the formatted commercial rent. Show POA if on frontend and 'POA' ticked
     *
     * @access public
     * @return string
     */
    public function get_formatted_commercial_rent( ) {

        $rent = '';

        if ( $this->_to_rent == 'yes' )
        {
            $is_admin = ( !is_admin() || ( is_admin() && defined('DOING_AJAX') && DOING_AJAX ) ) ? false : true;

            if ( !$is_admin && $this->_rent_poa == 'yes' )
            {
                $rent .= esc_html__( 'POA', 'propertyhive' );
            }
            else
            {
                $ph_countries = new PH_Countries();
                if ( $this->_commercial_rent_currency != '' )
                {
                    $currency = $ph_countries->get_currency( $this->_commercial_rent_currency );
                }
                else
                {
                    $currency = $ph_countries->get_currency( 'GBP' );
                }
                $prefix = ( ($currency['currency_prefix']) ? $currency['currency_symbol'] : '' );
                $suffix = ( (!$currency['currency_prefix']) ? $currency['currency_symbol'] : '' );

                if ( $this->_rent_from != '' )
                {
                    $rent .= $prefix . esc_html( ph_display_price_field($this->_rent_from, !$is_admin) ) . $suffix;
                }
                if ( $this->_rent_to != '' && $this->_rent_to != $this->_rent_from )
                {
                    if ( $rent != '' )
                    {
                        $rent .= ' - ';
                    }
                    $rent .= $prefix . esc_html( ph_display_price_field($this->_rent_to, !$is_admin) ) . $suffix;
                }
                if ( $rent != '' )
                {
                    $price_units = get_commercial_price_units( );
                    $rent .= ' ' . esc_html( isset( $price_units[$this->_rent_units] ) ? $price_units[$this->_rent_units] : $this->_rent_units );
                }
            }
        }

        // Stored rent/unit text is escaped above; preserve trusted currency and rent filter HTML.
        return apply_filters( 'propertyhive_commercial_rent_output', $rent, $this );
    }

    public function get_formatted_floor_area( ) {
        
        $area = '';

        if ( $this->_floor_area_from != '' )
        {
            $explode_area = explode(".", $this->_floor_area_from);
            if ( count($explode_area) == 2 )
            {
                $area .= number_format((float)$explode_area[0], 0) . '.' . $explode_area[1];
            }
            else
            {
                $area .= number_format((float)$this->_floor_area_from, 0);
            }
        }
        if ( $this->_floor_area_to != '' && $this->_floor_area_to != $this->_floor_area_from )
        {
            if ( $area != '' )
            {
                $area .= ' - ';
            }
            $explode_area = explode(".", $this->_floor_area_to);
            if ( count($explode_area) == 2 )
            {
                $area .= number_format((float)$explode_area[0], 0) . '.' . $explode_area[1];
            }
            else
            {
                $area .= number_format((float)$this->_floor_area_to, 0);
            }
        }

        if ( $area != '' )
        {
            $area_units = get_area_units( );
            $area .= ( isset($area_units[$this->_floor_area_units]) ) ? ' ' . $area_units[$this->_floor_area_units] : '';
        }

        return apply_filters( 'propertyhive_floor_area_output', esc_html( $area ), $this );

    }

    public function get_formatted_site_area( ) {
        
        $area = '';

        if ( $this->_site_area_from != '' )
        {
            $explode_area = explode(".", $this->_site_area_from);
            if ( count($explode_area) == 2 )
            {
                $area .= number_format((float)$explode_area[0], 0) . '.' . $explode_area[1];
            }
            else
            {
                $area .= number_format((float)$this->_site_area_from, 0);
            }
        }
        if ( $this->_site_area_to != '' && $this->_site_area_to != $this->_site_area_from )
        {
            if ( $area != '' )
            {
                $area .= ' - ';
            }
            $explode_area = explode(".", $this->_site_area_to);
            if ( count($explode_area) == 2 )
            {
                $area .= number_format((float)$explode_area[0], 0) . '.' . $explode_area[1];
            }
            else
            {
                $area .= number_format((float)$this->_site_area_to, 0);
            }
        }

        if ( $area != '' )
        {
            $area_units = get_area_units( );
            $area .= ( isset($area_units[$this->_site_area_units]) ) ? ' ' . $area_units[$this->_site_area_units] : '';
        }

        return apply_filters( 'propertyhive_site_area_output', esc_html( $area ), $this );

    }

    /**
     * Get the formatted deposit
     *
     * @access public
     * @return string
     */
    public function get_formatted_deposit( ) 
    {
        if ( $this->_deposit == '' )
        {
            return '';
        }

        $ph_countries = new PH_Countries();

        $currency = $ph_countries->get_currency( $this->_currency );

        $is_admin = ( !is_admin() || ( is_admin() && defined('DOING_AJAX') && DOING_AJAX ) ) ? false : true;

        if ( $currency === false )
        {
            return ph_display_price_field($this->_deposit, !$is_admin);
        }

        $prefix = ( !isset($currency['currency_prefix']) || ( isset($currency['currency_prefix']) && $currency['currency_prefix'] ) ) ? $currency['currency_symbol'] : '';
        $suffix = ( isset($currency['currency_prefix']) && !$currency['currency_prefix'] ) ? $currency['currency_symbol'] : '';

        return $prefix . ph_display_price_field($this->_deposit, !$is_admin) . $suffix;
    }
    
    /**
     * Get the available date, or 'Now' if date is in past
     *
     * @access public
     * @return string
     */
    public function get_available_date( ) 
    {
        if ( $this->_available_date == '' )
        {
            return '';
        }

        if (strtotime($this->_available_date) > time())
        {
            return gmdate( get_option( 'date_format' ), strtotime($this->_available_date) );
        }
        else
        {
            return __( 'Now', 'propertyhive' );
        }
    }
    
    /**
     * Get the full description by constructing the rooms or commercial description (dependant on department)
     *
     * @access public
     * @return string
     */
    public function get_formatted_description( $plain_text = false ) {

        $department = $this->_department;
        if ( ph_get_custom_department_based_on( $department ) !== false )
        {
            $department = ph_get_custom_department_based_on( $department );
        }
        if ( $department == 'commercial' )
        {
            $description = $this->get_formatted_descriptions( $plain_text ); // Haven't called this commercial_descriptions as we might use generic descriptions for other areas going forward
        }
        else
        {
            $description = $this->get_formatted_rooms( $plain_text );
        }

        return apply_filters( 'propertyhive_description_output', $description );
    }

    /**
     * Get the full description by constructing the rooms
     *
     * @access public
     * @return string
     */
    public function get_formatted_rooms( $plain_text = false ) {
        
        $rooms = $this->_rooms;
        
        $return = '';
        
        if (isset($rooms) && $rooms != '' && $rooms > 0)
        {
            for ($i = 0; $i < $rooms; ++$i)
            {
                if ( !$plain_text )
                {
                    $return .= '<p class="room">';
                    if ($this->{'_room_name_' . $i} != '')
                    {
                        $return .= '<strong class="name">' . $this->{'_room_name_' . $i} . '</strong>';
                    }
                    if ($this->{'_room_dimensions_' . $i} != '')
                    {  
                        $return .= '&nbsp;<span class="dimension">' . $this->{'_room_dimensions_' . $i} . '</span>';
                    }
                    if ($this->{'_room_name_' . $i} != '' || $this->{'_room_dimensions_' . $i} != '')
                    {
                        $return .= '<br>';
                    }
                    $return .= str_replace("\r\n", "", nl2br($this->{'_room_description_' . $i})) . '</p>';
                }
                else
                {
                    if ($this->{'_room_name_' . $i} != '')
                    {
                        $return .= $this->{'_room_name_' . $i};
                    }
                    if ($this->{'_room_dimensions_' . $i} != '')
                    {  
                        $return .= ' ' . $this->{'_room_dimensions_' . $i};
                    }
                    if ($this->{'_room_name_' . $i} != '' || $this->{'_room_dimensions_' . $i} != '')
                    {
                        $return .= "\n";
                    }
                    $return .= wp_strip_all_tags($this->{'_room_description_' . $i}) . "\n\n";
                }
            }
        }

        return $return;
    }

    /**
     * Get the full description by constructing the descriptions
     *
     * @access public
     * @return string
     */
    public function get_formatted_descriptions( $plain_text = false ) {
        
        $descriptions = $this->_descriptions;
        
        $return = '';
        
        if (isset($descriptions) && $descriptions != '' && $descriptions > 0)
        {
            for ($i = 0; $i < $descriptions; ++$i)
            {
                if ( !$plain_text )
                {
                    $return .= '<p class="description-section';
                    if ($this->{'_description_name_' . $i} != '')
                    {
                        $return .= ' description-section-' . esc_attr(sanitize_title($this->{'_description_name_' . $i}));
                    }
                    $return .= '">';
                    if ($this->{'_description_name_' . $i} != '')
                    {
                        $return .= '<strong class="description-title">' . $this->{'_description_name_' . $i} . '</strong><br>';
                    }
                    $return .= str_replace("\r\n", "", nl2br($this->{'_description_' . $i})) . '</p>';
                }
                else
                {
                    if ($this->{'_description_name_' . $i} != '')
                    {
                        $return .= $this->{'_description_name_' . $i} . "\n";
                    }
                    $return .= wp_strip_all_tags($this->{'_description_' . $i}) . "\n\n";
                }
            }
        }
        
        return $return;
    }
    
    /**
     * Get the property type taxononmy
     *
     * @access public
     * @return string
     */
    public function get_property_type()
    {
        $term_list = wp_get_post_terms($this->id, ( ( $this->_department == 'commercial' || ph_get_custom_department_based_on( $this->_department ) == 'commercial' ) ? 'commercial_' : '' ) . 'property_type', array("fields" => "names"));
        
        if ( !is_wp_error($term_list) && is_array($term_list) && !empty($term_list) )
        {
            return implode(", ", $term_list);
        }
        
        return '';
    }

    /**
     * Get the availability taxononmy
     *
     * @access public
     * @return string
     */
    public function get_availability()
    {
        $term_list = wp_get_post_terms($this->id, 'availability', array("fields" => "names"));
        
        if ( !is_wp_error($term_list) && is_array($term_list) && !empty($term_list) )
        {
            return implode(", ", $term_list);
        }
        
        return '';
    }

    /**
     * Get the location taxononmy
     *
     * @access public
     * @return string
     */
    public function get_location()
    {
        $term_list = wp_get_post_terms($this->id, 'location', array("fields" => "names"));
        
        if ( !is_wp_error($term_list) && is_array($term_list) && !empty($term_list) )
        {
            return implode(", ", $term_list);
        }
        
        return '';
    }

    /**
     * Get the price qualifier taxononmy
     *
     * @access public
     * @return string
     */
    public function get_price_qualifier()
    {
        $term_list = wp_get_post_terms($this->id, 'price_qualifier', array("fields" => "names"));
        
        if ( !is_wp_error($term_list) && is_array($term_list) && !empty($term_list) )
        {
            return implode(", ", $term_list);
        }
        
        return '';
    }

    /**
     * Get the tenure taxononmy
     *
     * @access public
     * @return string
     */
    public function get_tenure()
    {
        $term_list = wp_get_post_terms($this->id, ( ( $this->_department == 'commercial' || ph_get_custom_department_based_on( $this->_department ) == 'commercial' ) ? 'commercial_' : '' ) . 'tenure', array("fields" => "names"));
        
        if ( !is_wp_error($term_list) && is_array($term_list) && !empty($term_list) )
        {
            return implode(", ", $term_list);
        }
        
        return '';
    }

    /**
     * Get the sale by taxononmy
     *
     * @access public
     * @return string
     */
    public function get_sale_by()
    {
        $term_list = wp_get_post_terms($this->id, 'sale_by', array("fields" => "names"));
        
        if ( !is_wp_error($term_list) && is_array($term_list) && !empty($term_list) )
        {
            return implode(", ", $term_list);
        }
        
        return '';
    }

    /**
     * Get the furnished taxononmy
     *
     * @access public
     * @return string
     */
    public function get_furnished()
    {
        $term_list = wp_get_post_terms($this->id, 'furnished', array("fields" => "names"));
        
        if ( !is_wp_error($term_list) && is_array($term_list) && !empty($term_list) )
        {
            return implode(", ", $term_list);
        }
        
        return '';
    }

    /**
     * Get the parking taxononmy
     *
     * @access public
     * @return string
     */
    public function get_parking()
    {
        $term_list = wp_get_post_terms($this->id, 'parking', array("fields" => "names"));
        
        if ( !is_wp_error($term_list) && is_array($term_list) && !empty($term_list) )
        {
            return implode(", ", $term_list);
        }
        
        return '';
    }

    /**
     * Get the outside space taxononmy
     *
     * @access public
     * @return string
     */
    public function get_outside_space()
    {
        $term_list = wp_get_post_terms($this->id, 'outside_space', array("fields" => "names"));
        
        if ( !is_wp_error($term_list) && is_array($term_list) && !empty($term_list) )
        {
            return implode(", ", $term_list);
        }
        
        return '';
    }

    /**
     * Get the marketing flag taxononmy
     *
     * @access public
     * @return string
     */
    public function get_marketing_flag()
    {
        $term_list = wp_get_post_terms($this->id, 'marketing_flag', array("fields" => "names"));
        
        if ( !is_wp_error($term_list) && is_array($term_list) && !empty($term_list) )
        {
            return implode(", ", $term_list);
        }
        
        return '';
    }

    /**
     * Get the ID of property from third party system
     *
     * @access public
     * @return string
     */
    public function get_imported_id()
    {
        // Use WordPress's metadata cache and match the literal importer-key prefix.
        foreach ( get_post_meta( $this->id ) as $key => $values ) {
            if ( 0 === strpos( $key, '_imported_ref_' ) && isset( $values[0] ) ) {
                return $values[0];
            }
        }
        return '';
    }

    /**
     * Get an array of property features
     *
     * @access public
     * @return array
     */
    public function get_features( ) 
    {
        $features = array();
        
        if ( get_option('propertyhive_features_type') == 'checkbox' )
        {
            $term_list = wp_get_post_terms($this->id, 'property_feature', array("fields" => "names"));
            if ( !is_wp_error($term_list) && is_array($term_list) && !empty($term_list) )
            {
                foreach ( $term_list as $term_name )
                {
                    $features[] = trim($term_name);
                }
            }
        }
        else
        {
            $num_property_features = $this->_features;
            if ($num_property_features == '') { $num_property_features = 0; }
            
            for ($i = 0; $i < $num_property_features; ++$i)
            {   
                if ( trim($this->{'_feature_' . $i}) != '' )
                {
                    $features[] = trim($this->{'_feature_' . $i});
                }
            }
        }
        
        return apply_filters( 'propertyhive_property_features', $features );
    }
    
    /**
     * Get the full formatted address
     *
     * @access public
     * @return string
     */
    public function get_formatted_full_address( $separator = ', ' ) {
        // Standard post data
        
        $return = '';
        
        $address_name_number = $this->_address_name_number;
        if ($address_name_number != '')
        {
            $return .= $address_name_number;
        }
        $address_street = $this->_address_street;
        if ($address_street != '')
        {
            if ($return != '') { $return .= ' '; }
            $return .= $address_street;
        }
        $address_two = $this->_address_two;
        if ($address_two != '')
        {
            if ($return != '') { $return .= $separator; }
            $return .= $address_two;
        }
        $address_three = $this->_address_three;
        if ($address_three != '')
        {
            if ($return != '') { $return .= $separator; }
            $return .= $address_three;
        }
        $address_four = $this->_address_four;
        if ($address_four != '')
        {
            if ($return != '') { $return .= $separator; }
            $return .= $address_four;
        }
        $address_postcode = $this->_address_postcode;
        if ($address_postcode != '')
        {
            if ($return != '') { $return .= $separator; }
            $return .= $address_postcode;
        }

        if ( $return == '' )
        {
            $return = $this->post_title;
        }
        
        return $return;
    }

    /**
     * Get the summary formatted address
     *
     * @access public
     * @return string
     */
    public function get_formatted_summary_address( $separator = ', ' ) {
        // Standard post data
        
        $return = '';
        
        $address_name_number = $this->_address_name_number;
        if ($address_name_number != '')
        {
            $return .= $address_name_number;
        }
        $address_street = $this->_address_street;
        if ($address_street != '')
        {
            if ($return != '') { $return .= ' '; }
            $return .= $address_street;
        }
        $address_two = $this->_address_two;
        $address_three = $this->_address_three;
        $address_four = $this->_address_four;
        if ($address_two != '')
        {
            if ($return != '') { $return .= $separator; }
            $return .= $address_two;
        }
        elseif ($address_three != '')
        {
            if ($return != '') { $return .= $separator; }
            $return .= $address_three;
        }
        elseif ($address_four != '')
        {
            if ($return != '') { $return .= $separator; }
            $return .= $address_four;
        }
        $address_postcode = $this->_address_postcode;
        if ($address_postcode != '')
        {
            if ($return != '') { $return .= $separator; }
            $return .= $address_postcode;
        }

        if ( $return == '' )
        {
            $return = $this->post_title;
        }
        
        return $return;
    }

    public function get_material_information()
    {
        $return = array();

        $utilities = array();

        // Utilities
        $utility_types = array( 
            'electricity' => __( 'Electricity Type', 'propertyhive' ), 
            'water' => __( 'Water Type', 'propertyhive' ),  
            'heating' => __( 'Heating Type', 'propertyhive' ), 
            'broadband' => __( 'Broadband Type', 'propertyhive' ), 
            'sewerage' => __( 'Sewerage Type', 'propertyhive' ),  
        );
        foreach ( $utility_types as $utility_key => $utility_label )
        {
            $property_utility_types = $this->{'_' . $utility_key . '_type'};
            if ( is_array($property_utility_types) && !empty($property_utility_types) )
            {
                $types = array();
                foreach ( $property_utility_types as $type ) 
                {
                    if ( $type == 'other' )
                    {
                        $types[] = $this->{'_' . $utility_key . '_type_other'};
                    }
                    else
                    {
                        $function_name = "get_{$utility_key}_type";

                        if ( function_exists($function_name) )
                        {
                            $types[] = $function_name($type);
                        }
                        else
                        {
                            $types[] = $type;
                        }
                    }
                }
                if ( !isset($utilities[$utility_key]) ) { $utilities[$utility_key] = array(); }
                $utilities[$utility_key] = implode(", ", $types);
            }
        }

        if ( !empty($utilities) )
        {
            $return['utilities'] = $utilities;
        }

        // Accessibility
        $accessibility = array();

        $property_accessibility = $this->_accessibility;
        if ( is_array($property_accessibility) && !empty($property_accessibility) )
        {
            foreach ( $property_accessibility as $type ) 
            {
                if ( $type == 'other' )
                {
                    $accessibility[] = $this->_accessibility_other;
                }
                else
                {
                    $function_name = "get_accessibility_type";

                    if ( function_exists($function_name) )
                    {
                        $accessibility[] = $function_name($type);
                    }
                    else
                    {
                        $accessibility[] = $type;
                    }
                }
            }
        }

        if ( !empty($accessibility) )
        {
            $return['accessibility'] = implode(", ", $accessibility);
        }

        // Restrictions
        $restrictions = array();

        $property_restriction = $this->_restriction;
        if ( is_array($property_restriction) && !empty($property_restriction) )
        {
            foreach ( $property_restriction as $type ) 
            {
                if ( $type == 'other' )
                {
                    $restrictions[] = $this->_restriction_other;
                }
                else
                {
                    $function_name = "get_restriction";

                    if ( function_exists($function_name) )
                    {
                        $restrictions[] = $function_name($type);
                    }
                    else
                    {
                        $restrictions[] = $type;
                    }
                }
            }
        }

        if ( !empty($restrictions) )
        {
            $return['restrictions'] = implode(", ", $restrictions);
        }

        // Rights & Easements
        $rights = array();

        $property_right = $this->_right;
        if ( is_array($property_right) && !empty($property_right) )
        {
            foreach ( $property_right as $type ) 
            {
                if ( $type == 'other' )
                {
                    $rights[] = $this->_right_other;
                }
                else
                {
                    $function_name = "get_right";

                    if ( function_exists($function_name) )
                    {
                        $rights[] = $function_name($type);
                    }
                    else
                    {
                        $rights[] = $type;
                    }
                }
            }
        }

        if ( !empty($rights) )
        {
            $return['rights'] = implode(", ", $rights);
        }

        // Flood Risk
        $flood_data = array();

        $property_flood_data = $this->_flooded_in_last_five_years;
        if ( !empty($property_flood_data) )
        {
            $flood_data['flooded_in_last_five_years'] = ucfirst($property_flood_data);
        }

        $flood_sources = array();

        $property_flood_source_type = $this->_flood_source_type;
        if ( is_array($property_flood_source_type) && !empty($property_flood_source_type) )
        {
            foreach ( $property_flood_source_type as $type ) 
            {
                if ( $type == 'other' )
                {
                    $flood_sources[] = $this->_flood_source_type_other;
                }
                else
                {
                    $function_name = "get_flooding_source_type";

                    if ( function_exists($function_name) )
                    {
                        $flood_sources[] = $function_name($type);
                    }
                    else
                    {
                        $flood_sources[] = $type;
                    }
                }
            }
        }

        if ( !empty($flood_sources) )
        {
            $flood_data['flood_source'] = implode(", ", $flood_sources);
        }

        $property_flood_data = $this->_flood_defences;
        if ( !empty($property_flood_data) )
        {
            $flood_data['flood_defences'] = ucfirst($property_flood_data);
        }

        if ( !empty($flood_data) )
        {
            $return['flood_risk'] = $flood_data;
        }

        $return = apply_filters( 'propertyhive_property_material_information', $return, $this );

        return $return;
    }

    public function get_office_name()
    {
        return get_the_title( $this->_office_id );
    }

    public function get_office_address( $separator = ', ' )
    {
        $return = '';
        
        for ( $i = 1; $i <= 4; ++$i )
        {
            $address = get_post_meta( $this->_office_id, '_office_address_' . $i, TRUE );
            if ($address != '')
            {
                if ($return != '') { $return .= $separator; }
                $return .= $address;
            }
        }
        $address = get_post_meta( $this->_office_id, '_office_address_postcode', TRUE );
        if ($address != '')
        {
            if ($return != '') { $return .= $separator; }
            $return .= $address;
        }

        return $return;
    }

    public function get_office_telephone_number()
    {
        return get_post_meta( $this->_office_id, '_office_telephone_number_' . ( str_replace("residential-", "", $this->_department) ), TRUE );
    }

    public function get_office_email_address()
    {
        return get_post_meta( $this->_office_id, '_office_email_address_' . ( str_replace("residential-", "", $this->_department) ), TRUE );
    }

    public function get_negotiator_name()
    {   
        if ( empty($this->_negotiator_id) )
        {
            return '';
        }

        $user = get_userdata( $this->_negotiator_id );

        if ( $user === false )
        {
            return '';
        }

        return $user->display_name;
    }

    public function get_negotiator_telephone_number( $fallback_to_office = true )
    {   
        if ( empty($this->_negotiator_id) )
        {
            return '';
        }

        $user = get_userdata( $this->_negotiator_id );

        if ( $user === false )
        {
            return '';
        }

        $telephone_number = get_user_meta( $this->_negotiator_id, 'telephone_number', true );

        if ( empty($telephone_number) && $fallback_to_office )
        {
            // need to fallback
            $telephone_number = $this->get_office_telephone_number();
        }

        return $telephone_number;
    }

    public function get_negotiator_email_address( $fallback_to_office = true )
    {   
        if ( empty($this->_negotiator_id) )
        {
            return '';
        }

        $user = get_userdata( $this->_negotiator_id );

        if ( $user === false )
        {
            return '';
        }

        $email_address = $user->user_email;

        if ( empty($email_address) && $fallback_to_office )
        {
            // need to fallback
            $email_address = $this->get_office_email_address();
        }

        return $email_address;
    }

    public function get_negotiator_photo()
    {   
        if ( empty($this->_negotiator_id) )
        {
            return '';
        }

        $user = get_userdata( $this->_negotiator_id );

        if ( $user === false )
        {
            return '';
        }

        $photo_attachment_id = get_user_meta( $this->_negotiator_id, 'photo_attachment_id', true );

        $photo = wp_get_attachment_image( $photo_attachment_id, 'large' );

        return $photo;
    }

    /**
     * Returns boolean whether the property is featured or not
     *
     * @access public
     * @return string
     */
    public function is_featured() {

        if ( $this->_featured == 'yes' )
        {
            return true;
        }

        return false;

    }
    
    /**
     * Adds a note (comment) to the property
     *
     * @access public
     * @param string $note Note to add
     * @return id Comment ID
     */
    public function add_note( $note ) {

        if ( is_user_logged_in() ) 
        {
            $user = get_user_by( 'id', get_current_user_id() );
        
            $commentdata = array(
                'comment_post_ID' => $this->id,
                'comment_author' => $user->display_name,
                'comment_author_email' => $user->user_email,
                'comment_author_url' => '',
                'comment_content' => $note,
                'comment_type' => 'propertyhive_note',
                'comment_parent' => 0,
                'user_id' => $user->ID,
                'comment_agent' => 'PropertyHive',
                'comment_date' => current_time('mysql'),
                'comment_approved' => 1,
            );
            
            $comment_id = wp_insert_comment( $commentdata );
            
            return $comment_id;
        }
    }


}