Skip to content

Commit 7a082f7

Browse files
therouvtherouv
committed
Merge branch 'release/1.0.1'
2 parents 0d1943d + 3c7bce8 commit 7a082f7

File tree

84 files changed

+6713
-427
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

84 files changed

+6713
-427
lines changed

‎.travis.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@ language: php
22
php:
33
- 5.3
44
before_install:
5-
- composer install --dev
65
- mkdir test/
6+
- composer install --dev
77
before_script:
88
- CURR_DIR=$(pwd)
99
- bin/mage-ci install test 1.7.0.2 magento_test -c -t -r http://mage-ci.ecomdev.org
10-
- bin/mage-ci install-module test $CURR_DIR/src/
11-
- git clone git://github.com/IvanChepurnyi/EcomDev_PHPUnit.git -b dev ./phpunit/
10+
- bin/mage-ci install-module test $CURR_DIR
11+
- git clone https://github.com/EcomDev/EcomDev_PHPUnit.git -b dev $CURR_DIR/phpunit/
1212
- bin/mage-ci install-module $CURR_DIR/test $CURR_DIR/phpunit/
1313
script:
1414
- bin/mage-ci phpunit test

‎README.md‎

Lines changed: 106 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,129 @@
1-
# Firegento AdminMonitoring
1+
FireGento_AdminMonitoring
2+
=========================
23

3-
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.
4+
The admin monitoring logs nearly every save and delete call in the backend.
45

