eZPublish  3.9
eZMatrix Class Reference

The class eZMatrix does. More...

Public Member Functions

 addColumn (&$columnDefinition)
 
 addColumnToCells (&$columnDefinition)
 
 addColumnToMatrix (&$columnDefinition)
 
 addRow ($beforeIndex=false, $addCount=1)
 
 adjustColumnIndex (&$columnDefinition, $newColumnIndex)
 
 adjustColumnName (&$columnDefinition, $newColumnName)
 
 adjustColumnsToDefinition ($classColumnsDefinition)
 
attribute ($name)
 
 attributes ()
 
 buildReorderChains (&$chain, &$columns, &$curPos, &$startPos)
 
buildReorderRuleForColumn (&$columns, $curPos, $startPos)
 
buildReorderRules (&$columns)
 
 copyCellsDataBetweenColumns ($firstColIdx, $secondColIdx, $toSecondCol)
 
 copyColumn ($colIdx, &$buffer, $toBuffer)
 
 copyColumnCellsData ($colIdx, &$buffer, $toBuffer)
 
 copyColumnDefinition ($colIdx, &$buffer, $toBuffer)
 
 copyDataBetweenColumns ($firstColIdx, $secondColIdx, $toSecondCol=true)
 
 copyDefinitionBetweenColumns ($firstColIdx, $secondColIdx, $toSecondCol)
 
 decodeXML ($xmlString)
 
 eZMatrix ($name, $numRows=false, $matrixColumnDefinition=false)
 
getColumnDefinitionByID (&$id)
 
getColumnsToRemove (&$matrixColumnsDefinition)
 
 hasAttribute ($name)
 
 hasRuleForColumn (&$rules, $pos)
 
 isColumnExists (&$columnToFind, &$matrixColumnsDefinition)
 
name ()
 
 removeColumn (&$columnDefinition)
 
 removeColumnFromCells (&$columnDefinition)
 
 removeColumnFromMatrix (&$columnDefinition)
 
 removeRow ($rowNum)
 
 removeUselessColumns (&$matrixColumnDefinition)
 
 reorderColumns ()
 
 setColumnIndex (&$columnDefinition, $newColumnIndex)
 
 setColumnName (&$columnDefinition, $newColumnName)
 
 setName ($name)
 
 updateColumns (&$matrixColumnDefinition, $addNewColumnsAllowed, $updateColumnsAttributesAllowed)
 
xmlString ()
 

Static Public Member Functions

 domString (&$domDocument)
 

Public Attributes

 $Cells
 
 $Matrix
 Contains the Matrix array. More...
 
 $Name
 Contains the Matrix name. More...
 
 $NumColumns
 Contains the number of columns. More...
 
 $NumRows
 Contains the number of rows. More...
 

Detailed Description

The class eZMatrix does.

Member Function Documentation

eZMatrix::addColumn ( $columnDefinition)

Adds column $columnDefinition to eZMatrix object.

Referenced by updateColumns().

eZMatrix::addColumnToCells ( $columnDefinition)

Adds column $columnDefinition to 'cells' member of eZMatrix.

Referenced by addColumn().

eZMatrix::addColumnToMatrix ( $columnDefinition)

Adds column $columnDefinition to 'matrix' member of eZMatrix.

Referenced by addColumn().

eZMatrix::addRow (   $beforeIndex = false,
  $addCount = 1 
)
eZMatrix::adjustColumnIndex ( $columnDefinition,
  $newColumnIndex 
)

Checks if column $columnDefinition has index $newColumnIndex. If so does nothing and returns false, otherwise changes column's index to $newColumnIndex and returns true.

Referenced by updateColumns().

eZMatrix::adjustColumnName ( $columnDefinition,
  $newColumnName 
)

Checks if column $columnDefinition has name $newColumnName. If so does nothing and returns false, otherwise changes column's name to $newColumnName and returns true.

Referenced by updateColumns().

eZMatrix::adjustColumnsToDefinition (   $classColumnsDefinition)

Checks current eZMatrix object against definition. If columns ids are wrong or there are additional/redundant columns in definition/eZMatrix object then current eZMatix object will be adjusted according to $matrixColumnDefinition. Note: if id of some column was changed form "old_id" to "new_id" then a column with "old_id" will be removed(all data of this column will be lost) and an empty column with "new_id" will be created. Returns true if adjustment(matrix modification) was performed. Otherwise - false.

eZMatrix::attributes ( )

Referenced by hasAttribute().

eZMatrix::buildReorderChains ( $chain,
$columns,
$curPos,
$startPos 
)

static

Referenced by buildReorderRuleForColumn().

