Collaboration diagram for PhpOffice\PhpSpreadsheet\Helper\Html:

Public Member Functions
	toRichTextObject ($html)
	Parse HTML formatting and return the resulting RichText. More...

Static Public Member Functions
static	colourNameLookup (string $rgb)

Protected Member Functions
	initialise ()

	cleanWhitespace ()

	buildTextRun ()

	rgbToColour ($rgb)

	startFontTag ($tag)

	endFontTag ()

	startBoldTag ()

	endBoldTag ()

	startItalicTag ()

	endItalicTag ()

	startUnderlineTag ()

	endUnderlineTag ()

	startSubscriptTag ()

	endSubscriptTag ()

	startSuperscriptTag ()

	endSuperscriptTag ()

	startStrikethruTag ()

	endStrikethruTag ()

	breakTag ()

	parseTextNode (DOMText $textNode)

	handleCallback (DOMElement $element, $callbackTag, array $callbacks)

	parseElementNode (DOMElement $element)

	parseElements (DOMNode $element)

Protected Attributes
static	$face

	$size

	$color

	$bold = false

	$italic = false

	$underline = false

	$superscript = false

	$subscript = false

	$strikethrough = false

	$startTagCallbacks

	$endTagCallbacks

	$stack = []

	$stringData = ''

	$richTextObject

Static Protected Attributes
static	$colourMap

Detailed Description

Definition at line 13 of file Html.php.

Member Function Documentation

◆ breakTag()

PhpOffice\PhpSpreadsheet\Helper\Html::breakTag ( )

protected

Definition at line 787 of file Html.php.

                                  : void
     {
         $this->stringData .= "\n";
     }

◆ buildTextRun()

PhpOffice\PhpSpreadsheet\Helper\Html::buildTextRun ( )

protected

Definition at line 649 of file Html.php.

References PhpOffice\PhpSpreadsheet\Helper\Html\$stringData, $text, color, size, and PhpOffice\PhpSpreadsheet\Style\Font\UNDERLINE_SINGLE.

