vendor/pimcore/pimcore/models/Asset/Document.php line 25

Open in your IDE?
  1. <?php
  3. /**
  4.  * Pimcore
  5.  *
  6.  * This source file is available under two different licenses:
  7.  * - GNU General Public License version 3 (GPLv3)
  8.  * - Pimcore Commercial License (PCL)
  9.  * Full copyright and license information is available in
  10.  * LICENSE.md which is distributed with this source code.
  11.  *
  12.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  14.  */
  16. namespace Pimcore\Model\Asset;
  18. use Pimcore\Cache;
  19. use Pimcore\Logger;
  20. use Pimcore\Model;
  22. /**
  23.  * @method \Pimcore\Model\Asset\Dao getDao()
  24.  */
  25. class Document extends Model\Asset
  26. {
  27.     /**
  28.      * {@inheritdoc}
  29.      */
  30.     protected $type = 'document';
  32.     /**
  33.      * {@inheritdoc}
  34.      */
  35.     protected function update($params = [])
  36.     {
  37.         if ($this->getDataChanged()) {
  38.             $this->removeCustomSetting('document_page_count');
  39.         }
  41.         parent::update($params);
  43.         if ($params['isUpdate']) {
  44.             $this->clearThumbnails();
  45.         }
  46.     }
  48.     /**
  49.      * @internal
  50.      *
  51.      * @param string|null $path
  52.      */
  53.     public function processPageCount($path = null)
  54.     {
  55.         $pageCount = null;
  56.         if (!\Pimcore\Document::isAvailable()) {
  57.             Logger::error("Couldn't create image-thumbnail of document " . $this->getRealFullPath() . ' no document adapter is available');
  59.             return;
  60.         }
  62.         try {
  63.             $converter = \Pimcore\Document::getInstance();
  64.             $converter->load($this);
  66.             // read from blob here, because in $this->update() (see above) $this->getFileSystemPath() contains the old data
  67.             $pageCount = $converter->getPageCount();
  68.             $this->setCustomSetting('document_page_count', $pageCount);
  69.         } catch (\Exception $e) {
  70.             Logger::error((string) $e);
  71.             $this->setCustomSetting('document_page_count', 'failed');
  72.         }
  73.     }
  75.     /**
  76.      * returns null when page count wasn't processed yet (done asynchronously)
  77.      *
  78.      * @return int|null
  79.      */
  80.     public function getPageCount()
  81.     {
  82.         return $this->getCustomSetting('document_page_count');
  83.     }
  85.     /**
  86.      * @param string|array|Image\Thumbnail\Config $thumbnailName
  87.      * @param int $page
  88.      * @param bool $deferred $deferred deferred means that the image will be generated on-the-fly (details see below)
  89.      *
  90.      * @return Document\ImageThumbnail
  91.      */
  92.     public function getImageThumbnail($thumbnailName, $page = 1, $deferred = false)
  93.     {
  94.         if (!\Pimcore\Document::isAvailable()) {
  95.             Logger::error("Couldn't create image-thumbnail of document " . $this->getRealFullPath() . ' no document adapter is available');
  97.             return new Document\ImageThumbnail(null);
  98.         }
  100.         if (!$this->getCustomSetting('document_page_count')) {
  101.             Logger::info('Image thumbnail not yet available, processing is done asynchronously.');
  102.             $this->addToUpdateTaskQueue();
  104.             return new Document\ImageThumbnail(null);
  105.         }
  107.         return new Document\ImageThumbnail($this, $thumbnailName, $page, $deferred);
  108.     }
  110.     /**
  111.      * @param int|null $page
  112.      *
  113.      * @return string|null
  114.      */
  115.     public function getText($page = null)
  116.     {
  117.         if (\Pimcore\Document::isAvailable() && \Pimcore\Document::isFileTypeSupported($this->getFilename())) {
  118.             if ($this->getCustomSetting('document_page_count')) {
  119.                 $cacheKey = 'asset_document_text_' . $this->getId() . '_' . ($page ? $page : 'all');
  120.                 if (!$text = Cache::load($cacheKey)) {
  121.                     $document = \Pimcore\Document::getInstance();
  122.                     $text = $document->getText($page, $this);
  123.                     Cache::save($text, $cacheKey, $this->getCacheTags(), null, 99, true); // force cache write
  124.                 }
  126.                 return $text;
  127.             } else {
  128.                 Logger::info('Unable to fetch text of ' . $this->getRealFullPath() . ' as it was not processed yet by the maintenance script');
  129.             }
  130.         } else {
  131.             Logger::warning("Couldn't get text out of document " . $this->getRealFullPath() . ' no document adapter is available');
  132.         }
  134.         return null;
  135.     }
  136. }