Alpha Framework 3.0.0 API Documentation
  • Namespace
  • Class

Namespaces

  • Alpha
    • Controller
      • Front
    • Exception
    • Model
      • Type
    • Task
    • Util
      • Backup
      • Cache
      • Code
        • Highlight
        • Metric
      • Config
      • Convertor
      • Email
      • Extension
      • Feed
      • File
      • Graph
      • Helper
      • Http
        • Filter
        • Session
      • Image
      • Logging
      • Search
      • Security
      • Service
    • View
      • Renderer
        • Html
        • Json
      • Widget

Classes

  • Alpha\Controller\ActiveRecordController
  • Alpha\Controller\ArticleController
  • Alpha\Controller\AttachmentController
  • Alpha\Controller\CacheController
  • Alpha\Controller\Controller
  • Alpha\Controller\DEnumController
  • Alpha\Controller\ExcelController
  • Alpha\Controller\FeedController
  • Alpha\Controller\Front\FrontController
  • Alpha\Controller\GenSecureQueryStringController
  • Alpha\Controller\ImageController
  • Alpha\Controller\IndexController
  • Alpha\Controller\InstallController
  • Alpha\Controller\ListActiveRecordsController
  • Alpha\Controller\LogController
  • Alpha\Controller\LoginController
  • Alpha\Controller\LogoutController
  • Alpha\Controller\MetricController
  • Alpha\Controller\PhpinfoController
  • Alpha\Controller\RecordSelectorController
  • Alpha\Controller\SearchController
  • Alpha\Controller\SequenceController
  • Alpha\Controller\TagController
  • Alpha\Model\ActionLog
  • Alpha\Model\ActiveRecord
  • Alpha\Model\ActiveRecordProviderMySQL
  • Alpha\Model\ActiveRecordProviderSQLite
  • Alpha\Model\Article
  • Alpha\Model\ArticleComment
  • Alpha\Model\ArticleVote
  • Alpha\Model\BadRequest
  • Alpha\Model\BlacklistedClient
  • Alpha\Model\BlacklistedIP
  • Alpha\Model\Person
  • Alpha\Model\Rights
  • Alpha\Model\Tag
  • Alpha\Model\Type\Boolean
  • Alpha\Model\Type\Date
  • Alpha\Model\Type\DEnum
  • Alpha\Model\Type\DEnumItem
  • Alpha\Model\Type\Double
  • Alpha\Model\Type\Enum
  • Alpha\Model\Type\Integer
  • Alpha\Model\Type\Relation
  • Alpha\Model\Type\RelationLookup
  • Alpha\Model\Type\Sequence
  • Alpha\Model\Type\SmallText
  • Alpha\Model\Type\Text
  • Alpha\Model\Type\Timestamp
  • Alpha\Model\Type\Type
  • Alpha\Task\BackupTask
  • Alpha\Task\CronManager
  • Alpha\Util\Backup\BackupUtils
  • Alpha\Util\Cache\CacheProviderAPC
  • Alpha\Util\Cache\CacheProviderArray
  • Alpha\Util\Cache\CacheProviderFile
  • Alpha\Util\Cache\CacheProviderMemcache
  • Alpha\Util\Cache\CacheProviderRedis
  • Alpha\Util\Code\Highlight\HighlightProviderGeshi
  • Alpha\Util\Code\Highlight\HighlightProviderLuminous
  • Alpha\Util\Code\Metric\Inspector
  • Alpha\Util\Config\ConfigProvider
  • Alpha\Util\Convertor\ActiveRecord2Excel
  • Alpha\Util\Email\EmailProviderPHP
  • Alpha\Util\ErrorHandlers
  • Alpha\Util\Extension\Markdown
  • Alpha\Util\Extension\MarkdownFacade
  • Alpha\Util\Extension\TCPDF
  • Alpha\Util\Extension\TCPDFFacade
  • Alpha\Util\Feed\Atom
  • Alpha\Util\Feed\Feed
  • Alpha\Util\Feed\RSS
  • Alpha\Util\Feed\RSS2
  • Alpha\Util\File\FileUtils
  • Alpha\Util\Graph\GraphNode
  • Alpha\Util\Graph\TreeGraph
  • Alpha\Util\Helper\Validator
  • Alpha\Util\Http\AgentUtils
  • Alpha\Util\Http\Filter\ClientBlacklistFilter
  • Alpha\Util\Http\Filter\ClientTempBlacklistFilter
  • Alpha\Util\Http\Filter\IPBlacklistFilter
  • Alpha\Util\Http\PHPServerUtils
  • Alpha\Util\Http\Request
  • Alpha\Util\Http\Response
  • Alpha\Util\Http\Session\SessionProviderArray
  • Alpha\Util\Http\Session\SessionProviderPHP
  • Alpha\Util\Image\ImageUtils
  • Alpha\Util\InputFilter
  • Alpha\Util\Logging\KPI
  • Alpha\Util\Logging\Logger
  • Alpha\Util\Logging\LogProviderFile
  • Alpha\Util\Search\SearchProviderTags
  • Alpha\Util\Security\SecurityUtils
  • Alpha\Util\Service\ServiceFactory
  • Alpha\View\ArticleCommentView
  • Alpha\View\ArticleView
  • Alpha\View\DEnumView
  • Alpha\View\PersonView
  • Alpha\View\Renderer\Html\RendererProviderHTML
  • Alpha\View\Renderer\Json\RendererProviderJSON
  • Alpha\View\SequenceView
  • Alpha\View\View
  • Alpha\View\ViewState
  • Alpha\View\Widget\Button
  • Alpha\View\Widget\DateBox
  • Alpha\View\Widget\Image
  • Alpha\View\Widget\RecordSelector
  • Alpha\View\Widget\SmallTextBox
  • Alpha\View\Widget\TagCloud
  • Alpha\View\Widget\TextBox

