Inheritance diagram for Spreadsheet_Excel_Writer_Format:

Collaboration diagram for Spreadsheet_Excel_Writer_Format:

Public Member Functions
	Spreadsheet_Excel_Writer_Format ($BIFF_version, $index=0, $properties=array())
	Constructor. More...

	getXf ($style)
	Generate an Excel BIFF XF record (style or cell). More...

	getFont ()
	Generate an Excel BIFF FONT record. More...

	getFontKey ()
	Returns a unique hash key for a font. More...

	getXfIndex ()
	Returns the index used by Spreadsheet_Excel_Writer_Worksheet::_XF() More...

	_getColor ($name_color='')
	Used in conjunction with the set_xxx_color methods to convert a color string into a number. More...

	setAlign ($location)
	Set cell alignment. More...

	setHAlign ($location)
	Set cell horizontal alignment. More...

	setVAlign ($location)
	Set cell vertical alignment. More...

	setMerge ()
	This is an alias for the unintuitive setAlign('merge') More...

	setBold ($weight=1)
	Sets the boldness of the text. More...

	setBottom ($style)
	Sets the width for the bottom border of the cell. More...

	setTop ($style)
	Sets the width for the top border of the cell. More...

	setLeft ($style)
	Sets the width for the left border of the cell. More...

	setRight ($style)
	Sets the width for the right border of the cell. More...

	setBorder ($style)
	Set cells borders to the same style. More...

	setBorderColor ($color)
	Sets all the cell's borders to the same color. More...

	setBottomColor ($color)
	Sets the cell's bottom border color. More...

	setTopColor ($color)
	Sets the cell's top border color. More...

	setLeftColor ($color)
	Sets the cell's left border color. More...

	setRightColor ($color)
	Sets the cell's right border color. More...

	setFgColor ($color)
	Sets the cell's foreground color. More...

	setBgColor ($color)
	Sets the cell's background color. More...

	setColor ($color)
	Sets the cell's color. More...

	setPattern ($arg=1)
	Sets the fill pattern attribute of a cell. More...

	setUnderline ($underline)
	Sets the underline of the text. More...

	setItalic ()
	Sets the font style as italic. More...

	setSize ($size)
	Sets the font size. More...

	setTextWrap ()
	Sets text wrapping. More...

	setTextRotation ($angle)
	Sets the orientation of the text. More...

	setNumFormat ($num_format)
	Sets the numeric format. More...

	setStrikeOut ()
	Sets font as strikeout. More...

	setOutLine ()
	Sets outlining for a font. More...

	setShadow ()
	Sets font as shadow. More...

	setScript ($script)
	Sets the script type of the text. More...

	setLocked ()
	Locks a cell. More...

	setUnLocked ()
	Unlocks a cell. More...

	setFontFamily ($font_family)
	Sets the font family name. More...

Public Member Functions inherited from PEAR
	PEAR ($error_class=null)
	Constructor. More...

	_PEAR ()
	Destructor (the emulated type of...). More...

&	getStaticProperty ($class, $var)
	If you have a class that's mostly/entirely static, and you need static properties, you can use this method to simulate them. More...

	registerShutdownFunc ($func, $args=array())
	Use this function to register a shutdown method for static classes. More...

	isError ($data, $code=null)
	Tell whether a value is a PEAR error. More...

	setErrorHandling ($mode=null, $options=null)
	Sets how errors generated by this object should be handled. More...

	expectError ($code=' *')
	This method is used to tell which errors you expect to get. More...

	popExpect ()
	This method pops one element off the expected error codes stack. More...

	_checkDelExpect ($error_code)
	This method checks unsets an error code if available. More...

	delExpect ($error_code)
	This method deletes all occurences of the specified element from the expected error codes stack. More...

&	raiseError ($message=null, $code=null, $mode=null, $options=null, $userinfo=null, $error_class=null, $skipmsg=false)
	This method is a wrapper that returns an instance of the configured error class with this object's default error handling applied. More...

&	throwError ($message=null, $code=null, $userinfo=null)
	Simpler form of raiseError with fewer options. More...

	staticPushErrorHandling ($mode, $options=null)

	staticPopErrorHandling ()

	pushErrorHandling ($mode, $options=null)
	Push a new error handler on top of the error handler options stack. More...

	popErrorHandling ()
	Pop the last error handler used. More...

	loadExtension ($ext)
	OS independant PHP extension load. More...

Data Fields
	$_xf_index

	$font_index

	$_font_name

	$_size

	$_bold

	$_italic

	$_color

	$_underline

	$_font_strikeout

	$_font_outline

	$_font_shadow

	$_font_script

	$_font_family

	$_font_charset

	$_num_format

	$_hidden

	$_locked

	$_text_h_align

	$_text_wrap

	$_text_v_align

	$_text_justlast

	$_rotation

	$_fg_color

	$_bg_color

	$_pattern

	$_bottom

	$_bottom_color

	$_top

	$_top_color

	$_left

	$_left_color

	$_right

	$_right_color

