PSR-2 coding standards for the charting

This commit is contained in:
MarkBaker 2015-05-14 23:50:28 +01:00
parent 7d9f45c176
commit 66169af898
2 changed files with 379 additions and 340 deletions

View File

@ -96,7 +96,8 @@ class PHPExcel_Chart_DataSeriesValues
* *
* @return string * @return string
*/ */
public function getDataType() { public function getDataType()
{
return $this->_dataType; return $this->_dataType;
} }
@ -111,7 +112,8 @@ class PHPExcel_Chart_DataSeriesValues
* Normally used for chart data values * Normally used for chart data values
* @return PHPExcel_Chart_DataSeriesValues * @return PHPExcel_Chart_DataSeriesValues
*/ */
public function setDataType($dataType = self::DATASERIES_TYPE_NUMBER) { public function setDataType($dataType = self::DATASERIES_TYPE_NUMBER)
{
if (!in_array($dataType, self::$_dataTypeValues)) { if (!in_array($dataType, self::$_dataTypeValues)) {
throw new PHPExcel_Chart_Exception('Invalid datatype for chart data series values'); throw new PHPExcel_Chart_Exception('Invalid datatype for chart data series values');
} }
@ -125,7 +127,8 @@ class PHPExcel_Chart_DataSeriesValues
* *
* @return string * @return string
*/ */
public function getDataSource() { public function getDataSource()
{
return $this->_dataSource; return $this->_dataSource;
} }
@ -135,7 +138,8 @@ class PHPExcel_Chart_DataSeriesValues
* @param string $dataSource * @param string $dataSource
* @return PHPExcel_Chart_DataSeriesValues * @return PHPExcel_Chart_DataSeriesValues
*/ */
public function setDataSource($dataSource = null, $refreshDataValues = true) { public function setDataSource($dataSource = null, $refreshDataValues = true)
{
$this->_dataSource = $dataSource; $this->_dataSource = $dataSource;
if ($refreshDataValues) { if ($refreshDataValues) {
@ -150,7 +154,8 @@ class PHPExcel_Chart_DataSeriesValues
* *
* @return string * @return string
*/ */
public function getPointMarker() { public function getPointMarker()
{
return $this->_marker; return $this->_marker;
} }
@ -160,7 +165,8 @@ class PHPExcel_Chart_DataSeriesValues
* @param string $marker * @param string $marker
* @return PHPExcel_Chart_DataSeriesValues * @return PHPExcel_Chart_DataSeriesValues
*/ */
public function setPointMarker($marker = null) { public function setPointMarker($marker = null)
{
$this->_marker = $marker; $this->_marker = $marker;
return $this; return $this;
@ -171,7 +177,8 @@ class PHPExcel_Chart_DataSeriesValues
* *
* @return string * @return string
*/ */
public function getFormatCode() { public function getFormatCode()
{
return $this->_formatCode; return $this->_formatCode;
} }
@ -181,7 +188,8 @@ class PHPExcel_Chart_DataSeriesValues
* @param string $formatCode * @param string $formatCode
* @return PHPExcel_Chart_DataSeriesValues * @return PHPExcel_Chart_DataSeriesValues
*/ */
public function setFormatCode($formatCode = null) { public function setFormatCode($formatCode = null)
{
$this->_formatCode = $formatCode; $this->_formatCode = $formatCode;
return $this; return $this;
@ -192,7 +200,8 @@ class PHPExcel_Chart_DataSeriesValues
* *
* @return integer * @return integer
*/ */
public function getPointCount() { public function getPointCount()
{
return $this->_pointCount; return $this->_pointCount;
} }
@ -201,7 +210,8 @@ class PHPExcel_Chart_DataSeriesValues
* *
* @return boolean * @return boolean
*/ */
public function isMultiLevelSeries() { public function isMultiLevelSeries()
{
if (count($this->_dataValues) > 0) { if (count($this->_dataValues) > 0) {
return is_array($this->_dataValues[0]); return is_array($this->_dataValues[0]);
} }
@ -213,7 +223,8 @@ class PHPExcel_Chart_DataSeriesValues
* *
* @return boolean * @return boolean
*/ */
public function multiLevelCount() { public function multiLevelCount()
{
$levelCount = 0; $levelCount = 0;
foreach ($this->_dataValues as $dataValueSet) { foreach ($this->_dataValues as $dataValueSet) {
$levelCount = max($levelCount,count($dataValueSet)); $levelCount = max($levelCount,count($dataValueSet));
@ -226,7 +237,8 @@ class PHPExcel_Chart_DataSeriesValues
* *
* @return array of mixed * @return array of mixed
*/ */
public function getDataValues() { public function getDataValues()
{
return $this->_dataValues; return $this->_dataValues;
} }
@ -235,7 +247,8 @@ class PHPExcel_Chart_DataSeriesValues
* *
* @return mixed * @return mixed
*/ */
public function getDataValue() { public function getDataValue()
{
$count = count($this->_dataValues); $count = count($this->_dataValues);
if ($count == 0) { if ($count == 0) {
return null; return null;
@ -254,7 +267,8 @@ class PHPExcel_Chart_DataSeriesValues
* FALSE - don't change the value of _dataSource * FALSE - don't change the value of _dataSource
* @return PHPExcel_Chart_DataSeriesValues * @return PHPExcel_Chart_DataSeriesValues
*/ */
public function setDataValues($dataValues = array(), $refreshDataSource = TRUE) { public function setDataValues($dataValues = array(), $refreshDataSource = true)
{
$this->_dataValues = PHPExcel_Calculation_Functions::flattenArray($dataValues); $this->_dataValues = PHPExcel_Calculation_Functions::flattenArray($dataValues);
$this->_pointCount = count($dataValues); $this->_pointCount = count($dataValues);
@ -265,17 +279,19 @@ class PHPExcel_Chart_DataSeriesValues
return $this; return $this;
} }
private function _stripNulls($var) { private function _stripNulls($var)
return $var !== NULL; {
return $var !== null;
} }
public function refresh(PHPExcel_Worksheet $worksheet, $flatten = TRUE) { public function refresh(PHPExcel_Worksheet $worksheet, $flatten = true)
if ($this->_dataSource !== NULL) { {
if ($this->_dataSource !== null) {
$calcEngine = PHPExcel_Calculation::getInstance($worksheet->getParent()); $calcEngine = PHPExcel_Calculation::getInstance($worksheet->getParent());
$newDataValues = PHPExcel_Calculation::_unwrapResult( $newDataValues = PHPExcel_Calculation::_unwrapResult(
$calcEngine->_calculateFormulaValue( $calcEngine->_calculateFormulaValue(
'='.$this->_dataSource, '='.$this->_dataSource,
NULL, null,
$worksheet->getCell('A1') $worksheet->getCell('A1')
) )
); );
@ -313,7 +329,5 @@ class PHPExcel_Chart_DataSeriesValues
} }
$this->_pointCount = count($this->_dataValues); $this->_pointCount = count($this->_dataValues);
} }
} }
} }

View File

@ -7,8 +7,8 @@
* Time: 2:36 PM * Time: 2:36 PM
*/ */
class PHPExcel_Chart_GridLines extends class PHPExcel_Chart_GridLines extends PHPExcel_Chart_Properties
PHPExcel_Chart_Properties { {
/** /**
* Properties of Class: * Properties of Class:
@ -20,12 +20,12 @@ class PHPExcel_Chart_GridLines extends
* *
*/ */
private private $_object_state = false;
$_object_state = FALSE,
$_line_properties = array( private $_line_properties = array(
'color' => array( 'color' => array(
'type' => self::EXCEL_COLOR_TYPE_STANDARD, 'type' => self::EXCEL_COLOR_TYPE_STANDARD,
'value' => NULL, 'value' => null,
'alpha' => 0 'alpha' => 0
), ),
'style' => array( 'style' => array(
@ -45,36 +45,39 @@ class PHPExcel_Chart_GridLines extends
), ),
) )
) )
), );
$_shadow_properties = array(
private $_shadow_properties = array(
'presets' => self::SHADOW_PRESETS_NOSHADOW, 'presets' => self::SHADOW_PRESETS_NOSHADOW,
'effect' => NULL, 'effect' => null,
'color' => array( 'color' => array(
'type' => self::EXCEL_COLOR_TYPE_STANDARD, 'type' => self::EXCEL_COLOR_TYPE_STANDARD,
'value' => 'black', 'value' => 'black',
'alpha' => 85, 'alpha' => 85,
), ),
'size' => array( 'size' => array(
'sx' => NULL, 'sx' => null,
'sy' => NULL, 'sy' => null,
'kx' => NULL 'kx' => null
), ),
'blur' => NULL, 'blur' => null,
'direction' => NULL, 'direction' => null,
'distance' => NULL, 'distance' => null,
'algn' => NULL, 'algn' => null,
'rotWithShape' => NULL 'rotWithShape' => null
), );
$_glow_properties = array(
'size' => NULL, private $_glow_properties = array(
'size' => null,
'color' => array( 'color' => array(
'type' => self::EXCEL_COLOR_TYPE_STANDARD, 'type' => self::EXCEL_COLOR_TYPE_STANDARD,
'value' => 'black', 'value' => 'black',
'alpha' => 40 'alpha' => 40
) )
), );
$_soft_edges = array(
'size' => NULL private $_soft_edges = array(
'size' => null
); );
/** /**
@ -83,7 +86,8 @@ class PHPExcel_Chart_GridLines extends
* @return bool * @return bool
*/ */
public function getObjectState() { public function getObjectState()
{
return $this->_object_state; return $this->_object_state;
} }
@ -93,8 +97,9 @@ class PHPExcel_Chart_GridLines extends
* @return PHPExcel_Chart_GridLines * @return PHPExcel_Chart_GridLines
*/ */
private function _activateObject() { private function _activateObject()
$this->_object_state = TRUE; {
$this->_object_state = true;
return $this; return $this;
} }
@ -107,7 +112,8 @@ class PHPExcel_Chart_GridLines extends
* @param string $type * @param string $type
*/ */
public function setLineColorProperties($value, $alpha = 0, $type = self::EXCEL_COLOR_TYPE_STANDARD) { public function setLineColorProperties($value, $alpha = 0, $type = self::EXCEL_COLOR_TYPE_STANDARD)
{
$this $this
->_activateObject() ->_activateObject()
->_line_properties['color'] = $this->setColorProperties( ->_line_properties['color'] = $this->setColorProperties(
@ -130,35 +136,36 @@ class PHPExcel_Chart_GridLines extends
* @param string $end_arrow_size * @param string $end_arrow_size
*/ */
public function setLineStyleProperties($line_width = NULL, $compound_type = NULL, $dash_type = NULL, $cap_type = NULL, $join_type = NULL, $head_arrow_type = NULL, $head_arrow_size = NULL, $end_arrow_type = NULL, $end_arrow_size = NULL) { public function setLineStyleProperties($line_width = null, $compound_type = null, $dash_type = null, $cap_type = null, $join_type = null, $head_arrow_type = null, $head_arrow_size = null, $end_arrow_type = null, $end_arrow_size = null)
{
$this->_activateObject(); $this->_activateObject();
(!is_null($line_width)) (!is_null($line_width))
? $this->_line_properties['style']['width'] = $this->getExcelPointsWidth((float) $line_width) ? $this->_line_properties['style']['width'] = $this->getExcelPointsWidth((float) $line_width)
: NULL; : null;
(!is_null($compound_type)) (!is_null($compound_type))
? $this->_line_properties['style']['compound'] = (string) $compound_type ? $this->_line_properties['style']['compound'] = (string) $compound_type
: NULL; : null;
(!is_null($dash_type)) (!is_null($dash_type))
? $this->_line_properties['style']['dash'] = (string) $dash_type ? $this->_line_properties['style']['dash'] = (string) $dash_type
: NULL; : null;
(!is_null($cap_type)) (!is_null($cap_type))
? $this->_line_properties['style']['cap'] = (string) $cap_type ? $this->_line_properties['style']['cap'] = (string) $cap_type
: NULL; : null;
(!is_null($join_type)) (!is_null($join_type))
? $this->_line_properties['style']['join'] = (string) $join_type ? $this->_line_properties['style']['join'] = (string) $join_type
: NULL; : null;
(!is_null($head_arrow_type)) (!is_null($head_arrow_type))
? $this->_line_properties['style']['arrow']['head']['type'] = (string) $head_arrow_type ? $this->_line_properties['style']['arrow']['head']['type'] = (string) $head_arrow_type
: NULL; : null;
(!is_null($head_arrow_size)) (!is_null($head_arrow_size))
? $this->_line_properties['style']['arrow']['head']['size'] = (string) $head_arrow_size ? $this->_line_properties['style']['arrow']['head']['size'] = (string) $head_arrow_size
: NULL; : null;
(!is_null($end_arrow_type)) (!is_null($end_arrow_type))
? $this->_line_properties['style']['arrow']['end']['type'] = (string) $end_arrow_type ? $this->_line_properties['style']['arrow']['end']['type'] = (string) $end_arrow_type
: NULL; : null;
(!is_null($end_arrow_size)) (!is_null($end_arrow_size))
? $this->_line_properties['style']['arrow']['end']['size'] = (string) $end_arrow_size ? $this->_line_properties['style']['arrow']['end']['size'] = (string) $end_arrow_size
: NULL; : null;
} }
/** /**
@ -169,7 +176,8 @@ class PHPExcel_Chart_GridLines extends
* @return string * @return string
*/ */
public function getLineColorProperty($parameter) { public function getLineColorProperty($parameter)
{
return $this->_line_properties['color'][$parameter]; return $this->_line_properties['color'][$parameter];
} }
@ -181,7 +189,8 @@ class PHPExcel_Chart_GridLines extends
* @return string * @return string
*/ */
public function getLineStyleProperty($elements) { public function getLineStyleProperty($elements)
{
return $this->getArrayElementsValue($this->_line_properties['style'], $elements); return $this->getArrayElementsValue($this->_line_properties['style'], $elements);
} }
@ -195,7 +204,8 @@ class PHPExcel_Chart_GridLines extends
* *
*/ */
public function setGlowProperties($size, $color_value = NULL, $color_alpha = NULL, $color_type = NULL) { public function setGlowProperties($size, $color_value = null, $color_alpha = null, $color_type = null)
{
$this $this
->_activateObject() ->_activateObject()
->_setGlowSize($size) ->_setGlowSize($size)
@ -210,7 +220,8 @@ class PHPExcel_Chart_GridLines extends
* @return string * @return string
*/ */
public function getGlowColor($property) { public function getGlowColor($property)
{
return $this->_glow_properties['color'][$property]; return $this->_glow_properties['color'][$property];
} }
@ -220,7 +231,8 @@ class PHPExcel_Chart_GridLines extends
* @return string * @return string
*/ */
public function getGlowSize() { public function getGlowSize()
{
return $this->_glow_properties['size']; return $this->_glow_properties['size'];
} }
@ -232,7 +244,8 @@ class PHPExcel_Chart_GridLines extends
* @return PHPExcel_Chart_GridLines * @return PHPExcel_Chart_GridLines
*/ */
private function _setGlowSize($size) { private function _setGlowSize($size)
{
$this->_glow_properties['size'] = $this->getExcelPointsWidth((float) $size); $this->_glow_properties['size'] = $this->getExcelPointsWidth((float) $size);
return $this; return $this;
@ -248,7 +261,8 @@ class PHPExcel_Chart_GridLines extends
* @return PHPExcel_Chart_GridLines * @return PHPExcel_Chart_GridLines
*/ */
private function _setGlowColor($color, $alpha, $type) { private function _setGlowColor($color, $alpha, $type)
{
if (!is_null($color)) { if (!is_null($color)) {
$this->_glow_properties['color']['value'] = (string) $color; $this->_glow_properties['color']['value'] = (string) $color;
} }
@ -271,7 +285,8 @@ class PHPExcel_Chart_GridLines extends
* @return string * @return string
*/ */
public function getLineStyleArrowParameters($arrow_selector, $property_selector) { public function getLineStyleArrowParameters($arrow_selector, $property_selector)
{
return $this->getLineStyleArrowSize($this->_line_properties['style']['arrow'][$arrow_selector]['size'], $property_selector); return $this->getLineStyleArrowSize($this->_line_properties['style']['arrow'][$arrow_selector]['size'], $property_selector);
} }
@ -288,7 +303,8 @@ class PHPExcel_Chart_GridLines extends
* *
*/ */
public function setShadowProperties($sh_presets, $sh_color_value = NULL, $sh_color_type = NULL, $sh_color_alpha = NULL, $sh_blur = NULL, $sh_angle = NULL, $sh_distance = NULL) { public function setShadowProperties($sh_presets, $sh_color_value = null, $sh_color_type = null, $sh_color_alpha = null, $sh_blur = null, $sh_angle = null, $sh_distance = null)
{
$this $this
->_activateObject() ->_activateObject()
->_setShadowPresetsProperties((int) $sh_presets) ->_setShadowPresetsProperties((int) $sh_presets)
@ -310,7 +326,8 @@ class PHPExcel_Chart_GridLines extends
* @return PHPExcel_Chart_GridLines * @return PHPExcel_Chart_GridLines
*/ */
private function _setShadowPresetsProperties($shadow_presets) { private function _setShadowPresetsProperties($shadow_presets)
{
$this->_shadow_properties['presets'] = $shadow_presets; $this->_shadow_properties['presets'] = $shadow_presets;
$this->_setShadowProperiesMapValues($this->getShadowPresetsMap($shadow_presets)); $this->_setShadowProperiesMapValues($this->getShadowPresetsMap($shadow_presets));
@ -326,18 +343,19 @@ class PHPExcel_Chart_GridLines extends
* @return PHPExcel_Chart_GridLines * @return PHPExcel_Chart_GridLines
*/ */
private function _setShadowProperiesMapValues(array $properties_map, &$reference = NULL) { private function _setShadowProperiesMapValues(array $properties_map, &$reference = null)
{
$base_reference = $reference; $base_reference = $reference;
foreach ($properties_map as $property_key => $property_val) { foreach ($properties_map as $property_key => $property_val) {
if (is_array($property_val)) { if (is_array($property_val)) {
if ($reference === NULL) { if ($reference === null) {
$reference = & $this->_shadow_properties[$property_key]; $reference = & $this->_shadow_properties[$property_key];
} else { } else {
$reference = & $reference[$property_key]; $reference = & $reference[$property_key];
} }
$this->_setShadowProperiesMapValues($property_val, $reference); $this->_setShadowProperiesMapValues($property_val, $reference);
} else { } else {
if ($base_reference === NULL) { if ($base_reference === null) {
$this->_shadow_properties[$property_key] = $property_val; $this->_shadow_properties[$property_key] = $property_val;
} else { } else {
$reference[$property_key] = $property_val; $reference[$property_key] = $property_val;
@ -356,7 +374,8 @@ class PHPExcel_Chart_GridLines extends
* @param string $type * @param string $type
* @return PHPExcel_Chart_GridLines * @return PHPExcel_Chart_GridLines
*/ */
private function _setShadowColor($color, $alpha, $type) { private function _setShadowColor($color, $alpha, $type)
{
if (!is_null($color)) { if (!is_null($color)) {
$this->_shadow_properties['color']['value'] = (string) $color; $this->_shadow_properties['color']['value'] = (string) $color;
} }
@ -377,8 +396,9 @@ class PHPExcel_Chart_GridLines extends
* *
* @return PHPExcel_Chart_GridLines * @return PHPExcel_Chart_GridLines
*/ */
private function _setShadowBlur($blur) { private function _setShadowBlur($blur)
if ($blur !== NULL) { {
if ($blur !== null) {
$this->_shadow_properties['blur'] = (string) $this->getExcelPointsWidth($blur); $this->_shadow_properties['blur'] = (string) $this->getExcelPointsWidth($blur);
} }
@ -392,8 +412,9 @@ class PHPExcel_Chart_GridLines extends
* @return PHPExcel_Chart_GridLines * @return PHPExcel_Chart_GridLines
*/ */
private function _setShadowAngle($angle) { private function _setShadowAngle($angle)
if ($angle !== NULL) { {
if ($angle !== null) {
$this->_shadow_properties['direction'] = (string) $this->getExcelPointsAngle($angle); $this->_shadow_properties['direction'] = (string) $this->getExcelPointsAngle($angle);
} }
@ -406,8 +427,9 @@ class PHPExcel_Chart_GridLines extends
* @param float $distance * @param float $distance
* @return PHPExcel_Chart_GridLines * @return PHPExcel_Chart_GridLines
*/ */
private function _setShadowDistance($distance) { private function _setShadowDistance($distance)
if ($distance !== NULL) { {
if ($distance !== null) {
$this->_shadow_properties['distance'] = (string) $this->getExcelPointsWidth($distance); $this->_shadow_properties['distance'] = (string) $this->getExcelPointsWidth($distance);
} }
@ -421,7 +443,8 @@ class PHPExcel_Chart_GridLines extends
* @param array $elements * @param array $elements
* @return string * @return string
*/ */
public function getShadowProperty($elements) { public function getShadowProperty($elements)
{
return $this->getArrayElementsValue($this->_shadow_properties, $elements); return $this->getArrayElementsValue($this->_shadow_properties, $elements);
} }
@ -430,7 +453,8 @@ class PHPExcel_Chart_GridLines extends
* *
* @param float $size * @param float $size
*/ */
public function setSoftEdgesSize($size) { public function setSoftEdgesSize($size)
{
if (!is_null($size)) { if (!is_null($size)) {
$this->_activateObject(); $this->_activateObject();
$_soft_edges['size'] = (string) $this->getExcelPointsWidth($size); $_soft_edges['size'] = (string) $this->getExcelPointsWidth($size);
@ -442,7 +466,8 @@ class PHPExcel_Chart_GridLines extends
* *
* @return string * @return string
*/ */
public function getSoftEdgesSize() { public function getSoftEdgesSize()
{
return $this->_soft_edges['size']; return $this->_soft_edges['size'];
} }
} }