Path

ez projects / ezpliteralobjectsreport


eZp Literal Objects Report

UNIX name Owner Status Version Compatible with
ezpliteralobjectsreport Brookins Consulting stable 0.1.2 4.x (required) or higher. 4.6.x+ (Community Build, 2011.11+) is recommended
eZp Literal Object CSV Report is a true eZ Publish cli script that provides commandline script to find orphaned image objects and generate a csv report

Version

  • The current version of eZp Literal Objects Report is 0.1.0

Copyright

  • eZp Literal Objects Report is copyright 1999 - 2017 Brookins Consulting and Think Creative
  • See: doc/COPYRIGHT for more information on the terms of the copyright and license

License

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

The complete license agreement is included in the LICENSE file.

eZp Literal Objects Report is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as published by the Free Software Foundation.

eZp Literal 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 Literal Objects Report under certain conditions. The GNU GPL license is distributed with the software, see the file 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 Literal Objects Report in LICENSE. If not, see http://www.gnu.org/licenses/.

Using eZp Literal 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 Literal Objects Report:

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.

PHP version

  • Make sure you have PHP 5.x or higher.

Features

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/literalCsvReport;
# Assign proper permissions for report directory to be stored after generation
sudo chmod -R 777 var/literalCsvReport;
sudo chown -R _www:_www var/literalCsvReport;
# Run the script to generate the report
php ./extension/ezpezpliteralobjectsreport/bin/php/ezpezpliteralobjectsreport.php
--storage-dir=var/literalCsvReport --hostname=www.example.com
# Review generated report in open office as a spreadsheet:
less var/literalCsvReport/ezpezpliteralobjectsreport.csv

Usage - Cronjob

# Change directory into eZ Publish website document root:
cd path/to/ezpublish/docroot;
# Create settings override
cp -va extension/ezpliteralobjectsreport/settings/ezpliteralobjectsreport.ini.append.php settings/override/ezpliteralobjectsreport.ini.append.php
# Populate ini settings: SiteHostname and ReportStoragePath
emacs settings/override/ezpliteralobjectsreport.ini.append.php
# Create directory for report to be stored after generation
mkdir var/literalCsvReport;
# Assign proper permissions for report directory to be stored after generation
sudo chmod -R 777 var/literalCsvReport;
sudo chown -R _www:_www var/literalCsvReport;
# Run the cronjob manually to generate the report
php ./runcronjobs.php ezpliteralobjectsreportgenerate
# Review generated report in open office as a spreadsheet:
less var/literalCsvReport/ezpezpliteralobjectsreport.csv

Usage - Module

# The module view is optional

# The module view can be used for simple regeneration of report and downloading of report
# Access the module view using the following uri
http://admin.example.com/literalreport/report

Troubleshooting

Read the FAQ

Some problems are more common than others. The most common ones are listed in the the doc/FAQ.md

Support

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

No news yet.

This project has no reviews yet. Be the first one to review it!

No forum messages yet.