Data Fields inherited from PEAR
	$_debug = false

	$_default_error_mode = null

	$_default_error_options = null

	$_default_error_handler = ''

	$_error_class = 'PEAR_Error'

	$_expected_errors = array()

Detailed Description

Definition at line 45 of file Format.php.

Member Function Documentation

◆ _getColor()

Spreadsheet_Excel_Writer_Format::_getColor ( $name_color = '' )

Used in conjunction with the set_xxx_color methods to convert a color string into a number.

Color range is 0..63 but we will restrict it to 8..63 to comply with Gnumeric. Colors 0..7 are repeated in 8..15.

@access private

Parameters

string $name_color name of the color (i.e.: 'blue', 'red', etc..). Optional.

Returns: integer The color index

Definition at line 533 of file Format.php.

    {
        $colors = array(
                        'aqua'    => 0x0F,
                        'cyan'    => 0x0F,
                        'black'   => 0x08,
                        'blue'    => 0x0C,
                        'brown'   => 0x10,
                        'magenta' => 0x0E,
                        'fuchsia' => 0x0E,
                        'gray'    => 0x17,
                        'grey'    => 0x17,
                        'green'   => 0x11,
                        'lime'    => 0x0B,
                        'navy'    => 0x12,
                        'orange'  => 0x35,
                        'purple'  => 0x14,
                        'red'     => 0x0A,
                        'silver'  => 0x16,
                        'white'   => 0x09,
                        'yellow'  => 0x0D
                       );
 
        // Return the default color, 0x7FFF, if undef,
        if ($name_color == '') {
            return(0x7FFF);
        }
 
        // or the color string converted to an integer,
        if (isset($colors[$name_color])) {
            return($colors[$name_color]);
        }
 
        // or the default color if string is unrecognised,
        if (preg_match("/\D/",$name_color)) {
            return(0x7FFF);
        }
 
        // or an index < 8 mapped into the correct range,
        if ($name_color < 8) {
            return($name_color + 8);
        }
 
        // or the default color if arg is outside range,
        if ($name_color > 63) {
            return(0x7FFF);
        }
 
        // or an integer in the valid range
        return($name_color);
    }

Referenced by setBgColor(), setBottomColor(), setColor(), setFgColor(), setLeftColor(), setRightColor(), and setTopColor().

Here is the caller graph for this function:

◆ getFont()

Spreadsheet_Excel_Writer_Format::getFont ( )

Generate an Excel BIFF FONT record.

Returns: string The FONT record

Definition at line 447 of file Format.php.

    {
        $dyHeight   = $this->_size * 20;    // Height of font (1/20 of a point)
        $icv        = $this->_color;        // Index to color palette
        $bls        = $this->_bold;         // Bold style
        $sss        = $this->_font_script;  // Superscript/subscript
        $uls        = $this->_underline;    // Underline
        $bFamily    = $this->_font_family;  // Font family
        $bCharSet   = $this->_font_charset; // Character set
        $encoding   = 0;                    // TODO: Unicode support
 
        $cch        = strlen($this->_font_name); // Length of font name
        $record     = 0x31;                      // Record identifier
        if ($this->_BIFF_version == 0x0500) {
            $length     = 0x0F + $cch;            // Record length
        } elseif ($this->_BIFF_version == 0x0600) {
            $length     = 0x10 + $cch;
        }
        $reserved   = 0x00;                // Reserved
        $grbit      = 0x00;                // Font attributes
        if ($this->_italic) {
            $grbit     |= 0x02;
        }
        if ($this->_font_strikeout) {
            $grbit     |= 0x08;
        }
        if ($this->_font_outline) {
            $grbit     |= 0x10;
        }
        if ($this->_font_shadow) {
            $grbit     |= 0x20;
        }
 
        $header  = pack("vv",         $record, $length);
        if ($this->_BIFF_version == 0x0500) {
            $data    = pack("vvvvvCCCCC", $dyHeight, $grbit, $icv, $bls,
                                          $sss, $uls, $bFamily,
                                          $bCharSet, $reserved, $cch);
        } elseif ($this->_BIFF_version == 0x0600) {
            $data    = pack("vvvvvCCCCCC", $dyHeight, $grbit, $icv, $bls,
                                           $sss, $uls, $bFamily,
                                           $bCharSet, $reserved, $cch, $encoding);
        }
        return($header . $data . $this->_font_name);
    }

References $_bold, $_color, $_font_charset, $_font_family, $_font_script, $_underline, $data, and $header.

◆ getFontKey()

Spreadsheet_Excel_Writer_Format::getFontKey ( )

Returns a unique hash key for a font.

Used by Spreadsheet_Excel_Writer_Workbook::_storeAllFonts()

The elements that form the key are arranged to increase the probability of generating a unique key. Elements that hold a large range of numbers (eg. _color) are placed between two binary elements such as _italic

Returns: string A key for this font

