Collaboration diagram for PHPExcel_Helper_HTML:

Public Member Functions
	toRichTextObject ($html)

Protected Member Functions
	initialise ()

	buildTextRun ()

	rgbToColour ($rgb)

	colourNameLookup ($rgb)

	startFontTag ($tag)

	endFontTag ()

	startBoldTag ()

	endBoldTag ()

	startItalicTag ()

	endItalicTag ()

	startUnderlineTag ()

	endUnderlineTag ()

	startSubscriptTag ()

	endSubscriptTag ()

	startSuperscriptTag ()

	endSuperscriptTag ()

	startStrikethruTag ()

	endStrikethruTag ()

	breakTag ()

	parseTextNode (DOMText $textNode)

	handleCallback ($element, $callbackTag, $callbacks)

	parseElementNode (DOMElement $element)

	parseElements (DOMNode $element)

Protected Attributes
	$face

	$size

	$color

	$bold = false

	$italic = false

	$underline = false

	$superscript = false

	$subscript = false

	$strikethrough = false

	$startTagCallbacks

	$endTagCallbacks

	$stack = array()

	$stringData = ''

	$richTextObject

Static Protected Attributes
static	$colourMap

Detailed Description

Definition at line 3 of file HTML.php.

Member Function Documentation

◆ breakTag()

PHPExcel_Helper_HTML::breakTag ( )

protected

Definition at line 721 of file HTML.php.

                                  {
        $this->stringData .= PHP_EOL;
    }

References PHP_EOL.

◆ buildTextRun()

PHPExcel_Helper_HTML::buildTextRun ( )

protected

Definition at line 602 of file HTML.php.

                                      {
        $text = $this->stringData;
        if (trim($text) === '')
            return;
 
        $richtextRun = $this->richTextObject->createTextRun($this->stringData);
        if ($this->face) {
            $richtextRun->getFont()->setName($this->face);
        }
        if ($this->size) {
            $richtextRun->getFont()->setSize($this->size);
        }
        if ($this->color) {
            $richtextRun->getFont()->setColor( new PHPExcel_Style_Color( 'ff' . $this->color ) );
        }
        if ($this->bold) {
            $richtextRun->getFont()->setBold(true);
        }
        if ($this->italic) {
            $richtextRun->getFont()->setItalic(true);
        }
        if ($this->underline) {
            $richtextRun->getFont()->setUnderline(PHPExcel_Style_Font::UNDERLINE_SINGLE);
        }
        if ($this->superscript) {
            $richtextRun->getFont()->setSuperScript(true);
        }
        if ($this->subscript) {
            $richtextRun->getFont()->setSubScript(true);
        }
        if ($this->strikethrough) {
            $richtextRun->getFont()->setStrikethrough(true);
        }
        $this->stringData = '';
    }

References $stringData, $text, color, size, and PHPExcel_Style_Font\UNDERLINE_SINGLE.

Referenced by parseTextNode().

Here is the caller graph for this function:

◆ colourNameLookup()

PHPExcel_Helper_HTML::colourNameLookup ( $rgb )

protected

Definition at line 646 of file HTML.php.

                                              {
        return self::$colourMap[$rgb];
    }

Referenced by startFontTag().

Here is the caller graph for this function:

◆ endBoldTag()

PHPExcel_Helper_HTML::endBoldTag ( )

protected

Definition at line 677 of file HTML.php.

                                    {
        $this->bold = false;
    }

◆ endFontTag()

PHPExcel_Helper_HTML::endFontTag ( )

protected

Definition at line 669 of file HTML.php.

                                    {
        $this->face = $this->size = $this->color = null;
    }

References color, and size.

◆ endItalicTag()

PHPExcel_Helper_HTML::endItalicTag ( )

protected

Definition at line 685 of file HTML.php.

                                      {
        $this->italic = false;
    }

◆ endStrikethruTag()

PHPExcel_Helper_HTML::endStrikethruTag ( )

protected

Definition at line 717 of file HTML.php.

                                          {
        $this->strikethrough = false;
    }

◆ endSubscriptTag()

PHPExcel_Helper_HTML::endSubscriptTag ( )

protected

Definition at line 701 of file HTML.php.

                                         {
        $this->subscript = false;
    }

◆ endSuperscriptTag()

PHPExcel_Helper_HTML::endSuperscriptTag ( )

protected

Definition at line 709 of file HTML.php.

                                           {
        $this->superscript = false;
    }

◆ endUnderlineTag()

PHPExcel_Helper_HTML::endUnderlineTag ( )

protected

Definition at line 693 of file HTML.php.

                                         {
        $this->underline = false;
    }

◆ handleCallback()

PHPExcel_Helper_HTML::handleCallback	(	$element,
		$callbackTag,
		$callbacks
	)

protected

