Collaboration diagram for ilXMLResultSet:

Public Member Functions
	getColumnName ($index)

	addColumn ($columnname)
	create a new column with columnname and attach it to column list More...

	getIndexForColumn ($columnname)
	return index for column name More...

	hasColumn ($columnname)
	has column name More...

	getColSpecs ()
	return array of ilXMLResultSetColumn More...

	getRows ()
	return array of ilXMLResultSetRow More...

	addRow (&$row)
	add row object More...

	setArray ($array)
	Clear table value and sets them based on array. More...

	addArray ($array, $overwrite=false)
	Add table values. More...

	clear ()
	Clear resultset (colspecs and row values) More...

	getColumnCount ()
	return column count More...

	getRowCount ()
	return row count More...

	getRow ($idx)
	return row for index idx More...

	getValue ($rowIdx, $colIdx)
	return column value at colidx and rowidx More...

Private Attributes
	$colspecs = array()

	$rows = array()

Detailed Description

Definition at line 37 of file class.ilXMLResultSet.php.

Member Function Documentation

◆ addArray()

ilXMLResultSet::addArray	(	$array,
		$overwrite = `false`
	)

Add table values.

Exspects a 2-dimension array. Column indeces of second dimensions in first row are column names.

e.g. array (array("first" => "val1_1", "second" => "val1_2), array ("first" => "val2_1", "second" => "val2_2")) results in Table first second val1_1 va11_2 val2_1 val2_2

Parameters

array	$array	2 dimensional array
boolean	$overwrite	if false, column names won't be changed, rows will be added,true: result set will be reset to null and data will be added.

Definition at line 144 of file class.ilXMLResultSet.php.

                                                               {
                    if ($overwrite) {
                      $this->clear();
                    }
                    foreach ($array as $row) {
                        if ($overwrite)
                        {
                            // add column names from first row
                            $columnNames = array_keys($row);
                            foreach ($columnNames as $columnName)
                            {
                              $this->addColumn($columnName);
                            }
                            $overwrite = false;
                        }
                $xmlRow = new ilXMLResultSetRow();
                $xmlRow->setValues ($row);
                $this->addRow($xmlRow);
                    }
                }

References $row, addColumn(), addRow(), and clear().

Referenced by setArray().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addColumn()

ilXMLResultSet::addColumn ( $columnname )

create a new column with columnname and attach it to column list

Parameters

String $columname

Definition at line 55 of file class.ilXMLResultSet.php.

                {
                        $this->colspecs [count($this->colspecs)] = new ilXMLResultSetColumn (count($this->colspecs), $columnname);
                }

Referenced by addArray().

Here is the caller graph for this function:

◆ addRow()

ilXMLResultSet::addRow ( & $row )

add row object

Parameters

ilXMLResultSetRow $row

Definition at line 112 of file class.ilXMLResultSet.php.

                {
                        $this->rows [] = $row;
                }

References $row.

Referenced by addArray().

Here is the caller graph for this function:

◆ clear()

ilXMLResultSet::clear ( )

Clear resultset (colspecs and row values)

Definition at line 169 of file class.ilXMLResultSet.php.

                                  {
                    $this->rows = array();
                    $this->colspecs = array();
                }

Referenced by addArray().

Here is the caller graph for this function:

◆ getColSpecs()

ilXMLResultSet::getColSpecs ( )

return array of ilXMLResultSetColumn

Returns: array

Definition at line 92 of file class.ilXMLResultSet.php.

                {
                        return $this->colspecs;
                }

References $colspecs.

◆ getColumnCount()

ilXMLResultSet::getColumnCount ( )

return column count

Returns: int column count

Definition at line 179 of file class.ilXMLResultSet.php.

                                           {
                    return count($this->colspecs);
                }

◆ getColumnName()

ilXMLResultSet::getColumnName ( $index )

Definition at line 42 of file class.ilXMLResultSet.php.

                                                {
                    if (is_numeric($index) && ($index < 0 || $index > count($this->colspecs)))
                    {
                      return null;
                    }
                    return $this->colspecs[$index] instanceof ilXMLResultSetColumn ? $this->colspecs[$index]->getName() : null;
                }

References ilXMLResultSetColumn\getName().

Here is the call graph for this function:

◆ getIndexForColumn()

ilXMLResultSet::getIndexForColumn ( $columnname )

return index for column name

Parameters

string $columnname

Returns: int

Definition at line 66 of file class.ilXMLResultSet.php.

                                                         {
                        $idx = 0;
                        foreach ($this->colspecs as $colspec) {
                                if (strcasecmp($columnname, $colspec->getName()) == 0)
                                        return $idx;
                                $idx++; 
                        }
                        return -1;
                }

Referenced by getValue(), and hasColumn().

Here is the caller graph for this function:

◆ getRow()

ilXMLResultSet::getRow ( $idx )

return row for index idx

Parameters

$idx index

Returns: ilXMLResultSetRow

Definition at line 197 of file class.ilXMLResultSet.php.

                                       {
                        if ($idx < 0 || $idx >= $this->getRowCount())
                                throw new Exception ("Index too small or too big!");
                        return $this->rows[$idx];
                }

References getRowCount().

Referenced by getValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRowCount()

ilXMLResultSet::getRowCount ( )

return row count

Returns: int row count

Definition at line 188 of file class.ilXMLResultSet.php.

                                        {
                    return count($this->rows);
                }

Referenced by getRow().

Here is the caller graph for this function:

◆ getRows()

ilXMLResultSet::getRows ( )

return array of ilXMLResultSetRow

Returns: array

Definition at line 102 of file class.ilXMLResultSet.php.

                {
                        return $this->rows;
                }

References $rows.

◆ getValue()

ilXMLResultSet::getValue	(	$rowIdx,
		$colIdx
	)

return column value at colidx and rowidx

Parameters

int	$rowIdx
mixed	$colIdx

Returns: string

Definition at line 210 of file class.ilXMLResultSet.php.

                                                     {
                        $row = $this->getRow($rowIdx);
                        
                        if (!is_numeric($colIdx))
                                $colIdx = $this->getIndexForColumn($colIdx);
                                
                        return $row->getValue ($colIdx);
                }

References $row, getIndexForColumn(), and getRow().

Here is the call graph for this function:

◆ hasColumn()

ilXMLResultSet::hasColumn ( $columnname )

has column name

Parameters

string $columnname

Returns: boolean

Definition at line 83 of file class.ilXMLResultSet.php.

                                                 {
                        return $this->getIndexForColumn($columnname) != -1;
                }

References getIndexForColumn().

Here is the call graph for this function:

◆ setArray()

ilXMLResultSet::setArray ( $array )

Clear table value and sets them based on array.

Exspects a 2-dimension array. Column indeces of second dimensions in first row are column names.

e.g. array (array("first" => "val1_1", "second" => "val1_2), array ("first" => "val2_1", "second" => "val2_2")) results in Table first second val1_1 va11_2 val2_1 val2_2

Parameters

array $array 2 dimensional array

Definition at line 128 of file class.ilXMLResultSet.php.

                {
            $this->addArray($array, true);
                }

References addArray().

Here is the call graph for this function:

Field Documentation

◆ $colspecs

ilXMLResultSet::$colspecs = array()

private

Definition at line 39 of file class.ilXMLResultSet.php.

Referenced by getColSpecs().

◆ $rows

ilXMLResultSet::$rows = array()

private

Definition at line 40 of file class.ilXMLResultSet.php.

Referenced by getRows().

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

webservice/soap/classes/class.ilXMLResultSet.php

Public Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ addArray()

◆ addColumn()

◆ addRow()

◆ clear()

◆ getColSpecs()

◆ getColumnCount()

◆ getColumnName()

◆ getIndexForColumn()

◆ getRow()

◆ getRowCount()

◆ getRows()

◆ getValue()

◆ hasColumn()

◆ setArray()

Field Documentation

◆ $colspecs

◆ $rows