Definition at line 503 of file Format.php.

    {
        $key  = "$this->_font_name$this->_size";
        $key .= "$this->_font_script$this->_underline";
        $key .= "$this->_font_strikeout$this->_bold$this->_font_outline";
        $key .= "$this->_font_family$this->_font_charset";
        $key .= "$this->_font_shadow$this->_color$this->_italic";
        $key  = str_replace(' ', '_', $key);
        return ($key);
    }

◆ getXf()

Spreadsheet_Excel_Writer_Format::getXf ( $style )

Generate an Excel BIFF XF record (style or cell).

Parameters

string $style The type of the XF record ('style' or 'cell').

Returns: string The XF record

Definition at line 315 of file Format.php.

    {
        // Set the type of the XF record and some of the attributes.
        if ($style == 'style') {
            $style = 0xFFF5;
        } else {
            $style   = $this->_locked;
            $style  |= $this->_hidden << 1;
        }
 
        // Flags to indicate if attributes have been set.
        $atr_num     = ($this->_num_format != 0)?1:0;
        $atr_fnt     = ($this->font_index != 0)?1:0;
        $atr_alc     = ($this->_text_wrap)?1:0;
        $atr_bdr     = ($this->_bottom   ||
                        $this->_top      ||
                        $this->_left     ||
                        $this->_right)?1:0;
        $atr_pat     = (($this->_fg_color != 0x40) ||
                        ($this->_bg_color != 0x41) ||
                        $this->_pattern)?1:0;
        $atr_prot    = $this->_locked | $this->_hidden;
 
        // Zero the default border colour if the border has not been set.
        if ($this->_bottom == 0) {
            $this->_bottom_color = 0;
        }
        if ($this->_top  == 0) {
            $this->_top_color = 0;
        }
        if ($this->_right == 0) {
            $this->_right_color = 0;
        }
        if ($this->_left == 0) {
            $this->_left_color = 0;
        }
        if ($this->_diag == 0) {
            $this->_diag_color = 0;
        }
 
        $record         = 0x00E0;              // Record identifier
        if ($this->_BIFF_version == 0x0500) {
            $length         = 0x0010;              // Number of bytes to follow
        }
        if ($this->_BIFF_version == 0x0600) {
            $length         = 0x0014;
        }
 
        $ifnt           = $this->font_index;   // Index to FONT record
        $ifmt           = $this->_num_format;  // Index to FORMAT record
        if ($this->_BIFF_version == 0x0500) {
            $align          = $this->_text_h_align;       // Alignment
            $align         |= $this->_text_wrap     << 3;
            $align         |= $this->_text_v_align  << 4;
            $align         |= $this->_text_justlast << 7;
            $align         |= $this->_rotation      << 8;
            $align         |= $atr_num                << 10;
            $align         |= $atr_fnt                << 11;
            $align         |= $atr_alc                << 12;
            $align         |= $atr_bdr                << 13;
            $align         |= $atr_pat                << 14;
            $align         |= $atr_prot               << 15;
 
            $icv            = $this->_fg_color;       // fg and bg pattern colors
            $icv           |= $this->_bg_color      << 7;
 
            $fill           = $this->_pattern;        // Fill and border line style
            $fill          |= $this->_bottom        << 6;
            $fill          |= $this->_bottom_color  << 9;
 
            $border1        = $this->_top;            // Border line style and color
            $border1       |= $this->_left          << 3;
            $border1       |= $this->_right         << 6;
            $border1       |= $this->_top_color     << 9;
 
            $border2        = $this->_left_color;     // Border color
            $border2       |= $this->_right_color   << 7;
 
            $header      = pack("vv",       $record, $length);
            $data        = pack("vvvvvvvv", $ifnt, $ifmt, $style, $align,
                                            $icv, $fill,
                                            $border1, $border2);
        } elseif ($this->_BIFF_version == 0x0600) {
            $align          = $this->_text_h_align;       // Alignment
            $align         |= $this->_text_wrap     << 3;
            $align         |= $this->_text_v_align  << 4;
            $align         |= $this->_text_justlast << 7;
 
            $used_attrib    = $atr_num              << 2;
            $used_attrib   |= $atr_fnt              << 3;
            $used_attrib   |= $atr_alc              << 4;
            $used_attrib   |= $atr_bdr              << 5;
            $used_attrib   |= $atr_pat              << 6;
            $used_attrib   |= $atr_prot             << 7;
 
            $icv            = $this->_fg_color;      // fg and bg pattern colors
            $icv           |= $this->_bg_color      << 7;
 
            $border1        = $this->_left;          // Border line style and color
            $border1       |= $this->_right         << 4;
            $border1       |= $this->_top           << 8;
            $border1       |= $this->_bottom        << 12;
            $border1       |= $this->_left_color    << 16;
            $border1       |= $this->_right_color   << 23;
            $diag_tl_to_rb = 0; // FIXME: add method
            $diag_tr_to_lb = 0; // FIXME: add method
            $border1       |= $diag_tl_to_rb        << 30;
            $border1       |= $diag_tr_to_lb        << 31;
 
            $border2        = $this->_top_color;    // Border color
            $border2       |= $this->_bottom_color   << 7;
            $border2       |= $this->_diag_color     << 14;
            $border2       |= $this->_diag           << 21;
            $border2       |= $this->_pattern        << 26;
 
            $header      = pack("vv",       $record, $length);
 
            $rotation      = $this->_rotation;
            $biff8_options = 0x00;
            $data  = pack("vvvC", $ifnt, $ifmt, $style, $align);
            $data .= pack("CCC", $rotation, $biff8_options, $used_attrib);
            $data .= pack("VVv", $border1, $border2, $icv);
        }
 
        return($header . $data);
    }

