Files
FHC-Core/include/ezcomponents/Graph/src/options/font.php
T
Andreas Österreicher 0a8e90a8b3 EZ-Components
2009-02-17 15:27:43 +00:00

293 lines
10 KiB
PHP

<?php
/**
* File containing the ezcGraphFontOption class
*
* @package Graph
* @version 1.3
* @copyright Copyright (C) 2005-2008 eZ systems as. All rights reserved.
* @license http://ez.no/licenses/new_bsd New BSD License
*/
/**
* Class containing the options for font configuration.
*
* Global font settings will only affect the font settings of chart elements
* until they were modified once. Form then on the font configuration of one
* chart element has been copied and can only be configured independently.
*
* <code>
* $graph = new ezcGraphPieChart();
* $graph->palette = new ezcGraphPaletteEzBlue();
* $graph->title = 'Access statistics';
*
* $graph->options->font->name = 'serif';
* $graph->options->font->maxFontSize = 12;
*
* $graph->title->background = '#EEEEEC';
* $graph->title->font->name = 'sans-serif';
*
* $graph->options->font->maxFontSize = 8;
*
* $graph->data['Access statistics'] = new ezcGraphArrayDataSet( array(
* 'Mozilla' => 19113,
* 'Explorer' => 10917,
* 'Opera' => 1464,
* 'Safari' => 652,
* 'Konqueror' => 474,
* ) );
*
* $graph->render( 400, 150, 'tutorial_chart_title.svg' );
* </code>
*
* @property string $name
* Name of font.
* @property string $path
* Path to font file.
* @property int $type
* Type of used font. May be one of the following:
* - TTF_FONT Native TTF fonts
* - PS_FONT PostScript Type1 fonts
* - FT2_FONT FreeType 2 fonts
* @property float $minFontSize
* Minimum font size for displayed texts.
* @property float $maxFontSize
* Maximum font size for displayed texts.
* @property float $minimalUsedFont
* The minimal used font size for this element.
* @property ezcGraphColor $color
* Font color.
* @property ezcGraphColor $background
* Background color
* @property ezcGraphColor $border
* Border color
* @property int $borderWidth
* Border width
* @property int $padding
* Padding between text and border
* @property bool $minimizeBorder
* Fit the border exactly around the text, or use the complete
* possible space.
* @property bool $textShadow
* Draw shadow for texts
* @property int $textShadowOffset
* Offset for text shadow
* @property ezcGraphColor $textShadowColor
* Color of text shadow. If false the inverse color of the text
* color will be used.
*
* @version 1.3
* @package Graph
*/
class ezcGraphFontOptions extends ezcBaseOptions
{
/**
* Indicates if path already has been checked for correct font
*
* @var bool
*/
protected $pathChecked = false;
/**
* Constructor
*
* @param array $options Default option array
* @return void
* @ignore
*/
public function __construct( array $options = array() )
{
$this->properties['name'] = 'sans-serif';
// $this->properties['path'] = 'Graph/tests/data/font.ttf';
$this->properties['path'] = '';
$this->properties['type'] = ezcGraph::TTF_FONT;
$this->properties['minFontSize'] = 6;
$this->properties['maxFontSize'] = 96;
$this->properties['minimalUsedFont'] = 96;
$this->properties['color'] = ezcGraphColor::fromHex( '#000000' );
$this->properties['background'] = false;
$this->properties['border'] = false;
$this->properties['borderWidth'] = 1;
$this->properties['padding'] = 0;
$this->properties['minimizeBorder'] = true;
$this->properties['textShadow'] = false;
$this->properties['textShadowOffset'] = 1;
$this->properties['textShadowColor'] = false;
parent::__construct( $options );
}
/**
* Set an option value
*
* @param string $propertyName
* @param mixed $propertyValue
* @throws ezcBasePropertyNotFoundException
* If a property is not defined in this class
* @return void
*/
public function __set( $propertyName, $propertyValue )
{
switch ( $propertyName )
{
case 'minFontSize':
if ( !is_numeric( $propertyValue ) ||
( $propertyValue < 1 ) )
{
throw new ezcBaseValueException( $propertyName, $propertyValue, 'float > 1' );
}
// Ensure min font size is smaller or equal max font size.
if ( $propertyValue > $this->properties['maxFontSize'] )
{
throw new ezcBaseValueException( $propertyName, $propertyValue, 'float <= ' . $this->properties['maxFontSize'] );
}
$this->properties[$propertyName] = (float) $propertyValue;
break;
case 'maxFontSize':
if ( !is_numeric( $propertyValue ) ||
( $propertyValue < 1 ) )
{
throw new ezcBaseValueException( $propertyName, $propertyValue, 'float > 1' );
}
// Ensure max font size is greater or equal min font size.
if ( $propertyValue < $this->properties['minFontSize'] )
{
throw new ezcBaseValueException( $propertyName, $propertyValue, 'float >= ' . $this->properties['minFontSize'] );
}
$this->properties[$propertyName] = (float) $propertyValue;
break;
case 'minimalUsedFont':
$propertyValue = (float) $propertyValue;
if ( $propertyValue < $this->minimalUsedFont )
{
$this->properties['minimalUsedFont'] = $propertyValue;
}
break;
case 'color':
case 'background':
case 'border':
case 'textShadowColor':
$this->properties[$propertyName] = ezcGraphColor::create( $propertyValue );
break;
case 'borderWidth':
case 'padding':
case 'textShadowOffset':
if ( !is_numeric( $propertyValue ) ||
( $propertyValue < 0 ) )
{
throw new ezcBaseValueException( $propertyName, $propertyValue, 'int >= 0' );
}
$this->properties[$propertyName] = (int) $propertyValue;
break;
case 'minimizeBorder':
case 'textShadow':
if ( !is_bool( $propertyValue ) )
{
throw new ezcBaseValueException( $propertyName, $propertyValue, 'bool' );
}
$this->properties[$propertyName] = (bool) $propertyValue;
break;
case 'name':
if ( is_string( $propertyValue ) )
{
$this->properties['name'] = $propertyValue;
}
else
{
throw new ezcBaseValueException( $propertyName, $propertyValue, 'string' );
}
break;
case 'path':
if ( is_file( $propertyValue ) && is_readable( $propertyValue ) )
{
$this->properties['path'] = realpath( $propertyValue );
$parts = pathinfo( $this->properties['path'] );
switch ( strtolower( $parts['extension'] ) )
{
case 'fdb':
$this->properties['type'] = ezcGraph::PALM_FONT;
break;
case 'pfb':
$this->properties['type'] = ezcGraph::PS_FONT;
break;
case 'ttf':
$this->properties['type'] = ezcGraph::TTF_FONT;
break;
case 'svg':
$this->properties['type'] = ezcGraph::SVG_FONT;
$this->properties['name'] = ezcGraphSvgFont::getFontName( $propertyValue );
break;
default:
throw new ezcGraphUnknownFontTypeException( $propertyValue, $parts['extension'] );
}
$this->pathChecked = true;
}
else
{
throw new ezcBaseFileNotFoundException( $propertyValue, 'font' );
}
break;
case 'type':
if ( is_int( $propertyValue ) )
{
$this->properties['type'] = $propertyValue;
}
else
{
throw new ezcBaseValueException( $propertyName, $propertyValue, 'int' );
}
break;
default:
throw new ezcBasePropertyNotFoundException( $propertyName );
break;
}
}
/**
* __get
*
* @param mixed $propertyName
* @throws ezcBasePropertyNotFoundException
* If a the value for the property options is not an instance of
* @return mixed
* @ignore
*/
public function __get( $propertyName )
{
switch ( $propertyName )
{
case 'textShadowColor':
// Use inverted font color if false
if ( $this->properties['textShadowColor'] === false )
{
$this->properties['textShadowColor'] = $this->properties['color']->invert();
}
return $this->properties['textShadowColor'];
case 'path':
if ( $this->pathChecked === false )
{
// Enforce call of path check
$this->__set( 'path', $this->properties['path'] );
}
// No break to use parent return
default:
return parent::__get( $propertyName );
}
}
}
?>