class PHPExcel_Comment in Loft Data Grids 6.2

PHPExcel_Comment

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

Hierarchy

• class \PHPExcel_Comment implements PHPExcel_IComparable

File

vendor/phpoffice/phpexcel/Classes/PHPExcel/Comment.php, line 36

class PHPExcel_Comment implements PHPExcel_IComparable {

  /**
   * Author
   *
   * @var string
   */
  private $_author;

  /**
   * Rich text comment
   *
   * @var PHPExcel_RichText
   */
  private $_text;

  /**
   * Comment width (CSS style, i.e. XXpx or YYpt)
   *
   * @var string
   */
  private $_width = '96pt';

  /**
   * Left margin (CSS style, i.e. XXpx or YYpt)
   *
   * @var string
   */
  private $_marginLeft = '59.25pt';

  /**
   * Top margin (CSS style, i.e. XXpx or YYpt)
   *
   * @var string
   */
  private $_marginTop = '1.5pt';

  /**
   * Visible
   *
   * @var boolean
   */
  private $_visible = false;

  /**
   * Comment height (CSS style, i.e. XXpx or YYpt)
   *
   * @var string
   */
  private $_height = '55.5pt';

  /**
   * Comment fill color
   *
   * @var PHPExcel_Style_Color
   */
  private $_fillColor;

  /**
   * Alignment
   *
   * @var string
   */
  private $_alignment;

  /**
   * Create a new PHPExcel_Comment
   *
   * @throws PHPExcel_Exception
   */
  public function __construct() {

    // Initialise variables
    $this->_author = 'Author';
    $this->_text = new PHPExcel_RichText();
    $this->_fillColor = new PHPExcel_Style_Color('FFFFFFE1');
    $this->_alignment = PHPExcel_Style_Alignment::HORIZONTAL_GENERAL;
  }

  /**
   * Get Author
   *
   * @return string
   */
  public function getAuthor() {
    return $this->_author;
  }

  /**
   * Set Author
   *
   * @param string $pValue
   * @return PHPExcel_Comment
   */
  public function setAuthor($pValue = '') {
    $this->_author = $pValue;
    return $this;
  }

  /**
   * Get Rich text comment
   *
   * @return PHPExcel_RichText
   */
  public function getText() {
    return $this->_text;
  }

  /**
   * Set Rich text comment
   *
   * @param PHPExcel_RichText $pValue
   * @return PHPExcel_Comment
   */
  public function setText(PHPExcel_RichText $pValue) {
    $this->_text = $pValue;
    return $this;
  }

  /**
   * Get comment width (CSS style, i.e. XXpx or YYpt)
   *
   * @return string
   */
  public function getWidth() {
    return $this->_width;
  }

  /**
   * Set comment width (CSS style, i.e. XXpx or YYpt)
   *
   * @param string $value
   * @return PHPExcel_Comment
   */
  public function setWidth($value = '96pt') {
    $this->_width = $value;
    return $this;
  }

  /**
   * Get comment height (CSS style, i.e. XXpx or YYpt)
   *
   * @return string
   */
  public function getHeight() {
    return $this->_height;
  }

  /**
   * Set comment height (CSS style, i.e. XXpx or YYpt)
   *
   * @param string $value
   * @return PHPExcel_Comment
   */
  public function setHeight($value = '55.5pt') {
    $this->_height = $value;
    return $this;
  }

  /**
   * Get left margin (CSS style, i.e. XXpx or YYpt)
   *
   * @return string
   */
  public function getMarginLeft() {
    return $this->_marginLeft;
  }

  /**
   * Set left margin (CSS style, i.e. XXpx or YYpt)
   *
   * @param string $value
   * @return PHPExcel_Comment
   */
  public function setMarginLeft($value = '59.25pt') {
    $this->_marginLeft = $value;
    return $this;
  }

  /**
   * Get top margin (CSS style, i.e. XXpx or YYpt)
   *
   * @return string
   */
  public function getMarginTop() {
    return $this->_marginTop;
  }

  /**
   * Set top margin (CSS style, i.e. XXpx or YYpt)
   *
   * @param string $value
   * @return PHPExcel_Comment
   */
  public function setMarginTop($value = '1.5pt') {
    $this->_marginTop = $value;
    return $this;
  }