References $_fg_color, $_hidden, $_left, $_left_color, $_locked, $_num_format, $_pattern, $_right, $_rotation, $_text_h_align, $_text_wrap, $_top, $_top_color, $data, $font_index, $header, and $style.

◆ getXfIndex()

Spreadsheet_Excel_Writer_Format::getXfIndex ( )

Returns the index used by Spreadsheet_Excel_Writer_Worksheet::_XF()

Returns: integer The index for the XF record

Definition at line 519 of file Format.php.

    {
        return($this->_xf_index);
    }

◆ setAlign()

Spreadsheet_Excel_Writer_Format::setAlign ( $location )

Set cell alignment.

@access public

Parameters

string $location alignment for the cell ('left', 'right', etc...).

Definition at line 591 of file Format.php.

    {
        if (preg_match("/\d/",$location)) {
            return;                      // Ignore numbers
        }
 
        $location = strtolower($location);
 
        if ($location == 'left') {
            $this->_text_h_align = 1;
        }
        if ($location == 'centre') {
            $this->_text_h_align = 2;
        }
        if ($location == 'center') {
            $this->_text_h_align = 2;
        }
        if ($location == 'right') {
            $this->_text_h_align = 3;
        }
        if ($location == 'fill') {
            $this->_text_h_align = 4;
        }
        if ($location == 'justify') {
            $this->_text_h_align = 5;
        }
        if ($location == 'merge') {
            $this->_text_h_align = 6;
        }
        if ($location == 'equal_space') { // For T.K.
            $this->_text_h_align = 7;
        }
        if ($location == 'top') {
            $this->_text_v_align = 0;
        }
        if ($location == 'vcentre') {
            $this->_text_v_align = 1;
        }
        if ($location == 'vcenter') {
            $this->_text_v_align = 1;
        }
        if ($location == 'bottom') {
            $this->_text_v_align = 2;
        }
        if ($location == 'vjustify') {
            $this->_text_v_align = 3;
        }
        if ($location == 'vequal_space') { // For T.K.
            $this->_text_v_align = 4;
        }
    }

References $location.

Referenced by setMerge().

Here is the caller graph for this function:

◆ setBgColor()

Spreadsheet_Excel_Writer_Format::setBgColor ( $color )

Sets the cell's background color.

@access public

Parameters

mixed $color either a string (like 'blue'), or an integer (range is [8...63]).

Definition at line 908 of file Format.php.

    {
        $value = $this->_getColor($color);
        $this->_bg_color = $value;
        if ($this->_pattern == 0) { // force color to be seen
            $this->_pattern = 1;
        }
    }

References _getColor().

Here is the call graph for this function:

◆ setBold()

Spreadsheet_Excel_Writer_Format::setBold ( $weight = 1 )

Sets the boldness of the text.

Bold has a range 100..1000. 0 (400) is normal. 1 (700) is bold.

@access public

Parameters

integer $weight Weight for the text, 0 maps to 400 (normal text), 1 maps to 700 (bold text). Valid range is: 100-1000. It's Optional, default is 1 (bold).

Definition at line 737 of file Format.php.

    {
        if ($weight == 1) {
            $weight = 0x2BC;  // Bold text
        }
        if ($weight == 0) {
            $weight = 0x190;  // Normal text
        }
        if ($weight <  0x064) {
            $weight = 0x190;  // Lower bound
        }
        if ($weight >  0x3E8) {
            $weight = 0x190;  // Upper bound
        }
        $this->_bold = $weight;
    }

◆ setBorder()

Spreadsheet_Excel_Writer_Format::setBorder ( $style )

Set cells borders to the same style.

@access public

Parameters

integer $style style to apply for all cell borders. 1 => thin, 2 => thick.

Definition at line 810 of file Format.php.

    {
        $this->setBottom($style);
        $this->setTop($style);
        $this->setLeft($style);
        $this->setRight($style);
    }

References $style, setBottom(), setLeft(), setRight(), and setTop().

Here is the call graph for this function:

◆ setBorderColor()

Spreadsheet_Excel_Writer_Format::setBorderColor ( $color )

Sets all the cell's borders to the same color.

@access public

Parameters

mixed $color The color we are setting. Either a string (like 'blue'), or an integer (range is [8...63]).

Definition at line 830 of file Format.php.

    {
        $this->setBottomColor($color);
        $this->setTopColor($color);
        $this->setLeftColor($color);
        $this->setRightColor($color);
    }

