You are here

class PHPExcel_Worksheet_HeaderFooterDrawing in Loft Data Grids 7.2

Same name and namespace in other branches
  1. 6.2 vendor/phpoffice/phpexcel/Classes/PHPExcel/Worksheet/HeaderFooterDrawing.php \PHPExcel_Worksheet_HeaderFooterDrawing

PHPExcel_Worksheet_HeaderFooterDrawing

@category PHPExcel @package PHPExcel_Worksheet @copyright Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)

Hierarchy

Expanded class hierarchy of PHPExcel_Worksheet_HeaderFooterDrawing

File

vendor/phpoffice/phpexcel/Classes/PHPExcel/Worksheet/HeaderFooterDrawing.php, line 36

View source
class PHPExcel_Worksheet_HeaderFooterDrawing extends PHPExcel_Worksheet_Drawing implements PHPExcel_IComparable {

  /**
   * Path
   *
   * @var string
   */
  private $_path;

  /**
   * Name
   *
   * @var string
   */
  protected $_name;

  /**
   * Offset X
   *
   * @var int
   */
  protected $_offsetX;

  /**
   * Offset Y
   *
   * @var int
   */
  protected $_offsetY;

  /**
   * Width
   *
   * @var int
   */
  protected $_width;

  /**
   * Height
   *
   * @var int
   */
  protected $_height;

  /**
   * Proportional resize
   *
   * @var boolean
   */
  protected $_resizeProportional;

  /**
   * Create a new PHPExcel_Worksheet_HeaderFooterDrawing
   */
  public function __construct() {

    // Initialise values
    $this->_path = '';
    $this->_name = '';
    $this->_offsetX = 0;
    $this->_offsetY = 0;
    $this->_width = 0;
    $this->_height = 0;
    $this->_resizeProportional = true;
  }

  /**
   * Get Name
   *
   * @return string
   */
  public function getName() {
    return $this->_name;
  }

  /**
   * Set Name
   *
   * @param string $pValue
   * @return PHPExcel_Worksheet_HeaderFooterDrawing
   */
  public function setName($pValue = '') {
    $this->_name = $pValue;
    return $this;
  }

  /**
   * Get OffsetX
   *
   * @return int
   */
  public function getOffsetX() {
    return $this->_offsetX;
  }

  /**
   * Set OffsetX
   *
   * @param int $pValue
   * @return PHPExcel_Worksheet_HeaderFooterDrawing
   */
  public function setOffsetX($pValue = 0) {
    $this->_offsetX = $pValue;
    return $this;
  }

  /**
   * Get OffsetY
   *
   * @return int
   */
  public function getOffsetY() {
    return $this->_offsetY;
  }

  /**
   * Set OffsetY
   *
   * @param int $pValue
   * @return PHPExcel_Worksheet_HeaderFooterDrawing
   */
  public function setOffsetY($pValue = 0) {
    $this->_offsetY = $pValue;
    return $this;
  }

  /**
   * Get Width
   *
   * @return int
   */
  public function getWidth() {
    return $this->_width;
  }

  /**
   * Set Width
   *
   * @param int $pValue
   * @return PHPExcel_Worksheet_HeaderFooterDrawing
   */
  public function setWidth($pValue = 0) {

    // Resize proportional?
    if ($this->_resizeProportional && $pValue != 0) {
      $ratio = $this->_width / $this->_height;
      $this->_height = round($ratio * $pValue);
    }

    // Set width
    $this->_width = $pValue;
    return $this;
  }

  /**
   * Get Height
   *
   * @return int
   */
  public function getHeight() {
    return $this->_height;
  }

  /**
   * Set Height
   *
   * @param int $pValue
   * @return PHPExcel_Worksheet_HeaderFooterDrawing
   */
  public function setHeight($pValue = 0) {

    // Resize proportional?
    if ($this->_resizeProportional && $pValue != 0) {
      $ratio = $this->_width / $this->_height;
      $this->_width = round($ratio * $pValue);
    }

    // Set height
    $this->_height = $pValue;
    return $this;
  }

  /**
   * Set width and height with proportional resize
   * Example:
   * <code>
   * $objDrawing->setResizeProportional(true);
   * $objDrawing->setWidthAndHeight(160,120);
   * </code>
   *
   * @author Vincent@luo MSN:kele_100@hotmail.com
   * @param int $width
   * @param int $height
   * @return PHPExcel_Worksheet_HeaderFooterDrawing
   */
  public function setWidthAndHeight($width = 0, $height = 0) {
    $xratio = $width / $this->_width;
    $yratio = $height / $this->_height;
    if ($this->_resizeProportional && !($width == 0 || $height == 0)) {
      if ($xratio * $this->_height < $height) {
        $this->_height = ceil($xratio * $this->_height);
        $this->_width = $width;
      }
      else {
        $this->_width = ceil($yratio * $this->_width);
        $this->_height = $height;
      }
    }
    return $this;
  }

