eventespresso / event-espresso-core

core/services/factory/FactoryWithDependencyResolver.php

Indentation +33 added lines, -33 removed lines

@@ -18,41 +18,41 @@
  */
 abstract class FactoryWithDependencyResolver implements FactoryInterface
 {
-    /**
-     * @var DependencyResolverInterface $dependency_resolver
-     */
-    private $dependency_resolver;
+	/**
+	 * @var DependencyResolverInterface $dependency_resolver
+	 */
+	private $dependency_resolver;
 
-    /**
-     * @var LoaderInterface $loader
-     */
-    private $loader;
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	private $loader;
 
-    /**
-     * FactoryWithDependencyResolver constructor.
-     *
-     * @param DependencyResolverInterface $dependency_resolver
-     * @param LoaderInterface             $loader
-     */
-    public function __construct(DependencyResolverInterface $dependency_resolver, LoaderInterface $loader)
-    {
-        $this->dependency_resolver = $dependency_resolver;
-        $this->loader = $loader;
-    }
+	/**
+	 * FactoryWithDependencyResolver constructor.
+	 *
+	 * @param DependencyResolverInterface $dependency_resolver
+	 * @param LoaderInterface             $loader
+	 */
+	public function __construct(DependencyResolverInterface $dependency_resolver, LoaderInterface $loader)
+	{
+		$this->dependency_resolver = $dependency_resolver;
+		$this->loader = $loader;
+	}
 
-    /**
-     * @return DependencyResolverInterface
-     */
-    public function dependencyResolver()
-    {
-        return $this->dependency_resolver;
-    }
+	/**
+	 * @return DependencyResolverInterface
+	 */
+	public function dependencyResolver()
+	{
+		return $this->dependency_resolver;
+	}
 
-    /**
-     * @return LoaderInterface
-     */
-    public function loader()
-    {
-        return $this->loader;
-    }
+	/**
+	 * @return LoaderInterface
+	 */
+	public function loader()
+	{
+		return $this->loader;
+	}
 }

core/domain/services/factories/FactoryInterface.php

Indentation +6 added lines, -6 removed lines

@@ -11,10 +11,10 @@
 interface FactoryInterface
 {
 
-    /**
-     * @param mixed $arguments Either a Fully Qualified Class Name
-     *                         or array of data required for construction
-     * @return mixed
-     */
-    public static function create($arguments);
+	/**
+	 * @param mixed $arguments Either a Fully Qualified Class Name
+	 *                         or array of data required for construction
+	 * @return mixed
+	 */
+	public static function create($arguments);
 }

core/domain/services/pue/Config.php

Indentation +127 added lines, -127 removed lines

