Skip to content

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
akrys committed Jan 27, 2018
2 parents 30d9682 + 44962c4 commit f091360
Show file tree
Hide file tree
Showing 97 changed files with 11,084 additions and 4,077 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
docs
node_modules
/vendor/
composer.lock

58 changes: 24 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,52 +4,42 @@

Dieses Addon sucht nach Bildern, Module und Templates, die nicht (mehr) verwendet werden.

## Installation

Das Repo beinhaltet direkt die Dateien für das Verzeichnis
`redaxo/inlcude/addons/usage_check` (Redaxo 4.x) oder
`redaxo/src/addons/usage_check` (Redaxo 5.x)

Das Verzeichnis selber (`usage_check`) ist hier nicht enthalten, da man das
Addon sonst nicht direkt an die richtige Stelle auschecken könnte.
Mit der Version 2.0 wird die Unterstützung für Redaxo 4 entfernt. Vorrangig passiert das wegen (für mich nicht
nachvollziehbaren) Zeichensatz-Problemen in diversen Redaxo 5 Instanzen.

Man kann auch das hier generierte ZIP herunterladen und an die richtige Stelle
kopieren.
## Installation

Dann muss man das Addon nur noch über das Redaxo-Backend installieren und
aktivieren.
###Standard-Installation
Normalerweise kann man das Addon normal über das Redaxo-Backend installieren. Im Normalfall sollte man als Benutzer auch
diesen Weg wählen.

## Kompatibilität
- PHP Version: __5.3.2__ oder höher
- getestet mit Redaxo __4.3.2__, __4.4.1__, __4.5__, __4.6.1__, __4.7__, __5.0.1__, __5.1__, __5.2__

Der Code funktioniert für Redaxo 4 und Redaxo 5
###Manuelle Installation
Eine Ausnahme stellt das Testen von Beta-Funktionalitäten dar. Dann muss man ganz "old school" die Dateien laden und an
die richtige Stelle kopieren.

##Hinweis für die Sprachdateien
Dafür nun folgende Hinweise:

Der Ordner `usage_check/lang` braucht Schreibrechte für den PHP bzw. Apache User.
Das Repo beinhaltet direkt alle Dateien für das Verzeichnis `redaxo/src/addons/usage_check`

Grund dafür ist, dass von mir nur die Dateien `de_de_utf8.lang` und
`en_gb_utf8.lang` gepflegt werden.
Das Verzeichnis selber (`usage_check`) ist hier nicht enthalten, da man das Addon sonst nicht direkt an die richtige
Stelle auschecken könnte.

Jetzt wird es etwas undurchsichtig: Für Redaxo 4 braucht es den Inhalt der
Dateien `de_de_utf8.lang` und `en_gb_utf8.lang` in __ISO-8859-1__. Da diese
Dateien in Redaxo 5 aber __UTF-8__ kodiert sein müssen, muss ich diese Dateien
je nach verwendeter Redaxo-Version aus den `xx_yy_utf8.lang` Dateien in der
richtigen Zeichenkodierung erstellen. Dafür braucht es dann Schreibrechte am
Verzeichnis.
Man kann auch das hier generierte ZIP herunterladen und an die richtige Stelle kopieren.

Leider kommt man da nicht drum herum, wenn der Code für beide Redaxo-Versionen
kompatibel sein soll und man gleichzeitig die Sprachdateien nur 1x pflegen will.
Dann muss man das Addon nur noch über das Redaxo-Backend installieren und aktivieren.

## Kompatibilität
- PHP Version: __5.6.11__ oder höher
- getestet mit Redaxo __5.0.1__, __5.1__, __5.2__, __5.3__, __5.4__, __5.5__

##Hinweis Code-Analyse-Tools
Mit der Verison 1.0-Beta7 habe ich Code-Anlayse-Tools, wie z.B. `PHPUnit` eingebaut. Dafür schein es am Einfachsten
zu sein, eine `composer.json` zu erstellen und die Hilfsprogramme ins Projekt zu installieren. Leider kann durch den
AutoLoader im Redaxo-Core aber dazu kommen, dass sich die Seite in einen Timeout läuft. Es werden alle Dateien
- auch die in `vendor`-Ordnern - analysiert und u.U. eingebunden. Sollte man also in den Fall rennen, kann man den
`vendor`-Ordner in diesem Addon einfach löschen, sofern vorhanden. Wenn er nicht vorhanden ist, so war ich auch nicht
der Übeltäter ;-)
Mit der Verison 1.0-Beta7 habe ich Code-Anlayse-Tools, wie z.B. `PHPUnit` eingebaut. Dafür schein es am Einfachsten zu
sein, eine `composer.json` zu erstellen und die Hilfsprogramme ins Projekt zu installieren. Leider kann durch den
AutoLoader im Redaxo-Core aber dazu kommen, dass sich die Seite in einen Timeout läuft. Es werden alle Dateien - auch
die in `vendor`-Ordnern - analysiert und u.U. eingebunden. Sollte man also in den Fall rennen, kann man den `vendor`-
Ordner in diesem Addon einfach löschen, sofern vorhanden. Wenn er nicht vorhanden ist, so war ich auch nicht der
Übeltäter ;-)

