Joomla! Issue Tracker | Joomla! CMS #41325 - [5.0][Events] Application configuration event classes

Feature PR-5.0-dev

Fixed in Code Base
21 Aug 2023
Medium
Build: 5.0-dev
# 41325
Diff
Fedik:app-config-event

Pending

User tests: Successful: Unsuccessful:

Fedik
6 Aug 2023

Summary of Changes

Implementing Event classes for Application configuration events.
This also need #41226, that has some fixes. But can be tested without.

Affected events:

onApplicationBeforeSave
onApplicationAfterSave

Testing Instructions

Apply patch.
Try edit global configuration.
All should work as before.

Actual result BEFORE applying this Pull Request

Works

Expected result AFTER applying this Pull Request

Works

Link to documentations

Please select:

Documentation link for docs.joomla.org: https://docs.joomla.org/Plugin/Events#Config_Component
No documentation changes for docs.joomla.org needed
Pull Request link for manual.joomla.org: TBD
No documentation changes for manual.joomla.org needed

63854ec 6 Aug 2023

Application Configuration Event

joomla-cms-bot - change - 6 Aug 2023

Category

⇒

Administration com_config Libraries

Fedik - open - 6 Aug 2023

Fedik - change - 6 Aug 2023

Status

New

⇒

Pending

heelc29 - comment - 6 Aug 2023

There is a small b/c break

- $result = $app->triggerEvent('onApplicationBeforeSave', [$config]);
+ $result = $app->triggerEvent('onApplicationBeforeSave', ['subject' => $config]);

- $app->triggerEvent('onApplicationAfterSave', [$config]);
+ $app->triggerEvent('onApplicationAfterSave', ['subject' => $config]);

you will see it when you perform removeroot

joomla-cms/administrator/components/com_config/src/Model/ApplicationModel.php

Lines 773 to 799 in fe2074e

    
           public function removeroot() 
        
           { 
        
               $app = Factory::getApplication(); 
        
               // Get the previous configuration. 
        
               $prev = new \JConfig(); 
        
               $prev = ArrayHelper::fromObject($prev); 
        
               // Create the new configuration object, and unset the root_user property 
        
               unset($prev['root_user']); 
        
               $config = new Registry($prev); 
        
               $result = $app->triggerEvent('onApplicationBeforeSave', [$config]); 
        
               // Store the data. 
        
               if (in_array(false, $result, true)) { 
        
                   throw new \RuntimeException(Text::_('COM_CONFIG_ERROR_UNKNOWN_BEFORE_SAVING')); 
        
               } 
        
               // Write the configuration file. 
        
               $result = $this->writeConfigFile($config); 
        
               // Trigger the after save event. 
        
               $app->triggerEvent('onApplicationAfterSave', [$config]); 
        
               return $result; 
        
           }

heelc29 - test_item - 6 Aug 2023 - Tested unsuccessfully

heelc29 - comment - 6 Aug 2023

I have tested this item ? unsuccessfully on 63854ec

See comments above

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/41325.}

bb8986c 6 Aug 2023

Application Configuration Event

Fedik - change - 6 Aug 2023

Labels

Added: Feature PR-5.0-dev

Fedik - comment - 6 Aug 2023

Yea, I have missed couple ones, should be good now

heelc29 - test_item - 6 Aug 2023 - Tested successfully

heelc29 - comment - 6 Aug 2023

I have tested this item ✅ successfully on bb8986c

Looks good now. Thanks

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/41325.}

9d00370 14 Aug 2023

Merge branch '5.0-dev' into app-config-event

a9916da 20 Aug 2023

Merge branch '5.0-dev' into app-config-event

HLeithner - comment - 20 Aug 2023

Merging this for the next alpha to get more feedback. Thanks for the work.

8253dcf 21 Aug 2023

Merge branch '5.0-dev' into app-config-event

HLeithner - change - 21 Aug 2023

Status	Pending	⇒	Fixed in Code Base
Closed_Date	0000-00-00 00:00:00	⇒	2023-08-21 08:22:22
Closed_By		⇒	HLeithner

HLeithner - close - 21 Aug 2023

HLeithner - merge - 21 Aug 2023

HLeithner - comment - 21 Aug 2023

thanks

Add a Comment

Older
Newer

Joomla! Issue Tracker - CMS

[#41325] - [5.0][Events] Application configuration event classes

Summary of Changes

Testing Instructions

Actual result BEFORE applying this Pull Request

Expected result AFTER applying this Pull Request

Link to documentations

Add a Comment

	public function removeroot()
	{
	$app = Factory::getApplication();

	// Get the previous configuration.
	$prev = new \JConfig();
	$prev = ArrayHelper::fromObject($prev);

	// Create the new configuration object, and unset the root_user property
	unset($prev['root_user']);
	$config = new Registry($prev);

	$result = $app->triggerEvent('onApplicationBeforeSave', [$config]);

	// Store the data.
	if (in_array(false, $result, true)) {
	throw new \RuntimeException(Text::_('COM_CONFIG_ERROR_UNKNOWN_BEFORE_SAVING'));
	}

	// Write the configuration file.
	$result = $this->writeConfigFile($config);

	// Trigger the after save event.
	$app->triggerEvent('onApplicationAfterSave', [$config]);

	return $result;
	}