References setBottomColor(), setLeftColor(), setRightColor(), and setTopColor().

Here is the call graph for this function:

◆ setBottom()

Spreadsheet_Excel_Writer_Format::setBottom ( $style )

Sets the width for the bottom border of the cell.

@access public

Parameters

integer $style style of the cell border. 1 => thin, 2 => thick.

Definition at line 765 of file Format.php.

    {
        $this->_bottom = $style;
    }

References $style.

Referenced by setBorder().

Here is the caller graph for this function:

◆ setBottomColor()

Spreadsheet_Excel_Writer_Format::setBottomColor ( $color )

Sets the cell's bottom border color.

@access public

Parameters

mixed $color either a string (like 'blue'), or an integer (range is [8...63]).

Definition at line 844 of file Format.php.

    {
        $value = $this->_getColor($color);
        $this->_bottom_color = $value;
    }

References _getColor().

Referenced by setBorderColor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setColor()

Spreadsheet_Excel_Writer_Format::setColor ( $color )

Sets the cell's color.

@access public

Parameters

mixed $color either a string (like 'blue'), or an integer (range is [8...63]).

Definition at line 923 of file Format.php.

    {
        $value = $this->_getColor($color);
        $this->_color = $value;
    }

References _getColor().

Here is the call graph for this function:

◆ setFgColor()

Spreadsheet_Excel_Writer_Format::setFgColor ( $color )

Sets the cell's foreground color.

@access public

Parameters

mixed $color either a string (like 'blue'), or an integer (range is [8...63]).

Definition at line 893 of file Format.php.

    {
        $value = $this->_getColor($color);
        $this->_fg_color = $value;
        if ($this->_pattern == 0) { // force color to be seen
            $this->_pattern = 1;
        }
    }

References _getColor().

Here is the call graph for this function:

◆ setFontFamily()

Spreadsheet_Excel_Writer_Format::setFontFamily ( $font_family )

Sets the font family name.

@access public

Parameters

string $fontfamily The font family name. Possible values are: 'Times New Roman', 'Arial', 'Courier'.

Definition at line 1109 of file Format.php.

    {
        $this->_font_name = $font_family;
    }

◆ setHAlign()

Spreadsheet_Excel_Writer_Format::setHAlign ( $location )

Set cell horizontal alignment.

@access public

Parameters

string $location alignment for the cell ('left', 'right', etc...).

Definition at line 649 of file Format.php.

    {
        if (preg_match("/\d/",$location)) {
            return;                      // Ignore numbers
        }
    
        $location = strtolower($location);
    
        if ($location == 'left') {
            $this->_text_h_align = 1;
        }
        if ($location == 'centre') {
            $this->_text_h_align = 2;
        }
        if ($location == 'center') {
            $this->_text_h_align = 2;
        }
        if ($location == 'right') {
            $this->_text_h_align = 3;
        }
        if ($location == 'fill') {
            $this->_text_h_align = 4;
        }
        if ($location == 'justify') {
            $this->_text_h_align = 5;
        }
        if ($location == 'merge') {
            $this->_text_h_align = 6;
        }
        if ($location == 'equal_space') { // For T.K.
            $this->_text_h_align = 7;
        }
    }

References $location.

◆ setItalic()

Spreadsheet_Excel_Writer_Format::setItalic ( )

Sets the font style as italic.

@access public

Definition at line 958 of file Format.php.

    {
        $this->_italic = 1;
    }

◆ setLeft()

Spreadsheet_Excel_Writer_Format::setLeft ( $style )

Sets the width for the left border of the cell.

@access public

Parameters

integer $style style of the cell left border. 1 => thin, 2 => thick.

Definition at line 787 of file Format.php.

    {
        $this->_left = $style;
    }

References $style.

Referenced by setBorder().

Here is the caller graph for this function:

◆ setLeftColor()

Spreadsheet_Excel_Writer_Format::setLeftColor ( $color )

Sets the cell's left border color.

@access public

Parameters

mixed $color either a string (like 'blue'), or an integer (range is [8...63]).

Definition at line 868 of file Format.php.

    {
        $value = $this->_getColor($color);
        $this->_left_color = $value;
    }

References _getColor().

Referenced by setBorderColor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setLocked()

Spreadsheet_Excel_Writer_Format::setLocked ( )

Locks a cell.

@access public

Definition at line 1087 of file Format.php.

     {
         $this->_locked = 1;
     }

◆ setMerge()

Spreadsheet_Excel_Writer_Format::setMerge ( )

This is an alias for the unintuitive setAlign('merge')

@access public

Definition at line 722 of file Format.php.

    {
        $this->setAlign('merge');
    }

References setAlign().

Here is the call graph for this function:

◆ setNumFormat()

Spreadsheet_Excel_Writer_Format::setNumFormat ( $num_format )

Sets the numeric format.

It can be date, time, currency, etc...

@access public

Parameters

integer $num_format The numeric format.