5-
##Vision
6-
If we know all the changes in the backend, we can provide versioning.
6+
Facts
7+
-----
8+
- Version: check [config.xml](https://github.com/firegento/firegento-adminmonitoring/blob/master/src/app/code/community/FireGento/AdminMonitoring/etc/config.xml)
9+
- [Extension on GitHub](https://github.com/firegento/firegento-adminmonitoring/)
710

8-
## Usage
9-
Install via modman or copy the files into your magento installation.
11+
Builds
12+
------
13+
- Branch: master [![Build Status](https://travis-ci.org/firegento/firegento-adminmonitoring.png?branch=master)](https://travis-ci.org/firegento/firegento-adminmonitoring)
14+
- Branch: develop [![Build Status](https://travis-ci.org/firegento/firegento-adminmonitoring.png?branch=develop)](https://travis-ci.org/firegento/firegento-adminmonitoring)
1015

11-
### Dependencies
12-
* PHP 5.3 (or even 5.0 as long as [spl](http://www.php.net/manual/en/book.spl.php) is activated)
13-
* Magento CE >= 1.6 OR Magento EE >= 1.12
16+
Description
17+
-----------
18+
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.
1419

1520
### BE CAREFUL
1621
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!
1722

1823
To exclude a class, add it into the node `config/default/firegento_adminmonitoring_config/exclude/object_types`
1924

20-
<config>
21-
<default>
22-
<firegento_adminmonitoring_config>
23-
<exclude>
24-
<object_types>
25-
<Mage_Index_Model_Event />
26-
<!-- omit infinite loops -->
27-
<Firegento_AdminMonitoring_Model_History />
28-
</object_types>
29-
</exclude>
30-
</firegento_adminmonitoring_config>
31-
</default>
32-
</config>
25+
```xml
26+
<config>
27+
<default>
28+
<firegento_adminmonitoring_config>
29+
<exclude>
30+
<object_types>
31+
<Mage_Index_Model_Event />
32+
<!-- omit infinite loops -->
33+
<Firegento_AdminMonitoring_Model_History />
34+
</object_types>
35+
</exclude>
36+
</firegento_adminmonitoring_config>
37+
</default>
38+
</config>
39+
```
3340

3441
You can also exclude fields like updated_at ...
3542

36-
<config>
37-
<default>
38-
<firegento_adminmonitoring_config>
39-
<exclude>
40-
<fields>
41-
<updated_at />
42-
<update_time />
43-
</fields>
44-
</exclude>
45-
</firegento_adminmonitoring_config>
46-
</default>
47-
</config>
43+
```xml
44+
<config>
45+
<default>
46+
<firegento_adminmonitoring_config>
47+
<exclude>
48+
<fields>
49+
<updated_at />
50+
<update_time />
51+
</fields>
52+
</exclude>
53+
</firegento_adminmonitoring_config>
54+
</default>
55+
</config>
56+
```
4857

4958
### Third party integration
50-
model_save_after and model_delete_after are observed and changes automatically logged if not excluded as described above.
59+
60+
Events for model_save_after and model_delete_after are observed and changes automatically logged, if not excluded as described above.
5161
So even third party models will be logged and can be even better integrated by link to their adminhtml edit form.
5262
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.
5363

5464
If you want to log your own events just dispatch the firegento_AdminMonitoring_log event:
5565

56-
Mage::dispatchEvent(
57-
'firegento_adminmonitoring_log',
58-
array(
59-
'object_id' => $objectId,
60-
'object_type' => $objectType,
61-
'content' => $content, // as json
62-
'content_diff' => $contentDiff, // as json
63-
'action' => $action, // see Firegento_AdminMonitoring_Helper_Data for possible ACTION constants
64-
)
65-
);
66-
67-
## Core Team
66+
```php
67+
Mage::dispatchEvent(
68+
'firegento_adminmonitoring_log',
69+
array(
70+
'object_id' => $objectId,
71+
'object_type' => $objectType,
72+
'content' => $content, // as json
73+
'content_diff' => $contentDiff, // as json
74+
'action' => $action, // see Firegento_AdminMonitoring_Helper_Data for possible ACTION constants
75+
)
76+
);
77+
```
78+
79+
Requirements
80+
------------
81+
- PHP >= 5.3.0 (or even 5.0 as long as [spl](http://www.php.net/manual/en/book.spl.php) is activated)
82+
83+
Compatibility
84+
-------------
85+
- Magento CE >= 1.6
86+
- Magento EE >= 1.12
87+
88+
Installation Instructions
89+
-------------------------
90+
1. Install the extension by copying all the extension files into your document root.
91+
2. Clear the cache, logout from the admin panel and then login again.
92+
3. You can now configure the extenion via *System -> Configuration -> Advanced -> Admin -> Admin Monitoring*
93+
94+
Uninstallation
95+
--------------
96+
1. Remove all extension files from your Magento installation
97+
2. Run the following sql script in your database:
98+
99+
```sql
100+
DROP TABLE 'firegento_adminmonitoring_history';
101+
```
102+
103+
Support
104+
-------
105+
If you have any issues with this extension, open an issue on [GitHub](https://github.com/firegento/firegento-customer/issues).
106+
107+
Contribution
108+
------------
109+
Any contribution is highly appreciated. The best way to contribute code is to open a [pull request on GitHub](https://help.github.com/articles/using-pull-requests).
110+
111+
Developer
112+
---------
113+
FireGento Team
114+
* Website: [http://firegento.com](http://firegento.com)
115+
* Twitter: [@firegento](https://twitter.com/firegento)
116+
117+
Developers:
68118
* Tobias Zander (@airbone42)
69119
* Ralf Siepker (@mageconsult)
70120
* Carmen Bremen (@neoshops)
71-
* Fabian Blechschmidt (@Schrank)
121+
* Fabian Blechschmidt (@Schrank)
122+
123+
License
124+
-------
125+
[GNU General Public License, version 3 (GPLv3)](http://opensource.org/licenses/gpl-3.0)
126+
127+
Copyright
128+
---------
129+
(c) 2013 FireGento Team

‎composer.json‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,8 @@
1717
"type": "composer",
1818
"url": "http://packages.firegento.com"
1919
}
20-
]
20+
],
21+
"extra": {
22+
"magento-root-dir": "test/"
23+
}
2124
}

‎docs/api/html/classes/FireGento_AdminMonitoring_Adminhtml_HistoryController.xhtml‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!DOCTYPE html PUBLIC "html" "">
3+
<html xmlns="http://www.w3.org/1999/xhtml" class="no-js" lang="en">
4+
<head>
5+
<meta charset="utf-8"/>
6+
<title>FireGento_AdminMonitoring - FireGento_AdminMonitoring_Adminhtml_HistoryController - API Documentation</title>
7+
<link href="../css/normalize.css" rel="stylesheet" type="text/css" media="all"/>
8+
<link href="../css/styles.css" rel="stylesheet" type="text/css" media="all"/>
9+
</head>
10+
<body>
11+
<div class="wrapper clearfix">
12+
<div class="topbar clearfix">
13+
<h1>
14+
<a class="brand" href="../index.xhtml">FireGento_AdminMonitoring - API Documentation</a>
15+
</h1>
16+
<ul class="nav">
17+
<li class="active">
18+
<a href="../index.xhtml">Overview</a>
19+
</li>
20+
</ul>
21+
</div>
22+
<div class="navigation">
23+
<h3>Methods</h3>
24+
<ul>
25+
<li>
26+
<a href="#_initAction">_initAction</a>
27+
</li>
28+
<li>
29+
<a href="#indexAction">indexAction</a>
30+
</li>
31+
<li>
32+
<a href="#revertAction">revertAction</a>
33+
</li>
34+
</ul>
35+
</div>
36+
<div class="content">
37+
<h2><span style="font-size:60%">\</span>FireGento_AdminMonitoring_Adminhtml_HistoryController</h2>
38+
<div class="file-notice">
39+
<p>History controller</p>
40+
</div>
41+
<ul class="fileinfos">
42+
<li><b>Author: </b>FireGento Team &lt;team@firegento.com&gt;</li>
43+
</ul>
44+
<h3>Methods</h3>
45+
<ul class="varlist">
46+
<li>
47+
<a name="indexAction"/>
48+
<h4><span class="label public">public</span>indexAction<span style="font-size:90%;">( )</span></h4>
49+
<p style="font-size:110%; padding-top:5px;">
50+
<li>Shows the history grid</li>
51+
</p>
52+
</li>
53+
<li>
54+
<a name="revertAction"/>
55+
<h4><span class="label public">public</span>revertAction<span style="font-size:90%;">( )</span></h4>
56+
<p style="font-size:110%; padding-top:5px;">
57+
<li>Reverts a history entry</li>
58+
</p>
59+
</li>
60+
<li>
61+
<a name="_initAction"/>
62+
<h4><span class="label protected">protected</span>_initAction<span style="font-size:90%;">( )</span></h4>
63+
<p style="font-size:110%; padding-top:5px;">
64+
<li>Inits the layout, the active menu tab and the breadcrumbs</li>
65+
</p>
66+
<ul>
67+
<h4 class="return">Returns:</h4>
68+
<ul class="return">
69+
<li/>
70+
</ul>
71+
</ul>
72+
</li>
73+
</ul>
74+
<div class="footer">Generated using phpDox 0.5 - Copyright (C) 2010 - 2013 by Arne Blankerts</div>
75+
</div>
76+
</div>
77+
</body>
78+
</html>

‎docs/api/html/classes/FireGento_AdminMonitoring_Block_Adminhtml_History.xhtml‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!DOCTYPE html PUBLIC "html" "">
3+
<html xmlns="http://www.w3.org/1999/xhtml" class="no-js" lang="en">
4+
<head>
5+
<meta charset="utf-8"/>
6+
<title>FireGento_AdminMonitoring - FireGento_AdminMonitoring_Block_Adminhtml_History - API Documentation</title>
7+
<link href="../css/normalize.css" rel="stylesheet" type="text/css" media="all"/>
8+
<link href="../css/styles.css" rel="stylesheet" type="text/css" media="all"/>
9+
</head>
10+
<body>
11+
<div class="wrapper clearfix">
12+
<div class="topbar clearfix">
13+
<h1>
14+
<a class="brand" href="../index.xhtml">FireGento_AdminMonitoring - API Documentation</a>
15+
</h1>
16+
<ul class="nav">
17+
<li class="active">
18+
<a href="../index.xhtml">Overview</a>
19+
</li>
20+
</ul>
21+
</div>
22+
<div class="navigation">
23+
<h3>Methods</h3>
24+
<ul>
25+
<li>
26+
<a href="#__construct">__construct</a>
27+
</li>
28+
</ul>
29+
</div>
30+
<div class="content">
31+
<h2><span style="font-size:60%">\</span>FireGento_AdminMonitoring_Block_Adminhtml_History</h2>
32+
<div class="file-notice">
33+
<p>Displays the logging history grid container</p>
34+
</div>
35+
<ul class="fileinfos">
36+
<li><b>Author: </b>FireGento Team &lt;team@firegento.com&gt;</li>
37+
</ul>
38+
<h3>Constructor</h3>
39+
<ul class="varlist">
40+
<li>
41+
<a name="__construct"/>
42+
<h4><span class="label public">public</span>__construct<span style="font-size:90%;">( )</span></h4>
43+
<p style="font-size:110%; padding-top:5px;">
44+
<li>Constructor of the grid container</li>
45+
</p>
46+
</li>
47+
</ul>
48+
<div class="footer">Generated using phpDox 0.5 - Copyright (C) 2010 - 2013 by Arne Blankerts</div>
49+
</div>
50+
</div>
51+
</body>
52+
</html>

0 commit comments

Comments
 (0)