diff --git a/.travis.yml b/.travis.yml index b8df36f..baff9f6 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,14 +1,29 @@ language: php + php: - 5.3 + - 5.4 + - 5.5 + +env: + - MAGENTO_VERSION="1.6.2.0" + - MAGENTO_VERSION="1.7.0.2" + - MAGENTO_VERSION="1.8.1.0" + - MAGENTO_VERSION="1.9.0.1" + before_install: - mkdir test/ - - composer install --dev + - curl -sS https://getcomposer.org/installer | php + - chmod +x ./composer.phar + - ./composer.phar --version + - ./composer.phar install --dev + before_script: - CURR_DIR=$(pwd) - - bin/mage-ci install test 1.7.0.2 magento_test -c -t -r http://mage-ci.ecomdev.org + - bin/mage-ci install test ${MAGENTO_VERSION} magento_test -c -t -r http://mage-ci.firegento.com - bin/mage-ci install-module test $CURR_DIR - - git clone https://github.com/EcomDev/EcomDev_PHPUnit.git -b dev $CURR_DIR/phpunit/ + - git clone https://github.com/EcomDev/EcomDev_PHPUnit.git ./phpunit/ - bin/mage-ci install-module $CURR_DIR/test $CURR_DIR/phpunit/ + script: - bin/mage-ci phpunit test diff --git a/README.md b/README.md index 190787f..1dc49ba 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ FireGento_AdminMonitoring ========================= -The admin monitoring logs nearly every save and delete call in the backend. +The admin monitoring allows an shop owner to log almost every activity in the backend. Facts ----- @@ -15,53 +15,65 @@ Builds Description ----------- -The admin monitoring logs nearly every save and delete call in the backend. The idea is to generate an overview of the changes in the backend to know who changed certain things. +The admin monitoring allows an shop owner to log almost every activity in the backend. The goal is to monitor all changes in the backend and show them in a nice view so that +a shop owner can monitor who changed what, e.g. logged in to the admin account, saved a product, deleted a customer, e.g. ### BE CAREFUL This extension writes a lot of data into the database and we exclude only a few core classes. If you have many writes in the backend, please have a look into this to avoid a full hard disk! -To exclude a class, add it into the node `config/default/firegento_adminmonitoring_config/exclude/object_types` +There are currently several ways if you can exclude e.g. specific models, admin routes, field names from logging data to the database: +- Exclude all changes from a specific object (e.g. Mage_Index_Model_Event) +- Exclude all changes from a specific admin route (e.g. admin_sales_order_create_loadBlock) +- Exclude specific objects from specific admin routes (e.g. Mage_CatalogRule_Model_Flag from admin_promo_catalog_save) +- Exclude specific field names from every object (e.g. created_at, updated_at) -```xml - - - - - - - - - - - - - -``` - -You can also exclude fields like updated_at ... +There is a basic *adminmonitoring.xml* file located in the "etc" folder of this extension with the following default excludes: ```xml + - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ``` + ### Third party integration Events for model_save_after and model_delete_after are observed and changes automatically logged, if not excluded as described above. So even third party models will be logged and can be even better integrated by link to their adminhtml edit form. -To do this observe the firegento_AdminMonitoring_rowurl event and see Firegento_AdminMonitoring_Model_RowUrl_Product for an catalog_product implementation which can be adapted. +To do this observe the event **firegento_adminmonitoring_rowurl** and see **Firegento_AdminMonitoring_Model_RowUrl_Product** for an catalog_product implementation which can be adapted for your custom models. -If you want to log your own events just dispatch the firegento_AdminMonitoring_log event: +If you want to log your own events just dispatch the event **firegento_adminmonitoring_log** and pass your custom data: ```php Mage::dispatchEvent( @@ -76,9 +88,14 @@ Mage::dispatchEvent( ); ``` +If you want to exclude some more fields, admin routes, object types just create a custom *adminmonitoring.xml* file +in your custom module and add the necessary values in the same structure like in the default *adminmonitoring.xml* file of this extension. + + Requirements ------------ - PHP >= 5.3.0 (or even 5.0 as long as [spl](http://www.php.net/manual/en/book.spl.php) is activated) +- PHP >= 5.5.0: json extension Compatibility ------------- @@ -90,6 +107,7 @@ Installation Instructions 1. Install the extension by copying all the extension files into your document root. 2. Clear the cache, logout from the admin panel and then login again. 3. You can now configure the extenion via *System -> Configuration -> Advanced -> Admin -> Admin Monitoring* +4. You can view all logging entries in *System -> Configuration -> Admin Monitoring* Uninstallation -------------- @@ -100,6 +118,8 @@ Uninstallation DROP TABLE 'firegento_adminmonitoring_history'; ``` +3. Please remove all integration for the admin monitoring in your custom modules. + Support ------- If you have any issues with this extension, open an issue on [GitHub](https://github.com/firegento/firegento-adminmonitoring/issues). @@ -115,10 +135,7 @@ FireGento Team * Twitter: [@firegento](https://twitter.com/firegento) Developers: -* Tobias Zander (@airbone42) -* Ralf Siepker (@mageconsult) -* Carmen Bremen (@neoshops) -* Fabian Blechschmidt (@Schrank) +* Please see the [contributor page](https://github.com/firegento/firegento-adminmonitoring/graphs/contributors) on github. License ------- @@ -126,4 +143,4 @@ License Copyright --------- -(c) 2013 FireGento Team +(c) 2013-2014 FireGento Team diff --git a/docs/api/html/classes.xhtml b/docs/api/html/classes.xhtml new file mode 100644 index 0000000..5777e9d --- /dev/null +++ b/docs/api/html/classes.xhtml @@ -0,0 +1,450 @@ + + + + phpDox - Overview + + + + + +
+

