ilXMLResultSet Class Reference

Collaboration diagram for ilXMLResultSet:

Public Member Functions
	getColumnName (int $index)
	addColumn (string $columnname)
	create a new column with columnname and attach it to column list More...
	getIndexForColumn (string $columnname)
	return index for column name More...
	hasColumn (string $columnname)
	has column name More...
	getColSpecs ()
	return array of ilXMLResultSetColumn More...
	getRows ()
	return array of ilXMLResultSetRow More...
	addRow (ilXMLResultSetRow $row)
	setArray (array $array)
	Clear table value and sets them based on array. More...
	addArray (array $array, bool $overwrite=false)
	Add table values. More...
	clear ()
	getColumnCount ()
	getRowCount ()
	getRow ($idx)
	return row for index idx More...
	getValue (int $rowIdx, $colIdx)
	return column value at colidx and rowidx More...

Private Attributes
array	$colspecs = []
array	$rows = []

Detailed Description

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

Member Function Documentation

addArray()

ilXMLResultSet::addArray	(	array	$array,
		bool	$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
bool	$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 122 of file class.ilXMLResultSet.php.

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

Referenced by setArray().

                                                                    : void
    {
        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);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addColumn()

ilXMLResultSet::addColumn

(

string

$columnname

)

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

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

Referenced by addArray().

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

Here is the caller graph for this function:

addRow()

ilXMLResultSet::addRow

(

ilXMLResultSetRow

$row

)

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

Referenced by addArray().

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

Here is the caller graph for this function:

clear()

ilXMLResultSet::clear

(

)

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

Referenced by addArray().

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

Here is the caller graph for this function:

getColSpecs()

ilXMLResultSet::getColSpecs

(

)

return array of ilXMLResultSetColumn

Returns

ilXMLResultSetColumn[]

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

References $colspecs.

                                  : array
    {
        return $this->colspecs;
    }

getColumnCount()

ilXMLResultSet::getColumnCount

(

)

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

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

getColumnName()

ilXMLResultSet::getColumnName

(

int

$index

)

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

References $index, and ilXMLResultSetColumn\getName().

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

Here is the call graph for this function:

getIndexForColumn()

ilXMLResultSet::getIndexForColumn

(

string

$columnname

)

return index for column name

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

Referenced by getValue(), and hasColumn().

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

Here is the caller graph for this function:

getRow()

ilXMLResultSet::getRow

(

$idx

)

return row for index idx

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

References getRowCount().

Referenced by getValue().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getRowCount()

ilXMLResultSet::getRowCount

(

)

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

Referenced by getRow().

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

Here is the caller graph for this function:

getRows()

ilXMLResultSet::getRows

(

)

return array of ilXMLResultSetRow

Returns

ilXMLResultSetRow[]

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

References $rows.

                              : array
    {
        return $this->rows;
    }

getValue()

ilXMLResultSet::getValue	(	int	$rowIdx,
			$colIdx
	)

return column value at colidx and rowidx

Parameters

int	$rowIdx
int | string	$colIdx

Returns

string

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

References getIndexForColumn(), and getRow().

                                                   : string
    {
        $row = $this->getRow($rowIdx);

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

Here is the call graph for this function:

hasColumn()

ilXMLResultSet::hasColumn

(

string

$columnname

)

has column name

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

References getIndexForColumn().

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

Here is the call graph for this function:

setArray()

ilXMLResultSet::setArray

(

array

$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

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

References addArray().

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

Here is the call graph for this function:

Field Documentation

$colspecs

array ilXMLResultSet::$colspecs = []

private

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

Referenced by getColSpecs().

$rows

array ilXMLResultSet::$rows = []

private

Definition at line 37 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