ilCountPDFPages Class Reference

Class ilCountPDFPages. More...

Collaboration diagram for ilCountPDFPages:

Public Member Functions
	__construct ()
	isAvailable ()
	extractAmountOfPagesByRID (ResourceIdentification $rid)
	extractAmountOfPagesByPath (string $path_to_pdf)

Private Attributes
Services	$irss
	@readonly More...
bool	$postscript_available = false
bool	$imagick_available = false

Detailed Description

Class ilCountPDFPages.

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 29 of file class.ilCountPDFPages.php.

Constructor & Destructor Documentation

__construct()

ilCountPDFPages::__construct

(

)

Definition at line 38 of file class.ilCountPDFPages.php.

    {
        global $DIC;
        $this->irss = $DIC->resourceStorage();
        $this->postscript_available = (defined('PATH_TO_GHOSTSCRIPT') && PATH_TO_GHOSTSCRIPT !== "");
        $this->imagick_available = class_exists('Imagick');
    }

References $DIC.

Member Function Documentation

extractAmountOfPagesByPath()

ilCountPDFPages::extractAmountOfPagesByPath

(

string

$path_to_pdf

)

Definition at line 69 of file class.ilCountPDFPages.php.

                                                                   : ?int
    {
        if (!$this->postscript_available && !$this->imagick_available) {
            return null;
        }
 
        // first we try using Imagick
        if ($this->imagick_available) {
            $pages = null;
            try {
                $imagick = new Imagick();
                $imagick->pingImage($path_to_pdf);
 
                return $imagick->getNumberImages();
            } catch (Throwable) {
                // Imagick is not available or another error occured
            }
        }
 
        if ($this->postscript_available) {
            $arg = "-q -dNODISPLAY -dNOSAFER -c \"($path_to_pdf) (r) file runpdfbegin pdfpagecount = quit\";";
            $return = ilShellUtil::execQuoted(PATH_TO_GHOSTSCRIPT, $arg);
            if (!isset($return[0]) || ($pages = (int) $return[0]) === 0) {
                return null;
            }
 
            return $pages;
        }
 
        return null;
    }

References ilShellUtil\execQuoted().

Referenced by extractAmountOfPagesByRID().

Here is the call graph for this function:

Here is the caller graph for this function:

extractAmountOfPagesByRID()

ilCountPDFPages::extractAmountOfPagesByRID

(

ResourceIdentification

$rid

)

Definition at line 51 of file class.ilCountPDFPages.php.

                                                                          : ?int
    {
        // the same condition as in isAvailable() and extractAmountOfPagesByPath():
        // asking for Ghostscript alone skipped the page count on every installation
        // that only has Imagick, see https://mantis.ilias.de/view.php?id=47827
        if (!$this->postscript_available && !$this->imagick_available) {
            return null;
        }
        $revision = $this->irss->manage()->getCurrentRevision($rid);
        $info = $revision->getInformation();
        if ($info->getMimeType() !== MimeType::APPLICATION__PDF) {
            return null;
        }
        $consumer = $this->irss->consume()->stream($rid);
        $path_to_pdf = $consumer->getStream()->getMetadata('uri');
        return $this->extractAmountOfPagesByPath($path_to_pdf);
    }

References $info, and extractAmountOfPagesByPath().

Here is the call graph for this function:

isAvailable()

ilCountPDFPages::isAvailable

(

)

Definition at line 46 of file class.ilCountPDFPages.php.

                                 : bool
    {
        return $this->postscript_available || $this->imagick_available;
    }

References $imagick_available.

Field Documentation

$imagick_available

bool ilCountPDFPages::$imagick_available = false

private

Definition at line 36 of file class.ilCountPDFPages.php.

Referenced by isAvailable().

$irss

Services ilCountPDFPages::$irss

private

@readonly

Definition at line 34 of file class.ilCountPDFPages.php.

$postscript_available

bool ilCountPDFPages::$postscript_available = false

private

Definition at line 35 of file class.ilCountPDFPages.php.

---

The documentation for this class was generated from the following file:

• components/ILIAS/File/classes/PreProcessors/class.ilCountPDFPages.php