Definition at line 1035 of file Format.php.

    {
        $this->_num_format = $num_format;
    }

◆ setOutLine()

Spreadsheet_Excel_Writer_Format::setOutLine ( )

Sets outlining for a font.

@access public

Definition at line 1055 of file Format.php.

    {
        $this->_font_outline = 1;
    }

◆ setPattern()

Spreadsheet_Excel_Writer_Format::setPattern ( $arg = 1 )

Sets the fill pattern attribute of a cell.

@access public

Parameters

integer $arg Optional. Defaults to 1. Meaningful values are: 0-18, 0 meaning no background.

Definition at line 936 of file Format.php.

    {
        $this->_pattern = $arg;
    }

◆ setRight()

Spreadsheet_Excel_Writer_Format::setRight ( $style )

Sets the width for the right border of the cell.

@access public

Parameters

integer $style style of the cell right border. 1 => thin, 2 => thick.

Definition at line 798 of file Format.php.

    {
        $this->_right = $style;
    }

References $style.

Referenced by setBorder().

Here is the caller graph for this function:

◆ setRightColor()

Spreadsheet_Excel_Writer_Format::setRightColor ( $color )

Sets the cell's right border color.

@access public

Parameters

mixed $color either a string (like 'blue'), or an integer (range is [8...63]).

Definition at line 880 of file Format.php.

    {
        $value = $this->_getColor($color);
        $this->_right_color = $value;
    }

References _getColor().

Referenced by setBorderColor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setScript()

Spreadsheet_Excel_Writer_Format::setScript ( $script )

Sets the script type of the text.

@access public

Parameters

integer $script The value for script type. Possible values are: 1 => superscript, 2 => subscript.

Definition at line 1077 of file Format.php.

    {
        $this->_font_script = $script;
    }

◆ setShadow()

Spreadsheet_Excel_Writer_Format::setShadow ( )

Sets font as shadow.

@access public

Definition at line 1065 of file Format.php.

    {
        $this->_font_shadow = 1;
    }

◆ setSize()

Spreadsheet_Excel_Writer_Format::setSize ( $size )

Sets the font size.

@access public

Parameters

integer $size The font size (in pixels I think).

Definition at line 969 of file Format.php.

    {
        $this->_size = $size;
    }

References $size.

◆ setStrikeOut()

Spreadsheet_Excel_Writer_Format::setStrikeOut ( )

Sets font as strikeout.

@access public

Definition at line 1045 of file Format.php.

    {
        $this->_font_strikeout = 1;
    }

◆ setTextRotation()

Spreadsheet_Excel_Writer_Format::setTextRotation ( $angle )

Sets the orientation of the text.

@access public

Parameters

integer $angle The rotation angle for the text (clockwise). Possible values are: 0, 90, 270 and -1 for stacking top-to-bottom.

Definition at line 991 of file Format.php.

    {
        switch ($angle)
        {
            case 0:
                $this->_rotation = 0;
                break;
            case 90:
                if ($this->_BIFF_version == 0x0500) {
                $this->_rotation = 3;
                } elseif ($this->_BIFF_version == 0x0600) {
                    $this->_rotation = 180;
                }
                break;
            case 270:
                if ($this->_BIFF_version == 0x0500) {
                $this->_rotation = 2;
                } elseif ($this->_BIFF_version == 0x0600) {
                    $this->_rotation = 90;
                }
                break;
            case -1:
                if ($this->_BIFF_version == 0x0500) {
                $this->_rotation = 1;
                } elseif ($this->_BIFF_version == 0x0600) {
                    $this->_rotation = 255;
                }
                break;
            default :
                return $this->raiseError("Invalid value for angle.".
                                  " Possible values are: 0, 90, 270 and -1 ".
                                  "for stacking top-to-bottom.");
                $this->_rotation = 0;
                break;
        }
    }

References $angle, and PEAR\raiseError().

Here is the call graph for this function:

◆ setTextWrap()

Spreadsheet_Excel_Writer_Format::setTextWrap ( )

Sets text wrapping.

@access public

Definition at line 979 of file Format.php.

    {
        $this->_text_wrap = 1;
    }

◆ setTop()

Spreadsheet_Excel_Writer_Format::setTop ( $style )

Sets the width for the top border of the cell.

@access public

Parameters

integer $style style of the cell top border. 1 => thin, 2 => thick.

Definition at line 776 of file Format.php.

    {
        $this->_top = $style;
    }

References $style.

Referenced by setBorder().

Here is the caller graph for this function:

◆ setTopColor()

Spreadsheet_Excel_Writer_Format::setTopColor ( $color )

Sets the cell's top border color.

@access public

Parameters

mixed $color either a string (like 'blue'), or an integer (range is [8...63]).

Definition at line 856 of file Format.php.

    {
        $value = $this->_getColor($color);
        $this->_top_color = $value;
    }

References _getColor().

Referenced by setBorderColor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setUnderline()

Spreadsheet_Excel_Writer_Format::setUnderline ( $underline )

Sets the underline of the text.

@access public