  /**
   * Get ResizeProportional
   *
   * @return boolean
   */
  public function getResizeProportional() {
    return $this->_resizeProportional;
  }

  /**
   * Set ResizeProportional
   *
   * @param boolean $pValue
   * @return PHPExcel_Worksheet_HeaderFooterDrawing
   */
  public function setResizeProportional($pValue = true) {
    $this->_resizeProportional = $pValue;
    return $this;
  }

  /**
   * Get Filename
   *
   * @return string
   */
  public function getFilename() {
    return basename($this->_path);
  }

  /**
   * Get Extension
   *
   * @return string
   */
  public function getExtension() {
    $parts = explode(".", basename($this->_path));
    return end($parts);
  }

  /**
   * Get Path
   *
   * @return string
   */
  public function getPath() {
    return $this->_path;
  }

  /**
   * Set Path
   *
   * @param 	string 		$pValue			File path
   * @param 	boolean		$pVerifyFile	Verify file
   * @throws 	PHPExcel_Exception
   * @return PHPExcel_Worksheet_HeaderFooterDrawing
   */
  public function setPath($pValue = '', $pVerifyFile = true) {
    if ($pVerifyFile) {
      if (file_exists($pValue)) {
        $this->_path = $pValue;
        if ($this->_width == 0 && $this->_height == 0) {

          // Get width/height
          list($this->_width, $this->_height) = getimagesize($pValue);
        }
      }
      else {
        throw new PHPExcel_Exception("File {$pValue} not found!");
      }
    }
    else {
      $this->_path = $pValue;
    }
    return $this;
  }

  /**
   * Get hash code
   *
   * @return string	Hash code
   */
  public function getHashCode() {
    return md5($this->_path . $this->_name . $this->_offsetX . $this->_offsetY . $this->_width . $this->_height . __CLASS__);
  }

