eventespresso / event-espresso-core

core/domain/values/TimeFormat.php

Indentation +27 added lines, -27 removed lines

@@ -4,33 +4,33 @@
 
 class TimeFormat extends BaseFormat
 {
-    protected const DEFAULT_FORMAT = 'H:i:s';
-    protected const WORDPRESS_FORMAT_OPTION_NAME = 'time_format';
+	protected const DEFAULT_FORMAT = 'H:i:s';
+	protected const WORDPRESS_FORMAT_OPTION_NAME = 'time_format';
 
-    protected static array   $allowed_chars  = [
-        'a',
-        'A',
-        'B',
-        'g',
-        'G',
-        'h',
-        'H',
-        'i',
-        's',
-        'u',
-        'v',
-        'e',
-        'I',
-        'O',
-        'P',
-        'T',
-        'Z',
-        ':',
-        '-',
-        ',',
-        '.',
-        ' ',
-    ];
+	protected static array   $allowed_chars  = [
+		'a',
+		'A',
+		'B',
+		'g',
+		'G',
+		'h',
+		'H',
+		'i',
+		's',
+		'u',
+		'v',
+		'e',
+		'I',
+		'O',
+		'P',
+		'T',
+		'Z',
+		':',
+		'-',
+		',',
+		'.',
+		' ',
+	];
 
-    protected static ?string $wordpress_format = null;
+	protected static ?string $wordpress_format = null;
 }

Spacing +1 added lines, -1 removed lines

@@ -7,7 +7,7 @@
     protected const DEFAULT_FORMAT = 'H:i:s';
     protected const WORDPRESS_FORMAT_OPTION_NAME = 'time_format';
 