Parameters

integer $underline The value for underline. Possible values are: 1 => underline, 2 => double underline.

Definition at line 948 of file Format.php.

    {
        $this->_underline = $underline;
    }

◆ setUnLocked()

Spreadsheet_Excel_Writer_Format::setUnLocked ( )

Unlocks a cell.

Useful for unprotecting particular cells of a protected sheet.

@access public

Definition at line 1097 of file Format.php.

    {
        $this->_locked = 0;
    }

◆ setVAlign()

Spreadsheet_Excel_Writer_Format::setVAlign ( $location )

Set cell vertical alignment.

@access public

Parameters

string $location alignment for the cell ('top', 'vleft', 'vright', etc...).

Definition at line 689 of file Format.php.

    {
        if (preg_match("/\d/",$location)) {
            return;                      // Ignore numbers
        }
    
        $location = strtolower($location);
 
        if ($location == 'top') {
            $this->_text_v_align = 0;
        }
        if ($location == 'vcentre') {
            $this->_text_v_align = 1;
        }
        if ($location == 'vcenter') {
            $this->_text_v_align = 1;
        }
        if ($location == 'bottom') {
            $this->_text_v_align = 2;
        }
        if ($location == 'vjustify') {
            $this->_text_v_align = 3;
        }
        if ($location == 'vequal_space') { // For T.K.
            $this->_text_v_align = 4;
        }
    }

References $location.

◆ Spreadsheet_Excel_Writer_Format()

Spreadsheet_Excel_Writer_Format::Spreadsheet_Excel_Writer_Format	(	$BIFF_version,
		$index = `0`,
		$properties = `array()`
	)

Constructor.

@access private

Parameters

integer	$index	the XF index for the format.
array	$properties	array with properties to be set on initialization.

Definition at line 252 of file Format.php.

    {
        $this->_xf_index       = $index;
        $this->_BIFF_version   = $BIFF_version;
        $this->font_index      = 0;
        $this->_font_name      = 'Arial';
        $this->_size           = 10;
        $this->_bold           = 0x0190;
        $this->_italic         = 0;
        $this->_color          = 0x7FFF;
        $this->_underline      = 0;
        $this->_font_strikeout = 0;
        $this->_font_outline   = 0;
        $this->_font_shadow    = 0;
        $this->_font_script    = 0;
        $this->_font_family    = 0;
        $this->_font_charset   = 0;
 
        $this->_num_format     = 0;
 
        $this->_hidden         = 0;
        $this->_locked         = 0;
 
        $this->_text_h_align   = 0;
        $this->_text_wrap      = 0;
        $this->_text_v_align   = 2;
        $this->_text_justlast  = 0;
        $this->_rotation       = 0;
 
        $this->_fg_color       = 0x40;
        $this->_bg_color       = 0x41;
 
        $this->_pattern        = 0;
 
        $this->_bottom         = 0;
        $this->_top            = 0;
        $this->_left           = 0;
        $this->_right          = 0;
        $this->_diag           = 0;
 
        $this->_bottom_color   = 0x40;
        $this->_top_color      = 0x40;
        $this->_left_color     = 0x40;
        $this->_right_color    = 0x40;
        $this->_diag_color     = 0x40;
 
        // Set properties passed to Spreadsheet_Excel_Writer_Workbook::addFormat()
        foreach ($properties as $property => $value)
        {
            if (method_exists($this, 'set'.ucwords($property))) {
                $method_name = 'set'.ucwords($property);
                $this->$method_name($value);
            }
        }
    }

Field Documentation

◆ $_bg_color

Spreadsheet_Excel_Writer_Format::$_bg_color

Definition at line 189 of file Format.php.

◆ $_bold

Spreadsheet_Excel_Writer_Format::$_bold

Definition at line 75 of file Format.php.

Referenced by getFont().

◆ $_bottom

Spreadsheet_Excel_Writer_Format::$_bottom

Definition at line 201 of file Format.php.

◆ $_bottom_color

Spreadsheet_Excel_Writer_Format::$_bottom_color

Definition at line 207 of file Format.php.

◆ $_color

Spreadsheet_Excel_Writer_Format::$_color

Definition at line 87 of file Format.php.

Referenced by getFont().

◆ $_fg_color

Spreadsheet_Excel_Writer_Format::$_fg_color

Definition at line 183 of file Format.php.

Referenced by getXf().

◆ $_font_charset

Spreadsheet_Excel_Writer_Format::$_font_charset

Definition at line 129 of file Format.php.

Referenced by getFont().

◆ $_font_family

Spreadsheet_Excel_Writer_Format::$_font_family

Definition at line 123 of file Format.php.

Referenced by getFont().

◆ $_font_name

Spreadsheet_Excel_Writer_Format::$_font_name

Definition at line 63 of file Format.php.

◆ $_font_outline

Spreadsheet_Excel_Writer_Format::$_font_outline

Definition at line 105 of file Format.php.

◆ $_font_script

Spreadsheet_Excel_Writer_Format::$_font_script

