-
-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
nicolaasuni
committed
May 11, 2015
0 parents
commit 507a109
Showing
27 changed files
with
6,787 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
vendor | ||
target | ||
phpunit.xml | ||
**/.DS_Store | ||
**/.vagrant |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,114 @@ | ||
# tc-lib-pdf-parser | ||
|
||
*Please consider supporting this project by making a donation to <[email protected]>* | ||
|
||
* **category** Library | ||
* **package** \Com\Tecnick\Pdf\Parser | ||
* **author** Nicola Asuni <[email protected]> | ||
* **copyright** 2015-2015 Nicola Asuni - Tecnick.com LTD | ||
* **license** http://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT) | ||
* **link** https://github.com/tecnickcom/tc-lib-pdf-parser | ||
|
||
## Description | ||
|
||
PHP library to parse PDF documents. | ||
|
||
The initial source code has been extracted from TCPDF (<http://www.tcpdf.org>). | ||
|
||
|
||
## Getting started | ||
|
||
First, you need to install all development dependencies using [Composer](https://getcomposer.org/): | ||
|
||
```bash | ||
$ curl -sS https://getcomposer.org/installer | php | ||
$ mv composer.phar /usr/local/bin/composer | ||
``` | ||
|
||
This project include a Makefile that allows you to test and build the project with simple commands. | ||
To see all available options: | ||
|
||
```bash | ||
make help | ||
``` | ||
|
||
To install all the development dependencies: | ||
|
||
```bash | ||
make build_dev | ||
``` | ||
|
||
## Running all tests | ||
|
||
Before committing the code, please check if it passes all tests using | ||
|
||
```bash | ||
make qa_all | ||
``` | ||
this generates the phpunit coverage report in target/coverage. | ||
Please check if the tests are covering all code. | ||
|
||
Generate the documentation: | ||
|
||
```bash | ||
make docs | ||
``` | ||
|
||
Generate static analysis reports in target/report: | ||
|
||
```bash | ||
make reports | ||
``` | ||
|
||
Other make options allows you to install this library globally and build an RPM package. | ||
Please check all the available options using `make help`. | ||
|
||
|
||
## Example | ||
|
||
Examples are located in the `example` directory. | ||
|
||
Start a development server (requires PHP 5.5) using the command: | ||
|
||
``` | ||
make server | ||
``` | ||
|
||
and point your browser to <http://localhost:8000/index.php> | ||
|
||
|
||
## Installation | ||
|
||
Create a composer.json in your projects root-directory: | ||
|
||
```json | ||
{ | ||
"require": { | ||
"tecnick.com/tc-lib-pdf-parser": "dev-master" | ||
}, | ||
"repositories": [ | ||
{ | ||
"type": "vcs", | ||
"url": "[email protected]:tecnickcom/tc-lib-pdf-parser.git" | ||
} | ||
] | ||
} | ||
``` | ||
|
||
|
||
## Packaging | ||
|
||
This library is mainly intended to be used and included in other PHP projects using Composer. | ||
However, since some production environments dictates the installation of any application as RPM or DEB packages, | ||
this library includes make targets for building these packages (`make rpm` and `make deb`). | ||
The packages are generated under the `target` directory. | ||
|
||
When this library is installed using an RPM or DEB package, you can use it your code by including the autoloader: | ||
``` | ||
require_once ('/usr/share/php/Com/Tecnick/Pdf/Parser/autoload.php'); | ||
``` | ||
|
||
|
||
## Developer(s) Contact | ||
|
||
* Nicola Asuni <[email protected]> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
2.0.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
{ | ||
"name": "tecnick.com/tc-lib-pdf-parser", | ||
"description": "PHP library to parse PDF documents", | ||
"type": "library", | ||
"homepage": "http://www.tecnick.com", | ||
"license": "GNU-LGPL v3", | ||
"keywords": ["tc-lib-pdf-parser", "PDF", "parser", "document"], | ||
"authors": [ | ||
{ | ||
"name": "Nicola Asuni", | ||
"email": "[email protected]", | ||
"role": "lead" | ||
} | ||
], | ||
"require": { | ||
"php": ">=5.3.3", | ||
"tecnick.com/tc-lib-pdf-filter": "dev-master" | ||
}, | ||
"require-dev": { | ||
"phpunit/phpunit": "dev-master", | ||
"pdepend/pdepend" : "2.0.*", | ||
"squizlabs/php_codesniffer": "2.3.*", | ||
"phpmd/phpmd" : "2.2.*", | ||
"sebastian/phpcpd" : "2.0.*", | ||
"phploc/phploc" : "2.0.*", | ||
"phpdocumentor/phpdocumentor" : "2.5.0" | ||
}, | ||
"autoload": { | ||
"psr-4":{ | ||
"Com\\Tecnick\\Pdf\\Parser\\": "src" | ||
} | ||
}, | ||
"repositories": [ | ||
{ | ||
"type": "vcs", | ||
"url": "[email protected]:tecnickcom/tc-lib-pdf-filter.git" | ||
} | ||
] | ||
} |
Oops, something went wrong.