Referenced by PhpOffice\PhpSpreadsheet\Helper\Html\parseTextNode().

                                      : void
     {
         $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 Color('ff' . $this->color));
         }
         if ($this->bold) {
             $richtextRun->getFont()->setBold(true);
         }
         if ($this->italic) {
             $richtextRun->getFont()->setItalic(true);
         }
         if ($this->underline) {
             $richtextRun->getFont()->setUnderline(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 = '';
     }

Here is the caller graph for this function:

◆ cleanWhitespace()

PhpOffice\PhpSpreadsheet\Helper\Html::cleanWhitespace ( )

protected

Definition at line 635 of file Html.php.

References $key, and $text.

Referenced by PhpOffice\PhpSpreadsheet\Helper\Html\toRichTextObject().

                                         : void
     {
         foreach ($this->richTextObject->getRichTextElements() as $key => $element) {
             $text = $element->getText();
             // Trim any leading spaces on the first run
             if ($key == 0) {
                 $text = ltrim($text);
             }
             // Trim any spaces immediately after a line break
             $text = preg_replace('/\n */mu', "\n", $text);
             $element->setText($text);
         }
     }

Here is the caller graph for this function:

◆ colourNameLookup()

static PhpOffice\PhpSpreadsheet\Helper\Html::colourNameLookup ( string $rgb )

static

Definition at line 697 of file Html.php.

                                                         : string
     {
         return self::$colourMap[$rgb] ?? '';
     }

◆ endBoldTag()

PhpOffice\PhpSpreadsheet\Helper\Html::endBoldTag ( )

protected

Definition at line 732 of file Html.php.

                                    : void
     {
         $this->bold = false;
     }

◆ endFontTag()

PhpOffice\PhpSpreadsheet\Helper\Html::endFontTag ( )

protected

Definition at line 722 of file Html.php.

References color, and size.

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

◆ endItalicTag()

PhpOffice\PhpSpreadsheet\Helper\Html::endItalicTag ( )

protected

Definition at line 742 of file Html.php.

                                      : void
     {
         $this->italic = false;
     }

◆ endStrikethruTag()

PhpOffice\PhpSpreadsheet\Helper\Html::endStrikethruTag ( )

protected

Definition at line 782 of file Html.php.

                                          : void
     {
         $this->strikethrough = false;
     }

◆ endSubscriptTag()

PhpOffice\PhpSpreadsheet\Helper\Html::endSubscriptTag ( )

protected

Definition at line 762 of file Html.php.

                                         : void
     {
         $this->subscript = false;
     }

◆ endSuperscriptTag()

PhpOffice\PhpSpreadsheet\Helper\Html::endSuperscriptTag ( )

protected

Definition at line 772 of file Html.php.

                                           : void
     {
         $this->superscript = false;
     }

◆ endUnderlineTag()

PhpOffice\PhpSpreadsheet\Helper\Html::endUnderlineTag ( )

protected

Definition at line 752 of file Html.php.

                                         : void
     {
         $this->underline = false;
     }

◆ handleCallback()

PhpOffice\PhpSpreadsheet\Helper\Html::handleCallback	(	DOMElement	$element,
			$callbackTag,
		array	$callbacks
	)

protected

Parameters

string $callbackTag

Definition at line 806 of file Html.php.

Referenced by PhpOffice\PhpSpreadsheet\Helper\Html\parseElementNode().

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

Here is the caller graph for this function:

◆ initialise()

PhpOffice\PhpSpreadsheet\Helper\Html::initialise ( )

protected

Definition at line 596 of file Html.php.

References color, and size.

Referenced by PhpOffice\PhpSpreadsheet\Helper\Html\toRichTextObject().

                                    : void
     {
         $this->face = $this->size = $this->color = null;
         $this->bold = $this->italic = $this->underline = $this->superscript = $this->subscript = $this->strikethrough = false;
 
         $this->stack = [];
 
         $this->stringData = '';
     }

Here is the caller graph for this function:

◆ parseElementNode()

PhpOffice\PhpSpreadsheet\Helper\Html::parseElementNode ( DOMElement $element )

protected

Definition at line 816 of file Html.php.

References PhpOffice\PhpSpreadsheet\Helper\Html\handleCallback(), and PhpOffice\PhpSpreadsheet\Helper\Html\parseElements().

Referenced by PhpOffice\PhpSpreadsheet\Helper\Html\parseElements().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseElements()

PhpOffice\PhpSpreadsheet\Helper\Html::parseElements ( DOMNode $element )

protected

Definition at line 829 of file Html.php.

References PhpOffice\PhpSpreadsheet\Helper\Html\parseElementNode(), and PhpOffice\PhpSpreadsheet\Helper\Html\parseTextNode().

Referenced by PhpOffice\PhpSpreadsheet\Helper\Html\parseElementNode(), and PhpOffice\PhpSpreadsheet\Helper\Html\toRichTextObject().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseTextNode()

PhpOffice\PhpSpreadsheet\Helper\Html::parseTextNode ( DOMText $textNode )

protected

Definition at line 792 of file Html.php.

References PhpOffice\PhpSpreadsheet\Helper\Html\buildTextRun().

Referenced by PhpOffice\PhpSpreadsheet\Helper\Html\parseElements().

                                                        : void
     {
         $domText = preg_replace(
             '/\s+/u',
             ' ',
             str_replace(["\r", "\n"], ' ', $textNode->nodeValue)
         );
         $this->stringData .= $domText;
         $this->buildTextRun();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rgbToColour()

PhpOffice\PhpSpreadsheet\Helper\Html::rgbToColour ( $rgb )

protected

Definition at line 687 of file Html.php.

References $values.

Referenced by PhpOffice\PhpSpreadsheet\Helper\Html\startFontTag().

     {
         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]);
     }

Here is the caller graph for this function:

◆ startBoldTag()

PhpOffice\PhpSpreadsheet\Helper\Html::startBoldTag ( )

protected

Definition at line 727 of file Html.php.

                                      : void
     {
         $this->bold = true;
     }

◆ startFontTag()

PhpOffice\PhpSpreadsheet\Helper\Html::startFontTag ( $tag )

protected

Definition at line 702 of file Html.php.

References $tag, and PhpOffice\PhpSpreadsheet\Helper\Html\rgbToColour().

                                          : void
     {
         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 = static::colourNameLookup($attributeValue);
                 }
             } else {
                 $this->$attributeName = $attributeValue;
             }
         }
     }

Here is the call graph for this function:

◆ startItalicTag()

PhpOffice\PhpSpreadsheet\Helper\Html::startItalicTag ( )

protected

Definition at line 737 of file Html.php.

                                        : void
     {
         $this->italic = true;
     }

◆ startStrikethruTag()

PhpOffice\PhpSpreadsheet\Helper\Html::startStrikethruTag ( )

protected

Definition at line 777 of file Html.php.

                                            : void
     {
         $this->strikethrough = true;
     }