Am Besten führt man die Tests komplett separat durch. Generell sind sie eh nur für mich, um ungenutzten Code bzw.
(SQL-)Fehler zu finden.
Expand Down
48 changes: 21 additions & 27 deletions README_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,46 +2,40 @@

This addon searches for pictures, modules and templates that are not used anymore.

With realase of Version 2.0 the support for Redaxo 4 will be dropped due to (for me, onreproducable) encoding problems
on some Redaxo 5 instances.

## Installation

All files are directly included and can be moved to
`redaxo/inlcude/addons/usage_check` (using Redaxo 4.x) or
`redaxo/src/addons/usage_check` (using Redaxo 5.x)
###Standard installation
Usually this addon can be installed through the addon installer located in the redaxo backend.

###Manual installtion
If you want to test some beta functionality, it can be necessary to install this addon manually.

Installation instructions:

All files are directly included and can be moved to `redaxo/src/addons/usage_check`

The directory itself (`usage_check`) is not included.
Why? If you like, you can check out this repository to the right directory. This
would be impossible, if I included the `usage_check` folder.

You can also download the ZIP archive from here. The unzipped files can be moved
to the right destination depending on your Redaxo copy version.
You can also download the ZIP archive from here. The unzipped files can be moved to the right destination depending on
your Redaxo copy version.

After copying the files you'll need to install and activate this addon using
the Redaxo backend.
After copying the files you'll need to install and activate this addon using the Redaxo backend.

## Compatibility
- PHP version: __5.3.2__ or later
- tested on Redaxo versions __4.3.2__, __4.4.1__, __4.5__, __4.6.1__, __4.7__, __5.0.1__, __5.1__, __5.2__

This addon works with Redaxo 4 and Redaxo 5

##Language file notice

The folder `usage_check/lang` needs writing rights for your PHP / Apache user.

Reason: I'm using `de_de_utf8.lang` and `en_gb_utf8.lang` only.

Redaxo usually needs the language files `de_de.lang` and `en_gb.lang`.
Redaxo 4 needs these files in __ISO-8859-1__, Redaxo 5 in __UTF-8__. So I
decided to use the old `xx_yy_utf8.lang` files as these are always UTF-8.
These have to be converted according to the used Redaxo version. That's why it
needs writing rights.
- PHP version: __5.6.11__ or later
- tested on Redaxo versions __5.0.1__, __5.1__, __5.2__, __5.3__, __5.4__, __5.5__

##Notice on code-analyzing tools
As of version 1.0-Beta7, I'm using some code analyzing tools such as `PHPUnit`.
It seems to be the easiest way to write a `composer.json` and install these tools into the project. I didn't notice
the redaxo Autoloader. It analyzes all PHP-Files, including `vendor`-directories. So, it's possible for the page to
run into a timeout. In this case, simply you can simply delete the `vendor`-directory in this addon. If it's not
present, it wasn't me, who killed your page ;-)
It seems to be the easiest way to write a `composer.json` and install these tools into the project. I didn't notice the
redaxo Autoloader. It analyzes all PHP-Files, including `vendor`-directories. So, it's possible for the page to run into
a timeout. In this case, simply you can simply delete the `vendor`-directory in this addon. If it's not present, it
wasn't me, who killed your page ;-)

The best way of testing: just do it seperatly from your redaxo installation. Basicly, these tests are ment for me. Just
to find unused code or (SQL-)Erros.
2 changes: 1 addition & 1 deletion akrys/redaxo/addon/UsageCheck/Config.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class Config
*
* @var string
*/
const VERSION = '1.0';
const VERSION = '2.0';

