ilLDAPResult Class Reference

Class ilLDAPPagedResult. More...

Collaboration diagram for ilLDAPResult:

Public Member Functions
	__construct ($a_ldap_handle, $a_result=null)
	ilLDAPPagedResult constructor. More...
	numRows ()
	Total count of resulted rows. More...
	getResult ()
	Resource from ldap_search() 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 ()
	Destructor. More...

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

Private Attributes
	$handle
	$result
	$rows
	$last_row

Detailed Description

Class ilLDAPPagedResult.

Author

Fabian Wolf

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

Constructor & Destructor Documentation

__construct()

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

ilLDAPPagedResult constructor.

Parameters

resource	$a_ldap_handle	from ldap_connect()
resource	$a_result	from ldap_search()

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

    {
        $this->handle = $a_ldap_handle;

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

__destruct()

ilLDAPResult::__destruct

(

)

Destructor.

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

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

Member Function Documentation

addEntriesToRows()

ilLDAPResult::addEntriesToRows (   $entries )

private

Adds Results from ldap_get_entries() to rows.

Parameters

array

$entries

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

References $data, and toSimpleArray().

Referenced by run().

    {
        if (!$entries) {
            return;
        }

        $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 96 of file class.ilLDAPResult.php.

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

getResult()

ilLDAPResult::getResult

(

)

Resource from ldap_search()

Returns

resource

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

References $result.

    {
        return $this->result;
    }

getRows()

ilLDAPResult::getRows

(

)

Returns complete results.

Returns

array

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

    {
        return is_array($this->rows) ? $this->rows : array();
    }

numRows()

ilLDAPResult::numRows

(

)

Total count of resulted rows.

Returns

int

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

    {
        return is_array($this->rows) ? count($this->rows) : 0;
    }

run()

ilLDAPResult::run

(

)

Starts ldap_get_entries() and transforms results.

Returns

self $this

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

References addEntriesToRows().

    {
        $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

resource

$result

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

References $result.

    {
        $this->result = $result;
    }

toSimpleArray()

ilLDAPResult::toSimpleArray (   $entry )

private

Transforms results from ldap_get_entries() to a simple format.

Parameters

array

$entry

Returns

array

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

References $data, and $i.

Referenced by addEntriesToRows().

    {
        $data = array();
        foreach ($entry as $key => $value) {
            $key = strtolower($key);

            if (is_int($key)) {
                continue;
            }
            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 34 of file class.ilLDAPResult.php.

$last_row

ilLDAPResult::$last_row

private

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

$result

ilLDAPResult::$result

private

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

Referenced by getResult(), and setResult().

$rows

ilLDAPResult::$rows

private

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

---

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

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