ahmadrosid / php-pdf

PHP Extension to read pdf file with mupdf.

PHP Pdf reader

PHP Extension for reading pdf document written in Rust. This extension is using mupdf-rs to parsing the pdf file.

Build

Before you build install this package on linux:

sudo apt install software-properties-common libfontconfig1-dev mupdf-tools gperf clang php8.1-dev build-essential autoconf unzip

Or for other linux distribution:

• Alpine Linux: fontconfig-dev
• Arch Linux: fontconfig
• Debian-based systems: libfontconfig1-dev
• FreeBSD: fontconfig
• Void Linux: fontconfig-devel

Run this command to build debug version (this example for MacOS):

cargo build
cp target/debug/libphp_pdf.dylib target/debug/libphp_pdf.so

Or you can use this bash script (MacOS).

bash build.sh

Then you can use the debug version using this command.

php -d "extension=target/debug/libphp_pdf.so" test.php

Release build

Download from CDN:

wget https://blob-drop.netlify.app/libphp_pdf.so

To build production release.

cargo build --release
cp target/release/libphp_pdf.dylib target/release/libphp_pdf.so # Only for macos

Then copy the extension to your extension dir for example here is my directory extension /opt/homebrew/lib/php/pecl/20210902, you can find the extension directory by runnig this command.

php -i | grep extension_dir
#or
pecl config-get ext_dir

Then copy to that extension directory, you can get the directory location by running this command pecl config-get ext_dir:

cp target/release/libphp_pdf.so /opt/homebrew/lib/php/pecl/20210902

or

cp target/release/libphp_pdf.so  $(pecl config-get ext_dir)/libphp_pdf.so

Enable extension config ono php.ini:

extension=/opt/homebrew/lib/php/pecl/20210902/libphp_pdf.so

And now you are ready to go.

Usage

Download example pdf document:

wget --user-agent="Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9.0.3) Gecko/2008092416 Firefox/3.0.3"  https://arxiv.org/pdf/2303.12712.pdf

Get page size:

$size = php_pdf_get_page_size('2303.12712.pdf');
echo $size;

Read all document page texts.

$texts = php_pdf_read_all('2303.12712.pdf');

foreach ($texts as $text) {
    echo $text;
}

Read document page by the page number.

$text = php_pdf_read_page('2303.12712.pdf', 100);
echo $text;