tonyair
/
silverstripe-textextraction
mirror of https://github.com/silverstripe/silverstripe-textextraction
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
99 Commits 17 Branches 33 Tags 347 KiB
PHP 98.7%
Shell 1.3%
Go to file
Robbie Averill ecbf190577 Remove obsolete branch alias 2019-04-12 15:17:01 +12:00
.travis Move to new travis containerised infrastructure 2015-08-25 15:28:20 +01:00
_config FIX UnexpectedValueException thrown when trying to set SolrCellTextExtraction.base_url in config 2016-10-03 20:19:30 +01:00
code MINOR: module support for Silverstripe 3.7 2019-04-12 15:11:35 +12:00
docs/en DOCS Add Windows note back into Configuration guide, bump license year 2017-11-23 09:49:05 +13:00
tests MINOR: module support for Silverstripe 3.7 2019-04-12 15:11:35 +12:00
.editorconfig Added standard editor config 2015-11-19 13:27:10 +13:00
.gitattributes Added standard git attributes 2015-11-19 19:14:04 +13:00
.scrutinizer.yml Added standard Scrutinizer config 2015-11-18 15:38:01 +13:00
.travis.yml MINOR: module support for Silverstripe 3.7 2019-04-12 15:11:35 +12:00
CHANGELOG.md Add supported module standard docs 2015-11-07 14:06:23 +13:00
CONTRIBUTING.md Add supported module standard docs 2015-11-07 14:06:23 +13:00
README.md DOCS Add note to readme about version support for SilverStripe core releases 2019-04-12 15:16:31 +12:00
code-of-conduct.md Added standard code of conduct 2015-11-21 20:17:44 +13:00
composer.json Remove obsolete branch alias 2019-04-12 15:17:01 +12:00
license.md DOCS Add Windows note back into Configuration guide, bump license year 2017-11-23 09:49:05 +13:00

README.md

Text extraction module

Build Status Code Quality Version License

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.