Completed
Branch FET/extract-activation-detecti... (0caf02)
by
unknown
07:42 queued 05:38
created
acceptance_tests/Helpers/EventsAdmin.php 1 patch
Indentation   +129 added lines, -129 removed lines patch added patch discarded remove patch
@@ -14,133 +14,133 @@
 block discarded – undo
14 14
 trait EventsAdmin
15 15
 {
16 16
 
17
-    /**
18
-     * @param string $additional_params
19
-     */
20
-    public function amOnDefaultEventsListTablePage($additional_params = '')
21
-    {
22
-        $this->actor()->amOnAdminPage(EventsPage::defaultEventsListTableUrl($additional_params));
23
-    }
24
-
25
-
26
-    /**
27
-     * Triggers the publishing of the Event.
28
-     */
29
-    public function publishEvent()
30
-    {
31
-        $this->actor()->scrollTo(EventsPage::EVENT_EDITOR_TITLE_FIELD_SELECTOR);
32
-        $this->actor()->wait(3);
33
-        $this->actor()->click(EventsPage::EVENT_EDITOR_PUBLISH_BUTTON_SELECTOR);
34
-        $this->actor()->waitForText('Event published.', 30);
35
-    }
36
-
37
-
38
-    /**
39
-     * Triggers saving the Event.
40
-     */
41
-    public function saveEvent()
42
-    {
43
-        $this->actor()->scrollTo(EventsPage::EVENT_EDITOR_TITLE_FIELD_SELECTOR);
44
-        $this->actor()->wait(2);
45
-        $this->actor()->click(EventsPage::EVENT_EDITOR_SAVE_BUTTON_SELECTOR);
46
-    }
47
-
48
-
49
-    /**
50
-     * Navigates the actor to the event list table page and will attempt to edit the event for the given title.
51
-     * First this will search using the given title and then attempt to edit from the results of the search.
52
-     *
53
-     * Assumes actor is already logged in.
54
-     * @param $event_title
55
-     */
56
-    public function amEditingTheEventWithTitle($event_title)
57
-    {
58
-        $this->amOnDefaultEventsListTablePage();
59
-        $this->actor()->fillField(EventsPage::EVENT_LIST_TABLE_SEARCH_INPUT_SELECTOR, $event_title);
60
-        $this->actor()->click(CoreAdmin::LIST_TABLE_SEARCH_SUBMIT_SELECTOR);
61
-        $this->actor()->waitForText($event_title, 15);
62
-        $this->actor()->click(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title));
63
-    }
64
-
65
-
66
-    /**
67
-     * Navigates the user to the single event page (frontend view) for the given event title via clicking the "View"
68
-     * link for the event in the event list table.
69
-     * Assumes the actor is already logged in and on the Event list table page.
70
-     *
71
-     * @param string $event_title
72
-     */
73
-    public function amOnEventPageAfterClickingViewLinkInListTableForEvent($event_title)
74
-    {
75
-        $this->actor()->moveMouseOver(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title));
76
-        $this->actor()->click(EventsPage::eventListTableEventTitleViewLinkSelectorForTitle($event_title));
77
-    }
78
-
79
-
80
-    /**
81
-     * Used to retrieve the event id for the event via the list table and for the given event.
82
-     * @param string $event_title
83
-     */
84
-    public function observeEventIdInListTableForEvent($event_title)
85
-    {
86
-        return $this->actor()->observeValueFromInputAt(EventsPage::eventListTableEventIdSelectorForTitle($event_title));
87
-    }
88
-
89
-
90
-    /**
91
-     * This performs the click action on the gear icon that triggers the advanced settings view state.
92
-     * Assumes the actor is already logged in and editing an event.
93
-     *
94
-     * @param int $row_number  What ticket row to toggle open/close.
95
-     */
96
-    public function toggleAdvancedSettingsViewForTicketRow($row_number = 1)
97
-    {
98
-        $this->actor()->click(EventsPage::eventEditorTicketAdvancedDetailsSelector($row_number));
99
-    }
100
-
101
-
102
-    /**
103
-     * Toggles the TKT_is_taxable checkbox for the ticket in the given row.
104
-     * Assumes the actor is already logged in and editing an event and that the advanced settings view state for that
105
-     * ticket is "open".
106
-     *
107
-     * @param int $row_number  What ticket row to toggle the checkbox for.
108
-     */
109
-    public function toggleTicketIsTaxableForTicketRow($row_number = 1)
110
-    {
111
-        $this->actor()->click(EventsPage::eventEditorTicketTaxableCheckboxSelector($row_number));
112
-    }
113
-
114
-
115
-    /**
116
-     * Use to change the default registration status for the event.
117
-     * Assumes the view is already on the event editor.
118
-     * @param $registration_status
119
-     */
120
-    public function changeDefaultRegistrationStatusTo($registration_status)
121
-    {
122
-        $this->actor()->selectOption(
123
-            EventsPage::EVENT_EDITOR_DEFAULT_REGISTRATION_STATUS_FIELD_SELECTOR,
124
-            $registration_status
125
-        );
126
-    }
127
-
128
-
129
-    /**
130
-     * Use this from the context of the event editor to select the given custom template for a given message type and
131
-     * messenger.
132
-     *
133
-     * @param string $message_type_label  The visible label for the message type (eg Registration Approved)
134
-     * @param string $messenger_slug      The slug for the messenger (eg 'email')
135
-     * @param string $custom_template_label The visible label in the select input for the custom template you want
136
-     *                                      selected.
137
-     */
138
-    public function selectCustomTemplateFor($message_type_label, $messenger_slug, $custom_template_label)
139
-    {
140
-        $this->actor()->click(EventsPage::eventEditorNotificationsMetaBoxMessengerTabSelector($messenger_slug));
141
-        $this->actor()->selectOption(
142
-            EventsPage::eventEditorNotificationsMetaBoxSelectSelectorForMessageType($message_type_label),
143
-            $custom_template_label
144
-        );
145
-    }
17
+	/**
18
+	 * @param string $additional_params
19
+	 */
20
+	public function amOnDefaultEventsListTablePage($additional_params = '')
21
+	{
22
+		$this->actor()->amOnAdminPage(EventsPage::defaultEventsListTableUrl($additional_params));
23
+	}
24
+
25
+
26
+	/**
27
+	 * Triggers the publishing of the Event.
28
+	 */
29
+	public function publishEvent()
30
+	{
31
+		$this->actor()->scrollTo(EventsPage::EVENT_EDITOR_TITLE_FIELD_SELECTOR);
32
+		$this->actor()->wait(3);
33
+		$this->actor()->click(EventsPage::EVENT_EDITOR_PUBLISH_BUTTON_SELECTOR);
34
+		$this->actor()->waitForText('Event published.', 30);
35
+	}
36
+
37
+
38
+	/**
39
+	 * Triggers saving the Event.
40
+	 */
41
+	public function saveEvent()
42
+	{
43
+		$this->actor()->scrollTo(EventsPage::EVENT_EDITOR_TITLE_FIELD_SELECTOR);
44
+		$this->actor()->wait(2);
45
+		$this->actor()->click(EventsPage::EVENT_EDITOR_SAVE_BUTTON_SELECTOR);
46
+	}
47
+
48
+
49
+	/**
50
+	 * Navigates the actor to the event list table page and will attempt to edit the event for the given title.
51
+	 * First this will search using the given title and then attempt to edit from the results of the search.
52
+	 *
53
+	 * Assumes actor is already logged in.
54
+	 * @param $event_title
55
+	 */
56
+	public function amEditingTheEventWithTitle($event_title)
57
+	{
58
+		$this->amOnDefaultEventsListTablePage();
59
+		$this->actor()->fillField(EventsPage::EVENT_LIST_TABLE_SEARCH_INPUT_SELECTOR, $event_title);
60
+		$this->actor()->click(CoreAdmin::LIST_TABLE_SEARCH_SUBMIT_SELECTOR);
61
+		$this->actor()->waitForText($event_title, 15);
62
+		$this->actor()->click(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title));
63
+	}
64
+
65
+
66
+	/**
67
+	 * Navigates the user to the single event page (frontend view) for the given event title via clicking the "View"
68
+	 * link for the event in the event list table.
69
+	 * Assumes the actor is already logged in and on the Event list table page.
70
+	 *
71
+	 * @param string $event_title
72
+	 */
73
+	public function amOnEventPageAfterClickingViewLinkInListTableForEvent($event_title)
74
+	{
75
+		$this->actor()->moveMouseOver(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title));
76
+		$this->actor()->click(EventsPage::eventListTableEventTitleViewLinkSelectorForTitle($event_title));
77
+	}
78
+
79
+
80
+	/**
81
+	 * Used to retrieve the event id for the event via the list table and for the given event.
82
+	 * @param string $event_title
83
+	 */
84
+	public function observeEventIdInListTableForEvent($event_title)
85
+	{
86
+		return $this->actor()->observeValueFromInputAt(EventsPage::eventListTableEventIdSelectorForTitle($event_title));
87
+	}
88
+
89
+
90
+	/**
91
+	 * This performs the click action on the gear icon that triggers the advanced settings view state.
92
+	 * Assumes the actor is already logged in and editing an event.
93
+	 *
94
+	 * @param int $row_number  What ticket row to toggle open/close.
95
+	 */
96
+	public function toggleAdvancedSettingsViewForTicketRow($row_number = 1)
97
+	{
98
+		$this->actor()->click(EventsPage::eventEditorTicketAdvancedDetailsSelector($row_number));
99
+	}
100
+
101
+
102
+	/**
103
+	 * Toggles the TKT_is_taxable checkbox for the ticket in the given row.
104
+	 * Assumes the actor is already logged in and editing an event and that the advanced settings view state for that
105
+	 * ticket is "open".
106
+	 *
107
+	 * @param int $row_number  What ticket row to toggle the checkbox for.
108
+	 */
109
+	public function toggleTicketIsTaxableForTicketRow($row_number = 1)
110
+	{
111
+		$this->actor()->click(EventsPage::eventEditorTicketTaxableCheckboxSelector($row_number));
112
+	}
113
+
114
+
115
+	/**
116
+	 * Use to change the default registration status for the event.
117
+	 * Assumes the view is already on the event editor.
118
+	 * @param $registration_status
119
+	 */
120
+	public function changeDefaultRegistrationStatusTo($registration_status)
121
+	{
122
+		$this->actor()->selectOption(
123
+			EventsPage::EVENT_EDITOR_DEFAULT_REGISTRATION_STATUS_FIELD_SELECTOR,
124
+			$registration_status
125
+		);
126
+	}
127
+
128
+
129
+	/**
130
+	 * Use this from the context of the event editor to select the given custom template for a given message type and
131
+	 * messenger.
132
+	 *
133
+	 * @param string $message_type_label  The visible label for the message type (eg Registration Approved)
134
+	 * @param string $messenger_slug      The slug for the messenger (eg 'email')
135
+	 * @param string $custom_template_label The visible label in the select input for the custom template you want
136
+	 *                                      selected.
137
+	 */
138
+	public function selectCustomTemplateFor($message_type_label, $messenger_slug, $custom_template_label)
139
+	{
140
+		$this->actor()->click(EventsPage::eventEditorNotificationsMetaBoxMessengerTabSelector($messenger_slug));
141
+		$this->actor()->selectOption(
142
+			EventsPage::eventEditorNotificationsMetaBoxSelectSelectorForMessageType($message_type_label),
143
+			$custom_template_label
144
+		);
145
+	}
146 146
 }
147 147
\ No newline at end of file
Please login to merge, or discard this patch.
core/middleware/EE_Detect_File_Editor_Request.core.php 1 patch
Indentation   +23 added lines, -23 removed lines patch added patch discarded remove patch
@@ -14,28 +14,28 @@
 block discarded – undo
