ilMailAutoCompleteUserProvider Class Reference

Class ilMailAutoCompleteUserProvider. More...

Inheritance diagram for ilMailAutoCompleteUserProvider:

Collaboration diagram for ilMailAutoCompleteUserProvider:

Public Member Functions
	__construct ($quoted_term, $term)
	valid ()
	"Valid" implementation of iterator interface More...
	current ()
	"Current" implementation of iterator interface More...
	key ()
	"Key" implementation of iterator interface More...
	rewind ()
	"Rewind "implementation of iterator interface More...
Public Member Functions inherited from ilMailAutoCompleteRecipientProvider
	__construct ($quoted_term, $term)
	valid ()
	"Valid" implementation of iterator interface More...
	next ()
	"Next" implementation of iterator interface More...
	__destruct ()
	Destructor Free the result. More...

Protected Member Functions
	getSelectPart ()
	getFromPart ()
	getWherePart ($search_query)
	getOrderByPart ()
	getQueryConditionByFieldAndValue ($field, $a_str)
	getFields ()
	Get searchable fields. More...

Additional Inherited Members
Protected Attributes inherited from ilMailAutoCompleteRecipientProvider
	$db
	$res
	$data = array()
	$quoted_term = ''
	$term = ''
	$user_id = 0

Detailed Description

Class ilMailAutoCompleteUserProvider.

Definition at line 10 of file class.ilMailAutoCompleteUserProvider.php.

Constructor & Destructor Documentation

__construct()

ilMailAutoCompleteUserProvider::__construct	(		$quoted_term,
			$term
	)

Parameters

string	$quoted_term
string	$term

Definition at line 16 of file class.ilMailAutoCompleteUserProvider.php.

References ilMailAutoCompleteRecipientProvider\$quoted_term, and ilMailAutoCompleteRecipientProvider\$term.

    {
        parent::__construct($quoted_term, $term);
    }

Member Function Documentation

current()

ilMailAutoCompleteUserProvider::current

(

)

"Current" implementation of iterator interface

Returns

array

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

References array, and data.

    {
        return array(
            'login'     => $this->data['login'],
            'firstname' => $this->data['firstname'],
            'lastname'  => $this->data['lastname']
        );
    }

getFields()

ilMailAutoCompleteUserProvider::getFields ( )

protected

Get searchable fields.

Returns

array

Definition at line 208 of file class.ilMailAutoCompleteUserProvider.php.

References ilUserSearchOptions\_isEnabled(), and array.