& eZMatrix::buildReorderRuleForColumn ( $columns,
  $curPos,
  $startPos 
)

static

Referenced by buildReorderRules().

& eZMatrix::buildReorderRules ( $columns)

static

Referenced by reorderColumns().

eZMatrix::copyCellsDataBetweenColumns (   $firstColIdx,
  $secondColIdx,
  $toSecondCol 
)

Referenced by copyDataBetweenColumns().

eZMatrix::copyColumn (   $colIdx,
$buffer,
  $toBuffer 
)

Referenced by reorderColumns().

eZMatrix::copyColumnCellsData (   $colIdx,
$buffer,
  $toBuffer 
)

Referenced by copyColumn().

eZMatrix::copyColumnDefinition (   $colIdx,
$buffer,
  $toBuffer 
)

Referenced by copyColumn().

eZMatrix::copyDataBetweenColumns (   $firstColIdx,
  $secondColIdx,
  $toSecondCol = true 
)

Referenced by reorderColumns().

eZMatrix::copyDefinitionBetweenColumns (   $firstColIdx,
  $secondColIdx,
  $toSecondCol 
)

Referenced by copyDataBetweenColumns().

eZMatrix::decodeXML (   $xmlString)

Will decode an xml string and initialize the eZ matrix object

Referenced by adjustColumnsToDefinition(), and eZMatrix().

eZMatrix::domString ( $domDocument)
static
Returns
the XML structure in $domDocument as text. It will take of care of the necessary charset conversions for content storage.

Referenced by xmlString().

eZMatrix::eZMatrix (   $name,
  $numRows = false,
  $matrixColumnDefinition = false 
)

Constructor

& eZMatrix::getColumnDefinitionByID ( $id)

Searches column definition by indentifier. If column was found returns it, otherwise returns false.

Referenced by updateColumns().

& eZMatrix::getColumnsToRemove ( $matrixColumnsDefinition)

Searches columns that are in matrix but not in $matrixColumnDefinition.

Referenced by removeUselessColumns().

eZMatrix::hasAttribute (   $name)
eZMatrix::hasRuleForColumn ( $rules,
  $pos 
)

static

Referenced by buildReorderRules().

eZMatrix::isColumnExists ( $columnToFind,
$matrixColumnsDefinition 
)

static Searches column $columnToFind in $matrixColumnDefinition. Returns true if found, false - otherwise.

Referenced by getColumnsToRemove().

& eZMatrix::name ( )

Returns the name of the matrix.

eZMatrix::removeColumn ( $columnDefinition)

Removess column $columnDefinition from eZMatrix object.

Referenced by removeUselessColumns().

eZMatrix::removeColumnFromCells ( $columnDefinition)

Removess column $columnDefinition from 'cells' member of eZMatrix.

Referenced by removeColumn().

eZMatrix::removeColumnFromMatrix ( $columnDefinition)

Removess column $columnDefinition from 'matrix' member of eZMatrix.

Referenced by removeColumn().

eZMatrix::removeRow (   $rowNum)
eZMatrix::removeUselessColumns ( $matrixColumnDefinition)

Removes columns that are in matrix but not in $matrixColumnDefinition

Referenced by adjustColumnsToDefinition().

eZMatrix::reorderColumns ( )
eZMatrix::setColumnIndex ( $columnDefinition,
  $newColumnIndex 
)

Sets column's name to $newColumnIndex.

Referenced by adjustColumnIndex().

eZMatrix::setColumnName ( $columnDefinition,
  $newColumnName 
)

Sets column's name to $newColumnName.

Referenced by adjustColumnName().

eZMatrix::setName (   $name)

Sets the name of the matrix

Referenced by decodeXML().

eZMatrix::updateColumns ( $matrixColumnDefinition,
  $addNewColumnsAllowed,
  $updateColumnsAttributesAllowed 
)

Searches in matrix columns with identifiers that in $matrixColumnDefinition and a) if column exists and $updateColumnsAttributesAllowed is true then modification of column attributes is performed( index, name, etc.); b) if column doesn't exists and $addNewColumnsAllowed then new column will be created.

Referenced by adjustColumnsToDefinition().

& eZMatrix::xmlString ( )

Will return the XML string for this matrix.

Referenced by adjustColumnsToDefinition(), and eZMatrix().

Member Data Documentation

eZMatrix::$Cells

Referenced by attribute().

eZMatrix::$Matrix

Contains the Matrix array.

Referenced by attribute().

eZMatrix::$Name

Contains the Matrix name.

Referenced by attribute(), and name().

eZMatrix::$NumColumns

Contains the number of columns.

Referenced by xmlString().

eZMatrix::$NumRows

Contains the number of rows.

Referenced by xmlString().


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