Definition at line 731 of file HTML.php.

                                                                          {
        if (isset($callbacks[$callbackTag])) {
            $elementHandler = $callbacks[$callbackTag];
            if (method_exists($this, $elementHandler)) {
                call_user_func(array($this, $elementHandler), $element);
            }
        }
    }

Referenced by parseElementNode().

Here is the caller graph for this function:

◆ initialise()

PHPExcel_Helper_HTML::initialise ( )

protected

Definition at line 576 of file HTML.php.

                                    {
        $this->face = $this->size = $this->color = null;
        $this->bold = $this->italic = $this->underline = $this->superscript = $this->subscript = $this->strikethrough = false;
 
        $this->stack = array();
 
        $this->stringData = '';
    }

References color, and size.

Referenced by toRichTextObject().

Here is the caller graph for this function:

◆ parseElementNode()

PHPExcel_Helper_HTML::parseElementNode ( DOMElement $element )

protected

Definition at line 740 of file HTML.php.

                                                             {
        $callbackTag = strtolower($element->nodeName);
        $this->stack[] = $callbackTag;
 
        $this->handleCallback($element, $callbackTag, $this->startTagCallbacks);
 
        $this->parseElements($element);
        $this->stringData .= ' ';
        array_pop($this->stack);
 
        $this->handleCallback($element, $callbackTag, $this->endTagCallbacks);
    }

References handleCallback(), and parseElements().

Referenced by parseElements().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseElements()

PHPExcel_Helper_HTML::parseElements ( DOMNode $element )

protected

Definition at line 753 of file HTML.php.

                                                       {
        foreach ($element->childNodes as $child) {
            if ($child instanceof DOMText) {
                $this->parseTextNode($child);
            } elseif ($child instanceof DOMElement) {
                $this->parseElementNode($child);
            }
        }
    }

References parseElementNode(), and parseTextNode().

Referenced by parseElementNode(), and toRichTextObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseTextNode()

PHPExcel_Helper_HTML::parseTextNode ( DOMText $textNode )

protected

Definition at line 725 of file HTML.php.

                                                        {
        $domText = preg_replace('/\s+/u', ' ', ltrim($textNode->nodeValue));
        $this->stringData .= $domText;
        $this->buildTextRun();
    }

References buildTextRun().

Referenced by parseElements().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rgbToColour()

PHPExcel_Helper_HTML::rgbToColour ( $rgb )

protected

Definition at line 638 of file HTML.php.

                                         {
        preg_match_all('/\d+/', $rgb, $values);
        foreach($values[0] as &$value) {
            $value = str_pad(dechex($value), 2, '0', STR_PAD_LEFT);
        }
        return implode($values[0]);
    }

Referenced by startFontTag().

Here is the caller graph for this function:

◆ startBoldTag()

PHPExcel_Helper_HTML::startBoldTag ( )

protected

Definition at line 673 of file HTML.php.

                                      {
        $this->bold = true;
    }

◆ startFontTag()

PHPExcel_Helper_HTML::startFontTag ( $tag )

protected

Definition at line 650 of file HTML.php.

                                          {
        foreach ($tag->attributes as $attribute) {
            $attributeName = strtolower($attribute->name);
            $attributeValue = $attribute->value;
 
            if ($attributeName == 'color') {
                if (preg_match('/rgb\s*\‍(/', $attributeValue)) {
                    $this->$attributeName = $this->rgbToColour($attributeValue);
                } elseif(strpos(trim($attributeValue), '#') === 0) {
                    $this->$attributeName = ltrim($attributeValue, '#');
                } else {
                    $this->$attributeName = $this->colourNameLookup($attributeValue);
                }
            } else {
                $this->$attributeName = $attributeValue;
            }
        }
    }

References colourNameLookup(), and rgbToColour().

Here is the call graph for this function:

◆ startItalicTag()

PHPExcel_Helper_HTML::startItalicTag ( )

protected

Definition at line 681 of file HTML.php.

                                        {
        $this->italic = true;
    }

◆ startStrikethruTag()

PHPExcel_Helper_HTML::startStrikethruTag ( )

protected

Definition at line 713 of file HTML.php.

                                            {
        $this->strikethrough = true;
    }

◆ startSubscriptTag()

PHPExcel_Helper_HTML::startSubscriptTag ( )

protected

Definition at line 697 of file HTML.php.

                                           {
        $this->subscript = true;
    }

◆ startSuperscriptTag()

PHPExcel_Helper_HTML::startSuperscriptTag ( )

protected

Definition at line 705 of file HTML.php.

                                             {
        $this->superscript = true;
    }

◆ startUnderlineTag()

PHPExcel_Helper_HTML::startUnderlineTag ( )

protected

Definition at line 689 of file HTML.php.

                                           {
        $this->underline = true;
    }

◆ toRichTextObject()

PHPExcel_Helper_HTML::toRichTextObject ( $html )

