Download the PHP package se7enxweb/bccie without Composer

On this page you can find all versions of the php package se7enxweb/bccie. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package bccie

BC CIE: collected information export for Exponential

BC CIE exports the information that the forms of an Exponential site collect (contact forms, polls, sign-up and feedback forms: any content object with information-collector fields) to CSV or SYLK files that open in Excel, LibreOffice Calc or Numbers. It is for site administrators and editors who need the submissions of a form as a spreadsheet, and for developers who want the same export from the console or from cron.

What you get:

Requirements

Installation

With Composer

From the root of your Exponential installation:

The legacy extension installer puts the files in extension/bccie.

By hand

Download a release from https://github.com/se7enxweb/bccie/releases (or git clone https://github.com/se7enxweb/bccie.git extension/bccie) and place it so that the files are in extension/bccie of your installation. The folder must be called bccie.

Then, either way

  1. Activate the extension in settings/override/site.ini.append.php:

  2. Regenerate the autoloads and clear the caches:

  3. Give the roles that should export the policy bccie/read (see Permissions). Administrators with all rights have it already.

The CIE tab now shows in the administration's top menu.

If one of your siteaccesses keeps its own menu.ini.append.php with a [TopAdminMenu] Tabs[] list, add Tabs[]=bccie_overview to it.

Usage

In the administration

  1. Click the CIE tab (/bccie/overview). The start page lists every form that has collected information, with the number of collections and the date of the last one, the last exports, and the problems found (for example a scheduled export without objects, or one that removes what it exported).
  2. Click a form (/bccie/export/<object id>). Choose:
    • Fields: the collection ID, each field of the form, and optionally the creation and modification dates. A field whose datatype has no export handler exports its stored text.
    • Date range: a start and an end date; empty dates mean no limit.
    • Export type: CSV or SYLK (Excel).
    • Character set: utf8 (default), utf8bom (Excel on Windows), utf16le (Excel on macOS) or cp1252.
    • Separation char for CSV: semicolon, comma, colon, pipe or hash.
  3. Click Do export. An export of up to DirectExportLimit collections (2000 by default) is downloaded at once. A larger one runs in the background: the page follows its progress (bccie/job) and offers the file for download (bccie/download) when it is done. Only the user who started an export can see its state and download its file, and only while that user can still read the form.
  4. A user with bccie/remove also sees Remove all collected information. It removes every collection of the form; the form itself stays. Export the data first.

You can also start from the kernel's Collected information pages: the overview has an Export link per form and the collection list of a form an Export Collection button; both open the same export page.

From the console

ext:bccie:export also takes --to=YYYY-MM-DD, --fields=contentobjectid,<attribute ids> (-1 adds an empty column, -2 skips one), --creation-date, --modification-date and --remove-exported. Every command lists its options with --help. Without ./console, run the scripts directly, for example php extension/bccie/bin/php/export.php --object=123.

Scheduled exports (cron)

The cronjob parts exportcsv and exportsylk export every object listed in [CieSettings] Collection[] to [CieSettings] Directory, the same as ./console ext:bccie:export --cron:

A crontab line that exports every night at 02:30:

The shell scripts in bin/ (runcronjobpart.sh, runcronjobpartcsv.sh, runcronjobpartsylk.sh) run a part by hand from the installation's root and write its output to var/log/cie.log.

Configuration

Copy the settings you want to change into settings/override/cie.ini.append.php (or a siteaccess's settings folder). The defaults are in extension/bccie/settings/cie.ini.append.php.

Datatypes and export handlers

export.ini lists the datatypes that are exported ([General] ExportableDatatypes[]) and, per datatype, the handler class that turns a value into a cell. The handlers are in extension/bccie/classes/handlers/. Supported out of the box: ezboolean, ezcountry, ezdate, ezdatetime, ezemail, ezenhancedobjectrelation, ezfloat, ezidentifier, ezinteger, ezobjectrelation, ezoption, ezselection, ezstring, eztext, eztime, ezurl, ezxmltext, and the third-party owenhancedselection, smileobjectrelationlist and ezbirthday. For the object relation datatypes, OutputRelatedObjectNames=false in their block exports the IDs instead of the names.

To export a datatype of your own, write a handler that extends BaseHandler (see ezexamplecustomhandler.php), put it in extension/bccie/classes/handlers/ or a folder below it:

and register it in settings/override/export.ini.append.php:

Character set handlers

A character set is a class named in ExportOutputFormatHandlers[] that extends bccieExportFormatOutputHandler; the four in classes/exportFormatOutputHandlers/ are examples.

Permissions

The module bccie has two functions (modules/bccie/module.php):

Function Allows
bccie/read The CIE tab, the overview, the export pages, background exports and their downloads
bccie/remove Removing the collected information of a form (with bccie/read)

The kernel's Collected information pages need infocollector/read, as before. The views are not open to anonymous users: settings/site.ini.append.php explains why its PolicyOmitList[] lines stay commented out.

Upgrading

Replace the files in extension/bccie (or run composer update se7enxweb/bccie), regenerate the autoloads and clear the caches as in Installation. Keep your changes in settings/override, never in the extension's own settings. The changes of each release are in doc/changelogs.

Known limits

Troubleshooting

Development and tests

The PHPUnit tests in tests/ read the sources and need neither a kernel nor a database. From the installation's root:

Issues and pull requests are welcome at https://github.com/se7enxweb/bccie.

License

GNU General Public License v2.0 or (at your option) any later version. See LICENSE and COPYRIGHT.md.

Credits and history

BC CIE was written in 2006 by Mathias Vitalis, inspired by the CSV export module of Gabriel Ambuehl, and was developed and maintained by Brookins Consulting for eZ Publish, the system Exponential grew out of, until 2017. 7x maintains it for Exponential. See doc/CREDITS.md.


All versions of bccie with dependencies

PHP Build Version
Package Version
Requires php Version >=8.0
se7enxweb/ezpublish-legacy-installer Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package se7enxweb/bccie contains the following files

Loading the files please wait ...