Interfaces

  • Alpha\Controller\ControllerInterface
  • Alpha\Model\ActiveRecordProviderInterface
  • Alpha\Model\Type\TypeInterface
  • Alpha\Task\TaskInterface
  • Alpha\Util\Cache\CacheProviderInterface
  • Alpha\Util\Code\Highlight\HighlightProviderInterface
  • Alpha\Util\Email\EmailProviderInterface
  • Alpha\Util\Http\Filter\FilterInterface
  • Alpha\Util\Http\Session\SessionProviderInterface
  • Alpha\Util\Logging\LogProviderInterface
  • Alpha\Util\Search\SearchProviderInterface
  • Alpha\View\Renderer\RendererProviderInterface

Exceptions

  • Alpha\Exception\AlphaException
  • Alpha\Exception\BadTableNameException
  • Alpha\Exception\CustomQueryException
  • Alpha\Exception\FailedDeleteException
  • Alpha\Exception\FailedIndexCreateException
  • Alpha\Exception\FailedLookupCreateException
  • Alpha\Exception\FailedSaveException
  • Alpha\Exception\FailedUnitCommitException
  • Alpha\Exception\FileNotFoundException
  • Alpha\Exception\IllegalArguementException
  • Alpha\Exception\LockingException
  • Alpha\Exception\MailNotSentException
  • Alpha\Exception\NotImplementedException
  • Alpha\Exception\PHPException
  • Alpha\Exception\RecordNotFoundException
  • Alpha\Exception\ResourceNotAllowedException
  • Alpha\Exception\ResourceNotFoundException
  • Alpha\Exception\SearchIndexWriteException
  • Alpha\Exception\SecurityException
  • Alpha\Exception\ValidationException
  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 
<?php

namespace Alpha\Util\Extension;

use Alpha\Util\Config\ConfigProvider;
use Alpha\Util\Logging\Logger;
use Alpha\Util\Helper\Validator;
use Alpha\Controller\Front\FrontController;
use Alpha\View\Widget\Image;