  /**
   * Is the comment visible by default?
   *
   * @return boolean
   */
  public function getVisible() {
    return $this->_visible;
  }

  /**
   * Set comment default visibility
   *
   * @param boolean $value
   * @return PHPExcel_Comment
   */
  public function setVisible($value = false) {
    $this->_visible = $value;
    return $this;
  }

  /**
   * Get fill color
   *
   * @return PHPExcel_Style_Color
   */
  public function getFillColor() {
    return $this->_fillColor;
  }

  /**
   * Set Alignment
   *
   * @param string $pValue
   * @return PHPExcel_Comment
   */
  public function setAlignment($pValue = PHPExcel_Style_Alignment::HORIZONTAL_GENERAL) {
    $this->_alignment = $pValue;
    return $this;
  }

  /**
   * Get Alignment
   *
   * @return string
   */
  public function getAlignment() {
    return $this->_alignment;
  }

  /**
   * Get hash code
   *
   * @return string    Hash code
   */
  public function getHashCode() {
    return md5($this->_author . $this->_text
      ->getHashCode() . $this->_width . $this->_height . $this->_marginLeft . $this->_marginTop . ($this->_visible ? 1 : 0) . $this->_fillColor
      ->getHashCode() . $this->_alignment . __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;
      }
    }
  }

  /**
   * Convert to string
   *
   * @return string
   */
  public function __toString() {
    return $this->_text
      ->getPlainText();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PHPExcel_Comment::$_alignment	private	property	Alignment
PHPExcel_Comment::$_author	private	property	Author
PHPExcel_Comment::$_fillColor	private	property	Comment fill color
PHPExcel_Comment::$_height	private	property	Comment height (CSS style, i.e. XXpx or YYpt)
PHPExcel_Comment::$_marginLeft	private	property	Left margin (CSS style, i.e. XXpx or YYpt)
PHPExcel_Comment::$_marginTop	private	property	Top margin (CSS style, i.e. XXpx or YYpt)
PHPExcel_Comment::$_text	private	property	Rich text comment
PHPExcel_Comment::$_visible	private	property	Visible
PHPExcel_Comment::$_width	private	property	Comment width (CSS style, i.e. XXpx or YYpt)
PHPExcel_Comment::getAlignment	public	function	Get Alignment
PHPExcel_Comment::getAuthor	public	function	Get Author
PHPExcel_Comment::getFillColor	public	function	Get fill color
PHPExcel_Comment::getHashCode	public	function	Get hash code Overrides PHPExcel_IComparable::getHashCode
PHPExcel_Comment::getHeight	public	function	Get comment height (CSS style, i.e. XXpx or YYpt)
PHPExcel_Comment::getMarginLeft	public	function	Get left margin (CSS style, i.e. XXpx or YYpt)
PHPExcel_Comment::getMarginTop	public	function	Get top margin (CSS style, i.e. XXpx or YYpt)
PHPExcel_Comment::getText	public	function	Get Rich text comment
PHPExcel_Comment::getVisible	public	function	Is the comment visible by default?
PHPExcel_Comment::getWidth	public	function	Get comment width (CSS style, i.e. XXpx or YYpt)
PHPExcel_Comment::setAlignment	public	function	Set Alignment
PHPExcel_Comment::setAuthor	public	function	Set Author
PHPExcel_Comment::setHeight	public	function	Set comment height (CSS style, i.e. XXpx or YYpt)
PHPExcel_Comment::setMarginLeft	public	function	Set left margin (CSS style, i.e. XXpx or YYpt)
PHPExcel_Comment::setMarginTop	public	function	Set top margin (CSS style, i.e. XXpx or YYpt)
PHPExcel_Comment::setText	public	function	Set Rich text comment
PHPExcel_Comment::setVisible	public	function	Set comment default visibility
PHPExcel_Comment::setWidth	public	function	Set comment width (CSS style, i.e. XXpx or YYpt)
PHPExcel_Comment::__clone	public	function	Implement PHP __clone to create a deep clone, not just a shallow copy.
PHPExcel_Comment::__construct	public	function	Create a new PHPExcel_Comment
PHPExcel_Comment::__toString	public	function	Convert to string