eventespresso / event-espresso-core

core/CPTs/CptQueryModifier.php

Indentation +578 added lines, -578 removed lines

@@ -30,582 +30,582 @@
  */
 class CptQueryModifier
 {
-    /**
-     * @var CurrentPage $current_page
-     */
-    protected $current_page;
-
-    /**
-     * @var string $post_type
-     */
-    protected $post_type = '';
-
-    /**
-     * CPT details from CustomPostTypeDefinitions for specific post type
-     *
-     * @var array $cpt_details
-     */
-    protected $cpt_details = array();
-
-    /**
-     * @var EE_Table_Base[] $model_tables
-     */
-    protected $model_tables = array();
-
-    /**
-     * @var array $taxonomies
-     */
-    protected $taxonomies = array();
-
-    /**
-     * meta table for the related CPT
-     *
-     * @var EE_Secondary_Table $meta_table
-     */
-    protected $meta_table;
-
-    /**
-     * EEM_CPT_Base model for the related CPT
-     *
-     * @var EEM_CPT_Base $model
-     */
-    protected $model;
-
-    /**
-     * @var EE_Request_Handler $request_handler
-     */
-    protected $request_handler;
-
-    /**
-     * @var WP_Query $wp_query
-     */
-    protected $wp_query;
-
-    /**
-     * @var LoaderInterface $loader
-     */
-    protected $loader;
-
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
-
-
-    /**
-     * CptQueryModifier constructor
-     *
-     * @param string             $post_type
-     * @param array              $cpt_details
-     * @param WP_Query           $WP_Query
-     * @param CurrentPage $current_page
-     * @param RequestInterface   $request
-     * @param LoaderInterface    $loader
-     * @throws EE_Error
-     */
-    public function __construct(
-        $post_type,
-        array $cpt_details,
-        WP_Query $WP_Query,
-        CurrentPage $current_page,
-        RequestInterface $request,
-        LoaderInterface $loader
-    ) {
-        $this->loader = $loader;
-        $this->request = $request;
-        $this->current_page = $current_page;
-        $this->setWpQuery($WP_Query);
-        $this->setPostType($post_type);
-        $this->setCptDetails($cpt_details);
-        $this->init();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function postType()
-    {
-        return $this->post_type;
-    }
-
-
-    /**
-     * @param string $post_type
-     */
-    protected function setPostType($post_type)
-    {
-        $this->post_type = $post_type;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function cptDetails()
-    {
-        return $this->cpt_details;
-    }
-
-
-    /**
-     * @param array $cpt_details
-     */
-    protected function setCptDetails($cpt_details)
-    {
-        $this->cpt_details = $cpt_details;
-    }
-
-
-    /**
-     * @return EE_Table_Base[]
-     */
-    public function modelTables()
-    {
-        return $this->model_tables;
-    }
-
-
-    /**
-     * @param EE_Table_Base[] $model_tables
-     */
-    protected function setModelTables($model_tables)
-    {
-        $this->model_tables = $model_tables;
-    }
-
-
-    /**
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function taxonomies()
-    {
-        if (empty($this->taxonomies)) {
-            $this->initializeTaxonomies();
-        }
-        return $this->taxonomies;
-    }
-
-
-    /**
-     * @param array $taxonomies
-     */
-    protected function setTaxonomies(array $taxonomies)
-    {
-        $this->taxonomies = $taxonomies;
-    }
-
-
-    /**
-     * @return EE_Secondary_Table
-     */
-    public function metaTable()
-    {
-        return $this->meta_table;
-    }
-
-
-    /**
-     * @param EE_Secondary_Table $meta_table
-     */
-    public function setMetaTable(EE_Secondary_Table $meta_table)
-    {
-        $this->meta_table = $meta_table;
-    }
-
-
-    /**
-     * @return EEM_Base
-     */
-    public function model()
-    {
-        return $this->model;
-    }
-
-
-    /**
-     * @param EEM_Base $CPT_model
-     */
-    protected function setModel(EEM_Base $CPT_model)
-    {
-        $this->model = $CPT_model;
-    }
-
-
-    /**
-     * @deprecated 4.9.63.p
-     * @return EE_Request_Handler
-     */
-    public function request()
-    {
-        if (! $this->request_handler instanceof EE_Request_Handler) {
-            $this->request_handler = LoaderFactory::getLoader()->getShared('EE_Request_Handler');
-        }
-        return $this->request_handler;
-    }
-
-
-
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-
-
-    /**
-     * @return WP_Query
-     */
-    public function WpQuery()
-    {
-        return $this->wp_query;
-    }
-    // phpcs:enable
-
-
-    /**
-     * @param WP_Query $wp_query
-     */
-    public function setWpQuery(WP_Query $wp_query)
-    {
-        $this->wp_query = $wp_query;
-    }
-
-
-    /**
-     * @return void
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    protected function initializeTaxonomies()
-    {
-        // check if taxonomies have already been set and that this CPT has taxonomies registered for it
-        if (
-            empty($this->taxonomies)
-            && isset($this->cpt_details['args']['taxonomies'])
-        ) {
-            // if so then grab them, but we want the taxonomy name as the key
-            $taxonomies = array_flip($this->cpt_details['args']['taxonomies']);
-            // then grab the list of ALL taxonomies
-            /** @var CustomTaxonomyDefinitions
-             * $taxonomy_definitions
-             */
-            $taxonomy_definitions = $this->loader->getShared(
-                'EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions'
-            );
-            $all_taxonomies = $taxonomy_definitions->getCustomTaxonomyDefinitions();
-            foreach ($taxonomies as $taxonomy => &$details) {
-                // add details to our taxonomies if they exist
-                $details = isset($all_taxonomies[ $taxonomy ])
-                    ? $all_taxonomies[ $taxonomy ]
-                    : array();
-            }
-            // ALWAYS unset() variables that were passed by reference
-            unset($details);
-            $this->setTaxonomies($taxonomies);
-        }
-    }
-
-
-    /**
-     * @since 4.9.63.p
-     * @throws EE_Error
-     */
-    protected function init()
-    {
-        $this->setAdditionalCptDetails();
-        $this->setRequestVarsIfCpt();
-        // convert post_type to model name
-        $model_name = str_replace('EE_', '', $this->cpt_details['class_name']);
-        // load all tables related to CPT
-        $this->setupModelsAndTables($model_name);
-        // load and instantiate CPT_*_Strategy
-        $CPT_Strategy = $this->cptStrategyClass($model_name);
-        // !!!!!!!!!!  IMPORTANT !!!!!!!!!!!!
-        // here's the list of available filters in the WP_Query object
-        // 'posts_where_paged'
-        // 'posts_groupby'
-        // 'posts_join_paged'
-        // 'posts_orderby'
-        // 'posts_distinct'
-        // 'post_limits'
-        // 'posts_fields'
-        // 'posts_join'
-        add_filter('posts_fields', array($this, 'postsFields'));
-        add_filter('posts_join', array($this, 'postsJoin'));
-        add_filter(
-            'get_' . $this->post_type . '_metadata',
-            array($CPT_Strategy, 'get_EE_post_type_metadata'),
-            1,
-            4
-        );
-        add_filter('the_posts', array($this, 'thePosts'), 1, 1);
-        if ($this->wp_query->is_main_query()) {
-            add_filter('get_edit_post_link', array($this, 'getEditPostLink'), 10, 2);
-            $this->addTemplateFilters();
-        }
-    }
-
-
-    /**
-     * sets some basic query vars that pertain to the CPT
-     *
-     * @access protected
-     * @return void
-     */
-    protected function setAdditionalCptDetails()
-    {
-        // the post or category or term that is triggering EE
-        $this->cpt_details['espresso_page'] = $this->current_page->isEspressoPage();
-        // requested post name
-        $this->cpt_details['post_name'] = $this->request->getRequestParam('post_name');
-        // add support for viewing 'private', 'draft', or 'pending' posts
-        if (
-            isset($this->wp_query->query_vars['p'])
-            && $this->wp_query->query_vars['p'] !== 0
-            && is_user_logged_in()
-            && current_user_can('edit_post', $this->wp_query->query_vars['p'])
-        ) {
-            // we can just inject directly into the WP_Query object
-            $this->wp_query->query['post_status'] = array('publish', 'private', 'draft', 'pending');
-            // now set the main 'ee' request var so that the appropriate module can load the appropriate template(s)
-            $this->request->setRequestParam('ee', $this->cpt_details['singular_slug']);
-        }
-    }
-
-
-    /**
-     * Checks if we're on a EE-CPT archive-or-single page, and if we've never set the EE request var.
-     * If so, sets the 'ee' request variable
-     * so other parts of EE can know what CPT is getting queried.
-     * To Mike's knowledge, this must be called from during or after the pre_get_posts hook
-     * in order for is_archive() and is_single() methods to work properly.
-     *
-     * @return void
-     */
-    public function setRequestVarsIfCpt()
-    {
-        // check if ee action var has been set
-        if (! $this->request->requestParamIsSet('ee')) {
-            // check that route exists for CPT archive slug
-            if (is_archive() && EE_Config::get_route($this->cpt_details['plural_slug'])) {
-                // ie: set "ee" to "events"
-                $this->request->setRequestParam('ee', $this->cpt_details['plural_slug']);
-                // or does it match a single page CPT like /event/
-            } elseif (is_single() && EE_Config::get_route($this->cpt_details['singular_slug'])) {
-                // ie: set "ee" to "event"
-                $this->request->setRequestParam('ee', $this->cpt_details['singular_slug']);
-            }
-        }
-    }
-
-
-    /**
-     * setupModelsAndTables
-     *
-     * @access protected
-     * @param string $model_name
-     * @throws EE_Error
-     */
-    protected function setupModelsAndTables($model_name)
-    {
-        // get CPT table data via CPT Model
-        $full_model_name = strpos($model_name, 'EEM_') !== 0
-            ? 'EEM_' . $model_name
-            : $model_name;
-        $model = $this->loader->getShared($full_model_name);
-        if (! $model instanceof EEM_Base) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The "%1$s" model could not be loaded.',
-                        'event_espresso'
-                    ),
-                    $full_model_name
-                )
-            );
-        }
-        $this->setModel($model);
-        $this->setModelTables($this->model->get_tables());
-        $meta_model = $model_name . '_Meta';
-        // is there a Meta Table for this CPT?
-        if (
-            isset($this->cpt_details['tables'][ $meta_model ])
-            && $this->cpt_details['tables'][ $meta_model ] instanceof EE_Secondary_Table
-        ) {
-            $this->setMetaTable($this->cpt_details['tables'][ $meta_model ]);
-        }
-    }
-
-
-    /**
-     * cptStrategyClass
-     *
-     * @access protected
-     * @param  string $model_name
-     * @return string
-     */
-    protected function cptStrategyClass($model_name)
-    {
-        // creates classname like:  CPT_Event_Strategy
-        $CPT_Strategy_class_name = 'EE_CPT_' . $model_name . '_Strategy';
-        // load and instantiate
-        $CPT_Strategy = $this->loader->getShared(
-            $CPT_Strategy_class_name,
-            array('WP_Query' => $this->wp_query, 'CPT' => $this->cpt_details)
-        );
-        if ($CPT_Strategy === null) {
-            $CPT_Strategy = $this->loader->getShared(
-                'EE_CPT_Default_Strategy',
-                array('WP_Query' => $this->wp_query, 'CPT' => $this->cpt_details)
-            );
-        }
-        return $CPT_Strategy;
-    }
-
-
-    /**
-     * postsFields
-     *
-     * @access public
-     * @param  $SQL
-     * @return string
-     */
-    public function postsFields($SQL)
-    {
-        // does this CPT have a meta table ?
-        if ($this->meta_table instanceof EE_Secondary_Table) {
-            // adds something like ", wp_esp_event_meta.* " to WP Query SELECT statement
-            $SQL .= ', ' . $this->meta_table->get_table_name() . '.* ';
-        }
-        remove_filter('posts_fields', array($this, 'postsFields'));
-        return $SQL;
-    }
-
-
-    /**
-     * postsJoin
-     *
-     * @access public
-     * @param  $SQL
-     * @return string
-     */
-    public function postsJoin($SQL)
-    {
-        // does this CPT have a meta table ?
-        if ($this->meta_table instanceof EE_Secondary_Table) {
-            global $wpdb;
-            // adds something like " LEFT JOIN wp_esp_event_meta ON ( wp_esp_event_meta.EVT_ID = wp_posts.ID ) " to WP Query JOIN statement
-            $SQL .= ' LEFT JOIN '
-                    . $this->meta_table->get_table_name()
-                    . ' ON ( '
-                    . $this->meta_table->get_table_name()
-                    . '.'
-                    . $this->meta_table->get_fk_on_table()
-                    . ' = '
-                    . $wpdb->posts
-                    . '.ID ) ';
-        }
-        remove_filter('posts_join', array($this, 'postsJoin'));
-        return $SQL;
-    }
-
-
-    /**
-     * thePosts
-     *
-     * @access public
-     * @param  WP_Post[] $posts
-     * @return WP_Post[]
-     */
-    public function thePosts($posts)
-    {
-        $CPT_class = $this->cpt_details['class_name'];
-        // loop thru posts
-        if (is_array($posts) && $this->model instanceof EEM_CPT_Base) {
-            foreach ($posts as $post) {
-                if ($post->post_type === $this->post_type) {
-                    $post->{$CPT_class} = $this->model->instantiate_class_from_post_object($post);
-                }
-            }
-        }
-        remove_filter('the_posts', array($this, 'thePosts'), 1);
-        return $posts;
-    }
-
-
-    /**
-     * @param $url
-     * @param $ID
-     * @return string
-     */
-    public function getEditPostLink($url, $ID)
-    {
-        // need to make sure we only edit links if our cpt
-        global $post;
-        // notice if the cpt is registered with `show_ee_ui` set to false, we take that to mean that the WordPress core ui
-        // for interacting with the CPT is desired and there is no EE UI for interacting with the CPT in the admin.
-        if (
-            ! $post instanceof WP_Post
-            || $post->post_type !== $this->post_type
-            || (
-                isset($this->cpt_details['args']['show_ee_ui'])
-                && ! $this->cpt_details['args']['show_ee_ui']
-            )
-        ) {
-            return $url;
-        }
-        // k made it here so all is good.
-        return wp_nonce_url(
-            add_query_arg(
-                array('page' => $this->post_type, 'post' => $ID, 'action' => 'edit'),
-                admin_url('admin.php')
-            ),
-            'edit',
-            'edit_nonce'
-        );
-    }
-
-
-    /**
-     * Execute any template filters.
-     * This method is only called if in main query.
-     *
-     * @return void
-     */
-    public function addTemplateFilters()
-    {
-        // if requested cpt supports page_templates and it's the main query
-        if (! empty($this->cpt_details['args']['page_templates']) && $this->wp_query->is_main_query()) {
-            // then let's hook into the appropriate query_template hook
-            add_filter('single_template', array($this, 'singleCptTemplate'));
-        }
-    }
-
-
-    /**
-     * Callback for single_template wp filter.
-     * This is used to load the set page_template for a single ee cpt if its set.  If "default" then we load the normal
-     * hierarchy.
-     *
-     * @access public
-     * @param string $current_template Existing default template path derived for this page call.
-     * @return string the path to the full template file.
-     */
-    public function singleCptTemplate($current_template)
-    {
-        $object = get_queried_object();
-        // does this called object HAVE a page template set that is something other than the default.
-        $template = get_post_meta($object->ID, '_wp_page_template', true);
-        // exit early if default or not set or invalid path (accounts for theme changes)
-        if (
-            $template === 'default'
-            || empty($template)
-            || ! is_readable(get_stylesheet_directory() . '/' . $template)
-        ) {
-            return $current_template;
-        }
-        // made it here so we SHOULD be able to just locate the template and then return it.
-        return locate_template(array($template));
-    }
+	/**
+	 * @var CurrentPage $current_page
+	 */
+	protected $current_page;
+
+	/**
+	 * @var string $post_type
+	 */
+	protected $post_type = '';
+
+	/**
+	 * CPT details from CustomPostTypeDefinitions for specific post type
+	 *
+	 * @var array $cpt_details
+	 */
+	protected $cpt_details = array();
+
+	/**
+	 * @var EE_Table_Base[] $model_tables
+	 */
+	protected $model_tables = array();
+
+	/**
+	 * @var array $taxonomies
+	 */
+	protected $taxonomies = array();
+
+	/**
+	 * meta table for the related CPT
+	 *
+	 * @var EE_Secondary_Table $meta_table
+	 */
+	protected $meta_table;
+
+	/**
+	 * EEM_CPT_Base model for the related CPT
+	 *
+	 * @var EEM_CPT_Base $model
+	 */
+	protected $model;
+
+	/**
+	 * @var EE_Request_Handler $request_handler
+	 */
+	protected $request_handler;
+
+	/**
+	 * @var WP_Query $wp_query
+	 */
+	protected $wp_query;
+
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	protected $loader;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
+
+
+	/**
+	 * CptQueryModifier constructor
+	 *
+	 * @param string             $post_type
+	 * @param array              $cpt_details
+	 * @param WP_Query           $WP_Query
+	 * @param CurrentPage $current_page
+	 * @param RequestInterface   $request
+	 * @param LoaderInterface    $loader
+	 * @throws EE_Error
+	 */
+	public function __construct(
+		$post_type,
+		array $cpt_details,
+		WP_Query $WP_Query,
+		CurrentPage $current_page,
+		RequestInterface $request,
+		LoaderInterface $loader
+	) {
+		$this->loader = $loader;
+		$this->request = $request;
+		$this->current_page = $current_page;
+		$this->setWpQuery($WP_Query);
+		$this->setPostType($post_type);
+		$this->setCptDetails($cpt_details);
+		$this->init();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function postType()
+	{
+		return $this->post_type;
+	}
+
+
+	/**
+	 * @param string $post_type
+	 */
+	protected function setPostType($post_type)
+	{
+		$this->post_type = $post_type;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function cptDetails()
+	{
+		return $this->cpt_details;
+	}
+
+
+	/**
+	 * @param array $cpt_details
+	 */
+	protected function setCptDetails($cpt_details)
+	{
+		$this->cpt_details = $cpt_details;
+	}
+
+
+	/**
+	 * @return EE_Table_Base[]
+	 */
+	public function modelTables()
+	{
+		return $this->model_tables;
+	}
+
+
+	/**
+	 * @param EE_Table_Base[] $model_tables
+	 */
+	protected function setModelTables($model_tables)
+	{
+		$this->model_tables = $model_tables;
+	}
+
+
+	/**
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function taxonomies()
+	{
+		if (empty($this->taxonomies)) {
+			$this->initializeTaxonomies();
+		}
+		return $this->taxonomies;
+	}
+
+
+	/**
+	 * @param array $taxonomies
+	 */
+	protected function setTaxonomies(array $taxonomies)
+	{
+		$this->taxonomies = $taxonomies;
+	}
+
+
+	/**
+	 * @return EE_Secondary_Table
+	 */
+	public function metaTable()
+	{
+		return $this->meta_table;
+	}
+
+
+	/**
+	 * @param EE_Secondary_Table $meta_table
+	 */
+	public function setMetaTable(EE_Secondary_Table $meta_table)
+	{
+		$this->meta_table = $meta_table;
+	}
+
+
+	/**
+	 * @return EEM_Base
+	 */
+	public function model()
+	{
+		return $this->model;
+	}
+
+
+	/**
+	 * @param EEM_Base $CPT_model
+	 */
+	protected function setModel(EEM_Base $CPT_model)
+	{
+		$this->model = $CPT_model;
+	}
+
+
+	/**
+	 * @deprecated 4.9.63.p
+	 * @return EE_Request_Handler
+	 */
+	public function request()
+	{
+		if (! $this->request_handler instanceof EE_Request_Handler) {
+			$this->request_handler = LoaderFactory::getLoader()->getShared('EE_Request_Handler');
+		}
+		return $this->request_handler;
+	}
+
+
+
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+
+
+	/**
+	 * @return WP_Query
+	 */
+	public function WpQuery()
+	{
+		return $this->wp_query;
+	}
+	// phpcs:enable
+
+
+	/**
+	 * @param WP_Query $wp_query
+	 */
+	public function setWpQuery(WP_Query $wp_query)
+	{
+		$this->wp_query = $wp_query;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	protected function initializeTaxonomies()
+	{
+		// check if taxonomies have already been set and that this CPT has taxonomies registered for it
+		if (
+			empty($this->taxonomies)
+			&& isset($this->cpt_details['args']['taxonomies'])
+		) {
+			// if so then grab them, but we want the taxonomy name as the key
+			$taxonomies = array_flip($this->cpt_details['args']['taxonomies']);
+			// then grab the list of ALL taxonomies
+			/** @var CustomTaxonomyDefinitions
+			 * $taxonomy_definitions
+			 */
+			$taxonomy_definitions = $this->loader->getShared(
+				'EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions'
+			);
+			$all_taxonomies = $taxonomy_definitions->getCustomTaxonomyDefinitions();
+			foreach ($taxonomies as $taxonomy => &$details) {
+				// add details to our taxonomies if they exist
+				$details = isset($all_taxonomies[ $taxonomy ])
+					? $all_taxonomies[ $taxonomy ]
+					: array();
+			}
+			// ALWAYS unset() variables that were passed by reference
+			unset($details);
+			$this->setTaxonomies($taxonomies);
+		}
+	}
+
+
+	/**
+	 * @since 4.9.63.p
+	 * @throws EE_Error
+	 */
+	protected function init()
+	{
+		$this->setAdditionalCptDetails();
+		$this->setRequestVarsIfCpt();
+		// convert post_type to model name
+		$model_name = str_replace('EE_', '', $this->cpt_details['class_name']);
+		// load all tables related to CPT
+		$this->setupModelsAndTables($model_name);
+		// load and instantiate CPT_*_Strategy
+		$CPT_Strategy = $this->cptStrategyClass($model_name);
+		// !!!!!!!!!!  IMPORTANT !!!!!!!!!!!!
+		// here's the list of available filters in the WP_Query object
+		// 'posts_where_paged'
+		// 'posts_groupby'
+		// 'posts_join_paged'
+		// 'posts_orderby'
+		// 'posts_distinct'
+		// 'post_limits'
+		// 'posts_fields'
+		// 'posts_join'
+		add_filter('posts_fields', array($this, 'postsFields'));
+		add_filter('posts_join', array($this, 'postsJoin'));
+		add_filter(
+			'get_' . $this->post_type . '_metadata',
+			array($CPT_Strategy, 'get_EE_post_type_metadata'),
+			1,
+			4
+		);
+		add_filter('the_posts', array($this, 'thePosts'), 1, 1);
+		if ($this->wp_query->is_main_query()) {
+			add_filter('get_edit_post_link', array($this, 'getEditPostLink'), 10, 2);
+			$this->addTemplateFilters();
+		}
+	}
+
+
+	/**
+	 * sets some basic query vars that pertain to the CPT
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function setAdditionalCptDetails()
+	{
+		// the post or category or term that is triggering EE
+		$this->cpt_details['espresso_page'] = $this->current_page->isEspressoPage();
+		// requested post name
+		$this->cpt_details['post_name'] = $this->request->getRequestParam('post_name');
+		// add support for viewing 'private', 'draft', or 'pending' posts
+		if (
+			isset($this->wp_query->query_vars['p'])
+			&& $this->wp_query->query_vars['p'] !== 0
+			&& is_user_logged_in()
+			&& current_user_can('edit_post', $this->wp_query->query_vars['p'])
+		) {
+			// we can just inject directly into the WP_Query object
+			$this->wp_query->query['post_status'] = array('publish', 'private', 'draft', 'pending');
+			// now set the main 'ee' request var so that the appropriate module can load the appropriate template(s)
+			$this->request->setRequestParam('ee', $this->cpt_details['singular_slug']);
+		}
+	}
+
+
+	/**
+	 * Checks if we're on a EE-CPT archive-or-single page, and if we've never set the EE request var.
+	 * If so, sets the 'ee' request variable
+	 * so other parts of EE can know what CPT is getting queried.
+	 * To Mike's knowledge, this must be called from during or after the pre_get_posts hook
+	 * in order for is_archive() and is_single() methods to work properly.
+	 *
+	 * @return void
+	 */
+	public function setRequestVarsIfCpt()
+	{
+		// check if ee action var has been set
+		if (! $this->request->requestParamIsSet('ee')) {
+			// check that route exists for CPT archive slug
+			if (is_archive() && EE_Config::get_route($this->cpt_details['plural_slug'])) {
+				// ie: set "ee" to "events"
+				$this->request->setRequestParam('ee', $this->cpt_details['plural_slug']);
+				// or does it match a single page CPT like /event/
+			} elseif (is_single() && EE_Config::get_route($this->cpt_details['singular_slug'])) {
+				// ie: set "ee" to "event"
+				$this->request->setRequestParam('ee', $this->cpt_details['singular_slug']);
+			}
+		}
+	}
+
+
+	/**
+	 * setupModelsAndTables
+	 *
+	 * @access protected
+	 * @param string $model_name
+	 * @throws EE_Error
+	 */
+	protected function setupModelsAndTables($model_name)
+	{
+		// get CPT table data via CPT Model
+		$full_model_name = strpos($model_name, 'EEM_') !== 0
+			? 'EEM_' . $model_name
+			: $model_name;
+		$model = $this->loader->getShared($full_model_name);
+		if (! $model instanceof EEM_Base) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The "%1$s" model could not be loaded.',
+						'event_espresso'
+					),
+					$full_model_name
+				)
+			);
+		}
+		$this->setModel($model);
+		$this->setModelTables($this->model->get_tables());
+		$meta_model = $model_name . '_Meta';
+		// is there a Meta Table for this CPT?
+		if (
+			isset($this->cpt_details['tables'][ $meta_model ])
+			&& $this->cpt_details['tables'][ $meta_model ] instanceof EE_Secondary_Table
+		) {
+			$this->setMetaTable($this->cpt_details['tables'][ $meta_model ]);
+		}
+	}
+
+
+	/**
+	 * cptStrategyClass
+	 *
+	 * @access protected
+	 * @param  string $model_name
+	 * @return string
+	 */
+	protected function cptStrategyClass($model_name)
+	{
+		// creates classname like:  CPT_Event_Strategy
+		$CPT_Strategy_class_name = 'EE_CPT_' . $model_name . '_Strategy';
+		// load and instantiate
+		$CPT_Strategy = $this->loader->getShared(
+			$CPT_Strategy_class_name,
+			array('WP_Query' => $this->wp_query, 'CPT' => $this->cpt_details)
+		);
+		if ($CPT_Strategy === null) {
+			$CPT_Strategy = $this->loader->getShared(
+				'EE_CPT_Default_Strategy',
+				array('WP_Query' => $this->wp_query, 'CPT' => $this->cpt_details)
+			);
+		}
+		return $CPT_Strategy;
+	}
+
+
+	/**
+	 * postsFields
+	 *
+	 * @access public
+	 * @param  $SQL
+	 * @return string
+	 */
+	public function postsFields($SQL)
+	{
+		// does this CPT have a meta table ?
+		if ($this->meta_table instanceof EE_Secondary_Table) {
+			// adds something like ", wp_esp_event_meta.* " to WP Query SELECT statement
+			$SQL .= ', ' . $this->meta_table->get_table_name() . '.* ';
+		}
+		remove_filter('posts_fields', array($this, 'postsFields'));
+		return $SQL;
+	}
+
+
+	/**
+	 * postsJoin
+	 *
+	 * @access public
+	 * @param  $SQL
+	 * @return string
+	 */
+	public function postsJoin($SQL)
+	{
+		// does this CPT have a meta table ?
+		if ($this->meta_table instanceof EE_Secondary_Table) {
+			global $wpdb;
+			// adds something like " LEFT JOIN wp_esp_event_meta ON ( wp_esp_event_meta.EVT_ID = wp_posts.ID ) " to WP Query JOIN statement
+			$SQL .= ' LEFT JOIN '
+					. $this->meta_table->get_table_name()
+					. ' ON ( '
+					. $this->meta_table->get_table_name()
+					. '.'
+					. $this->meta_table->get_fk_on_table()
+					. ' = '
+					. $wpdb->posts
+					. '.ID ) ';
+		}
+		remove_filter('posts_join', array($this, 'postsJoin'));
+		return $SQL;
+	}
+
+
+	/**
+	 * thePosts
+	 *
+	 * @access public
+	 * @param  WP_Post[] $posts
+	 * @return WP_Post[]
+	 */
+	public function thePosts($posts)
+	{
+		$CPT_class = $this->cpt_details['class_name'];
+		// loop thru posts
+		if (is_array($posts) && $this->model instanceof EEM_CPT_Base) {
+			foreach ($posts as $post) {
+				if ($post->post_type === $this->post_type) {
+					$post->{$CPT_class} = $this->model->instantiate_class_from_post_object($post);
+				}
+			}
+		}
+		remove_filter('the_posts', array($this, 'thePosts'), 1);
+		return $posts;
+	}
+
+
+	/**
+	 * @param $url
+	 * @param $ID
+	 * @return string
+	 */
+	public function getEditPostLink($url, $ID)
+	{
+		// need to make sure we only edit links if our cpt
+		global $post;
+		// notice if the cpt is registered with `show_ee_ui` set to false, we take that to mean that the WordPress core ui
+		// for interacting with the CPT is desired and there is no EE UI for interacting with the CPT in the admin.
+		if (
+			! $post instanceof WP_Post
+			|| $post->post_type !== $this->post_type
+			|| (
+				isset($this->cpt_details['args']['show_ee_ui'])
+				&& ! $this->cpt_details['args']['show_ee_ui']
+			)
+		) {
+			return $url;
+		}
+		// k made it here so all is good.
+		return wp_nonce_url(
+			add_query_arg(
+				array('page' => $this->post_type, 'post' => $ID, 'action' => 'edit'),
+				admin_url('admin.php')
+			),
+			'edit',
+			'edit_nonce'
+		);
+	}
+
+
+	/**
+	 * Execute any template filters.
+	 * This method is only called if in main query.
+	 *
+	 * @return void
+	 */
+	public function addTemplateFilters()
+	{
+		// if requested cpt supports page_templates and it's the main query
+		if (! empty($this->cpt_details['args']['page_templates']) && $this->wp_query->is_main_query()) {
+			// then let's hook into the appropriate query_template hook
+			add_filter('single_template', array($this, 'singleCptTemplate'));
+		}
+	}
+
+
+	/**
+	 * Callback for single_template wp filter.
+	 * This is used to load the set page_template for a single ee cpt if its set.  If "default" then we load the normal
+	 * hierarchy.
+	 *
+	 * @access public
+	 * @param string $current_template Existing default template path derived for this page call.
+	 * @return string the path to the full template file.
+	 */
+	public function singleCptTemplate($current_template)
+	{
+		$object = get_queried_object();
+		// does this called object HAVE a page template set that is something other than the default.
+		$template = get_post_meta($object->ID, '_wp_page_template', true);
+		// exit early if default or not set or invalid path (accounts for theme changes)
+		if (
+			$template === 'default'
+			|| empty($template)
+			|| ! is_readable(get_stylesheet_directory() . '/' . $template)
+		) {
+			return $current_template;
+		}
+		// made it here so we SHOULD be able to just locate the template and then return it.
+		return locate_template(array($template));
+	}
 }

