ezporphanedimageobjectsreport

eZp Orphaned Image Objects Report script README

What is the eZp Orphaned Image Objects Report extension?

eZp Orphaned Image Objects Report is a true eZ Publish cli script
that provides commandline script to find orphaned image objects
and generate a csv report.

eZp Orphaned Image Objects Report version

The current version of eZp Orphaned Image Objects Report is 0.11.0
Last Major update: May 19, 2013

Copyright

eZp Orphaned Image Objects Report is copyright 1999-2012 Brookins Consulting and Think Creative

See: doc/COPYRIGHT for more information on the terms of the copyright and license

License

eZp Orphaned Image Objects Report is licensed under the GNU General Public License.

The complete license agreement is included in the doc/LICENSE file.

eZp Orphaned Image Objects Report is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.

eZp Orphaned Image Objects Report is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

The GNU GPL gives you the right to use, modify and redistribute
eZp Orphaned Image Objects Report under certain conditions. The GNU GPL license
is distributed with the software, see the file doc/LICENSE.

It is also available at http://www.gnu.org/licenses/gpl.txt

You should have received a copy of the GNU General Public License
along with eZp Orphaned Image Objects Report in doc/LICENSE. If not, see http://www.gnu.org/licenses/.

Using eZp Orphaned Image Objects Report under the terms of the GNU GPL is free (as in freedom).

For more information or questions please contact
license@brookinsconsulting.com

Requirements

The following requirements exists for using eZp Orphaned Image Objects Report extension:

o eZ Publish version:

Make sure you use eZ Publish version 4.x (required) or higher. eZ Publish 4.6.x+ (Community Build, 2011.11+) is recommended.

o PHP version:

Make sure you have PHP 5.x or higher.

Usage - Command line script

Change directory into eZ Publish website document root:

cd path/to/ezpublish/docroot;

Create directory for report to be stored after generation

mkdir var/orphanedCsvReport;

Warning: script may consume larger than expected amounts of memory durring execution

Run the script to generate the report

php -d memory_limit=-1 ./extension/fsu/bin/php/ezporphanedimageobjectsreport.php
--storage-dir=var/orphanedImageObjectsReport --hostname=www.example.com --nodeid=43

Review generated report in open office as a spreadsheet:

less var/orphanedCsvReport/orphanedCsvReport.csv

Usage - Cronjob

Change directory into eZ Publish website document root:

cd path/to/ezpublish/docroot;

Run the cronjob manually to check links

php ./runcronjobs.php ezporphanedimageobjectsreportgenerate

Usage - Module

Click the new "Image Report" menu tab and follow the instructions on the page.

http://admin.example.com/orphanedimageobjects/report

Troubleshooting

1. Some problems are more common than others. The most common ones
   are listed in the the doc/FAQ.
2. If you have find any problems not handled by this document or the FAQ you
   can contact Brookins Consulting through the support system:
   http://brookinsconsulting.com/contact