PHPExcel_Writer_Excel5_Font Class Reference

Collaboration diagram for PHPExcel_Writer_Excel5_Font:

Public Member Functions
	__construct (PHPExcel_Style_Font $font=null)
	Constructor. More...
	setColorIndex ($colorIndex)
	Set the color index. More...
	writeFont ()
	Get font record data. More...

Static Private Member Functions
static	_mapBold ($bold)
	Map to BIFF5-BIFF8 codes for bold. More...
static	_mapUnderline ($underline)
	Map underline. More...

Private Attributes
	$_colorIndex
	$_font

Static Private Attributes
static	$_mapUnderline
	Map of BIFF2-BIFF8 codes for underline styles. More...

Detailed Description

Definition at line 36 of file Font.php.

Constructor & Destructor Documentation

__construct()

PHPExcel_Writer_Excel5_Font::__construct

(

PHPExcel_Style_Font

$font = null

)

Constructor.

Parameters

PHPExcel_Style_Font

$font

Definition at line 57 of file Font.php.

        {
                $this->_colorIndex = 0x7FFF;
                $this->_font = $font;
        }

Member Function Documentation

_mapBold()

static PHPExcel_Writer_Excel5_Font::_mapBold (   $bold )

staticprivate

Map to BIFF5-BIFF8 codes for bold.

Parameters

boolean

$bold

Returns

int

Definition at line 135 of file Font.php.

                                                {
                if ($bold) {
                        return 0x2BC;   //      700 = Bold font weight
                }
                return 0x190;           //      400 = Normal font weight
        }

_mapUnderline()

static PHPExcel_Writer_Excel5_Font::_mapUnderline (   $underline )

staticprivate

Map underline.

Parameters

string

Returns

int

Definition at line 159 of file Font.php.

                                                          {
                if (isset(self::$_mapUnderline[$underline]))
                        return self::$_mapUnderline[$underline];
                return 0x00;
        }

setColorIndex()

PHPExcel_Writer_Excel5_Font::setColorIndex

(

$colorIndex

)

Set the color index.

Parameters

int

$colorIndex

Definition at line 68 of file Font.php.

        {
                $this->_colorIndex = $colorIndex;
        }

writeFont()

PHPExcel_Writer_Excel5_Font::writeFont

(

)

Get font record data.

Returns

string

Definition at line 78 of file Font.php.

References $_colorIndex, $data, $header, PHPExcel_Shared_Font\getCharsetFromFontName(), and PHPExcel_Shared_String\UTF8toBIFF8UnicodeShort().

        {
                $font_outline = 0;
                $font_shadow = 0;

                $icv = $this->_colorIndex; // Index to color palette
                if ($this->_font->getSuperScript()) {
                        $sss = 1;
                } else if ($this->_font->getSubScript()) {
                        $sss = 2;
                } else {
                        $sss = 0;
                }
                $bFamily = 0; // Font family
                $bCharSet = PHPExcel_Shared_Font::getCharsetFromFontName($this->_font->getName()); // Character set

                $record = 0x31;         // Record identifier
                $reserved = 0x00;       // Reserved
                $grbit = 0x00;          // Font attributes
                if ($this->_font->getItalic()) {
                        $grbit |= 0x02;
                }
                if ($this->_font->getStrikethrough()) {
                        $grbit |= 0x08;
                }
                if ($font_outline) {
                        $grbit |= 0x10;
                }
                if ($font_shadow) {
                        $grbit |= 0x20;
                }

                $data = pack("vvvvvCCCC",
                        $this->_font->getSize() * 20,                                           //      Fontsize (in twips)
                        $grbit,
                        $icv,                                                                                           //      Colour
                        self::_mapBold($this->_font->getBold()),                        //      Font weight
                        $sss,                                                                                           //      Superscript/Subscript
                        self::_mapUnderline($this->_font->getUnderline()),
                        $bFamily,
                        $bCharSet,
                        $reserved
                );
                $data .= PHPExcel_Shared_String::UTF8toBIFF8UnicodeShort($this->_font->getName());

                $length = strlen($data);
                $header = pack("vv", $record, $length);

                return($header . $data);
        }

Here is the call graph for this function:

Field Documentation

$_colorIndex

PHPExcel_Writer_Excel5_Font::$_colorIndex

private

Definition at line 43 of file Font.php.

Referenced by writeFont().

$_font

PHPExcel_Writer_Excel5_Font::$_font

private

Definition at line 50 of file Font.php.

$_mapUnderline

PHPExcel_Writer_Excel5_Font::$_mapUnderline

staticprivate

Initial value:

= array(        PHPExcel_Style_Font::UNDERLINE_NONE                                     => 0x00,
                                                                                        PHPExcel_Style_Font::UNDERLINE_SINGLE                           => 0x01,
                                                                                        PHPExcel_Style_Font::UNDERLINE_DOUBLE                           => 0x02,
                                                                                        PHPExcel_Style_Font::UNDERLINE_SINGLEACCOUNTING         => 0x21,
                                                                                        PHPExcel_Style_Font::UNDERLINE_DOUBLEACCOUNTING         => 0x22,
                                                                                 )

Map of BIFF2-BIFF8 codes for underline styles.

array of int

Definition at line 147 of file Font.php.

---

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

• libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/Writer/Excel5/Font.php