Definition at line 585 of file HTML.php.

                                            {
        $this->initialise();
 
        //      Create a new DOM object
        $dom = new domDocument;
        //      Load the HTML file into the DOM object
        //  Note the use of error suppression, because typically this will be an html fragment, so not fully valid markup
        $loaded = @$dom->loadHTML($html);
 
        //      Discard excess white space
        $dom->preserveWhiteSpace = false;
 
        $this->richTextObject = new PHPExcel_RichText();;
        $this->parseElements($dom);
        return $this->richTextObject;
    }

References $html, $richTextObject, initialise(), and parseElements().

Here is the call graph for this function:

Field Documentation

◆ $bold

PHPExcel_Helper_HTML::$bold = false

protected

Definition at line 529 of file HTML.php.

◆ $color

PHPExcel_Helper_HTML::$color

protected

Definition at line 527 of file HTML.php.

◆ $colourMap

PHPExcel_Helper_HTML::$colourMap

staticprotected

Definition at line 5 of file HTML.php.

◆ $endTagCallbacks

PHPExcel_Helper_HTML::$endTagCallbacks

protected

Initial value:

= array(
        'font' => 'endFontTag',
        'b' => 'endBoldTag',
        'strong' => 'endBoldTag',
        'i' => 'endItalicTag',
        'em' => 'endItalicTag',
        'u' => 'endUnderlineTag',
        'ins' => 'endUnderlineTag',
        'del' => 'endStrikethruTag',
        'sup' => 'endSuperscriptTag',
        'sub' => 'endSubscriptTag',
        'br' => 'breakTag',
        'p' => 'breakTag',
        'h1' => 'breakTag',
        'h2' => 'breakTag',
        'h3' => 'breakTag',
        'h4' => 'breakTag',
        'h5' => 'breakTag',
        'h6' => 'breakTag',
    )

Definition at line 549 of file HTML.php.

◆ $face

PHPExcel_Helper_HTML::$face

protected

Definition at line 525 of file HTML.php.

◆ $italic

PHPExcel_Helper_HTML::$italic = false

protected

Definition at line 530 of file HTML.php.

◆ $richTextObject

PHPExcel_Helper_HTML::$richTextObject

protected

Definition at line 574 of file HTML.php.

Referenced by toRichTextObject().

◆ $size

PHPExcel_Helper_HTML::$size

protected

Definition at line 526 of file HTML.php.

◆ $stack

PHPExcel_Helper_HTML::$stack = array()

protected

Definition at line 570 of file HTML.php.

◆ $startTagCallbacks

PHPExcel_Helper_HTML::$startTagCallbacks

protected

Initial value:

= array(
        'font' => 'startFontTag',
        'b' => 'startBoldTag',
        'strong' => 'startBoldTag',
        'i' => 'startItalicTag',
        'em' => 'startItalicTag',
        'u' => 'startUnderlineTag',
        'ins' => 'startUnderlineTag',
        'del' => 'startStrikethruTag',
        'sup' => 'startSuperscriptTag',
        'sub' => 'startSubscriptTag',
    )

Definition at line 536 of file HTML.php.

◆ $strikethrough

PHPExcel_Helper_HTML::$strikethrough = false

protected

Definition at line 534 of file HTML.php.

◆ $stringData

PHPExcel_Helper_HTML::$stringData = ''

protected

Definition at line 572 of file HTML.php.

Referenced by buildTextRun().

◆ $subscript

PHPExcel_Helper_HTML::$subscript = false

protected

Definition at line 533 of file HTML.php.

◆ $superscript

PHPExcel_Helper_HTML::$superscript = false

protected

Definition at line 532 of file HTML.php.

◆ $underline

PHPExcel_Helper_HTML::$underline = false

protected

Definition at line 531 of file HTML.php.

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

libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/Helper/HTML.php

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ breakTag()

◆ buildTextRun()

◆ colourNameLookup()

◆ endBoldTag()

◆ endFontTag()

◆ endItalicTag()

◆ endStrikethruTag()

◆ endSubscriptTag()

◆ endSuperscriptTag()

◆ endUnderlineTag()

◆ handleCallback()

◆ initialise()

◆ parseElementNode()

◆ parseElements()

◆ parseTextNode()

◆ rgbToColour()

◆ startBoldTag()

◆ startFontTag()

◆ startItalicTag()

◆ startStrikethruTag()

◆ startSubscriptTag()

◆ startSuperscriptTag()

◆ startUnderlineTag()

◆ toRichTextObject()

Field Documentation

◆ $bold

◆ $color

◆ $colourMap

◆ $endTagCallbacks

◆ $face

◆ $italic

◆ $richTextObject

◆ $size

◆ $stack

◆ $startTagCallbacks

◆ $strikethrough

◆ $stringData

◆ $subscript

◆ $superscript

◆ $underline