/**
 * Custom version of the TCPDF library class, allowing for any required overrides.
 *
 * @since 1.0
 *
 * @author John Collins <dev@alphaframework.org>
 * @license http://www.opensource.org/licenses/bsd-license.php The BSD License
 * @copyright Copyright (c) 2018, John Collins (founder of Alpha Framework).
 * All rights reserved.
 *
 * <pre>
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the
 * following conditions are met:
 *
 * * Redistributions of source code must retain the above
 *   copyright notice, this list of conditions and the
 *   following disclaimer.
 * * Redistributions in binary form must reproduce the above
 *   copyright notice, this list of conditions and the
 *   following disclaimer in the documentation and/or other
 *   materials provided with the distribution.
 * * Neither the name of the Alpha Framework nor the names
 *   of its contributors may be used to endorse or promote
 *   products derived from this software without specific
 *   prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * </pre>
 */
class TCPDF extends \TCPDF
{
    /**
     * Trace logger.
     *
     * @var \Alpha\Util\Logging\Logger
     *
     * @since 1.0
     */
    private static $logger = null;

    /**
     * Overrides the TCPDF::Image method to decrypt encrypted $file paths from the Image widget, then pass
     * them to the normal TCPDF::Image along with all of the other (unmodified) parameters.
     *
     * @param string $file    Name of the file containing the image.
     * @param float  $x       Abscissa of the upper-left corner.
     * @param float  $y       Ordinate of the upper-left corner.
     * @param float  $w       Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
     * @param float  $h       Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
     * @param string $type    Image format. Possible values are (case insensitive): JPEG and PNG (whitout GD library) and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM;. If not specified, the type is inferred from the file extension.
     * @param mixed  $link    URL or identifier returned by AddLink().
     * @param string $align   Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul>
     * @param bool   $resize  If true resize (reduce) the image to fit $w and $h (requires GD library).
     * @param int    $dpi     dot-per-inch resolution used on resize
     * @param string $palign  Allows to center or align the image on the current line. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul>
     * @param bool   $ismask  true if this image is a mask, false otherwise
     * @param mixed  $imgmask image object returned by this function or false
     * @param mixed  $border  Indicates if borders must be drawn around the image. The value can be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul>
     * @param $hidden (boolean) If true do not display the image.
     * @param $fitonpage (boolean) If true the image is resized to not exceed page dimensions.
     * @param $alt (boolean) If true the image will be added as alternative and not directly printed (the ID of the image will be returned).
     * @param $altimgs (array) Array of alternate images IDs. Each alternative image must be an array with two values: an integer representing the image ID (the value returned by the Image method) and a boolean value to indicate if the image is the default for printing.
     *
     * @since 1.0
     */
    public function Image($file, $x = '', $y = '', $w = 0, $h = 0, $type = '', $link = '', $align = '', $resize = false, $dpi = 300, $palign = '', $ismask = false, $imgmask = false, $border = 0, $fitbox = false, $hidden = false, $fitonpage = false, $alt = false, $altimgs = array())
    {
        if (self::$logger == null) {
            self::$logger = new Logger('TCPDF');
        }

        $config = ConfigProvider::getInstance();

        self::$logger->debug('Processing image file URL ['.$file.']');

        try {
            if (mb_strpos($file, '/tk/') !== false) {
                $start = mb_strpos($file, '/tk/')+3;
                $end = mb_strlen($file);
                $tk = mb_substr($file, $start+1, $end-($start+1));
                $decoded = FrontController::getDecodeQueryParams($tk);

                parent::Image($decoded['source'], $x, $y, $w, $h, $type, $link, $align, $resize, $dpi, $palign, $ismask, $imgmask, $border);
            } else {
                // it has no query string, so threat as a regular image URL
                if (Validator::isURL($file)) {
                    parent::Image($config->get('app.root').'/'.Image::convertImageURLToPath($file), $x, $y, $w, $h, $type, $link, $align, $resize, $dpi, $palign, $ismask, $imgmask, $border, $fitbox, $hidden, $fitonpage, $alt, $altimgs);
                } else {
                    parent::Image($file, $x, $y, $w, $h, $type, $link, $align, $resize, $dpi, $palign, $ismask, $imgmask, $border, $fitbox, $hidden, $fitonpage, $alt, $altimgs);
                }
            }
        } catch (\Exception $e) {
            self::$logger->error('Error processing image file URL ['.$file.'], error ['.$e->getMessage().']');
            throw $e;
        }
    }
}
Alpha Framework 3.0.0 API Documentation API documentation generated by ApiGen