Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Fonctions membres publiques | Champs de données | Attributs protégés | Fonctions membres privées | Attributs privés
Référence de la classe Query
+ Graphe d'héritage de Query:

Fonctions membres publiques

 __construct (Connection $connection, string $dn, string $query, array $options=[])
 
 __sleep ()
 
 __wakeup ()
 
 __destruct ()
 
 execute ()
 
 getResource (int $idx=0)
 
 getResources ()
 
- Fonctions membres publiques hérités de AbstractQuery
 __construct (ConnectionInterface $connection, string $dn, string $query, array $options=[])
 

Champs de données

const PAGINATION_OID = '1.2.840.113556.1.4.319'
 
- Champs de données hérités de QueryInterface
const DEREF_NEVER = 0x00
 
const DEREF_SEARCHING = 0x01
 
const DEREF_FINDING = 0x02
 
const DEREF_ALWAYS = 0x03
 
const SCOPE_BASE = 'base'
 
const SCOPE_ONE = 'one'
 
const SCOPE_SUB = 'sub'
 

Attributs protégés

 $connection
 
- Attributs protégés hérités de AbstractQuery
 $connection
 
 $dn
 
 $query
 
 $options
 

Fonctions membres privées

 resetPagination ()
 
 controlPagedResult ($con, int $pageSize, bool $critical, string $cookie)
 
 controlPagedResultResponse ($con, $result, string $cookie='')
 
 callSearchFunction ($con, callable $func, int $sizeLimit)
 

Attributs privés

 $results
 
 $serverctrls = []
 

Description détaillée

Auteur
Charles Sarrazin charl.nosp@m.es@s.nosp@m.arraz.nosp@m..in
Bob van de Vijver bobva.nosp@m.ndev.nosp@m.ijver.nosp@m.@hot.nosp@m.mail..nosp@m.com

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( Connection  $connection,
string  $dn,
string  $query,
array  $options = [] 
)

Références Query\$connection, AbstractQuery\$dn, AbstractQuery\$options, AbstractQuery\$query, et Symfony\Contracts\Service\__construct().

◆ __destruct()

__destruct ( )

Références $result, et null.

Documentation des fonctions membres

◆ __sleep()

__sleep ( )
Renvoie
array

◆ __wakeup()

__wakeup ( )

◆ callSearchFunction()

callSearchFunction (   $con,
callable  $func,
int  $sizeLimit 
)
private

Calls actual LDAP search function with the prepared options and parameters.

Paramètres
resource | LDAPConnection$con
Renvoie
resource|Result|false

Référencé par Query\execute().

◆ controlPagedResult()

controlPagedResult (   $con,
int  $pageSize,
bool  $critical,
string  $cookie 
)
private

Sets LDAP pagination controls.

Paramètres
resource | LDAPConnection$con

Référencé par Query\execute(), et Query\resetPagination().

◆ controlPagedResultResponse()

controlPagedResultResponse (   $con,
  $result,
string  $cookie = '' 
)
private

Retrieve LDAP pagination cookie.

Paramètres
resource | LDAPConnection$con
resource | Result$result

Références $result.

Référencé par Query\execute().

◆ execute()

execute ( )

{Executes a query and returns the list of Ldap entries.

Renvoie
CollectionInterface
Exceptions
NotBoundException
LdapException
}

Implémente QueryInterface.

Références $this, Query\callSearchFunction(), Query\controlPagedResult(), Query\controlPagedResultResponse(), elseif, null, et Query\resetPagination().

◆ getResource()

getResource ( int  $idx = 0)

Returns an LDAP search resource. If this query resulted in multiple searches, only the first page will be returned.

Renvoie
resource|Result|null

Références null.

◆ getResources()

getResources ( )

Returns all LDAP search resources.

Renvoie
resource[]|Result[]

Références Query\$results.

◆ resetPagination()

resetPagination ( )
private

Resets pagination on the current connection.

Références $info, et Query\controlPagedResult().

Référencé par Query\execute().

Documentation des champs

◆ $connection

$connection
protected

Référencé par Query\__construct().

◆ $results

$results
private

Référencé par Query\getResources().

◆ $serverctrls

$serverctrls = []
private

◆ PAGINATION_OID

const PAGINATION_OID = '1.2.840.113556.1.4.319'
La documentation de cette classe a été générée à partir du fichier suivant :