ilLDAPResult Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilLDAPResult:

Public Member Functions
	__construct ($a_ldap_handle, $a_result=null)
	numRows ()
	Total count of resulted rows. More...
	setResult ($result)
	Resource from ldap_search() More...
	get ()
	Returns last result. More...
	getRows ()
	Returns complete results. More...
	run ()
	Starts ldap_get_entries() and transforms results. More...
	__destruct ()

Private Member Functions
	addEntriesToRows (array $entries)
	Adds Results from ldap_get_entries() to rows. More...
	toSimpleArray (array $entry)
	Transforms results from ldap_get_entries() to a simple format. More...

Private Attributes
	$handle
	$result = null
array	$rows = []
array	$last_row

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilLDAPPagedResult

Author

Fabian Wolf

Definition at line 26 of file class.ilLDAPResult.php.

Constructor & Destructor Documentation

__construct()

ilLDAPResult::__construct	(		$a_ldap_handle,
			$a_result = null
	)

Parameters

resource | \Ldap\Connection	$a_ldap_handle	from ldap_connect()
	null|false|resource|list<

Definition at line 45 of file class.ilLDAPResult.php.

    {
        $this->handle = $a_ldap_handle;

        if ($a_result !== null && $a_result !== false) {
            $this->result = $a_result;
        }
    }

__destruct()

ilLDAPResult::__destruct

(

)

Definition at line 151 of file class.ilLDAPResult.php.

    {
        if ($this->result) {
            ldap_free_result($this->result);
        }
    }

Member Function Documentation

addEntriesToRows()

ilLDAPResult::addEntriesToRows ( array  $entries )

private

Adds Results from ldap_get_entries() to rows.

Definition at line 105 of file class.ilLDAPResult.php.

References $data, and toSimpleArray().

Referenced by run().

                                                     : void
    {
        $num = $entries['count'];
        if ($num === 0) {
            return;
        }

        for ($row_counter = 0; $row_counter < $num; $row_counter++) {
            $data = $this->toSimpleArray($entries[$row_counter]);
            $this->rows[] = $data;
            $this->last_row = $data;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

get()

ilLDAPResult::get

(

)

Returns last result.

Returns

array

Definition at line 75 of file class.ilLDAPResult.php.

                         : array
    {
        return is_array($this->last_row) ? $this->last_row : [];
    }

getRows()

ilLDAPResult::getRows

(

)

Returns complete results.

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

References $rows.

                             : array
    {
        return $this->rows;
    }

numRows()

ilLDAPResult::numRows

(

)

Total count of resulted rows.

Definition at line 57 of file class.ilLDAPResult.php.

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

run()

ilLDAPResult::run

(

)

Starts ldap_get_entries() and transforms results.

Returns

self $this

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

References addEntriesToRows().

                         : self
    {
        if ($this->result) {
            $entries = ldap_get_entries($this->handle, $this->result);
            $this->addEntriesToRows($entries);
        }

        return $this;
    }

Here is the call graph for this function:

setResult()

ilLDAPResult::setResult

(

$result

)

Resource from ldap_search()

Parameters

false|resource|list<

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

References $result.

                                      : void
    {
        $this->result = $result;
    }

toSimpleArray()

ilLDAPResult::toSimpleArray ( array  $entry )

private

Transforms results from ldap_get_entries() to a simple format.

Definition at line 122 of file class.ilLDAPResult.php.

References $data, and ILIAS\LTI\ToolProvider\$key.

Referenced by addEntriesToRows().

                                                : array
    {
        $data = [];
        foreach ($entry as $key => $value) {
            if (is_int($key)) {
                continue;
            }

            $key = strtolower($key);
            if ($key === 'dn') {
                $data['dn'] = $value;
                continue;
            }
            if (is_array($value)) {
                if ($value['count'] > 1) {
                    for ($i = 0; $i < $value['count']; $i++) {
                        $data[$key][] = $value[$i];
                    }
                } elseif ($value['count'] === 1) {
                    $data[$key] = $value[0];
                }
            } else {
                $data[$key] = $value;
            }
        }

        return $data;
    }

Here is the caller graph for this function:

Field Documentation

$handle

ilLDAPResult::$handle

private

Definition at line 31 of file class.ilLDAPResult.php.

$last_row

array ilLDAPResult::$last_row

private

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

$result

ilLDAPResult::$result = null

private

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

Referenced by setResult().

$rows

array ilLDAPResult::$rows = []

private

Definition at line 38 of file class.ilLDAPResult.php.

Referenced by getRows().

---

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

• Services/LDAP/classes/class.ilLDAPResult.php