-    protected static array   $allowed_chars  = [
+    protected static array   $allowed_chars = [
         'a',
         'A',
         'B',

core/domain/values/BaseFormat.php

Indentation +40 added lines, -40 removed lines

@@ -4,44 +4,44 @@
 
 abstract class BaseFormat
 {
-    protected string $format;
-
-    public function __construct(?string $format)
-    {
-        if (static::$wordpress_format === null) {
-            static::$wordpress_format = get_option(static::WORDPRESS_FORMAT_OPTION_NAME, static::DEFAULT_FORMAT);
-        }
-        $this->format = $this->sanitizeDateFormat($format ?: static::$wordpress_format);
-    }
-
-
-    protected function sanitizeDateFormat(string $format): string
-    {
-        $sanitized_format = '';
-        for ($i = 0; $i < strlen($format); $i++) {
-            $char = substr($format, $i, 1);
-            // first check if the previous character was a backslash
-            if (substr($format, $i-1, 1) === '\\') {
-                // escaped characters are allowed
-                $sanitized_format .= "\\$char";
-                continue;
-            }
-            if (in_array($char, static::$allowed_chars)) {
-                $sanitized_format .= $char;
-            }
-        }
-        return $sanitized_format;
-    }
-
-
-    public function format(): string
-    {
-        return $this->format;
-    }
-
-
-    public function __toString(): string
-    {
-        return $this->format();
-    }
+	protected string $format;
+
+	public function __construct(?string $format)
+	{
+		if (static::$wordpress_format === null) {
+			static::$wordpress_format = get_option(static::WORDPRESS_FORMAT_OPTION_NAME, static::DEFAULT_FORMAT);
+		}
+		$this->format = $this->sanitizeDateFormat($format ?: static::$wordpress_format);
+	}
+
+
+	protected function sanitizeDateFormat(string $format): string
+	{
+		$sanitized_format = '';
+		for ($i = 0; $i < strlen($format); $i++) {
+			$char = substr($format, $i, 1);
+			// first check if the previous character was a backslash
+			if (substr($format, $i-1, 1) === '\\') {
+				// escaped characters are allowed
+				$sanitized_format .= "\\$char";
+				continue;
+			}
+			if (in_array($char, static::$allowed_chars)) {
+				$sanitized_format .= $char;
+			}
+		}
+		return $sanitized_format;
+	}
+
+
+	public function format(): string
+	{
+		return $this->format;
+	}
+
+
+	public function __toString(): string
+	{
+		return $this->format();
+	}
 }

core/db_models/EEM_Ticket.model.php

Indentation +486 added lines, -486 removed lines

@@ -13,490 +13,490 @@
  */
 class EEM_Ticket extends EEM_Soft_Delete_Base
 {
-    /**
-     * the following constants define where tickets can be viewed throughout the UI
-     *  TICKET_VISIBILITY_NONE          - will not be displayed anywhere
-     *  TICKET_VISIBILITY_PUBLIC        - basically displayed everywhere
-     *  TICKET_VISIBILITY_MEMBERS_ONLY  - displayed to any logged-in user
-     *  TICKET_VISIBILITY_ADMINS_ONLY   - displayed to any logged-in user that is an admin
-     *  TICKET_VISIBILITY_ADMIN_UI_ONLY - only displayed in the admin, never publicly
-     */
-    public const TICKET_VISIBILITY_NONE_KEY            = 'NONE';
-
-    public const TICKET_VISIBILITY_NONE_VALUE          = 0;
-
-    public const TICKET_VISIBILITY_PUBLIC_KEY          = 'PUBLIC';
-
-    public const TICKET_VISIBILITY_PUBLIC_VALUE        = 100;
-
-    public const TICKET_VISIBILITY_MEMBERS_ONLY_KEY    = 'MEMBERS_ONLY';
-
-    public const TICKET_VISIBILITY_MEMBERS_ONLY_VALUE  = 200;
-
-    public const TICKET_VISIBILITY_ADMINS_ONLY_KEY     = 'ADMINS_ONLY';
-
-    public const TICKET_VISIBILITY_ADMINS_ONLY_VALUE   = 300;
-
-    public const TICKET_VISIBILITY_ADMIN_UI_ONLY_KEY   = 'ADMIN_UI_ONLY';
-
-    public const TICKET_VISIBILITY_ADMIN_UI_ONLY_VALUE = 400;
-
-
-    /**
-     * defines where tickets can be viewed throughout the UI
-     *
-     * @var array
-     */
-    private $ticket_visibility;
-
-    /**
-     * private instance of the EEM_Ticket object
-     *
-     * @var EEM_Ticket $_instance
-     */
-    protected static $_instance;
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param string|null $timezone string representing the timezone we want to set for returned Date Time Strings
-     *                              (and any incoming timezone data that gets saved).
-     *                              Note this just sends the timezone info to the date time model field objects.
-     *                              Default is NULL
-     *                              (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Ticket', 'event_espresso');
-        $this->plural_item   = esc_html__('Tickets', 'event_espresso');
-        $this->_tables       = [
-            'Ticket' => new EE_Primary_Table('esp_ticket', 'TKT_ID'),
-        ];
-        $this->parseTicketVisibilityOptions();
-        $this->_fields          = [
-            'Ticket' => [
-                'TKT_ID'                => new EE_Primary_Key_Int_Field(
-                    'TKT_ID',
-                    esc_html__('Ticket ID', 'event_espresso')
-                ),
-                'TTM_ID'                => new EE_Foreign_Key_Int_Field(
-                    'TTM_ID',
-                    esc_html__('Ticket Template ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Ticket_Template'
-                ),
-                'TKT_name'              => new EE_Plain_Text_Field(
-                    'TKT_name',
-                    esc_html__('Ticket Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'TKT_description'       => new EE_Post_Content_Field(
-                    'TKT_description',
-                    esc_html__('Description of Ticket', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'TKT_start_date'        => new EE_Datetime_Field(
-                    'TKT_start_date',
-                    esc_html__('Start time/date of Ticket', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'TKT_end_date'          => new EE_Datetime_Field(
-                    'TKT_end_date',
-                    esc_html__('End time/date of Ticket', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'TKT_min'               => new EE_Integer_Field(
-                    'TKT_min',
-                    esc_html__('Minimum quantity of this ticket that must be purchased', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'TKT_max'               => new EE_Infinite_Integer_Field(
-                    'TKT_max',
-                    esc_html__(
-                        'Maximum quantity of this ticket that can be purchased in one transaction',
-                        'event_espresso'
-                    ),
-                    false,
-                    EE_INF
-                ),
-                'TKT_price'             => new EE_Money_Field(
-                    'TKT_price',
-                    esc_html__('Final calculated price for ticket', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'TKT_sold'              => new EE_Integer_Field(
-                    'TKT_sold',
-                    esc_html__('Number of this ticket sold', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'TKT_qty'               => new EE_Infinite_Integer_Field(
-                    'TKT_qty',
-                    esc_html__('Quantity of this ticket that is available', 'event_espresso'),
-                    false,
-                    EE_INF
-                ),
-                'TKT_reserved'          => new EE_Integer_Field(
-                    'TKT_reserved',
-                    esc_html__(
-                        'Quantity of this ticket that is reserved, but not yet fully purchased',
-                        'event_espresso'
-                    ),
-                    false,
-                    0
-                ),
-                'TKT_uses'              => new EE_Infinite_Integer_Field(
-                    'TKT_uses',
-                    esc_html__('Number of datetimes this ticket can be used at', 'event_espresso'),
-                    false,
-                    EE_INF
-                ),
-                'TKT_required'          => new EE_Boolean_Field(
-                    'TKT_required',
-                    esc_html__(
-                        'Flag indicating whether this ticket must be purchased with a transaction',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-                'TKT_taxable'           => new EE_Boolean_Field(
-                    'TKT_taxable',
-                    esc_html__(
-                        'Flag indicating whether there is tax applied on this ticket',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-                'TKT_is_default'        => new EE_Boolean_Field(
-                    'TKT_is_default',
-                    esc_html__('Flag indicating that this ticket is a default ticket', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'TKT_order'             => new EE_Integer_Field(
-                    'TKT_order',
-                    esc_html__(
-                        'The order in which the Ticket is displayed in the editor (used for autosaves when the form doesn\'t have the ticket ID yet)',
-                        'event_espresso'
-                    ),
-                    false,
-                    0
-                ),
-                'TKT_row'               => new EE_Integer_Field(
-                    'TKT_row',
-                    esc_html__('How tickets are displayed in the ui', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'TKT_deleted'           => new EE_Trashed_Flag_Field(
-                    'TKT_deleted',
-                    esc_html__('Flag indicating if this has been archived or not', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'TKT_wp_user'           => new EE_WP_User_Field(
-                    'TKT_wp_user',
-                    esc_html__('Ticket Creator ID', 'event_espresso'),
-                    false
-                ),
-                'TKT_parent'            => new EE_Integer_Field(
-                    'TKT_parent',
-                    esc_html__(
-                        'Indicates what TKT_ID is the parent of this TKT_ID (used in autosaves/revisions)',
-                        'event_espresso'
-                    ),
-                    true,
-                    0
-                ),
-                'TKT_reverse_calculate' => new EE_Boolean_Field(
-                    'TKT_reverse_calculate',
-                    esc_html__(
-                        'Flag indicating whether ticket calculations should run in reverse and calculate the base ticket price from the provided ticket total.',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-                'TKT_visibility'        => new EE_Enum_Integer_Field(
-                    'TKT_visibility',
-                    esc_html__('Defines where the ticket can be viewed throughout the UI.', 'event_espresso'),
-                    false,
-                    EEM_Ticket::TICKET_VISIBILITY_PUBLIC_VALUE,
-                    $this->getTicketVisibilityEnumOptions()
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Datetime'        => new EE_HABTM_Relation('Datetime_Ticket'),
-            'Datetime_Ticket' => new EE_Has_Many_Relation(),
-            'Price'           => new EE_HABTM_Relation('Ticket_Price'),
-            'Ticket_Template' => new EE_Belongs_To_Relation(),
-            'Registration'    => new EE_Has_Many_Relation(),
-            'WP_User'         => new EE_Belongs_To_Relation(),
-        ];
-        // this model is generally available for reading
-        $path_to_event                                            = 'Datetime.Event';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public(
-            'TKT_is_default',
-            $path_to_event
-        );
-
-        // account for default tickets in the caps
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ]
-                                                                    = new EE_Restriction_Generator_Default_Protected(
-            'TKT_is_default',
-            $path_to_event
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]   = new EE_Restriction_Generator_Default_Protected(
-            'TKT_is_default',
-            $path_to_event
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected(
-            'TKT_is_default',
-            $path_to_event
-        );
-        $this->model_chain_to_password                              = $path_to_event;
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * This returns all tickets that are defaults from the db
-     *
-     * @return EE_Ticket[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_default_tickets(): array
-    {
-        $tickets = $this->get_all(
-            [
-                [
-                    'TKT_is_default' => 1,
-                    'TKT_visibility' => ['>', EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE],
-                ],
-                'order_by' => ['TKT_ID' => 'ASC'],
-            ]
-        );
-        // we need to set the start date and end date to today's date and the start of the default dtt
-        return $this->_set_default_dates($tickets);
-    }
-
-
-    /**
-     * sets up relevant start and end date for EE_Ticket (s)
-     *
-     * @param EE_Ticket[] $tickets
-     * @return EE_Ticket[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _set_default_dates(array $tickets): array
-    {
-        foreach ($tickets as $ticket) {
-            $ticket->set(
-                'TKT_start_date',
-                (int) $this->current_time_for_query('TKT_start_date', true)
-            );
-            $ticket->set(
-                'TKT_end_date',
-                (int) $this->current_time_for_query('TKT_end_date', true) + MONTH_IN_SECONDS
-            );
-            $ticket->set_end_time(
-                $this->convert_datetime_for_query(
-                    'TKT_end_date',
-                    '11:59 pm',
-                    'g:i a',
-                    $this->_timezone
-                )
-            );
-        }
-        return $tickets;
-    }
-
-
-    /**
-     * Gets the total number of tickets available at a particular datetime (does
-     * NOT take int account the datetime's spaces available)
-     *
-     * @param int   $DTT_ID
-     * @param array $query_params
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function sum_tickets_currently_available_at_datetime(int $DTT_ID, array $query_params = []): int
-    {
-        $query_params += [['TKT_visibility' => ['>', EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE]]];
-        return EEM_Datetime::instance()->sum_tickets_currently_available_at_datetime($DTT_ID, $query_params);
-    }
-
-
-    /**
-     * Updates the TKT_sold quantity on all the tickets matching $query_params
-     *
-     * @param EE_Ticket[] $tickets
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function update_tickets_sold(array $tickets)
-    {
-        foreach ($tickets as $ticket) {
-            $ticket->update_tickets_sold();
-        }
-    }
-
-
-    /**
-     * returns an array of EE_Ticket objects with a non-zero value for TKT_reserved
-     *
-     * @return EE_Base_Class[]|EE_Ticket[]|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_tickets_with_reservations(): ?array
-    {
-        return $this->get_all(
-            [
-                [
-                    'TKT_reserved'   => ['>', 0],
-                    'TKT_visibility' => ['>', EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE],
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * returns an array of EE_Ticket objects matching the supplied list of IDs
-     *
-     * @param array $ticket_IDs
-     * @return EE_Base_Class[]|EE_Ticket[]|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_tickets_with_IDs(array $ticket_IDs): ?array
-    {
-        return $this->get_all(
-            [
-                [
-                    'TKT_ID' => ['IN', $ticket_IDs],
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * @return void
-     */
-    private function parseTicketVisibilityOptions()
-    {
-        $this->ticket_visibility = (array) apply_filters(
-            'FHEE__EEM_Ticket__construct__ticket_visibility',
-            [
-                EEM_Ticket::TICKET_VISIBILITY_PUBLIC_KEY        => [
-                    'desc'  => esc_html__('ticket displayed to everyone everywhere', 'event_espresso'),
-                    'label' => esc_html__('Public', 'event_espresso'),
-                    'value' => EEM_Ticket::TICKET_VISIBILITY_PUBLIC_VALUE,
-                ],
-                EEM_Ticket::TICKET_VISIBILITY_MEMBERS_ONLY_KEY  => [
-                    'desc'  => esc_html__('ticket only displayed to logged-in users', 'event_espresso'),
-                    'label' => esc_html__('Members only', 'event_espresso'),
-                    'value' => EEM_Ticket::TICKET_VISIBILITY_MEMBERS_ONLY_VALUE,
-                ],
-                EEM_Ticket::TICKET_VISIBILITY_ADMINS_ONLY_KEY   => [
-                    'desc'  => esc_html__('ticket only displayed to logged-in admins', 'event_espresso'),
-                    'label' => esc_html__('Admins only', 'event_espresso'),
-                    'value' => EEM_Ticket::TICKET_VISIBILITY_ADMINS_ONLY_VALUE,
-                ],
-                EEM_Ticket::TICKET_VISIBILITY_ADMIN_UI_ONLY_KEY => [
-                    'desc'  => esc_html__(
-                        'ticket only displayed in the admin UI and not on the frontend',
-                        'event_espresso'
-                    ),
-                    'label' => esc_html__('Admin UI only', 'event_espresso'),
-                    'value' => EEM_Ticket::TICKET_VISIBILITY_ADMIN_UI_ONLY_VALUE,
-                ],
-                EEM_Ticket::TICKET_VISIBILITY_NONE_KEY          => [
-                    'desc'  => esc_html__('will hide the ticket everywhere', 'event_espresso'),
-                    'label' => esc_html__('None', 'event_espresso'),
-                    'value' => EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getTicketVisibilityEnumOptions(): array
-    {
-        $ticket_visibility = [];
-        foreach ($this->ticket_visibility as $visibility) {
-            if (isset($visibility['value'], $visibility['label'])) {
-                $ticket_visibility[ $visibility['value'] ] = $visibility['label'];
-            }
-        }
-        return $ticket_visibility;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getTicketVisibilityValues(): array
-    {
-        // copy ticket_visibility array
-        $ticket_visibility_options = $this->ticket_visibility;
-        foreach ($ticket_visibility_options as $ticket_visibility_option) {
-            // remove labels because we only want the values
-            unset($ticket_visibility_option['label']);
-        }
-        return $ticket_visibility_options;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getTicketVisibilityLabels(): array
-    {
-        $ticket_visibility_options = [];
-        foreach ($this->ticket_visibility as $key => $ticket_visibility_option) {
-            if (isset($ticket_visibility_option['label'])) {
-                // change because we only want the labels tied to the keys
-                $ticket_visibility_options[] = [
-                    'value' => $key,
-                    'label' => $ticket_visibility_option['label'],
-                ];
-            }
-        }
-        return $ticket_visibility_options;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function ticketVisibilityOptions(): array
-    {
-        return $this->ticket_visibility;
-    }
+	/**
+	 * the following constants define where tickets can be viewed throughout the UI
+	 *  TICKET_VISIBILITY_NONE          - will not be displayed anywhere
+	 *  TICKET_VISIBILITY_PUBLIC        - basically displayed everywhere
+	 *  TICKET_VISIBILITY_MEMBERS_ONLY  - displayed to any logged-in user
+	 *  TICKET_VISIBILITY_ADMINS_ONLY   - displayed to any logged-in user that is an admin
+	 *  TICKET_VISIBILITY_ADMIN_UI_ONLY - only displayed in the admin, never publicly
+	 */
+	public const TICKET_VISIBILITY_NONE_KEY            = 'NONE';
+
+	public const TICKET_VISIBILITY_NONE_VALUE          = 0;
+
+	public const TICKET_VISIBILITY_PUBLIC_KEY          = 'PUBLIC';
+
+	public const TICKET_VISIBILITY_PUBLIC_VALUE        = 100;
+
+	public const TICKET_VISIBILITY_MEMBERS_ONLY_KEY    = 'MEMBERS_ONLY';
+
+	public const TICKET_VISIBILITY_MEMBERS_ONLY_VALUE  = 200;
+
+	public const TICKET_VISIBILITY_ADMINS_ONLY_KEY     = 'ADMINS_ONLY';
+
+	public const TICKET_VISIBILITY_ADMINS_ONLY_VALUE   = 300;
+
+	public const TICKET_VISIBILITY_ADMIN_UI_ONLY_KEY   = 'ADMIN_UI_ONLY';
+
+	public const TICKET_VISIBILITY_ADMIN_UI_ONLY_VALUE = 400;
+
+
+	/**
+	 * defines where tickets can be viewed throughout the UI
+	 *
+	 * @var array
+	 */
+	private $ticket_visibility;
+
+	/**
+	 * private instance of the EEM_Ticket object
+	 *
+	 * @var EEM_Ticket $_instance
+	 */
+	protected static $_instance;
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param string|null $timezone string representing the timezone we want to set for returned Date Time Strings
+	 *                              (and any incoming timezone data that gets saved).
+	 *                              Note this just sends the timezone info to the date time model field objects.
+	 *                              Default is NULL
+	 *                              (and will be assumed using the set timezone in the 'timezone_string' wp option)
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Ticket', 'event_espresso');
+		$this->plural_item   = esc_html__('Tickets', 'event_espresso');
+		$this->_tables       = [
+			'Ticket' => new EE_Primary_Table('esp_ticket', 'TKT_ID'),
+		];
+		$this->parseTicketVisibilityOptions();
+		$this->_fields          = [
+			'Ticket' => [
+				'TKT_ID'                => new EE_Primary_Key_Int_Field(
+					'TKT_ID',
+					esc_html__('Ticket ID', 'event_espresso')
+				),
+				'TTM_ID'                => new EE_Foreign_Key_Int_Field(
+					'TTM_ID',
+					esc_html__('Ticket Template ID', 'event_espresso'),
+					false,
+					0,
+					'Ticket_Template'
+				),
+				'TKT_name'              => new EE_Plain_Text_Field(
+					'TKT_name',
+					esc_html__('Ticket Name', 'event_espresso'),
+					false,
+					''
+				),
+				'TKT_description'       => new EE_Post_Content_Field(
+					'TKT_description',
+					esc_html__('Description of Ticket', 'event_espresso'),
+					false,
+					''
+				),
+				'TKT_start_date'        => new EE_Datetime_Field(
+					'TKT_start_date',
+					esc_html__('Start time/date of Ticket', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'TKT_end_date'          => new EE_Datetime_Field(
+					'TKT_end_date',
+					esc_html__('End time/date of Ticket', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'TKT_min'               => new EE_Integer_Field(
+					'TKT_min',
+					esc_html__('Minimum quantity of this ticket that must be purchased', 'event_espresso'),
+					false,
+					0
+				),
+				'TKT_max'               => new EE_Infinite_Integer_Field(
+					'TKT_max',
+					esc_html__(
+						'Maximum quantity of this ticket that can be purchased in one transaction',
+						'event_espresso'
+					),
+					false,
+					EE_INF
+				),
+				'TKT_price'             => new EE_Money_Field(
+					'TKT_price',
+					esc_html__('Final calculated price for ticket', 'event_espresso'),
+					false,
+					0
+				),
+				'TKT_sold'              => new EE_Integer_Field(
+					'TKT_sold',
+					esc_html__('Number of this ticket sold', 'event_espresso'),
+					false,
+					0
+				),
+				'TKT_qty'               => new EE_Infinite_Integer_Field(
+					'TKT_qty',
+					esc_html__('Quantity of this ticket that is available', 'event_espresso'),
+					false,
+					EE_INF
+				),
+				'TKT_reserved'          => new EE_Integer_Field(
+					'TKT_reserved',
+					esc_html__(
+						'Quantity of this ticket that is reserved, but not yet fully purchased',
+						'event_espresso'
+					),
+					false,
+					0
+				),
+				'TKT_uses'              => new EE_Infinite_Integer_Field(
+					'TKT_uses',
+					esc_html__('Number of datetimes this ticket can be used at', 'event_espresso'),
+					false,
+					EE_INF
+				),
+				'TKT_required'          => new EE_Boolean_Field(
+					'TKT_required',
+					esc_html__(
+						'Flag indicating whether this ticket must be purchased with a transaction',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+				'TKT_taxable'           => new EE_Boolean_Field(
+					'TKT_taxable',
+					esc_html__(
+						'Flag indicating whether there is tax applied on this ticket',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+				'TKT_is_default'        => new EE_Boolean_Field(
+					'TKT_is_default',
+					esc_html__('Flag indicating that this ticket is a default ticket', 'event_espresso'),
+					false,
+					false
+				),
+				'TKT_order'             => new EE_Integer_Field(
+					'TKT_order',
+					esc_html__(
+						'The order in which the Ticket is displayed in the editor (used for autosaves when the form doesn\'t have the ticket ID yet)',
+						'event_espresso'
+					),
+					false,
+					0
+				),
+				'TKT_row'               => new EE_Integer_Field(
+					'TKT_row',
+					esc_html__('How tickets are displayed in the ui', 'event_espresso'),
+					false,
+					0
+				),
+				'TKT_deleted'           => new EE_Trashed_Flag_Field(
+					'TKT_deleted',
+					esc_html__('Flag indicating if this has been archived or not', 'event_espresso'),
+					false,
+					false
+				),
+				'TKT_wp_user'           => new EE_WP_User_Field(
+					'TKT_wp_user',
+					esc_html__('Ticket Creator ID', 'event_espresso'),
+					false
+				),
+				'TKT_parent'            => new EE_Integer_Field(
+					'TKT_parent',
+					esc_html__(
+						'Indicates what TKT_ID is the parent of this TKT_ID (used in autosaves/revisions)',
+						'event_espresso'
+					),
+					true,
+					0
+				),
+				'TKT_reverse_calculate' => new EE_Boolean_Field(
+					'TKT_reverse_calculate',
+					esc_html__(
+						'Flag indicating whether ticket calculations should run in reverse and calculate the base ticket price from the provided ticket total.',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+				'TKT_visibility'        => new EE_Enum_Integer_Field(
+					'TKT_visibility',
+					esc_html__('Defines where the ticket can be viewed throughout the UI.', 'event_espresso'),
+					false,
+					EEM_Ticket::TICKET_VISIBILITY_PUBLIC_VALUE,
+					$this->getTicketVisibilityEnumOptions()
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Datetime'        => new EE_HABTM_Relation('Datetime_Ticket'),
+			'Datetime_Ticket' => new EE_Has_Many_Relation(),
+			'Price'           => new EE_HABTM_Relation('Ticket_Price'),
+			'Ticket_Template' => new EE_Belongs_To_Relation(),
+			'Registration'    => new EE_Has_Many_Relation(),
+			'WP_User'         => new EE_Belongs_To_Relation(),
+		];
+		// this model is generally available for reading
+		$path_to_event                                            = 'Datetime.Event';
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public(
+			'TKT_is_default',
+			$path_to_event
+		);
+
+		// account for default tickets in the caps
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ]
+																	= new EE_Restriction_Generator_Default_Protected(
+			'TKT_is_default',
+			$path_to_event
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]   = new EE_Restriction_Generator_Default_Protected(
+			'TKT_is_default',
+			$path_to_event
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected(
+			'TKT_is_default',
+			$path_to_event
+		);
+		$this->model_chain_to_password                              = $path_to_event;
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * This returns all tickets that are defaults from the db
+	 *
+	 * @return EE_Ticket[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_default_tickets(): array
+	{
+		$tickets = $this->get_all(
+			[
+				[
+					'TKT_is_default' => 1,
+					'TKT_visibility' => ['>', EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE],
+				],
+				'order_by' => ['TKT_ID' => 'ASC'],
+			]
+		);
+		// we need to set the start date and end date to today's date and the start of the default dtt
+		return $this->_set_default_dates($tickets);
+	}
+
+
+	/**
+	 * sets up relevant start and end date for EE_Ticket (s)
+	 *
+	 * @param EE_Ticket[] $tickets
+	 * @return EE_Ticket[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _set_default_dates(array $tickets): array
+	{
+		foreach ($tickets as $ticket) {
+			$ticket->set(
+				'TKT_start_date',
+				(int) $this->current_time_for_query('TKT_start_date', true)
+			);
+			$ticket->set(
+				'TKT_end_date',
+				(int) $this->current_time_for_query('TKT_end_date', true) + MONTH_IN_SECONDS
+			);
+			$ticket->set_end_time(
+				$this->convert_datetime_for_query(
+					'TKT_end_date',
+					'11:59 pm',
+					'g:i a',
+					$this->_timezone
+				)
+			);
+		}
+		return $tickets;
+	}
+
+
+	/**
+	 * Gets the total number of tickets available at a particular datetime (does
+	 * NOT take int account the datetime's spaces available)
+	 *
+	 * @param int   $DTT_ID
+	 * @param array $query_params
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function sum_tickets_currently_available_at_datetime(int $DTT_ID, array $query_params = []): int
+	{
+		$query_params += [['TKT_visibility' => ['>', EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE]]];
+		return EEM_Datetime::instance()->sum_tickets_currently_available_at_datetime($DTT_ID, $query_params);
+	}
+
+
+	/**
+	 * Updates the TKT_sold quantity on all the tickets matching $query_params
+	 *
+	 * @param EE_Ticket[] $tickets
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function update_tickets_sold(array $tickets)
+	{
+		foreach ($tickets as $ticket) {
+			$ticket->update_tickets_sold();
+		}
+	}
+
+
+	/**
+	 * returns an array of EE_Ticket objects with a non-zero value for TKT_reserved
+	 *
+	 * @return EE_Base_Class[]|EE_Ticket[]|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_tickets_with_reservations(): ?array
+	{
+		return $this->get_all(
+			[
+				[
+					'TKT_reserved'   => ['>', 0],
+					'TKT_visibility' => ['>', EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE],
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * returns an array of EE_Ticket objects matching the supplied list of IDs
+	 *
+	 * @param array $ticket_IDs
+	 * @return EE_Base_Class[]|EE_Ticket[]|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_tickets_with_IDs(array $ticket_IDs): ?array
+	{
+		return $this->get_all(
+			[
+				[
+					'TKT_ID' => ['IN', $ticket_IDs],
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function parseTicketVisibilityOptions()
+	{
+		$this->ticket_visibility = (array) apply_filters(
+			'FHEE__EEM_Ticket__construct__ticket_visibility',
+			[
+				EEM_Ticket::TICKET_VISIBILITY_PUBLIC_KEY        => [
+					'desc'  => esc_html__('ticket displayed to everyone everywhere', 'event_espresso'),
+					'label' => esc_html__('Public', 'event_espresso'),
+					'value' => EEM_Ticket::TICKET_VISIBILITY_PUBLIC_VALUE,
+				],
+				EEM_Ticket::TICKET_VISIBILITY_MEMBERS_ONLY_KEY  => [
+					'desc'  => esc_html__('ticket only displayed to logged-in users', 'event_espresso'),
+					'label' => esc_html__('Members only', 'event_espresso'),
+					'value' => EEM_Ticket::TICKET_VISIBILITY_MEMBERS_ONLY_VALUE,
+				],
+				EEM_Ticket::TICKET_VISIBILITY_ADMINS_ONLY_KEY   => [
+					'desc'  => esc_html__('ticket only displayed to logged-in admins', 'event_espresso'),
+					'label' => esc_html__('Admins only', 'event_espresso'),
+					'value' => EEM_Ticket::TICKET_VISIBILITY_ADMINS_ONLY_VALUE,
+				],
+				EEM_Ticket::TICKET_VISIBILITY_ADMIN_UI_ONLY_KEY => [
+					'desc'  => esc_html__(
+						'ticket only displayed in the admin UI and not on the frontend',
+						'event_espresso'
+					),
+					'label' => esc_html__('Admin UI only', 'event_espresso'),
+					'value' => EEM_Ticket::TICKET_VISIBILITY_ADMIN_UI_ONLY_VALUE,
+				],
+				EEM_Ticket::TICKET_VISIBILITY_NONE_KEY          => [
+					'desc'  => esc_html__('will hide the ticket everywhere', 'event_espresso'),
+					'label' => esc_html__('None', 'event_espresso'),
+					'value' => EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getTicketVisibilityEnumOptions(): array
+	{
+		$ticket_visibility = [];
+		foreach ($this->ticket_visibility as $visibility) {
+			if (isset($visibility['value'], $visibility['label'])) {
+				$ticket_visibility[ $visibility['value'] ] = $visibility['label'];
+			}
+		}
+		return $ticket_visibility;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getTicketVisibilityValues(): array
+	{
+		// copy ticket_visibility array
+		$ticket_visibility_options = $this->ticket_visibility;
+		foreach ($ticket_visibility_options as $ticket_visibility_option) {
+			// remove labels because we only want the values
+			unset($ticket_visibility_option['label']);
+		}
+		return $ticket_visibility_options;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getTicketVisibilityLabels(): array
+	{
+		$ticket_visibility_options = [];
+		foreach ($this->ticket_visibility as $key => $ticket_visibility_option) {
+			if (isset($ticket_visibility_option['label'])) {
+				// change because we only want the labels tied to the keys
+				$ticket_visibility_options[] = [
+					'value' => $key,
+					'label' => $ticket_visibility_option['label'],
+				];
+			}
+		}
+		return $ticket_visibility_options;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function ticketVisibilityOptions(): array
+	{
+		return $this->ticket_visibility;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -76,7 +76,7 @@ 
             'Ticket' => new EE_Primary_Table('esp_ticket', 'TKT_ID'),
         ];
         $this->parseTicketVisibilityOptions();
-        $this->_fields          = [
+        $this->_fields = [
             'Ticket' => [
                 'TKT_ID'                => new EE_Primary_Key_Int_Field(
                     'TKT_ID',
@@ -250,26 +250,26 @@ 
         ];
         // this model is generally available for reading
         $path_to_event                                            = 'Datetime.Event';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public(
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Default_Public(
             'TKT_is_default',
             $path_to_event
         );
 
         // account for default tickets in the caps
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ]
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin]
                                                                     = new EE_Restriction_Generator_Default_Protected(
             'TKT_is_default',
             $path_to_event
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]   = new EE_Restriction_Generator_Default_Protected(
+        $this->_cap_restriction_generators[EEM_Base::caps_edit] = new EE_Restriction_Generator_Default_Protected(
             'TKT_is_default',
             $path_to_event
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected(
+        $this->_cap_restriction_generators[EEM_Base::caps_delete] = new EE_Restriction_Generator_Default_Protected(
             'TKT_is_default',
             $path_to_event
         );
-        $this->model_chain_to_password                              = $path_to_event;
+        $this->model_chain_to_password = $path_to_event;
         parent::__construct($timezone);
     }
 
@@ -451,7 +451,7 @@ 
         $ticket_visibility = [];
         foreach ($this->ticket_visibility as $visibility) {
             if (isset($visibility['value'], $visibility['label'])) {
-                $ticket_visibility[ $visibility['value'] ] = $visibility['label'];
+                $ticket_visibility[$visibility['value']] = $visibility['label'];
             }
         }
         return $ticket_visibility;

core/db_models/EEM_Ticket_Template.model.php

Indentation +64 added lines, -64 removed lines

@@ -10,71 +10,71 @@
  */
 class EEM_Ticket_Template extends EEM_Base
 {
-    // private instance of the EEM_Ticket_Template object
-    protected static $_instance = null;
+	// private instance of the EEM_Ticket_Template object
+	protected static $_instance = null;
 
 
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param string|null $timezone string representing the timezone we want to set for returned Date Time Strings (and
-     *                              any incoming timezone data that gets saved).  Note this just sends the timezone
-     *                              info to the date time model field objects.  Default is NULL (and will be assumed
-     *                              using the set timezone in the 'timezone_string' wp option)
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Ticket Template', 'event_espresso');
-        $this->plural_item   = esc_html__('Ticket Templates', 'event_espresso');
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param string|null $timezone string representing the timezone we want to set for returned Date Time Strings (and
+	 *                              any incoming timezone data that gets saved).  Note this just sends the timezone
+	 *                              info to the date time model field objects.  Default is NULL (and will be assumed
+	 *                              using the set timezone in the 'timezone_string' wp option)
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Ticket Template', 'event_espresso');
+		$this->plural_item   = esc_html__('Ticket Templates', 'event_espresso');
 
-        $this->_tables                                            = [
-            'Ticket_Template' => new EE_Primary_Table('esp_ticket_template', 'TTM_ID'),
-        ];
-        $this->_fields                                            = [
-            'Ticket_Template' => [
-                'TTM_ID'          => new EE_Primary_Key_Int_Field(
-                    'TTM_ID', esc_html__('Ticket Template ID', 'event_espresso')
-                ),
-                'TTM_name'        => new EE_Plain_Text_Field(
-                    'TTM_name',
-                    esc_html__('The name of the ticket template', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'TTM_description' => new EE_Plain_Text_Field(
-                    'TTM_description',
-                    esc_html__(
-                        'The description for the ticket template',
-                        'event_espresso'
-                    ),
-                    true,
-                    ''
-                ),
-                'TTM_file'        => new EE_Plain_Text_Field(
-                    'TTM_file',
-                    esc_html__(
-                        'The file name for the actual template file saved on disk',
-                        'event_espresso'
-                    ),
-                    true,
-                    ''
-                ),
-            ],
-        ];
-        $this->_model_relations                                   = [
-            'Ticket' => new EE_Has_Many_Relation(),
-        ];
-        $this->_model_chain_to_wp_user                            = 'Ticket';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] =
-            new EE_Restriction_Generator_Default_Public('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        // account for default tickets in the caps
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
-            new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
-            new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
-            new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        parent::__construct($timezone);
-    }
+		$this->_tables                                            = [
+			'Ticket_Template' => new EE_Primary_Table('esp_ticket_template', 'TTM_ID'),
+		];
+		$this->_fields                                            = [
+			'Ticket_Template' => [
+				'TTM_ID'          => new EE_Primary_Key_Int_Field(
+					'TTM_ID', esc_html__('Ticket Template ID', 'event_espresso')
+				),
+				'TTM_name'        => new EE_Plain_Text_Field(
+					'TTM_name',
+					esc_html__('The name of the ticket template', 'event_espresso'),
+					false,
+					''
+				),
+				'TTM_description' => new EE_Plain_Text_Field(
+					'TTM_description',
+					esc_html__(
+						'The description for the ticket template',
+						'event_espresso'
+					),
+					true,
+					''
+				),
+				'TTM_file'        => new EE_Plain_Text_Field(
+					'TTM_file',
+					esc_html__(
+						'The file name for the actual template file saved on disk',
+						'event_espresso'
+					),
+					true,
+					''
+				),
+			],
+		];
+		$this->_model_relations                                   = [
+			'Ticket' => new EE_Has_Many_Relation(),
+		];
+		$this->_model_chain_to_wp_user                            = 'Ticket';
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] =
+			new EE_Restriction_Generator_Default_Public('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+		// account for default tickets in the caps
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+			new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+			new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+			new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+		parent::__construct($timezone);
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -66,14 +66,14 @@
             'Ticket' => new EE_Has_Many_Relation(),
         ];
         $this->_model_chain_to_wp_user                            = 'Ticket';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] =
+        $this->_cap_restriction_generators[EEM_Base::caps_read] =
             new EE_Restriction_Generator_Default_Public('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
         // account for default tickets in the caps
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] =
             new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+        $this->_cap_restriction_generators[EEM_Base::caps_edit]       =
             new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+        $this->_cap_restriction_generators[EEM_Base::caps_delete]     =
             new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
         parent::__construct($timezone);
     }

core/db_models/EEM_Soft_Delete_Base.model.php

Indentation +367 added lines, -367 removed lines

@@ -28,371 +28,371 @@
  */
 abstract class EEM_Soft_Delete_Base extends EEM_Base
 {
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
-            $this->_default_where_conditions_strategy = new EE_Soft_Delete_Where_Conditions();
-        }
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * Searches for field on this model of type 'deleted_flag'. if it is found, returns it's name.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function deleted_field_name()
-    {
-        $field = $this->get_a_field_of_type('EE_Trashed_Flag_Field');
-        if ($field) {
-            return $field->get_name();
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'We are trying to find the deleted flag field on %s, but none was found. Are you sure there is a field of type EE_Trashed_Flag_Field in %s constructor?',
-                        'event_espresso'
-                    ),
-                    get_class($this),
-                    get_class($this)
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Gets one item that's been deleted, according to $query_params
-     *
-     * @param array $query_params
-     * @return EE_Soft_Delete_Base_Class
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function get_one_deleted($query_params = [])
-    {
-        $query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
-        return $this->get_one($query_params);
-    }
-
-
-    /**
-     * Gets one item from the DB, regardless of whether it's been soft-deleted or not
-     *
-     * @param array $query_params like EEM_base::get_all's $query_params
-     * @return EE_Soft_Delete_Base_Class
-     * @throws EE_Error
-     */
-    public function get_one_deleted_or_undeleted($query_params = [])
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return $this->get_one($query_params);
-    }
-
-
-    /**
-     * Gets the item indicated by its ID. But if it's soft-deleted, pretends it doesn't exist.
-     *
-     * @param int|string $id
-     * @return EE_Soft_Delete_Base_Class
-     * @throws EE_Error
-     */
-    public function get_one_by_ID_but_ignore_deleted($id)
-    {
-        return $this->get_one(
-            $this->alter_query_params_to_restrict_by_ID(
-                $id,
-                ['default_where_conditions' => 'default']
-            )
-        );
-    }
-
-
-    /**
-     * Counts all the deleted/trashed items
-     *
-     * @param array  $query_params
-     * @param string $field_to_count
-     * @param bool   $distinct     if we want to only count the distinct values for the column then you can trigger
-     *                             that by the setting $distinct to TRUE;
-     * @return int
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function count_deleted($query_params = [], $field_to_count = null, $distinct = false)
-    {
-        $query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
-        return $this->count($query_params, $field_to_count, $distinct);
-    }
-
-
-    /**
-     * Alters the query params so that only trashed/soft-deleted items are considered
-     *
-     * @param array $query_params
-     * @return array
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    protected function _alter_query_params_so_only_trashed_items_included($query_params)
-    {
-        $deletedFlagFieldName                     = $this->deleted_field_name();
-        $query_params[0][ $deletedFlagFieldName ] = true;
-        return $query_params;
-    }
-
-
-    /**
-     * Alters the query params so that only trashed/soft-deleted items are considered
-     *
-     * @param array $query_params
-     * @return array
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function alter_query_params_so_only_trashed_items_included($query_params)
-    {
-        return $this->_alter_query_params_so_only_trashed_items_included($query_params);
-    }
-
-
-    /**
-     * Alters the query params so each item's deleted status is ignored.
-     *
-     * @param array $query_params
-     * @return array
-     */
-    public function alter_query_params_so_deleted_and_undeleted_items_included($query_params = [])
-    {
-        return $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-    }
-
-
-    /**
-     * Alters the query params so each item's deleted status is ignored.
-     *
-     * @param array $query_params
-     * @return array
-     */
-    protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params)
-    {
-        if (! isset($query_params['default_where_conditions'])) {
-            $query_params['default_where_conditions'] = 'minimum';
-        }
-        return $query_params;
-    }
-
-
-    /**
-     * Counts all deleted and undeleted items
-     *
-     * @param array  $query_params
-     * @param string $field_to_count
-     * @param bool   $distinct     if we want to only count the distinct values for the column then you can trigger
-     *                             that by the setting $distinct to TRUE;
-     * @return int
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function count_deleted_and_undeleted($query_params = [], $field_to_count = null, $distinct = false)
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return $this->count($query_params, $field_to_count, $distinct);
-    }
-
-
-    /**
-     * Sum all the deleted items.
-     *
-     * @param array  $query_params
-     * @param string $field_to_sum
-     * @return float
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function sum_deleted($query_params = [], $field_to_sum = null)
-    {
-        $query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
-        return $this->sum($query_params, $field_to_sum);
-    }
-
-
-    /**
-     * Sums all the deleted and undeleted items.
-     *
-     * @param array  $query_params
-     * @param string $field_to_sum
-     * @return float
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function sum_deleted_and_undeleted($query_params = [], $field_to_sum = null)
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return $this->sum($query_params, $field_to_sum);
-    }
-
-
-    /**
-     * Gets all deleted and undeleted mode objects from the db that meet the criteria, regardless of
-     * whether they've been soft-deleted or not
-     *
-     * @param array $query_params
-     * @return EE_Soft_Delete_Base_Class[]
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function get_all_deleted_and_undeleted($query_params = [])
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return $this->get_all($query_params);
-    }
-
-
-    /**
-     * For 'soft deletable' models, gets all which ARE deleted, according to conditions specified in $query_params.
-     *
-     * @param array $query_params
-     * @return EE_Soft_Delete_Base_Class[]
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function get_all_deleted($query_params = [])
-    {
-        $query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
-        return $this->get_all($query_params);
-    }
-
-
-    /**
-     * Permanently deletes the selected rows. When selecting rows for deletion, ignores
-     * whether they've been soft-deleted or not. (ie, you don't have to soft-delete objects
-     * before you can permanently delete them).
-     * Because this will cause a real deletion, related models may block this deletion (ie, add an error
-     * and abort the delete)
-     *
-     * @param array   $query_params
-     * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
-     *                                that blocks it (ie, there' sno other data that depends on this data);
-     *                                if false, deletes regardless of other objects which may depend on it.
-     *                                Its generally advisable to always leave this as TRUE,
-     *                                otherwise you could easily corrupt your DB
-     * @return int                    number of rows deleted
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function delete_permanently($query_params, $allow_blocking = true)
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return parent::delete_permanently($query_params, $allow_blocking);
-    }
-
-
-    /**
-     * Restores a particular item by its ID (primary key). Ignores the fact whether the item
-     * has been soft-deleted or not.
-     *
-     * @param mixed $ID int if primary key is an int, string otherwise
-     * @return boolean success
-     * @throws EE_Error
-     */
-    public function restore_by_ID($ID = false)
-    {
-        return $this->delete_or_restore_by_ID(false, $ID);
-    }
-
-
-    /**
-     * For deleting or restoring a particular item. Note that this model is a SOFT-DELETABLE model! However,
-     * this function will ignore whether the items have been soft-deleted or not.
-     *
-     * @param boolean $delete true for delete, false for restore
-     * @param mixed   $ID     int if primary key is an int, string otherwise
-     * @return bool
-     * @throws EE_Error
-     */
-    public function delete_or_restore_by_ID($delete = true, $ID = false)
-    {
-        // returns false if entity doesn't have an ID or if delete/restore action failed
-        return $ID && $this->delete_or_restore($delete, $this->alter_query_params_to_restrict_by_ID($ID));
-    }
-
-
-    /**
-     * Overrides parent's 'delete' method to instead do a soft delete on all rows that
-     * meet the criteria in $where_col_n_values. This particular function ignores whether the items have been
-     * soft-deleted or not. Note: because this item will be soft-deleted only, doesn't block because of model
-     * dependencies
-     *
-     * @param array $query_params
-     * @param bool  $block_deletes
-     * @return bool
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function delete($query_params = [], $block_deletes = false)
-    {
-        // no matter what, we WON'T block soft deletes.
-        return $this->delete_or_restore(true, $query_params);
-    }
-
-
-    /**
-     * 'Un-deletes' the chosen items. Note that this model is a SOFT-DELETABLE model! That means that, by default,
-     * trashed/soft-deleted items are ignored in queries. However, this particular function ignores whether the items
-     * have been soft-deleted or not.
-     *
-     * @param array $query_params
-     * @return bool
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function restore($query_params = [])
-    {
-        return $this->delete_or_restore(false, $query_params);
-    }
-
-
-    /**
-     * Performs deletes or restores on items. Both soft-deleted and non-soft-deleted items considered.
-     *
-     * @param boolean $delete true to indicate deletion, false to indicate restoration
-     * @param array   $query_params
-     * @return boolean
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function delete_or_restore($delete = true, $query_params = [])
-    {
-        $deletedFlagFieldName = $this->deleted_field_name();
-        $query_params         = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return (bool) $this->update([$deletedFlagFieldName => $delete], $query_params);
-    }
-
-
-    /**
-     * Updates all the items of this model which match the $query params, regardless of whether
-     * they've been soft-deleted or not
-     *
-     * @param array   $fields_n_values         like EEM_Base::update's $fields_n_value
-     * @param array   $query_params            like EEM_base::get_all's $query_params
-     * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
-     *                                         in this model's entity map according to $fields_n_values that match
-     *                                         $query_params. This obviously has some overhead, so you can disable it
-     *                                         by setting this to FALSE, but be aware that model objects being used
-     *                                         could get out-of-sync with the database
-     * @return int number of items updated
-     * @throws EE_Error
-     */
-    public function update_deleted_and_undeleted($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return $this->update($fields_n_values, $query_params, $keep_model_objs_in_sync);
-    }
+	/**
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
+			$this->_default_where_conditions_strategy = new EE_Soft_Delete_Where_Conditions();
+		}
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * Searches for field on this model of type 'deleted_flag'. if it is found, returns it's name.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function deleted_field_name()
+	{
+		$field = $this->get_a_field_of_type('EE_Trashed_Flag_Field');
+		if ($field) {
+			return $field->get_name();
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'We are trying to find the deleted flag field on %s, but none was found. Are you sure there is a field of type EE_Trashed_Flag_Field in %s constructor?',
+						'event_espresso'
+					),
+					get_class($this),
+					get_class($this)
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Gets one item that's been deleted, according to $query_params
+	 *
+	 * @param array $query_params
+	 * @return EE_Soft_Delete_Base_Class
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function get_one_deleted($query_params = [])
+	{
+		$query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
+		return $this->get_one($query_params);
+	}
+
+
+	/**
+	 * Gets one item from the DB, regardless of whether it's been soft-deleted or not
+	 *
+	 * @param array $query_params like EEM_base::get_all's $query_params
+	 * @return EE_Soft_Delete_Base_Class
+	 * @throws EE_Error
+	 */
+	public function get_one_deleted_or_undeleted($query_params = [])
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return $this->get_one($query_params);
+	}
+
+
+	/**
+	 * Gets the item indicated by its ID. But if it's soft-deleted, pretends it doesn't exist.
+	 *
+	 * @param int|string $id
+	 * @return EE_Soft_Delete_Base_Class
+	 * @throws EE_Error
+	 */
+	public function get_one_by_ID_but_ignore_deleted($id)
+	{
+		return $this->get_one(
+			$this->alter_query_params_to_restrict_by_ID(
+				$id,
+				['default_where_conditions' => 'default']
+			)
+		);
+	}
+
+
+	/**
+	 * Counts all the deleted/trashed items
+	 *
+	 * @param array  $query_params
+	 * @param string $field_to_count
+	 * @param bool   $distinct     if we want to only count the distinct values for the column then you can trigger
+	 *                             that by the setting $distinct to TRUE;
+	 * @return int
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function count_deleted($query_params = [], $field_to_count = null, $distinct = false)
+	{
+		$query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
+		return $this->count($query_params, $field_to_count, $distinct);
+	}
+
+
+	/**
+	 * Alters the query params so that only trashed/soft-deleted items are considered
+	 *
+	 * @param array $query_params
+	 * @return array
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	protected function _alter_query_params_so_only_trashed_items_included($query_params)
+	{
+		$deletedFlagFieldName                     = $this->deleted_field_name();
+		$query_params[0][ $deletedFlagFieldName ] = true;
+		return $query_params;
+	}
+
+
+	/**
+	 * Alters the query params so that only trashed/soft-deleted items are considered
+	 *
+	 * @param array $query_params
+	 * @return array
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function alter_query_params_so_only_trashed_items_included($query_params)
+	{
+		return $this->_alter_query_params_so_only_trashed_items_included($query_params);
+	}
+
+
+	/**
+	 * Alters the query params so each item's deleted status is ignored.
+	 *
+	 * @param array $query_params
+	 * @return array
+	 */
+	public function alter_query_params_so_deleted_and_undeleted_items_included($query_params = [])
+	{
+		return $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+	}
+
+
+	/**
+	 * Alters the query params so each item's deleted status is ignored.
+	 *
+	 * @param array $query_params
+	 * @return array
+	 */
+	protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params)
+	{
+		if (! isset($query_params['default_where_conditions'])) {
+			$query_params['default_where_conditions'] = 'minimum';
+		}
+		return $query_params;
+	}
+
+
+	/**
+	 * Counts all deleted and undeleted items
+	 *
+	 * @param array  $query_params
+	 * @param string $field_to_count
+	 * @param bool   $distinct     if we want to only count the distinct values for the column then you can trigger
+	 *                             that by the setting $distinct to TRUE;
+	 * @return int
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function count_deleted_and_undeleted($query_params = [], $field_to_count = null, $distinct = false)
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return $this->count($query_params, $field_to_count, $distinct);
+	}
+
+
+	/**
+	 * Sum all the deleted items.
+	 *
+	 * @param array  $query_params
+	 * @param string $field_to_sum
+	 * @return float
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function sum_deleted($query_params = [], $field_to_sum = null)
+	{
+		$query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
+		return $this->sum($query_params, $field_to_sum);
+	}
+
+
+	/**
+	 * Sums all the deleted and undeleted items.
+	 *
+	 * @param array  $query_params
+	 * @param string $field_to_sum
+	 * @return float
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function sum_deleted_and_undeleted($query_params = [], $field_to_sum = null)
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return $this->sum($query_params, $field_to_sum);
+	}
+
+
+	/**
+	 * Gets all deleted and undeleted mode objects from the db that meet the criteria, regardless of
+	 * whether they've been soft-deleted or not
+	 *
+	 * @param array $query_params
+	 * @return EE_Soft_Delete_Base_Class[]
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function get_all_deleted_and_undeleted($query_params = [])
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return $this->get_all($query_params);
+	}
+
+
+	/**
+	 * For 'soft deletable' models, gets all which ARE deleted, according to conditions specified in $query_params.
+	 *
+	 * @param array $query_params
+	 * @return EE_Soft_Delete_Base_Class[]
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function get_all_deleted($query_params = [])
+	{
+		$query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
+		return $this->get_all($query_params);
+	}
+
+
+	/**
+	 * Permanently deletes the selected rows. When selecting rows for deletion, ignores
+	 * whether they've been soft-deleted or not. (ie, you don't have to soft-delete objects
+	 * before you can permanently delete them).
+	 * Because this will cause a real deletion, related models may block this deletion (ie, add an error
+	 * and abort the delete)
+	 *
+	 * @param array   $query_params
+	 * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
+	 *                                that blocks it (ie, there' sno other data that depends on this data);
+	 *                                if false, deletes regardless of other objects which may depend on it.
+	 *                                Its generally advisable to always leave this as TRUE,
+	 *                                otherwise you could easily corrupt your DB
+	 * @return int                    number of rows deleted
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function delete_permanently($query_params, $allow_blocking = true)
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return parent::delete_permanently($query_params, $allow_blocking);
+	}
+
+
+	/**
+	 * Restores a particular item by its ID (primary key). Ignores the fact whether the item
+	 * has been soft-deleted or not.
+	 *
+	 * @param mixed $ID int if primary key is an int, string otherwise
+	 * @return boolean success
+	 * @throws EE_Error
+	 */
+	public function restore_by_ID($ID = false)
+	{
+		return $this->delete_or_restore_by_ID(false, $ID);
+	}
+
+
+	/**
+	 * For deleting or restoring a particular item. Note that this model is a SOFT-DELETABLE model! However,
+	 * this function will ignore whether the items have been soft-deleted or not.
+	 *
+	 * @param boolean $delete true for delete, false for restore
+	 * @param mixed   $ID     int if primary key is an int, string otherwise
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function delete_or_restore_by_ID($delete = true, $ID = false)
+	{
+		// returns false if entity doesn't have an ID or if delete/restore action failed
+		return $ID && $this->delete_or_restore($delete, $this->alter_query_params_to_restrict_by_ID($ID));
+	}
+
+
+	/**
+	 * Overrides parent's 'delete' method to instead do a soft delete on all rows that
+	 * meet the criteria in $where_col_n_values. This particular function ignores whether the items have been
+	 * soft-deleted or not. Note: because this item will be soft-deleted only, doesn't block because of model
+	 * dependencies
+	 *
+	 * @param array $query_params
+	 * @param bool  $block_deletes
+	 * @return bool
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function delete($query_params = [], $block_deletes = false)
+	{
+		// no matter what, we WON'T block soft deletes.
+		return $this->delete_or_restore(true, $query_params);
+	}
+
+
+	/**
+	 * 'Un-deletes' the chosen items. Note that this model is a SOFT-DELETABLE model! That means that, by default,
+	 * trashed/soft-deleted items are ignored in queries. However, this particular function ignores whether the items
+	 * have been soft-deleted or not.
+	 *
+	 * @param array $query_params
+	 * @return bool
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function restore($query_params = [])
+	{
+		return $this->delete_or_restore(false, $query_params);
+	}
+
+
+	/**
+	 * Performs deletes or restores on items. Both soft-deleted and non-soft-deleted items considered.
+	 *
+	 * @param boolean $delete true to indicate deletion, false to indicate restoration
+	 * @param array   $query_params
+	 * @return boolean
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function delete_or_restore($delete = true, $query_params = [])
+	{
+		$deletedFlagFieldName = $this->deleted_field_name();
+		$query_params         = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return (bool) $this->update([$deletedFlagFieldName => $delete], $query_params);
+	}
+
+
+	/**
+	 * Updates all the items of this model which match the $query params, regardless of whether
+	 * they've been soft-deleted or not
+	 *
+	 * @param array   $fields_n_values         like EEM_Base::update's $fields_n_value
+	 * @param array   $query_params            like EEM_base::get_all's $query_params
+	 * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
+	 *                                         in this model's entity map according to $fields_n_values that match
+	 *                                         $query_params. This obviously has some overhead, so you can disable it
+	 *                                         by setting this to FALSE, but be aware that model objects being used
+	 *                                         could get out-of-sync with the database
+	 * @return int number of items updated
+	 * @throws EE_Error
+	 */
+	public function update_deleted_and_undeleted($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return $this->update($fields_n_values, $query_params, $keep_model_objs_in_sync);
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -34,7 +34,7 @@ 
      */
     protected function __construct(?string $timezone = '')
     {
-        if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
+        if ( ! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
             $this->_default_where_conditions_strategy = new EE_Soft_Delete_Where_Conditions();
         }
         parent::__construct($timezone);
@@ -143,7 +143,7 @@ 
     protected function _alter_query_params_so_only_trashed_items_included($query_params)
     {
         $deletedFlagFieldName                     = $this->deleted_field_name();
-        $query_params[0][ $deletedFlagFieldName ] = true;
+        $query_params[0][$deletedFlagFieldName] = true;
         return $query_params;
     }
 
@@ -182,7 +182,7 @@ 
      */
     protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params)
     {
-        if (! isset($query_params['default_where_conditions'])) {
+        if ( ! isset($query_params['default_where_conditions'])) {
             $query_params['default_where_conditions'] = 'minimum';
         }
         return $query_params;

core/db_models/EEM_Message.model.php

Indentation +664 added lines, -664 removed lines

@@ -12,674 +12,674 @@
  */
 class EEM_Message extends EEM_Base implements EEI_Query_Filter
 {
-    // private instance of the Message object
-    protected static $_instance = null;
+	// private instance of the Message object
+	protected static $_instance = null;
 
-
-    /**
-     * This priority indicates a message should be generated and sent ASAP
-     *
-     * @type int
-     */
-    const priority_high = 10;
-
-
-    /**
-     * This priority indicates a message should be generated ASAP and queued for sending.
-     *
-     * @type
-     */
-    const priority_medium = 20;
-
-
-    /**
-     * This priority indicates a message should be queued for generating.
-     *
-     * @type int
-     */
-    const priority_low = 30;
-
-
-    /**
-     * indicates this message was sent at the time modified
-     */
-    const status_sent = 'MSN';
-
-
-    /**
-     * indicates this message is waiting to be sent
-     */
-    const status_idle = 'MID';
-
-
-    /**
-     * indicates an attempt was a made to send this message
-     * at the scheduled time, but it failed at the time modified.  This differs from MDO status in that it will ALWAYS
-     * appear to the end user.
-     */
-    const status_failed = 'MFL';
-
-
-    /**
-     * indicates the message has been flagged for resending (at the time modified).
-     */
-    const status_resend = 'MRS';
-
-
-    /**
-     * indicates the message has been flagged for generation but has not been generated yet.  Messages always start as
-     * this status when added to the queue.
-     */
-    const status_incomplete = 'MIC';
-
-
-    /**
-     * Indicates everything was generated fine for the message, however, the messenger was unable to send.
-     * This status means that its possible to retry sending the message.
-     */
-    const status_retry = 'MRT';
-
-
-    /**
-     * This is used for more informational messages that may not indicate anything is broken but still cannot be
-     * generated or sent correctly. An example of a message that would get flagged this way would be when a not
-     * approved message was queued for generation, but at time of generation, the attached registration(s) are
-     * approved. So the message queued for generation is no longer valid.  Messages for this status will only persist
-     * in the db and be viewable in the message activity list table when the messages system is in debug mode.
-     *
-     * @see EEM_Message::debug()
-     */
-    const status_debug_only = 'MDO';
-
-
-    /**
-     * This status is given to messages it is processed by the messenger send method.
-     * Messages with this status should rarely be seen in the Message List table, but if they are, that's usually
-     * indicative of a PHP timeout or memory limit issue.
-     */
-    const status_messenger_executing = 'MEX';
-
-
-    /**
-     * Private constructor to prevent direct creation.
-     *
-     * @param string|null $timezone string representing the timezone we want to set for returned Date Time Strings (and
-     *                              any incoming timezone data that gets saved).  Note this just sends the timezone
-     *                              info to the date time model field objects.  Default is null (and will be assumed
-     *                              using the set timezone in the 'timezone_string' wp option)
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Message', 'event_espresso');
-        $this->plural_item   = esc_html__('Messages', 'event_espresso');
-
-        $this->_tables = [
-            'Message' => new EE_Primary_Table('esp_message', 'MSG_ID'),
-        ];
-
-        $allowed_priority = [
-            self::priority_high   => esc_html__('high', 'event_espresso'),
-            self::priority_medium => esc_html__('medium', 'event_espresso'),
-            self::priority_low    => esc_html__('low', 'event_espresso'),
-        ];
-
-        $this->_fields          = [
-            'Message' => [
-                'MSG_ID'             => new EE_Primary_Key_Int_Field(
-                    'MSG_ID', esc_html__('Message ID', 'event_espresso')
-                ),
-                'MSG_token'          => new EE_Plain_Text_Field(
-                    'MSG_token',
-                    esc_html__(
-                        'Unique Token used to represent this row in publicly viewable contexts (eg. a url).',
-                        'event_espresso'
-                    ),
-                    false,
-                    EEH_URL::generate_unique_token()
-                ),
-                'GRP_ID'             => new EE_Foreign_Key_Int_Field(
-                    'GRP_ID',
-                    esc_html__('Foreign key to the EEM_Message_Template_Group table.', 'event_espresso'),
-                    true,
-                    0,
-                    'Message_Template_Group'
-                ),
-                'TXN_ID'             => new EE_Foreign_Key_Int_Field(
-                    'TXN_ID',
-                    esc_html__(
-                        'Foreign key to the related EE_Transaction.  This is required to give context for regenerating the specific message',
-                        'event_espresso'
-                    ),
-                    true,
-                    0,
-                    'Transaction'
-                ),
-                'MSG_messenger'      => new EE_Plain_Text_Field(
-                    'MSG_messenger',
-                    esc_html__(
-                        'Corresponds to the EE_messenger::name used to send this message. This will also be used to attempt any resending of the message.',
-                        'event_espresso'
-                    ),
-                    false,
-                    'email'
-                ),
-                'MSG_message_type'   => new EE_Plain_Text_Field(
-                    'MSG_message_type',
-                    esc_html__(
-                        'Corresponds to the EE_message_type::name used to generate this message.',
-                        'event_espresso'
-                    ),
-                    false,
-                    'receipt'
-                ),
-                'MSG_context'        => new EE_Plain_Text_Field(
-                    'MSG_context',
-                    esc_html__('Context', 'event_espresso'),
-                    false
-                ),
-                'MSG_recipient_ID'   => new EE_Foreign_Key_Int_Field(
-                    'MSG_recipient_ID',
-                    esc_html__('Recipient ID', 'event_espresso'),
-                    true,
-                    null,
-                    ['Registration', 'Attendee', 'WP_User']
-                ),
-                'MSG_recipient_type' => new EE_Any_Foreign_Model_Name_Field(
-                    'MSG_recipient_type',
-                    esc_html__('Recipient Type', 'event_espresso'),
-                    true,
-                    null,
-                    ['Registration', 'Attendee', 'WP_User']
-                ),
-                'MSG_content'        => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_content',
-                    esc_html__('Content', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'MSG_to'             => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_to',
-                    esc_html__('Address To', 'event_espresso'),
-                    true
-                ),
-                'MSG_from'           => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_from',
-                    esc_html__('Address From', 'event_espresso'),
-                    true
-                ),
-                'MSG_subject'        => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_subject',
-                    esc_html__('Subject', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'MSG_priority'       => new EE_Enum_Integer_Field(
-                    'MSG_priority',
-                    esc_html__('Priority', 'event_espresso'),
-                    false,
-                    self::priority_low,
-                    $allowed_priority
-                ),
-                'STS_ID'             => new EE_Foreign_Key_String_Field(
-                    'STS_ID',
-                    esc_html__('Status', 'event_espresso'),
-                    false,
-                    self::status_incomplete,
-                    'Status'
-                ),
-                'MSG_created'        => new EE_Datetime_Field(
-                    'MSG_created',
-                    esc_html__('Created', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now
-                ),
-                'MSG_modified'       => new EE_Datetime_Field(
-                    'MSG_modified',
-                    esc_html__('Modified', 'event_espresso'),
-                    true,
-                    EE_Datetime_Field::now
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Attendee'               => new EE_Belongs_To_Any_Relation(),
-            'Registration'           => new EE_Belongs_To_Any_Relation(),
-            'WP_User'                => new EE_Belongs_To_Any_Relation(),
-            'Message_Template_Group' => new EE_Belongs_To_Relation(),
-            'Transaction'            => new EE_Belongs_To_Relation(),
-        ];
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * @return EE_Message
-     * @throws EE_Error
-     */
-    public function create_default_object()
-    {
-        /** @type EE_Message $message */
-        $message = parent::create_default_object();
-        if ($message instanceof EE_Message) {
-            return EE_Message_Factory::set_messenger_and_message_type($message);
-        }
-        return null;
-    }
-
-
-    /**
-     * @param mixed $cols_n_values
-     * @return EE_Message
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function instantiate_class_from_array_or_object($cols_n_values)
-    {
-        /** @type EE_Message $message */
-        $message = parent::instantiate_class_from_array_or_object($cols_n_values);
-        if ($message instanceof EE_Message) {
-            return EE_Message_Factory::set_messenger_and_message_type($message);
-        }
-        return null;
-    }
-
-
-    /**
-     * Returns whether or not a message of that type was sent for a given attendee.
-     *
-     * @param EE_Attendee|int $attendee
-     * @param string          $message_type the message type slug
-     * @return boolean
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function message_sent_for_attendee($attendee, $message_type)
-    {
-        $attendee_ID = EEM_Attendee::instance()->ensure_is_ID($attendee);
-        return $this->exists(
-            [
-                [
-                    'Attendee.ATT_ID'  => $attendee_ID,
-                    'MSG_message_type' => $message_type,
-                    'STS_ID'           => ['IN', $this->stati_indicating_sent()],
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * Returns whether or not a message of that type was sent for a given registration
-     *
-     * @param EE_Registration|int $registration
-     * @param string              $message_type the message type slug
-     * @return boolean
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function message_sent_for_registration($registration, $message_type)
-    {
-        $registrationID = EEM_Registration::instance()->ensure_is_ID($registration);
-        return $this->exists(
-            [
-                [
-                    'Registration.REG_ID' => $registrationID,
-                    'MSG_message_type'    => $message_type,
-                    'STS_ID'              => ['IN', $this->stati_indicating_sent()],
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * This retrieves an EE_Message object from the db matching the given token string.
-     *
-     * @param string $token
-     * @return EE_Message
-     * @throws EE_Error
-     */
-    public function get_one_by_token($token)
-    {
-        return $this->get_one(
-            [
-                [
-                    'MSG_token' => $token,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * Returns stati that indicate the message HAS been sent
-     *
-     * @return array of strings for possible stati
-     */
-    public function stati_indicating_sent()
-    {
-        return apply_filters('FHEE__EEM_Message__stati_indicating_sent', [self::status_sent]);
-    }
-
-
-    /**
-     * Returns stati that indicate the message is waiting to be sent.
-     *
-     * @return array of strings for possible stati.
-     */
-    public function stati_indicating_to_send()
-    {
-        return apply_filters(
-            'FHEE__EEM_Message__stati_indicating_to_send',
-            [self::status_idle, self::status_resend]
-        );
-    }
-
-
-    /**
-     * Returns stati that indicate the message has failed sending
-     *
-     * @return array  array of strings for possible stati.
-     */
-    public function stati_indicating_failed_sending()
-    {
-        $failed_stati = [
-            self::status_failed,
-            self::status_retry,
-            self::status_messenger_executing,
-        ];
-        // if WP_DEBUG is set, then let's include debug_only fails
-        if (WP_DEBUG) {
-            $failed_stati[] = self::status_debug_only;
-        }
-        return apply_filters('FHEE__EEM_Message__stati_indicating_failed_sending', $failed_stati);
-    }
-
-
-    /**
-     * Returns filterable array of all EEM_Message statuses.
-     *
-     * @return array
-     */
-    public function all_statuses()
-    {
-        return apply_filters(
-            'FHEE__EEM_Message__all_statuses',
-            [
-                EEM_Message::status_sent,
-                EEM_Message::status_incomplete,
-                EEM_Message::status_idle,
-                EEM_Message::status_resend,
-                EEM_Message::status_retry,
-                EEM_Message::status_failed,
-                EEM_Message::status_messenger_executing,
-                EEM_Message::status_debug_only,
-            ]
-        );
-    }
-
-
-    /**
-     * Detects any specific query variables in the request and uses those to setup appropriate
-     * filter for any queries.
-     *
-     * @return array
-     */
-    public function filter_by_query_params()
-    {
-        /** @var RequestInterface $request */
-        $request = EEM_Base::$loader->getShared(RequestInterface::class);
-        // expected possible query_vars, the key in this array matches an expected key in the request,
-        // the value, matches the corresponding EEM_Base child reference.
-        $expected_vars   = $this->_expected_vars_for_query_inject();
-        $query_params[0] = [];
-        foreach ($expected_vars as $request_key => $model_name) {
-            $request_value = $request->getRequestParam($request_key);
-            if ($request_value) {
-                // special case
-                switch ($request_key) {
-                    case '_REG_ID':
-                        $query_params[0]['AND**filter_by']['OR**filter_by_REG_ID'] = [
-                            'Transaction.Registration.REG_ID' => $request_value,
-                        ];
-                        break;
-                    case 'EVT_ID':
-                        $query_params[0]['AND**filter_by']['OR**filter_by_EVT_ID'] = [
-                            'Transaction.Registration.EVT_ID' => $request_value,
-                        ];
-                        break;
-                    default:
-                        $query_params[0]['AND**filter_by'][ 'OR**filter_by_' . $request_key ][ $model_name . '.' . $request_key ] =
-                            $request_value;
-                        break;
-                }
-            }
-        }
-        return $query_params;
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_pretty_label_for_results()
-    {
-        /** @var RequestInterface $request */
-        $request       = EEM_Base::$loader->getShared(RequestInterface::class);
-        $expected_vars = $this->_expected_vars_for_query_inject();
-        $pretty_label  = '';
-        $label_parts   = [];
-        foreach ($expected_vars as $request_key => $model_name) {
-            $model_name        = strpos($model_name, 'EEM_', true) === 0 ? $model_name : "EEM_{$model_name}";
-            $model             = EEM_Base::$loader->getShared($model_name);
-            $model_field_value = $request->getRequestParam($request_key);
-            if ($model instanceof EEM_Base && $model_field_value !== '') {
-                switch ($request_key) {
-                    case '_REG_ID':
-                        $label_parts[] = sprintf(
-                            esc_html__('Registration with the ID: %s', 'event_espresso'),
-                            $model_field_value
-                        );
-                        break;
-                    case 'ATT_ID':
-                        /** @var EE_Attendee $attendee */
-                        $attendee      = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $attendee instanceof EE_Attendee
-                            ? sprintf(esc_html__('Attendee %s', 'event_espresso'), $attendee->full_name())
-                            : sprintf(esc_html__('Attendee ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                    case 'ID':
-                        /** @var EE_WP_User $wpUser */
-                        $wpUser        = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $wpUser instanceof EE_WP_User
-                            ? sprintf(esc_html__('WP User: %s', 'event_espresso'), $wpUser->name())
-                            : sprintf(esc_html__('WP User ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                    case 'TXN_ID':
-                        $label_parts[] = sprintf(
-                            esc_html__('Transaction with the ID: %s', 'event_espresso'),
-                            $model_field_value
-                        );
-                        break;
-                    case 'EVT_ID':
-                        /** @var EE_Event $Event */
-                        $Event         = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $Event instanceof EE_Event
-                            ? sprintf(esc_html__('for the Event: %s', 'event_espresso'), $Event->name())
-                            : sprintf(esc_html__('for the Event with ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                }
-            }
-        }
-
-        if ($label_parts) {
-            // prepend to the last element of $label_parts an "and".
-            if (count($label_parts) > 1) {
-                $label_parts_index_to_prepend                 = count($label_parts) - 1;
-                $label_parts[ $label_parts_index_to_prepend ] = 'and' . $label_parts[ $label_parts_index_to_prepend ];
-            }
-
-            $pretty_label .= sprintf(
-                esc_html_x(
-                    'Showing messages for %s',
-                    'A label for the messages returned in a query that are filtered by items in the query. This could be Transaction, Event, Attendee, Registration, or WP_User.',
-                    'event_espresso'
-                ),
-                implode(', ', $label_parts)
-            );
-        }
-        return $pretty_label;
-    }
-
-
-    /**
-     * This returns the array of expected variables for the EEI_Query_Filter methods being implemented
-     * The array is in the format:
-     * array(
-     *  {$field_name} => {$model_name}
-     * );
-     *
-     * @return array
-     * @since 4.9.0
-     */
-    protected function _expected_vars_for_query_inject()
-    {
-        return [
-            '_REG_ID' => 'Registration',
-            'ATT_ID'  => 'Attendee',
-            'ID'      => 'WP_User',
-            'TXN_ID'  => 'Transaction',
-            'EVT_ID'  => 'Event',
-        ];
-    }
-
-
-    /**
-     * This returns whether EEM_Message is in debug mode or not.
-     * Currently "debug mode" is used to control the handling of the EEM_Message::debug_only status when
-     * generating/sending messages. Debug mode can be set by either:
-     * 1. Sending in a value for the $set_debug argument
-     * 2. Defining `EE_DEBUG_MESSAGES` constant in wp-config.php
-     * 3. Overriding the above via the provided filter.
-     *
-     * @param bool|null $set_debug      If provided, then the debug mode will be set internally until reset via the
-     *                                  provided boolean. When no argument is provided (default null) then the debug
-     *                                  mode will be returned.
-     * @return bool         true means Messages is in debug mode.  false means messages system is not in debug mode.
-     */
-    public static function debug($set_debug = null)
-    {
-        static $is_debugging = null;
-
-        // initialize (use constant if set).
-        if (is_null($set_debug) && is_null($is_debugging)) {
-            $is_debugging = defined('EE_DEBUG_MESSAGES') && EE_DEBUG_MESSAGES;
-        }
-
-        if (! is_null($set_debug)) {
-            $is_debugging = filter_var($set_debug, FILTER_VALIDATE_BOOLEAN);
-        }
-
-        // return filtered value
-        return apply_filters('FHEE__EEM_Message__debug', $is_debugging);
-    }
-
-
-    /**
-     * Deletes old messages meeting certain criteria for removal from the database.
-     * By default, this will delete messages that:
-     * - are older than the value of the delete_threshold in months.
-     * - have a STS_ID other than EEM_Message::status_idle
-     *
-     * @param int $delete_threshold This integer will be used to set the boundary for what messages are deleted in
-     *                              months.
-     * @return bool|false|int Either the number of records affected or false if there was an error (you can call
-     *                              $wpdb->last_error to find out what the error was.
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function delete_old_messages($delete_threshold = 6)
-    {
-        $number_deleted = 0;
-        /**
-         * Allows code to change the boundary for what messages are kept.
-         * Uses the value of the `delete_threshold` variable by default.
-         *
-         * @param int $seconds seconds that will be subtracted from the timestamp for now.
-         * @return int
-         */
-        $time_to_leave_alone = absint(
-            apply_filters(
-                'FHEE__EEM_Message__delete_old_messages__time_to_leave_alone',
-                ((int) $delete_threshold) * MONTH_IN_SECONDS
-            )
-        );
-
-
-        /**
-         * Allows code to change what message stati are ignored when deleting.
-         * Defaults to only ignore EEM_Message::status_idle messages.
-         *
-         * @param string $message_stati_to_keep An array of message statuses that will be ignored when deleting.
-         */
-        $message_stati_to_keep = (array) apply_filters(
-            'FHEE__EEM_Message__delete_old_messages__message_stati_to_keep',
-            [
-                EEM_Message::status_idle,
-            ]
-        );
-
-        // first get all the ids of messages being deleted
-        $message_ids_to_delete = EEM_Message::instance()->get_col(
-            [
-                0       => [
-                    'STS_ID'       => ['NOT_IN', $message_stati_to_keep],
-                    'MSG_modified' => ['<', time() - $time_to_leave_alone],
-                ],
-                'limit' => apply_filters(
-                    'EEM_Message__delete_old_messages__limit',
-                    2000,
-                    $delete_threshold
-                ),
-            ]
-        );
-
-        if (! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
-            global $wpdb;
-            $number_deleted = $wpdb->query(
-                '
+
+	/**
+	 * This priority indicates a message should be generated and sent ASAP
+	 *
+	 * @type int
+	 */
+	const priority_high = 10;
+
+
+	/**
+	 * This priority indicates a message should be generated ASAP and queued for sending.
+	 *
+	 * @type
+	 */
+	const priority_medium = 20;
+
+
+	/**
+	 * This priority indicates a message should be queued for generating.
+	 *
+	 * @type int
+	 */
+	const priority_low = 30;
+
+
+	/**
+	 * indicates this message was sent at the time modified
+	 */
+	const status_sent = 'MSN';
+
+
+	/**
+	 * indicates this message is waiting to be sent
+	 */
+	const status_idle = 'MID';
+
+
+	/**
+	 * indicates an attempt was a made to send this message
+	 * at the scheduled time, but it failed at the time modified.  This differs from MDO status in that it will ALWAYS
+	 * appear to the end user.
+	 */
+	const status_failed = 'MFL';
+
+
+	/**
+	 * indicates the message has been flagged for resending (at the time modified).
+	 */
+	const status_resend = 'MRS';
+
+
+	/**
+	 * indicates the message has been flagged for generation but has not been generated yet.  Messages always start as
+	 * this status when added to the queue.
+	 */
+	const status_incomplete = 'MIC';
+
+
+	/**
+	 * Indicates everything was generated fine for the message, however, the messenger was unable to send.
+	 * This status means that its possible to retry sending the message.
+	 */
+	const status_retry = 'MRT';
+
+
+	/**
+	 * This is used for more informational messages that may not indicate anything is broken but still cannot be
+	 * generated or sent correctly. An example of a message that would get flagged this way would be when a not
+	 * approved message was queued for generation, but at time of generation, the attached registration(s) are
+	 * approved. So the message queued for generation is no longer valid.  Messages for this status will only persist
+	 * in the db and be viewable in the message activity list table when the messages system is in debug mode.
+	 *
+	 * @see EEM_Message::debug()
+	 */
+	const status_debug_only = 'MDO';
+
+
+	/**
+	 * This status is given to messages it is processed by the messenger send method.
+	 * Messages with this status should rarely be seen in the Message List table, but if they are, that's usually
+	 * indicative of a PHP timeout or memory limit issue.
+	 */
+	const status_messenger_executing = 'MEX';
+
+
+	/**
+	 * Private constructor to prevent direct creation.
+	 *
+	 * @param string|null $timezone string representing the timezone we want to set for returned Date Time Strings (and
+	 *                              any incoming timezone data that gets saved).  Note this just sends the timezone
+	 *                              info to the date time model field objects.  Default is null (and will be assumed
+	 *                              using the set timezone in the 'timezone_string' wp option)
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Message', 'event_espresso');
+		$this->plural_item   = esc_html__('Messages', 'event_espresso');
+
+		$this->_tables = [
+			'Message' => new EE_Primary_Table('esp_message', 'MSG_ID'),
+		];
+
+		$allowed_priority = [
+			self::priority_high   => esc_html__('high', 'event_espresso'),
+			self::priority_medium => esc_html__('medium', 'event_espresso'),
+			self::priority_low    => esc_html__('low', 'event_espresso'),
+		];
+
+		$this->_fields          = [
+			'Message' => [
+				'MSG_ID'             => new EE_Primary_Key_Int_Field(
+					'MSG_ID', esc_html__('Message ID', 'event_espresso')
+				),
+				'MSG_token'          => new EE_Plain_Text_Field(
+					'MSG_token',
+					esc_html__(
+						'Unique Token used to represent this row in publicly viewable contexts (eg. a url).',
+						'event_espresso'
+					),
+					false,
+					EEH_URL::generate_unique_token()
+				),
+				'GRP_ID'             => new EE_Foreign_Key_Int_Field(
+					'GRP_ID',
+					esc_html__('Foreign key to the EEM_Message_Template_Group table.', 'event_espresso'),
+					true,
+					0,
+					'Message_Template_Group'
+				),
+				'TXN_ID'             => new EE_Foreign_Key_Int_Field(
+					'TXN_ID',
+					esc_html__(
+						'Foreign key to the related EE_Transaction.  This is required to give context for regenerating the specific message',
+						'event_espresso'
+					),
+					true,
+					0,
+					'Transaction'
+				),
+				'MSG_messenger'      => new EE_Plain_Text_Field(
+					'MSG_messenger',
+					esc_html__(
+						'Corresponds to the EE_messenger::name used to send this message. This will also be used to attempt any resending of the message.',
+						'event_espresso'
+					),
+					false,
+					'email'
+				),
+				'MSG_message_type'   => new EE_Plain_Text_Field(
+					'MSG_message_type',
+					esc_html__(
+						'Corresponds to the EE_message_type::name used to generate this message.',
+						'event_espresso'
+					),
+					false,
+					'receipt'
+				),
+				'MSG_context'        => new EE_Plain_Text_Field(
+					'MSG_context',
+					esc_html__('Context', 'event_espresso'),
+					false
+				),
+				'MSG_recipient_ID'   => new EE_Foreign_Key_Int_Field(
+					'MSG_recipient_ID',
+					esc_html__('Recipient ID', 'event_espresso'),
+					true,
+					null,
+					['Registration', 'Attendee', 'WP_User']
+				),
+				'MSG_recipient_type' => new EE_Any_Foreign_Model_Name_Field(
+					'MSG_recipient_type',
+					esc_html__('Recipient Type', 'event_espresso'),
+					true,
+					null,
+					['Registration', 'Attendee', 'WP_User']
+				),
+				'MSG_content'        => new EE_Maybe_Serialized_Text_Field(
+					'MSG_content',
+					esc_html__('Content', 'event_espresso'),
+					true,
+					''
+				),
+				'MSG_to'             => new EE_Maybe_Serialized_Text_Field(
+					'MSG_to',
+					esc_html__('Address To', 'event_espresso'),
+					true
+				),
+				'MSG_from'           => new EE_Maybe_Serialized_Text_Field(
+					'MSG_from',
+					esc_html__('Address From', 'event_espresso'),
+					true
+				),
+				'MSG_subject'        => new EE_Maybe_Serialized_Text_Field(
+					'MSG_subject',
+					esc_html__('Subject', 'event_espresso'),
+					true,
+					''
+				),
+				'MSG_priority'       => new EE_Enum_Integer_Field(
+					'MSG_priority',
+					esc_html__('Priority', 'event_espresso'),
+					false,
+					self::priority_low,
+					$allowed_priority
+				),
+				'STS_ID'             => new EE_Foreign_Key_String_Field(
+					'STS_ID',
+					esc_html__('Status', 'event_espresso'),
+					false,
+					self::status_incomplete,
+					'Status'
+				),
+				'MSG_created'        => new EE_Datetime_Field(
+					'MSG_created',
+					esc_html__('Created', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now
+				),
+				'MSG_modified'       => new EE_Datetime_Field(
+					'MSG_modified',
+					esc_html__('Modified', 'event_espresso'),
+					true,
+					EE_Datetime_Field::now
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Attendee'               => new EE_Belongs_To_Any_Relation(),
+			'Registration'           => new EE_Belongs_To_Any_Relation(),
+			'WP_User'                => new EE_Belongs_To_Any_Relation(),
+			'Message_Template_Group' => new EE_Belongs_To_Relation(),
+			'Transaction'            => new EE_Belongs_To_Relation(),
+		];
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * @return EE_Message
+	 * @throws EE_Error
+	 */
+	public function create_default_object()
+	{
+		/** @type EE_Message $message */
+		$message = parent::create_default_object();
+		if ($message instanceof EE_Message) {
+			return EE_Message_Factory::set_messenger_and_message_type($message);
+		}
+		return null;
+	}
+
+
+	/**
+	 * @param mixed $cols_n_values
+	 * @return EE_Message
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function instantiate_class_from_array_or_object($cols_n_values)
+	{
+		/** @type EE_Message $message */
+		$message = parent::instantiate_class_from_array_or_object($cols_n_values);
+		if ($message instanceof EE_Message) {
+			return EE_Message_Factory::set_messenger_and_message_type($message);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Returns whether or not a message of that type was sent for a given attendee.
+	 *
+	 * @param EE_Attendee|int $attendee
+	 * @param string          $message_type the message type slug
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function message_sent_for_attendee($attendee, $message_type)
+	{
+		$attendee_ID = EEM_Attendee::instance()->ensure_is_ID($attendee);
+		return $this->exists(
+			[
+				[
+					'Attendee.ATT_ID'  => $attendee_ID,
+					'MSG_message_type' => $message_type,
+					'STS_ID'           => ['IN', $this->stati_indicating_sent()],
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * Returns whether or not a message of that type was sent for a given registration
+	 *
+	 * @param EE_Registration|int $registration
+	 * @param string              $message_type the message type slug
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function message_sent_for_registration($registration, $message_type)
+	{
+		$registrationID = EEM_Registration::instance()->ensure_is_ID($registration);
+		return $this->exists(
+			[
+				[
+					'Registration.REG_ID' => $registrationID,
+					'MSG_message_type'    => $message_type,
+					'STS_ID'              => ['IN', $this->stati_indicating_sent()],
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * This retrieves an EE_Message object from the db matching the given token string.
+	 *
+	 * @param string $token
+	 * @return EE_Message
+	 * @throws EE_Error
+	 */
+	public function get_one_by_token($token)
+	{
+		return $this->get_one(
+			[
+				[
+					'MSG_token' => $token,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * Returns stati that indicate the message HAS been sent
+	 *
+	 * @return array of strings for possible stati
+	 */
+	public function stati_indicating_sent()
+	{
+		return apply_filters('FHEE__EEM_Message__stati_indicating_sent', [self::status_sent]);
+	}
+
+
+	/**
+	 * Returns stati that indicate the message is waiting to be sent.
+	 *
+	 * @return array of strings for possible stati.
+	 */
+	public function stati_indicating_to_send()
+	{
+		return apply_filters(
+			'FHEE__EEM_Message__stati_indicating_to_send',
+			[self::status_idle, self::status_resend]
+		);
+	}
+
+
+	/**
+	 * Returns stati that indicate the message has failed sending
+	 *
+	 * @return array  array of strings for possible stati.
+	 */
+	public function stati_indicating_failed_sending()
+	{
+		$failed_stati = [
+			self::status_failed,
+			self::status_retry,
+			self::status_messenger_executing,
+		];
+		// if WP_DEBUG is set, then let's include debug_only fails
+		if (WP_DEBUG) {
+			$failed_stati[] = self::status_debug_only;
+		}
+		return apply_filters('FHEE__EEM_Message__stati_indicating_failed_sending', $failed_stati);
+	}
+
+
+	/**
+	 * Returns filterable array of all EEM_Message statuses.
+	 *
+	 * @return array
+	 */
+	public function all_statuses()
+	{
+		return apply_filters(
+			'FHEE__EEM_Message__all_statuses',
+			[
+				EEM_Message::status_sent,
+				EEM_Message::status_incomplete,
+				EEM_Message::status_idle,
+				EEM_Message::status_resend,
+				EEM_Message::status_retry,
+				EEM_Message::status_failed,
+				EEM_Message::status_messenger_executing,
+				EEM_Message::status_debug_only,
+			]
+		);
+	}
+
+
+	/**
+	 * Detects any specific query variables in the request and uses those to setup appropriate
+	 * filter for any queries.
+	 *
+	 * @return array
+	 */
+	public function filter_by_query_params()
+	{
+		/** @var RequestInterface $request */
+		$request = EEM_Base::$loader->getShared(RequestInterface::class);
+		// expected possible query_vars, the key in this array matches an expected key in the request,
+		// the value, matches the corresponding EEM_Base child reference.
+		$expected_vars   = $this->_expected_vars_for_query_inject();
+		$query_params[0] = [];
+		foreach ($expected_vars as $request_key => $model_name) {
+			$request_value = $request->getRequestParam($request_key);
+			if ($request_value) {
+				// special case
+				switch ($request_key) {
+					case '_REG_ID':
+						$query_params[0]['AND**filter_by']['OR**filter_by_REG_ID'] = [
+							'Transaction.Registration.REG_ID' => $request_value,
+						];
+						break;
+					case 'EVT_ID':
+						$query_params[0]['AND**filter_by']['OR**filter_by_EVT_ID'] = [
+							'Transaction.Registration.EVT_ID' => $request_value,
+						];
+						break;
+					default:
+						$query_params[0]['AND**filter_by'][ 'OR**filter_by_' . $request_key ][ $model_name . '.' . $request_key ] =
+							$request_value;
+						break;
+				}
+			}
+		}
+		return $query_params;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_pretty_label_for_results()
+	{
+		/** @var RequestInterface $request */
+		$request       = EEM_Base::$loader->getShared(RequestInterface::class);
+		$expected_vars = $this->_expected_vars_for_query_inject();
+		$pretty_label  = '';
+		$label_parts   = [];
+		foreach ($expected_vars as $request_key => $model_name) {
+			$model_name        = strpos($model_name, 'EEM_', true) === 0 ? $model_name : "EEM_{$model_name}";
+			$model             = EEM_Base::$loader->getShared($model_name);
+			$model_field_value = $request->getRequestParam($request_key);
+			if ($model instanceof EEM_Base && $model_field_value !== '') {
+				switch ($request_key) {
+					case '_REG_ID':
+						$label_parts[] = sprintf(
+							esc_html__('Registration with the ID: %s', 'event_espresso'),
+							$model_field_value
+						);
+						break;
+					case 'ATT_ID':
+						/** @var EE_Attendee $attendee */
+						$attendee      = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $attendee instanceof EE_Attendee
+							? sprintf(esc_html__('Attendee %s', 'event_espresso'), $attendee->full_name())
+							: sprintf(esc_html__('Attendee ID: %s', 'event_espresso'), $model_field_value);
+						break;
+					case 'ID':
+						/** @var EE_WP_User $wpUser */
+						$wpUser        = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $wpUser instanceof EE_WP_User
+							? sprintf(esc_html__('WP User: %s', 'event_espresso'), $wpUser->name())
+							: sprintf(esc_html__('WP User ID: %s', 'event_espresso'), $model_field_value);
+						break;
+					case 'TXN_ID':
+						$label_parts[] = sprintf(
+							esc_html__('Transaction with the ID: %s', 'event_espresso'),
+							$model_field_value
+						);
+						break;
+					case 'EVT_ID':
+						/** @var EE_Event $Event */
+						$Event         = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $Event instanceof EE_Event
+							? sprintf(esc_html__('for the Event: %s', 'event_espresso'), $Event->name())
+							: sprintf(esc_html__('for the Event with ID: %s', 'event_espresso'), $model_field_value);
+						break;
+				}
+			}
+		}
+
+		if ($label_parts) {
+			// prepend to the last element of $label_parts an "and".
+			if (count($label_parts) > 1) {
+				$label_parts_index_to_prepend                 = count($label_parts) - 1;
+				$label_parts[ $label_parts_index_to_prepend ] = 'and' . $label_parts[ $label_parts_index_to_prepend ];
+			}
+
+			$pretty_label .= sprintf(
+				esc_html_x(
+					'Showing messages for %s',
+					'A label for the messages returned in a query that are filtered by items in the query. This could be Transaction, Event, Attendee, Registration, or WP_User.',
+					'event_espresso'
+				),
+				implode(', ', $label_parts)
+			);
+		}
+		return $pretty_label;
+	}
+
+
+	/**
+	 * This returns the array of expected variables for the EEI_Query_Filter methods being implemented
+	 * The array is in the format:
+	 * array(
+	 *  {$field_name} => {$model_name}
+	 * );
+	 *
+	 * @return array
+	 * @since 4.9.0
+	 */
+	protected function _expected_vars_for_query_inject()
+	{
+		return [
+			'_REG_ID' => 'Registration',
+			'ATT_ID'  => 'Attendee',
+			'ID'      => 'WP_User',
+			'TXN_ID'  => 'Transaction',
+			'EVT_ID'  => 'Event',
+		];
+	}
+
+
+	/**
+	 * This returns whether EEM_Message is in debug mode or not.
+	 * Currently "debug mode" is used to control the handling of the EEM_Message::debug_only status when
+	 * generating/sending messages. Debug mode can be set by either:
+	 * 1. Sending in a value for the $set_debug argument
+	 * 2. Defining `EE_DEBUG_MESSAGES` constant in wp-config.php
+	 * 3. Overriding the above via the provided filter.
+	 *
+	 * @param bool|null $set_debug      If provided, then the debug mode will be set internally until reset via the
+	 *                                  provided boolean. When no argument is provided (default null) then the debug
+	 *                                  mode will be returned.
+	 * @return bool         true means Messages is in debug mode.  false means messages system is not in debug mode.
+	 */
+	public static function debug($set_debug = null)
+	{
+		static $is_debugging = null;
+
+		// initialize (use constant if set).
+		if (is_null($set_debug) && is_null($is_debugging)) {
+			$is_debugging = defined('EE_DEBUG_MESSAGES') && EE_DEBUG_MESSAGES;
+		}
+
+		if (! is_null($set_debug)) {
+			$is_debugging = filter_var($set_debug, FILTER_VALIDATE_BOOLEAN);
+		}
+
+		// return filtered value
+		return apply_filters('FHEE__EEM_Message__debug', $is_debugging);
+	}
+
+
+	/**
+	 * Deletes old messages meeting certain criteria for removal from the database.
+	 * By default, this will delete messages that:
+	 * - are older than the value of the delete_threshold in months.
+	 * - have a STS_ID other than EEM_Message::status_idle
+	 *
+	 * @param int $delete_threshold This integer will be used to set the boundary for what messages are deleted in
+	 *                              months.
+	 * @return bool|false|int Either the number of records affected or false if there was an error (you can call
+	 *                              $wpdb->last_error to find out what the error was.
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function delete_old_messages($delete_threshold = 6)
+	{
+		$number_deleted = 0;
+		/**
+		 * Allows code to change the boundary for what messages are kept.
+		 * Uses the value of the `delete_threshold` variable by default.
+		 *
+		 * @param int $seconds seconds that will be subtracted from the timestamp for now.
+		 * @return int
+		 */
+		$time_to_leave_alone = absint(
+			apply_filters(
+				'FHEE__EEM_Message__delete_old_messages__time_to_leave_alone',
+				((int) $delete_threshold) * MONTH_IN_SECONDS
+			)
+		);
+
+
+		/**
+		 * Allows code to change what message stati are ignored when deleting.
+		 * Defaults to only ignore EEM_Message::status_idle messages.
+		 *
+		 * @param string $message_stati_to_keep An array of message statuses that will be ignored when deleting.
+		 */
+		$message_stati_to_keep = (array) apply_filters(
+			'FHEE__EEM_Message__delete_old_messages__message_stati_to_keep',
+			[
+				EEM_Message::status_idle,
+			]
+		);
+
+		// first get all the ids of messages being deleted
+		$message_ids_to_delete = EEM_Message::instance()->get_col(
+			[
+				0       => [
+					'STS_ID'       => ['NOT_IN', $message_stati_to_keep],
+					'MSG_modified' => ['<', time() - $time_to_leave_alone],
+				],
+				'limit' => apply_filters(
+					'EEM_Message__delete_old_messages__limit',
+					2000,
+					$delete_threshold
+				),
+			]
+		);
+
+		if (! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
+			global $wpdb;
+			$number_deleted = $wpdb->query(
+				'
                 DELETE
                 FROM ' . $this->table() . '
                 WHERE
                     MSG_ID IN (' . implode(",", $message_ids_to_delete) . ')
             '
-            );
-        }
-
-        /**
-         * This will get called if the number of records deleted 0 or greater.  So a successful deletion is one where
-         * there were no errors.  An unsuccessful deletion is where there were errors.  Keep that in mind for the actions
-         * below.
-         */
-        if ($number_deleted !== false) {
-            do_action(
-                'AHEE__EEM_Message__delete_old_messages__after_successful_deletion',
-                $message_ids_to_delete,
-                $number_deleted
-            );
-        } else {
-            do_action(
-                'AHEE__EEM_Message__delete_old_messages__after_deletion_fail',
-                $message_ids_to_delete,
-                $number_deleted
-            );
-        }
-        return $number_deleted;
-    }
+			);
+		}
+
+		/**
+		 * This will get called if the number of records deleted 0 or greater.  So a successful deletion is one where
+		 * there were no errors.  An unsuccessful deletion is where there were errors.  Keep that in mind for the actions
+		 * below.
+		 */
+		if ($number_deleted !== false) {
+			do_action(
+				'AHEE__EEM_Message__delete_old_messages__after_successful_deletion',
+				$message_ids_to_delete,
+				$number_deleted
+			);
+		} else {
+			do_action(
+				'AHEE__EEM_Message__delete_old_messages__after_deletion_fail',
+				$message_ids_to_delete,
+				$number_deleted
+			);
+		}
+		return $number_deleted;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -124,7 +124,7 @@ 
             self::priority_low    => esc_html__('low', 'event_espresso'),
         ];
 
-        $this->_fields          = [
+        $this->_fields = [
             'Message' => [
                 'MSG_ID'             => new EE_Primary_Key_Int_Field(
                     'MSG_ID', esc_html__('Message ID', 'event_espresso')
@@ -452,7 +452,7 @@ 
                         ];
                         break;
                     default:
-                        $query_params[0]['AND**filter_by'][ 'OR**filter_by_' . $request_key ][ $model_name . '.' . $request_key ] =
+                        $query_params[0]['AND**filter_by']['OR**filter_by_'.$request_key][$model_name.'.'.$request_key] =
                             $request_value;
                         break;
                 }
@@ -521,7 +521,7 @@ 
             // prepend to the last element of $label_parts an "and".
             if (count($label_parts) > 1) {
                 $label_parts_index_to_prepend                 = count($label_parts) - 1;
-                $label_parts[ $label_parts_index_to_prepend ] = 'and' . $label_parts[ $label_parts_index_to_prepend ];
+                $label_parts[$label_parts_index_to_prepend] = 'and'.$label_parts[$label_parts_index_to_prepend];
             }
 
             $pretty_label .= sprintf(
@@ -581,7 +581,7 @@ 
             $is_debugging = defined('EE_DEBUG_MESSAGES') && EE_DEBUG_MESSAGES;
         }
 
-        if (! is_null($set_debug)) {
+        if ( ! is_null($set_debug)) {
             $is_debugging = filter_var($set_debug, FILTER_VALIDATE_BOOLEAN);
         }
 
@@ -650,14 +650,14 @@ 
             ]
         );
 
-        if (! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
+        if ( ! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
             global $wpdb;
             $number_deleted = $wpdb->query(
                 '
                 DELETE
-                FROM ' . $this->table() . '
+                FROM ' . $this->table().'
                 WHERE
-                    MSG_ID IN (' . implode(",", $message_ids_to_delete) . ')
+                    MSG_ID IN (' . implode(",", $message_ids_to_delete).')
             '
             );
         }

core/db_models/EEM_Line_Item.model.php

Indentation +625 added lines, -625 removed lines

@@ -27,632 +27,632 @@
  */
 class EEM_Line_Item extends EEM_Base
 {
-    /**
-     * Tax sub-total is just the total of all the taxes, which should be children
-     * of this line item. There should only ever be one tax sub-total, and it should
-     * be a direct child of. Its quantity and LIN_unit_price = 1.
-     */
-    const type_tax_sub_total = 'tax-sub-total';
-
-    /**
-     * Tax line items indicate a tax applied to all the taxable line items.
-     * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal
-     * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1.
-     */
-    const type_tax = 'tax';
-
-    /**
-     * Indicating individual items purchased, or discounts or surcharges.
-     * The sum of all the regular line items  plus the tax items should equal the grand total.
-     * Possible children are sub-line-items and cancellations.
-     * For flat items, LIN_unit_price * LIN_quantity = LIN_total. Its LIN_total is the sum of all the children
-     * LIN_totals. Its LIN_percent = 0.
-     * For percent items, its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal (eg 10% = 10, not 0.1).
-     * Its LIN_total is LIN_percent / 100 * sum of lower-priority sibling line items. Quantity = 1.
-     */
-    const type_line_item = 'line-item';
-
-    /**
-     * Line item indicating all the factors that make a single line item.
-     * Sub-line items should have NO children line items.
-     * For flat sub-items, their quantity should match their parent item, their LIN_unit_price should be this sub-item's
-     * contribution towards the price of ONE of their parent items, and its LIN_total should be
-     *  = LIN_quantity * LIN_unit_price. Its LIN_percent = 0.
-     * For percent sub-items, the quantity should be 1, LIN_unit_price should be 0, and its LIN_total should
-     * = LIN_percent / 100 * sum of lower-priority sibling line items..
-     */
-    const type_sub_line_item = 'sub-item';
-
-    /**
-     * SubTax line items indicate a tax that is only applied to the pre-tax total of their parent line item.
-     * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal
-     * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1.
-     */
-    const type_sub_tax = 'sub-tax';
-
-    /**
-     * Line item indicating a sub-total (eg total for an event, or pre-tax subtotal).
-     * Direct children should be event subtotals.
-     * Should have quantity of 1, and a LIN_total and LIN_unit_price of the sum of all its sub-items' LIN_totals.
-     */
-    const type_sub_total = 'sub-total';
-
-    /**
-     * Line item for the grand total of an order.
-     * Its direct children should be tax subtotals and (pre-tax) subtotals,
-     * and possibly a regular line item indicating a transaction-wide discount/surcharge.
-     * Should have a quantity of 1, a LIN_total and LIN_unit_price of the entire order's amount.
-     */
-    const type_total = 'total';
-
-    /**
-     * When a line item is cancelled, a sub-line-item of type 'cancellation'
-     * should be created, indicating the quantity that were cancelled
-     * (because a line item could have a quantity of 1, and its cancellation item
-     * could be for 3, indicating that originally 4 were purchased, but 3 have been
-     * cancelled, and only one remains).
-     * When items are refunded, a cancellation line item should be made, which points
-     * to teh payment model object which actually refunded the payment.
-     * Cancellations should NOT have any children line items; the should NOT affect
-     * any calculations, and are only meant as a record that cancellations have occurred.
-     * Their LIN_percent should be 0.
-     */
-    const type_cancellation = 'cancellation';
-
-    // various line item object types
-    const OBJ_TYPE_EVENT       = 'Event';
-
-    const OBJ_TYPE_PRICE       = 'Price';
-
-    const OBJ_TYPE_PROMOTION   = 'Promotion';
-
-    const OBJ_TYPE_TICKET      = 'Ticket';
-
-    const OBJ_TYPE_TRANSACTION = 'Transaction';
-
-    /**
-     * @var EEM_Line_Item $_instance
-     */
-    protected static $_instance;
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param string|null $timezone string representing the timezone we want to set for returned Date Time Strings
-     *                              (and any incoming timezone data that gets saved).
-     *                              Note this just sends the timezone info to the date time model field objects.
-     *                              Default is NULL
-     *                              (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Line Item', 'event_espresso');
-        $this->plural_item   = esc_html__('Line Items', 'event_espresso');
-
-        $this->_tables                 = [
-            'Line_Item' => new EE_Primary_Table('esp_line_item', 'LIN_ID'),
-        ];
-        $line_items_can_be_for         = apply_filters(
-            'FHEE__EEM_Line_Item__line_items_can_be_for',
-            ['Ticket', 'Price', 'Event']
-        );
-        $this->_fields                 = [
-            'Line_Item' => [
-                'LIN_ID'         => new EE_Primary_Key_Int_Field(
-                    'LIN_ID',
-                    esc_html__('ID', 'event_espresso')
-                ),
-                'LIN_code'       => new EE_Slug_Field(
-                    'LIN_code',
-                    esc_html__('Code for index into Cart', 'event_espresso'),
-                    true
-                ),
-                'TXN_ID'         => new EE_Foreign_Key_Int_Field(
-                    'TXN_ID',
-                    esc_html__('Transaction ID', 'event_espresso'),
-                    true,
-                    null,
-                    'Transaction'
-                ),
-                'LIN_name'       => new EE_Full_HTML_Field(
-                    'LIN_name',
-                    esc_html__('Line Item Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'LIN_desc'       => new EE_Full_HTML_Field(
-                    'LIN_desc',
-                    esc_html__('Line Item Description', 'event_espresso'),
-                    true
-                ),
-                'LIN_unit_price' => new EE_Money_Field(
-                    'LIN_unit_price',
-                    esc_html__('Unit Price', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'LIN_percent'    => new EE_Float_Field(
-                    'LIN_percent',
-                    esc_html__('Percent', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'LIN_is_taxable' => new EE_Boolean_Field(
-                    'LIN_is_taxable',
-                    esc_html__('Taxable', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'LIN_order'      => new EE_Integer_Field(
-                    'LIN_order',
-                    esc_html__('Order of Application towards total of parent', 'event_espresso'),
-                    false,
-                    1
-                ),
-                'LIN_total'      => new EE_Money_Field(
-                    'LIN_total',
-                    esc_html__('Total (unit price x quantity) after taxes', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'LIN_pretax'     => new EE_Money_Field(
-                    'LIN_pretax',
-                    esc_html__('Total (unit price x quantity) before taxes', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'LIN_quantity'   => new EE_Integer_Field(
-                    'LIN_quantity',
-                    esc_html__('Quantity', 'event_espresso'),
-                    false,
-                    1
-                ),
-                'LIN_parent'     => new EE_Integer_Field(
-                    'LIN_parent',
-                    esc_html__("Parent ID (this item goes towards that Line Item's total)", 'event_espresso'),
-                    true,
-                    null
-                ),
-                'LIN_type'       => new EE_Enum_Text_Field(
-                    'LIN_type',
-                    esc_html__('Type', 'event_espresso'),
-                    false,
-                    'line-item',
-                    [
-                        self::type_line_item     => esc_html__('Line Item', 'event_espresso'),
-                        self::type_sub_line_item => esc_html__('Sub-Item', 'event_espresso'),
-                        self::type_sub_tax       => esc_html__('Sub-Tax', 'event_espresso'),
-                        self::type_sub_total     => esc_html__('Subtotal', 'event_espresso'),
-                        self::type_tax_sub_total => esc_html__('Tax Subtotal', 'event_espresso'),
-                        self::type_tax           => esc_html__('Tax', 'event_espresso'),
-                        self::type_total         => esc_html__('Total', 'event_espresso'),
-                        self::type_cancellation  => esc_html__('Cancellation', 'event_espresso'),
-                    ]
-                ),
-                'OBJ_ID'         => new EE_Foreign_Key_Int_Field(
-                    'OBJ_ID',
-                    esc_html__('ID of Item purchased.', 'event_espresso'),
-                    true,
-                    null,
-                    $line_items_can_be_for
-                ),
-                'OBJ_type'       => new EE_Any_Foreign_Model_Name_Field(
-                    'OBJ_type',
-                    esc_html__('Model Name this Line Item is for', 'event_espresso'),
-                    true,
-                    null,
-                    $line_items_can_be_for
-                ),
-                'LIN_timestamp'  => new EE_Datetime_Field(
-                    'LIN_timestamp',
-                    esc_html__('When the line item was created', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-            ],
-        ];
-        $this->_model_relations        = [
-            'Transaction' => new EE_Belongs_To_Relation(),
-            'Ticket'      => new EE_Belongs_To_Any_Relation(),
-            'Price'       => new EE_Belongs_To_Any_Relation(),
-            'Event'       => new EE_Belongs_To_Any_Relation(),
-        ];
-        $this->_model_chain_to_wp_user = 'Transaction.Registration.Event';
-        $this->_caps_slug              = 'transactions';
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * Gets all the line items for this transaction of the given type
-     *
-     * @param string             $line_item_type like one of EEM_Line_Item::type_*
-     * @param EE_Transaction|int $transaction
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_all_of_type_for_transaction($line_item_type, $transaction)
-    {
-        $transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
-        return $this->get_all(
-            [
-                [
-                    'LIN_type' => $line_item_type,
-                    'TXN_ID'   => $transaction,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * Gets all line items unrelated to tickets that are normal line items
-     * (eg shipping, promotions, and miscellaneous other stuff should probably fit in this category)
-     *
-     * @param EE_Transaction|int $transaction
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_all_non_ticket_line_items_for_transaction($transaction)
-    {
-        $transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
-        return $this->get_all(
-            [
-                [
-                    'LIN_type' => self::type_line_item,
-                    'TXN_ID'   => $transaction,
-                    'OR'       => [
-                        'OBJ_type*notticket' => ['!=', EEM_Line_Item::OBJ_TYPE_TICKET],
-                        'OBJ_type*null'      => ['IS_NULL'],
-                    ],
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * Deletes line items with no transaction who have passed the transaction cutoff time.
-     * This needs to be very efficient
-     * because if there are spam bots afoot there will be LOTS of line items. Also MySQL doesn't allow a limit when
-     * deleting and joining tables like this.
-     *
-     * @return int count of how many deleted
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function delete_line_items_with_no_transaction()
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        $time_to_leave_alone = apply_filters(
-            'FHEE__EEM_Line_Item__delete_line_items_with_no_transaction__time_to_leave_alone',
-            WEEK_IN_SECONDS
-        );
-        $query               = $wpdb->prepare(
-            'DELETE li
+	/**
+	 * Tax sub-total is just the total of all the taxes, which should be children
+	 * of this line item. There should only ever be one tax sub-total, and it should
+	 * be a direct child of. Its quantity and LIN_unit_price = 1.
+	 */
+	const type_tax_sub_total = 'tax-sub-total';
+
+	/**
+	 * Tax line items indicate a tax applied to all the taxable line items.
+	 * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal
+	 * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1.
+	 */
+	const type_tax = 'tax';
+
+	/**
+	 * Indicating individual items purchased, or discounts or surcharges.
+	 * The sum of all the regular line items  plus the tax items should equal the grand total.
+	 * Possible children are sub-line-items and cancellations.
+	 * For flat items, LIN_unit_price * LIN_quantity = LIN_total. Its LIN_total is the sum of all the children
+	 * LIN_totals. Its LIN_percent = 0.
+	 * For percent items, its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal (eg 10% = 10, not 0.1).
+	 * Its LIN_total is LIN_percent / 100 * sum of lower-priority sibling line items. Quantity = 1.
+	 */
+	const type_line_item = 'line-item';
+
+	/**
+	 * Line item indicating all the factors that make a single line item.
+	 * Sub-line items should have NO children line items.
+	 * For flat sub-items, their quantity should match their parent item, their LIN_unit_price should be this sub-item's
+	 * contribution towards the price of ONE of their parent items, and its LIN_total should be
+	 *  = LIN_quantity * LIN_unit_price. Its LIN_percent = 0.
+	 * For percent sub-items, the quantity should be 1, LIN_unit_price should be 0, and its LIN_total should
+	 * = LIN_percent / 100 * sum of lower-priority sibling line items..
+	 */
+	const type_sub_line_item = 'sub-item';
+
+	/**
+	 * SubTax line items indicate a tax that is only applied to the pre-tax total of their parent line item.
+	 * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal
+	 * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1.
+	 */
+	const type_sub_tax = 'sub-tax';
+
+	/**
+	 * Line item indicating a sub-total (eg total for an event, or pre-tax subtotal).
+	 * Direct children should be event subtotals.
+	 * Should have quantity of 1, and a LIN_total and LIN_unit_price of the sum of all its sub-items' LIN_totals.
+	 */
+	const type_sub_total = 'sub-total';
+
+	/**
+	 * Line item for the grand total of an order.
+	 * Its direct children should be tax subtotals and (pre-tax) subtotals,
+	 * and possibly a regular line item indicating a transaction-wide discount/surcharge.
+	 * Should have a quantity of 1, a LIN_total and LIN_unit_price of the entire order's amount.
+	 */
+	const type_total = 'total';
+
+	/**
+	 * When a line item is cancelled, a sub-line-item of type 'cancellation'
+	 * should be created, indicating the quantity that were cancelled
+	 * (because a line item could have a quantity of 1, and its cancellation item
+	 * could be for 3, indicating that originally 4 were purchased, but 3 have been
+	 * cancelled, and only one remains).
+	 * When items are refunded, a cancellation line item should be made, which points
+	 * to teh payment model object which actually refunded the payment.
+	 * Cancellations should NOT have any children line items; the should NOT affect
+	 * any calculations, and are only meant as a record that cancellations have occurred.
+	 * Their LIN_percent should be 0.
+	 */
+	const type_cancellation = 'cancellation';
+
+	// various line item object types
+	const OBJ_TYPE_EVENT       = 'Event';
+
+	const OBJ_TYPE_PRICE       = 'Price';
+
+	const OBJ_TYPE_PROMOTION   = 'Promotion';
+
+	const OBJ_TYPE_TICKET      = 'Ticket';
+
+	const OBJ_TYPE_TRANSACTION = 'Transaction';
+
+	/**
+	 * @var EEM_Line_Item $_instance
+	 */
+	protected static $_instance;
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param string|null $timezone string representing the timezone we want to set for returned Date Time Strings
+	 *                              (and any incoming timezone data that gets saved).
+	 *                              Note this just sends the timezone info to the date time model field objects.
+	 *                              Default is NULL
+	 *                              (and will be assumed using the set timezone in the 'timezone_string' wp option)
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Line Item', 'event_espresso');
+		$this->plural_item   = esc_html__('Line Items', 'event_espresso');
+
+		$this->_tables                 = [
+			'Line_Item' => new EE_Primary_Table('esp_line_item', 'LIN_ID'),
+		];
+		$line_items_can_be_for         = apply_filters(
+			'FHEE__EEM_Line_Item__line_items_can_be_for',
+			['Ticket', 'Price', 'Event']
+		);
+		$this->_fields                 = [
+			'Line_Item' => [
+				'LIN_ID'         => new EE_Primary_Key_Int_Field(
+					'LIN_ID',
+					esc_html__('ID', 'event_espresso')
+				),
+				'LIN_code'       => new EE_Slug_Field(
+					'LIN_code',
+					esc_html__('Code for index into Cart', 'event_espresso'),
+					true
+				),
+				'TXN_ID'         => new EE_Foreign_Key_Int_Field(
+					'TXN_ID',
+					esc_html__('Transaction ID', 'event_espresso'),
+					true,
+					null,
+					'Transaction'
+				),
+				'LIN_name'       => new EE_Full_HTML_Field(
+					'LIN_name',
+					esc_html__('Line Item Name', 'event_espresso'),
+					false,
+					''
+				),
+				'LIN_desc'       => new EE_Full_HTML_Field(
+					'LIN_desc',
+					esc_html__('Line Item Description', 'event_espresso'),
+					true
+				),
+				'LIN_unit_price' => new EE_Money_Field(
+					'LIN_unit_price',
+					esc_html__('Unit Price', 'event_espresso'),
+					false,
+					0
+				),
+				'LIN_percent'    => new EE_Float_Field(
+					'LIN_percent',
+					esc_html__('Percent', 'event_espresso'),
+					false,
+					0
+				),
+				'LIN_is_taxable' => new EE_Boolean_Field(
+					'LIN_is_taxable',
+					esc_html__('Taxable', 'event_espresso'),
+					false,
+					false
+				),
+				'LIN_order'      => new EE_Integer_Field(
+					'LIN_order',
+					esc_html__('Order of Application towards total of parent', 'event_espresso'),
+					false,
+					1
+				),
+				'LIN_total'      => new EE_Money_Field(
+					'LIN_total',
+					esc_html__('Total (unit price x quantity) after taxes', 'event_espresso'),
+					false,
+					0
+				),
+				'LIN_pretax'     => new EE_Money_Field(
+					'LIN_pretax',
+					esc_html__('Total (unit price x quantity) before taxes', 'event_espresso'),
+					false,
+					0
+				),
+				'LIN_quantity'   => new EE_Integer_Field(
+					'LIN_quantity',
+					esc_html__('Quantity', 'event_espresso'),
+					false,
+					1
+				),
+				'LIN_parent'     => new EE_Integer_Field(
+					'LIN_parent',
+					esc_html__("Parent ID (this item goes towards that Line Item's total)", 'event_espresso'),
+					true,
+					null
+				),
+				'LIN_type'       => new EE_Enum_Text_Field(
+					'LIN_type',
+					esc_html__('Type', 'event_espresso'),
+					false,
+					'line-item',
+					[
+						self::type_line_item     => esc_html__('Line Item', 'event_espresso'),
+						self::type_sub_line_item => esc_html__('Sub-Item', 'event_espresso'),
+						self::type_sub_tax       => esc_html__('Sub-Tax', 'event_espresso'),
+						self::type_sub_total     => esc_html__('Subtotal', 'event_espresso'),
+						self::type_tax_sub_total => esc_html__('Tax Subtotal', 'event_espresso'),
+						self::type_tax           => esc_html__('Tax', 'event_espresso'),
+						self::type_total         => esc_html__('Total', 'event_espresso'),
+						self::type_cancellation  => esc_html__('Cancellation', 'event_espresso'),
+					]
+				),
+				'OBJ_ID'         => new EE_Foreign_Key_Int_Field(
+					'OBJ_ID',
+					esc_html__('ID of Item purchased.', 'event_espresso'),
+					true,
+					null,
+					$line_items_can_be_for
+				),
+				'OBJ_type'       => new EE_Any_Foreign_Model_Name_Field(
+					'OBJ_type',
+					esc_html__('Model Name this Line Item is for', 'event_espresso'),
+					true,
+					null,
+					$line_items_can_be_for
+				),
+				'LIN_timestamp'  => new EE_Datetime_Field(
+					'LIN_timestamp',
+					esc_html__('When the line item was created', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+			],
+		];
+		$this->_model_relations        = [
+			'Transaction' => new EE_Belongs_To_Relation(),
+			'Ticket'      => new EE_Belongs_To_Any_Relation(),
+			'Price'       => new EE_Belongs_To_Any_Relation(),
+			'Event'       => new EE_Belongs_To_Any_Relation(),
+		];
+		$this->_model_chain_to_wp_user = 'Transaction.Registration.Event';
+		$this->_caps_slug              = 'transactions';
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * Gets all the line items for this transaction of the given type
+	 *
+	 * @param string             $line_item_type like one of EEM_Line_Item::type_*
+	 * @param EE_Transaction|int $transaction
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_all_of_type_for_transaction($line_item_type, $transaction)
+	{
+		$transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
+		return $this->get_all(
+			[
+				[
+					'LIN_type' => $line_item_type,
+					'TXN_ID'   => $transaction,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * Gets all line items unrelated to tickets that are normal line items
+	 * (eg shipping, promotions, and miscellaneous other stuff should probably fit in this category)
+	 *
+	 * @param EE_Transaction|int $transaction
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_all_non_ticket_line_items_for_transaction($transaction)
+	{
+		$transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
+		return $this->get_all(
+			[
+				[
+					'LIN_type' => self::type_line_item,
+					'TXN_ID'   => $transaction,
+					'OR'       => [
+						'OBJ_type*notticket' => ['!=', EEM_Line_Item::OBJ_TYPE_TICKET],
+						'OBJ_type*null'      => ['IS_NULL'],
+					],
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * Deletes line items with no transaction who have passed the transaction cutoff time.
+	 * This needs to be very efficient
+	 * because if there are spam bots afoot there will be LOTS of line items. Also MySQL doesn't allow a limit when
+	 * deleting and joining tables like this.
+	 *
+	 * @return int count of how many deleted
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function delete_line_items_with_no_transaction()
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		$time_to_leave_alone = apply_filters(
+			'FHEE__EEM_Line_Item__delete_line_items_with_no_transaction__time_to_leave_alone',
+			WEEK_IN_SECONDS
+		);
+		$query               = $wpdb->prepare(
+			'DELETE li
 				FROM ' . $this->table() . ' li
 				LEFT JOIN ' . EEM_Transaction::instance()->table() . ' t ON li.TXN_ID = t.TXN_ID
 				WHERE t.TXN_ID IS NULL AND li.LIN_timestamp < %s',
-            // use GMT time because that's what TXN_timestamps are in
-            date('Y-m-d H:i:s', time() - $time_to_leave_alone)
-        );
-        return $wpdb->query($query);
-    }
-
-
-    /**
-     * get_line_item_for_transaction_object
-     * Gets a transaction's line item record for a specific object such as a EE_Event or EE_Ticket
-     *
-     * @param int           $TXN_ID
-     * @param EE_Base_Class $object
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_line_item_for_transaction_object($TXN_ID, EE_Base_Class $object)
-    {
-        return $this->get_all(
-            [
-                [
-                    'TXN_ID'   => $TXN_ID,
-                    'OBJ_type' => str_replace('EE_', '', get_class($object)),
-                    'OBJ_ID'   => $object->ID(),
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * get_object_line_items_for_transaction
-     * Gets all of the the object line items for a transaction, based on an object type plus an array of object IDs
-     *
-     * @param int    $TXN_ID
-     * @param string $OBJ_type
-     * @param array  $OBJ_IDs
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     */
-    public function get_object_line_items_for_transaction(
-        $TXN_ID,
-        $OBJ_type = EEM_Line_Item::OBJ_TYPE_EVENT,
-        $OBJ_IDs = []
-    ) {
-        $query_params = [
-            'OBJ_type' => $OBJ_type,
-            // if incoming $OBJ_IDs is an array, then make sure it is formatted correctly for the query
-            'OBJ_ID'   => is_array($OBJ_IDs) && ! isset($OBJ_IDs['IN']) ? ['IN', $OBJ_IDs] : $OBJ_IDs,
-        ];
-        if ($TXN_ID) {
-            $query_params['TXN_ID'] = $TXN_ID;
-        }
-        return $this->get_all([$query_params]);
-    }
-
-
-    /**
-     * get_all_ticket_line_items_for_transaction
-     *
-     * @param EE_Transaction $transaction
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_all_ticket_line_items_for_transaction(EE_Transaction $transaction)
-    {
-        return $this->get_all(
-            [
-                [
-                    'TXN_ID'   => $transaction->ID(),
-                    'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * get_ticket_line_item_for_transaction
-     *
-     * @param int $TXN_ID
-     * @param int $TKT_ID
-     * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_ticket_line_item_for_transaction($TXN_ID, $TKT_ID)
-    {
-        return $this->get_one(
-            [
-                [
-                    'TXN_ID'   => EEM_Transaction::instance()->ensure_is_ID($TXN_ID),
-                    'OBJ_ID'   => $TKT_ID,
-                    'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * get_existing_promotion_line_item
-     * searches the cart for existing line items for the specified promotion
-     *
-     * @param EE_Line_Item $parent_line_item
-     * @param EE_Promotion $promotion
-     * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 1.0.0
-     */
-    public function get_existing_promotion_line_item(EE_Line_Item $parent_line_item, EE_Promotion $promotion)
-    {
-        return $this->get_one(
-            [
-                [
-                    'TXN_ID'     => $parent_line_item->TXN_ID(),
-                    'LIN_parent' => $parent_line_item->ID(),
-                    'OBJ_type'   => EEM_Line_Item::OBJ_TYPE_PROMOTION,
-                    'OBJ_ID'     => $promotion->ID(),
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * get_all_promotion_line_items
-     * searches the cart for any and all existing promotion line items
-     *
-     * @param EE_Line_Item $parent_line_item
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since   1.0.0
-     */
-    public function get_all_promotion_line_items(EE_Line_Item $parent_line_item)
-    {
-        return $this->get_all(
-            [
-                [
-                    'TXN_ID'     => $parent_line_item->TXN_ID(),
-                    'LIN_parent' => $parent_line_item->ID(),
-                    'OBJ_type'   => EEM_Line_Item::OBJ_TYPE_PROMOTION,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * Gets the registration's corresponding line item.
-     * Note: basically does NOT support having multiple line items for a single ticket,
-     * which would happen if some of the registrations had a price modifier while others didn't.
-     * In order to support that, we'd probably need a LIN_ID on registrations or something.
-     *
-     * @param EE_Registration $registration
-     * @return EE_Base_Class|EE_Line_ITem|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     */
-    public function get_line_item_for_registration(EE_Registration $registration)
-    {
-        return $this->get_one($this->line_item_for_registration_query_params($registration));
-    }
-
-
-    /**
-     * Gets the query params used to retrieve a specific line item for the given registration
-     *
-     * @param EE_Registration $registration
-     * @param array           $original_query_params any extra query params you'd like to be merged with
-     * @return array @see
-     *                                               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @throws EE_Error
-     */
-    public function line_item_for_registration_query_params(
-        EE_Registration $registration,
-        $original_query_params = []
-    ) {
-        return array_replace_recursive(
-            $original_query_params,
-            [
-                [
-                    'OBJ_ID'   => $registration->ticket_ID(),
-                    'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
-                    'TXN_ID'   => $registration->transaction_ID(),
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public function get_total_line_items_with_no_transaction()
-    {
-        return $this->get_total_line_items_for_carts();
-    }
-
-
-    /**
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public function get_total_line_items_for_active_carts()
-    {
-        return $this->get_total_line_items_for_carts(false);
-    }
-
-
-    /**
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public function get_total_line_items_for_expired_carts()
-    {
-        return $this->get_total_line_items_for_carts(true);
-    }
-
-
-    /**
-     * Returns an array of grand total line items where the TXN_ID is 0.
-     * If $expired is set to true, then only line items for expired sessions will be returned.
-     * If $expired is set to false, then only line items for active sessions will be returned.
-     *
-     * @param null $expired
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function get_total_line_items_for_carts($expired = null)
-    {
-        $where_params = [
-            'TXN_ID'   => 0,
-            'LIN_type' => 'total',
-        ];
-        if ($expired !== null) {
-            /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
-            $session_lifespan              = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\values\session\SessionLifespan'
-            );
-            $where_params['LIN_timestamp'] = [
-                $expired ? '<=' : '>',
-                $session_lifespan->expiration(),
-            ];
-        }
-        return $this->get_all([$where_params]);
-    }
-
-
-    /**
-     * Returns an array of ticket total line items where the TXN_ID is 0
-     * AND the timestamp is older than the session lifespan.
-     *
-     * @param int $timestamp
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function getTicketLineItemsForExpiredCarts($timestamp = 0)
-    {
-        if (! absint($timestamp)) {
-            /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
-            $session_lifespan = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\values\session\SessionLifespan'
-            );
-            $timestamp        = $session_lifespan->expiration();
-        }
-        return $this->get_all(
-            [
-                [
-                    'TXN_ID'        => 0,
-                    'OBJ_type'      => EEM_Line_Item::OBJ_TYPE_TICKET,
-                    'LIN_timestamp' => ['<=', $timestamp],
-                ],
-            ]
-        );
-    }
+			// use GMT time because that's what TXN_timestamps are in
+			date('Y-m-d H:i:s', time() - $time_to_leave_alone)
+		);
+		return $wpdb->query($query);
+	}
+
+
+	/**
+	 * get_line_item_for_transaction_object
+	 * Gets a transaction's line item record for a specific object such as a EE_Event or EE_Ticket
+	 *
+	 * @param int           $TXN_ID
+	 * @param EE_Base_Class $object
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_line_item_for_transaction_object($TXN_ID, EE_Base_Class $object)
+	{
+		return $this->get_all(
+			[
+				[
+					'TXN_ID'   => $TXN_ID,
+					'OBJ_type' => str_replace('EE_', '', get_class($object)),
+					'OBJ_ID'   => $object->ID(),
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * get_object_line_items_for_transaction
+	 * Gets all of the the object line items for a transaction, based on an object type plus an array of object IDs
+	 *
+	 * @param int    $TXN_ID
+	 * @param string $OBJ_type
+	 * @param array  $OBJ_IDs
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 */
+	public function get_object_line_items_for_transaction(
+		$TXN_ID,
+		$OBJ_type = EEM_Line_Item::OBJ_TYPE_EVENT,
+		$OBJ_IDs = []
+	) {
+		$query_params = [
+			'OBJ_type' => $OBJ_type,
+			// if incoming $OBJ_IDs is an array, then make sure it is formatted correctly for the query
+			'OBJ_ID'   => is_array($OBJ_IDs) && ! isset($OBJ_IDs['IN']) ? ['IN', $OBJ_IDs] : $OBJ_IDs,
+		];
+		if ($TXN_ID) {
+			$query_params['TXN_ID'] = $TXN_ID;
+		}
+		return $this->get_all([$query_params]);
+	}
+
+
+	/**
+	 * get_all_ticket_line_items_for_transaction
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_all_ticket_line_items_for_transaction(EE_Transaction $transaction)
+	{
+		return $this->get_all(
+			[
+				[
+					'TXN_ID'   => $transaction->ID(),
+					'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * get_ticket_line_item_for_transaction
+	 *
+	 * @param int $TXN_ID
+	 * @param int $TKT_ID
+	 * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_ticket_line_item_for_transaction($TXN_ID, $TKT_ID)
+	{
+		return $this->get_one(
+			[
+				[
+					'TXN_ID'   => EEM_Transaction::instance()->ensure_is_ID($TXN_ID),
+					'OBJ_ID'   => $TKT_ID,
+					'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * get_existing_promotion_line_item
+	 * searches the cart for existing line items for the specified promotion
+	 *
+	 * @param EE_Line_Item $parent_line_item
+	 * @param EE_Promotion $promotion
+	 * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 1.0.0
+	 */
+	public function get_existing_promotion_line_item(EE_Line_Item $parent_line_item, EE_Promotion $promotion)
+	{
+		return $this->get_one(
+			[
+				[
+					'TXN_ID'     => $parent_line_item->TXN_ID(),
+					'LIN_parent' => $parent_line_item->ID(),
+					'OBJ_type'   => EEM_Line_Item::OBJ_TYPE_PROMOTION,
+					'OBJ_ID'     => $promotion->ID(),
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * get_all_promotion_line_items
+	 * searches the cart for any and all existing promotion line items
+	 *
+	 * @param EE_Line_Item $parent_line_item
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since   1.0.0
+	 */
+	public function get_all_promotion_line_items(EE_Line_Item $parent_line_item)
+	{
+		return $this->get_all(
+			[
+				[
+					'TXN_ID'     => $parent_line_item->TXN_ID(),
+					'LIN_parent' => $parent_line_item->ID(),
+					'OBJ_type'   => EEM_Line_Item::OBJ_TYPE_PROMOTION,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * Gets the registration's corresponding line item.
+	 * Note: basically does NOT support having multiple line items for a single ticket,
+	 * which would happen if some of the registrations had a price modifier while others didn't.
+	 * In order to support that, we'd probably need a LIN_ID on registrations or something.
+	 *
+	 * @param EE_Registration $registration
+	 * @return EE_Base_Class|EE_Line_ITem|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 */
+	public function get_line_item_for_registration(EE_Registration $registration)
+	{
+		return $this->get_one($this->line_item_for_registration_query_params($registration));
+	}
+
+
+	/**
+	 * Gets the query params used to retrieve a specific line item for the given registration
+	 *
+	 * @param EE_Registration $registration
+	 * @param array           $original_query_params any extra query params you'd like to be merged with
+	 * @return array @see
+	 *                                               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @throws EE_Error
+	 */
+	public function line_item_for_registration_query_params(
+		EE_Registration $registration,
+		$original_query_params = []
+	) {
+		return array_replace_recursive(
+			$original_query_params,
+			[
+				[
+					'OBJ_ID'   => $registration->ticket_ID(),
+					'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
+					'TXN_ID'   => $registration->transaction_ID(),
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public function get_total_line_items_with_no_transaction()
+	{
+		return $this->get_total_line_items_for_carts();
+	}
+
+
+	/**
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public function get_total_line_items_for_active_carts()
+	{
+		return $this->get_total_line_items_for_carts(false);
+	}
+
+
+	/**
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public function get_total_line_items_for_expired_carts()
+	{
+		return $this->get_total_line_items_for_carts(true);
+	}
+
+
+	/**
+	 * Returns an array of grand total line items where the TXN_ID is 0.
+	 * If $expired is set to true, then only line items for expired sessions will be returned.
+	 * If $expired is set to false, then only line items for active sessions will be returned.
+	 *
+	 * @param null $expired
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function get_total_line_items_for_carts($expired = null)
+	{
+		$where_params = [
+			'TXN_ID'   => 0,
+			'LIN_type' => 'total',
+		];
+		if ($expired !== null) {
+			/** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
+			$session_lifespan              = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\values\session\SessionLifespan'
+			);
+			$where_params['LIN_timestamp'] = [
+				$expired ? '<=' : '>',
+				$session_lifespan->expiration(),
+			];
+		}
+		return $this->get_all([$where_params]);
+	}
+
+
+	/**
+	 * Returns an array of ticket total line items where the TXN_ID is 0
+	 * AND the timestamp is older than the session lifespan.
+	 *
+	 * @param int $timestamp
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function getTicketLineItemsForExpiredCarts($timestamp = 0)
+	{
+		if (! absint($timestamp)) {
+			/** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
+			$session_lifespan = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\values\session\SessionLifespan'
+			);
+			$timestamp        = $session_lifespan->expiration();
+		}
+		return $this->get_all(
+			[
+				[
+					'TXN_ID'        => 0,
+					'OBJ_type'      => EEM_Line_Item::OBJ_TYPE_TICKET,
+					'LIN_timestamp' => ['<=', $timestamp],
+				],
+			]
+		);
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -139,7 +139,7 @@ 
             'FHEE__EEM_Line_Item__line_items_can_be_for',
             ['Ticket', 'Price', 'Event']
         );
-        $this->_fields                 = [
+        $this->_fields = [
             'Line_Item' => [
                 'LIN_ID'         => new EE_Primary_Key_Int_Field(
                     'LIN_ID',
@@ -255,7 +255,7 @@ 
                 ),
             ],
         ];
-        $this->_model_relations        = [
+        $this->_model_relations = [
             'Transaction' => new EE_Belongs_To_Relation(),
             'Ticket'      => new EE_Belongs_To_Any_Relation(),
             'Price'       => new EE_Belongs_To_Any_Relation(),
@@ -341,10 +341,10 @@ 
             'FHEE__EEM_Line_Item__delete_line_items_with_no_transaction__time_to_leave_alone',
             WEEK_IN_SECONDS
         );
-        $query               = $wpdb->prepare(
+        $query = $wpdb->prepare(
             'DELETE li
-				FROM ' . $this->table() . ' li
-				LEFT JOIN ' . EEM_Transaction::instance()->table() . ' t ON li.TXN_ID = t.TXN_ID
+				FROM ' . $this->table().' li
+				LEFT JOIN ' . EEM_Transaction::instance()->table().' t ON li.TXN_ID = t.TXN_ID
 				WHERE t.TXN_ID IS NULL AND li.LIN_timestamp < %s',
             // use GMT time because that's what TXN_timestamps are in
             date('Y-m-d H:i:s', time() - $time_to_leave_alone)
@@ -638,7 +638,7 @@ 
      */
     public function getTicketLineItemsForExpiredCarts($timestamp = 0)
     {
-        if (! absint($timestamp)) {
+        if ( ! absint($timestamp)) {
             /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
             $session_lifespan = LoaderFactory::getLoader()->getShared(
                 'EventEspresso\core\domain\values\session\SessionLifespan'

core/db_models/EEM_Question_Group_Question.model.php

Indentation +59 added lines, -59 removed lines

@@ -13,68 +13,68 @@
  */
 class EEM_Question_Group_Question extends EEM_Base
 {
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
 
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item    = esc_html__('Question Group to Question Link', 'event_espresso');
-        $this->plural_item      = esc_html__('Question Group to Question Links', 'event_espresso');
-        $this->_tables          = [
-            'Question_Group_Question' => new EE_Primary_Table('esp_question_group_question', 'QGQ_ID'),
-        ];
-        $this->_fields          = [
-            'Question_Group_Question' => [
-                'QGQ_ID'    => new EE_Primary_Key_Int_Field(
-                    'QGQ_ID',
-                    esc_html__('Question Group to Question Link ID', 'event_espresso')
-                ),
-                'QSG_ID'    => new EE_Foreign_Key_Int_Field(
-                    'QSG_ID',
-                    esc_html__('Question Group ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Question_Group'
-                ),
-                'QST_ID'    => new EE_Foreign_Key_Int_Field(
-                    'QST_ID',
-                    esc_html__('Question Id', 'event_espresso'),
-                    false,
-                    0,
-                    'Question'
-                ),
-                'QGQ_order' => new EE_Integer_Field(
-                    'QGQ_order',
-                    esc_html__('Question Group Question Order', 'event_espresso'),
-                    false,
-                    0
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Question_Group' => new EE_Belongs_To_Relation(),
-            'Question'       => new EE_Belongs_To_Relation(),
-        ];
+	/**
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item    = esc_html__('Question Group to Question Link', 'event_espresso');
+		$this->plural_item      = esc_html__('Question Group to Question Links', 'event_espresso');
+		$this->_tables          = [
+			'Question_Group_Question' => new EE_Primary_Table('esp_question_group_question', 'QGQ_ID'),
+		];
+		$this->_fields          = [
+			'Question_Group_Question' => [
+				'QGQ_ID'    => new EE_Primary_Key_Int_Field(
+					'QGQ_ID',
+					esc_html__('Question Group to Question Link ID', 'event_espresso')
+				),
+				'QSG_ID'    => new EE_Foreign_Key_Int_Field(
+					'QSG_ID',
+					esc_html__('Question Group ID', 'event_espresso'),
+					false,
+					0,
+					'Question_Group'
+				),
+				'QST_ID'    => new EE_Foreign_Key_Int_Field(
+					'QST_ID',
+					esc_html__('Question Id', 'event_espresso'),
+					false,
+					0,
+					'Question'
+				),
+				'QGQ_order' => new EE_Integer_Field(
+					'QGQ_order',
+					esc_html__('Question Group Question Order', 'event_espresso'),
+					false,
+					0
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Question_Group' => new EE_Belongs_To_Relation(),
+			'Question'       => new EE_Belongs_To_Relation(),
+		];
 
-        $this->_model_chain_to_wp_user = 'Question_Group';
+		$this->_model_chain_to_wp_user = 'Question_Group';
 
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
-            new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
-            new EE_Restriction_Generator_Reg_Form('Question_Group.QSG_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
-            new EE_Restriction_Generator_Reg_Form('Question_Group.QSG_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
-            new EE_Restriction_Generator_Reg_Form('Question_Group.QSG_system');
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
+			new EE_Restriction_Generator_Public();
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+			new EE_Restriction_Generator_Reg_Form('Question_Group.QSG_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+			new EE_Restriction_Generator_Reg_Form('Question_Group.QSG_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+			new EE_Restriction_Generator_Reg_Form('Question_Group.QSG_system');
 
-        // use the caps for question groups
-        $this->_caps_slug = 'question_groups';
-        parent::__construct($timezone);
-    }
+		// use the caps for question groups
+		$this->_caps_slug = 'question_groups';
+		parent::__construct($timezone);
+	}
 }

core/db_models/EEM_Venue.model.php

Indentation +196 added lines, -196 removed lines

@@ -10,202 +10,202 @@
  */
 class EEM_Venue extends EEM_CPT_Base
 {
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
 
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item    = esc_html__('Venue', 'event_espresso');
-        $this->plural_item      = esc_html__('Venues', 'event_espresso');
-        $this->_tables          = [
-            'Venue_CPT'  => new EE_Primary_Table('posts', 'ID'),
-            'Venue_Meta' => new EE_Secondary_Table('esp_venue_meta', 'VNUM_ID', 'VNU_ID'),
-        ];
-        $this->_fields          = [
-            'Venue_CPT'  => [
-                'VNU_ID'         => new EE_Primary_Key_Int_Field('ID', esc_html__("Venue ID", "event_espresso")),
-                'VNU_name'       => new EE_Plain_Text_Field(
-                    'post_title',
-                    esc_html__("Venue Name", "event_espresso"),
-                    false,
-                    ''
-                ),
-                'VNU_desc'       => new EE_Post_Content_Field(
-                    'post_content',
-                    esc_html__("Venue Description", "event_espresso"),
-                    false,
-                    ''
-                ),
-                'VNU_identifier' => new EE_Slug_Field(
-                    'post_name',
-                    esc_html__("Venue Identifier", "event_espresso"),
-                    false,
-                    ''
-                ),
-                'VNU_created'    => new EE_Datetime_Field(
-                    'post_date',
-                    esc_html__("Date Venue Created", "event_espresso"),
-                    false,
-                    EE_Datetime_Field::now
-                ),
-                'VNU_short_desc' => new EE_Plain_Text_Field(
-                    'post_excerpt',
-                    esc_html__("Short Description of Venue", "event_espresso"),
-                    true,
-                    ''
-                ),
-                'VNU_modified'   => new EE_Datetime_Field(
-                    'post_modified',
-                    esc_html__("Venue Modified Date", "event_espresso"),
-                    false,
-                    EE_Datetime_Field::now
-                ),
-                'VNU_wp_user'    => new EE_WP_User_Field(
-                    'post_author',
-                    esc_html__("Venue Creator ID", "event_espresso"),
-                    false
-                ),
-                'parent'         => new EE_Integer_Field(
-                    'post_parent',
-                    esc_html__("Venue Parent ID", "event_espresso"),
-                    false,
-                    0
-                ),
-                'VNU_order'      => new EE_Integer_Field(
-                    'menu_order',
-                    esc_html__("Venue order", "event_espresso"),
-                    false,
-                    1
-                ),
-                'post_type'      => new EE_WP_Post_Type_Field('espresso_venues'),
-                'password'       => new EE_Password_Field(
-                    'post_password',
-                    esc_html__('Password', 'event_espresso'),
-                    false,
-                    '',
-                    [
-                        'VNU_desc',
-                        'VNU_short_desc',
-                        'VNU_address',
-                        'VNU_address2',
-                        'VNU_city',
-                        'STA_ID',
-                        'CNT_ISO',
-                        'VNU_zip',
-                        'VNU_phone',
-                        'VNU_capacity',
-                        'VNU_url',
-                        'VNU_virtual_phone',
-                        'VNU_virtual_url',
-                        'VNU_google_map_link',
-                        'VNU_enable_for_gmap',
-                    ]
-                ),
-            ],
-            'Venue_Meta' => [
-                'VNUM_ID'             => new EE_DB_Only_Int_Field(
-                    'VNUM_ID',
-                    esc_html__("ID of Venue Meta Row", "event_espresso"),
-                    false
-                ),
-                'VNU_ID_fk'           => new EE_DB_Only_Int_Field(
-                    'VNU_ID',
-                    esc_html__("Foreign Key to Venue Post ", "event_espresso"),
-                    false
-                ),
-                'VNU_address'         => new EE_Plain_Text_Field(
-                    'VNU_address',
-                    esc_html__("Venue Address line 1", "event_espresso"),
-                    true,
-                    ''
-                ),
-                'VNU_address2'        => new EE_Plain_Text_Field(
-                    'VNU_address2',
-                    esc_html__("Venue Address line 2", "event_espresso"),
-                    true,
-                    ''
-                ),
-                'VNU_city'            => new EE_Plain_Text_Field(
-                    'VNU_city',
-                    esc_html__("Venue City", "event_espresso"),
-                    true,
-                    ''
-                ),
-                'STA_ID'              => new EE_Foreign_Key_Int_Field(
-                    'STA_ID',
-                    esc_html__("State ID", "event_espresso"),
-                    true,
-                    null,
-                    'State'
-                ),
-                'CNT_ISO'             => new EE_Foreign_Key_String_Field(
-                    'CNT_ISO',
-                    esc_html__("Country Code", "event_espresso"),
-                    true,
-                    null,
-                    'Country'
-                ),
-                'VNU_zip'             => new EE_Plain_Text_Field(
-                    'VNU_zip',
-                    esc_html__("Venue Zip/Postal Code", "event_espresso"),
-                    true
-                ),
-                'VNU_phone'           => new EE_Plain_Text_Field(
-                    'VNU_phone',
-                    esc_html__("Venue Phone", "event_espresso"),
-                    true
-                ),
-                'VNU_capacity'        => new EE_Infinite_Integer_Field(
-                    'VNU_capacity',
-                    esc_html__("Venue Capacity", "event_espresso"),
-                    true,
-                    EE_INF
-                ),
-                'VNU_url'             => new EE_Plain_Text_Field(
-                    'VNU_url',
-                    esc_html__('Venue Website', 'event_espresso'),
-                    true
-                ),
-                'VNU_virtual_phone'   => new EE_Plain_Text_Field(
-                    'VNU_virtual_phone',
-                    esc_html__('Call in Number', 'event_espresso'),
-                    true
-                ),
-                'VNU_virtual_url'     => new EE_Plain_Text_Field(
-                    'VNU_virtual_url',
-                    esc_html__('Virtual URL', 'event_espresso'),
-                    true
-                ),
-                'VNU_google_map_link' => new EE_Plain_Text_Field(
-                    'VNU_google_map_link',
-                    esc_html__('Google Map Link', 'event_espresso'),
-                    true
-                ),
-                'VNU_enable_for_gmap' => new EE_Boolean_Field(
-                    'VNU_enable_for_gmap',
-                    esc_html__('Show Google Map?', 'event_espresso'),
-                    false,
-                    false
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Country'           => new EE_Belongs_To_Relation(),
-            'Event'             => new EE_Has_Many_Relation(),
-            'Datetime'          => new EE_Has_Many_Relation(),
-            'State'             => new EE_Belongs_To_Relation(),
-            'Term_Relationship' => new EE_Has_Many_Relation(),
-            'Term_Taxonomy'     => new EE_HABTM_Relation('Term_Relationship'),
-            'WP_User'           => new EE_Belongs_To_Relation(),
-        ];
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        $this->model_chain_to_password                            = '';
-        parent::__construct($timezone);
-    }
+	/**
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item    = esc_html__('Venue', 'event_espresso');
+		$this->plural_item      = esc_html__('Venues', 'event_espresso');
+		$this->_tables          = [
+			'Venue_CPT'  => new EE_Primary_Table('posts', 'ID'),
+			'Venue_Meta' => new EE_Secondary_Table('esp_venue_meta', 'VNUM_ID', 'VNU_ID'),
+		];
+		$this->_fields          = [
+			'Venue_CPT'  => [
+				'VNU_ID'         => new EE_Primary_Key_Int_Field('ID', esc_html__("Venue ID", "event_espresso")),
+				'VNU_name'       => new EE_Plain_Text_Field(
+					'post_title',
+					esc_html__("Venue Name", "event_espresso"),
+					false,
+					''
+				),
+				'VNU_desc'       => new EE_Post_Content_Field(
+					'post_content',
+					esc_html__("Venue Description", "event_espresso"),
+					false,
+					''
+				),
+				'VNU_identifier' => new EE_Slug_Field(
+					'post_name',
+					esc_html__("Venue Identifier", "event_espresso"),
+					false,
+					''
+				),
+				'VNU_created'    => new EE_Datetime_Field(
+					'post_date',
+					esc_html__("Date Venue Created", "event_espresso"),
+					false,
+					EE_Datetime_Field::now
+				),
+				'VNU_short_desc' => new EE_Plain_Text_Field(
+					'post_excerpt',
+					esc_html__("Short Description of Venue", "event_espresso"),
+					true,
+					''
+				),
+				'VNU_modified'   => new EE_Datetime_Field(
+					'post_modified',
+					esc_html__("Venue Modified Date", "event_espresso"),
+					false,
+					EE_Datetime_Field::now
+				),
+				'VNU_wp_user'    => new EE_WP_User_Field(
+					'post_author',
+					esc_html__("Venue Creator ID", "event_espresso"),
+					false
+				),
+				'parent'         => new EE_Integer_Field(
+					'post_parent',
+					esc_html__("Venue Parent ID", "event_espresso"),
+					false,
+					0
+				),
+				'VNU_order'      => new EE_Integer_Field(
+					'menu_order',
+					esc_html__("Venue order", "event_espresso"),
+					false,
+					1
+				),
+				'post_type'      => new EE_WP_Post_Type_Field('espresso_venues'),
+				'password'       => new EE_Password_Field(
+					'post_password',
+					esc_html__('Password', 'event_espresso'),
+					false,
+					'',
+					[
+						'VNU_desc',
+						'VNU_short_desc',
+						'VNU_address',
+						'VNU_address2',
+						'VNU_city',
+						'STA_ID',
+						'CNT_ISO',
+						'VNU_zip',
+						'VNU_phone',
+						'VNU_capacity',
+						'VNU_url',
+						'VNU_virtual_phone',
+						'VNU_virtual_url',
+						'VNU_google_map_link',
+						'VNU_enable_for_gmap',
+					]
+				),
+			],
+			'Venue_Meta' => [
+				'VNUM_ID'             => new EE_DB_Only_Int_Field(
+					'VNUM_ID',
+					esc_html__("ID of Venue Meta Row", "event_espresso"),
+					false
+				),
+				'VNU_ID_fk'           => new EE_DB_Only_Int_Field(
+					'VNU_ID',
+					esc_html__("Foreign Key to Venue Post ", "event_espresso"),
+					false
+				),
+				'VNU_address'         => new EE_Plain_Text_Field(
+					'VNU_address',
+					esc_html__("Venue Address line 1", "event_espresso"),
+					true,
+					''
+				),
+				'VNU_address2'        => new EE_Plain_Text_Field(
+					'VNU_address2',
+					esc_html__("Venue Address line 2", "event_espresso"),
+					true,
+					''
+				),
+				'VNU_city'            => new EE_Plain_Text_Field(
+					'VNU_city',
+					esc_html__("Venue City", "event_espresso"),
+					true,
+					''
+				),
+				'STA_ID'              => new EE_Foreign_Key_Int_Field(
+					'STA_ID',
+					esc_html__("State ID", "event_espresso"),
+					true,
+					null,
+					'State'
+				),
+				'CNT_ISO'             => new EE_Foreign_Key_String_Field(
+					'CNT_ISO',
+					esc_html__("Country Code", "event_espresso"),
+					true,
+					null,
+					'Country'
+				),
+				'VNU_zip'             => new EE_Plain_Text_Field(
+					'VNU_zip',
+					esc_html__("Venue Zip/Postal Code", "event_espresso"),
+					true
+				),
+				'VNU_phone'           => new EE_Plain_Text_Field(
+					'VNU_phone',
+					esc_html__("Venue Phone", "event_espresso"),
+					true
+				),
+				'VNU_capacity'        => new EE_Infinite_Integer_Field(
+					'VNU_capacity',
+					esc_html__("Venue Capacity", "event_espresso"),
+					true,
+					EE_INF
+				),
+				'VNU_url'             => new EE_Plain_Text_Field(
+					'VNU_url',
+					esc_html__('Venue Website', 'event_espresso'),
+					true
+				),
+				'VNU_virtual_phone'   => new EE_Plain_Text_Field(
+					'VNU_virtual_phone',
+					esc_html__('Call in Number', 'event_espresso'),
+					true
+				),
+				'VNU_virtual_url'     => new EE_Plain_Text_Field(
+					'VNU_virtual_url',
+					esc_html__('Virtual URL', 'event_espresso'),
+					true
+				),
+				'VNU_google_map_link' => new EE_Plain_Text_Field(
+					'VNU_google_map_link',
+					esc_html__('Google Map Link', 'event_espresso'),
+					true
+				),
+				'VNU_enable_for_gmap' => new EE_Boolean_Field(
+					'VNU_enable_for_gmap',
+					esc_html__('Show Google Map?', 'event_espresso'),
+					false,
+					false
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Country'           => new EE_Belongs_To_Relation(),
+			'Event'             => new EE_Has_Many_Relation(),
+			'Datetime'          => new EE_Has_Many_Relation(),
+			'State'             => new EE_Belongs_To_Relation(),
+			'Term_Relationship' => new EE_Has_Many_Relation(),
+			'Term_Taxonomy'     => new EE_HABTM_Relation('Term_Relationship'),
+			'WP_User'           => new EE_Belongs_To_Relation(),
+		];
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+		$this->model_chain_to_password                            = '';
+		parent::__construct($timezone);
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -26,7 +26,7 @@ 
             'Venue_CPT'  => new EE_Primary_Table('posts', 'ID'),
             'Venue_Meta' => new EE_Secondary_Table('esp_venue_meta', 'VNUM_ID', 'VNU_ID'),
         ];
-        $this->_fields          = [
+        $this->_fields = [
             'Venue_CPT'  => [
                 'VNU_ID'         => new EE_Primary_Key_Int_Field('ID', esc_html__("Venue ID", "event_espresso")),
                 'VNU_name'       => new EE_Plain_Text_Field(
@@ -204,7 +204,7 @@ 
             'WP_User'           => new EE_Belongs_To_Relation(),
         ];
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
         $this->model_chain_to_password                            = '';
         parent::__construct($timezone);
     }