◆ startSubscriptTag()

PhpOffice\PhpSpreadsheet\Helper\Html::startSubscriptTag ( )

protected

Definition at line 757 of file Html.php.

                                           : void
     {
         $this->subscript = true;
     }

◆ startSuperscriptTag()

PhpOffice\PhpSpreadsheet\Helper\Html::startSuperscriptTag ( )

protected

Definition at line 767 of file Html.php.

                                             : void
     {
         $this->superscript = true;
     }

◆ startUnderlineTag()

PhpOffice\PhpSpreadsheet\Helper\Html::startUnderlineTag ( )

protected

Definition at line 747 of file Html.php.

                                           : void
     {
         $this->underline = true;
     }

◆ toRichTextObject()

PhpOffice\PhpSpreadsheet\Helper\Html::toRichTextObject ( $html )

Parse HTML formatting and return the resulting RichText.

Parameters

string $html

Returns: RichText

Definition at line 613 of file Html.php.

References $html, PhpOffice\PhpSpreadsheet\Helper\Html\$richTextObject, PhpOffice\PhpSpreadsheet\Helper\Html\cleanWhitespace(), PhpOffice\PhpSpreadsheet\Helper\Html\initialise(), and PhpOffice\PhpSpreadsheet\Helper\Html\parseElements().

     {
         $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
         $prefix = '<?xml encoding="UTF-8">';
         @$dom->loadHTML($prefix . $html, LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD);
         //    Discard excess white space
         $dom->preserveWhiteSpace = false;
 
         $this->richTextObject = new RichText();
         $this->parseElements($dom);
 
         // Clean any further spurious whitespace
         $this->cleanWhitespace();
 
         return $this->richTextObject;
     }

Here is the call graph for this function:

Field Documentation

◆ $bold

PhpOffice\PhpSpreadsheet\Helper\Html::$bold = false

protected

Definition at line 541 of file Html.php.

◆ $color

PhpOffice\PhpSpreadsheet\Helper\Html::$color

protected

Definition at line 539 of file Html.php.

◆ $colourMap

PhpOffice\PhpSpreadsheet\Helper\Html::$colourMap

staticprotected

Initial value:

= [

'aliceblue' => 'f0f8ff'

Definition at line 15 of file Html.php.

◆ $endTagCallbacks

PhpOffice\PhpSpreadsheet\Helper\Html::$endTagCallbacks

protected

Initial value:

= [

'font' => 'endFontTag'

Definition at line 566 of file Html.php.

◆ $face

PhpOffice\PhpSpreadsheet\Helper\Html::$face

protected

Definition at line 17 of file Html.php.

◆ $italic

PhpOffice\PhpSpreadsheet\Helper\Html::$italic = false

protected

Definition at line 543 of file Html.php.

◆ $richTextObject

PhpOffice\PhpSpreadsheet\Helper\Html::$richTextObject

protected

Definition at line 594 of file Html.php.

Referenced by PhpOffice\PhpSpreadsheet\Helper\Html\toRichTextObject().

◆ $size

PhpOffice\PhpSpreadsheet\Helper\Html::$size

protected

Definition at line 537 of file Html.php.

◆ $stack

PhpOffice\PhpSpreadsheet\Helper\Html::$stack = []

protected

Definition at line 587 of file Html.php.

◆ $startTagCallbacks

PhpOffice\PhpSpreadsheet\Helper\Html::$startTagCallbacks

protected

Initial value:

= [

'font' => 'startFontTag'

Definition at line 553 of file Html.php.

◆ $strikethrough

PhpOffice\PhpSpreadsheet\Helper\Html::$strikethrough = false

protected

Definition at line 551 of file Html.php.

◆ $stringData

PhpOffice\PhpSpreadsheet\Helper\Html::$stringData = ''

protected

Definition at line 589 of file Html.php.

Referenced by PhpOffice\PhpSpreadsheet\Helper\Html\buildTextRun().

◆ $subscript

PhpOffice\PhpSpreadsheet\Helper\Html::$subscript = false

protected

Definition at line 549 of file Html.php.

◆ $superscript

PhpOffice\PhpSpreadsheet\Helper\Html::$superscript = false

protected

Definition at line 547 of file Html.php.

◆ $underline

PhpOffice\PhpSpreadsheet\Helper\Html::$underline = false

protected

Definition at line 545 of file Html.php.

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

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Helper/Html.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ breakTag()

◆ buildTextRun()

◆ cleanWhitespace()

◆ 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