14 14
 class EE_Detect_File_Editor_Request extends EE_Middleware
15 15
 {
16 16
 
17
-    /**
18
-     * @deprecated
19
-     * @param EE_Request  $request
20
-     * @param EE_Response $response
21
-     * @return EE_Response
22
-     */
23
-    public function handle_request(EE_Request $request, EE_Response $response)
24
-    {
25
-        EE_Error::doing_it_wrong(
26
-            __METHOD__,
27
-            sprintf(
28
-                esc_html__(
29
-                    'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
30
-                    'event_espresso'
31
-                ),
32
-                'EventEspresso\core\services\request\middleware\DetectFileEditorRequest',
33
-                '\core\services\request',
34
-                'EventEspresso\core\services\request'
35
-            ),
36
-            '4.9.52'
37
-        );
38
-        return $response;
39
-    }
17
+	/**
18
+	 * @deprecated
19
+	 * @param EE_Request  $request
20
+	 * @param EE_Response $response
21
+	 * @return EE_Response
22
+	 */
23
+	public function handle_request(EE_Request $request, EE_Response $response)
24
+	{
25
+		EE_Error::doing_it_wrong(
26
+			__METHOD__,
27
+			sprintf(
28
+				esc_html__(
29
+					'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
30
+					'event_espresso'
31
+				),
32
+				'EventEspresso\core\services\request\middleware\DetectFileEditorRequest',
33
+				'\core\services\request',
34
+				'EventEspresso\core\services\request'
35
+			),
36
+			'4.9.52'
37
+		);
38
+		return $response;
39
+	}
40 40
 
41 41
 }
Please login to merge, or discard this patch.
core/domain/services/admin/PluginUpsells.php 2 patches
Spacing   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -83,12 +83,12 @@
 block discarded – undo
83 83
                     <div class="notice inline notice-alt">
84 84
                         <div class="ee-upsell-container">
85 85
                             <div class="ee-upsell-inner-container">
86
-                                <a href="' . $button_url . '">
87
-                                    ' . $button_text . '
86
+                                <a href="' . $button_url.'">
87
+                                    ' . $button_text.'
88 88
                                 </a>
89 89
                             </div>
90 90
                             <div class="ee-upsell-inner-container">
91
-                                <p>' . $upsell_text . '</p>
91
+                                <p>' . $upsell_text.'</p>
92 92
                             </div>
93 93
                             <div style="clear:both"></div>
94 94
                         </div>
Please login to merge, or discard this patch.
Indentation   +57 added lines, -57 removed lines patch added patch discarded remove patch
@@ -17,47 +17,47 @@  discard block
 block discarded – undo
17 17
 class PluginUpsells
18 18
 {
19 19
 
20
-    /**
21
-     * @var DomainInterface
22
-     */
23
-    private $domain;
20
+	/**
21
+	 * @var DomainInterface
22
+	 */
23
+	private $domain;
24 24
 
25 25
 
26
-    /**
27
-     * PluginUpsells constructor.
28
-     *
29
-     * @param DomainInterface $domain
30
-     */
31
-    public function __construct(DomainInterface $domain)
32
-    {
33
-        $this->domain = $domain;
34
-    }
26
+	/**
27
+	 * PluginUpsells constructor.
28
+	 *
29
+	 * @param DomainInterface $domain
30
+	 */
31
+	public function __construct(DomainInterface $domain)
32
+	{
33
+		$this->domain = $domain;
34
+	}
35 35
 
36 36
 
37
-    /**
38
-     * Hook in various upsells for the decaf version of EE.
39
-     */
40
-    public function decafUpsells()
41
-    {
42
-        if ($this->domain instanceof CaffeinatedInterface && ! $this->domain->isCaffeinated()) {
43
-            add_action('after_plugin_row', array($this, 'doPremiumUpsell'), 10, 3);
44
-        }
45
-    }
37
+	/**
38
+	 * Hook in various upsells for the decaf version of EE.
39
+	 */
40
+	public function decafUpsells()
41
+	{
42
+		if ($this->domain instanceof CaffeinatedInterface && ! $this->domain->isCaffeinated()) {
43
+			add_action('after_plugin_row', array($this, 'doPremiumUpsell'), 10, 3);
44
+		}
45
+	}
46 46
 
47 47
 
48
-    /**
49
-     * Callback for `after_plugin_row` to add upsell info
50
-     *
51
-     * @param string $plugin_file
52
-     * @param array  $plugin_data
53
-     * @param string $status
54
-     * @throws DomainException
55
-     */
56
-    public function doPremiumUpsell($plugin_file, $plugin_data, $status)
57
-    {
58
-        if ($plugin_file === $this->domain->pluginBasename()) {
59
-            list($button_text, $button_url, $upsell_text) = $this->getAfterPluginRowDetails();
60
-            echo '<tr class="plugin-update-tr ee-upsell-plugin-list-table active">
48
+	/**
49
+	 * Callback for `after_plugin_row` to add upsell info
50
+	 *
51
+	 * @param string $plugin_file
52
+	 * @param array  $plugin_data
53
+	 * @param string $status
54
+	 * @throws DomainException
55
+	 */
56
+	public function doPremiumUpsell($plugin_file, $plugin_data, $status)
57
+	{
58
+		if ($plugin_file === $this->domain->pluginBasename()) {
59
+			list($button_text, $button_url, $upsell_text) = $this->getAfterPluginRowDetails();
60
+			echo '<tr class="plugin-update-tr ee-upsell-plugin-list-table active">
61 61
                 <td colspan="3" class="plugin-update colspanchange">
62 62
                     <div class="notice inline notice-alt">
63 63
                         <div class="ee-upsell-container">
@@ -74,27 +74,27 @@  discard block
 block discarded – undo
74 74
                     </div>
75 75
                 </td>
76 76
               </tr>';
77
-        }
78
-    }
77
+		}
78
+	}
79 79
 
80
-    /**
81
-     * Provide the details used for the upsell container.
82
-     *
83
-     * @return array
84
-     */
85
-    protected function getAfterPluginRowDetails()
86
-    {
87
-        return array(
88
-            esc_html__('Upgrade for Support', 'event_espresso'),
89
-            'https://eventespresso.com/purchase/?slug=ee4-license-personal&utm_source=wp_admin_plugins_screen&utm_medium=link&utm_campaign=plugins_screen_upgrade_link" class="button button-primary',
90
-            sprintf(
91
-                esc_html__(
92
-                    'You\'re missing out on %1$sexpert support%2$s and %1$sone-click updates%2$s! Don\'t have an Event Espresso support license key? Support the project and buy one today!',
93
-                    'event_espresso'
94
-                ),
95
-                '<strong>',
96
-                '</strong>'
97
-            ),
98
-        );
99
-    }
80
+	/**
81
+	 * Provide the details used for the upsell container.
82
+	 *
83
+	 * @return array
84
+	 */
85
+	protected function getAfterPluginRowDetails()
86
+	{
87
+		return array(
88
+			esc_html__('Upgrade for Support', 'event_espresso'),
89
+			'https://eventespresso.com/purchase/?slug=ee4-license-personal&utm_source=wp_admin_plugins_screen&utm_medium=link&utm_campaign=plugins_screen_upgrade_link" class="button button-primary',
90
+			sprintf(
91
+				esc_html__(
92
+					'You\'re missing out on %1$sexpert support%2$s and %1$sone-click updates%2$s! Don\'t have an Event Espresso support license key? Support the project and buy one today!',
93
+					'event_espresso'
94
+				),
95
+				'<strong>',
96
+				'</strong>'
97
+			),
98
+		);
99
+	}
100 100
 }
Please login to merge, or discard this patch.
core/services/activation/ActivationHistory.php 2 patches
Indentation   +276 added lines, -276 removed lines patch added patch discarded remove patch
@@ -20,282 +20,282 @@
 block discarded – undo
20 20
 class ActivationHistory