@@ -16,131 +16,131 @@
  */
 class Config
 {
-    /**
-     * @var EE_Network_Config
-     */
-    private $network_config;
-
-
-    /**
-     * @var EE_Config
-     */
-    private $ee_config;
-
-
-    public function __construct(EE_Network_Config $network_config, EE_Config $ee_config)
-    {
-        $this->network_config = $network_config;
-        $this->ee_config = $ee_config;
-    }
-
-
-    /**
-     * Get the site license key for the site.
-     */
-    public function siteLicenseKey()
-    {
-        return $this->network_config->core->site_license_key;
-    }
-
-
-    public function i18nDomain()
-    {
-        return 'event_espresso';
-    }
-
-
-    public function checkPeriod()
-    {
-        return 24;
-    }
-
-
-    public function optionKey()
-    {
-        return 'ee_site_license_key';
-    }
-
-
-    public function optionsPageSlug()
-    {
-        return 'espresso_general_settings';
-    }
-
-
-    public function hostServerUrl()
-    {
-        return defined('PUE_UPDATES_ENDPOINT')
-            ? PUE_UPDATES_ENDPOINT
-            : 'https://eventespresso.com';
-    }
-
-
-    public function pluginSlug()
-    {
-        // Note: PUE uses a simple preg_match to determine what type is currently installed based on version number.
-        //  So it's important that you use a key for the version type that is unique and not found in another key.
-        // For example:
-        // $plugin_slug['premium']['p'] = 'some-premium-slug';
-        // $plugin_slug['prerelease']['pr'] = 'some-pre-release-slug';
-        // The above would not work because "p" is found in both keys for the version type. ( i.e 1.0.p vs 1.0.pr )
-        // so doing something like:
-        // $plugin_slug['premium']['p'] = 'some-premium-slug';
-        // $plugin_slug['prerelease']['b'] = 'some-pre-release-slug';
-        // ..WOULD work!
-        return array(
-            'free'       => array('decaf' => 'event-espresso-core-decaf'),
-            'premium'    => array('p' => 'event-espresso-core-reg'),
-            'prerelease' => array('beta' => 'event-espresso-core-pr'),
-        );
-    }
-
-
-    /**
-     * Return whether the site is opted in for UXIP or not.
-     *
-     * @return bool
-     */
-    public function isOptedInForUxip()
-    {
-        return filter_var($this->ee_config->core->ee_ueip_optin, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * Return whether the site has been notified about UXIP or not.
-     *
-     * @return bool
-     */
-    public function hasNotifiedForUxip()
-    {
-        return filter_var($this->ee_config->core->ee_ueip_has_notified, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * Set the site opted in for UXIP.
-     */
-    public function setHasOptedInForUxip()
-    {
-        $this->ee_config->core->ee_ueip_optin = true;
-        $this->ee_config->update_espresso_config(false, false);
-    }
-
-
-    /**
-     * Set the site opted out for UXIP
-     */
-    public function setHasOptedOutForUxip()
-    {
-        $this->ee_config->core->ee_ueip_optin = false;
-        $this->ee_config->update_espresso_config(false, false);
-    }
-
-
-    public function setHasNotifiedAboutUxip()
-    {
-        $this->ee_config->core->ee_ueip_has_notified = true;
-        $this->ee_config->update_espresso_config(false, false);
-    }
+	/**
+	 * @var EE_Network_Config
+	 */
+	private $network_config;
+
+
+	/**
+	 * @var EE_Config
+	 */
+	private $ee_config;
+
+
+	public function __construct(EE_Network_Config $network_config, EE_Config $ee_config)
+	{
+		$this->network_config = $network_config;
+		$this->ee_config = $ee_config;
+	}
+
+
+	/**
+	 * Get the site license key for the site.
+	 */
+	public function siteLicenseKey()
+	{
+		return $this->network_config->core->site_license_key;
+	}
+
+
+	public function i18nDomain()
+	{
+		return 'event_espresso';
+	}
+
+
+	public function checkPeriod()
+	{
+		return 24;
+	}
+
+
+	public function optionKey()
+	{
+		return 'ee_site_license_key';
+	}
+
+
+	public function optionsPageSlug()
+	{
+		return 'espresso_general_settings';
+	}
+
+
+	public function hostServerUrl()
+	{
+		return defined('PUE_UPDATES_ENDPOINT')
+			? PUE_UPDATES_ENDPOINT
+			: 'https://eventespresso.com';
+	}
+
+
+	public function pluginSlug()
+	{
+		// Note: PUE uses a simple preg_match to determine what type is currently installed based on version number.
+		//  So it's important that you use a key for the version type that is unique and not found in another key.
+		// For example:
+		// $plugin_slug['premium']['p'] = 'some-premium-slug';
+		// $plugin_slug['prerelease']['pr'] = 'some-pre-release-slug';
+		// The above would not work because "p" is found in both keys for the version type. ( i.e 1.0.p vs 1.0.pr )
+		// so doing something like:
+		// $plugin_slug['premium']['p'] = 'some-premium-slug';
+		// $plugin_slug['prerelease']['b'] = 'some-pre-release-slug';
+		// ..WOULD work!
+		return array(
+			'free'       => array('decaf' => 'event-espresso-core-decaf'),
+			'premium'    => array('p' => 'event-espresso-core-reg'),
+			'prerelease' => array('beta' => 'event-espresso-core-pr'),
+		);
+	}
+
+
+	/**
+	 * Return whether the site is opted in for UXIP or not.
+	 *
+	 * @return bool
+	 */
+	public function isOptedInForUxip()
+	{
+		return filter_var($this->ee_config->core->ee_ueip_optin, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * Return whether the site has been notified about UXIP or not.
+	 *
+	 * @return bool
+	 */
+	public function hasNotifiedForUxip()
+	{
+		return filter_var($this->ee_config->core->ee_ueip_has_notified, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * Set the site opted in for UXIP.
+	 */
+	public function setHasOptedInForUxip()
+	{
+		$this->ee_config->core->ee_ueip_optin = true;
+		$this->ee_config->update_espresso_config(false, false);
+	}
+
+
+	/**
+	 * Set the site opted out for UXIP
+	 */
+	public function setHasOptedOutForUxip()
+	{
+		$this->ee_config->core->ee_ueip_optin = false;
+		$this->ee_config->update_espresso_config(false, false);
+	}
+
+
+	public function setHasNotifiedAboutUxip()
+	{
+		$this->ee_config->core->ee_ueip_has_notified = true;
+		$this->ee_config->update_espresso_config(false, false);
+	}
 }

core/services/request/middleware/DetectFileEditorRequest.php

Indentation +19 added lines, -19 removed lines

@@ -17,23 +17,23 @@
 class DetectFileEditorRequest extends Middleware
 {
 
-    /**
-     * converts a Request to a Response
-     *
-     * @param RequestInterface  $request
-     * @param ResponseInterface $response
-     * @return ResponseInterface
-     */
-    public function handleRequest(RequestInterface $request, ResponseInterface $response)
-    {
-        $this->request  = $request;
-        $this->response = $response;
-        // can't store user data during WP error scrapes if no user exists
-        // so don't load the session since it's not going to work anyways
-        if ($this->request->isWordPressScrape()) {
-            add_filter('FHEE_load_EE_Session', '__return_false', 999);
-        }
-        $this->response = $this->processRequestStack($this->request, $this->response);
-        return $this->response;
-    }
+	/**
+	 * converts a Request to a Response
+	 *
+	 * @param RequestInterface  $request
+	 * @param ResponseInterface $response
+	 * @return ResponseInterface
+	 */
+	public function handleRequest(RequestInterface $request, ResponseInterface $response)
+	{
+		$this->request  = $request;
+		$this->response = $response;
+		// can't store user data during WP error scrapes if no user exists
+		// so don't load the session since it's not going to work anyways
+		if ($this->request->isWordPressScrape()) {
+			add_filter('FHEE_load_EE_Session', '__return_false', 999);
+		}
+		$this->response = $this->processRequestStack($this->request, $this->response);
+		return $this->response;
+	}
 }

core/entities/models/JsonModelSchema.php

Spacing +10 added lines, -10 removed lines

@@ -76,22 +76,22 @@ 
     public function getModelSchemaForFields(array $model_fields, array $schema)
     {
         foreach ($model_fields as $field => $model_field) {
-            if (! $model_field instanceof EE_Model_Field_Base) {
+            if ( ! $model_field instanceof EE_Model_Field_Base) {
                 continue;
             }
-            $schema['properties'][ $field ] = $model_field->getSchema();
+            $schema['properties'][$field] = $model_field->getSchema();
 
             // if this is a primary key field add the primary key item
             if ($model_field instanceof EE_Primary_Key_Field_Base) {
-                $schema['properties'][ $field ]['primary_key'] = true;
+                $schema['properties'][$field]['primary_key'] = true;
                 if ($model_field instanceof EE_Primary_Key_Int_Field) {
-                    $schema['properties'][ $field ]['readonly'] = true;
+                    $schema['properties'][$field]['readonly'] = true;
                 }
             }
 
             // if this is a foreign key field add the foreign key item
             if ($model_field instanceof EE_Foreign_Key_Field_Base) {
-                $schema['properties'][ $field ]['foreign_key'] = array(
+                $schema['properties'][$field]['foreign_key'] = array(
                     'description' => esc_html__(
                         'This is a foreign key the points to the given models.',
                         'event_espresso'
@@ -115,18 +115,18 @@ 
     public function getModelSchemaForRelations(array $relations_on_model, array $schema)
     {
         foreach ($relations_on_model as $model_name => $relation) {
-            if (! $relation instanceof EE_Model_Relation_Base) {
+            if ( ! $relation instanceof EE_Model_Relation_Base) {
                 continue;
             }
             $model_name_for_schema = $relation instanceof EE_Belongs_To_Relation
                 ? strtolower($model_name)
                 : EEH_Inflector::pluralize_and_lower($model_name);
-            $schema['properties'][ $model_name_for_schema ] = $relation->getSchema();
-            $schema['properties'][ $model_name_for_schema ]['relation_model'] = $model_name;
+            $schema['properties'][$model_name_for_schema] = $relation->getSchema();
+            $schema['properties'][$model_name_for_schema]['relation_model'] = $model_name;
 
             // links schema
-            $links_key = 'https://api.eventespresso.com/' . strtolower($model_name);
-            $schema['properties']['_links']['properties'][ $links_key ] = array(
+            $links_key = 'https://api.eventespresso.com/'.strtolower($model_name);
+            $schema['properties']['_links']['properties'][$links_key] = array(
                 'description' => esc_html__(
                     'Array of objects describing the link(s) for this relation resource.',
                     'event_espresso'

Indentation +235 added lines, -235 removed lines

@@ -25,256 +25,256 @@
 class JsonModelSchema
 {
 
-    /**
-     * @var EEM_Base
-     */
-    protected $model;
+	/**
+	 * @var EEM_Base
+	 */
+	protected $model;
 
-    /**
-     * @var CalculatedModelFields
-     */
-    protected $fields_calculator;
+	/**
+	 * @var CalculatedModelFields
+	 */
+	protected $fields_calculator;
 
 
-    /**
-     * JsonModelSchema constructor.
-     *
-     * @param EEM_Base              $model
-     * @param CalculatedModelFields $fields_calculator
-     */
-    public function __construct(EEM_Base $model, CalculatedModelFields $fields_calculator)
-    {
-        $this->model = $model;
-        $this->fields_calculator = $fields_calculator;
-    }
+	/**
+	 * JsonModelSchema constructor.
+	 *
+	 * @param EEM_Base              $model
+	 * @param CalculatedModelFields $fields_calculator
+	 */
+	public function __construct(EEM_Base $model, CalculatedModelFields $fields_calculator)
+	{
+		$this->model = $model;
+		$this->fields_calculator = $fields_calculator;
+	}
 
 
-    /**
-     * Return the schema for a given model from a given model.
-     *
-     * @return array
-     */
-    public function getModelSchema()
-    {
-        return $this->getModelSchemaForRelations(
-            $this->model->relation_settings(),
-            $this->getModelSchemaForFields(
-                $this->model->field_settings(),
-                $this->getInitialSchemaStructure()
-            )
-        );
-    }
+	/**
+	 * Return the schema for a given model from a given model.
+	 *
+	 * @return array
+	 */
+	public function getModelSchema()
+	{
+		return $this->getModelSchemaForRelations(
+			$this->model->relation_settings(),
+			$this->getModelSchemaForFields(
+				$this->model->field_settings(),
+				$this->getInitialSchemaStructure()
+			)
+		);
+	}
 
 
-    /**
-     * Get the schema for a given set of model fields.
-     *
-     * @param EE_Model_Field_Base[] $model_fields
-     * @param array                  $schema
-     * @return array
-     */
-    public function getModelSchemaForFields(array $model_fields, array $schema)
-    {
-        foreach ($model_fields as $field => $model_field) {
-            if (! $model_field instanceof EE_Model_Field_Base) {
-                continue;
-            }
-            $schema['properties'][ $field ] = $model_field->getSchema();
+	/**
+	 * Get the schema for a given set of model fields.
+	 *
+	 * @param EE_Model_Field_Base[] $model_fields
+	 * @param array                  $schema
+	 * @return array
+	 */
+	public function getModelSchemaForFields(array $model_fields, array $schema)
+	{
+		foreach ($model_fields as $field => $model_field) {
+			if (! $model_field instanceof EE_Model_Field_Base) {
+				continue;
+			}
+			$schema['properties'][ $field ] = $model_field->getSchema();
 
-            // if this is a primary key field add the primary key item
-            if ($model_field instanceof EE_Primary_Key_Field_Base) {
-                $schema['properties'][ $field ]['primary_key'] = true;
-                if ($model_field instanceof EE_Primary_Key_Int_Field) {
-                    $schema['properties'][ $field ]['readonly'] = true;
-                }
-            }
+			// if this is a primary key field add the primary key item
+			if ($model_field instanceof EE_Primary_Key_Field_Base) {
+				$schema['properties'][ $field ]['primary_key'] = true;
+				if ($model_field instanceof EE_Primary_Key_Int_Field) {
+					$schema['properties'][ $field ]['readonly'] = true;
+				}
+			}
 
-            // if this is a foreign key field add the foreign key item
-            if ($model_field instanceof EE_Foreign_Key_Field_Base) {
-                $schema['properties'][ $field ]['foreign_key'] = array(
-                    'description' => esc_html__(
-                        'This is a foreign key the points to the given models.',
-                        'event_espresso'
-                    ),
-                    'type'        => 'array',
-                    'enum'        => $model_field->get_model_class_names_pointed_to(),
-                );
-            }
-        }
-        return $schema;
-    }
+			// if this is a foreign key field add the foreign key item
+			if ($model_field instanceof EE_Foreign_Key_Field_Base) {
+				$schema['properties'][ $field ]['foreign_key'] = array(
+					'description' => esc_html__(
+						'This is a foreign key the points to the given models.',
+						'event_espresso'
+					),
+					'type'        => 'array',
+					'enum'        => $model_field->get_model_class_names_pointed_to(),
+				);
+			}
+		}
+		return $schema;
+	}
 
 
-    /**
-     * Get the schema for a given set of model relations
-     *
-     * @param EE_Model_Relation_Base[] $relations_on_model
-     * @param array                    $schema
-     * @return array
-     */
-    public function getModelSchemaForRelations(array $relations_on_model, array $schema)
-    {
-        foreach ($relations_on_model as $model_name => $relation) {
-            if (! $relation instanceof EE_Model_Relation_Base) {
-                continue;
-            }
-            $model_name_for_schema = $relation instanceof EE_Belongs_To_Relation
-                ? strtolower($model_name)
-                : EEH_Inflector::pluralize_and_lower($model_name);
-            $schema['properties'][ $model_name_for_schema ] = $relation->getSchema();
-            $schema['properties'][ $model_name_for_schema ]['relation_model'] = $model_name;
+	/**
+	 * Get the schema for a given set of model relations
+	 *
+	 * @param EE_Model_Relation_Base[] $relations_on_model
+	 * @param array                    $schema
+	 * @return array
+	 */
+	public function getModelSchemaForRelations(array $relations_on_model, array $schema)
+	{
+		foreach ($relations_on_model as $model_name => $relation) {
+			if (! $relation instanceof EE_Model_Relation_Base) {
+				continue;
+			}
+			$model_name_for_schema = $relation instanceof EE_Belongs_To_Relation
+				? strtolower($model_name)
+				: EEH_Inflector::pluralize_and_lower($model_name);
+			$schema['properties'][ $model_name_for_schema ] = $relation->getSchema();
+			$schema['properties'][ $model_name_for_schema ]['relation_model'] = $model_name;
 
-            // links schema
-            $links_key = 'https://api.eventespresso.com/' . strtolower($model_name);
-            $schema['properties']['_links']['properties'][ $links_key ] = array(
-                'description' => esc_html__(
-                    'Array of objects describing the link(s) for this relation resource.',
-                    'event_espresso'
-                ),
-                'type' => 'array',
-                'readonly' => true,
-                'items' => array(
-                    'type' => 'object',
-                    'properties' => array(
-                        'href' => array(
-                            'type' => 'string',
-                            'description' => sprintf(
-                                // translators: placeholder is the model name for the relation.
-                                esc_html__(
-                                    'The link to the resource for the %s relation(s) to this entity',
-                                    'event_espresso'
-                                ),
-                                $model_name
-                            ),
-                        ),
-                        'single' => array(
-                            'type' => 'boolean',
-                            'description' => sprintf(
-                                // translators: placeholder is the model name for the relation.
-                                esc_html__(
-                                    'Whether or not there is only a single %s relation to this entity',
-                                    'event_espresso'
-                                ),
-                                $model_name
-                            ),
-                        ),
-                    ),
-                    'additionalProperties' => false
-                ),
-            );
-        }
-        return $schema;
-    }
+			// links schema
+			$links_key = 'https://api.eventespresso.com/' . strtolower($model_name);
+			$schema['properties']['_links']['properties'][ $links_key ] = array(
+				'description' => esc_html__(
+					'Array of objects describing the link(s) for this relation resource.',
+					'event_espresso'
+				),
+				'type' => 'array',
+				'readonly' => true,
+				'items' => array(
+					'type' => 'object',
+					'properties' => array(
+						'href' => array(
+							'type' => 'string',
+							'description' => sprintf(
+								// translators: placeholder is the model name for the relation.
+								esc_html__(
+									'The link to the resource for the %s relation(s) to this entity',
+									'event_espresso'
+								),
+								$model_name
+							),
+						),
+						'single' => array(
+							'type' => 'boolean',
+							'description' => sprintf(
+								// translators: placeholder is the model name for the relation.
+								esc_html__(
+									'Whether or not there is only a single %s relation to this entity',
+									'event_espresso'
+								),
+								$model_name
+							),
+						),
+					),
+					'additionalProperties' => false
+				),
+			);
+		}
+		return $schema;
+	}
 
 
-    /**
-     * Outputs the schema header for a model.
-     *
-     * @return array
-     */
-    public function getInitialSchemaStructure()
-    {
-        return array(
-            '$schema'    => 'http://json-schema.org/draft-04/schema#',
-            'title'      => $this->model->get_this_model_name(),
-            'type'       => 'object',
-            'properties' => array(
-                'link' => array(
-                    'description' => esc_html__(
-                        'Link to event on WordPress site hosting events.',
-                        'event_espresso'
-                    ),
-                    'type' => 'string',
-                    'readonly' => true,
-                ),
-                '_links' => array(
-                    'description' => esc_html__(
-                        'Various links for resources related to the entity.',
-                        'event_espresso'
-                    ),
-                    'type' => 'object',
-                    'readonly' => true,
-                    'properties' => array(
-                        'self' => array(
-                            'description' => esc_html__(
-                                'Link to this entities resource.',
-                                'event_espresso'
-                            ),
-                            'type' => 'array',
-                            'items' => array(
-                                'type' => 'object',
-                                'properties' => array(
-                                    'href' => array(
-                                        'type' => 'string',
-                                    ),
-                                ),
-                                'additionalProperties' => false
-                            ),
-                            'readonly' => true
-                        ),
-                        'collection' => array(
-                            'description' => esc_html__(
-                                'Link to this entities collection resource.',
-                                'event_espresso'
-                            ),
-                            'type' => 'array',
-                            'items' => array(
-                                'type' => 'object',
-                                'properties' => array(
-                                    'href' => array(
-                                        'type' => 'string'
-                                    ),
-                                ),
-                                'additionalProperties' => false
-                            ),
-                            'readonly' => true
-                        ),
-                    ),
-                    'additionalProperties' => false,
-                ),
-                '_calculated_fields' => array_merge(
-                    $this->fields_calculator->getJsonSchemaForModel($this->model),
-                    array(
-                        '_protected' => $this->getProtectedFieldsSchema()
-                    )
-                ),
-                '_protected' => $this->getProtectedFieldsSchema()
-            ),
-            'additionalProperties' => false,
-        );
-    }
+	/**
+	 * Outputs the schema header for a model.
+	 *
+	 * @return array
+	 */
+	public function getInitialSchemaStructure()
+	{
+		return array(
+			'$schema'    => 'http://json-schema.org/draft-04/schema#',
+			'title'      => $this->model->get_this_model_name(),
+			'type'       => 'object',
+			'properties' => array(
+				'link' => array(
+					'description' => esc_html__(
+						'Link to event on WordPress site hosting events.',
+						'event_espresso'
+					),
+					'type' => 'string',
+					'readonly' => true,
+				),
+				'_links' => array(
+					'description' => esc_html__(
+						'Various links for resources related to the entity.',
+						'event_espresso'
+					),
+					'type' => 'object',
+					'readonly' => true,
+					'properties' => array(
+						'self' => array(
+							'description' => esc_html__(
+								'Link to this entities resource.',
+								'event_espresso'
+							),
+							'type' => 'array',
+							'items' => array(
+								'type' => 'object',
+								'properties' => array(
+									'href' => array(
+										'type' => 'string',
+									),
+								),
+								'additionalProperties' => false
+							),
+							'readonly' => true
+						),
+						'collection' => array(
+							'description' => esc_html__(
+								'Link to this entities collection resource.',
+								'event_espresso'
+							),
+							'type' => 'array',
+							'items' => array(
+								'type' => 'object',
+								'properties' => array(
+									'href' => array(
+										'type' => 'string'
+									),
+								),
+								'additionalProperties' => false
+							),
+							'readonly' => true
+						),
+					),
+					'additionalProperties' => false,
+				),
+				'_calculated_fields' => array_merge(
+					$this->fields_calculator->getJsonSchemaForModel($this->model),
+					array(
+						'_protected' => $this->getProtectedFieldsSchema()
+					)
+				),
+				'_protected' => $this->getProtectedFieldsSchema()
+			),
+			'additionalProperties' => false,
+		);
+	}
 
-    /**
-     * Returns an array of JSON schema to describe the _protected property on responses
-     * @since 4.9.74.p
-     * @return array
-     */
-    protected function getProtectedFieldsSchema()
-    {
-        return array(
-            'description' => esc_html__('Array of property names whose values were replaced with their default (because they are related to a password-protected entity.)', 'event_espresso'),
-            'type' => 'array',
-            'items' => array(
-                'description' => esc_html__('Each name corresponds to a property that is protected by password for this entity and has its default value returned in the response.', 'event_espresso'),
-                'type' => 'string',
-                'readonly' => true,
-            ),
-            'readonly' => true
-        );
-    }
+	/**
+	 * Returns an array of JSON schema to describe the _protected property on responses
+	 * @since 4.9.74.p
+	 * @return array
+	 */
+	protected function getProtectedFieldsSchema()
+	{
+		return array(
+			'description' => esc_html__('Array of property names whose values were replaced with their default (because they are related to a password-protected entity.)', 'event_espresso'),
+			'type' => 'array',
+			'items' => array(
+				'description' => esc_html__('Each name corresponds to a property that is protected by password for this entity and has its default value returned in the response.', 'event_espresso'),
+				'type' => 'string',
+				'readonly' => true,
+			),
+			'readonly' => true
+		);
+	}
 
 
-    /**
-     * Allows one to just use the object as a string to get the json.
-     * eg.
-     * $json_schema = new JsonModelSchema(EEM_Event::instance(), new CalculatedModelFields);
-     * echo $json_schema; //outputs the schema as a json formatted string.
-     *
-     * @return string
-     */
-    public function __toString()
-    {
-        $schema = wp_json_encode($this->getModelSchema());
-        return is_string($schema) ? $schema : '';
-    }
+	/**
+	 * Allows one to just use the object as a string to get the json.
+	 * eg.
+	 * $json_schema = new JsonModelSchema(EEM_Event::instance(), new CalculatedModelFields);
+	 * echo $json_schema; //outputs the schema as a json formatted string.
+	 *
+	 * @return string
+	 */
+	public function __toString()
+	{
+		$schema = wp_json_encode($this->getModelSchema());
+		return is_string($schema) ? $schema : '';
+	}
 }

core/libraries/rest_api/calculations/CalculatedModelFieldsFactory.php

Spacing +2 added lines, -2 removed lines

@@ -40,7 +40,7 @@ 
      */
     public function createFromModel($model_name)
     {
-        return $this->createFromClassname('EventEspresso\core\libraries\rest_api\calculations\\' . $model_name);
+        return $this->createFromClassname('EventEspresso\core\libraries\rest_api\calculations\\'.$model_name);
     }
 
     /**
@@ -51,7 +51,7 @@ 
     public function createFromClassname($calculator_classname)
     {
         $calculator = $this->loader->getShared($calculator_classname);
-        if (!$calculator instanceof Base) {
+        if ( ! $calculator instanceof Base) {
             throw new UnexpectedEntityException(
                 $calculator_classname,
                 'EventEspresso\core\libraries\rest_api\calculations\Base'

Indentation +37 added lines, -37 removed lines

@@ -18,46 +18,46 @@
  */
 class CalculatedModelFieldsFactory
 {
-    private $loader;
+	private $loader;
 
-    /**
-     * CalculatedModelFieldsFactory constructor.
-     * @param LoaderInterface $loader
-     */
-    public function __construct(LoaderInterface $loader)
-    {
-        $this->loader = $loader;
-    }
+	/**
+	 * CalculatedModelFieldsFactory constructor.
+	 * @param LoaderInterface $loader
+	 */
+	public function __construct(LoaderInterface $loader)
+	{
+		$this->loader = $loader;
+	}
 
-    /**
-     * Creates the calculator class that corresponds to that particular model
-     * @since 4.9.68.p
-     * @param string $model_name
-     * @return Base
-     * @throws UnexpectedEntityException
-     */
-    public function createFromModel($model_name)
-    {
-        return $this->createFromClassname('EventEspresso\core\libraries\rest_api\calculations\\' . $model_name);
-    }
+	/**
+	 * Creates the calculator class that corresponds to that particular model
+	 * @since 4.9.68.p
+	 * @param string $model_name
+	 * @return Base
+	 * @throws UnexpectedEntityException
+	 */
+	public function createFromModel($model_name)
+	{
+		return $this->createFromClassname('EventEspresso\core\libraries\rest_api\calculations\\' . $model_name);
+	}
 
-    /**
-     * Creates the calculator class that corresponds to that classname and verifies it's of the correct type
-     * @param string $calculator_classname
-     * @return Base
-     * @throws UnexpectedEntityException
-     */
-    public function createFromClassname($calculator_classname)
-    {
-        $calculator = $this->loader->getShared($calculator_classname);
-        if (!$calculator instanceof Base) {
-            throw new UnexpectedEntityException(
-                $calculator_classname,
-                'EventEspresso\core\libraries\rest_api\calculations\Base'
-            );
-        }
-        return $calculator;
-    }
+	/**
+	 * Creates the calculator class that corresponds to that classname and verifies it's of the correct type
+	 * @param string $calculator_classname
+	 * @return Base
+	 * @throws UnexpectedEntityException
+	 */
+	public function createFromClassname($calculator_classname)
+	{
+		$calculator = $this->loader->getShared($calculator_classname);
+		if (!$calculator instanceof Base) {
+			throw new UnexpectedEntityException(
+				$calculator_classname,
+				'EventEspresso\core\libraries\rest_api\calculations\Base'
+			);
+		}
+		return $calculator;
+	}
 }
 // End of file CalculationsFactory.php
 // Location: EventEspresso\core\libraries\rest_api\calculations/CalculationsFactory.php

core/libraries/rest_api/calculations/Base.php

Spacing +2 added lines, -2 removed lines

@@ -23,7 +23,7 @@ 
      */
     protected function verifyCurrentUserCan($required_permission, $attempted_calculation)
     {
-        if (! current_user_can($required_permission)) {
+        if ( ! current_user_can($required_permission)) {
             throw new RestException(
                 'permission_denied',
                 sprintf(
@@ -75,6 +75,6 @@ 
     public function schemaForCalculation($calculation_index)
     {
         $schema_map = $this->schemaForCalculations();
-        return isset($schema_map[ $calculation_index ]) ? $schema_map[ $calculation_index ] : array();
+        return isset($schema_map[$calculation_index]) ? $schema_map[$calculation_index] : array();
     }
 }

Indentation +57 added lines, -57 removed lines

@@ -16,65 +16,65 @@
 class Base
 {
 
-    /**
-     * @param $required_permission
-     * @param $attempted_calculation
-     * @throws RestException
-     */
-    protected function verifyCurrentUserCan($required_permission, $attempted_calculation)
-    {
-        if (! current_user_can($required_permission)) {
-            throw new RestException(
-                'permission_denied',
-                sprintf(
-                    esc_html__(
-                    // @codingStandardsIgnoreStart
-                        'Permission denied, you cannot calculate %1$s on %2$s because you do not have the capability "%3$s"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $attempted_calculation,
-                    EEH_Inflector::pluralize_and_lower($this->getResourceName()),
-                    $required_permission
-                )
-            );
-        }
-    }
+	/**
+	 * @param $required_permission
+	 * @param $attempted_calculation
+	 * @throws RestException
+	 */
+	protected function verifyCurrentUserCan($required_permission, $attempted_calculation)
+	{
+		if (! current_user_can($required_permission)) {
+			throw new RestException(
+				'permission_denied',
+				sprintf(
+					esc_html__(
+					// @codingStandardsIgnoreStart
+						'Permission denied, you cannot calculate %1$s on %2$s because you do not have the capability "%3$s"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$attempted_calculation,
+					EEH_Inflector::pluralize_and_lower($this->getResourceName()),
+					$required_permission
+				)
+			);
+		}
+	}
 
 
-    /**
-     * Gets the name of the resource of the called class
-     *
-     * @return string
-     */
-    public function getResourceName()
-    {
-        return substr(__CLASS__, strrpos(__CLASS__, '\\') + 1);
-    }
+	/**
+	 * Gets the name of the resource of the called class
+	 *
+	 * @return string
+	 */
+	public function getResourceName()
+	{
+		return substr(__CLASS__, strrpos(__CLASS__, '\\') + 1);
+	}
 
-    /**
-     * Returns an array to be used for the schema for the calculated fields.
-     * @since 4.9.68.p
-     * @return array keys are calculated field names (eg "optimum_sales_at_start") values are arrays {
-     * @type string $description
-     * @type string $type, eg "string", "int", "boolean", "object", "array", etc
-     * }
-     */
-    public function schemaForCalculations()
-    {
-        return array();
-    }
+	/**
+	 * Returns an array to be used for the schema for the calculated fields.
+	 * @since 4.9.68.p
+	 * @return array keys are calculated field names (eg "optimum_sales_at_start") values are arrays {
+	 * @type string $description
+	 * @type string $type, eg "string", "int", "boolean", "object", "array", etc
+	 * }
+	 */
+	public function schemaForCalculations()
+	{
+		return array();
+	}
 
-    /**
-     * Returns the json schema for the given calculation index.
-     *
-     * @since 4.9.68.p
-     * @param $calculation_index
-     * @return array
-     */
-    public function schemaForCalculation($calculation_index)
-    {
-        $schema_map = $this->schemaForCalculations();
-        return isset($schema_map[ $calculation_index ]) ? $schema_map[ $calculation_index ] : array();
-    }
+	/**
+	 * Returns the json schema for the given calculation index.
+	 *
+	 * @since 4.9.68.p
+	 * @param $calculation_index
+	 * @return array
+	 */
+	public function schemaForCalculation($calculation_index)
+	{
+		$schema_map = $this->schemaForCalculations();
+		return isset($schema_map[ $calculation_index ]) ? $schema_map[ $calculation_index ] : array();
+	}
 }

core/domain/entities/shortcodes/EspressoTicketSelector.php

Indentation +82 added lines, -82 removed lines

@@ -24,92 +24,92 @@
 {
 
 
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag()
-    {
-        return 'ESPRESSO_TICKET_SELECTOR';
-    }
+	/**
+	 * the actual shortcode tag that gets registered with WordPress
+	 *
+	 * @return string
+	 */
+	public function getTag()
+	{
+		return 'ESPRESSO_TICKET_SELECTOR';
+	}
 
 
-    /**
-     * the time in seconds to cache the results of the processShortcode() method
-     * 0 means the processShortcode() results will NOT be cached at all
-     *
-     * @return int
-     */
-    public function cacheExpiration()
-    {
-        return 0;
-    }
+	/**
+	 * the time in seconds to cache the results of the processShortcode() method
+	 * 0 means the processShortcode() results will NOT be cached at all
+	 *
+	 * @return int
+	 */
+	public function cacheExpiration()
+	{
+		return 0;
+	}
 
 
-    /**
-     * a place for adding any initialization code that needs to run prior to wp_header().
-     * this may be required for shortcodes that utilize a corresponding module,
-     * and need to enqueue assets for that module
-     *
-     * @return void
-     */
-    public function initializeShortcode()
-    {
-        add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
-        $this->shortcodeHasBeenInitialized();
-    }
+	/**
+	 * a place for adding any initialization code that needs to run prior to wp_header().
+	 * this may be required for shortcodes that utilize a corresponding module,
+	 * and need to enqueue assets for that module
+	 *
+	 * @return void
+	 */
+	public function initializeShortcode()
+	{
+		add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
+		$this->shortcodeHasBeenInitialized();
+	}
 
 
-    /**
-     * callback that runs when the shortcode is encountered in post content.
-     * IMPORTANT !!!
-     * remember that shortcode content should be RETURNED and NOT echoed out
-     *
-     * @param array $attributes
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function processShortcode($attributes = array())
-    {
-        extract($attributes, EXTR_OVERWRITE);
-        $event_id = isset($event_id) ? $event_id : 0;
-        $event = EE_Registry::instance()->load_model('Event')->get_one_by_ID($event_id);
-        if (! $event instanceof EE_Event) {
-            if (WP_DEBUG === true && current_user_can('edit_pages')) {
-                new ExceptionStackTraceDisplay(
-                    new InvalidArgumentException(
-                        sprintf(
-                            esc_html__(
-                                'A valid Event ID is required to use the "%1$s" shortcode.%4$sAn Event with an ID of "%2$s" could not be found.%4$sPlease verify that the shortcode added to this post\'s content includes an "%3$s" argument and that its value corresponds to a valid Event ID.',
-                                'event_espresso'
-                            ),
-                            $this->getTag(),
-                            $event_id,
-                            'event_id',
-                            '<br />'
-                        )
-                    )
-                );
-                return '';
-            }
-            return sprintf(
-                esc_html__(
-                    'An Event with an ID of "%s" could not be found. Please contact the event administrator for assistance.',
-                    'event_espresso'
-                ),
-                $event_id
-            );
-        }
-        ob_start();
-        do_action('AHEE_event_details_before_post', $event_id);
-        espresso_ticket_selector($event);
-        do_action('AHEE_event_details_after_post');
-        return ob_get_clean();
-    }
+	/**
+	 * callback that runs when the shortcode is encountered in post content.
+	 * IMPORTANT !!!
+	 * remember that shortcode content should be RETURNED and NOT echoed out
+	 *
+	 * @param array $attributes
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function processShortcode($attributes = array())
+	{
+		extract($attributes, EXTR_OVERWRITE);
+		$event_id = isset($event_id) ? $event_id : 0;
+		$event = EE_Registry::instance()->load_model('Event')->get_one_by_ID($event_id);
+		if (! $event instanceof EE_Event) {
+			if (WP_DEBUG === true && current_user_can('edit_pages')) {
+				new ExceptionStackTraceDisplay(
+					new InvalidArgumentException(
+						sprintf(
+							esc_html__(
+								'A valid Event ID is required to use the "%1$s" shortcode.%4$sAn Event with an ID of "%2$s" could not be found.%4$sPlease verify that the shortcode added to this post\'s content includes an "%3$s" argument and that its value corresponds to a valid Event ID.',
+								'event_espresso'
+							),
+							$this->getTag(),
+							$event_id,
+							'event_id',
+							'<br />'
+						)
+					)
+				);
+				return '';
+			}
+			return sprintf(
+				esc_html__(
+					'An Event with an ID of "%s" could not be found. Please contact the event administrator for assistance.',
+					'event_espresso'
+				),
+				$event_id
+			);
+		}
+		ob_start();
+		do_action('AHEE_event_details_before_post', $event_id);
+		espresso_ticket_selector($event);
+		do_action('AHEE_event_details_after_post');
+		return ob_get_clean();
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -80,7 +80,7 @@
         extract($attributes, EXTR_OVERWRITE);
         $event_id = isset($event_id) ? $event_id : 0;
         $event = EE_Registry::instance()->load_model('Event')->get_one_by_ID($event_id);
-        if (! $event instanceof EE_Event) {
+        if ( ! $event instanceof EE_Event) {
             if (WP_DEBUG === true && current_user_can('edit_pages')) {
                 new ExceptionStackTraceDisplay(
                     new InvalidArgumentException(

core/libraries/messages/messenger/EE_Pdf_messenger.class.php

Spacing +4 added lines, -4 removed lines

@@ -259,7 +259,7 @@ 
             'base_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, true, 'base', $this->_variation),
             'print_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, true, 'print', $this->_variation),
             'main_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, true, 'main', $this->_variation),
-            'extra_css' => EE_LIBRARIES_URL . 'messages/defaults/default/variations/pdf_base_default.css',
+            'extra_css' => EE_LIBRARIES_URL.'messages/defaults/default/variations/pdf_base_default.css',
             'main_body' => apply_filters('FHEE__EE_Pdf_messenger___send_message__main_body', wpautop($this->_content), $this->_content)
         );
         $this->_deregister_wp_hooks();
@@ -323,8 +323,8 @@ 
         $invoice_name = $this->_subject;
 
         // only load dompdf if nobody else has yet...
-        if (! class_exists('Dompdf\Dompdf')) {
-            require_once(EE_THIRD_PARTY . 'dompdf/src/Autoloader.php');
+        if ( ! class_exists('Dompdf\Dompdf')) {
+            require_once(EE_THIRD_PARTY.'dompdf/src/Autoloader.php');
             Dompdf\Autoloader::register();
         }
         $options = new Dompdf\Options();
@@ -336,7 +336,7 @@ 
         $dompdf->loadHtml($content);
         $dompdf->render();
         // forcing the browser to open a download dialog.
-        $dompdf->stream($invoice_name . ".pdf", array('Attachment' => true));
+        $dompdf->stream($invoice_name.".pdf", array('Attachment' => true));
     }
 
 

Indentation +344 added lines, -344 removed lines

@@ -15,349 +15,349 @@
 {
 
 
-    /**
-     * The following are the properties that this messenger requires for generating pdf
-     */
-
-    /**
-     * This is the pdf body generated by the template via the message type.
-     *
-     * @var string
-     */
-    protected $_content;
-
-
-    /**
-     * This is for the page title that gets displayed.  This will end up being the filename for the generated pdf.
-     *
-     * @var string
-     */
-    protected $_subject;
-
-
-    /**
-     * @return EE_Pdf_messenger
-     */
-    public function __construct()
-    {
-        // set properties
-        $this->name = 'pdf';
-        $this->description = esc_html__('This messenger is used for generating a pdf version of the message.', 'event_espresso');
-        $this->label = array(
-            'singular' => esc_html__('PDF', 'event_espresso'),
-            'plural' => esc_html__('PDFs', 'event_espresso')
-        );
-        $this->activate_on_install = true;
-
-        parent::__construct();
-    }
-
-
-    /**
-     * PDF Messenger desires execution immediately.
-     * @see  parent::send_now() for documentation.
-     * @since  4.9.0
-     * @return bool
-     */
-    public function send_now()
-    {
-        return true;
-    }
-
-
-    /**
-     * HTML Messenger allows an empty to field.
-     * @see parent::allow_empty_to_field() for documentation
-     * @since  4.9.0
-     * @return bool
-     */
-    public function allow_empty_to_field()
-    {
-        return true;
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_admin_pages()
-    {
-        $this->admin_registered_pages = array('events_edit' => false);
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_valid_shortcodes()
-    {
-        $this->_valid_shortcodes = array();
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_validator_config()
-    {
-        $this->_validator_config = array(
-            'subject' => array(
-                'shortcodes' => array('recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email', 'event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime')
-            ),
-            'content' => array(
-                'shortcodes' => array('recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email', 'event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime')
-            ),
-            'attendee_list' => array(
-                'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
-                'required' => array('[ATTENDEE_LIST]')
-            ),
-            'event_list' => array(
-                'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'venue', 'datetime_list', 'attendee', 'primary_registration_details', 'primary_registration_list', 'event_author', 'recipient_details', 'recipient_list'),
-                'required' => array('[EVENT_LIST]')
-            ),
-            'ticket_list' => array(
-                'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list', 'primary_registration_details', 'recipient_details'),
-                'required' => array('[TICKET_LIST]')
-            ),
-            'datetime_list' => array(
-                'shortcodes' => array('datetime'),
-                'required' => array('[DATETIME_LIST]')
-            ),
-        );
-    }
-
-
-    /**
-     * Takes care of enqueuing any necessary scripts or styles for the page.  A do_action() so message types using this messenger can add their own js.
-     *
-     * @return void.
-     */
-    public function enqueue_scripts_styles()
-    {
-        parent::enqueue_scripts_styles();
-        do_action('AHEE__EE_Pdf_messenger__enqueue_scripts_styles');
-    }
-
-
-    /**
-     * _set_template_fields
-     * This sets up the fields that a messenger requires for the message to go out.
-     *
-     * @access  protected
-     * @return void
-     */
-    protected function _set_template_fields()
-    {
-        // any extra template fields that are NOT used by the messenger but will get used by a messenger field for shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field they relate to.  This is important for the Messages_admin to know what fields to display to the user.  Also, notice that the "values" are equal to the field type that messages admin will use to know what kind of field to display. The values ALSO have one index labeled "shortcode".  the values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be displayed.  If the required shortcode isn't part of the shortcodes array then the field is not needed and will not be displayed/parsed.
-        $this->_template_fields = array(
-            'subject' => array(
-                'input' => 'text',
-                'label' => esc_html__('Page Title', 'event_espresso'),
-                'type' => 'string',
-                'required' => true,
-                'validation' => true,
-                'css_class' => 'large-text',
-                'format' => '%s'
-            ),
-            'content' => '', // left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
-            'extra' => array(
-                'content' => array(
-                    'main' => array(
-                        'input' => 'wp_editor',
-                        'label' => esc_html__('Main Content', 'event_espresso'),
-                        'type' => 'string',
-                        'required' => true,
-                        'validation' => true,
-                        'format' => '%s',
-                        'rows' => '15'
-                    ),
-                    'event_list' => array(
-                        'input' => 'wp_editor',
-                        'label' => '[EVENT_LIST]',
-                        'type' => 'string',
-                        'required' => true,
-                        'validation' => true,
-                        'format' => '%s',
-                        'rows' => '15',
-                        'shortcodes_required' => array('[EVENT_LIST]')
-                    ),
-                    'attendee_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[ATTENDEE_LIST]',
-                        'type' => 'string',
-                        'required' => true,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '5',
-                        'shortcodes_required' => array('[ATTENDEE_LIST]')
-                    ),
-                    'ticket_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[TICKET_LIST]',
-                        'type' => 'string',
-                        'required' => true,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '10',
-                        'shortcodes_required' => array('[TICKET_LIST]')
-                    ),
-                    'datetime_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[DATETIME_LIST]',
-                        'type' => 'string',
-                        'required' => true,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '10',
-                        'shortcodes_required' => array('[DATETIME_LIST]')
-                    )
-                )
-            )
-        );
-    }
-
-
-    /**
-     * @see definition of this method in parent
-     *
-     * @since 4.5.0
-     *
-     */
-    protected function _set_default_message_types()
-    {
-        // note currently PDF is only a secondary messenger so it never has any associated message types.
-        $this->_default_message_types = array();
-    }
-
-
-    /**
-     * @see definition of this method in parent
-     *
-     * @since 4.5.0
-     */
-    protected function _set_valid_message_types()
-    {
-        $this->_valid_message_types = array();
-    }
-
-
-    /**
-     * Generates html version of the message content and then sends it to the pdf generator.
-     *
-     *
-     * @since 4.5.0
-     *
-     * @return string.
-     */
-    protected function _send_message()
-    {
-        $this->_template_args = array(
-            'page_title' => $this->_subject,
-            'base_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, true, 'base', $this->_variation),
-            'print_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, true, 'print', $this->_variation),
-            'main_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, true, 'main', $this->_variation),
-            'extra_css' => EE_LIBRARIES_URL . 'messages/defaults/default/variations/pdf_base_default.css',
-            'main_body' => apply_filters('FHEE__EE_Pdf_messenger___send_message__main_body', wpautop($this->_content), $this->_content)
-        );
-        $this->_deregister_wp_hooks();
-        add_action('wp_enqueue_scripts', array($this, 'enqueue_scripts_styles'));
-        $content = $this->_get_main_template();
+	/**
+	 * The following are the properties that this messenger requires for generating pdf
+	 */
+
+	/**
+	 * This is the pdf body generated by the template via the message type.
+	 *
+	 * @var string
+	 */
+	protected $_content;
+
+
+	/**
+	 * This is for the page title that gets displayed.  This will end up being the filename for the generated pdf.
+	 *
+	 * @var string
+	 */
+	protected $_subject;
+
+
+	/**
+	 * @return EE_Pdf_messenger
+	 */
+	public function __construct()
+	{
+		// set properties
+		$this->name = 'pdf';
+		$this->description = esc_html__('This messenger is used for generating a pdf version of the message.', 'event_espresso');
+		$this->label = array(
+			'singular' => esc_html__('PDF', 'event_espresso'),
+			'plural' => esc_html__('PDFs', 'event_espresso')
+		);
+		$this->activate_on_install = true;
+
+		parent::__construct();
+	}
+
+
+	/**
+	 * PDF Messenger desires execution immediately.
+	 * @see  parent::send_now() for documentation.
+	 * @since  4.9.0
+	 * @return bool
+	 */
+	public function send_now()
+	{
+		return true;
+	}
+
+
+	/**
+	 * HTML Messenger allows an empty to field.
+	 * @see parent::allow_empty_to_field() for documentation
+	 * @since  4.9.0
+	 * @return bool
+	 */
+	public function allow_empty_to_field()
+	{
+		return true;
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_admin_pages()
+	{
+		$this->admin_registered_pages = array('events_edit' => false);
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_valid_shortcodes()
+	{
+		$this->_valid_shortcodes = array();
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_validator_config()
+	{
+		$this->_validator_config = array(
+			'subject' => array(
+				'shortcodes' => array('recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email', 'event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime')
+			),
+			'content' => array(
+				'shortcodes' => array('recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email', 'event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime')
+			),
+			'attendee_list' => array(
+				'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
+				'required' => array('[ATTENDEE_LIST]')
+			),
+			'event_list' => array(
+				'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'venue', 'datetime_list', 'attendee', 'primary_registration_details', 'primary_registration_list', 'event_author', 'recipient_details', 'recipient_list'),
+				'required' => array('[EVENT_LIST]')
+			),
+			'ticket_list' => array(
+				'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list', 'primary_registration_details', 'recipient_details'),
+				'required' => array('[TICKET_LIST]')
+			),
+			'datetime_list' => array(
+				'shortcodes' => array('datetime'),
+				'required' => array('[DATETIME_LIST]')
+			),
+		);
+	}
+
+
+	/**
+	 * Takes care of enqueuing any necessary scripts or styles for the page.  A do_action() so message types using this messenger can add their own js.
+	 *
+	 * @return void.
+	 */
+	public function enqueue_scripts_styles()
+	{
+		parent::enqueue_scripts_styles();
+		do_action('AHEE__EE_Pdf_messenger__enqueue_scripts_styles');
+	}
+
+
+	/**
+	 * _set_template_fields
+	 * This sets up the fields that a messenger requires for the message to go out.
+	 *
+	 * @access  protected
+	 * @return void
+	 */
+	protected function _set_template_fields()
+	{
+		// any extra template fields that are NOT used by the messenger but will get used by a messenger field for shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field they relate to.  This is important for the Messages_admin to know what fields to display to the user.  Also, notice that the "values" are equal to the field type that messages admin will use to know what kind of field to display. The values ALSO have one index labeled "shortcode".  the values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be displayed.  If the required shortcode isn't part of the shortcodes array then the field is not needed and will not be displayed/parsed.
+		$this->_template_fields = array(
+			'subject' => array(
+				'input' => 'text',
+				'label' => esc_html__('Page Title', 'event_espresso'),
+				'type' => 'string',
+				'required' => true,
+				'validation' => true,
+				'css_class' => 'large-text',
+				'format' => '%s'
+			),
+			'content' => '', // left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
+			'extra' => array(
+				'content' => array(
+					'main' => array(
+						'input' => 'wp_editor',
+						'label' => esc_html__('Main Content', 'event_espresso'),
+						'type' => 'string',
+						'required' => true,
+						'validation' => true,
+						'format' => '%s',
+						'rows' => '15'
+					),
+					'event_list' => array(
+						'input' => 'wp_editor',
+						'label' => '[EVENT_LIST]',
+						'type' => 'string',
+						'required' => true,
+						'validation' => true,
+						'format' => '%s',
+						'rows' => '15',
+						'shortcodes_required' => array('[EVENT_LIST]')
+					),
+					'attendee_list' => array(
+						'input' => 'textarea',
+						'label' => '[ATTENDEE_LIST]',
+						'type' => 'string',
+						'required' => true,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '5',
+						'shortcodes_required' => array('[ATTENDEE_LIST]')
+					),
+					'ticket_list' => array(
+						'input' => 'textarea',
+						'label' => '[TICKET_LIST]',
+						'type' => 'string',
+						'required' => true,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '10',
+						'shortcodes_required' => array('[TICKET_LIST]')
+					),
+					'datetime_list' => array(
+						'input' => 'textarea',
+						'label' => '[DATETIME_LIST]',
+						'type' => 'string',
+						'required' => true,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '10',
+						'shortcodes_required' => array('[DATETIME_LIST]')
+					)
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * @see definition of this method in parent
+	 *
+	 * @since 4.5.0
+	 *
+	 */
+	protected function _set_default_message_types()
+	{
+		// note currently PDF is only a secondary messenger so it never has any associated message types.
+		$this->_default_message_types = array();
+	}
+
+
+	/**
+	 * @see definition of this method in parent
+	 *
+	 * @since 4.5.0
+	 */
+	protected function _set_valid_message_types()
+	{
+		$this->_valid_message_types = array();
+	}
+
+
+	/**
+	 * Generates html version of the message content and then sends it to the pdf generator.
+	 *
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return string.
+	 */
+	protected function _send_message()
+	{
+		$this->_template_args = array(
+			'page_title' => $this->_subject,
+			'base_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, true, 'base', $this->_variation),
+			'print_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, true, 'print', $this->_variation),
+			'main_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, true, 'main', $this->_variation),
+			'extra_css' => EE_LIBRARIES_URL . 'messages/defaults/default/variations/pdf_base_default.css',
+			'main_body' => apply_filters('FHEE__EE_Pdf_messenger___send_message__main_body', wpautop($this->_content), $this->_content)
+		);
+		$this->_deregister_wp_hooks();
+		add_action('wp_enqueue_scripts', array($this, 'enqueue_scripts_styles'));
+		$content = $this->_get_main_template();
 //      die( $content );
-        $this->_do_pdf($content);
-        exit(0);
-    }
-
-
-    /**
-     * The purpose of this function is to de register all actions hooked into wp_head and wp_footer so that it doesn't interfere with our templates.  If users want to add any custom styles or scripts they must use the AHEE__EE_Pdf_messenger__enqueue_scripts_styles hook.
-     *
-     * @since 4.5.0
-     *
-     * @return void
-     */
-    protected function _deregister_wp_hooks()
-    {
-        remove_all_actions('wp_head');
-        remove_all_actions('wp_footer');
-        remove_all_actions('wp_print_footer_scripts');
-        remove_all_actions('wp_enqueue_scripts');
-        global $wp_scripts, $wp_styles;
-        $wp_scripts = $wp_styles = array();
-
-        // just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load.
-        add_action('wp_head', 'wp_enqueue_scripts');
-        add_action('wp_footer', 'wp_print_footer_scripts');
-        add_action('wp_print_footer_scripts', '_wp_footer_scripts');
-    }
-
-
-    /**
-     * Overwrite parent _get_main_template for pdf purposes.
-     *
-     * @since  4.5.0
-     *
-     * @param bool $preview
-     * @return string
-     */
-    protected function _get_main_template($preview = false)
-    {
-        $wrapper_template = $this->_tmp_pack->get_wrapper('html', 'main');
-        // add message type to template_args
-        $this->_template_args['message_type'] = $this->_incoming_message_type;
-        return EEH_Template::display_template($wrapper_template, $this->_template_args, true);
-    }
-
-
-    /**
-     * This takes care of loading the dompdf library and generating the actual pdf
-     *
-     * @param string $content This is the generated html content being converted into a pdf.
-     *
-     * @return void
-     */
-    protected function _do_pdf($content = '')
-    {
-        $invoice_name = $this->_subject;
-
-        // only load dompdf if nobody else has yet...
-        if (! class_exists('Dompdf\Dompdf')) {
-            require_once(EE_THIRD_PARTY . 'dompdf/src/Autoloader.php');
-            Dompdf\Autoloader::register();
-        }
-        $options = new Dompdf\Options();
-        $options->set('isRemoteEnabled', true);
-        $options->set('isJavascriptEnabled', false);
-        if (defined('DOMPDF_FONT_DIR')) {
-            $options->setFontDir(DOMPDF_FONT_DIR);
-            $options->setFontCache(DOMPDF_FONT_DIR);
-        }
-        // Allow changing the paper size.
-        if (defined('DOMPDF_DEFAULT_PAPER_SIZE')) {
-            $options->set('defaultPaperSize', DOMPDF_DEFAULT_PAPER_SIZE);
-        }
-        $dompdf = new Dompdf\Dompdf($options);
-        // Remove all spaces between HTML tags
-        $content = preg_replace('/>\s+</', '><', $content);
-        $dompdf->loadHtml($content);
-        $dompdf->render();
-        // forcing the browser to open a download dialog.
-        $dompdf->stream($invoice_name . ".pdf", array('Attachment' => true));
-    }
-
-
-    /**
-     * @return string
-     */
-    protected function _preview()
-    {
-        return $this->_send_message();
-    }
-
-
-    protected function _set_admin_settings_fields()
-    {
-    }
+		$this->_do_pdf($content);
+		exit(0);
+	}
+
+
+	/**
+	 * The purpose of this function is to de register all actions hooked into wp_head and wp_footer so that it doesn't interfere with our templates.  If users want to add any custom styles or scripts they must use the AHEE__EE_Pdf_messenger__enqueue_scripts_styles hook.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return void
+	 */
+	protected function _deregister_wp_hooks()
+	{
+		remove_all_actions('wp_head');
+		remove_all_actions('wp_footer');
+		remove_all_actions('wp_print_footer_scripts');
+		remove_all_actions('wp_enqueue_scripts');
+		global $wp_scripts, $wp_styles;
+		$wp_scripts = $wp_styles = array();
+
+		// just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load.
+		add_action('wp_head', 'wp_enqueue_scripts');
+		add_action('wp_footer', 'wp_print_footer_scripts');
+		add_action('wp_print_footer_scripts', '_wp_footer_scripts');
+	}
+
+
+	/**
+	 * Overwrite parent _get_main_template for pdf purposes.
+	 *
+	 * @since  4.5.0
+	 *
+	 * @param bool $preview
+	 * @return string
+	 */
+	protected function _get_main_template($preview = false)
+	{
+		$wrapper_template = $this->_tmp_pack->get_wrapper('html', 'main');
+		// add message type to template_args
+		$this->_template_args['message_type'] = $this->_incoming_message_type;
+		return EEH_Template::display_template($wrapper_template, $this->_template_args, true);
+	}
+
+
+	/**
+	 * This takes care of loading the dompdf library and generating the actual pdf
+	 *
+	 * @param string $content This is the generated html content being converted into a pdf.
+	 *
+	 * @return void
+	 */
+	protected function _do_pdf($content = '')
+	{
+		$invoice_name = $this->_subject;
+
+		// only load dompdf if nobody else has yet...
+		if (! class_exists('Dompdf\Dompdf')) {
+			require_once(EE_THIRD_PARTY . 'dompdf/src/Autoloader.php');
+			Dompdf\Autoloader::register();
+		}
+		$options = new Dompdf\Options();
+		$options->set('isRemoteEnabled', true);
+		$options->set('isJavascriptEnabled', false);
+		if (defined('DOMPDF_FONT_DIR')) {
+			$options->setFontDir(DOMPDF_FONT_DIR);
+			$options->setFontCache(DOMPDF_FONT_DIR);
+		}
+		// Allow changing the paper size.
+		if (defined('DOMPDF_DEFAULT_PAPER_SIZE')) {
+			$options->set('defaultPaperSize', DOMPDF_DEFAULT_PAPER_SIZE);
+		}
+		$dompdf = new Dompdf\Dompdf($options);
+		// Remove all spaces between HTML tags
+		$content = preg_replace('/>\s+</', '><', $content);
+		$dompdf->loadHtml($content);
+		$dompdf->render();
+		// forcing the browser to open a download dialog.
+		$dompdf->stream($invoice_name . ".pdf", array('Attachment' => true));
+	}
+
+
+	/**
+	 * @return string
+	 */
+	protected function _preview()
+	{
+		return $this->_send_message();
+	}
+
+
+	protected function _set_admin_settings_fields()
+	{
+	}
 }