Definition at line 117 of file Format.php.

Referenced by getFont().

◆ $_font_shadow

Spreadsheet_Excel_Writer_Format::$_font_shadow

Definition at line 111 of file Format.php.

◆ $_font_strikeout

Spreadsheet_Excel_Writer_Format::$_font_strikeout

Definition at line 99 of file Format.php.

◆ $_hidden

Spreadsheet_Excel_Writer_Format::$_hidden

Definition at line 141 of file Format.php.

Referenced by getXf().

◆ $_italic

Spreadsheet_Excel_Writer_Format::$_italic

Definition at line 81 of file Format.php.

◆ $_left

Spreadsheet_Excel_Writer_Format::$_left

Definition at line 225 of file Format.php.

Referenced by getXf().

◆ $_left_color

Spreadsheet_Excel_Writer_Format::$_left_color

Definition at line 231 of file Format.php.

Referenced by getXf().

◆ $_locked

Spreadsheet_Excel_Writer_Format::$_locked

Definition at line 147 of file Format.php.

Referenced by getXf().

◆ $_num_format

Spreadsheet_Excel_Writer_Format::$_num_format

Definition at line 135 of file Format.php.

Referenced by getXf().

◆ $_pattern

Spreadsheet_Excel_Writer_Format::$_pattern

Definition at line 195 of file Format.php.

Referenced by getXf().

◆ $_right

Spreadsheet_Excel_Writer_Format::$_right

Definition at line 237 of file Format.php.

Referenced by getXf().

◆ $_right_color

Spreadsheet_Excel_Writer_Format::$_right_color

Definition at line 243 of file Format.php.

◆ $_rotation

Spreadsheet_Excel_Writer_Format::$_rotation

Definition at line 177 of file Format.php.

Referenced by getXf().

◆ $_size

Spreadsheet_Excel_Writer_Format::$_size

Definition at line 69 of file Format.php.

◆ $_text_h_align

Spreadsheet_Excel_Writer_Format::$_text_h_align

Definition at line 153 of file Format.php.

Referenced by getXf().

◆ $_text_justlast

Spreadsheet_Excel_Writer_Format::$_text_justlast

Definition at line 171 of file Format.php.

◆ $_text_v_align

Spreadsheet_Excel_Writer_Format::$_text_v_align

Definition at line 165 of file Format.php.

◆ $_text_wrap

Spreadsheet_Excel_Writer_Format::$_text_wrap

Definition at line 159 of file Format.php.

Referenced by getXf().

◆ $_top

Spreadsheet_Excel_Writer_Format::$_top

Definition at line 213 of file Format.php.

Referenced by getXf().

◆ $_top_color

Spreadsheet_Excel_Writer_Format::$_top_color

Definition at line 219 of file Format.php.

Referenced by getXf().

◆ $_underline

Spreadsheet_Excel_Writer_Format::$_underline

Definition at line 93 of file Format.php.

Referenced by getFont().

◆ $_xf_index

Spreadsheet_Excel_Writer_Format::$_xf_index

Definition at line 51 of file Format.php.

◆ $font_index

Spreadsheet_Excel_Writer_Format::$font_index

Definition at line 57 of file Format.php.

Referenced by getXf().

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

Services/PEAR/lib/Spreadsheet/Excel/Writer/Format.php

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ _getColor()

◆ getFont()

◆ getFontKey()

◆ getXf()

◆ getXfIndex()

◆ setAlign()

◆ setBgColor()

◆ setBold()

◆ setBorder()

◆ setBorderColor()

◆ setBottom()

◆ setBottomColor()

◆ setColor()

◆ setFgColor()

◆ setFontFamily()

◆ setHAlign()

◆ setItalic()

◆ setLeft()

◆ setLeftColor()

◆ setLocked()

◆ setMerge()

◆ setNumFormat()

◆ setOutLine()

◆ setPattern()

◆ setRight()

◆ setRightColor()

◆ setScript()

◆ setShadow()

◆ setSize()

◆ setStrikeOut()

◆ setTextRotation()

◆ setTextWrap()

◆ setTop()

◆ setTopColor()

◆ setUnderline()

◆ setUnLocked()

◆ setVAlign()

◆ Spreadsheet_Excel_Writer_Format()

Field Documentation

◆ $_bg_color

◆ $_bold

◆ $_bottom

◆ $_bottom_color

◆ $_color

◆ $_fg_color

◆ $_font_charset

◆ $_font_family

◆ $_font_name

◆ $_font_outline

◆ $_font_script

◆ $_font_shadow

◆ $_font_strikeout

◆ $_hidden

◆ $_italic

◆ $_left

◆ $_left_color

◆ $_locked

◆ $_num_format

◆ $_pattern

◆ $_right

◆ $_right_color

◆ $_rotation

◆ $_size

◆ $_text_h_align

◆ $_text_justlast

◆ $_text_v_align

◆ $_text_wrap

◆ $_top

◆ $_top_color

◆ $_underline

◆ $_xf_index

◆ $font_index