  /**
   * Implement PHP __clone to create a deep clone, not just a shallow copy.
   */
  public function __clone() {
    $vars = get_object_vars($this);
    foreach ($vars as $key => $value) {
      if (is_object($value)) {
        $this->{$key} = clone $value;
      }
      else {
        $this->{$key} = $value;
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
PHPExcel_Worksheet_BaseDrawing::$_coordinates protected property * Coordinates * *
PHPExcel_Worksheet_BaseDrawing::$_description protected property * Description * *
PHPExcel_Worksheet_BaseDrawing::$_imageCounter private static property * Image counter * *
PHPExcel_Worksheet_BaseDrawing::$_imageIndex private property * Image index * *
PHPExcel_Worksheet_BaseDrawing::$_rotation protected property * Rotation * *
PHPExcel_Worksheet_BaseDrawing::$_shadow protected property * Shadow * *
PHPExcel_Worksheet_BaseDrawing::$_worksheet protected property * Worksheet * *
PHPExcel_Worksheet_BaseDrawing::getCoordinates public function Get Coordinates
PHPExcel_Worksheet_BaseDrawing::getDescription public function Get Description
PHPExcel_Worksheet_BaseDrawing::getImageIndex public function Get image index
PHPExcel_Worksheet_BaseDrawing::getRotation public function Get Rotation
PHPExcel_Worksheet_BaseDrawing::getShadow public function Get Shadow
PHPExcel_Worksheet_BaseDrawing::getWorksheet public function Get Worksheet
PHPExcel_Worksheet_BaseDrawing::setCoordinates public function Set Coordinates
PHPExcel_Worksheet_BaseDrawing::setDescription public function Set Description
PHPExcel_Worksheet_BaseDrawing::setRotation public function Set Rotation
PHPExcel_Worksheet_BaseDrawing::setShadow public function Set Shadow
PHPExcel_Worksheet_BaseDrawing::setWorksheet public function Set Worksheet
PHPExcel_Worksheet_Drawing::getIndexedFilename public function Get indexed filename (using image index)
PHPExcel_Worksheet_HeaderFooterDrawing::$_height protected property * Height * * Overrides PHPExcel_Worksheet_BaseDrawing::$_height
PHPExcel_Worksheet_HeaderFooterDrawing::$_name protected property * Name * * Overrides PHPExcel_Worksheet_BaseDrawing::$_name
PHPExcel_Worksheet_HeaderFooterDrawing::$_offsetX protected property * Offset X * * Overrides PHPExcel_Worksheet_BaseDrawing::$_offsetX
PHPExcel_Worksheet_HeaderFooterDrawing::$_offsetY protected property * Offset Y * * Overrides PHPExcel_Worksheet_BaseDrawing::$_offsetY
PHPExcel_Worksheet_HeaderFooterDrawing::$_path private property * Path * * Overrides PHPExcel_Worksheet_Drawing::$_path
PHPExcel_Worksheet_HeaderFooterDrawing::$_resizeProportional protected property * Proportional resize * * Overrides PHPExcel_Worksheet_BaseDrawing::$_resizeProportional
PHPExcel_Worksheet_HeaderFooterDrawing::$_width protected property * Width * * Overrides PHPExcel_Worksheet_BaseDrawing::$_width
PHPExcel_Worksheet_HeaderFooterDrawing::getExtension public function Get Extension Overrides PHPExcel_Worksheet_Drawing::getExtension
PHPExcel_Worksheet_HeaderFooterDrawing::getFilename public function Get Filename Overrides PHPExcel_Worksheet_Drawing::getFilename
PHPExcel_Worksheet_HeaderFooterDrawing::getHashCode public function * Get hash code * * Overrides PHPExcel_Worksheet_Drawing::getHashCode
PHPExcel_Worksheet_HeaderFooterDrawing::getHeight public function Get Height Overrides PHPExcel_Worksheet_BaseDrawing::getHeight
PHPExcel_Worksheet_HeaderFooterDrawing::getName public function Get Name Overrides PHPExcel_Worksheet_BaseDrawing::getName
PHPExcel_Worksheet_HeaderFooterDrawing::getOffsetX public function Get OffsetX Overrides PHPExcel_Worksheet_BaseDrawing::getOffsetX
PHPExcel_Worksheet_HeaderFooterDrawing::getOffsetY public function Get OffsetY Overrides PHPExcel_Worksheet_BaseDrawing::getOffsetY
PHPExcel_Worksheet_HeaderFooterDrawing::getPath public function Get Path Overrides PHPExcel_Worksheet_Drawing::getPath
PHPExcel_Worksheet_HeaderFooterDrawing::getResizeProportional public function Get ResizeProportional Overrides PHPExcel_Worksheet_BaseDrawing::getResizeProportional
PHPExcel_Worksheet_HeaderFooterDrawing::getWidth public function Get Width Overrides PHPExcel_Worksheet_BaseDrawing::getWidth
PHPExcel_Worksheet_HeaderFooterDrawing::setHeight public function Set Height Overrides PHPExcel_Worksheet_BaseDrawing::setHeight
PHPExcel_Worksheet_HeaderFooterDrawing::setName public function Set Name Overrides PHPExcel_Worksheet_BaseDrawing::setName
PHPExcel_Worksheet_HeaderFooterDrawing::setOffsetX public function Set OffsetX Overrides PHPExcel_Worksheet_BaseDrawing::setOffsetX
PHPExcel_Worksheet_HeaderFooterDrawing::setOffsetY public function Set OffsetY Overrides PHPExcel_Worksheet_BaseDrawing::setOffsetY
PHPExcel_Worksheet_HeaderFooterDrawing::setPath public function Set Path Overrides PHPExcel_Worksheet_Drawing::setPath
PHPExcel_Worksheet_HeaderFooterDrawing::setResizeProportional public function Set ResizeProportional Overrides PHPExcel_Worksheet_BaseDrawing::setResizeProportional
PHPExcel_Worksheet_HeaderFooterDrawing::setWidth public function Set Width Overrides PHPExcel_Worksheet_BaseDrawing::setWidth
PHPExcel_Worksheet_HeaderFooterDrawing::setWidthAndHeight public function Set width and height with proportional resize * Example: * <code> $objDrawing->setResizeProportional(true); $objDrawing->setWidthAndHeight(160,120); * </code> * @author Vincent@luo MSN:kele_100@hotmail.com Overrides PHPExcel_Worksheet_BaseDrawing::setWidthAndHeight
PHPExcel_Worksheet_HeaderFooterDrawing::__clone public function * Implement PHP __clone to create a deep clone, not just a shallow copy. Overrides PHPExcel_Worksheet_Drawing::__clone
PHPExcel_Worksheet_HeaderFooterDrawing::__construct public function Create a new PHPExcel_Worksheet_HeaderFooterDrawing Overrides PHPExcel_Worksheet_Drawing::__construct