tonyair
/
silverstripe-textextraction
mirror of https://github.com/silverstripe/silverstripe-textextraction
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
190 Commits 17 Branches 33 Tags 344 KiB
PHP 98.7%
Shell 1.3%
Go to file
Guy Sartorelli e04501cb52
Merge branch '3.5' into 3 		2023-04-26 12:49:10 +12:00
.github/workflows MNT Use gha-dispatch-ci 2023-03-21 13:42:30 +13:00
.travis Move to new travis containerised infrastructure 2015-08-25 15:28:20 +01:00
_config API FileTextExtractable::getContent now takes a File instance instead of a path 2018-07-03 15:55:02 +12:00
docs/en DOCS Fix class reference for cache class 2022-03-07 11:20:01 +13:00
src API Stop using deprecated API 2022-11-28 19:20:01 +13:00
tests API phpunit 9 support 2021-10-27 18:16:05 +13:00
.editorconfig Added standard editor config 2015-11-19 13:27:10 +13:00
.gitattributes Update gitattributes and Scrutinizer configuration 2018-07-03 11:36:04 +12:00
.upgrade.yml API Update namespaces for FileTextCache and add upgrader mapping 2018-07-03 11:23:27 +12:00
CONTRIBUTING.md Add supported module standard docs 2015-11-07 14:06:23 +13:00
README.md MNT Standardise modules 2022-08-01 16:23:36 +12:00
code-of-conduct.md Added standard code of conduct 2015-11-21 20:17:44 +13:00
codecov.yml Add phpunit/phpcs configuration and update Travis configuration 2018-07-03 11:35:52 +12:00
composer.json MNT Revert erroneous dependency changes 2023-03-28 14:55:48 +13:00
license.md Bump license year 2018-07-03 10:48:02 +12:00
phpcs.xml.dist MNT Travis shared config 2021-01-20 14:49:58 +13:00
phpunit.xml.dist MNT Standardise modules 2022-08-01 16:23:36 +12:00

README.md

Text extraction module

CI Silverstripe supported module

Provides a text extraction API for file content, that can hook into different extractor engines based on availability and the parsed file format. The output returned is always a string of the file content.

Via the FileTextExtractable extension, this logic can be used to cache the extracted content on a DataObject subclass (usually File).

The module supports text extraction on the following file formats:

  • HTML (built-in)
  • PDF (with XPDF or Solr)
  • Microsoft Word, Excel, Powerpoint (Solr)
  • OpenOffice (Solr)
  • CSV (Solr)
  • RTF (Solr)
  • EPub (Solr)
  • Many others (Tika)

Requirements

Installation

composer require silverstripe/textextraction

The module depends on the Guzzle HTTP Library, which is automatically checked out by composer. Alternatively, install Guzzle through PEAR and ensure its in your include_path.

Documentation

Bugtracker

Bugs are tracked in the issues section of this repository. Before submitting an issue please read over existing issues to ensure yours is unique.

If the issue does look like a new bug:

  • Create a new issue
  • Describe the steps required to reproduce your issue, and the expected outcome. Unit tests, screenshots and screencasts can help here.
  • Describe your environment as detailed as possible: Silverstripe version, Browser, PHP version, Operating System, any installed Silverstripe modules.

Please report security issues to security@silverstripe.org directly. Please don't file security issues in the bugtracker.

Development and contribution

If you would like to make contributions to the module please ensure you raise a pull request and discuss with the module maintainers.