tonyair/silverstripe-textextraction
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-textextraction synced 2024-10-22 11:06:00 +02:00
Code Issues Projects Releases Wiki Activity
101 Commits 17 Branches 34 Tags 396 KiB
PHP 98.7%
Shell 1.3%
d06569c8fd
Go to file
Dylan Wagstaff d06569c8fd Add supported module badge to readme
2018-06-15 17:50:30 +12:00
_config FIX: First-pass SS4 compatibility. 2017-12-21 10:41:06 +13:00
.travis Move to new travis containerised infrastructure 2015-08-25 15:28:20 +01:00
docs/en DOCS Add Windows note back into Configuration guide, bump license year 2017-11-23 09:49:05 +13:00
src FIX: Updated namespace refs for GuzzleHttp (from Guzzle\Http) 2017-12-22 14:34:40 +13:00
tests FIX: First-pass SS4 compatibility. 2017-12-21 10:41:06 +13:00
_config.php Initial commit 2012-08-22 17:52:08 +02: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 Merge pull request #19 from camfindlay/feature/make-supported 2017-11-23 09:39:34 +13:00
CHANGELOG.md Add supported module standard docs 2015-11-07 14:06:23 +13:00
code-of-conduct.md Added standard code of conduct 2015-11-21 20:17:44 +13:00
composer.json Update dependency constraints in composer.json 2018-02-02 12:52:19 +13:00
CONTRIBUTING.md Add supported module standard docs 2015-11-07 14:06:23 +13:00
license.md DOCS Add Windows note back into Configuration guide, bump license year 2017-11-23 09:49:05 +13:00
README.md Add supported module badge to readme 2018-06-15 17:50:30 +12:00

README.md

Text extraction module

Build Status SilverStripe supported module 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.