Referenced by getWherePart().

    {
        $available_fields = array();
        foreach (array('firstname', 'lastname') as $field) {
            include_once 'Services/Search/classes/class.ilUserSearchOptions.php';
            if (ilUserSearchOptions::_isEnabled($field)) {
                $available_fields[] = $field;
            }
        }
        return $available_fields;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFromPart()

ilMailAutoCompleteUserProvider::getFromPart ( )

protected

Returns

string

Definition at line 110 of file class.ilMailAutoCompleteUserProvider.php.

References array.

Referenced by rewind().

    {
        $joins = array();

        $joins[] = '
                        LEFT JOIN usr_pref profpref
                        ON profpref.usr_id = usr_data.usr_id
                        AND profpref.keyword = ' . $this->db->quote('public_profile', 'text');

        $joins[] = '
                        LEFT JOIN usr_pref pubemail
                        ON pubemail.usr_id = usr_data.usr_id
                        AND pubemail.keyword = ' . $this->db->quote('public_email', 'text');

        if ($joins) {
            return 'usr_data ' . implode(' ', $joins);
        } else {
            return 'usr_data ';
        }
    }

Here is the caller graph for this function:

getOrderByPart()

ilMailAutoCompleteUserProvider::getOrderByPart ( )

protected

Returns

string

Definition at line 189 of file class.ilMailAutoCompleteUserProvider.php.

Referenced by rewind().

    {
        return 'login ASC';
    }

Here is the caller graph for this function:

getQueryConditionByFieldAndValue()

ilMailAutoCompleteUserProvider::getQueryConditionByFieldAndValue (   $field,   $a_str  )

protected

Parameters

string	$field
mixed	$a_str

Returns

string

Definition at line 199 of file class.ilMailAutoCompleteUserProvider.php.

Referenced by getWherePart().

    {
        return $this->db->like($field, 'text', $a_str . '%');
    }

Here is the caller graph for this function:

getSelectPart()

ilMailAutoCompleteUserProvider::getSelectPart ( )

protected

Returns

string

Definition at line 79 of file class.ilMailAutoCompleteUserProvider.php.

References array.

Referenced by rewind().

    {
        $fields = array(
            'login',
            sprintf(
                "(CASE WHEN (profpref.value = %s OR profpref.value = %s OR profpref.value IS NULL) THEN firstname ELSE '' END) firstname",
                $this->db->quote('y', 'text'),
                $this->db->quote('g', 'text')
            ),
            sprintf(
                "(CASE WHEN (profpref.value = %s OR profpref.value = %s OR profpref.value IS NULL) THEN lastname ELSE '' END) lastname",
                $this->db->quote('y', 'text'),
                $this->db->quote('g', 'text')
            ),
            sprintf(
                "(CASE WHEN ((profpref.value = %s OR profpref.value = %s OR profpref.value IS NULL) AND pubemail.value = %s) THEN email ELSE '' END) email",
                $this->db->quote('y', 'text'),
                $this->db->quote('g', 'text'),
                $this->db->quote('y', 'text')
            ),
        );

        $fields[] = 'profpref.value profile_value';
        $fields[] = 'pubemail.value email_value';

        return implode(', ', $fields);
    }

Here is the caller graph for this function:

getWherePart()

ilMailAutoCompleteUserProvider::getWherePart (   $search_query )

protected

Parameters

string

Returns

string

Definition at line 135 of file class.ilMailAutoCompleteUserProvider.php.

References array, getFields(), ilUserAccountSettings\getInstance(), ilUserFilter\getInstance(), and getQueryConditionByFieldAndValue().

Referenced by rewind().

    {
        $outer_conditions   = array();
        $outer_conditions[] = 'usr_data.usr_id != ' . $this->db->quote(ANONYMOUS_USER_ID, 'integer');

        $field_conditions = array();
        foreach ($this->getFields() as $field) {
            $field_condition = $this->getQueryConditionByFieldAndValue($field, $search_query);

            if ('email' == $field) {
                // If privacy should be respected, the profile setting of every user concerning the email address has to be
                // respected (in every user context, no matter if the user is 'logged in' or 'anonymous').
                $email_query        = array();
                $email_query[]      = $field_condition;
                $email_query[]      = 'pubemail.value = ' . $this->db->quote('y', 'text');
                $field_conditions[] = '(' . implode(' AND ', $email_query) . ')';
            } else {
                $field_conditions[] = $field_condition;
            }
        }

        // If the current user context ist 'logged in' and privacy should be respected, all fields >>>except the login<<<
        // should only be searchable if the users' profile is published (y oder g)
        // In 'anonymous' context we do not need this additional conditions,
        // because we checked the privacy setting in the condition above: profile = 'g'
        if ($field_conditions) {
            $fields = '(' . implode(' OR ', $field_conditions) . ')';

            $field_conditions = ['(' . implode(' AND ', array(
                $fields,
                $this->db->in('profpref.value', array('y', 'g'), false, 'text')
            )) . ')'];
        }

        // The login field must be searchable regardless (for 'logged in' users) of any privacy settings.
        // We handled the general condition for 'anonymous' context above: profile = 'g'
        $field_conditions[] = $this->getQueryConditionByFieldAndValue('login', $search_query);

        include_once 'Services/User/classes/class.ilUserAccountSettings.php';
        if (ilUserAccountSettings::getInstance()->isUserAccessRestricted()) {
            include_once './Services/User/classes/class.ilUserFilter.php';
            $outer_conditions[] = $this->db->in('time_limit_owner', ilUserFilter::getInstance()->getFolderIds(), false, 'integer');
        }

        if ($field_conditions) {
            $outer_conditions[] = '(' . implode(' OR ', $field_conditions) . ')';
        }

        return implode(' AND ', $outer_conditions);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

key()

ilMailAutoCompleteUserProvider::key

(

)

"Key" implementation of iterator interface

Returns

boolean true/false

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

References data.

    {
        return $this->data['login'];
    }

rewind()

ilMailAutoCompleteUserProvider::rewind

(

)

"Rewind "implementation of iterator interface

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

References $query, array, getFromPart(), getOrderByPart(), getSelectPart(), and getWherePart().

    {
        if ($this->res) {
            $this->db->free($this->res);
            $this->res = null;
        }
        $select_part   = $this->getSelectPart();
        $where_part    = $this->getWherePart($this->quoted_term);
        $order_by_part = $this->getOrderByPart();
        $query         = implode(" ", array(
            'SELECT ' . $select_part,
            'FROM ' . $this->getFromPart(),
            $where_part ? 'WHERE ' . $where_part : '',
            $order_by_part ? 'ORDER BY ' . $order_by_part : ''
        ));

        $this->res = $this->db->query($query);
    }

Here is the call graph for this function:

valid()

ilMailAutoCompleteUserProvider::valid

(

)

"Valid" implementation of iterator interface

Returns

boolean true/false

Definition at line 25 of file class.ilMailAutoCompleteUserProvider.php.

References data.

    {
        $this->data = $this->db->fetchAssoc($this->res);

        return is_array($this->data);
    }

---

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

• Services/Mail/classes/class.ilMailAutoCompleteUserProvider.php