Classes

+
+

\

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription +
+ FireGento_AdminMonitoring_Adminhtml_HistoryController + History controllerUNTESTED
+ FireGento_AdminMonitoring_Block_Adminhtml_History + Displays the logging history grid containerUNTESTED
+ FireGento_AdminMonitoring_Block_Adminhtml_History_Grid + Displays the logging history gridUNTESTED
+ FireGento_AdminMonitoring_Block_Adminhtml_History_Grid_Link + Displays the link to the object in the history if applicableUNTESTED
+ FireGento_AdminMonitoring_Block_Adminhtml_History_View + Displays the logging history detail pageUNTESTED
+ FireGento_AdminMonitoring_Block_Adminhtml_History_View_Detail + Block for showing information on the history detail pageUNTESTED
+ FireGento_AdminMonitoring_Helper_Data + Helper classUNTESTED
+ FireGento_AdminMonitoring_Model_Clean + Cleans the history after a configurable amount of time.UNTESTED
+ FireGento_AdminMonitoring_Model_Config + Class FireGento_AdminMonitoring_Model_ConfigUNTESTED
+ FireGento_AdminMonitoring_Model_History + History ModelUNTESTED
+ FireGento_AdminMonitoring_Model_History_Data + History Data ModelUNTESTED
+ FireGento_AdminMonitoring_Model_History_Diff + History Diff ModelUNTESTED
+ FireGento_AdminMonitoring_Model_Observer_Log + Logging modelUNTESTED
+ FireGento_AdminMonitoring_Model_Observer_Login + Logs the successful and failed logins to the admin backendUNTESTED
+ FireGento_AdminMonitoring_Model_Observer_Model_Abstract + Abstract observer class; provides some common functions for subclassesUNTESTED
+ FireGento_AdminMonitoring_Model_Observer_Model_Delete + Observes Model DeleteUNTESTED
+ FireGento_AdminMonitoring_Model_Observer_Model_Save + Observes Model SaveUNTESTED
+ FireGento_AdminMonitoring_Model_Observer_Product_Attribute_Update + Observes the product attribute updatesUNTESTED
+ FireGento_AdminMonitoring_Model_Observer_Product_Import + Observes the product importUNTESTED
+ FireGento_AdminMonitoring_Model_Resource_History + History Resource ModelUNTESTED
+ FireGento_AdminMonitoring_Model_Resource_History_Collection + History Collection Resource ModelUNTESTED
+ FireGento_AdminMonitoring_Model_RowUrl_Model_Abstract + Abstract Model for RowUrlUNTESTED
+ FireGento_AdminMonitoring_Model_RowUrl_Model_Customer + RowUrl Implementation for CustomersUNTESTED
+ FireGento_AdminMonitoring_Model_RowUrl_Model_Order + RowUrl Implementation for sales orderUNTESTED
+ FireGento_AdminMonitoring_Model_RowUrl_Model_Page + RowUrl Implementation for CMS pagesUNTESTED
+ FireGento_AdminMonitoring_Model_RowUrl_Model_Product + RowUrl Implementation for ProductsUNTESTED
+ FireGento_AdminMonitoring_Model_System_Config_Source_Admin_User + Source model for admin usersUNTESTED
+ FireGento_AdminMonitoring_Model_System_Config_Source_History_Action + Source model for history actionsUNTESTED
+ FireGento_AdminMonitoring_Model_System_Config_Source_History_Status + Source model for history statusUNTESTED
+ FireGento_AdminMonitoring_Model_System_Config_Source_SourceAbstract + Abstract source modelUNTESTED
+ FireGento_AdminMonitoring_Test_Block_Adminhtml_History + Class FireGento_AdminMonitoring_Test_Block_Adminhtml_HistoryUNTESTED
+ FireGento_AdminMonitoring_Test_Block_Adminhtml_History_Grid + Class FireGento_AdminMonitoring_Test_Block_Adminhtml_History_GridUNTESTED
+ FireGento_AdminMonitoring_Test_Block_Adminhtml_History_Grid_Link + Class FireGento_AdminMonitoring_Test_Block_Adminhtml_History_Grid_LinkUNTESTED
+ FireGento_AdminMonitoring_Test_Block_Adminhtml_History_View + Class FireGento_AdminMonitoring_Test_Block_Adminhtml_History_ViewUNTESTED
+ FireGento_AdminMonitoring_Test_Block_Adminhtml_History_View_Detail + Class FireGento_AdminMonitoring_Test_Block_Adminhtml_History_View_DetailUNTESTED
+ FireGento_AdminMonitoring_Test_Config_Config + + No description available + UNTESTED
+ FireGento_AdminMonitoring_Test_Helper_Data + Class FireGento_AdminMonitoring_Test_Helper_DataUNTESTED
+ FireGento_AdminMonitoring_Test_Model_Clean + Class FireGento_AdminMonitoring_Test_Model_CleanUNTESTED
+ FireGento_AdminMonitoring_Test_Model_Config + Class FireGento_AdminMonitoring_Test_Model_ConfigUNTESTED
+ FireGento_AdminMonitoring_Test_Model_History + Class FireGento_AdminMonitoring_Test_Model_HistoryUNTESTED
+ FireGento_AdminMonitoring_Test_Model_History_Data + Class FireGento_AdminMonitoring_Test_Model_History_DataUNTESTED
+ FireGento_AdminMonitoring_Test_Model_History_Diff + Class FireGento_AdminMonitoring_Test_Model_History_DiffUNTESTED
+ FireGento_AdminMonitoring_Test_Model_Observer_Log + Class FireGento_AdminMonitoring_Test_Model_Observer_LogUNTESTED
+ FireGento_AdminMonitoring_Test_Model_Observer_Login + Class FireGento_AdminMonitoring_Test_Model_Observer_LoginUNTESTED
+ FireGento_AdminMonitoring_Test_Model_Observer_Model_Delete + Class FireGento_AdminMonitoring_Test_Model_Observer_Model_DeleteUNTESTED
+ FireGento_AdminMonitoring_Test_Model_Observer_Model_Save + Class FireGento_AdminMonitoring_Test_Model_Observer_Model_SaveUNTESTED
+ FireGento_AdminMonitoring_Test_Model_Observer_Product_Attribute_Update + Class FireGento_AdminMonitoring_Test_Model_Observer_Product_Attribute_UpdateUNTESTED
+ FireGento_AdminMonitoring_Test_Model_Observer_Product_Import + Class FireGento_AdminMonitoring_Test_Model_Observer_Product_ImportUNTESTED
+ FireGento_AdminMonitoring_Test_Model_Resource_History + Class FireGento_AdminMonitoring_Test_Model_Resource_HistoryUNTESTED
+ FireGento_AdminMonitoring_Test_Model_Resource_History_Collection + Class FireGento_AdminMonitoring_Test_Model_Resource_History_CollectionUNTESTED
+ FireGento_AdminMonitoring_Test_Model_RowUrl_Model_Customer + Class FireGento_AdminMonitoring_Test_Model_RowUrl_Model_CustomerUNTESTED
+ FireGento_AdminMonitoring_Test_Model_RowUrl_Model_Order + Class FireGento_AdminMonitoring_Test_Model_RowUrl_Model_OrderUNTESTED
+ FireGento_AdminMonitoring_Test_Model_RowUrl_Model_Page + Class FireGento_AdminMonitoring_Test_Model_RowUrl_Model_PageUNTESTED
+ FireGento_AdminMonitoring_Test_Model_RowUrl_Model_Product + Class FireGento_AdminMonitoring_Test_Model_RowUrl_Model_ProductUNTESTED
+ FireGento_AdminMonitoring_Test_Model_System_Config_Source_Admin_User + Class FireGento_AdminMonitoring_Test_Model_System_Config_Source_Admin_UserUNTESTED
+ FireGento_AdminMonitoring_Test_Model_System_Config_Source_History_Action + Class FireGento_AdminMonitoring_Test_Model_System_Config_Source_History_ActionUNTESTED
+ FireGento_AdminMonitoring_Test_Model_System_Config_Source_History_Status + Class FireGento_AdminMonitoring_Test_Model_System_Config_Source_History_StatusUNTESTED
+
+
+ + + diff --git a/docs/api/html/classes/FireGento_AdminMonitoring_Adminhtml_HistoryController.xhtml b/docs/api/html/classes/FireGento_AdminMonitoring_Adminhtml_HistoryController.xhtml index abf8fb5..06185ab 100644 --- a/docs/api/html/classes/FireGento_AdminMonitoring_Adminhtml_HistoryController.xhtml +++ b/docs/api/html/classes/FireGento_AdminMonitoring_Adminhtml_HistoryController.xhtml @@ -1,78 +1,115 @@ - - - + + + - - FireGento_AdminMonitoring - FireGento_AdminMonitoring_Adminhtml_HistoryController - API Documentation - - + phpDox - FireGento_AdminMonitoring_Adminhtml_HistoryController + + -
-
-

- FireGento_AdminMonitoring - API Documentation -

-