21 21
 {
22 22
 
23
-    /**
24
-     * option name for recording the activation history for core
25
-     */
26
-    const EE_ACTIVATION_HISTORY_OPTION_NAME = 'espresso_db_update';
27
-
28
-    /**
29
-     * option name for indicating that the current request is for activating core
30
-     */
31
-    const EE_ACTIVATION_INDICATOR_OPTION_NAME = 'ee_espresso_activation';
32
-
33
-    /**
34
-     * stores the values for the activation history option name for core or an addon
35
-     *
36
-     * @var string $activation_history_option_name
37
-     */
38
-    protected $activation_history_option_name;
39
-
40
-    /**
41
-     * stores the values for the activation indicator option name for core or an addon
42
-     *
43
-     * @var string $activation_indicator_option_name
44
-     */
45
-    protected $activation_indicator_option_name;
46
-
47
-    /**
48
-     * the current version for core or an addon, like "1.2.3.p"
49
-     *
50
-     * @var string $current_version
51
-     */
52
-    protected $current_version;
53
-
54
-    /**
55
-     * array of activated versions and activation dates for core or an addon
56
-     *
57
-     * @var array $version_history
58
-     */
59
-    protected $version_history;
60
-
61
-
62
-
63
-    /**
64
-     * ActivationHistory constructor.
65
-     *
66
-     * @param string $activation_history_option_name
67
-     * @param string $activation_indicator_option_name
68
-     * @param string $current_version
69
-     * @throws InvalidDataTypeException
70
-     */
71
-    public function __construct(
72
-        $activation_history_option_name = '',
73
-        $activation_indicator_option_name = '',
74
-        $current_version = ''
75
-    ) {
76
-        $this->setActivationHistoryOptionName($activation_history_option_name);
77
-        $this->setActivationIndicatorOptionName($activation_indicator_option_name);
78
-        $this->setCurrentVersion($current_version);
79
-        $this->version_history = (array) get_option($this->activation_history_option_name, array());
80
-    }
81
-
82
-
83
-
84
-    /**
85
-     * @param string $activation_history_option_name
86
-     * @throws InvalidDataTypeException
87
-     */
88
-    protected function setActivationHistoryOptionName($activation_history_option_name)
89
-    {
90
-        if(! is_string($activation_history_option_name)) {
91
-            throw new InvalidDataTypeException(
92
-                '$activation_history_option_name',
93
-                $activation_history_option_name,
94
-                'string'
95
-            );
96
-        }
97
-        $this->activation_history_option_name = $activation_history_option_name !== ''
98
-            ? $activation_history_option_name
99
-            : ActivationHistory::EE_ACTIVATION_HISTORY_OPTION_NAME;
100
-    }
101
-
102
-
103
-
104
-    /**
105
-     * @param string $activation_indicator_option_name
106
-     * @throws InvalidDataTypeException
107
-     */
108
-    protected function setActivationIndicatorOptionName($activation_indicator_option_name)
109
-    {
110
-        if (! is_string($activation_indicator_option_name)) {
111
-            throw new InvalidDataTypeException(
112
-                '$activation_indicator_option_name',
113
-                $activation_indicator_option_name,
114
-                'string'
115
-            );
116
-        }
117
-        $this->activation_indicator_option_name = $activation_indicator_option_name !== ''
118
-            ? $activation_indicator_option_name
119
-            : ActivationHistory::EE_ACTIVATION_INDICATOR_OPTION_NAME;
120
-    }
121
-
122
-
123
-
124
-    /**
125
-     * @param string $current_version
126
-     * @throws InvalidDataTypeException
127
-     */
128
-    protected function setCurrentVersion($current_version)
129
-    {
130
-        if (! is_string($current_version)) {
131
-            throw new InvalidDataTypeException(
132
-                '$current_version',
133
-                $current_version,
134
-                'string'
135
-            );
136
-        }
137
-        $this->current_version = $current_version !== ''
138
-            ? $current_version
139
-            : espresso_version();
140
-    }
141
-
142
-
143
-
144
-
145
-    /**
146
-     * Gets the wp option which stores the activation history for this addon
147
-     *
148
-     * @return array|bool
149
-     */
150
-    public function getVersionHistory()
151
-    {
152
-        return $this->version_history;
153
-    }
154
-
155
-
156
-
157
-    /**
158
-     * @return string
159
-     */
160
-    public function getCurrentVersion()
161
-    {
162
-        return $this->current_version;
163
-    }
164
-
165
-
166
-
167
-    /**
168
-     * Gets the most recently active version listed in the activation history,
169
-     * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
170
-     *
171
-     * @return string
172
-     */
173
-    public function getMostRecentActiveVersion()
174
-    {
175
-        $most_recently_active_version_activation = '1970-01-01 00:00:00';
176
-        $most_recently_active_version = '0.0.0.dev.000';
177
-        if (is_array($this->version_history) && count($this->version_history)) {
178
-            foreach ($this->version_history as $version => $times_activated) {
179
-                // check there is a record of when this version was activated.
180
-                // Otherwise, mark it as unknown
181
-                if (! $times_activated) {
182
-                    $times_activated = array('unknown-date');
183
-                }
184
-                if (is_string($times_activated)) {
185
-                    $times_activated = array($times_activated);
186
-                }
187
-                foreach ($times_activated as $an_activation) {
188
-                    if (
189
-                        $an_activation !== 'unknown-date'
190
-                        && $an_activation > $most_recently_active_version_activation
191
-                    ) {
192
-                        $most_recently_active_version = $version;
193
-                        $most_recently_active_version_activation = $an_activation === 'unknown-date'
194
-                            ? '1970-01-01 00:00:00'
195
-                            : $an_activation;
196
-                    }
197
-                }
198
-            }
199
-        }
200
-        return $most_recently_active_version;
201
-    }
202
-
203
-
204
-
205
-    /**
206
-     * Updates the version history for this addon
207
-     *
208
-     * @param array|null $version_history
209
-     * @param string     $current_version
210
-     * @param bool       $add_current
211
-     * @return bool success
212
-     */
213
-    public function updateActivationHistory($version_history = null, $current_version = '', $add_current  = true)
214
-    {
215
-        if ($version_history !== null) {
216
-            $this->version_history = $version_history;
217
-        }
218
-        if ($current_version !== '') {
219
-            $this->current_version = $current_version;
220
-        }
221
-        if(! isset($this->version_history[$this->current_version])) {
222
-            $this->version_history[$this->current_version] =   array();
223
-        }
224
-        if($add_current) {
225
-            $this->version_history[$this->current_version][] = date('Y-m-d H:i:s');
226
-        }
227
-        return update_option(
228
-            $this->activation_history_option_name,
229
-            $this->version_history
230
-        );
231
-    }
232
-
233
-
234
-
235
-    /**
236
-     * Updates the version history for this addon
237
-     *
238
-     * @param array|null $version_history
239
-     * @param string     $current_version
240
-     * @return boolean success
241
-     */
242
-    public function addActivationHistory($version_history = null, $current_version = '')
243
-    {
244
-        if ($version_history !== null) {
245
-            $this->version_history = $version_history;
246
-        }
247
-        if ($current_version !== '') {
248
-            $this->current_version = $current_version;
249
-        }
250
-        return add_option(
251
-            $this->activation_history_option_name,
252
-            $this->version_history,
253
-            '',
254
-            'no'
255
-        );
256
-    }
257
-
258
-
259
-
260
-    /**
261
-     * @return bool
262
-     */
263
-    public function getActivationIndicator()
264
-    {
265
-        return get_option($this->activation_indicator_option_name, false);
266
-    }
267
-
268
-
269
-
270
-    /**
271
-     * @return bool
272
-     */
273
-    public function setActivationIndicator()
274
-    {
275
-        return update_option($this->activation_indicator_option_name, true);
276
-    }
277
-
278
-
279
-
280
-    /**
281
-     * @return bool
282
-     */
283
-    public function deleteActivationIndicator()
284
-    {
285
-        return delete_option($this->activation_indicator_option_name);
286
-    }
287
-
288
-
289
-
290
-    /**
291
-     * DANGER!!! HOPE YOU KNOW WHAT YOU ARE DOING !!!
292
-     *
293
-     * @return bool
294
-     */
295
-    public function deleteActivationHistory()
296
-    {
297
-        return delete_option($this->activation_history_option_name);
298
-    }
23
+	/**
24
+	 * option name for recording the activation history for core
25
+	 */
26
+	const EE_ACTIVATION_HISTORY_OPTION_NAME = 'espresso_db_update';
27
+
28
+	/**
29
+	 * option name for indicating that the current request is for activating core
30
+	 */
31
+	const EE_ACTIVATION_INDICATOR_OPTION_NAME = 'ee_espresso_activation';
32
+
33
+	/**
34
+	 * stores the values for the activation history option name for core or an addon
35
+	 *
36
+	 * @var string $activation_history_option_name
37
+	 */
38
+	protected $activation_history_option_name;
39
+
40
+	/**
41
+	 * stores the values for the activation indicator option name for core or an addon
42
+	 *
43
+	 * @var string $activation_indicator_option_name
44
+	 */
45
+	protected $activation_indicator_option_name;
46
+
47
+	/**
48
+	 * the current version for core or an addon, like "1.2.3.p"
49
+	 *
50
+	 * @var string $current_version
51
+	 */
52
+	protected $current_version;
53
+
54
+	/**
55
+	 * array of activated versions and activation dates for core or an addon
56
+	 *
57
+	 * @var array $version_history
58
+	 */
59
+	protected $version_history;
60
+
61
+
62
+
63
+	/**
64
+	 * ActivationHistory constructor.
65
+	 *
66
+	 * @param string $activation_history_option_name
67
+	 * @param string $activation_indicator_option_name
68
+	 * @param string $current_version
69
+	 * @throws InvalidDataTypeException
70
+	 */
71
+	public function __construct(
72
+		$activation_history_option_name = '',
73
+		$activation_indicator_option_name = '',
74
+		$current_version = ''
75
+	) {
76
+		$this->setActivationHistoryOptionName($activation_history_option_name);
77
+		$this->setActivationIndicatorOptionName($activation_indicator_option_name);
78
+		$this->setCurrentVersion($current_version);
79
+		$this->version_history = (array) get_option($this->activation_history_option_name, array());
80
+	}
81
+
82
+
83
+
84
+	/**
85
+	 * @param string $activation_history_option_name
86
+	 * @throws InvalidDataTypeException
87
+	 */
88
+	protected function setActivationHistoryOptionName($activation_history_option_name)
89
+	{
90
+		if(! is_string($activation_history_option_name)) {
91
+			throw new InvalidDataTypeException(
92
+				'$activation_history_option_name',
93
+				$activation_history_option_name,
94
+				'string'
95
+			);
96
+		}
97
+		$this->activation_history_option_name = $activation_history_option_name !== ''
98
+			? $activation_history_option_name
99
+			: ActivationHistory::EE_ACTIVATION_HISTORY_OPTION_NAME;
100
+	}
101
+
102
+
103
+
104
+	/**
105
+	 * @param string $activation_indicator_option_name
106
+	 * @throws InvalidDataTypeException
107
+	 */
108
+	protected function setActivationIndicatorOptionName($activation_indicator_option_name)
109
+	{
110
+		if (! is_string($activation_indicator_option_name)) {
111
+			throw new InvalidDataTypeException(
112
+				'$activation_indicator_option_name',
113
+				$activation_indicator_option_name,
114
+				'string'
115
+			);
116
+		}
117
+		$this->activation_indicator_option_name = $activation_indicator_option_name !== ''
118
+			? $activation_indicator_option_name
119
+			: ActivationHistory::EE_ACTIVATION_INDICATOR_OPTION_NAME;
120
+	}
121
+
122
+
123
+
124
+	/**
125
+	 * @param string $current_version
126
+	 * @throws InvalidDataTypeException
127
+	 */
128
+	protected function setCurrentVersion($current_version)
129
+	{
130
+		if (! is_string($current_version)) {
131
+			throw new InvalidDataTypeException(
132
+				'$current_version',
133
+				$current_version,
134
+				'string'
135
+			);
136
+		}
137
+		$this->current_version = $current_version !== ''
138
+			? $current_version
139
+			: espresso_version();
140
+	}
141
+
142
+
143
+
144
+
145
+	/**
146
+	 * Gets the wp option which stores the activation history for this addon
147
+	 *
148
+	 * @return array|bool
149
+	 */
150
+	public function getVersionHistory()
151
+	{
152
+		return $this->version_history;
153
+	}
154
+
155
+
156
+
157
+	/**
158
+	 * @return string
159
+	 */
160
+	public function getCurrentVersion()
161
+	{
162
+		return $this->current_version;
163
+	}
164
+
165
+
166
+
167
+	/**
168
+	 * Gets the most recently active version listed in the activation history,
169
+	 * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
170
+	 *
171
+	 * @return string
172
+	 */
173
+	public function getMostRecentActiveVersion()
174
+	{
175
+		$most_recently_active_version_activation = '1970-01-01 00:00:00';
176
+		$most_recently_active_version = '0.0.0.dev.000';
177
+		if (is_array($this->version_history) && count($this->version_history)) {
178
+			foreach ($this->version_history as $version => $times_activated) {
179
+				// check there is a record of when this version was activated.
180
+				// Otherwise, mark it as unknown
181
+				if (! $times_activated) {
182
+					$times_activated = array('unknown-date');
183
+				}
184
+				if (is_string($times_activated)) {
185
+					$times_activated = array($times_activated);
186
+				}
187
+				foreach ($times_activated as $an_activation) {
188
+					if (
189
+						$an_activation !== 'unknown-date'
190
+						&& $an_activation > $most_recently_active_version_activation
191
+					) {
192
+						$most_recently_active_version = $version;
193
+						$most_recently_active_version_activation = $an_activation === 'unknown-date'
194
+							? '1970-01-01 00:00:00'
195
+							: $an_activation;
196
+					}
197
+				}
198
+			}
199
+		}
200
+		return $most_recently_active_version;
201
+	}
202
+
203
+
204
+
205
+	/**
206
+	 * Updates the version history for this addon
207
+	 *
208
+	 * @param array|null $version_history
209
+	 * @param string     $current_version
210
+	 * @param bool       $add_current
211
+	 * @return bool success
212
+	 */
213
+	public function updateActivationHistory($version_history = null, $current_version = '', $add_current  = true)
214
+	{
215
+		if ($version_history !== null) {
216
+			$this->version_history = $version_history;
217
+		}
218
+		if ($current_version !== '') {
219
+			$this->current_version = $current_version;
220
+		}
221
+		if(! isset($this->version_history[$this->current_version])) {
222
+			$this->version_history[$this->current_version] =   array();
223
+		}
224
+		if($add_current) {
225
+			$this->version_history[$this->current_version][] = date('Y-m-d H:i:s');
226
+		}
227
+		return update_option(
228
+			$this->activation_history_option_name,
229
+			$this->version_history
230
+		);
231
+	}
232
+
233
+
234
+
235
+	/**
236
+	 * Updates the version history for this addon
237
+	 *
238
+	 * @param array|null $version_history
239
+	 * @param string     $current_version
240
+	 * @return boolean success
241
+	 */
242
+	public function addActivationHistory($version_history = null, $current_version = '')
243
+	{
244
+		if ($version_history !== null) {
245
+			$this->version_history = $version_history;
246
+		}
247
+		if ($current_version !== '') {
248
+			$this->current_version = $current_version;
249
+		}
250
+		return add_option(
251
+			$this->activation_history_option_name,
252
+			$this->version_history,
253
+			'',
254
+			'no'
255
+		);
256
+	}
257
+
258
+
259
+
260
+	/**
261
+	 * @return bool
262
+	 */
263
+	public function getActivationIndicator()
264
+	{
265
+		return get_option($this->activation_indicator_option_name, false);
266
+	}
267
+
268
+
269
+
270
+	/**
271
+	 * @return bool
272
+	 */
273
+	public function setActivationIndicator()
274
+	{
275
+		return update_option($this->activation_indicator_option_name, true);
276
+	}
277
+
278
+
279
+
280
+	/**
281
+	 * @return bool
282
+	 */
283
+	public function deleteActivationIndicator()
284
+	{
285
+		return delete_option($this->activation_indicator_option_name);
286
+	}
287
+
288
+
289
+
290
+	/**
291
+	 * DANGER!!! HOPE YOU KNOW WHAT YOU ARE DOING !!!
292
+	 *
293
+	 * @return bool
294
+	 */
295
+	public function deleteActivationHistory()
296
+	{
297
+		return delete_option($this->activation_history_option_name);
298
+	}
299 299
 
300 300
 
301 301
 
Please login to merge, or discard this patch.
Spacing   +8 added lines, -8 removed lines patch added patch discarded remove patch
@@ -87,7 +87,7 @@  discard block
 block discarded – undo
87 87
      */
88 88
     protected function setActivationHistoryOptionName($activation_history_option_name)
89 89
     {
90
-        if(! is_string($activation_history_option_name)) {
90
+        if ( ! is_string($activation_history_option_name)) {
91 91
             throw new InvalidDataTypeException(
92 92
                 '$activation_history_option_name',
93 93
                 $activation_history_option_name,
@@ -107,7 +107,7 @@  discard block
 block discarded – undo
107 107
      */
108 108
     protected function setActivationIndicatorOptionName($activation_indicator_option_name)
109 109
     {
110
-        if (! is_string($activation_indicator_option_name)) {
110
+        if ( ! is_string($activation_indicator_option_name)) {
111 111
             throw new InvalidDataTypeException(
112 112
                 '$activation_indicator_option_name',
113 113
                 $activation_indicator_option_name,
@@ -127,7 +127,7 @@  discard block
 block discarded – undo
127 127
      */
128 128
     protected function setCurrentVersion($current_version)
129 129
     {
130
-        if (! is_string($current_version)) {
130
+        if ( ! is_string($current_version)) {
131 131
             throw new InvalidDataTypeException(
132 132
                 '$current_version',
133 133
                 $current_version,
@@ -178,7 +178,7 @@  discard block
 block discarded – undo
178 178
             foreach ($this->version_history as $version => $times_activated) {
179 179
                 // check there is a record of when this version was activated.
180 180
                 // Otherwise, mark it as unknown
181
-                if (! $times_activated) {
181
+                if ( ! $times_activated) {
182 182
                     $times_activated = array('unknown-date');
183 183
                 }
184 184
                 if (is_string($times_activated)) {
@@ -210,7 +210,7 @@  discard block
 block discarded – undo
210 210
      * @param bool       $add_current
211 211
      * @return bool success
212 212
      */
213
-    public function updateActivationHistory($version_history = null, $current_version = '', $add_current  = true)
213
+    public function updateActivationHistory($version_history = null, $current_version = '', $add_current = true)
214 214
     {
215 215
         if ($version_history !== null) {
216 216
             $this->version_history = $version_history;
@@ -218,10 +218,10 @@  discard block
 block discarded – undo
218 218
         if ($current_version !== '') {
219 219
             $this->current_version = $current_version;
220 220
         }
221
-        if(! isset($this->version_history[$this->current_version])) {
222
-            $this->version_history[$this->current_version] =   array();
221
+        if ( ! isset($this->version_history[$this->current_version])) {
222
+            $this->version_history[$this->current_version] = array();
223 223
         }
224
-        if($add_current) {
224
+        if ($add_current) {
225 225
             $this->version_history[$this->current_version][] = date('Y-m-d H:i:s');
226 226
         }
227 227
         return update_option(
Please login to merge, or discard this patch.
core/services/activation/InitializeAddon.php 1 patch
Indentation   +138 added lines, -138 removed lines patch added patch discarded remove patch
@@ -24,144 +24,144 @@
 block discarded – undo
24 24
 class InitializeAddon implements InitializeInterface
25 25
 {
26 26
 
27
-    /**
28
-     * @var EE_Addon $addon
29
-     */
30
-    private $addon;
31
-
32
-    /**
33
-     * @var EE_Data_Migration_Manager $data_migration_manager
34
-     */
35
-    private $data_migration_manager;
36
-
37
-    /**
38
-     * @var EE_Maintenance_Mode $maintenance_mode
39
-     */
40
-    private $maintenance_mode;
41
-
42
-    /**
43
-     * @var EE_Registry $registry
44
-     */
45
-    private $registry;
46
-
47
-
48
-
49
-    /**
50
-     * InitializeDatabase constructor.
51
-     *
52
-     * @param EE_Addon $addon
53
-     * @param EE_Data_Migration_Manager $data_migration_manager
54
-     * @param EE_Maintenance_Mode       $maintenance_mode
55
-     * @param EE_Registry $registry
56
-     */
57
-    public function __construct(
58
-        EE_Addon $addon,
59
-        EE_Data_Migration_Manager $data_migration_manager,
60
-        EE_Maintenance_Mode $maintenance_mode,
61
-        EE_Registry $registry
62
-    ) {
63
-        $this->addon = $addon;
64
-        $this->data_migration_manager = $data_migration_manager;
65
-        $this->maintenance_mode = $maintenance_mode;
66
-        $this->registry = $registry;
67
-    }
68
-
69
-
70
-    /**
71
-     * Takes care of double-checking that we're not in maintenance mode, and then
72
-     * initializing this addon's necessary initial data. This is called by default on new activations
73
-     * and reactivations
74
-     *
75
-     * @param boolean $verify_schema whether to verify the database's schema for this addon, or just its data.
76
-     *                               This is a resource-intensive job so we prefer to only do it when necessary
77
-     * @return void
78
-     * @throws ReflectionException
79
-     * @throws EE_Error
80
-     */
81
-    public function initialize($verify_schema = true)
82
-    {
83
-        if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
84
-            if ($verify_schema) {
85
-                $this->initializeDatabase();
86
-            }
87
-            $this->initializeDefaultData();
88
-            //@todo: this will probably need to be adjusted in 4.4 as the array changed formats I believe
89
-            $this->data_migration_manager->update_current_database_state_to(
90
-                array(
91
-                    'slug'    => $this->addon->name(),
92
-                    'version' => $this->addon->version()
93
-                )
94
-            );
95
-            //in case there are lots of addons being activated at once, let's force garbage collection
96
-            //to help avoid memory limit errors
97
-            //EEH_Debug_Tools::instance()->measure_memory( 'db content initialized for ' . get_class( $this), true );
98
-            gc_collect_cycles();
99
-        } else {
100
-            //ask the data migration manager to init this addon's data
101
-            //when migrations are finished because we can't do it now
102
-            $this->data_migration_manager->enqueue_db_initialization_for($this->addon->name());
103
-        }
104
-    }
105
-
106
-
107
-    /**
108
-     * Used to setup this addon's database tables, but not necessarily any default
109
-     * data in them. The default is to actually use the most up-to-date data migration script
110
-     * for this addon, and just use its schema_changes_before_migration() and schema_changes_after_migration()
111
-     * methods to setup the db.
112
-     *
113
-     * @throws ReflectionException
114
-     * @throws EE_Error
115
-     */
116
-    public function initializeDatabase()
117
-    {
118
-        //find the migration script that sets the database to be compatible with the code
119
-        $current_dms_name = $this->data_migration_manager->get_most_up_to_date_dms($this->addon->name());
120
-        if ($current_dms_name) {
121
-            $current_data_migration_script = $this->registry->load_dms($current_dms_name);
122
-            $current_data_migration_script->set_migrating(false);
123
-            $current_data_migration_script->schema_changes_before_migration();
124
-            $current_data_migration_script->schema_changes_after_migration();
125
-            if ($current_data_migration_script->get_errors()) {
126
-                foreach ($current_data_migration_script->get_errors() as $error) {
127
-                    EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
128
-                }
129
-            }
130
-        }
131
-        //if not DMS was found that should be ok. This addon just doesn't require any database changes
132
-        $this->data_migration_manager->update_current_database_state_to(
133
-            array(
134
-                'slug'    => $this->addon->name(),
135
-                'version' => $this->addon->version()
136
-            )
137
-        );
138
-    }
139
-
140
-
141
-
142
-    /**
143
-     * If you want to setup default data for the addon, override this method, and call
144
-     * parent::initialize_default_data() from within it. This is normally called
145
-     * from EE_Addon::initialize_db_if_no_migrations_required(), just after EE_Addon::initialize_db()
146
-     * and should verify default data is present (but this is also called
147
-     * on reactivations and just after migrations, so please verify you actually want
148
-     * to ADD default data, because it may already be present).
149
-     * However, please call this parent (currently it just fires a hook which other
150
-     * addons may be depending on)
151
-     */
152
-    public function initializeDefaultData()
153
-    {
154
-        /**
155
-         * Called when an addon is ensuring its default data is set (possibly called
156
-         * on a reactivation, so first check for the absence of other data before setting
157
-         * default data)
158
-         *
159
-         * @param EE_Addon $addon the addon that called this
160
-         */
161
-        do_action('AHEE__EE_Addon__initialize_default_data__begin', $this);
162
-        //override to insert default data. It is safe to use the models here
163
-        //because the site should not be in maintenance mode
164
-    }
27
+	/**
28
+	 * @var EE_Addon $addon
29
+	 */
30
+	private $addon;
31
+
32
+	/**
33
+	 * @var EE_Data_Migration_Manager $data_migration_manager
34
+	 */
35
+	private $data_migration_manager;
36
+
37
+	/**
38
+	 * @var EE_Maintenance_Mode $maintenance_mode
39
+	 */
40
+	private $maintenance_mode;
41
+
42
+	/**
43
+	 * @var EE_Registry $registry
44
+	 */
45
+	private $registry;
46
+
47
+
48
+
49
+	/**
50
+	 * InitializeDatabase constructor.
51
+	 *
52
+	 * @param EE_Addon $addon
53
+	 * @param EE_Data_Migration_Manager $data_migration_manager
54
+	 * @param EE_Maintenance_Mode       $maintenance_mode
55
+	 * @param EE_Registry $registry
56
+	 */
57
+	public function __construct(
58
+		EE_Addon $addon,
59
+		EE_Data_Migration_Manager $data_migration_manager,
60
+		EE_Maintenance_Mode $maintenance_mode,
61
+		EE_Registry $registry
62
+	) {
63
+		$this->addon = $addon;
64
+		$this->data_migration_manager = $data_migration_manager;
65
+		$this->maintenance_mode = $maintenance_mode;
66
+		$this->registry = $registry;
67
+	}
68
+
69
+
70
+	/**
71
+	 * Takes care of double-checking that we're not in maintenance mode, and then
72
+	 * initializing this addon's necessary initial data. This is called by default on new activations
73
+	 * and reactivations
74
+	 *
75
+	 * @param boolean $verify_schema whether to verify the database's schema for this addon, or just its data.
76
+	 *                               This is a resource-intensive job so we prefer to only do it when necessary
77
+	 * @return void
78
+	 * @throws ReflectionException
79
+	 * @throws EE_Error
80
+	 */
81
+	public function initialize($verify_schema = true)
82
+	{
83
+		if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
84
+			if ($verify_schema) {
85
+				$this->initializeDatabase();
86
+			}
87
+			$this->initializeDefaultData();
88
+			//@todo: this will probably need to be adjusted in 4.4 as the array changed formats I believe
89
+			$this->data_migration_manager->update_current_database_state_to(
90
+				array(
91
+					'slug'    => $this->addon->name(),
92
+					'version' => $this->addon->version()
93
+				)
94
+			);
95
+			//in case there are lots of addons being activated at once, let's force garbage collection
96
+			//to help avoid memory limit errors
97
+			//EEH_Debug_Tools::instance()->measure_memory( 'db content initialized for ' . get_class( $this), true );
98
+			gc_collect_cycles();
99
+		} else {
100
+			//ask the data migration manager to init this addon's data
101
+			//when migrations are finished because we can't do it now
102
+			$this->data_migration_manager->enqueue_db_initialization_for($this->addon->name());
103
+		}
104
+	}
105
+
106
+
107
+	/**
108
+	 * Used to setup this addon's database tables, but not necessarily any default
109
+	 * data in them. The default is to actually use the most up-to-date data migration script
110
+	 * for this addon, and just use its schema_changes_before_migration() and schema_changes_after_migration()
111
+	 * methods to setup the db.
112
+	 *
113
+	 * @throws ReflectionException
114
+	 * @throws EE_Error
115
+	 */
116
+	public function initializeDatabase()
117
+	{
118
+		//find the migration script that sets the database to be compatible with the code
119
+		$current_dms_name = $this->data_migration_manager->get_most_up_to_date_dms($this->addon->name());
120
+		if ($current_dms_name) {
121
+			$current_data_migration_script = $this->registry->load_dms($current_dms_name);
122
+			$current_data_migration_script->set_migrating(false);
123
+			$current_data_migration_script->schema_changes_before_migration();
124
+			$current_data_migration_script->schema_changes_after_migration();
125
+			if ($current_data_migration_script->get_errors()) {
126
+				foreach ($current_data_migration_script->get_errors() as $error) {
127
+					EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
128
+				}
129
+			}
130
+		}
131
+		//if not DMS was found that should be ok. This addon just doesn't require any database changes
132
+		$this->data_migration_manager->update_current_database_state_to(
133
+			array(
134
+				'slug'    => $this->addon->name(),
135
+				'version' => $this->addon->version()
136
+			)
137
+		);
138
+	}
139
+
140
+
141
+
142
+	/**
143
+	 * If you want to setup default data for the addon, override this method, and call
144
+	 * parent::initialize_default_data() from within it. This is normally called
145
+	 * from EE_Addon::initialize_db_if_no_migrations_required(), just after EE_Addon::initialize_db()
146
+	 * and should verify default data is present (but this is also called
147
+	 * on reactivations and just after migrations, so please verify you actually want
148
+	 * to ADD default data, because it may already be present).
149
+	 * However, please call this parent (currently it just fires a hook which other
150
+	 * addons may be depending on)
151
+	 */
152
+	public function initializeDefaultData()
153
+	{
154
+		/**
155
+		 * Called when an addon is ensuring its default data is set (possibly called
156
+		 * on a reactivation, so first check for the absence of other data before setting
157
+		 * default data)
158
+		 *
159
+		 * @param EE_Addon $addon the addon that called this
160
+		 */
161
+		do_action('AHEE__EE_Addon__initialize_default_data__begin', $this);
162
+		//override to insert default data. It is safe to use the models here
163
+		//because the site should not be in maintenance mode
164
+	}
165 165
 
166 166
 
167 167
 
Please login to merge, or discard this patch.
core/services/activation/InitializeCore.php 1 patch
Indentation   +117 added lines, -117 removed lines patch added patch discarded remove patch
@@ -24,121 +24,121 @@
 block discarded – undo
24 24
 class InitializeCore implements InitializeInterface
25 25
 {
26 26
 
27
-    /**
28
-     * @var EE_Capabilities $capabilities
29
-     */
30
-    private $capabilities;
31
-
32
-    /**
33
-     * @var EE_Data_Migration_Manager $data_migration_manager
34
-     */
35
-    private $data_migration_manager;
36
-
37
-    /**
38
-     * @var EE_Maintenance_Mode $maintenance_mode
39
-     */
40
-    private $maintenance_mode;
41
-
42
-    /**
43
-     * @var RequestInterface $request
44
-     */
45
-    private $request;
46
-
47
-    /**
48
-     * @var ActivationType $activation_type
49
-     */
50
-    private $activation_type;
51
-
52
-
53
-    /**
54
-     * InitializeDatabase constructor.
55
-     *
56
-     * @param ActivationType            $activation_type
57
-     * @param EE_Capabilities           $capabilities
58
-     * @param EE_Data_Migration_Manager $data_migration_manager
59
-     * @param EE_Maintenance_Mode       $maintenance_mode
60
-     * @param RequestInterface          $request
61
-     */
62
-    public function __construct(
63
-        ActivationType $activation_type,
64
-        EE_Capabilities $capabilities,
65
-        EE_Data_Migration_Manager $data_migration_manager,
66
-        EE_Maintenance_Mode $maintenance_mode,
67
-        RequestInterface $request
68
-    ) {
69
-        $this->activation_type        = $activation_type;
70
-        $this->capabilities           = $capabilities;
71
-        $this->data_migration_manager = $data_migration_manager;
72
-        $this->maintenance_mode       = $maintenance_mode;
73
-        $this->request = $request;
74
-    }
75
-
76
-
77
-
78
-
79
-    /**
80
-     * @param bool $verify_schema
81
-     * @return void
82
-     * @throws \EE_Error
83
-     */
84
-    public function initialize($verify_schema = true)
85
-    {
86
-        $activation_type = $this->activation_type->getActivationType();
87
-        //only initialize system if we're not in maintenance mode.
88
-        if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
89
-            update_option('ee_flush_rewrite_rules', true);
90
-            if ($verify_schema) {
91
-                // first check if we had previously attempted to setup EE's directories but failed
92
-                if (EEH_Activation::upload_directories_incomplete()) {
93
-                    EEH_Activation::create_upload_directories();
94
-                }
95
-                EEH_Activation::initialize_db_and_folders();
96
-            }
97
-            EEH_Activation::initialize_db_content();
98
-            EEH_Activation::system_initialization();
99
-        } else {
100
-            $this->data_migration_manager->enqueue_db_initialization_for('Core');
101
-        }
102
-        if ($activation_type === ActivationType::NEW_ACTIVATION
103
-            || $activation_type === ActivationType::REACTIVATION
104
-            || (
105
-                $activation_type === ActivationType::UPGRADE
106
-                && $this->activation_type->isMajorVersionChange()
107
-            )
108
-        ) {
109
-            add_action('init', array($this, 'redirectToAboutPage'), 1);
110
-        }
111
-    }
112
-
113
-
114
-
115
-
116
-    /**
117
-     * This redirects to the about EE page after activation
118
-     *
119
-     * @return void
120
-     */
121
-    public function redirectToAboutPage()
122
-    {
123
-        //if current user is an admin and it's not an ajax or rest request
124
-        if (
125
-            $this->request->isAdmin()
126
-            && EE_Error::has_notices() !== 1
127
-            && apply_filters(
128
-                'FHEE__EE_System__redirect_to_about_ee__do_redirect',
129
-                $this->capabilities->current_user_can('manage_options', 'espresso_about_default')
130
-            )
131
-        ) {
132
-            $query_params = array('page' => 'espresso_about');
133
-            $activation_type = $this->activation_type->getActivationType();
134
-            if ($activation_type === ActivationType::NEW_ACTIVATION) {
135
-                $query_params['new_activation'] = true;
136
-            } else if ($activation_type === ActivationType::REACTIVATION) {
137
-                $query_params['reactivation'] = true;
138
-            }
139
-            wp_safe_redirect(
140
-                add_query_arg($query_params, admin_url('admin.php'))
141
-            );
142
-        }
143
-    }
27
+	/**
28
+	 * @var EE_Capabilities $capabilities
29
+	 */
30
+	private $capabilities;
31
+
32
+	/**
33
+	 * @var EE_Data_Migration_Manager $data_migration_manager
34
+	 */
35
+	private $data_migration_manager;
36
+
37
+	/**
38
+	 * @var EE_Maintenance_Mode $maintenance_mode
39
+	 */
40
+	private $maintenance_mode;
41
+
42
+	/**
43
+	 * @var RequestInterface $request
44
+	 */
45
+	private $request;
46
+
47
+	/**
48
+	 * @var ActivationType $activation_type
49
+	 */
50
+	private $activation_type;
51
+
52
+
53
+	/**
54
+	 * InitializeDatabase constructor.
55
+	 *
56
+	 * @param ActivationType            $activation_type
57
+	 * @param EE_Capabilities           $capabilities
58
+	 * @param EE_Data_Migration_Manager $data_migration_manager
59
+	 * @param EE_Maintenance_Mode       $maintenance_mode
60
+	 * @param RequestInterface          $request
61
+	 */
62
+	public function __construct(
63
+		ActivationType $activation_type,
64
+		EE_Capabilities $capabilities,
65
+		EE_Data_Migration_Manager $data_migration_manager,
66
+		EE_Maintenance_Mode $maintenance_mode,
67
+		RequestInterface $request
68
+	) {
69
+		$this->activation_type        = $activation_type;
70
+		$this->capabilities           = $capabilities;
71
+		$this->data_migration_manager = $data_migration_manager;
72
+		$this->maintenance_mode       = $maintenance_mode;
73
+		$this->request = $request;
74
+	}
75
+
76
+
77
+
78
+
79
+	/**
80
+	 * @param bool $verify_schema
81
+	 * @return void
82
+	 * @throws \EE_Error
83
+	 */
84
+	public function initialize($verify_schema = true)
85
+	{
86
+		$activation_type = $this->activation_type->getActivationType();
87
+		//only initialize system if we're not in maintenance mode.
88
+		if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
89
+			update_option('ee_flush_rewrite_rules', true);
90
+			if ($verify_schema) {
91
+				// first check if we had previously attempted to setup EE's directories but failed
92
+				if (EEH_Activation::upload_directories_incomplete()) {
93
+					EEH_Activation::create_upload_directories();
94
+				}
95
+				EEH_Activation::initialize_db_and_folders();
96
+			}
97
+			EEH_Activation::initialize_db_content();
98
+			EEH_Activation::system_initialization();
99
+		} else {
100
+			$this->data_migration_manager->enqueue_db_initialization_for('Core');
101
+		}
102
+		if ($activation_type === ActivationType::NEW_ACTIVATION
103
+			|| $activation_type === ActivationType::REACTIVATION
104
+			|| (
105
+				$activation_type === ActivationType::UPGRADE
106
+				&& $this->activation_type->isMajorVersionChange()
107
+			)
108
+		) {
109
+			add_action('init', array($this, 'redirectToAboutPage'), 1);
110
+		}
111
+	}
112
+
113
+
114
+
115
+
116
+	/**
117
+	 * This redirects to the about EE page after activation
118
+	 *
119
+	 * @return void
120
+	 */
121
+	public function redirectToAboutPage()
122
+	{
123
+		//if current user is an admin and it's not an ajax or rest request
124
+		if (
125
+			$this->request->isAdmin()
126
+			&& EE_Error::has_notices() !== 1
127
+			&& apply_filters(
128
+				'FHEE__EE_System__redirect_to_about_ee__do_redirect',
129
+				$this->capabilities->current_user_can('manage_options', 'espresso_about_default')
130
+			)
131
+		) {
132
+			$query_params = array('page' => 'espresso_about');
133
+			$activation_type = $this->activation_type->getActivationType();
134
+			if ($activation_type === ActivationType::NEW_ACTIVATION) {
135
+				$query_params['new_activation'] = true;
136
+			} else if ($activation_type === ActivationType::REACTIVATION) {
137
+				$query_params['reactivation'] = true;
138
+			}
139
+			wp_safe_redirect(
140
+				add_query_arg($query_params, admin_url('admin.php'))
141
+			);
142
+		}
143
+	}
144 144
 }
Please login to merge, or discard this patch.
core/services/bootstrap/BootstrapDependencyInjectionContainer.php 2 patches
Spacing   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -78,13 +78,13 @@
 block discarded – undo
78 78
         // EE_Dependency_Map: info about how to load classes required by other classes
79 79
         espresso_load_required(
80 80
             'EE_Dependency_Map',
81
-            EE_CORE . 'EE_Dependency_Map.core.php'
81
+            EE_CORE.'EE_Dependency_Map.core.php'
82 82
         );
83 83
         $this->dependency_map = EE_Dependency_Map::instance($this->class_cache);
84 84
         // EE_Registry: central repository for classes (legacy)
85 85
         espresso_load_required(
86 86
             'EE_Registry',
87
-            EE_CORE . 'EE_Registry.core.php'
87
+            EE_CORE.'EE_Registry.core.php'
88 88
         );
89 89
         $this->registry = EE_Registry::instance(
90 90
             $this->dependency_map,
Please login to merge, or discard this patch.
Indentation   +119 added lines, -119 removed lines patch added patch discarded remove patch
@@ -25,123 +25,123 @@
 block discarded – undo
25 25
 class BootstrapDependencyInjectionContainer
26 26
 {
27 27
 
28
-    /**
29
-     * @var EE_Dependency_Map $dependency_map
30
-     */
31
-    protected $dependency_map;
32
-
33
-    /**
34
-     * @type LoaderInterface $loader
35
-     */
36
-    protected $loader;
37
-
38
-    /**
39
-     * @var EE_Registry $registry
40
-     */
41
-    protected $registry;
42
-
43
-    /**
44
-     * @var ClassInterfaceCache $class_cache
45
-     */
46
-    private $class_cache;
47
-
48
-    /**
49
-     * @var Mirror
50
-     */
51
-    private $mirror;
52
-
53
-    /**
54
-     * @var ObjectIdentifier
55
-     */
56
-    private $object_identifier;
57
-
58
-
59
-    /**
60
-     * Can't use this just yet until we exorcise some more of our singleton usage from core
61
-     */
62
-    public function buildDependencyInjectionContainer()
63
-    {
64
-        // build DI container
65
-        // $OpenCoffeeShop = new EventEspresso\core\services\container\OpenCoffeeShop();
66
-        // $OpenCoffeeShop->addRecipes();
67
-        // $CoffeeShop = $OpenCoffeeShop->CoffeeShop();
68
-    }
69
-
70
-
71
-    /**
72
-     * Setups  EE_Registry and EE_Dependency_Map
73
-     *
74
-     * @throws EE_Error
75
-     */
76
-    public function buildLegacyDependencyInjectionContainer()
77
-    {
78
-        $this->class_cache = new ClassInterfaceCache();
79
-        $this->object_identifier = new ObjectIdentifier($this->class_cache);
80
-        $this->mirror = new Mirror();
81
-        // EE_Dependency_Map: info about how to load classes required by other classes
82
-        espresso_load_required(
83
-            'EE_Dependency_Map',
84
-            EE_CORE . 'EE_Dependency_Map.core.php'
85
-        );
86
-        $this->dependency_map = EE_Dependency_Map::instance($this->class_cache);
87
-        // EE_Registry: central repository for classes (legacy)
88
-        espresso_load_required(
89
-            'EE_Registry',
90
-            EE_CORE . 'EE_Registry.core.php'
91
-        );
92
-        $this->registry = EE_Registry::instance(
93
-            $this->dependency_map,
94
-            $this->mirror,
95
-            $this->class_cache,
96
-            $this->object_identifier
97
-        );
98
-    }
99
-
100
-
101
-    /**
102
-     * Performs initial setup for the generic Loader
103
-     *
104
-     * @throws InvalidDataTypeException
105
-     * @throws InvalidInterfaceException
106
-     * @throws InvalidArgumentException
107
-     */
108
-    public function buildLoader()
109
-    {
110
-        $this->loader = LoaderFactory::getLoader(
111
-            $this->registry,
112
-            $this->class_cache,
113
-            $this->object_identifier
114
-        );
115
-        $this->loader->share('EventEspresso\core\services\loaders\ClassInterfaceCache', $this->class_cache);
116
-        $this->loader->share('EventEspresso\core\services\loaders\ObjectIdentifier', $this->object_identifier);
117
-        $this->loader->share('EventEspresso\core\services\container\Mirror', $this->mirror);
118
-        $this->dependency_map->setLoader($this->loader);
119
-    }
120
-
121
-
122
-    /**
123
-     * @return EE_Dependency_Map
124
-     */
125
-    public function getDependencyMap()
126
-    {
127
-        return $this->dependency_map;
128
-    }
129
-
130
-
131
-    /**
132
-     * @return EE_Registry
133
-     */
134
-    public function getRegistry()
135
-    {
136
-        return $this->registry;
137
-    }
138
-
139
-
140
-    /**
141
-     * @return LoaderInterface
142
-     */
143
-    public function getLoader()
144
-    {
145
-        return $this->loader;
146
-    }
28
+	/**
29
+	 * @var EE_Dependency_Map $dependency_map
30
+	 */
31
+	protected $dependency_map;
32
+
33
+	/**
34
+	 * @type LoaderInterface $loader
35
+	 */
36
+	protected $loader;
37
+
38
+	/**
39
+	 * @var EE_Registry $registry
40
+	 */
41
+	protected $registry;
42
+
43
+	/**
44
+	 * @var ClassInterfaceCache $class_cache
45
+	 */
46
+	private $class_cache;
47
+
48
+	/**
49
+	 * @var Mirror
50
+	 */
51
+	private $mirror;
52
+
53
+	/**
54
+	 * @var ObjectIdentifier
55
+	 */
56
+	private $object_identifier;
57
+
58
+
59
+	/**
60
+	 * Can't use this just yet until we exorcise some more of our singleton usage from core
61
+	 */
62
+	public function buildDependencyInjectionContainer()
63
+	{
64
+		// build DI container
65
+		// $OpenCoffeeShop = new EventEspresso\core\services\container\OpenCoffeeShop();
66
+		// $OpenCoffeeShop->addRecipes();
67
+		// $CoffeeShop = $OpenCoffeeShop->CoffeeShop();
68
+	}
69
+
70
+
71
+	/**
72
+	 * Setups  EE_Registry and EE_Dependency_Map
73
+	 *
74
+	 * @throws EE_Error
75
+	 */
76
+	public function buildLegacyDependencyInjectionContainer()
77
+	{
78
+		$this->class_cache = new ClassInterfaceCache();
79
+		$this->object_identifier = new ObjectIdentifier($this->class_cache);
80
+		$this->mirror = new Mirror();
81
+		// EE_Dependency_Map: info about how to load classes required by other classes
82
+		espresso_load_required(
83
+			'EE_Dependency_Map',
84
+			EE_CORE . 'EE_Dependency_Map.core.php'
85
+		);
86
+		$this->dependency_map = EE_Dependency_Map::instance($this->class_cache);
87
+		// EE_Registry: central repository for classes (legacy)
88
+		espresso_load_required(
89
+			'EE_Registry',
90
+			EE_CORE . 'EE_Registry.core.php'
91
+		);
92
+		$this->registry = EE_Registry::instance(
93
+			$this->dependency_map,
94
+			$this->mirror,
95
+			$this->class_cache,
96
+			$this->object_identifier
97
+		);
98
+	}
99
+
100
+
101
+	/**
102
+	 * Performs initial setup for the generic Loader
103
+	 *
104
+	 * @throws InvalidDataTypeException
105
+	 * @throws InvalidInterfaceException
106
+	 * @throws InvalidArgumentException
107
+	 */
108
+	public function buildLoader()
109
+	{
110
+		$this->loader = LoaderFactory::getLoader(
111
+			$this->registry,
112
+			$this->class_cache,
113
+			$this->object_identifier
114
+		);
115
+		$this->loader->share('EventEspresso\core\services\loaders\ClassInterfaceCache', $this->class_cache);
116
+		$this->loader->share('EventEspresso\core\services\loaders\ObjectIdentifier', $this->object_identifier);
117
+		$this->loader->share('EventEspresso\core\services\container\Mirror', $this->mirror);
118
+		$this->dependency_map->setLoader($this->loader);
119
+	}
120
+
121
+
122
+	/**
123
+	 * @return EE_Dependency_Map
124
+	 */
125
+	public function getDependencyMap()
126
+	{
127
+		return $this->dependency_map;
128
+	}
129
+
130
+
131
+	/**
132
+	 * @return EE_Registry
133
+	 */
134
+	public function getRegistry()
135
+	{
136
+		return $this->registry;
137
+	}
138
+
139
+
140
+	/**
141
+	 * @return LoaderInterface
142
+	 */
143
+	public function getLoader()
144
+	{
145
+		return $this->loader;
146
+	}
147 147
 }
Please login to merge, or discard this patch.
core/domain/services/custom_post_types/RegisterCustomTaxonomyTerms.php 2 patches
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -65,7 +65,7 @@
 block discarded – undo
65 65
      */
66 66
     public function registerCustomTaxonomyTerm($taxonomy, $term_slug, array $cpt_slugs = array())
67 67
     {
68
-        $this->custom_taxonomy_terms[][ $term_slug ] = new CustomTaxonomyTerm(
68
+        $this->custom_taxonomy_terms[][$term_slug] = new CustomTaxonomyTerm(
69 69
             $taxonomy,
70 70
             $term_slug,
71 71
             $cpt_slugs
Please login to merge, or discard this patch.
Indentation   +176 added lines, -176 removed lines patch added patch discarded remove patch
@@ -16,180 +16,180 @@
 block discarded – undo
16 16
 class RegisterCustomTaxonomyTerms
17 17
 {
18 18
 
19
-    /**
20
-     * @var array[] $custom_taxonomy_terms
21
-     */
22
-    public $custom_taxonomy_terms = array();
23
-
24
-
25
-    /**
26
-     * RegisterCustomTaxonomyTerms constructor.
27
-     */
28
-    public function __construct()
29
-    {
30
-        // hook into save_post so that we can make sure that the default terms get saved on publish of registered cpts
31
-        // IF they don't have a term for that taxonomy set.
32
-        add_action('save_post', array($this, 'saveDefaultTerm'), 100, 2);
33
-        do_action(
34
-            'AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end',
35
-            $this
36
-        );
37
-    }
38
-
39
-
40
-    public function registerCustomTaxonomyTerms()
41
-    {
42
-        // setup default terms in any of our taxonomies (but only if we're in admin).
43
-        // Why not added via register_activation_hook?
44
-        // Because it's possible that in future iterations of EE we may add new defaults for specialized taxonomies
45
-        // (think event_types) and register_activation_hook only reliably runs when a user manually activates the plugin.
46
-        // Keep in mind that this will READ these terms if they are deleted by the user.  Hence MUST use terms.
47
-        // if ( is_admin() ) {
48
-        // $this->set_must_use_event_types();
49
-        // }
50
-        // set default terms
51
-        $this->registerCustomTaxonomyTerm(
52
-            'espresso_event_type',
53
-            'single-event',
54
-            array('espresso_events')
55
-        );
56
-    }
57
-
58
-
59
-    /**
60
-     * Allows us to set what the default will be for terms when a cpt is PUBLISHED.
61
-     *
62
-     * @param string $taxonomy  The taxonomy we're using for the default term
63
-     * @param string $term_slug The slug of the term that will be the default.
64
-     * @param array  $cpt_slugs An array of custom post types we want the default assigned to
65
-     */
66
-    public function registerCustomTaxonomyTerm($taxonomy, $term_slug, array $cpt_slugs = array())
67
-    {
68
-        $this->custom_taxonomy_terms[][ $term_slug ] = new CustomTaxonomyTerm(
69
-            $taxonomy,
70
-            $term_slug,
71
-            $cpt_slugs
72
-        );
73
-    }
74
-
75
-
76
-    /**
77
-     * hooked into the wp 'save_post' action hook for setting our default terms found in the $_default_terms property
78
-     *
79
-     * @param  int     $post_id ID of CPT being saved
80
-     * @param  WP_Post $post    Post object
81
-     * @return void
82
-     */
83
-    public function saveDefaultTerm($post_id, WP_Post $post)
84
-    {
85
-        if (empty($this->custom_taxonomy_terms)) {
86
-            return;
87
-        }
88
-        // no default terms set so lets just exit.
89
-        foreach ($this->custom_taxonomy_terms as $custom_taxonomy_terms) {
90
-            foreach ($custom_taxonomy_terms as $custom_taxonomy_term) {
91
-                if ($post->post_status === 'publish'
92
-                    && $custom_taxonomy_term instanceof CustomTaxonomyTerm
93
-                    && in_array($post->post_type, $custom_taxonomy_term->customPostTypeSlugs(), true)
94
-                ) {
95
-                    // note some error proofing going on here to save unnecessary db queries
96
-                    $taxonomies = get_object_taxonomies($post->post_type);
97
-                    foreach ($taxonomies as $taxonomy) {
98
-                        $terms = wp_get_post_terms($post_id, $taxonomy);
99
-                        if (empty($terms) && $taxonomy === $custom_taxonomy_term->taxonomySlug()) {
100
-                            wp_set_object_terms(
101
-                                $post_id,
102
-                                array($custom_taxonomy_term->termSlug()),
103
-                                $taxonomy
104
-                            );
105
-                        }
106
-                    }
107
-                }
108
-            }
109
-        }
110
-    }
111
-
112
-
113
-    /**
114
-     * @return void
115
-     */
116
-    public function setMustUseEventTypes()
117
-    {
118
-        $term_details = array(
119
-            // Attendee's register for the first date-time only
120
-            'single-event'    => array(
121
-                'term' => esc_html__('Single Event', 'event_espresso'),
122
-                'desc' => esc_html__(
123
-                    'A single event that spans one or more consecutive days.',
124
-                    'event_espresso'
125
-                ),
126
-            ),
127
-            // example: a party or two-day long workshop
128
-            // Attendee's can register for any of the date-times
129
-            'multi-event'     => array(
130
-                'term' => esc_html__('Multi Event', 'event_espresso'),
131
-                'desc' => esc_html__(
132
-                    'Multiple, separate, but related events that occur on consecutive days.',
133
-                    'event_espresso'
134
-                ),
135
-            ),
136
-            // example: a three day music festival or week long conference
137
-            // Attendee's register for the first date-time only
138
-            'event-series'    => array(
139
-                'term' => esc_html__('Event Series', 'event_espresso'),
140
-                'desc' => esc_html__(
141
-                    ' Multiple events that occur over multiple non-consecutive days.',
142
-                    'event_espresso'
143
-                ),
144
-            ),
145
-            // example: an 8 week introduction to basket weaving course
146
-            // Attendee's can register for any of the date-times.
147
-            'recurring-event' => array(
148
-                'term' => esc_html__('Recurring Event', 'event_espresso'),
149
-                'desc' => esc_html__(
150
-                    'Multiple events that occur over multiple non-consecutive days.',
151
-                    'event_espresso'
152
-                ),
153
-            ),
154
-            // example: a yoga class
155
-            'ongoing'         => array(
156
-                'term' => esc_html__('Ongoing Event', 'event_espresso'),
157
-                'desc' => esc_html__(
158
-                    'An "event" that people can purchase tickets to gain access for anytime for this event regardless of date times on the event',
159
-                    'event_espresso'
160
-                ),
161
-            )
162
-            // example: access to a museum
163
-            // 'walk-in' => array( esc_html__('Walk In', 'event_espresso'), esc_html__('Single datetime and single entry recurring events. Attendees register for one or multiple datetimes individually.', 'event_espresso') ),
164
-            // 'reservation' => array( esc_html__('Reservation', 'event_espresso'), esc_html__('Reservations are created by specifying available datetimes and quantities. Attendees choose from the available datetimes and specify the quantity available (if the maximum is greater than 1)') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1
165
-            // 'multiple-session' => array( esc_html__('Multiple Session', 'event_espresso'), esc_html__('Multiple event, multiple datetime, hierarchically organized, custom entry events. Attendees may be required to register for a parent event before being allowed to register for child events. Attendees can register for any combination of child events as long as the datetimes do not conflict. Parent and child events may have additional fees or registration questions.') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1
166
-            // 'appointment' => array( esc_html__('Appointments', 'event_espresso'), esc_html__('Time slotted events where datetimes are generally in hours or minutes. For example, attendees can register for a single 15 minute or 1 hour time slot and this type of availability frequently reoccurs.', 'event_espresso') )
167
-        );
168
-        $this->setMustUseTerms('espresso_event_type', $term_details);
169
-    }
170
-
171
-
172
-    /**
173
-     * wrapper method for handling the setting up of initial terms in the db (if they don't already exist).
174
-     * Note this should ONLY be used for terms that always must be present.  Be aware that if an initial term is
175
-     * deleted then it WILL be recreated.
176
-     *
177
-     * @param string $taxonomy     The name of the taxonomy
178
-     * @param array  $term_details An array of term details indexed by slug and containing Name of term, and
179
-     *                             description as the elements in the array
180
-     * @return void
181
-     */
182
-    public function setMustUseTerms($taxonomy, $term_details)
183
-    {
184
-        $term_details = (array) $term_details;
185
-        foreach ($term_details as $slug => $details) {
186
-            if (isset($details['term'], $details['desc']) && ! term_exists($slug, $taxonomy)) {
187
-                $insert_arr = array(
188
-                    'slug'        => $slug,
189
-                    'description' => $details['desc'],
190
-                );
191
-                wp_insert_term($details['term'], $taxonomy, $insert_arr);
192
-            }
193
-        }
194
-    }
19
+	/**
20
+	 * @var array[] $custom_taxonomy_terms
21
+	 */
22
+	public $custom_taxonomy_terms = array();
23
+
24
+
25
+	/**
26
+	 * RegisterCustomTaxonomyTerms constructor.
27
+	 */
28
+	public function __construct()
29
+	{
30
+		// hook into save_post so that we can make sure that the default terms get saved on publish of registered cpts
31
+		// IF they don't have a term for that taxonomy set.
32
+		add_action('save_post', array($this, 'saveDefaultTerm'), 100, 2);
33
+		do_action(
34
+			'AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end',
35
+			$this
36
+		);
37
+	}
38
+
39
+
40
+	public function registerCustomTaxonomyTerms()
41
+	{
42
+		// setup default terms in any of our taxonomies (but only if we're in admin).
43
+		// Why not added via register_activation_hook?
44
+		// Because it's possible that in future iterations of EE we may add new defaults for specialized taxonomies
45
+		// (think event_types) and register_activation_hook only reliably runs when a user manually activates the plugin.
46
+		// Keep in mind that this will READ these terms if they are deleted by the user.  Hence MUST use terms.
47
+		// if ( is_admin() ) {
48
+		// $this->set_must_use_event_types();
49
+		// }
50
+		// set default terms
51
+		$this->registerCustomTaxonomyTerm(
52
+			'espresso_event_type',
53
+			'single-event',
54
+			array('espresso_events')
55
+		);
56
+	}
57
+
58
+
59
+	/**
60
+	 * Allows us to set what the default will be for terms when a cpt is PUBLISHED.
61
+	 *
62
+	 * @param string $taxonomy  The taxonomy we're using for the default term
63
+	 * @param string $term_slug The slug of the term that will be the default.
64
+	 * @param array  $cpt_slugs An array of custom post types we want the default assigned to
65
+	 */
66
+	public function registerCustomTaxonomyTerm($taxonomy, $term_slug, array $cpt_slugs = array())
67
+	{
68
+		$this->custom_taxonomy_terms[][ $term_slug ] = new CustomTaxonomyTerm(
69
+			$taxonomy,
70
+			$term_slug,
71
+			$cpt_slugs
72
+		);
73
+	}
74
+
75
+
76
+	/**
77
+	 * hooked into the wp 'save_post' action hook for setting our default terms found in the $_default_terms property
78
+	 *
79
+	 * @param  int     $post_id ID of CPT being saved
80
+	 * @param  WP_Post $post    Post object
81
+	 * @return void
82
+	 */
83
+	public function saveDefaultTerm($post_id, WP_Post $post)
84
+	{
85
+		if (empty($this->custom_taxonomy_terms)) {
86
+			return;
87
+		}
88
+		// no default terms set so lets just exit.
89
+		foreach ($this->custom_taxonomy_terms as $custom_taxonomy_terms) {
90
+			foreach ($custom_taxonomy_terms as $custom_taxonomy_term) {
91
+				if ($post->post_status === 'publish'
92
+					&& $custom_taxonomy_term instanceof CustomTaxonomyTerm
93
+					&& in_array($post->post_type, $custom_taxonomy_term->customPostTypeSlugs(), true)
94
+				) {
95
+					// note some error proofing going on here to save unnecessary db queries
96
+					$taxonomies = get_object_taxonomies($post->post_type);
97
+					foreach ($taxonomies as $taxonomy) {
98
+						$terms = wp_get_post_terms($post_id, $taxonomy);
99
+						if (empty($terms) && $taxonomy === $custom_taxonomy_term->taxonomySlug()) {
100
+							wp_set_object_terms(
101
+								$post_id,
102
+								array($custom_taxonomy_term->termSlug()),
103
+								$taxonomy
104
+							);
105
+						}
106
+					}
107
+				}
108
+			}
109
+		}
110
+	}
111
+
112
+
113
+	/**
114
+	 * @return void
115
+	 */
116
+	public function setMustUseEventTypes()
117
+	{
118
+		$term_details = array(
119
+			// Attendee's register for the first date-time only
120
+			'single-event'    => array(
121
+				'term' => esc_html__('Single Event', 'event_espresso'),
122
+				'desc' => esc_html__(
123
+					'A single event that spans one or more consecutive days.',
124
+					'event_espresso'
125
+				),
126
+			),
127
+			// example: a party or two-day long workshop
128
+			// Attendee's can register for any of the date-times
129
+			'multi-event'     => array(
130
+				'term' => esc_html__('Multi Event', 'event_espresso'),
131
+				'desc' => esc_html__(
132
+					'Multiple, separate, but related events that occur on consecutive days.',
133
+					'event_espresso'
134
+				),
135
+			),
136
+			// example: a three day music festival or week long conference
137
+			// Attendee's register for the first date-time only
138
+			'event-series'    => array(
139
+				'term' => esc_html__('Event Series', 'event_espresso'),
140
+				'desc' => esc_html__(
141
+					' Multiple events that occur over multiple non-consecutive days.',
142
+					'event_espresso'
143
+				),
144
+			),
145
+			// example: an 8 week introduction to basket weaving course
146
+			// Attendee's can register for any of the date-times.
147
+			'recurring-event' => array(
148
+				'term' => esc_html__('Recurring Event', 'event_espresso'),
149
+				'desc' => esc_html__(
150
+					'Multiple events that occur over multiple non-consecutive days.',
151
+					'event_espresso'
152
+				),
153
+			),
154
+			// example: a yoga class
155
+			'ongoing'         => array(
156
+				'term' => esc_html__('Ongoing Event', 'event_espresso'),
157
+				'desc' => esc_html__(
158
+					'An "event" that people can purchase tickets to gain access for anytime for this event regardless of date times on the event',
159
+					'event_espresso'
160
+				),
161
+			)
162
+			// example: access to a museum
163
+			// 'walk-in' => array( esc_html__('Walk In', 'event_espresso'), esc_html__('Single datetime and single entry recurring events. Attendees register for one or multiple datetimes individually.', 'event_espresso') ),
164
+			// 'reservation' => array( esc_html__('Reservation', 'event_espresso'), esc_html__('Reservations are created by specifying available datetimes and quantities. Attendees choose from the available datetimes and specify the quantity available (if the maximum is greater than 1)') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1
165
+			// 'multiple-session' => array( esc_html__('Multiple Session', 'event_espresso'), esc_html__('Multiple event, multiple datetime, hierarchically organized, custom entry events. Attendees may be required to register for a parent event before being allowed to register for child events. Attendees can register for any combination of child events as long as the datetimes do not conflict. Parent and child events may have additional fees or registration questions.') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1
166
+			// 'appointment' => array( esc_html__('Appointments', 'event_espresso'), esc_html__('Time slotted events where datetimes are generally in hours or minutes. For example, attendees can register for a single 15 minute or 1 hour time slot and this type of availability frequently reoccurs.', 'event_espresso') )
167
+		);
168
+		$this->setMustUseTerms('espresso_event_type', $term_details);
169
+	}
170
+
171
+
172
+	/**
173
+	 * wrapper method for handling the setting up of initial terms in the db (if they don't already exist).
174
+	 * Note this should ONLY be used for terms that always must be present.  Be aware that if an initial term is
175
+	 * deleted then it WILL be recreated.
176
+	 *
177
+	 * @param string $taxonomy     The name of the taxonomy
178
+	 * @param array  $term_details An array of term details indexed by slug and containing Name of term, and
179
+	 *                             description as the elements in the array
180
+	 * @return void
181
+	 */
182
+	public function setMustUseTerms($taxonomy, $term_details)
183
+	{
184
+		$term_details = (array) $term_details;
185
+		foreach ($term_details as $slug => $details) {
186
+			if (isset($details['term'], $details['desc']) && ! term_exists($slug, $taxonomy)) {
187
+				$insert_arr = array(
188
+					'slug'        => $slug,
189
+					'description' => $details['desc'],
190
+				);
191
+				wp_insert_term($details['term'], $taxonomy, $insert_arr);
192
+			}
193
+		}
194
+	}
195 195
 }
Please login to merge, or discard this patch.
core/services/loaders/CoreLoader.php 2 patches
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -47,7 +47,7 @@
 block discarded – undo
47 47
      */
48 48
     public function __construct($generator)
49 49
     {
50
-        if (! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
50
+        if ( ! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
51 51
             throw new InvalidArgumentException(
52 52
                 esc_html__(
53 53
                     'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.',
Please login to merge, or discard this patch.
Indentation   +98 added lines, -98 removed lines patch added patch discarded remove patch
@@ -29,108 +29,108 @@
 block discarded – undo
29 29
 class CoreLoader implements LoaderDecoratorInterface
30 30
 {
31 31
 
32
-    /**
33
-     * @var EE_Registry|CoffeeShop $generator
34
-     */
35
-    private $generator;
32
+	/**
33
+	 * @var EE_Registry|CoffeeShop $generator
34
+	 */
35
+	private $generator;
36 36
 
37 37
 
38
-    /**
39
-     * CoreLoader constructor.
40
-     *
41
-     * @param EE_Registry|CoffeeShop $generator
42
-     * @throws InvalidArgumentException
43
-     */
44
-    public function __construct($generator)
45
-    {
46
-        if (! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
47
-            throw new InvalidArgumentException(
48
-                esc_html__(
49
-                    'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.',
50
-                    'event_espresso'
51
-                )
52
-            );
53
-        }
54
-        $this->generator = $generator;
55
-    }
38
+	/**
39
+	 * CoreLoader constructor.
40
+	 *
41
+	 * @param EE_Registry|CoffeeShop $generator
42
+	 * @throws InvalidArgumentException
43
+	 */
44
+	public function __construct($generator)
45
+	{
46
+		if (! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
47
+			throw new InvalidArgumentException(
48
+				esc_html__(
49
+					'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.',
50
+					'event_espresso'
51
+				)
52
+			);
53
+		}
54
+		$this->generator = $generator;
55
+	}
56 56
 
57 57
 
58
-    /**
59
-     * Calls the appropriate loading method from the installed generator;
60
-     * If EE_Registry is being used, then the additional parameters for the EE_Registry::create() method
61
-     * can be added to the $arguments array and they will be extracted and passed to EE_Registry::create(),
62
-     * but NOT to the class being instantiated.
63
-     * This is done by adding the parameters to the $arguments array as follows:
64
-     *  array(
65
-     *      'EE_Registry::create(from_db)'   => true, // boolean value, default = false
66
-     *      'EE_Registry::create(load_only)' => true, // boolean value, default = false
67
-     *      'EE_Registry::create(addon)'     => true, // boolean value, default = false
68
-     *  )
69
-     *
70
-     * @param string $fqcn
71
-     * @param array  $arguments
72
-     * @param bool   $shared
73
-     * @return mixed
74
-     * @throws OutOfBoundsException
75
-     * @throws ServiceExistsException
76
-     * @throws InstantiationException
77
-     * @throws InvalidIdentifierException
78
-     * @throws InvalidDataTypeException
79
-     * @throws InvalidClassException
80
-     * @throws EE_Error
81
-     * @throws ServiceNotFoundException
82
-     * @throws ReflectionException
83
-     * @throws InvalidInterfaceException
84
-     * @throws InvalidArgumentException
85
-     */
86
-    public function load($fqcn, $arguments = array(), $shared = true)
87
-    {
88
-        $shared = filter_var($shared, FILTER_VALIDATE_BOOLEAN);
89
-        if ($this->generator instanceof EE_Registry) {
90
-            // check if additional EE_Registry::create() arguments have been passed
91
-            // from_db
92
-            $from_db = isset($arguments['EE_Registry::create(from_db)'])
93
-                ? filter_var($arguments['EE_Registry::create(from_db)'], FILTER_VALIDATE_BOOLEAN)
94
-                : false;
95
-            // load_only
96
-            $load_only = isset($arguments['EE_Registry::create(load_only)'])
97
-                ? filter_var($arguments['EE_Registry::create(load_only)'], FILTER_VALIDATE_BOOLEAN)
98
-                : false;
99
-            // addon
100
-            $addon = isset($arguments['EE_Registry::create(addon)'])
101
-                ? filter_var($arguments['EE_Registry::create(addon)'], FILTER_VALIDATE_BOOLEAN)
102
-                : false;
103
-            unset(
104
-                $arguments['EE_Registry::create(from_db)'],
105
-                $arguments['EE_Registry::create(load_only)'],
106
-                $arguments['EE_Registry::create(addon)']
107
-            );
108
-            // addons need to be cached on EE_Registry
109
-            $shared = $addon ? true : $shared;
110
-            return $this->generator->create(
111
-                $fqcn,
112
-                $arguments,
113
-                $shared,
114
-                $from_db,
115
-                $load_only,
116
-                $addon
117
-            );
118
-        }
119
-        return $this->generator->brew(
120
-            $fqcn,
121
-            $arguments,
122
-            $shared ? CoffeeMaker::BREW_SHARED : CoffeeMaker::BREW_NEW
123
-        );
124
-    }
58
+	/**
59
+	 * Calls the appropriate loading method from the installed generator;
60
+	 * If EE_Registry is being used, then the additional parameters for the EE_Registry::create() method
61
+	 * can be added to the $arguments array and they will be extracted and passed to EE_Registry::create(),
62
+	 * but NOT to the class being instantiated.
63
+	 * This is done by adding the parameters to the $arguments array as follows:
64
+	 *  array(
65
+	 *      'EE_Registry::create(from_db)'   => true, // boolean value, default = false
66
+	 *      'EE_Registry::create(load_only)' => true, // boolean value, default = false
67
+	 *      'EE_Registry::create(addon)'     => true, // boolean value, default = false
68
+	 *  )
69
+	 *
70
+	 * @param string $fqcn
71
+	 * @param array  $arguments
72
+	 * @param bool   $shared
73
+	 * @return mixed
74
+	 * @throws OutOfBoundsException
75
+	 * @throws ServiceExistsException
76
+	 * @throws InstantiationException
77
+	 * @throws InvalidIdentifierException
78
+	 * @throws InvalidDataTypeException
79
+	 * @throws InvalidClassException
80
+	 * @throws EE_Error
81
+	 * @throws ServiceNotFoundException
82
+	 * @throws ReflectionException
83
+	 * @throws InvalidInterfaceException
84
+	 * @throws InvalidArgumentException
85
+	 */
86
+	public function load($fqcn, $arguments = array(), $shared = true)
87
+	{
88
+		$shared = filter_var($shared, FILTER_VALIDATE_BOOLEAN);
89
+		if ($this->generator instanceof EE_Registry) {
90
+			// check if additional EE_Registry::create() arguments have been passed
91
+			// from_db
92
+			$from_db = isset($arguments['EE_Registry::create(from_db)'])
93
+				? filter_var($arguments['EE_Registry::create(from_db)'], FILTER_VALIDATE_BOOLEAN)
94
+				: false;
95
+			// load_only
96
+			$load_only = isset($arguments['EE_Registry::create(load_only)'])
97
+				? filter_var($arguments['EE_Registry::create(load_only)'], FILTER_VALIDATE_BOOLEAN)
98
+				: false;
99
+			// addon
100
+			$addon = isset($arguments['EE_Registry::create(addon)'])
101
+				? filter_var($arguments['EE_Registry::create(addon)'], FILTER_VALIDATE_BOOLEAN)
102
+				: false;
103
+			unset(
104
+				$arguments['EE_Registry::create(from_db)'],
105
+				$arguments['EE_Registry::create(load_only)'],
106
+				$arguments['EE_Registry::create(addon)']
107
+			);
108
+			// addons need to be cached on EE_Registry
109
+			$shared = $addon ? true : $shared;
110
+			return $this->generator->create(
111
+				$fqcn,
112
+				$arguments,
113
+				$shared,
114
+				$from_db,
115
+				$load_only,
116
+				$addon
117
+			);
118
+		}
119
+		return $this->generator->brew(
120
+			$fqcn,
121
+			$arguments,
122
+			$shared ? CoffeeMaker::BREW_SHARED : CoffeeMaker::BREW_NEW
123
+		);
124
+	}
125 125
 
126 126
 
127
-    /**
128
-     * calls reset() on generator if method exists
129
-     */
130
-    public function reset()
131
-    {
132
-        if ($this->generator instanceof ResettableInterface) {
133
-            $this->generator->reset();
134
-        }
135
-    }
127
+	/**
128
+	 * calls reset() on generator if method exists
129
+	 */
130
+	public function reset()
131
+	{
132
+		if ($this->generator instanceof ResettableInterface) {
133
+			$this->generator->reset();
134
+		}
135
+	}
136 136
 }
Please login to merge, or discard this patch.