EE_Price

Complexity

Total Complexity

29

Size/Duplication

Total Lines	446
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	4

Importance

Changes

0

27 Methods

Rating	Name	Duplication	Size	Complexity
A	new_instance()	0	5	2
A	new_instance_from_db()	0	4	1
A	set_type()	0	4	1
A	set_amount()	0	4	1
A	set_name()	0	4	1
A	set_description()	0	4	1
A	set_is_default()	0	4	1
A	set_deleted()	0	4	1
A	type()	0	4	1
A	amount()	0	4	1
A	name()	0	4	1
A	desc()	0	4	1
A	overrides()	0	4	1
A	order()	0	4	1
A	wp_user()	0	4	1
A	is_default()	0	4	1
A	deleted()	0	4	1
A	parent()	0	4	1
A	is_base_price()	0	5	1
A	type_obj()	0	4	1
A	type_order()	0	4	1
A	is_discount()	0	5	1
A	is_percent()	0	5	1
A	is_surcharge()	0	5	1
A	is_tax()	0	5	1
A	pretty_price()	0	6	2
A	get_price_without_currency_symbol()	0	8	1

<?php

use EventEspresso\core\exceptions\InvalidDataTypeException;
use EventEspresso\core\exceptions\InvalidInterfaceException;

/**
 * EE_Price class
 *
 * @package            Event Espresso
 * @subpackage         includes/classes/EE_Price.class.php
 * @author             Mike Nelson
 */
class EE_Price extends EE_Soft_Delete_Base_Class
{

    /**
     * @param array  $props_n_values          incoming values
     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
     *                                        used.)
     * @param array  $date_formats            incoming date_formats in an array where the first value is the
     *                                        date_format and the second value is the time format
     * @return EE_Price
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws ReflectionException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     */
    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
    {
        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
    }


    /**
     * @param array  $props_n_values  incoming values from the database
     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
     *                                the website will be used.
     * @return EE_Price
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws ReflectionException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     */
    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
    {
        return new self($props_n_values, true, $timezone);
    }


    /**
     * Set Price type ID
     *
     * @param int $PRT_ID
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws ReflectionException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     */
    public function set_type($PRT_ID = 0)
    {
        $this->set('PRT_ID', $PRT_ID);
    }


    /**
     * Set Price Amount
     *
     * @param float $PRC_amount
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws ReflectionException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     */
    public function set_amount($PRC_amount = 0.00)
    {
        $this->set('PRC_amount', $PRC_amount);
    }


    /**
     * Set Price Name
     *
     * @param string $PRC_name
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws ReflectionException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     */
    public function set_name($PRC_name = '')
    {
        $this->set('PRC_name', $PRC_name);
    }


    /**
     * Set Price Description
     *
     * @param string $PRC_desc
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws ReflectionException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     */
    public function set_description($PRC_desc = '')
    {
        $this->Set('PRC_desc', $PRC_desc);
    }


    /**
     * set is_default
     *
     * @param bool $PRC_is_default
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws ReflectionException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     */
    public function set_is_default($PRC_is_default = false)
    {
        $this->set('PRC_is_default', $PRC_is_default);
    }


    /**
     * set deleted
     *
     * @param bool $PRC_deleted
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws ReflectionException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     */
    public function set_deleted($PRC_deleted = null)
    {
        $this->set('PRC_deleted', $PRC_deleted);
    }


    /**
     * get Price type
     *
     * @return        int
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws ReflectionException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     */
    public function type()
    {
        return $this->get('PRT_ID');
    }


    /**
     * get Price Amount
     *
     * @return        float
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws ReflectionException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     */
    public function amount()
    {
        return $this->get('PRC_amount');
    }


    /**
     * get Price Name
     *
     * @return        string
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws ReflectionException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     */
    public function name()
    {
        return $this->get('PRC_name');
    }


    /**
     * get Price description
     *
     * @return        string
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws ReflectionException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     */
    public function desc()
    {
        return $this->get('PRC_desc');
    }


    /**
     * get overrides
     *
     * @return        int
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws ReflectionException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     */
    public function overrides()
    {
        return $this->get('PRC_overrides');
    }


    /**
     * get order
     *
     * @return int
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws ReflectionException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     */
    public function order()
    {
        return $this->get('PRC_order');
    }


    /**
     * get the author of the price
     *
     * @return int
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws ReflectionException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     * @since 4.5.0
     */
    public function wp_user()
    {
        return $this->get('PRC_wp_user');
    }


    /**
     * get is_default
     *
     * @return bool
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws ReflectionException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     */
    public function is_default()
    {
        return $this->get('PRC_is_default');
    }


    /**
     * get deleted
     *
     * @return bool
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws ReflectionException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     */
    public function deleted()
    {
        return $this->get('PRC_deleted');
    }


    /**
     * @return bool
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws ReflectionException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     */
    public function parent()
    {
        return $this->get('PRC_parent');
    }


    // some helper methods for getting info on the price_type for this price


    /**
     * return whether the price is a base price or not
     *
     * @return boolean
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     * @throws ReflectionException
     */
    public function is_base_price()
    {
        $price_type = $this->type_obj();
        return $price_type->is_base_price();
    }


    /**
     * @return EE_Base_Class|EE_Price_Type
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws ReflectionException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     */
    public function type_obj()
    {
        return $this->get_first_related('Price_Type');
    }


    /**
     * @return int
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws ReflectionException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     */
    public function type_order()
    {
        return $this->get_first_related('Price_Type')->order();
    }


    /**
     * Simply indicates whether this price increases or decreases the total
     *
     * @return boolean true = discount, otherwise adds to the total
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws ReflectionException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     */
    public function is_discount()
    {
        $price_type = $this->type_obj();
        return $price_type->is_discount();
    }


    /**
     * whether the price is a percentage or not
     *
     * @return boolean
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     * @throws ReflectionException
     */
    public function is_percent()
    {
        $price_type = $this->type_obj();
        return $price_type->is_percent();
    }


    /**
     * whether the price is a percentage or not
     *
     * @return boolean
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws ReflectionException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     */
    public function is_surcharge()
    {
        $price_type = $this->type_obj();
        return $price_type->is_surcharge();
    }

    /**
     * whether the price is a percentage or not
     *
     * @return boolean
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws ReflectionException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     */
    public function is_tax()
    {
        $price_type = $this->type_obj();
        return $price_type->is_tax();
    }


    /**
     * return pretty price dependant on whether its a dollar or percent.
     *
     * @return string
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws ReflectionException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     * @since 4.4.0
     */
    public function pretty_price()
    {
        return ! $this->is_percent()
            ? $this->get_pretty('PRC_amount')
            : $this->get('PRC_amount') . '%';
    }


    /**
     * @return mixed
     * @throws EE_Error
     * @throws InvalidArgumentException
     * @throws ReflectionException
     * @throws InvalidDataTypeException
     * @throws InvalidInterfaceException
     */
    public function get_price_without_currency_symbol()
    {
        return str_replace(
            EE_Registry::instance()->CFG->currency->sign,
            '',
            $this->get_pretty('PRC_amount')
        );
    }
}