Spacing +15 added lines, -15 removed lines

@@ -241,7 +241,7 @@ 
      */
     public function request()
     {
-        if (! $this->request_handler instanceof EE_Request_Handler) {
+        if ( ! $this->request_handler instanceof EE_Request_Handler) {
             $this->request_handler = LoaderFactory::getLoader()->getShared('EE_Request_Handler');
         }
         return $this->request_handler;
@@ -296,8 +296,8 @@ 
             $all_taxonomies = $taxonomy_definitions->getCustomTaxonomyDefinitions();
             foreach ($taxonomies as $taxonomy => &$details) {
                 // add details to our taxonomies if they exist
-                $details = isset($all_taxonomies[ $taxonomy ])
-                    ? $all_taxonomies[ $taxonomy ]
+                $details = isset($all_taxonomies[$taxonomy])
+                    ? $all_taxonomies[$taxonomy]
                     : array();
             }
             // ALWAYS unset() variables that were passed by reference
@@ -334,7 +334,7 @@ 
         add_filter('posts_fields', array($this, 'postsFields'));
         add_filter('posts_join', array($this, 'postsJoin'));
         add_filter(
-            'get_' . $this->post_type . '_metadata',
+            'get_'.$this->post_type.'_metadata',
             array($CPT_Strategy, 'get_EE_post_type_metadata'),
             1,
             4
@@ -386,7 +386,7 @@ 
     public function setRequestVarsIfCpt()
     {
         // check if ee action var has been set
-        if (! $this->request->requestParamIsSet('ee')) {
+        if ( ! $this->request->requestParamIsSet('ee')) {
             // check that route exists for CPT archive slug
             if (is_archive() && EE_Config::get_route($this->cpt_details['plural_slug'])) {
                 // ie: set "ee" to "events"
@@ -411,10 +411,10 @@ 
     {
         // get CPT table data via CPT Model
         $full_model_name = strpos($model_name, 'EEM_') !== 0
-            ? 'EEM_' . $model_name
+            ? 'EEM_'.$model_name
             : $model_name;
         $model = $this->loader->getShared($full_model_name);
-        if (! $model instanceof EEM_Base) {
+        if ( ! $model instanceof EEM_Base) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -427,13 +427,13 @@ 
         }
         $this->setModel($model);
         $this->setModelTables($this->model->get_tables());
-        $meta_model = $model_name . '_Meta';
+        $meta_model = $model_name.'_Meta';
         // is there a Meta Table for this CPT?
         if (
-            isset($this->cpt_details['tables'][ $meta_model ])
-            && $this->cpt_details['tables'][ $meta_model ] instanceof EE_Secondary_Table
+            isset($this->cpt_details['tables'][$meta_model])
+            && $this->cpt_details['tables'][$meta_model] instanceof EE_Secondary_Table
         ) {
-            $this->setMetaTable($this->cpt_details['tables'][ $meta_model ]);
+            $this->setMetaTable($this->cpt_details['tables'][$meta_model]);
         }
     }
 
@@ -448,7 +448,7 @@ 
     protected function cptStrategyClass($model_name)
     {
         // creates classname like:  CPT_Event_Strategy
-        $CPT_Strategy_class_name = 'EE_CPT_' . $model_name . '_Strategy';
+        $CPT_Strategy_class_name = 'EE_CPT_'.$model_name.'_Strategy';
         // load and instantiate
         $CPT_Strategy = $this->loader->getShared(
             $CPT_Strategy_class_name,
@@ -476,7 +476,7 @@ 
         // does this CPT have a meta table ?
         if ($this->meta_table instanceof EE_Secondary_Table) {
             // adds something like ", wp_esp_event_meta.* " to WP Query SELECT statement
-            $SQL .= ', ' . $this->meta_table->get_table_name() . '.* ';
+            $SQL .= ', '.$this->meta_table->get_table_name().'.* ';
         }
         remove_filter('posts_fields', array($this, 'postsFields'));
         return $SQL;
@@ -576,7 +576,7 @@ 
     public function addTemplateFilters()
     {
         // if requested cpt supports page_templates and it's the main query
-        if (! empty($this->cpt_details['args']['page_templates']) && $this->wp_query->is_main_query()) {
+        if ( ! empty($this->cpt_details['args']['page_templates']) && $this->wp_query->is_main_query()) {
             // then let's hook into the appropriate query_template hook
             add_filter('single_template', array($this, 'singleCptTemplate'));
         }
@@ -601,7 +601,7 @@ 
         if (
             $template === 'default'
             || empty($template)
-            || ! is_readable(get_stylesheet_directory() . '/' . $template)
+            || ! is_readable(get_stylesheet_directory().'/'.$template)
         ) {
             return $current_template;
         }

core/EE_Cron_Tasks.core.php

Spacing +14 added lines, -14 removed lines

@@ -38,7 +38,7 @@ 
      */
     public static function instance()
     {
-        if (! self::$_instance instanceof EE_Cron_Tasks) {
+        if ( ! self::$_instance instanceof EE_Cron_Tasks) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -72,7 +72,7 @@ 
              */
             add_action(
                 'AHEE__EE_System__load_core_configuration__complete',
-                function () {
+                function() {
                     EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request = true;
                     EE_Registry::instance()->NET_CFG->update_config(true, false);
                     add_option('ee_disabled_wp_cron_check', 1, '', false);
@@ -124,16 +124,16 @@ 
             'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
         );
         $crons = (array) get_option('cron');
-        if (! is_array($crons)) {
+        if ( ! is_array($crons)) {
             return;
         }
         foreach ($crons as $timestamp => $cron) {
             /** @var array[] $cron */
             foreach ($ee_crons as $ee_cron) {
-                if (isset($cron[ $ee_cron ]) && is_array($cron[ $ee_cron ])) {
+                if (isset($cron[$ee_cron]) && is_array($cron[$ee_cron])) {
                     do_action('AHEE_log', __CLASS__, __FUNCTION__, $ee_cron, 'scheduled EE cron');
-                    foreach ($cron[ $ee_cron ] as $ee_cron_details) {
-                        if (! empty($ee_cron_details['args'])) {
+                    foreach ($cron[$ee_cron] as $ee_cron_details) {
+                        if ( ! empty($ee_cron_details['args'])) {
                             do_action(
                                 'AHEE_log',
                                 __CLASS__,
@@ -160,7 +160,7 @@ 
      */
     public static function reschedule_cron_for_transactions_if_maintenance_mode($cron_task, array $TXN_IDs)
     {
-        if (! method_exists('EE_Cron_Tasks', $cron_task)) {
+        if ( ! method_exists('EE_Cron_Tasks', $cron_task)) {
             throw new DomainException(
                 sprintf(
                     esc_html__('"%1$s" is not valid method on EE_Cron_Tasks.', 'event_espresso'),
@@ -169,7 +169,7 @@ 
             );
         }
         // reschedule the cron if we can't hit the db right now
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+        if ( ! EE_Maintenance_Mode::instance()->models_can_query()) {
             foreach ($TXN_IDs as $TXN_ID => $additional_vars) {
                 // ensure $additional_vars is an array
                 $additional_vars = is_array($additional_vars) ? $additional_vars : array($additional_vars);
@@ -250,7 +250,7 @@ 
     {
         do_action('AHEE_log', __CLASS__, __FUNCTION__, $TXN_ID, '$TXN_ID');
         if (absint($TXN_ID)) {
-            self::$_update_transactions_with_payment[ $TXN_ID ] = $PAY_ID;
+            self::$_update_transactions_with_payment[$TXN_ID] = $PAY_ID;
             add_action(
                 'shutdown',
                 array('EE_Cron_Tasks', 'update_transaction_with_payment'),
@@ -297,7 +297,7 @@ 
         EE_Registry::instance()->load_model('Transaction');
         foreach (self::$_update_transactions_with_payment as $TXN_ID => $PAY_ID) {
             // reschedule the cron if we can't hit the db right now
-            if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+            if ( ! EE_Maintenance_Mode::instance()->models_can_query()) {
                 // reset cron job for updating the TXN
                 EE_Cron_Tasks::schedule_update_transaction_with_payment(
                     time() + EE_Cron_Tasks::reschedule_timeout,
@@ -313,7 +313,7 @@ 
                 // now try to update the TXN with any payments
                 $payment_processor->update_txn_based_on_payment($transaction, $payment, true, true);
             }
-            unset(self::$_update_transactions_with_payment[ $TXN_ID ]);
+            unset(self::$_update_transactions_with_payment[$TXN_ID]);
         }
     }
 
@@ -374,7 +374,7 @@ 
     public static function expired_transaction_check($TXN_ID = 0)
     {
         if (absint($TXN_ID)) {
-            self::$_expired_transactions[ $TXN_ID ] = $TXN_ID;
+            self::$_expired_transactions[$TXN_ID] = $TXN_ID;
             add_action(
                 'shutdown',
                 array('EE_Cron_Tasks', 'process_expired_transactions'),
@@ -502,7 +502,7 @@ 
                         break;
                 }
             }
-            unset(self::$_expired_transactions[ $TXN_ID ]);
+            unset(self::$_expired_transactions[$TXN_ID]);
         }
     }
 
@@ -549,7 +549,7 @@ 
             $reg_config = LoaderFactory::getLoader()->load('EE_Registration_Config');
             $time_diff_for_comparison = apply_filters(
                 'FHEE__EE_Cron_Tasks__clean_out_old_gateway_logs__time_diff_for_comparison',
-                '-' . $reg_config->gateway_log_lifespan
+                '-'.$reg_config->gateway_log_lifespan
             );
             EEM_Change_Log::instance()->delete_gateway_logs_older_than(new DateTime($time_diff_for_comparison));
         }

Indentation +600 added lines, -600 removed lines

@@ -14,607 +14,607 @@
  */
 class EE_Cron_Tasks extends EE_Base
 {
-    /**
-     * WordPress doesn't allow duplicate crons within 10 minutes of the original,
-     * so we'll set our retry time for just over 10 minutes to avoid that
-     */
-    const reschedule_timeout = 605;
-
-
-    /**
-     * @var EE_Cron_Tasks
-     */
-    private static $_instance;
-
-
-    /**
-     * @return EE_Cron_Tasks
-     * @throws ReflectionException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function instance()
-    {
-        if (! self::$_instance instanceof EE_Cron_Tasks) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @access private
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function __construct()
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__);
-        // verify that WP Cron is enabled
-        if (
-            defined('DISABLE_WP_CRON')
-            && DISABLE_WP_CRON
-            && is_admin()
-            && ! get_option('ee_disabled_wp_cron_check')
-        ) {
-            /**
-             * This needs to be delayed until after the config is loaded because EE_Cron_Tasks is constructed before
-             * config is loaded.
-             * This is intentionally using a anonymous function so that its not easily de-registered.  Client code
-             * wanting to not have this functionality can just register its own action at a priority after this one to
-             * reverse any changes.
-             */
-            add_action(
-                'AHEE__EE_System__load_core_configuration__complete',
-                function () {
-                    EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request = true;
-                    EE_Registry::instance()->NET_CFG->update_config(true, false);
-                    add_option('ee_disabled_wp_cron_check', 1, '', false);
-                }
-            );
-        }
-        // UPDATE TRANSACTION WITH PAYMENT
-        add_action(
-            'AHEE__EE_Cron_Tasks__update_transaction_with_payment_2',
-            array('EE_Cron_Tasks', 'setup_update_for_transaction_with_payment'),
-            10,
-            2
-        );
-        // ABANDONED / EXPIRED TRANSACTION CHECK
-        add_action(
-            'AHEE__EE_Cron_Tasks__expired_transaction_check',
-            array('EE_Cron_Tasks', 'expired_transaction_check'),
-            10,
-            1
-        );
-        // CLEAN OUT JUNK TRANSACTIONS AND RELATED DATA
-        add_action(
-            'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
-            array('EE_Cron_Tasks', 'clean_out_junk_transactions')
-        );
-        // logging
-        add_action(
-            'AHEE__EE_System__load_core_configuration__complete',
-            array('EE_Cron_Tasks', 'log_scheduled_ee_crons')
-        );
-        EE_Registry::instance()->load_lib('Messages_Scheduler');
-        // clean out old gateway logs
-        add_action(
-            'AHEE_EE_Cron_Tasks__clean_out_old_gateway_logs',
-            array('EE_Cron_Tasks', 'clean_out_old_gateway_logs')
-        );
-    }
-
-
-    /**
-     * @access protected
-     * @return void
-     */
-    public static function log_scheduled_ee_crons()
-    {
-        $ee_crons = array(
-            'AHEE__EE_Cron_Tasks__update_transaction_with_payment',
-            'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions',
-            'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
-        );
-        $crons = (array) get_option('cron');
-        if (! is_array($crons)) {
-            return;
-        }
-        foreach ($crons as $timestamp => $cron) {
-            /** @var array[] $cron */
-            foreach ($ee_crons as $ee_cron) {
-                if (isset($cron[ $ee_cron ]) && is_array($cron[ $ee_cron ])) {
-                    do_action('AHEE_log', __CLASS__, __FUNCTION__, $ee_cron, 'scheduled EE cron');
-                    foreach ($cron[ $ee_cron ] as $ee_cron_details) {
-                        if (! empty($ee_cron_details['args'])) {
-                            do_action(
-                                'AHEE_log',
-                                __CLASS__,
-                                __FUNCTION__,
-                                print_r($ee_cron_details['args'], true),
-                                "{$ee_cron} args"
-                            );
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * reschedule_cron_for_transactions_if_maintenance_mode
-     * if Maintenance Mode is active, this will reschedule a cron to run again in 10 minutes
-     *
-     * @param string $cron_task
-     * @param array  $TXN_IDs
-     * @return bool
-     * @throws DomainException
-     */
-    public static function reschedule_cron_for_transactions_if_maintenance_mode($cron_task, array $TXN_IDs)
-    {
-        if (! method_exists('EE_Cron_Tasks', $cron_task)) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__('"%1$s" is not valid method on EE_Cron_Tasks.', 'event_espresso'),
-                    $cron_task
-                )
-            );
-        }
-        // reschedule the cron if we can't hit the db right now
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
-            foreach ($TXN_IDs as $TXN_ID => $additional_vars) {
-                // ensure $additional_vars is an array
-                $additional_vars = is_array($additional_vars) ? $additional_vars : array($additional_vars);
-                // reset cron job for the TXN
-                call_user_func_array(
-                    array('EE_Cron_Tasks', $cron_task),
-                    array_merge(
-                        array(
-                            time() + (10 * MINUTE_IN_SECONDS),
-                            $TXN_ID,
-                        ),
-                        $additional_vars
-                    )
-                );
-            }
-            return true;
-        }
-        return false;
-    }
-
-
-
-
-    /****************  UPDATE TRANSACTION WITH PAYMENT ****************/
-
-
-    /**
-     * array of TXN IDs and the payment
-     *
-     * @var array
-     */
-    protected static $_update_transactions_with_payment = array();
-
-
-    /**
-     * schedule_update_transaction_with_payment
-     * sets a wp_schedule_single_event() for updating any TXNs that may
-     * require updating due to recently received payments
-     *
-     * @param int $timestamp
-     * @param int $TXN_ID
-     * @param int $PAY_ID
-     */
-    public static function schedule_update_transaction_with_payment(
-        $timestamp,
-        $TXN_ID,
-        $PAY_ID
-    ) {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__);
-        // validate $TXN_ID and $timestamp
-        $TXN_ID = absint($TXN_ID);
-        $timestamp = absint($timestamp);
-        if ($TXN_ID && $timestamp) {
-            wp_schedule_single_event(
-                $timestamp,
-                'AHEE__EE_Cron_Tasks__update_transaction_with_payment_2',
-                array($TXN_ID, $PAY_ID)
-            );
-        }
-    }
-
-
-    /**
-     * setup_update_for_transaction_with_payment
-     * this is the callback for the action hook:
-     * 'AHEE__EE_Cron_Tasks__update_transaction_with_payment'
-     * which is setup by EE_Cron_Tasks::schedule_update_transaction_with_payment().
-     * The passed TXN_ID and associated payment gets added to an array, and then
-     * the EE_Cron_Tasks::update_transaction_with_payment() function is hooked into
-     * 'shutdown' which will actually handle the processing of any
-     * transactions requiring updating, because doing so now would be too early
-     * and the required resources may not be available
-     *
-     * @param int $TXN_ID
-     * @param int $PAY_ID
-     */
-    public static function setup_update_for_transaction_with_payment($TXN_ID = 0, $PAY_ID = 0)
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__, $TXN_ID, '$TXN_ID');
-        if (absint($TXN_ID)) {
-            self::$_update_transactions_with_payment[ $TXN_ID ] = $PAY_ID;
-            add_action(
-                'shutdown',
-                array('EE_Cron_Tasks', 'update_transaction_with_payment'),
-                5
-            );
-        }
-    }
-
-
-    /**
-     * update_transaction_with_payment
-     * loops through the self::$_abandoned_transactions array
-     * and attempts to finalize any TXNs that have not been completed
-     * but have had their sessions expired, most likely due to a user not
-     * returning from an off-site payment gateway
-     *
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public static function update_transaction_with_payment()
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__);
-        if (
+	/**
+	 * WordPress doesn't allow duplicate crons within 10 minutes of the original,
+	 * so we'll set our retry time for just over 10 minutes to avoid that
+	 */
+	const reschedule_timeout = 605;
+
+
+	/**
+	 * @var EE_Cron_Tasks
+	 */
+	private static $_instance;
+
+
+	/**
+	 * @return EE_Cron_Tasks
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function instance()
+	{
+		if (! self::$_instance instanceof EE_Cron_Tasks) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @access private
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function __construct()
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__);
+		// verify that WP Cron is enabled
+		if (
+			defined('DISABLE_WP_CRON')
+			&& DISABLE_WP_CRON
+			&& is_admin()
+			&& ! get_option('ee_disabled_wp_cron_check')
+		) {
+			/**
+			 * This needs to be delayed until after the config is loaded because EE_Cron_Tasks is constructed before
+			 * config is loaded.
+			 * This is intentionally using a anonymous function so that its not easily de-registered.  Client code
+			 * wanting to not have this functionality can just register its own action at a priority after this one to
+			 * reverse any changes.
+			 */
+			add_action(
+				'AHEE__EE_System__load_core_configuration__complete',
+				function () {
+					EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request = true;
+					EE_Registry::instance()->NET_CFG->update_config(true, false);
+					add_option('ee_disabled_wp_cron_check', 1, '', false);
+				}
+			);
+		}
+		// UPDATE TRANSACTION WITH PAYMENT
+		add_action(
+			'AHEE__EE_Cron_Tasks__update_transaction_with_payment_2',
+			array('EE_Cron_Tasks', 'setup_update_for_transaction_with_payment'),
+			10,
+			2
+		);
+		// ABANDONED / EXPIRED TRANSACTION CHECK
+		add_action(
+			'AHEE__EE_Cron_Tasks__expired_transaction_check',
+			array('EE_Cron_Tasks', 'expired_transaction_check'),
+			10,
+			1
+		);
+		// CLEAN OUT JUNK TRANSACTIONS AND RELATED DATA
+		add_action(
+			'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
+			array('EE_Cron_Tasks', 'clean_out_junk_transactions')
+		);
+		// logging
+		add_action(
+			'AHEE__EE_System__load_core_configuration__complete',
+			array('EE_Cron_Tasks', 'log_scheduled_ee_crons')
+		);
+		EE_Registry::instance()->load_lib('Messages_Scheduler');
+		// clean out old gateway logs
+		add_action(
+			'AHEE_EE_Cron_Tasks__clean_out_old_gateway_logs',
+			array('EE_Cron_Tasks', 'clean_out_old_gateway_logs')
+		);
+	}
+
+
+	/**
+	 * @access protected
+	 * @return void
+	 */
+	public static function log_scheduled_ee_crons()
+	{
+		$ee_crons = array(
+			'AHEE__EE_Cron_Tasks__update_transaction_with_payment',
+			'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions',
+			'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
+		);
+		$crons = (array) get_option('cron');
+		if (! is_array($crons)) {
+			return;
+		}
+		foreach ($crons as $timestamp => $cron) {
+			/** @var array[] $cron */
+			foreach ($ee_crons as $ee_cron) {
+				if (isset($cron[ $ee_cron ]) && is_array($cron[ $ee_cron ])) {
+					do_action('AHEE_log', __CLASS__, __FUNCTION__, $ee_cron, 'scheduled EE cron');
+					foreach ($cron[ $ee_cron ] as $ee_cron_details) {
+						if (! empty($ee_cron_details['args'])) {
+							do_action(
+								'AHEE_log',
+								__CLASS__,
+								__FUNCTION__,
+								print_r($ee_cron_details['args'], true),
+								"{$ee_cron} args"
+							);
+						}
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * reschedule_cron_for_transactions_if_maintenance_mode
+	 * if Maintenance Mode is active, this will reschedule a cron to run again in 10 minutes
+	 *
+	 * @param string $cron_task
+	 * @param array  $TXN_IDs
+	 * @return bool
+	 * @throws DomainException
+	 */
+	public static function reschedule_cron_for_transactions_if_maintenance_mode($cron_task, array $TXN_IDs)
+	{
+		if (! method_exists('EE_Cron_Tasks', $cron_task)) {
+			throw new DomainException(
+				sprintf(
+					esc_html__('"%1$s" is not valid method on EE_Cron_Tasks.', 'event_espresso'),
+					$cron_task
+				)
+			);
+		}
+		// reschedule the cron if we can't hit the db right now
+		if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+			foreach ($TXN_IDs as $TXN_ID => $additional_vars) {
+				// ensure $additional_vars is an array
+				$additional_vars = is_array($additional_vars) ? $additional_vars : array($additional_vars);
+				// reset cron job for the TXN
+				call_user_func_array(
+					array('EE_Cron_Tasks', $cron_task),
+					array_merge(
+						array(
+							time() + (10 * MINUTE_IN_SECONDS),
+							$TXN_ID,
+						),
+						$additional_vars
+					)
+				);
+			}
+			return true;
+		}
+		return false;
+	}
+
+
+
+
+	/****************  UPDATE TRANSACTION WITH PAYMENT ****************/
+
+
+	/**
+	 * array of TXN IDs and the payment
+	 *
+	 * @var array
+	 */
+	protected static $_update_transactions_with_payment = array();
+
+
+	/**
+	 * schedule_update_transaction_with_payment
+	 * sets a wp_schedule_single_event() for updating any TXNs that may
+	 * require updating due to recently received payments
+	 *
+	 * @param int $timestamp
+	 * @param int $TXN_ID
+	 * @param int $PAY_ID
+	 */
+	public static function schedule_update_transaction_with_payment(
+		$timestamp,
+		$TXN_ID,
+		$PAY_ID
+	) {
+		do_action('AHEE_log', __CLASS__, __FUNCTION__);
+		// validate $TXN_ID and $timestamp
+		$TXN_ID = absint($TXN_ID);
+		$timestamp = absint($timestamp);
+		if ($TXN_ID && $timestamp) {
+			wp_schedule_single_event(
+				$timestamp,
+				'AHEE__EE_Cron_Tasks__update_transaction_with_payment_2',
+				array($TXN_ID, $PAY_ID)
+			);
+		}
+	}
+
+
+	/**
+	 * setup_update_for_transaction_with_payment
+	 * this is the callback for the action hook:
+	 * 'AHEE__EE_Cron_Tasks__update_transaction_with_payment'
+	 * which is setup by EE_Cron_Tasks::schedule_update_transaction_with_payment().
+	 * The passed TXN_ID and associated payment gets added to an array, and then
+	 * the EE_Cron_Tasks::update_transaction_with_payment() function is hooked into
+	 * 'shutdown' which will actually handle the processing of any
+	 * transactions requiring updating, because doing so now would be too early
+	 * and the required resources may not be available
+	 *
+	 * @param int $TXN_ID
+	 * @param int $PAY_ID
+	 */
+	public static function setup_update_for_transaction_with_payment($TXN_ID = 0, $PAY_ID = 0)
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__, $TXN_ID, '$TXN_ID');
+		if (absint($TXN_ID)) {
+			self::$_update_transactions_with_payment[ $TXN_ID ] = $PAY_ID;
+			add_action(
+				'shutdown',
+				array('EE_Cron_Tasks', 'update_transaction_with_payment'),
+				5
+			);
+		}
+	}
+
+
+	/**
+	 * update_transaction_with_payment
+	 * loops through the self::$_abandoned_transactions array
+	 * and attempts to finalize any TXNs that have not been completed
+	 * but have had their sessions expired, most likely due to a user not
+	 * returning from an off-site payment gateway
+	 *
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public static function update_transaction_with_payment()
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__);
+		if (
 // are there any TXNs that need cleaning up ?
-            empty(self::$_update_transactions_with_payment)
-            // reschedule the cron if we can't hit the db right now
-            || EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
-                'schedule_update_transaction_with_payment',
-                self::$_update_transactions_with_payment
-            )
-        ) {
-            return;
-        }
-        /** @type EE_Payment_Processor $payment_processor */
-        $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-        // set revisit flag for payment processor
-        $payment_processor->set_revisit();
-        // load EEM_Transaction
-        EE_Registry::instance()->load_model('Transaction');
-        foreach (self::$_update_transactions_with_payment as $TXN_ID => $PAY_ID) {
-            // reschedule the cron if we can't hit the db right now
-            if (! EE_Maintenance_Mode::instance()->models_can_query()) {
-                // reset cron job for updating the TXN
-                EE_Cron_Tasks::schedule_update_transaction_with_payment(
-                    time() + EE_Cron_Tasks::reschedule_timeout,
-                    $TXN_ID,
-                    $PAY_ID
-                );
-                continue;
-            }
-            $transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-            $payment = EEM_Payment::instance()->get_one_by_ID($PAY_ID);
-            // verify transaction
-            if ($transaction instanceof EE_Transaction && $payment instanceof EE_Payment) {
-                // now try to update the TXN with any payments
-                $payment_processor->update_txn_based_on_payment($transaction, $payment, true, true);
-            }
-            unset(self::$_update_transactions_with_payment[ $TXN_ID ]);
-        }
-    }
-
-
-
-    /************  END OF UPDATE TRANSACTION WITH PAYMENT  ************/
-
-
-    /*****************  EXPIRED TRANSACTION CHECK *****************/
-
-
-    /**
-     * array of TXN IDs
-     *
-     * @var array
-     */
-    protected static $_expired_transactions = array();
-
-
-    /**
-     * schedule_expired_transaction_check
-     * sets a wp_schedule_single_event() for following up on TXNs after their session has expired
-     *
-     * @param int $timestamp
-     * @param int $TXN_ID
-     */
-    public static function schedule_expired_transaction_check(
-        $timestamp,
-        $TXN_ID
-    ) {
-        // validate $TXN_ID and $timestamp
-        $TXN_ID = absint($TXN_ID);
-        $timestamp = absint($timestamp);
-        if ($TXN_ID && $timestamp) {
-            wp_schedule_single_event(
-                $timestamp,
-                'AHEE__EE_Cron_Tasks__expired_transaction_check',
-                array($TXN_ID)
-            );
-        }
-    }
-
-
-    /**
-     * expired_transaction_check
-     * this is the callback for the action hook:
-     * 'AHEE__EE_Cron_Tasks__transaction_session_expiration_check'
-     * which is utilized by wp_schedule_single_event()
-     * in \EED_Single_Page_Checkout::_initialize_transaction().
-     * The passed TXN_ID gets added to an array, and then the
-     * process_expired_transactions() function is hooked into
-     * 'AHEE__EE_System__core_loaded_and_ready' which will actually handle the
-     * processing of any failed transactions, because doing so now would be
-     * too early and the required resources may not be available
-     *
-     * @param int $TXN_ID
-     */
-    public static function expired_transaction_check($TXN_ID = 0)
-    {
-        if (absint($TXN_ID)) {
-            self::$_expired_transactions[ $TXN_ID ] = $TXN_ID;
-            add_action(
-                'shutdown',
-                array('EE_Cron_Tasks', 'process_expired_transactions'),
-                5
-            );
-        }
-    }
-
-
-    /**
-     * process_expired_transactions
-     * loops through the self::$_expired_transactions array and processes any failed TXNs
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws DomainException
-     * @throws RuntimeException
-     */
-    public static function process_expired_transactions()
-    {
-        if (
+			empty(self::$_update_transactions_with_payment)
+			// reschedule the cron if we can't hit the db right now
+			|| EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
+				'schedule_update_transaction_with_payment',
+				self::$_update_transactions_with_payment
+			)
+		) {
+			return;
+		}
+		/** @type EE_Payment_Processor $payment_processor */
+		$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+		// set revisit flag for payment processor
+		$payment_processor->set_revisit();
+		// load EEM_Transaction
+		EE_Registry::instance()->load_model('Transaction');
+		foreach (self::$_update_transactions_with_payment as $TXN_ID => $PAY_ID) {
+			// reschedule the cron if we can't hit the db right now
+			if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+				// reset cron job for updating the TXN
+				EE_Cron_Tasks::schedule_update_transaction_with_payment(
+					time() + EE_Cron_Tasks::reschedule_timeout,
+					$TXN_ID,
+					$PAY_ID
+				);
+				continue;
+			}
+			$transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+			$payment = EEM_Payment::instance()->get_one_by_ID($PAY_ID);
+			// verify transaction
+			if ($transaction instanceof EE_Transaction && $payment instanceof EE_Payment) {
+				// now try to update the TXN with any payments
+				$payment_processor->update_txn_based_on_payment($transaction, $payment, true, true);
+			}
+			unset(self::$_update_transactions_with_payment[ $TXN_ID ]);
+		}
+	}
+
+
+
+	/************  END OF UPDATE TRANSACTION WITH PAYMENT  ************/
+
+
+	/*****************  EXPIRED TRANSACTION CHECK *****************/
+
+
+	/**
+	 * array of TXN IDs
+	 *
+	 * @var array
+	 */
+	protected static $_expired_transactions = array();
+
+
+	/**
+	 * schedule_expired_transaction_check
+	 * sets a wp_schedule_single_event() for following up on TXNs after their session has expired
+	 *
+	 * @param int $timestamp
+	 * @param int $TXN_ID
+	 */
+	public static function schedule_expired_transaction_check(
+		$timestamp,
+		$TXN_ID
+	) {
+		// validate $TXN_ID and $timestamp
+		$TXN_ID = absint($TXN_ID);
+		$timestamp = absint($timestamp);
+		if ($TXN_ID && $timestamp) {
+			wp_schedule_single_event(
+				$timestamp,
+				'AHEE__EE_Cron_Tasks__expired_transaction_check',
+				array($TXN_ID)
+			);
+		}
+	}
+
+
+	/**
+	 * expired_transaction_check
+	 * this is the callback for the action hook:
+	 * 'AHEE__EE_Cron_Tasks__transaction_session_expiration_check'
+	 * which is utilized by wp_schedule_single_event()
+	 * in \EED_Single_Page_Checkout::_initialize_transaction().
+	 * The passed TXN_ID gets added to an array, and then the
+	 * process_expired_transactions() function is hooked into
+	 * 'AHEE__EE_System__core_loaded_and_ready' which will actually handle the
+	 * processing of any failed transactions, because doing so now would be
+	 * too early and the required resources may not be available
+	 *
+	 * @param int $TXN_ID
+	 */
+	public static function expired_transaction_check($TXN_ID = 0)
+	{
+		if (absint($TXN_ID)) {
+			self::$_expired_transactions[ $TXN_ID ] = $TXN_ID;
+			add_action(
+				'shutdown',
+				array('EE_Cron_Tasks', 'process_expired_transactions'),
+				5
+			);
+		}
+	}
+
+
+	/**
+	 * process_expired_transactions
+	 * loops through the self::$_expired_transactions array and processes any failed TXNs
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws DomainException
+	 * @throws RuntimeException
+	 */
+	public static function process_expired_transactions()
+	{
+		if (
 // are there any TXNs that need cleaning up ?
-            empty(self::$_expired_transactions)
-            // reschedule the cron if we can't hit the db right now
-            || EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
-                'schedule_expired_transaction_check',
-                self::$_expired_transactions
-            )
-        ) {
-            return;
-        }
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-        // set revisit flag for txn processor
-        $transaction_processor->set_revisit();
-        // load EEM_Transaction
-        EE_Registry::instance()->load_model('Transaction');
-        foreach (self::$_expired_transactions as $TXN_ID) {
-            $transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-            // verify transaction and whether it is failed or not
-            if ($transaction instanceof EE_Transaction) {
-                switch ($transaction->status_ID()) {
-                    // Completed TXNs
-                    case EEM_Transaction::complete_status_code:
-                        // Don't update the transaction/registrations if the Primary Registration is Not Approved.
-                        $primary_registration = $transaction->primary_registration();
-                        if (
-                            $primary_registration instanceof EE_Registration
-                            && $primary_registration->status_ID() !== EEM_Registration::status_id_not_approved
-                        ) {
-                            /** @type EE_Transaction_Processor $transaction_processor */
-                            $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-                            $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
-                                $transaction,
-                                $transaction->last_payment()
-                            );
-                            do_action(
-                                'AHEE__EE_Cron_Tasks__process_expired_transactions__completed_transaction',
-                                $transaction
-                            );
-                        }
-                        break;
-                    // Overpaid TXNs
-                    case EEM_Transaction::overpaid_status_code:
-                        do_action(
-                            'AHEE__EE_Cron_Tasks__process_expired_transactions__overpaid_transaction',
-                            $transaction
-                        );
-                        break;
-                    // Incomplete TXNs
-                    case EEM_Transaction::incomplete_status_code:
-                        do_action(
-                            'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction',
-                            $transaction
-                        );
-                        // todo : move business logic into EE_Transaction_Processor for finalizing abandoned transactions
-                        break;
-                    // Abandoned TXNs
-                    case EEM_Transaction::abandoned_status_code:
-                        // run hook before updating transaction, primarily so
-                        // EED_Ticket_Sales_Monitor::process_abandoned_transactions() can release reserved tickets
-                        do_action(
-                            'AHEE__EE_Cron_Tasks__process_expired_transactions__abandoned_transaction',
-                            $transaction
-                        );
-                        // don't finalize the TXN if it has already been completed
-                        if ($transaction->all_reg_steps_completed() !== true) {
-                            /** @type EE_Payment_Processor $payment_processor */
-                            $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-                            // let's simulate an IPN here which will trigger any notifications that need to go out
-                            $payment_processor->update_txn_based_on_payment(
-                                $transaction,
-                                $transaction->last_payment(),
-                                true,
-                                true
-                            );
-                        }
-                        break;
-                    // Failed TXNs
-                    case EEM_Transaction::failed_status_code:
-                        do_action(
-                            'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction',
-                            $transaction
-                        );
-                        // todo :
-                        // perform garbage collection here and remove clean_out_junk_transactions()
-                        // $registrations = $transaction->registrations();
-                        // if (! empty($registrations)) {
-                        //     foreach ($registrations as $registration) {
-                        //         if ($registration instanceof EE_Registration) {
-                        //             $delete_registration = true;
-                        //             if ($registration->attendee() instanceof EE_Attendee) {
-                        //                 $delete_registration = false;
-                        //             }
-                        //             if ($delete_registration) {
-                        //                 $registration->delete_permanently();
-                        //                 $registration->delete_related_permanently();
-                        //             }
-                        //         }
-                        //     }
-                        // }
-                        break;
-                }
-            }
-            unset(self::$_expired_transactions[ $TXN_ID ]);
-        }
-    }
-
-
-
-    /*************  END OF EXPIRED TRANSACTION CHECK  *************/
-
-
-    /************* START CLEAN UP BOT TRANSACTIONS **********************/
-
-
-    /**
-     * callback for 'AHEE__EE_Cron_Tasks__clean_up_junk_transactions'
-     * which is setup during activation to run on an hourly cron
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws DomainException
-     */
-    public static function clean_out_junk_transactions()
-    {
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            EED_Ticket_Sales_Monitor::reset_reservation_counts();
-            EEM_Transaction::instance('')->delete_junk_transactions();
-            EEM_Registration::instance('')->delete_registrations_with_no_transaction();
-            EEM_Line_Item::instance('')->delete_line_items_with_no_transaction();
-        }
-    }
-
-
-    /**
-     * Deletes old gateway logs. After about a week we usually don't need them for debugging. But folks can filter that.
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public static function clean_out_old_gateway_logs()
-    {
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            $reg_config = LoaderFactory::getLoader()->load('EE_Registration_Config');
-            $time_diff_for_comparison = apply_filters(
-                'FHEE__EE_Cron_Tasks__clean_out_old_gateway_logs__time_diff_for_comparison',
-                '-' . $reg_config->gateway_log_lifespan
-            );
-            EEM_Change_Log::instance()->delete_gateway_logs_older_than(new DateTime($time_diff_for_comparison));
-        }
-    }
-
-
-    /*****************  FINALIZE ABANDONED TRANSACTIONS *****************/
-
-
-    /**
-     * @var array
-     */
-    protected static $_abandoned_transactions = array();
-
-
-    /**
-     * @deprecated
-     * @param int $timestamp
-     * @param int $TXN_ID
-     */
-    public static function schedule_finalize_abandoned_transactions_check($timestamp, $TXN_ID)
-    {
-        EE_Cron_Tasks::schedule_expired_transaction_check($timestamp, $TXN_ID);
-    }
-
-
-    /**
-     * @deprecated
-     * @param int $TXN_ID
-     */
-    public static function check_for_abandoned_transactions($TXN_ID = 0)
-    {
-        EE_Cron_Tasks::expired_transaction_check($TXN_ID);
-    }
-
-
-    /**
-     * @deprecated
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public static function finalize_abandoned_transactions()
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__);
-        if (
+			empty(self::$_expired_transactions)
+			// reschedule the cron if we can't hit the db right now
+			|| EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
+				'schedule_expired_transaction_check',
+				self::$_expired_transactions
+			)
+		) {
+			return;
+		}
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+		// set revisit flag for txn processor
+		$transaction_processor->set_revisit();
+		// load EEM_Transaction
+		EE_Registry::instance()->load_model('Transaction');
+		foreach (self::$_expired_transactions as $TXN_ID) {
+			$transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+			// verify transaction and whether it is failed or not
+			if ($transaction instanceof EE_Transaction) {
+				switch ($transaction->status_ID()) {
+					// Completed TXNs
+					case EEM_Transaction::complete_status_code:
+						// Don't update the transaction/registrations if the Primary Registration is Not Approved.
+						$primary_registration = $transaction->primary_registration();
+						if (
+							$primary_registration instanceof EE_Registration
+							&& $primary_registration->status_ID() !== EEM_Registration::status_id_not_approved
+						) {
+							/** @type EE_Transaction_Processor $transaction_processor */
+							$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+							$transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
+								$transaction,
+								$transaction->last_payment()
+							);
+							do_action(
+								'AHEE__EE_Cron_Tasks__process_expired_transactions__completed_transaction',
+								$transaction
+							);
+						}
+						break;
+					// Overpaid TXNs
+					case EEM_Transaction::overpaid_status_code:
+						do_action(
+							'AHEE__EE_Cron_Tasks__process_expired_transactions__overpaid_transaction',
+							$transaction
+						);
+						break;
+					// Incomplete TXNs
+					case EEM_Transaction::incomplete_status_code:
+						do_action(
+							'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction',
+							$transaction
+						);
+						// todo : move business logic into EE_Transaction_Processor for finalizing abandoned transactions
+						break;
+					// Abandoned TXNs
+					case EEM_Transaction::abandoned_status_code:
+						// run hook before updating transaction, primarily so
+						// EED_Ticket_Sales_Monitor::process_abandoned_transactions() can release reserved tickets
+						do_action(
+							'AHEE__EE_Cron_Tasks__process_expired_transactions__abandoned_transaction',
+							$transaction
+						);
+						// don't finalize the TXN if it has already been completed
+						if ($transaction->all_reg_steps_completed() !== true) {
+							/** @type EE_Payment_Processor $payment_processor */
+							$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+							// let's simulate an IPN here which will trigger any notifications that need to go out
+							$payment_processor->update_txn_based_on_payment(
+								$transaction,
+								$transaction->last_payment(),
+								true,
+								true
+							);
+						}
+						break;
+					// Failed TXNs
+					case EEM_Transaction::failed_status_code:
+						do_action(
+							'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction',
+							$transaction
+						);
+						// todo :
+						// perform garbage collection here and remove clean_out_junk_transactions()
+						// $registrations = $transaction->registrations();
+						// if (! empty($registrations)) {
+						//     foreach ($registrations as $registration) {
+						//         if ($registration instanceof EE_Registration) {
+						//             $delete_registration = true;
+						//             if ($registration->attendee() instanceof EE_Attendee) {
+						//                 $delete_registration = false;
+						//             }
+						//             if ($delete_registration) {
+						//                 $registration->delete_permanently();
+						//                 $registration->delete_related_permanently();
+						//             }
+						//         }
+						//     }
+						// }
+						break;
+				}
+			}
+			unset(self::$_expired_transactions[ $TXN_ID ]);
+		}
+	}
+
+
+
+	/*************  END OF EXPIRED TRANSACTION CHECK  *************/
+
+
+	/************* START CLEAN UP BOT TRANSACTIONS **********************/
+
+
+	/**
+	 * callback for 'AHEE__EE_Cron_Tasks__clean_up_junk_transactions'
+	 * which is setup during activation to run on an hourly cron
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws DomainException
+	 */
+	public static function clean_out_junk_transactions()
+	{
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			EED_Ticket_Sales_Monitor::reset_reservation_counts();
+			EEM_Transaction::instance('')->delete_junk_transactions();
+			EEM_Registration::instance('')->delete_registrations_with_no_transaction();
+			EEM_Line_Item::instance('')->delete_line_items_with_no_transaction();
+		}
+	}
+
+
+	/**
+	 * Deletes old gateway logs. After about a week we usually don't need them for debugging. But folks can filter that.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public static function clean_out_old_gateway_logs()
+	{
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			$reg_config = LoaderFactory::getLoader()->load('EE_Registration_Config');
+			$time_diff_for_comparison = apply_filters(
+				'FHEE__EE_Cron_Tasks__clean_out_old_gateway_logs__time_diff_for_comparison',
+				'-' . $reg_config->gateway_log_lifespan
+			);
+			EEM_Change_Log::instance()->delete_gateway_logs_older_than(new DateTime($time_diff_for_comparison));
+		}
+	}
+
+
+	/*****************  FINALIZE ABANDONED TRANSACTIONS *****************/
+
+
+	/**
+	 * @var array
+	 */
+	protected static $_abandoned_transactions = array();
+
+
+	/**
+	 * @deprecated
+	 * @param int $timestamp
+	 * @param int $TXN_ID
+	 */
+	public static function schedule_finalize_abandoned_transactions_check($timestamp, $TXN_ID)
+	{
+		EE_Cron_Tasks::schedule_expired_transaction_check($timestamp, $TXN_ID);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @param int $TXN_ID
+	 */
+	public static function check_for_abandoned_transactions($TXN_ID = 0)
+	{
+		EE_Cron_Tasks::expired_transaction_check($TXN_ID);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public static function finalize_abandoned_transactions()
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__);
+		if (
 // are there any TXNs that need cleaning up ?
-            empty(self::$_abandoned_transactions)
-            // reschedule the cron if we can't hit the db right now
-            || EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
-                'schedule_expired_transaction_check',
-                self::$_abandoned_transactions
-            )
-        ) {
-            return;
-        }
-        // combine our arrays of transaction IDs
-        self::$_expired_transactions = self::$_abandoned_transactions + self::$_expired_transactions;
-        // and deal with abandoned transactions here now...
-        EE_Cron_Tasks::process_expired_transactions();
-    }
-
-
-    /*************  END OF FINALIZE ABANDONED TRANSACTIONS  *************/
+			empty(self::$_abandoned_transactions)
+			// reschedule the cron if we can't hit the db right now
+			|| EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
+				'schedule_expired_transaction_check',
+				self::$_abandoned_transactions
+			)
+		) {
+			return;
+		}
+		// combine our arrays of transaction IDs
+		self::$_expired_transactions = self::$_abandoned_transactions + self::$_expired_transactions;
+		// and deal with abandoned transactions here now...
+		EE_Cron_Tasks::process_expired_transactions();
+	}
+
+
+	/*************  END OF FINALIZE ABANDONED TRANSACTIONS  *************/
 }

core/helpers/EEH_Template_Validator.helper.php

Spacing +13 added lines, -13 removed lines

@@ -40,10 +40,10 @@ 
      */
     public static function verify_is_array_of($variable_to_test, $name_of_variable, $class_name, $allow_null = 'allow_null')
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
+        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null', 'do_not_allow_null'));
         if ('allow_null' == $allow_null && is_null($variable_to_test)) {
             return;
         }
@@ -66,7 +66,7 @@ 
      */
     public static function verify_isnt_null($variable_to_test, $name_of_variable)
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
         if ($variable_to_test == null && $variable_to_test != 0 && $variable_to_test != false) {
@@ -86,10 +86,10 @@ 
      */
     public static function verify_is_true($expression_to_test, $expression_string_representation)
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        if (!$expression_to_test) {
+        if ( ! $expression_to_test) {
             $error[] = esc_html__('Template error.', 'event_espresso');
             $error[] = esc_html__("%s evaluated to false, but it must be true!", 'event_espresso');
             throw new EE_Error(sprintf(implode(",", $error), $expression_string_representation));
@@ -110,14 +110,14 @@ 
      */
     public static function verify_instanceof($variable_to_test, $name_of_variable, $class_name, $allow_null = 'do_not_allow_null')
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
+        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null', 'do_not_allow_null'));
         if ($allow_null == 'allow_null' && is_null($variable_to_test)) {
             return;
         }
-        if ($variable_to_test == null ||  ! ( $variable_to_test instanceof $class_name )) {
+        if ($variable_to_test == null || ! ($variable_to_test instanceof $class_name)) {
             $msg[] = esc_html__('Variable %s is not of the correct type.', 'event_espresso');
             $msg[] = esc_html__("It should be of type %s", 'event_espresso');
             throw new EE_Error(sprintf(implode(",", $msg), $name_of_variable, $name_of_variable, $class_name));
@@ -138,14 +138,14 @@ 
      */
     public static function verify_is_array($variable_to_test, $variable_name, $allow_empty = 'allow_empty')
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        self::verify_argument_is_one_of($allow_empty, $variable_name, array('allow_empty','do_not_allow_empty'));
+        self::verify_argument_is_one_of($allow_empty, $variable_name, array('allow_empty', 'do_not_allow_empty'));
         if (empty($variable_to_test) && 'allow_empty' == $allow_empty) {
             return;
         }
-        if (!is_array($variable_to_test)) {
+        if ( ! is_array($variable_to_test)) {
             $error[] = esc_html__('Variable %s should be an array, but it is not.', 'event_espresso');
             $error[] = esc_html__("Its value is, instead '%s'", 'event_espresso');
             throw new EE_Error(sprintf(implode(",", $error), $variable_name, $variable_name, $variable_to_test));
@@ -168,10 +168,10 @@ 
      */
     public static function verify_argument_is_one_of($variable_to_test, $variable_name, $string_options)
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        if (!in_array($variable_to_test, $string_options)) {
+        if ( ! in_array($variable_to_test, $string_options)) {
             $msg[0] = esc_html__('Malconfigured template.', 'event_espresso');
             $msg[1] = esc_html__("Variable named '%s' was set to '%s'. It can only be one of '%s'", 'event_espresso');
             throw new EE_Error(sprintf(implode("||", $msg), $variable_name, $variable_to_test, implode("', '", $string_options)));

Indentation +148 added lines, -148 removed lines

@@ -24,152 +24,152 @@
  */
 class EEH_Template_Validator
 {
-    /**
-     * Throws an EE_Error if $variabel_to_test isn't an array of objects of class $class_name
-     * @param mixed $variable_to_test
-     * @param string $name_of_variable helpful in throwing intelligent errors
-     * @param string $class_name eg EE_Answer, EE_Transaction, etc.
-     * @param string $allow_null one of 'allow_null', or 'do_not_allow_null'
-     * @return void
-     * @throws EE_Error (indirectly)
-     */
-    public static function verify_is_array_of($variable_to_test, $name_of_variable, $class_name, $allow_null = 'allow_null')
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
-        if ('allow_null' == $allow_null && is_null($variable_to_test)) {
-            return;
-        }
-        self::verify_is_array($variable_to_test, $name_of_variable);
-        foreach ($variable_to_test as $key => $array_element) {
-            self::verify_instanceof($array_element, $key, $class_name);
-        }
-    }
-
-
-
-
-
-    /**
-     * throws an EE_Error if $variable_to_test is null
-     * @param mixed $variable_to_test
-     * @param string $name_of_variable helpful for throwing intelligent errors
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_isnt_null($variable_to_test, $name_of_variable)
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        if ($variable_to_test == null && $variable_to_test != 0 && $variable_to_test != false) {
-            $error[] = esc_html__('Variable named %s is null.', 'event_espresso');
-            $error[] = esc_html__("Consider looking at the stack trace to see why it wasn't set.", 'event_espresso');
-            throw new EE_Error(sprintf(implode(",", $error), $name_of_variable, $name_of_variable));
-        }
-    }
-
-    /**
-     * When WP_DEBUG is activted, throws an error if $expression_to_test is false.
-     * @param boolean $expression_to_test
-     * @param string $expression_string_representation a string representation of your expression
-     * for example, if your expression were $var1==23, then this should be '$var1==23'
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_is_true($expression_to_test, $expression_string_representation)
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        if (!$expression_to_test) {
-            $error[] = esc_html__('Template error.', 'event_espresso');
-            $error[] = esc_html__("%s evaluated to false, but it must be true!", 'event_espresso');
-            throw new EE_Error(sprintf(implode(",", $error), $expression_string_representation));
-        }
-    }
-
-
-
-
-
-    /**
-     * For verifying that a variable is indeed an object of class $class_name
-     * @param mixed $variable_to_test
-     * @param string $name_of_variable helpful when throwing errors
-     * @param string $class_name eg, EE_Answer,
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_instanceof($variable_to_test, $name_of_variable, $class_name, $allow_null = 'do_not_allow_null')
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
-        if ($allow_null == 'allow_null' && is_null($variable_to_test)) {
-            return;
-        }
-        if ($variable_to_test == null ||  ! ( $variable_to_test instanceof $class_name )) {
-            $msg[] = esc_html__('Variable %s is not of the correct type.', 'event_espresso');
-            $msg[] = esc_html__("It should be of type %s", 'event_espresso');
-            throw new EE_Error(sprintf(implode(",", $msg), $name_of_variable, $name_of_variable, $class_name));
-        }
-    }
-
-
-
-
-
-    /**
-     * For verifying that a variable is indeed an array, else throw an EE_Error
-     * @param type $variable_to_test
-     * @param type $variable_name
-     * @param type $allow_empty one of 'allow_empty' or 'do_not_allow_empty'
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_is_array($variable_to_test, $variable_name, $allow_empty = 'allow_empty')
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        self::verify_argument_is_one_of($allow_empty, $variable_name, array('allow_empty','do_not_allow_empty'));
-        if (empty($variable_to_test) && 'allow_empty' == $allow_empty) {
-            return;
-        }
-        if (!is_array($variable_to_test)) {
-            $error[] = esc_html__('Variable %s should be an array, but it is not.', 'event_espresso');
-            $error[] = esc_html__("Its value is, instead '%s'", 'event_espresso');
-            throw new EE_Error(sprintf(implode(",", $error), $variable_name, $variable_name, $variable_to_test));
-        }
-    }
-
-
-
-
-
-
-
-    /**
-     * for verifying that a variable is one of the string optiosn supplied
-     * @param mixed $variable_to_test
-     * @param mixed $variable_name the name you've given the variable. Eg, '$foo'. THis helps in producing better error messages
-     * @param array $string_options an array of acceptable values
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_argument_is_one_of($variable_to_test, $variable_name, $string_options)
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        if (!in_array($variable_to_test, $string_options)) {
-            $msg[0] = esc_html__('Malconfigured template.', 'event_espresso');
-            $msg[1] = esc_html__("Variable named '%s' was set to '%s'. It can only be one of '%s'", 'event_espresso');
-            throw new EE_Error(sprintf(implode("||", $msg), $variable_name, $variable_to_test, implode("', '", $string_options)));
-        }
-    }
+	/**
+	 * Throws an EE_Error if $variabel_to_test isn't an array of objects of class $class_name
+	 * @param mixed $variable_to_test
+	 * @param string $name_of_variable helpful in throwing intelligent errors
+	 * @param string $class_name eg EE_Answer, EE_Transaction, etc.
+	 * @param string $allow_null one of 'allow_null', or 'do_not_allow_null'
+	 * @return void
+	 * @throws EE_Error (indirectly)
+	 */
+	public static function verify_is_array_of($variable_to_test, $name_of_variable, $class_name, $allow_null = 'allow_null')
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
+		if ('allow_null' == $allow_null && is_null($variable_to_test)) {
+			return;
+		}
+		self::verify_is_array($variable_to_test, $name_of_variable);
+		foreach ($variable_to_test as $key => $array_element) {
+			self::verify_instanceof($array_element, $key, $class_name);
+		}
+	}
+
+
+
+
+
+	/**
+	 * throws an EE_Error if $variable_to_test is null
+	 * @param mixed $variable_to_test
+	 * @param string $name_of_variable helpful for throwing intelligent errors
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_isnt_null($variable_to_test, $name_of_variable)
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		if ($variable_to_test == null && $variable_to_test != 0 && $variable_to_test != false) {
+			$error[] = esc_html__('Variable named %s is null.', 'event_espresso');
+			$error[] = esc_html__("Consider looking at the stack trace to see why it wasn't set.", 'event_espresso');
+			throw new EE_Error(sprintf(implode(",", $error), $name_of_variable, $name_of_variable));
+		}
+	}
+
+	/**
+	 * When WP_DEBUG is activted, throws an error if $expression_to_test is false.
+	 * @param boolean $expression_to_test
+	 * @param string $expression_string_representation a string representation of your expression
+	 * for example, if your expression were $var1==23, then this should be '$var1==23'
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_is_true($expression_to_test, $expression_string_representation)
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		if (!$expression_to_test) {
+			$error[] = esc_html__('Template error.', 'event_espresso');
+			$error[] = esc_html__("%s evaluated to false, but it must be true!", 'event_espresso');
+			throw new EE_Error(sprintf(implode(",", $error), $expression_string_representation));
+		}
+	}
+
+
+
+
+
+	/**
+	 * For verifying that a variable is indeed an object of class $class_name
+	 * @param mixed $variable_to_test
+	 * @param string $name_of_variable helpful when throwing errors
+	 * @param string $class_name eg, EE_Answer,
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_instanceof($variable_to_test, $name_of_variable, $class_name, $allow_null = 'do_not_allow_null')
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
+		if ($allow_null == 'allow_null' && is_null($variable_to_test)) {
+			return;
+		}
+		if ($variable_to_test == null ||  ! ( $variable_to_test instanceof $class_name )) {
+			$msg[] = esc_html__('Variable %s is not of the correct type.', 'event_espresso');
+			$msg[] = esc_html__("It should be of type %s", 'event_espresso');
+			throw new EE_Error(sprintf(implode(",", $msg), $name_of_variable, $name_of_variable, $class_name));
+		}
+	}
+
+
+
+
+
+	/**
+	 * For verifying that a variable is indeed an array, else throw an EE_Error
+	 * @param type $variable_to_test
+	 * @param type $variable_name
+	 * @param type $allow_empty one of 'allow_empty' or 'do_not_allow_empty'
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_is_array($variable_to_test, $variable_name, $allow_empty = 'allow_empty')
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		self::verify_argument_is_one_of($allow_empty, $variable_name, array('allow_empty','do_not_allow_empty'));
+		if (empty($variable_to_test) && 'allow_empty' == $allow_empty) {
+			return;
+		}
+		if (!is_array($variable_to_test)) {
+			$error[] = esc_html__('Variable %s should be an array, but it is not.', 'event_espresso');
+			$error[] = esc_html__("Its value is, instead '%s'", 'event_espresso');
+			throw new EE_Error(sprintf(implode(",", $error), $variable_name, $variable_name, $variable_to_test));
+		}
+	}
+
+
+
+
+
+
+
+	/**
+	 * for verifying that a variable is one of the string optiosn supplied
+	 * @param mixed $variable_to_test
+	 * @param mixed $variable_name the name you've given the variable. Eg, '$foo'. THis helps in producing better error messages
+	 * @param array $string_options an array of acceptable values
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_argument_is_one_of($variable_to_test, $variable_name, $string_options)
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		if (!in_array($variable_to_test, $string_options)) {
+			$msg[0] = esc_html__('Malconfigured template.', 'event_espresso');
+			$msg[1] = esc_html__("Variable named '%s' was set to '%s'. It can only be one of '%s'", 'event_espresso');
+			throw new EE_Error(sprintf(implode("||", $msg), $variable_name, $variable_to_test, implode("', '", $string_options)));
+		}
+	}
 }

core/exceptions/InvalidStatusException.php

Indentation +22 added lines, -22 removed lines

@@ -7,26 +7,26 @@
 
 class InvalidStatusException extends InvalidArgumentException
 {
-    /**
-     * InvalidStatusException constructor.
-     * @param string $status the invalid status id that was supplied
-     * @param string $domain the name of the domain, model, or class that the status belongs to
-     * @param string $message custom message
-     * @param int $code
-     * @param Exception|null $previous
-     */
-    public function __construct($status, $domain, $message = '', $code = 0, Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                esc_html__(
-                    '"%1$s" is not a valid %2$s status',
-                    'event_espresso'
-                ),
-                $status,
-                $domain
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * InvalidStatusException constructor.
+	 * @param string $status the invalid status id that was supplied
+	 * @param string $domain the name of the domain, model, or class that the status belongs to
+	 * @param string $message custom message
+	 * @param int $code
+	 * @param Exception|null $previous
+	 */
+	public function __construct($status, $domain, $message = '', $code = 0, Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				esc_html__(
+					'"%1$s" is not a valid %2$s status',
+					'event_espresso'
+				),
+				$status,
+				$domain
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

core/exceptions/InvalidDataTypeException.php

Spacing +2 added lines, -2 removed lines

@@ -31,7 +31,7 @@ 
     {
         if (empty($message)) {
             $expected = strpos(' was expected.', $expected) === false
-                ? $this->addIndefiniteArticle($expected) . ' was expected.'
+                ? $this->addIndefiniteArticle($expected).' was expected.'
                 : $expected;
             $message = sprintf(
                 esc_html__(
@@ -56,6 +56,6 @@ 
         if (strtolower($string) === 'null') {
             return $string;
         }
-        return (stripos('aeiou', $string[0]) !== false ? 'an ' : 'a ') . $string;
+        return (stripos('aeiou', $string[0]) !== false ? 'an ' : 'a ').$string;
     }
 }

Indentation +40 added lines, -40 removed lines

@@ -15,46 +15,46 @@
  */
 class InvalidDataTypeException extends InvalidArgumentException
 {
-    /**
-     * InvalidDataTypeException constructor
-     *
-     * @param string    $var_name  name of the variable that was of the wrong type ie: "$my_var"
-     * @param mixed     $variable  the actual variable that was of the wrong data type, ie: $my_var
-     * @param string    $expected  data type we wanted ie: "integer", "string", "array", etc.
-     *                             or an entire rewrite of: "{something something} was expected."
-     * @param string    $message
-     * @param int       $code
-     * @param Exception $previous
-     */
-    public function __construct($var_name, $variable, $expected, $message = '', $code = 0, Exception $previous = null)
-    {
-        if (empty($message)) {
-            $expected = strpos(' was expected.', $expected) === false
-                ? $this->addIndefiniteArticle($expected) . ' was expected.'
-                : $expected;
-            $message = sprintf(
-                esc_html__(
-                    'The supplied data for "%1$s" was %2$s, but %3$s',
-                    'event_espresso'
-                ),
-                $var_name,
-                $this->addIndefiniteArticle(gettype($variable)),
-                $expected
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * InvalidDataTypeException constructor
+	 *
+	 * @param string    $var_name  name of the variable that was of the wrong type ie: "$my_var"
+	 * @param mixed     $variable  the actual variable that was of the wrong data type, ie: $my_var
+	 * @param string    $expected  data type we wanted ie: "integer", "string", "array", etc.
+	 *                             or an entire rewrite of: "{something something} was expected."
+	 * @param string    $message
+	 * @param int       $code
+	 * @param Exception $previous
+	 */
+	public function __construct($var_name, $variable, $expected, $message = '', $code = 0, Exception $previous = null)
+	{
+		if (empty($message)) {
+			$expected = strpos(' was expected.', $expected) === false
+				? $this->addIndefiniteArticle($expected) . ' was expected.'
+				: $expected;
+			$message = sprintf(
+				esc_html__(
+					'The supplied data for "%1$s" was %2$s, but %3$s',
+					'event_espresso'
+				),
+				$var_name,
+				$this->addIndefiniteArticle(gettype($variable)),
+				$expected
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 
 
-    /**
-     * @param $string
-     * @return string
-     */
-    protected function addIndefiniteArticle($string)
-    {
-        if (strtolower($string) === 'null') {
-            return $string;
-        }
-        return (stripos('aeiou', $string[0]) !== false ? 'an ' : 'a ') . $string;
-    }
+	/**
+	 * @param $string
+	 * @return string
+	 */
+	protected function addIndefiniteArticle($string)
+	{
+		if (strtolower($string) === 'null') {
+			return $string;
+		}
+		return (stripos('aeiou', $string[0]) !== false ? 'an ' : 'a ') . $string;
+	}
 }

payment_methods/Paypal_Express/templates/paypal_express_intro.template.php

Indentation +6 added lines, -6 removed lines

@@ -1,10 +1,10 @@
 <?php
 
 printf(
-    esc_html__(
-        'PayPal Express (Express Checkout) is an off-site payment method for accepting payments via PayPal and is available to event organizers in many countries. A PayPal premier or business account is needed to accept payments. Need a PayPal account? Call 1-855-456-1338 or %1$sclick here to sign up for a merchant account%2$s.',
-        'event_espresso'
-    ),
-    '<a href="https://eventespresso.com/go/paypalexpress/" target="_blank">',
-    '</a>'
+	esc_html__(
+		'PayPal Express (Express Checkout) is an off-site payment method for accepting payments via PayPal and is available to event organizers in many countries. A PayPal premier or business account is needed to accept payments. Need a PayPal account? Call 1-855-456-1338 or %1$sclick here to sign up for a merchant account%2$s.',
+		'event_espresso'
+	),
+	'<a href="https://eventespresso.com/go/paypalexpress/" target="_blank">',
+	'</a>'
 );

payment_methods/Paypal_Standard/EE_Paypal_Standard_Form.form.php

Spacing +3 added lines, -3 removed lines

@@ -67,7 +67,7 @@ 
         $paypal_calculates_taxes = $this->get_input_value('paypal_taxes');
         $paypal_requests_address_info = $this->get_input_value('shipping_details');
         if (
-            ( $paypal_calculates_shipping || $paypal_calculates_taxes ) &&
+            ($paypal_calculates_shipping || $paypal_calculates_taxes) &&
             $paypal_requests_address_info == EE_PMT_Paypal_Standard::shipping_info_none
         ) {
             // they want paypal to calculate taxes or shipping. They need to ask for
@@ -80,8 +80,8 @@ 
                 sprintf(
                     esc_html__('Automatically set "%s" to "%s" because Paypal requires address info in order to calculate shipping or taxes.', 'event_espresso'),
                     strip_tags($shipping_details_input->html_label_text()),
-                    isset($shipping_details_input_options[ EE_PMT_Paypal_Standard::shipping_info_optional ])
-                        ? $shipping_details_input_options[ EE_PMT_Paypal_Standard::shipping_info_optional ]
+                    isset($shipping_details_input_options[EE_PMT_Paypal_Standard::shipping_info_optional])
+                        ? $shipping_details_input_options[EE_PMT_Paypal_Standard::shipping_info_optional]
                         : esc_html__('Unknown', 'event_espresso')
                 ),
                 __FILE__,

Indentation +71 added lines, -71 removed lines

@@ -13,78 +13,78 @@
  */
 class EE_Paypal_Standard_Form extends EE_Payment_Method_Form
 {
-    /**
-     * @param EE_PMT_Paypal_Standard $payment_method_type
-     */
-    public function __construct($payment_method_type)
-    {
-        parent::__construct(
-            array(
-                'payment_method_type'          => $payment_method_type,
-                'extra_meta_inputs'            => array(
-                    'paypal_id'        => new EE_Text_Input(array(
-                        'html_label_text' => sprintf(esc_html__("Paypal Email %s", 'event_espresso'), $payment_method_type->get_help_tab_link()),
-                        'html_help_text'  => esc_html__("Typically payment@example-domain.com", 'event_espresso'),
-                        'required'        => true
-                    )),
-                    'image_url'        => new EE_Admin_File_Uploader_Input(array(
-                        'html_help_text'  => esc_html__("Used for your business/personal logo on the PayPal page", 'event_espresso'),
-                        'html_label_text' => esc_html__('Image URL', 'event_espresso')
-                    )),
-                    'paypal_taxes'     => new EE_Yes_No_Input(array(
-                        'html_label_text' => sprintf(esc_html__('Paypal Calculates Taxes %s', 'event_espresso'), $payment_method_type->get_help_tab_link()),
-                        'html_help_text'  => esc_html__('Whether Paypal should add taxes to the order', 'event_espresso'),
-                        'default'         => false
-                    )),
-                    'paypal_shipping'  => new EE_Yes_No_Input(array(
-                        'html_label_text' => sprintf(esc_html__('Paypal Calculates Shipping %s', 'event_espresso'), $payment_method_type->get_help_tab_link()),
-                        'html_help_text'  => esc_html__('Whether Paypal should add shipping surcharges', 'event_espresso'),
-                        'default'         => false
-                    )),
-                    'shipping_details' => new EE_Select_Input(array(
-                        EE_PMT_Paypal_Standard::shipping_info_none     => esc_html__("Do not prompt for an address", 'event_espresso'),
-                        EE_PMT_Paypal_Standard::shipping_info_optional => esc_html__("Prompt for an address, but do not require it", 'event_espresso'),
-                        EE_PMT_Paypal_Standard::shipping_info_required => esc_html__("Prompt for an address, and require it", 'event_espresso')
-                    ))
-                )
-            )
-        );
-    }
+	/**
+	 * @param EE_PMT_Paypal_Standard $payment_method_type
+	 */
+	public function __construct($payment_method_type)
+	{
+		parent::__construct(
+			array(
+				'payment_method_type'          => $payment_method_type,
+				'extra_meta_inputs'            => array(
+					'paypal_id'        => new EE_Text_Input(array(
+						'html_label_text' => sprintf(esc_html__("Paypal Email %s", 'event_espresso'), $payment_method_type->get_help_tab_link()),
+						'html_help_text'  => esc_html__("Typically payment@example-domain.com", 'event_espresso'),
+						'required'        => true
+					)),
+					'image_url'        => new EE_Admin_File_Uploader_Input(array(
+						'html_help_text'  => esc_html__("Used for your business/personal logo on the PayPal page", 'event_espresso'),
+						'html_label_text' => esc_html__('Image URL', 'event_espresso')
+					)),
+					'paypal_taxes'     => new EE_Yes_No_Input(array(
+						'html_label_text' => sprintf(esc_html__('Paypal Calculates Taxes %s', 'event_espresso'), $payment_method_type->get_help_tab_link()),
+						'html_help_text'  => esc_html__('Whether Paypal should add taxes to the order', 'event_espresso'),
+						'default'         => false
+					)),
+					'paypal_shipping'  => new EE_Yes_No_Input(array(
+						'html_label_text' => sprintf(esc_html__('Paypal Calculates Shipping %s', 'event_espresso'), $payment_method_type->get_help_tab_link()),
+						'html_help_text'  => esc_html__('Whether Paypal should add shipping surcharges', 'event_espresso'),
+						'default'         => false
+					)),
+					'shipping_details' => new EE_Select_Input(array(
+						EE_PMT_Paypal_Standard::shipping_info_none     => esc_html__("Do not prompt for an address", 'event_espresso'),
+						EE_PMT_Paypal_Standard::shipping_info_optional => esc_html__("Prompt for an address, but do not require it", 'event_espresso'),
+						EE_PMT_Paypal_Standard::shipping_info_required => esc_html__("Prompt for an address, and require it", 'event_espresso')
+					))
+				)
+			)
+		);
+	}
 
 
 
-    /**
-     * @param array $req_data
-     * @throws EE_Error
-     */
-    public function _normalize($req_data)
-    {
-        parent::_normalize($req_data);
-        $paypal_calculates_shipping = $this->get_input_value('paypal_shipping');
-        $paypal_calculates_taxes = $this->get_input_value('paypal_taxes');
-        $paypal_requests_address_info = $this->get_input_value('shipping_details');
-        if (
-            ( $paypal_calculates_shipping || $paypal_calculates_taxes ) &&
-            $paypal_requests_address_info == EE_PMT_Paypal_Standard::shipping_info_none
-        ) {
-            // they want paypal to calculate taxes or shipping. They need to ask for
-            // address info, otherwise paypal can't calculate taxes or shipping
-            /** @type EE_Select_Input $shipping_details_input */
-            $shipping_details_input = $this->get_input('shipping_details');
-            $shipping_details_input->set_default(EE_PMT_Paypal_Standard::shipping_info_optional);
-            $shipping_details_input_options = $shipping_details_input->options();
-            EE_Error::add_attention(
-                sprintf(
-                    esc_html__('Automatically set "%s" to "%s" because Paypal requires address info in order to calculate shipping or taxes.', 'event_espresso'),
-                    strip_tags($shipping_details_input->html_label_text()),
-                    isset($shipping_details_input_options[ EE_PMT_Paypal_Standard::shipping_info_optional ])
-                        ? $shipping_details_input_options[ EE_PMT_Paypal_Standard::shipping_info_optional ]
-                        : esc_html__('Unknown', 'event_espresso')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
+	/**
+	 * @param array $req_data
+	 * @throws EE_Error
+	 */
+	public function _normalize($req_data)
+	{
+		parent::_normalize($req_data);
+		$paypal_calculates_shipping = $this->get_input_value('paypal_shipping');
+		$paypal_calculates_taxes = $this->get_input_value('paypal_taxes');
+		$paypal_requests_address_info = $this->get_input_value('shipping_details');
+		if (
+			( $paypal_calculates_shipping || $paypal_calculates_taxes ) &&
+			$paypal_requests_address_info == EE_PMT_Paypal_Standard::shipping_info_none
+		) {
+			// they want paypal to calculate taxes or shipping. They need to ask for
+			// address info, otherwise paypal can't calculate taxes or shipping
+			/** @type EE_Select_Input $shipping_details_input */
+			$shipping_details_input = $this->get_input('shipping_details');
+			$shipping_details_input->set_default(EE_PMT_Paypal_Standard::shipping_info_optional);
+			$shipping_details_input_options = $shipping_details_input->options();
+			EE_Error::add_attention(
+				sprintf(
+					esc_html__('Automatically set "%s" to "%s" because Paypal requires address info in order to calculate shipping or taxes.', 'event_espresso'),
+					strip_tags($shipping_details_input->html_label_text()),
+					isset($shipping_details_input_options[ EE_PMT_Paypal_Standard::shipping_info_optional ])
+						? $shipping_details_input_options[ EE_PMT_Paypal_Standard::shipping_info_optional ]
+						: esc_html__('Unknown', 'event_espresso')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
 }

payment_methods/Check/EE_PMT_Check.pm.php

Spacing +9 added lines, -9 removed lines

@@ -22,7 +22,7 @@ 
         $this->_pretty_name = esc_html__("Check", 'event_espresso');
         $this->_default_description = esc_html__('After clicking "Finalize Registration", you will be given instructions on how to complete your payment.', 'event_espresso');
         parent::__construct($pm_instance);
-        $this->_default_button_url = $this->file_url() . 'lib/check-logo.png';
+        $this->_default_button_url = $this->file_url().'lib/check-logo.png';
     }
 
 
@@ -48,14 +48,14 @@ 
         if (EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance) {
             $organization = EE_Registry::instance()->CFG->organization;
             $organization_name = $organization->get_pretty('name');
-            $default_address = $organization->address_1 != '' ? $organization->get_pretty('address_1') . '<br />' : '';
-            $default_address .= $organization->address_2 != '' ? $organization->get_pretty('address_2') . '<br />' : '';
+            $default_address = $organization->address_1 != '' ? $organization->get_pretty('address_1').'<br />' : '';
+            $default_address .= $organization->address_2 != '' ? $organization->get_pretty('address_2').'<br />' : '';
             $default_address .= $organization->city != '' ? $organization->get_pretty('city') : '';
-            $default_address .= ( $organization->city != '' && $organization->STA_ID != '') ? ', ' : '<br />';
+            $default_address .= ($organization->city != '' && $organization->STA_ID != '') ? ', ' : '<br />';
             $state = EE_Registry::instance()->load_model('State')->get_one_by_ID($organization->STA_ID);
-            $country = EE_Registry::instance()->load_model('Country')->get_one_by_ID($organization->CNT_ISO) ;
-            $default_address .=  $state ? $state->name() . '<br />' : '';
-            $default_address .= $country ? $country->name() . '<br />' : '';
+            $country = EE_Registry::instance()->load_model('Country')->get_one_by_ID($organization->CNT_ISO);
+            $default_address .= $state ? $state->name().'<br />' : '';
+            $default_address .= $country ? $country->name().'<br />' : '';
             $default_address .= $organization->zip != '' ? $organization->get_pretty('zip') : '';
         } else {
             $default_address = 'unknown';
@@ -70,7 +70,7 @@ 
                 'payment_instructions' => new EE_Text_Area_Input(array(
                     'html_label_text' =>  sprintf(esc_html__("Instructions %s", "event_espresso"), $this->get_help_tab_link()),
                     'default' => esc_html__("Please send Check/Money Order to the address below. Payment must be received within 48 hours of event date.", 'event_espresso'),
-                    'validation_strategies' => array( new EE_Full_HTML_Validation_Strategy() ),
+                    'validation_strategies' => array(new EE_Full_HTML_Validation_Strategy()),
                 )),
                 'payable_to' => new EE_Text_Input(array(
                     'html_label_text' =>  sprintf(esc_html__("Payable To %s", "event_espresso"), $this->get_help_tab_link()),
@@ -79,7 +79,7 @@ 
                 'address_to_send_payment' => new EE_Text_Area_Input(array(
                     'html_label_text' =>  sprintf(esc_html__("Address Payable %s", "event_espresso"), $this->get_help_tab_link()),
                     'default' => $default_address,
-                    'validation_strategies' => array( new EE_Full_HTML_Validation_Strategy() ),
+                    'validation_strategies' => array(new EE_Full_HTML_Validation_Strategy()),
                 )),
             ),
             'exclude' => array('PMD_debug_mode')

Indentation +115 added lines, -115 removed lines

@@ -11,131 +11,131 @@
  */
 class EE_PMT_Check extends EE_PMT_Base
 {
-    /**
-     * @param EE_Payment_Method|null $pm_instance
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    public function __construct($pm_instance = null)
-    {
-        $this->_pretty_name = esc_html__("Check", 'event_espresso');
-        $this->_default_description = esc_html__('After clicking "Finalize Registration", you will be given instructions on how to complete your payment.', 'event_espresso');
-        parent::__construct($pm_instance);
-        $this->_default_button_url = $this->file_url() . 'lib/check-logo.png';
-    }
+	/**
+	 * @param EE_Payment_Method|null $pm_instance
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	public function __construct($pm_instance = null)
+	{
+		$this->_pretty_name = esc_html__("Check", 'event_espresso');
+		$this->_default_description = esc_html__('After clicking "Finalize Registration", you will be given instructions on how to complete your payment.', 'event_espresso');
+		parent::__construct($pm_instance);
+		$this->_default_button_url = $this->file_url() . 'lib/check-logo.png';
+	}
 
 
 
-    /**
-     * Creates the billing form for this payment method type
-     * @param EE_Transaction|null $transaction
-     * @return EE_Billing_Info_Form|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function generate_new_billing_form(EE_Transaction $transaction = null)
-    {    return null;
-    }
+	/**
+	 * Creates the billing form for this payment method type
+	 * @param EE_Transaction|null $transaction
+	 * @return EE_Billing_Info_Form|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function generate_new_billing_form(EE_Transaction $transaction = null)
+	{    return null;
+	}
 
 
 
-    /**
-     * Overrides parent to dynamically set some defaults, but only when the form is requested
-     *
-     * @return EE_Payment_Method_Form
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function generate_new_settings_form()
-    {
-        if (EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance) {
-            $organization = EE_Registry::instance()->CFG->organization;
-            $organization_name = $organization->get_pretty('name');
-            $default_address = $organization->address_1 != '' ? $organization->get_pretty('address_1') . '<br />' : '';
-            $default_address .= $organization->address_2 != '' ? $organization->get_pretty('address_2') . '<br />' : '';
-            $default_address .= $organization->city != '' ? $organization->get_pretty('city') : '';
-            $default_address .= ( $organization->city != '' && $organization->STA_ID != '') ? ', ' : '<br />';
-            $state = EE_Registry::instance()->load_model('State')->get_one_by_ID($organization->STA_ID);
-            $country = EE_Registry::instance()->load_model('Country')->get_one_by_ID($organization->CNT_ISO) ;
-            $default_address .=  $state ? $state->name() . '<br />' : '';
-            $default_address .= $country ? $country->name() . '<br />' : '';
-            $default_address .= $organization->zip != '' ? $organization->get_pretty('zip') : '';
-        } else {
-            $default_address = 'unknown';
-            $organization_name = 'unknown';
-        }
-            return new EE_Payment_Method_Form(array(
-            'extra_meta_inputs' => array(
-                'check_title' => new EE_Text_Input(array(
-                    'html_label_text' =>  sprintf(esc_html__("Title %s", "event_espresso"), $this->get_help_tab_link()),
-                    'default' =>  esc_html__("Check/Money Order Payments", 'event_espresso'),
-                )),
-                'payment_instructions' => new EE_Text_Area_Input(array(
-                    'html_label_text' =>  sprintf(esc_html__("Instructions %s", "event_espresso"), $this->get_help_tab_link()),
-                    'default' => esc_html__("Please send Check/Money Order to the address below. Payment must be received within 48 hours of event date.", 'event_espresso'),
-                    'validation_strategies' => array( new EE_Full_HTML_Validation_Strategy() ),
-                )),
-                'payable_to' => new EE_Text_Input(array(
-                    'html_label_text' =>  sprintf(esc_html__("Payable To %s", "event_espresso"), $this->get_help_tab_link()),
-                    'default' => $organization_name
-                )),
-                'address_to_send_payment' => new EE_Text_Area_Input(array(
-                    'html_label_text' =>  sprintf(esc_html__("Address Payable %s", "event_espresso"), $this->get_help_tab_link()),
-                    'default' => $default_address,
-                    'validation_strategies' => array( new EE_Full_HTML_Validation_Strategy() ),
-                )),
-            ),
-            'exclude' => array('PMD_debug_mode')
-            ));
-    }
+	/**
+	 * Overrides parent to dynamically set some defaults, but only when the form is requested
+	 *
+	 * @return EE_Payment_Method_Form
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function generate_new_settings_form()
+	{
+		if (EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance) {
+			$organization = EE_Registry::instance()->CFG->organization;
+			$organization_name = $organization->get_pretty('name');
+			$default_address = $organization->address_1 != '' ? $organization->get_pretty('address_1') . '<br />' : '';
+			$default_address .= $organization->address_2 != '' ? $organization->get_pretty('address_2') . '<br />' : '';
+			$default_address .= $organization->city != '' ? $organization->get_pretty('city') : '';
+			$default_address .= ( $organization->city != '' && $organization->STA_ID != '') ? ', ' : '<br />';
+			$state = EE_Registry::instance()->load_model('State')->get_one_by_ID($organization->STA_ID);
+			$country = EE_Registry::instance()->load_model('Country')->get_one_by_ID($organization->CNT_ISO) ;
+			$default_address .=  $state ? $state->name() . '<br />' : '';
+			$default_address .= $country ? $country->name() . '<br />' : '';
+			$default_address .= $organization->zip != '' ? $organization->get_pretty('zip') : '';
+		} else {
+			$default_address = 'unknown';
+			$organization_name = 'unknown';
+		}
+			return new EE_Payment_Method_Form(array(
+			'extra_meta_inputs' => array(
+				'check_title' => new EE_Text_Input(array(
+					'html_label_text' =>  sprintf(esc_html__("Title %s", "event_espresso"), $this->get_help_tab_link()),
+					'default' =>  esc_html__("Check/Money Order Payments", 'event_espresso'),
+				)),
+				'payment_instructions' => new EE_Text_Area_Input(array(
+					'html_label_text' =>  sprintf(esc_html__("Instructions %s", "event_espresso"), $this->get_help_tab_link()),
+					'default' => esc_html__("Please send Check/Money Order to the address below. Payment must be received within 48 hours of event date.", 'event_espresso'),
+					'validation_strategies' => array( new EE_Full_HTML_Validation_Strategy() ),
+				)),
+				'payable_to' => new EE_Text_Input(array(
+					'html_label_text' =>  sprintf(esc_html__("Payable To %s", "event_espresso"), $this->get_help_tab_link()),
+					'default' => $organization_name
+				)),
+				'address_to_send_payment' => new EE_Text_Area_Input(array(
+					'html_label_text' =>  sprintf(esc_html__("Address Payable %s", "event_espresso"), $this->get_help_tab_link()),
+					'default' => $default_address,
+					'validation_strategies' => array( new EE_Full_HTML_Validation_Strategy() ),
+				)),
+			),
+			'exclude' => array('PMD_debug_mode')
+			));
+	}
 
 
 
-    /**
-     * Adds the help tab
-     *
-     * @return array
-     * @see EE_PMT_Base::help_tabs_config()
-     */
-    public function help_tabs_config()
-    {
-        return array(
-            $this->get_help_tab_name() => array(
-                        'title' => esc_html__('Check Settings', 'event_espresso'),
-                        'filename' => 'payment_methods_overview_check'
-                        ),
-        );
-    }
+	/**
+	 * Adds the help tab
+	 *
+	 * @return array
+	 * @see EE_PMT_Base::help_tabs_config()
+	 */
+	public function help_tabs_config()
+	{
+		return array(
+			$this->get_help_tab_name() => array(
+						'title' => esc_html__('Check Settings', 'event_espresso'),
+						'filename' => 'payment_methods_overview_check'
+						),
+		);
+	}
 
 
 
-    /**
-     * For adding any html output ab ove the payment overview.
-     * Many gateways won't want ot display anything, so this function just returns an empty string.
-     * Other gateways may want to override this, such as offline gateways.
-     *
-     * @param EE_Payment $payment
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function payment_overview_content(EE_Payment $payment)
-    {
-        $extra_meta_for_payment_method = $this->_pm_instance->all_extra_meta_array();
-        $template_vars = array_merge(
-            array(
-                            'payment_method' => $this->_pm_instance,
-                            'payment' => $payment,
-                            'check_title' => '',
-                            'payment_instructions' => '',
-                            'payable_to' => '',
-                            'address_to_send_payment' => '',
-                            ),
-            $extra_meta_for_payment_method
-        );
-        return EEH_Template::locate_template(
-            'payment_methods/Check/templates/check_payment_details_content.template.php',
-            $template_vars
-        );
-    }
+	/**
+	 * For adding any html output ab ove the payment overview.
+	 * Many gateways won't want ot display anything, so this function just returns an empty string.
+	 * Other gateways may want to override this, such as offline gateways.
+	 *
+	 * @param EE_Payment $payment
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function payment_overview_content(EE_Payment $payment)
+	{
+		$extra_meta_for_payment_method = $this->_pm_instance->all_extra_meta_array();
+		$template_vars = array_merge(
+			array(
+							'payment_method' => $this->_pm_instance,
+							'payment' => $payment,
+							'check_title' => '',
+							'payment_instructions' => '',
+							'payable_to' => '',
+							'address_to_send_payment' => '',
+							),
+			$extra_meta_for_payment_method
+		);
+		return EEH_Template::locate_template(
+			'payment_methods/Check/templates/check_payment_details_content.template.php',
+			$template_vars
+		);
+	}
 }

admin_pages/registrations/qtips/Registration_List_Table_Tips.lib.php

Spacing +1 added lines, -1 removed lines

@@ -84,7 +84,7 @@
                . esc_html__(
                    'This lock-icon means that this registration cannot be trashed.  Registrations that belong to a transaction that has payments cannot be trashed.  If you wish to trash this registration then you must delete all payments attached to the related transaction first.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
 

Indentation +37 added lines, -37 removed lines

@@ -13,16 +13,16 @@ 
  */
 class Registration_List_Table_Tips extends EE_Qtip_Config
 {
-    protected function _set_tips_array()
-    {
-        $this->_qtipsa = array(
-            0 => array(
-                'content_id' => 'registration-trash-lock',
-                'target'     => '.ee-lock-icon',
-                'content'    => $this->_registration_trash_message(),
-            ),
-            /** removing status strips for now because they are triggered anywhere on the row. */
-            /**1 => array(
+	protected function _set_tips_array()
+	{
+		$this->_qtipsa = array(
+			0 => array(
+				'content_id' => 'registration-trash-lock',
+				'target'     => '.ee-lock-icon',
+				'content'    => $this->_registration_trash_message(),
+			),
+			/** removing status strips for now because they are triggered anywhere on the row. */
+			/**1 => array(
              * 'content_id' => 'registration-status-' . EEM_Registration::status_id_approved,
              * 'target' => '.reg-status-' . EEM_Registration::status_id_approved,
              * 'content' => $this->_registration_status_legend(EEM_Registration::status_id_approved),
@@ -72,37 +72,37 @@ 
              * )
              * )
              * )/**/
-        );
-    }
+		);
+	}
 
 
-    private function _registration_trash_message()
-    {
-        return '<p>'
-               . esc_html__(
-                   'This lock-icon means that this registration cannot be trashed.  Registrations that belong to a transaction that has payments cannot be trashed.  If you wish to trash this registration then you must delete all payments attached to the related transaction first.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	private function _registration_trash_message()
+	{
+		return '<p>'
+			   . esc_html__(
+				   'This lock-icon means that this registration cannot be trashed.  Registrations that belong to a transaction that has payments cannot be trashed.  If you wish to trash this registration then you must delete all payments attached to the related transaction first.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
 
-    /**
-     * output the relevant ee-status-legend with the designated status highlighted.
-     *
-     * @param  EEM_Registration constant $status What status is set (by class)
-     * @return string         The status legend with the related status highlighted
-     */
-    private function _registration_status_legend($status)
-    {
+	/**
+	 * output the relevant ee-status-legend with the designated status highlighted.
+	 *
+	 * @param  EEM_Registration constant $status What status is set (by class)
+	 * @return string         The status legend with the related status highlighted
+	 */
+	private function _registration_status_legend($status)
+	{
 
-        $status_array = array(
-            'approved_status' => EEM_Registration::status_id_approved,
-            'pending_status' => EEM_Registration::status_id_pending_payment,
-            'not_approved' => EEM_Registration::status_id_not_approved,
-            'declined_status' => EEM_Registration::status_id_declined,
-            'cancelled_status' => EEM_Registration::status_id_cancelled,
-        );
+		$status_array = array(
+			'approved_status' => EEM_Registration::status_id_approved,
+			'pending_status' => EEM_Registration::status_id_pending_payment,
+			'not_approved' => EEM_Registration::status_id_not_approved,
+			'declined_status' => EEM_Registration::status_id_declined,
+			'cancelled_status' => EEM_Registration::status_id_cancelled,
+		);
 
-        return EEH_Template::status_legend($status_array, $status);
-    }
+		return EEH_Template::status_legend($status_array, $status);
+	}
 }