/**
* release state
Expand Down
133 changes: 0 additions & 133 deletions akrys/redaxo/addon/UsageCheck/LangFile.php

This file was deleted.

3 changes: 0 additions & 3 deletions akrys/redaxo/addon/UsageCheck/Modules/Actions.php
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,6 @@ public static function create()
{
$object = null;
switch (RedaxoCall::getRedaxoVersion()) {
case RedaxoCall::REDAXO_VERSION_4:
$object = new \akrys\redaxo\addon\UsageCheck\RexV4\Modules\Actions();
break;
case RedaxoCall::REDAXO_VERSION_5:
$object = new \akrys\redaxo\addon\UsageCheck\RexV5\Modules\Actions();
break;
Expand Down
3 changes: 0 additions & 3 deletions akrys/redaxo/addon/UsageCheck/Modules/Modules.php
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,6 @@ public static function create()
{
$object = null;
switch (RedaxoCall::getRedaxoVersion()) {
case RedaxoCall::REDAXO_VERSION_4:
$object = new \akrys\redaxo\addon\UsageCheck\RexV4\Modules\Modules();
break;
case RedaxoCall::REDAXO_VERSION_5:
$object = new \akrys\redaxo\addon\UsageCheck\RexV5\Modules\Modules();
break;
Expand Down
22 changes: 9 additions & 13 deletions akrys/redaxo/addon/UsageCheck/Modules/Pictures.php
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<?php

/**
* Datei für Medienmodul
*
Expand Down Expand Up @@ -33,9 +34,6 @@ public static function create()
{
$object = null;
switch (RedaxoCall::getRedaxoVersion()) {
case RedaxoCall::REDAXO_VERSION_4:
$object = new \akrys\redaxo\addon\UsageCheck\RexV4\Modules\Pictures();
break;
case RedaxoCall::REDAXO_VERSION_5:
$object = new \akrys\redaxo\addon\UsageCheck\RexV5\Modules\Pictures();
break;
Expand Down Expand Up @@ -337,15 +335,13 @@ abstract public function getMeuLink($subpage, $showAllParam);
public function outputMenu($subpage, $showAllParam, $showAllLinktext)
{
$url = $this->getMeuLink($subpage, $showAllParam);

$text = \akrys\redaxo\addon\UsageCheck\RedaxoCall::getAPI()->getI18N('akrys_usagecheck_images_intro_text');
?>

<p class="rex-tx1">
<a href="<?php echo $url; ?>"><?php echo $showAllLinktext; ?></a>
</p>
<p class="rex-tx1"><?php echo $text ?></p>

<?php
$menu = new \rex_fragment([
'url' => $url,
'linktext' => $showAllLinktext,
'texts' => [
\akrys\redaxo\addon\UsageCheck\RedaxoCall::getAPI()->getI18N('akrys_usagecheck_images_intro_text'),
],
]);
return $menu->parse('fragments/menu/linktext.php');
}
}
8 changes: 0 additions & 8 deletions akrys/redaxo/addon/UsageCheck/Modules/Templates.php
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,6 @@ public static function create()
{
$object = null;
switch (RedaxoCall::getRedaxoVersion()) {
case RedaxoCall::REDAXO_VERSION_4:
$object = new \akrys\redaxo\addon\UsageCheck\RexV4\Modules\Templates();
break;
case RedaxoCall::REDAXO_VERSION_5:
$object = new \akrys\redaxo\addon\UsageCheck\RexV5\Modules\Templates();
break;
Expand Down Expand Up @@ -94,11 +91,6 @@ public function getTemplates()
//Parameter-Korrektur, wenn der User KEIN Admin ist
//Der darf die inaktiven Templats nämlich sowieso nicht sehen.
switch (RedaxoCall::getRedaxoVersion()) {
case RedaxoCall::REDAXO_VERSION_4:
if (!$GLOBALS['REX']['USER']->isAdmin() && $showInactive === true) {
$showInactive = false;
}
break;
case RedaxoCall::REDAXO_VERSION_5:
$user = \rex::getUser();
if (!$user->isAdmin() && $showInactive === true) {
Expand Down
4 changes: 0 additions & 4 deletions akrys/redaxo/addon/UsageCheck/Permission.php
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,6 @@ public static function getVersion()
{
if (!isset(self::$api)) {
switch (\akrys\redaxo\addon\UsageCheck\RedaxoCall::getRedaxoVersion()) {
case \akrys\redaxo\addon\UsageCheck\RedaxoCall::REDAXO_VERSION_4:
// Redaxo 4
self::$api = new RexV4\Permission();
break;
case \akrys\redaxo\addon\UsageCheck\RedaxoCall::REDAXO_VERSION_5:
// Redaxo 5
self::$api = new RexV5\Permission();
Expand Down
Loading

0 comments on commit f091360

Please sign in to comment.