bn8/ldapsaisie
1
0
Fork 0
mirror of https://gitlab.easter-eggs.com/ee/ldapsaisie.git synced 2024-11-23 02:19:07 +01:00
Code Issues Projects Releases Wiki Activity
ldapsaisie/doc/dist/4.2.0-1-28-g4235c05/conf/LSobject/LSsearch/index.html

4021 lines
No EOL
87 KiB
HTML
Raw Blame History

<!doctype html>
<html lang="fr" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="Documentation">
<meta name="author" content="Benjamin Renard <brenard@easter-eggs.com / brenard@zionetrix.net>">
<link rel="canonical" href="https://ldapsaisie.org/doc/dev/conf/LSobject/LSsearch/">
<link rel="prev" href="../LSform/">
<link rel="next" href="../ioFormat/">
<link rel="icon" href="../../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.25">
<title>Recherche des objets dans l'annuaire (LSsearch) - LdapSaisie</title>
<link rel="stylesheet" href="../../../assets/stylesheets/main.6543a935.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<link rel="stylesheet" href="../../../css/print-site.css">
<link rel="stylesheet" href="../../../css/print-site-material.css">
<script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="light-blue" data-md-color-accent="blue">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#recherche-des-objets-dans-lannuaire-lssearch" class="md-skip">
Aller au contenu
</a>
</div>
<div data-md-component="announce">
</div>
<div data-md-color-scheme="default" data-md-component="outdated" hidden>
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="En-tête">
<a href="https://ldapsaisie.org" title="LdapSaisie" class="md-header__button md-logo" aria-label="LdapSaisie" data-md-component="logo">
<img src="../../../assets/images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
LdapSaisie
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Recherche des objets dans l'annuaire (LSsearch)
</span>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Rechercher" placeholder="Rechercher" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Recherche">
<button type="reset" class="md-search__icon md-icon" title="Effacer" aria-label="Effacer" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initialisation de la recherche
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://gitlab.easter-eggs.com/ee/ldapsaisie" title="Aller au dépôt" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
ee/ldapsaisie
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="https://ldapsaisie.org" title="LdapSaisie" class="md-nav__button md-logo" aria-label="LdapSaisie" data-md-component="logo">
<img src="../../../assets/images/logo.png" alt="logo">
</a>
LdapSaisie
</label>
<div class="md-nav__source">
<a href="https://gitlab.easter-eggs.com/ee/ldapsaisie" title="Aller au dépôt" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
ee/ldapsaisie
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../.." class="md-nav__link">
<span class="md-ellipsis">
Introduction
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Installation
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Installation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../install/requirements/" class="md-nav__link">
<span class="md-ellipsis">
Pré-requis
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../install/download/" class="md-nav__link">
<span class="md-ellipsis">
Téléchargement
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../install/arbo/" class="md-nav__link">
<span class="md-ellipsis">
Arborescence du projet
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../install/howto/" class="md-nav__link">
<span class="md-ellipsis">
Tutoriel d'installation
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
Mise à jour
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Mise à jour
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../upgrade/" class="md-nav__link">
<span class="md-ellipsis">
Instroduction
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../upgrade/method/" class="md-nav__link">
<span class="md-ellipsis">
Procédure de mise à jour
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../upgrade/2_4_1-to-3_0_0/" class="md-nav__link">
<span class="md-ellipsis">
2.4.1 -> 3.0.0
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
Configuration
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Configuration
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../" class="md-nav__link">
<span class="md-ellipsis">
Introduction
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_2" >
<label class="md-nav__link" for="__nav_4_2" id="__nav_4_2_label" tabindex="0">
<span class="md-ellipsis">
Configuration globale
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span>
Configuration globale
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../global/" class="md-nav__link">
<span class="md-ellipsis">
Introduction
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_2_2" >
<label class="md-nav__link" for="__nav_4_2_2" id="__nav_4_2_2_label" tabindex="0">
<span class="md-ellipsis">
Connexion LDAP
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="3" aria-labelledby="__nav_4_2_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_2_2">
<span class="md-nav__icon md-icon"></span>
Connexion LDAP
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../global/ldap/" class="md-nav__link">
<span class="md-ellipsis">
Configuration des serveurs LDAP
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../global/ldap/LSprofile/" class="md-nav__link">
<span class="md-ellipsis">
Profils d'utilisateurs (LSprofile)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../global/ldap/subDn/" class="md-nav__link">
<span class="md-ellipsis">
Sous-niveaux de connexion (subDn)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../global/ldap/recoverPassword/" class="md-nav__link">
<span class="md-ellipsis">
Récupération de mot de passe
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../../global/LSlog/" class="md-nav__link">
<span class="md-ellipsis">
Configuration de la journalisation (LSlog)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../global/LSformat/" class="md-nav__link">
<span class="md-ellipsis">
Format paramétrable (LSformat)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../global/LDAP_search_params/" class="md-nav__link">
<span class="md-ellipsis">
Paramètres étendus des recherches dans l'annuaire
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" checked>
<label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
<span class="md-ellipsis">
Objets de l'annuaire
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span>
Objets de l'annuaire
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../" class="md-nav__link">
<span class="md-ellipsis">
Configuration LSobject
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3_2" >
<label class="md-nav__link" for="__nav_4_3_2" id="__nav_4_3_2_label" tabindex="0">
<span class="md-ellipsis">
Attributs
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="3" aria-labelledby="__nav_4_3_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_3_2">
<span class="md-nav__icon md-icon"></span>
Attributs
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../LSattribute/" class="md-nav__link">
<span class="md-ellipsis">
Configuration des attributs
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3_2_2" >
<label class="md-nav__link" for="__nav_4_3_2_2" id="__nav_4_3_2_2_label" tabindex="0">
<span class="md-ellipsis">
Types d'attribut LDAP (LSattr_ldap)
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_3_2_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_3_2_2">
<span class="md-nav__icon md-icon"></span>
Types d'attribut LDAP (LSattr_ldap)
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_ldap/" class="md-nav__link">
<span class="md-ellipsis">
Introduction
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_ldap/LSattr_ldap_ascii/" class="md-nav__link">
<span class="md-ellipsis">
ascii
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_ldap/LSattr_ldap_boolean/" class="md-nav__link">
<span class="md-ellipsis">
boolean
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_ldap/LSattr_ldap_compositeValueToJSON/" class="md-nav__link">
<span class="md-ellipsis">
compositeValueToJson
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_ldap/LSattr_ldap_date/" class="md-nav__link">
<span class="md-ellipsis">
date
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_ldap/LSattr_ldap_image/" class="md-nav__link">
<span class="md-ellipsis">
image
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_ldap/LSattr_ldap_naiveDate/" class="md-nav__link">
<span class="md-ellipsis">
naiveDate
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_ldap/LSattr_ldap_numeric/" class="md-nav__link">
<span class="md-ellipsis">
numeric
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_ldap/LSattr_ldap_password/" class="md-nav__link">
<span class="md-ellipsis">
password
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_ldap/LSattr_ldap_postaladdress/" class="md-nav__link">
<span class="md-ellipsis">
postaladdress
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_ldap/LSattr_ldap_pwdHistory/" class="md-nav__link">
<span class="md-ellipsis">
pwdHistory
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_ldap/LSattr_ldap_sambaAcctFlags/" class="md-nav__link">
<span class="md-ellipsis">
sambaAcctFlags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_ldap/LSattr_ldap_shadowExpire/" class="md-nav__link">
<span class="md-ellipsis">
shadowExpire
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3_2_3" >
<label class="md-nav__link" for="__nav_4_3_2_3" id="__nav_4_3_2_3_label" tabindex="0">
<span class="md-ellipsis">
Types d'attribut HTML (LSattr_html)
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_3_2_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_3_2_3">
<span class="md-nav__icon md-icon"></span>
Types d'attribut HTML (LSattr_html)
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_html/" class="md-nav__link">
<span class="md-ellipsis">
Introduction
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_html/LSattr_html_boolean/" class="md-nav__link">
<span class="md-ellipsis">
boolean
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_html/LSattr_html_date/" class="md-nav__link">
<span class="md-ellipsis">
date
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_html/LSattr_html_gpg_pub_key/" class="md-nav__link">
<span class="md-ellipsis">
gpg_pub_key
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_html/LSattr_html_image/" class="md-nav__link">
<span class="md-ellipsis">
image
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_html/LSattr_html_jsonCompositeAttribute/" class="md-nav__link">
<span class="md-ellipsis">
jsonCompositeAttribute
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_html/LSattr_html_labeledValue/" class="md-nav__link">
<span class="md-ellipsis">
labeledValue
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_html/LSattr_html_mail/" class="md-nav__link">
<span class="md-ellipsis">
mail
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_html/LSattr_html_maildir/" class="md-nav__link">
<span class="md-ellipsis">
maildir
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_html/LSattr_html_mailQuota/" class="md-nav__link">
<span class="md-ellipsis">
mailQuota
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_html/LSattr_html_password/" class="md-nav__link">
<span class="md-ellipsis">
password
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_html/LSattr_html_postaladdress/" class="md-nav__link">
<span class="md-ellipsis">
postaladdress
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_html/LSattr_html_pre/" class="md-nav__link">
<span class="md-ellipsis">
pre
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_html/LSattr_html_rss/" class="md-nav__link">
<span class="md-ellipsis">
rss
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_html/LSattr_html_sambaAcctFlags/" class="md-nav__link">
<span class="md-ellipsis">
sambaAcctFlags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_html/LSattr_html_select_box/" class="md-nav__link">
<span class="md-ellipsis">
select_box
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_html/LSattr_html_select_list/" class="md-nav__link">
<span class="md-ellipsis">
select_list
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_html/LSattr_html_select_object/" class="md-nav__link">
<span class="md-ellipsis">
select_object
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_html/LSattr_html_ssh_key/" class="md-nav__link">
<span class="md-ellipsis">
ssh_key
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_html/LSattr_html_tel/" class="md-nav__link">
<span class="md-ellipsis">
tel
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_html/LSattr_html_text/" class="md-nav__link">
<span class="md-ellipsis">
text
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_html/LSattr_html_textarea/" class="md-nav__link">
<span class="md-ellipsis">
textarea
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_html/LSattr_html_url/" class="md-nav__link">
<span class="md-ellipsis">
url
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_html/LSattr_html_valueWithUnit/" class="md-nav__link">
<span class="md-ellipsis">
valueWithUnit
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_html/LSattr_html_wysiwyg/" class="md-nav__link">
<span class="md-ellipsis">
wysiwyg
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/LSattr_html/LSattr_html_xmpp/" class="md-nav__link">
<span class="md-ellipsis">
xmpp
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3_2_4" >
<label class="md-nav__link" for="__nav_4_3_2_4" id="__nav_4_3_2_4_label" tabindex="0">
<span class="md-ellipsis">
Règles de vérification syntaxique (LSformRule)
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_3_2_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_3_2_4">
<span class="md-nav__icon md-icon"></span>
Règles de vérification syntaxique (LSformRule)
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../LSattribute/check_data/" class="md-nav__link">
<span class="md-ellipsis">
Introduction
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/check_data/alphanumeric/" class="md-nav__link">
<span class="md-ellipsis">
alphanumeric
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/check_data/callable/" class="md-nav__link">
<span class="md-ellipsis">
callable
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/check_data/date/" class="md-nav__link">
<span class="md-ellipsis">
date
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/check_data/differentPassword/" class="md-nav__link">
<span class="md-ellipsis">
differentPassword
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/check_data/email/" class="md-nav__link">
<span class="md-ellipsis">
email
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/check_data/filesize/" class="md-nav__link">
<span class="md-ellipsis">
filesize
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/check_data/gpg_pub_key/" class="md-nav__link">
<span class="md-ellipsis">
gpg_pub_key
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/check_data/imagefile/" class="md-nav__link">
<span class="md-ellipsis">
imagefile
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/check_data/imagesize/" class="md-nav__link">
<span class="md-ellipsis">
imagesize
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/check_data/inarray/" class="md-nav__link">
<span class="md-ellipsis">
inarray
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/check_data/integer/" class="md-nav__link">
<span class="md-ellipsis">
integer
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/check_data/ldapSearchURI/" class="md-nav__link">
<span class="md-ellipsis">
ldapSearchURI
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/check_data/lettersonly/" class="md-nav__link">
<span class="md-ellipsis">
lettersonly
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/check_data/maxlength/" class="md-nav__link">
<span class="md-ellipsis">
maxlength
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/check_data/mimetype/" class="md-nav__link">
<span class="md-ellipsis">
mimetype
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/check_data/minlength/" class="md-nav__link">
<span class="md-ellipsis">
minlength
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/check_data/nonzero/" class="md-nav__link">
<span class="md-ellipsis">
nonzero
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/check_data/nopunctuation/" class="md-nav__link">
<span class="md-ellipsis">
nopunctuation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/check_data/numberOfValues/" class="md-nav__link">
<span class="md-ellipsis">
numberOfValues
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/check_data/numeric/" class="md-nav__link">
<span class="md-ellipsis">
numeric
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/check_data/password/" class="md-nav__link">
<span class="md-ellipsis">
password
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/check_data/rangelength/" class="md-nav__link">
<span class="md-ellipsis">
rangelength
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/check_data/regex/" class="md-nav__link">
<span class="md-ellipsis">
regex
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/check_data/required/" class="md-nav__link">
<span class="md-ellipsis">
required
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/check_data/ssh_pub_key/" class="md-nav__link">
<span class="md-ellipsis">
ssh_pub_key
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/check_data/telephonenumber/" class="md-nav__link">
<span class="md-ellipsis">
telephonenumber
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/check_data/zxcvbn/" class="md-nav__link">
<span class="md-ellipsis">
zxcvbn
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../LSattribute/validation/" class="md-nav__link">
<span class="md-ellipsis">
Règles de vérification d'intégrité
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSattribute/triggers/" class="md-nav__link">
<span class="md-ellipsis">
Déclencheurs
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../container_auto_create/" class="md-nav__link">
<span class="md-ellipsis">
Création automatique du conteneur des LSobjets dans un subDn
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../triggers/" class="md-nav__link">
<span class="md-ellipsis">
Déclencheurs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../customActions/" class="md-nav__link">
<span class="md-ellipsis">
Actions personnalisées (customActions)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSrelation/" class="md-nav__link">
<span class="md-ellipsis">
Les relations entre les objets de l'annuire (LSrelation)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../LSform/" class="md-nav__link">
<span class="md-ellipsis">
Les formulaires (LSform)
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Recherche des objets dans l'annuaire (LSsearch)
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Recherche des objets dans l'annuaire (LSsearch)
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table des matières">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table des matières
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#les-actions-personnalisees-customactions" class="md-nav__link">
<span class="md-ellipsis">
Les actions personnalisées (customActions)
</span>
</a>
<nav class="md-nav" aria-label="Les actions personnalisées (customActions)">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#ecriture-dune-fonction-implementant-une-customaction" class="md-nav__link">
<span class="md-ellipsis">
Écriture d'une fonction implémentant une customAction
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../ioFormat/" class="md-nav__link">
<span class="md-ellipsis">
Les formats d'import/export (ioFormat)
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
<label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
<span class="md-ellipsis">
Configuration des addons (LSaddons)
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span>
Configuration des addons (LSaddons)
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../LSaddon/" class="md-nav__link">
<span class="md-ellipsis">
Introduction
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../LSaddon/LSaddon_accesslog/" class="md-nav__link">
<span class="md-ellipsis">
accesslog
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../LSaddon/LSaddon_asterisk/" class="md-nav__link">
<span class="md-ellipsis">
asterisk
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../LSaddon/LSaddon_exportSearchResultAsCSV/" class="md-nav__link">
<span class="md-ellipsis">
exportSearchResultAsCSV
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../LSaddon/LSaddon_impersonate/" class="md-nav__link">
<span class="md-ellipsis">
impersonate
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../LSaddon/LSaddon_LSaccessRightsMatrixView/" class="md-nav__link">
<span class="md-ellipsis">
LSaccessRightsMatrixView
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../LSaddon/LSaddon_mail/" class="md-nav__link">
<span class="md-ellipsis">
mail
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../LSaddon/LSaddon_maildir/" class="md-nav__link">
<span class="md-ellipsis">
maildir
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../LSaddon/LSaddon_mailquota/" class="md-nav__link">
<span class="md-ellipsis">
mailquota
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../LSaddon/LSaddon_phpldapadmin/" class="md-nav__link">
<span class="md-ellipsis">
phpldapadmin
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../LSaddon/LSaddon_ppolicy/" class="md-nav__link">
<span class="md-ellipsis">
ppolicy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../LSaddon/LSaddon_showSupportInfo/" class="md-nav__link">
<span class="md-ellipsis">
showSupportInfo
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../LSaddon/LSaddon_showTechInfo/" class="md-nav__link">
<span class="md-ellipsis">
showTechInfo
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_5" >
<label class="md-nav__link" for="__nav_4_5" id="__nav_4_5_label" tabindex="0">
<span class="md-ellipsis">
Configuration des méthodes d'authentification (LSauthMethod)
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_5">
<span class="md-nav__icon md-icon"></span>
Configuration des méthodes d'authentification (LSauthMethod)
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../LSauthMethod/" class="md-nav__link">
<span class="md-ellipsis">
Introduction
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../LSauthMethod/LSauthMethod_anonymous/" class="md-nav__link">
<span class="md-ellipsis">
anonymous
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../LSauthMethod/LSauthMethod_CAS/" class="md-nav__link">
<span class="md-ellipsis">
CAS
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../LSauthMethod/LSauthMethod_HTTP/" class="md-nav__link">
<span class="md-ellipsis">
HTTP
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../../../api/" class="md-nav__link">
<span class="md-ellipsis">
API
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<span class="md-ellipsis">
Contribution
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Contribution
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../contrib/" class="md-nav__link">
<span class="md-ellipsis">
Introduction
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
<label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
<span class="md-ellipsis">
Les addons (LSaddon)
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6_2">
<span class="md-nav__icon md-icon"></span>
Les addons (LSaddon)
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../contrib/addons/" class="md-nav__link">
<span class="md-ellipsis">
Introduction
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../contrib/addons/custom-views/" class="md-nav__link">
<span class="md-ellipsis">
Les vues personnalisées
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../contrib/addons/cli-commands/" class="md-nav__link">
<span class="md-ellipsis">
Les commandes CLI personnalisées
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../../../contrib/form-elements/" class="md-nav__link">
<span class="md-ellipsis">
Les éléments des formulaires (LSformElement)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../contrib/form-rules/" class="md-nav__link">
<span class="md-ellipsis">
Les règles de validation syntaxiques (LSformRule)
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../../../print_page/" class="md-nav__link">
<span class="md-ellipsis">
Documentation
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table des matières">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table des matières
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#les-actions-personnalisees-customactions" class="md-nav__link">
<span class="md-ellipsis">
Les actions personnalisées (customActions)
</span>
</a>
<nav class="md-nav" aria-label="Les actions personnalisées (customActions)">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#ecriture-dune-fonction-implementant-une-customaction" class="md-nav__link">
<span class="md-ellipsis">
Écriture d'une fonction implémentant une customAction
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<a href="../../../print_page/" title="Print Site" class="md-content__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 3H6v4h12m1 5a1 1 0 0 1-1-1 1 1 0 0 1 1-1 1 1 0 0 1 1 1 1 1 0 0 1-1 1m-3 7H8v-5h8m3-6H5a3 3 0 0 0-3 3v6h4v4h12v-4h4v-6a3 3 0 0 0-3-3Z"/></svg>
</a>
<h1 id="recherche-des-objets-dans-lannuaire-lssearch">Recherche des objets dans l'annuaire (LSsearch)</h1>
<p>Cette section décrit la manière de paramétrer les recherches dans l'annuaire pour un type
d'<a href="../#configuration-lsobject">LSobject</a> donné.</p>
<p>La configuration des <em>LSsearch</em> se situe dans la configuration des
<a href="../#configuration-lsobject">LSobjects</a>, dans la variable <code>LSsearch</code>
(<code>$GLOBALS['LSobjects']['[nom du type d'LSobject]']['LSsearch']</code>).</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="x">$GLOBALS[&#39;LSobjects&#39;][&#39;[nom du type d&#39;LSobject]&#39;][&#39;LSsearch&#39;] = array (</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="x"> &#39;attrs&#39; =&gt; array(</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="x"> &#39;attr1&#39;,</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="x"> &#39;attr2&#39;,</span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="x"> ...</span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="x"> &#39;attr3&#39; =&gt; array(</span>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="x"> &#39;searchLSformat&#39; =&gt; &#39;[LSformat]&#39;,</span>
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="x"> &#39;approxLSformat&#39; =&gt; &#39;[LSformat]&#39;,</span>
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="x"> ),</span>
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="x"> ...</span>
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a><span class="x"> ),</span>
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a><span class="x"> &#39;params&#39; =&gt; array(</span>
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a><span class="x"> // Paramètres de la recherche</span>
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a><span class="x"> &#39;pattern&#39; =&gt; &#39;[string]&#39;,</span>
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a><span class="x"> &#39;sizelimit&#39; =&gt; [integer],</span>
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a><span class="x"> &#39;recursive&#39; =&gt; [boolean],</span>
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a><span class="x"> &#39;approx&#39; =&gt; [boolean],</span>
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a><span class="x"> &#39;withoutCache&#39; =&gt; [boolean],</span>
<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a><span class="x"> &#39;onlyAccessible&#39; =&gt; [boolean],</span>
<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a><span class="x"> // Paramètres de tri</span>
<a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a><span class="x"> &#39;sortBy&#39; =&gt; [displayName|subDn],</span>
<a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a><span class="x"> &#39;sortDirection&#39; =&gt; [ASC|DESC],</span>
<a id="__codelineno-0-23" name="__codelineno-0-23" href="#__codelineno-0-23"></a><span class="x"> &#39;sortlimit&#39; =&gt; [integer],</span>
<a id="__codelineno-0-24" name="__codelineno-0-24" href="#__codelineno-0-24"></a><span class="x"> // Paramètre d&#39;affichage</span>
<a id="__codelineno-0-25" name="__codelineno-0-25" href="#__codelineno-0-25"></a><span class="x"> &#39;displayFormat&#39; =&gt; [LSformat],</span>
<a id="__codelineno-0-26" name="__codelineno-0-26" href="#__codelineno-0-26"></a><span class="x"> &#39;nbObjectsByPage&#39; =&gt; [integer],</span>
<a id="__codelineno-0-27" name="__codelineno-0-27" href="#__codelineno-0-27"></a><span class="x"> &#39;nbObjectsByPageChoices&#39; =&gt; array([integer], [integer], ...),</span>
<a id="__codelineno-0-28" name="__codelineno-0-28" href="#__codelineno-0-28"></a><span class="x"> &#39;validPatternRegex&#39; =&gt; &#39;[regex]&#39;</span>
<a id="__codelineno-0-29" name="__codelineno-0-29" href="#__codelineno-0-29"></a><span class="x"> ),</span>
<a id="__codelineno-0-30" name="__codelineno-0-30" href="#__codelineno-0-30"></a><span class="x"> &#39;predefinedFilters&#39; =&gt; array(</span>
<a id="__codelineno-0-31" name="__codelineno-0-31" href="#__codelineno-0-31"></a><span class="x"> &#39;filter1&#39; =&gt; &#39;label filter1&#39;,</span>
<a id="__codelineno-0-32" name="__codelineno-0-32" href="#__codelineno-0-32"></a><span class="x"> &#39;filter2&#39; =&gt; &#39;label filter2&#39;</span>
<a id="__codelineno-0-33" name="__codelineno-0-33" href="#__codelineno-0-33"></a><span class="x"> ),</span>
<a id="__codelineno-0-34" name="__codelineno-0-34" href="#__codelineno-0-34"></a><span class="x"> &#39;extraDisplayedColumns&#39; =&gt; array(</span>
<a id="__codelineno-0-35" name="__codelineno-0-35" href="#__codelineno-0-35"></a><span class="x"> &#39;col1&#39; =&gt; array(</span>
<a id="__codelineno-0-36" name="__codelineno-0-36" href="#__codelineno-0-36"></a><span class="x"> &#39;label&#39; =&gt; &#39;label column 1&#39;,</span>
<a id="__codelineno-0-37" name="__codelineno-0-37" href="#__codelineno-0-37"></a><span class="x"> &#39;LSformat&#39; =&gt; &#39;[LSformat]&#39;</span>
<a id="__codelineno-0-38" name="__codelineno-0-38" href="#__codelineno-0-38"></a><span class="x"> ),</span>
<a id="__codelineno-0-39" name="__codelineno-0-39" href="#__codelineno-0-39"></a><span class="x"> &#39;col2&#39; =&gt; array(</span>
<a id="__codelineno-0-40" name="__codelineno-0-40" href="#__codelineno-0-40"></a><span class="x"> &#39;label&#39; =&gt; &#39;label column 2&#39;,</span>
<a id="__codelineno-0-41" name="__codelineno-0-41" href="#__codelineno-0-41"></a><span class="x"> &#39;generateFunction&#39; =&gt; &#39;[fonction de génération]&#39;,</span>
<a id="__codelineno-0-42" name="__codelineno-0-42" href="#__codelineno-0-42"></a><span class="x"> &#39;additionalAttrs&#39; =&gt; array(&#39;[attr1]&#39;, &#39;[attr2]&#39;, ...),</span>
<a id="__codelineno-0-43" name="__codelineno-0-43" href="#__codelineno-0-43"></a><span class="x"> &#39;escape&#39; =&gt; [booléen],</span>
<a id="__codelineno-0-44" name="__codelineno-0-44" href="#__codelineno-0-44"></a><span class="x"> ),</span>
<a id="__codelineno-0-45" name="__codelineno-0-45" href="#__codelineno-0-45"></a><span class="x"> &#39;col3&#39; =&gt; array(</span>
<a id="__codelineno-0-46" name="__codelineno-0-46" href="#__codelineno-0-46"></a><span class="x"> &#39;label&#39; =&gt; &#39;label column 3&#39;,</span>
<a id="__codelineno-0-47" name="__codelineno-0-47" href="#__codelineno-0-47"></a><span class="x"> &#39;LSformat&#39; =&gt; &#39;[LSformat]&#39;,</span>
<a id="__codelineno-0-48" name="__codelineno-0-48" href="#__codelineno-0-48"></a><span class="x"> &#39;alternativeLSformats&#39; =&gt; array (</span>
<a id="__codelineno-0-49" name="__codelineno-0-49" href="#__codelineno-0-49"></a><span class="x"> &#39;[LSformat 1]&#39;,</span>
<a id="__codelineno-0-50" name="__codelineno-0-50" href="#__codelineno-0-50"></a><span class="x"> &#39;[LSformat 2]&#39;</span>
<a id="__codelineno-0-51" name="__codelineno-0-51" href="#__codelineno-0-51"></a><span class="x"> ),</span>
<a id="__codelineno-0-52" name="__codelineno-0-52" href="#__codelineno-0-52"></a><span class="x"> &#39;formaterLSformat&#39; =&gt; &#39;[LSformat]&#39;,</span>
<a id="__codelineno-0-53" name="__codelineno-0-53" href="#__codelineno-0-53"></a><span class="x"> &#39;formaterFunction&#39; =&gt; &#39;[fonction de formatage]&#39;,</span>
<a id="__codelineno-0-54" name="__codelineno-0-54" href="#__codelineno-0-54"></a><span class="x"> &#39;cssStyle&#39; =&gt; &#39;[CSS style]&#39;,</span>
<a id="__codelineno-0-55" name="__codelineno-0-55" href="#__codelineno-0-55"></a><span class="x"> &#39;visibleTo&#39; =&gt; array (</span>
<a id="__codelineno-0-56" name="__codelineno-0-56" href="#__codelineno-0-56"></a><span class="x"> &#39;[LSprofile 1]&#39;,</span>
<a id="__codelineno-0-57" name="__codelineno-0-57" href="#__codelineno-0-57"></a><span class="x"> &#39;[LSprofile 2]&#39;</span>
<a id="__codelineno-0-58" name="__codelineno-0-58" href="#__codelineno-0-58"></a><span class="x"> )</span>
<a id="__codelineno-0-59" name="__codelineno-0-59" href="#__codelineno-0-59"></a><span class="x"> ),</span>
<a id="__codelineno-0-60" name="__codelineno-0-60" href="#__codelineno-0-60"></a><span class="x"> ),</span>
<a id="__codelineno-0-61" name="__codelineno-0-61" href="#__codelineno-0-61"></a><span class="x"> &#39;customActions&#39; =&gt; array (</span>
<a id="__codelineno-0-62" name="__codelineno-0-62" href="#__codelineno-0-62"></a><span class="x"> // Configuration des customActions pour les recherches de ce type d&#39;objet</span>
<a id="__codelineno-0-63" name="__codelineno-0-63" href="#__codelineno-0-63"></a><span class="x"> ),</span>
<a id="__codelineno-0-64" name="__codelineno-0-64" href="#__codelineno-0-64"></a><span class="x"> &#39;showSelectionBoxes&#39; =&gt; [boolean],</span>
<a id="__codelineno-0-65" name="__codelineno-0-65" href="#__codelineno-0-65"></a><span class="x">);</span>
</code></pre></div>
<ul>
<li>
<p><code>attrs</code></p>
<p>Tableau listant les attributs pouvant être utilisés dans les filtres de recherche LDAP employés
par LdapSaisie. Lorsqu'un motif de recherche est passé par l'utilisateur, LdapSaisie composera un
filtre LDAP à partir de cette liste.</p>
<p>Lors d'une recherche non-approximative, le filtre de recherche sera composé (par défaut) de la
manière suivante :</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>(|(attr1=*motif*)(attr2=*motif*)...)
</code></pre></div>
<p>Lors d'une recherche approximative, le filtre de recherche sera composé (par défaut) de la manière
suivante :</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>(|(attr1=~motif)(attr2~=motif)...)
</code></pre></div>
<p>Il est également possible de paramétrer la manière dont sera composé le filtre de recherche
attribut par attribut à l'aide des paramètres <code>searchLSformat</code> et <code>approxLSformat</code>.</p>
<div class="admonition important">
<p class="admonition-title">Important</p>
<p>Ces filtres, une fois composés, sont insérés dans un autre, filtrant en plus sur les
<em>ObjectClass</em> du type d'<a href="../#configuration-lsobject">LSobject</a> de la manière suivante :</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>(&amp; (&amp;(objectclass=oc1)(objectclass=oc2)) (filtre) )
</code></pre></div>
</div>
<ul>
<li>
<p><code>searchLSformat</code></p>
<p>Ce paramètre est un <a href="../../global/LSformat/#format-parametrable">LSformat</a> permettant de définir,
attribut par attribut, comment le filtre de recherche LDAP est composé à partir d'un motif de
recherche et en cas de recherche non-approximative.</p>
<p>Ce <a href="../../global/LSformat/#format-parametrable">LSformat</a> est composé à l'aide des éléments
<code>name</code>, le nom de l'attribut et <code>pattern</code>, le motif de recherche.</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>(%{name}=%{pattern})
</code></pre></div>
<div class="admonition important">
<p class="admonition-title">Important</p>
<p>Le filtre déduit doit obligatoirement commencer par <code>(</code> et se terminer par <code>)</code>.</p>
</div>
</li>
</ul>
<ul>
<li>
<p><code>approxLSformat</code></p>
<p>Ce paramètre est un <a href="../../global/LSformat/#format-parametrable">LSformat</a> permettant de définir,
attribut par attribut, comment le filtre de recherche LDAP est composé à partir d'un motif de
recherche et en cas de recherche approximative.</p>
<p>Ce <a href="../../global/LSformat/#format-parametrable">LSformat</a> est composé à l'aide des éléments
<code>name</code>, le nom de l'attribut et <code>pattern</code>, le motif de recherche.</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>(%{name}=~%{pattern})
</code></pre></div>
<div class="admonition important">
<p class="admonition-title">Important</p>
<p>Le filtre déduit doit obligatoirement commencer par <code>(</code> et se terminer par <code>)</code>.</p>
</div>
</li>
</ul>
</li>
</ul>
<ul>
<li>
<p><code>params</code></p>
<p>Tableau des paramètres par défaut d'une recherche. Ce tableau contient les paramètres qui seront
utilisés pour initialisé une recherche. Ces paramètres pourront être redéfini par l'utilisateur
ou par l'application en fonction du contexte dans lequel cette recherche est effectuée.</p>
<ul>
<li>
<p><code>pattern</code></p>
<p>Mot clé de la recherche.</p>
</li>
</ul>
<ul>
<li>
<p><code>sizelimit</code></p>
<p>Entier determinant le nombre maximum d'objet pouvant être retournés dans une recherche.</p>
</li>
</ul>
<ul>
<li>
<p><code>recursive</code></p>
<p>Booléen déterminant si la recherche récursive est activée.</p>
</li>
</ul>
<ul>
<li>
<p><code>approx</code></p>
<p>Booléen déterminant si la recherche approximative est activée.</p>
</li>
</ul>
<ul>
<li>
<p><code>withoutCache</code></p>
<p>Booléen déterminant si le cache de recherche doit être utilisé.</p>
</li>
</ul>
<ul>
<li>
<p><code>onlyAccessible</code></p>
<p>Booléen déterminant si seul les objets accessibles à l'utilisateur connecté doivent être
retournés par la recherche.</p>
</li>
</ul>
<ul>
<li>
<p><code>sortBy</code></p>
<p>Mot clé déterminant sur quel valeur/colonne le résultat de recherche sera trié.</p>
<p>Valeurs possibles : <code>displayName</code>, <code>subDn</code> ou <code>NULL</code>.</p>
</li>
</ul>
<ul>
<li>
<p><code>sortDirection</code></p>
<p>Mot clé déterminant le sens du trie du résultat de la recherche.</p>
<p>Valeurs possibles : <code>ASC</code>, <code>DESC</code> ou <code>NULL</code>.</p>
</li>
</ul>
<ul>
<li>
<p><code>sortlimit</code></p>
<p>Entier determinant le nombre maximum d'objet pouvant être triés dans le résultat d'une
recherche.</p>
</li>
</ul>
<ul>
<li>
<p><code>displayFormat</code></p>
<p><a href="../../global/LSformat/#format-parametrable">LSformat</a> d'affichage du nom de l'objet dans le
résultat de la recherche.</p>
</li>
</ul>
<ul>
<li>
<p><code>nbObjectsByPage</code></p>
<p>Entier déterminant le nombre d'objet maximum affichés dans une page de résultat de la recherche.</p>
</li>
</ul>
<ul>
<li>
<p><code>nbObjectsByPageChoices</code></p>
<p>Tableau des choix proposés à l'utilisateur pour le nombre d'objets maximum affichés dans une
page de résultat de la recherche.</p>
</li>
</ul>
<ul>
<li>
<p><code>validPatternRegex</code></p>
<p>Expression régulière de validation des mots clés de recherche pour ce type
d'<a href="../#configuration-lsobject">LSobject</a>.</p>
<p>(Par défaut : <code>/^[\w\-_\\\'\"^[]\(\){}\=\+\£\%\$\€\.\:\;\,\?\/\@]+$/iu</code>)</p>
</li>
</ul>
</li>
</ul>
<ul>
<li>
<p><code>predefinedFilters</code></p>
<p>Tableau associatif contenant des filtres prédéfinis pour la recherche. Les clés sont les filtres
au format LDAP et les valeurs sont les labels associés.</p>
</li>
</ul>
<ul>
<li>
<p><code>extraDisplayedColumns</code></p>
<p>Tableau associatif contenant des colonnes supplémentaires à afficher dans les résultats de
recherche. Les clés sont les identifiants des colonnes supplémentaires et les valeurs sont leur
configuration définie à partir des paramètres suivant :</p>
<ul>
<li>
<p><code>label</code></p>
<p>Le label de la colonne.</p>
</li>
</ul>
<ul>
<li>
<p><code>LSformat</code></p>
<p>Le <a href="../../global/LSformat/#format-parametrable">LSformat</a> d'affichage de la colonne. Ce format
est composé à partir des attributs des objets LDAP dans leur format brut.</p>
</li>
</ul>
<ul>
<li>
<p><code>alternativeLSformats</code></p>
<p>Tableau des <a href="../../global/LSformat/#format-parametrable">LSformats</a> alternatifs à utiliser si le
résultat du format principal est vide. Les formats définis dans cette liste sont essayés les uns
après les autres et le premier <a href="../../global/LSformat/#format-parametrable">LSformat</a> retournant
une valeur non-vide est utilisé.</p>
</li>
</ul>
<ul>
<li>
<p><code>formaterLSformat</code></p>
<p><a href="../../global/LSformat/#format-parametrable">LSformat</a> optionnel permettant de mettre en forme le
résultat obtenu des <a href="../../global/LSformat/#format-parametrable">LSformats</a> précédents. Ce
<a href="../../global/LSformat/#format-parametrable">LSformat</a> ne sera utilisé que si le résultat obtenu
précédement n'est pas vide. Il est ainsi possible d'utiliser les paramètres <code>LSformat</code> et
<code>alternativeLSformats</code> afin de récupérer la valeur à afficher, puis de la mettre en forme grâce
à ce <a href="../../global/LSformat/#format-parametrable">LSformat</a>. Ce format est composé à partir des
attributs des objets LDAP dans leur format brut et de la valeur retournés précedement accessible
via la variable <code>val</code>.</p>
</li>
</ul>
<ul>
<li>
<p><code>formaterFunction</code></p>
<p>Le nom d'une fonction optionnelle à exécuter pour mettre en forme le résultat obtenu des
<a href="../../global/LSformat/#format-parametrable">LSformats</a> précédents. Cette fonction ne sera
appelée que si le résultat obtenu précédement n'est pas vide. La fonction prendra en paramètre
la valeur à mettre en forme et retournera la valeur mise en forme.</p>
</li>
</ul>
<ul>
<li>
<p><code>generateFunction</code></p>
<p>Le nom d'une fonction qui sera utilisée pour générer la valeur d'affichage de cette colonne. La
fonction prendra en paramètre une référence de l'objet <code>LSsearchEntry</code> et retournera la valeur
de la colonne.</p>
</li>
</ul>
<ul>
<li>
<p><code>additionalAttrs</code></p>
<p>Un tableau de nom d'attributs à inclure dans le resultat de la recherche LDAP. Ce tableau permet
notamment d'inclure les attributs nécessaires au bon fonctionnement de la fonction
<code>generateFunction</code>.</p>
</li>
</ul>
<ul>
<li>
<p><code>escape</code></p>
<p>Ce paramètre booléen permet de définir si, lors de l'affichage, le contenu de la colonne doit
être transformé pour protéger les caractères éligibles en entités HTML. Par défaut, ce paramètre
est <code>True</code>.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Cette fonctionnalité existe pour des raisons de sécurité et notamment en protection des
failles <code>XSS</code>. Si vous désactivez cette fonctionnalité, il est important de gérer la
problématique de sécurité par ailleurs.</p>
</div>
</li>
</ul>
<ul>
<li>
<p><code>cssStyle</code></p>
<p>Ce paramètre permet de définir un style CSS personnalisé pour la colonne. S'il est défini, le
contenu de ce paramètre sera ajouté en tant qu'attribut <code>style</code> des balises <code>th</code> et <code>td</code> de la
colone.</p>
</li>
</ul>
<ul>
<li>
<p><code>visibleTo</code></p>
<p>Ce paramètre permet de restreindre la visibilité de cette colonne aux seuls
<a href="../../global/ldap/LSprofile/#profils-dutilisateurs">LSprofiles</a> spécifiés. S'il est omis, la
colonne sera visible pour tous.</p>
</li>
</ul>
</li>
</ul>
<ul>
<li>
<p><code>customActions</code></p>
<p>Tableau associatif contenant les paramètres de configuration des
<a href="#customactions">customActions</a>. <a href="#customactions">Voir la section concernée</a>.</p>
</li>
</ul>
<ul>
<li>
<p><code>showSelectionBoxes</code></p>
<p>Booléen permettant de définir si les cases à cocher de sélections des objets doivent être
affichées. Lorsqu'elles sont affichées, l'utilisateur pourra sélectionner un ou plusieurs objets
dans la liste avant de déclencher une <a href="#customsactions">customAction</a>. Dans ce cas, les DNs de ces
objets seront passés à la page d'exécution de la <a href="#customsactions">customAction</a> via le paramètre
<code>selected</code>.</p>
</li>
</ul>
<h2 id="les-actions-personnalisees-customactions">Les actions personnalisées (customActions)</h2>
<p>Cette section décrit la manière de configurer les actions personnalisées exécutables sur les
recherches d'<a href="../#configuration-lsobject">LSobjects</a> appelées <a href="#customactions">customActions</a>.</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>$GLOBALS[&#39;LSobjects&#39;][&#39;[nom du type d&#39;LSobject]&#39;][&#39;LSsearch&#39;][&#39;customActions&#39;] = array (
<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a> &#39;action1&#39; =&gt; array(
<a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a> &#39;label&#39; =&gt; &#39;[label l&#39;action]&#39;,
<a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a> &#39;hideLabel&#39; =&gt; &#39;[booléen]&#39;,
<a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a> &#39;icon&#39; =&gt; &#39;[nom de l&#39;icône de l&#39;action]&#39;,
<a id="__codelineno-6-6" name="__codelineno-6-6" href="#__codelineno-6-6"></a> &#39;function&#39; =&gt; &#39;[fonction à exécuter]&#39;,
<a id="__codelineno-6-7" name="__codelineno-6-7" href="#__codelineno-6-7"></a> &#39;question_format&#39; =&gt; &#39;[LSformat de la question de confirmation]&#39;,
<a id="__codelineno-6-8" name="__codelineno-6-8" href="#__codelineno-6-8"></a> &#39;onSuccessMsgFormat&#39; =&gt; &#39;[LSformat du message à afficher en cas de succès de l&#39;action]&#39;,
<a id="__codelineno-6-9" name="__codelineno-6-9" href="#__codelineno-6-9"></a> &#39;disableOnSuccessMsg&#39; =&gt; &#39;[booléen]&#39;,
<a id="__codelineno-6-10" name="__codelineno-6-10" href="#__codelineno-6-10"></a> &#39;noConfirmation&#39; =&gt; &#39;[booléen]&#39;,
<a id="__codelineno-6-11" name="__codelineno-6-11" href="#__codelineno-6-11"></a> &#39;redirectToObjectList&#39; =&gt; &#39;[booléen]&#39;,
<a id="__codelineno-6-12" name="__codelineno-6-12" href="#__codelineno-6-12"></a> &#39;rights&#39; =&gt; array(
<a id="__codelineno-6-13" name="__codelineno-6-13" href="#__codelineno-6-13"></a> &#39;LSprofile1&#39;,
<a id="__codelineno-6-14" name="__codelineno-6-14" href="#__codelineno-6-14"></a> &#39;LSprofile2&#39;,
<a id="__codelineno-6-15" name="__codelineno-6-15" href="#__codelineno-6-15"></a> ...
<a id="__codelineno-6-16" name="__codelineno-6-16" href="#__codelineno-6-16"></a> )
<a id="__codelineno-6-17" name="__codelineno-6-17" href="#__codelineno-6-17"></a> )
<a id="__codelineno-6-18" name="__codelineno-6-18" href="#__codelineno-6-18"></a>);
</code></pre></div>
<ul>
<li>
<p><code>label</code></p>
<p>Le label de l'action.</p>
</li>
</ul>
<ul>
<li>
<p><code>hideLabel</code></p>
<p>Cache le label dans le bouton de l'action.</p>
</li>
</ul>
<ul>
<li>
<p><code>icon</code></p>
<p>Nom de l'îcone à afficher dans le bouton de l'action. Ce nom correspond au nom du fichier de
l'image (sans l'extention) qui devra se trouver dans le dossier
<code>/src/images/[nom du theme d'images]/</code> ou dans le dossier <code>src/local/images</code>.</p>
</li>
</ul>
<ul>
<li>
<p><code>function</code></p>
<p>Le nom de la fonction à exécuter qui implémente l'action personnalisée Cette fonction prendra en
seule paramètre l'objet <a href="#lssearch">LSsearch</a>. sur lequel l'action devra être exécutée et
retournera <code>True</code> en cas de succès ou <code>False</code> en cas d'échec d'exécution de la fonction.</p>
</li>
</ul>
<ul>
<li>
<p><code>question_format</code></p>
<p>Le <a href="../../global/LSformat/#format-parametrable">LSformat</a> de la question de confirmation
d'exécution de l'action. Ce <a href="../../global/LSformat/#format-parametrable">LSformat</a> sera composé à
l'aide du label de l'action.</p>
</li>
</ul>
<ul>
<li>
<p><code>onSuccessMsgFormat</code></p>
<p>Le <a href="../../global/LSformat/#format-parametrable">LSformat</a> du message à afficher en cas de succès
d'exécution de l'action. Ce <a href="../../global/LSformat/#format-parametrable">LSformat</a> sera composé à
l'aide du label de l'action.</p>
</li>
</ul>
<ul>
<li>
<p><code>disableOnSuccessMsg</code></p>
<p>Booléen permetant de désactiver le message afficher en cas de succès d'exécution de l'action.</p>
</li>
</ul>
<ul>
<li>
<p><code>noConfirmation</code></p>
<p>Booléen permetant de désactiver la confirmation de l'exécution de l'action.</p>
</li>
</ul>
<ul>
<li>
<p><code>redirectToObjectList</code></p>
<p>Booléen permetant de rediriger ou non l'utilisateur vers la liste des objets (Vrai par défaut).
Si l'utilisateur n'est redirigé, le template par défaut (ou celui défini durant l'éxécution de la
fonction) sera affiché.</p>
</li>
</ul>
<ul>
<li>
<p><code>rights</code></p>
<p>Tableau contenant la liste des noms des <a href="../../global/ldap/LSprofile/#profils-dutilisateurs">LSprofiles</a>
ayant le droit d'exécuter cette action.</p>
</li>
</ul>
<h3 id="ecriture-dune-fonction-implementant-une-customaction">Écriture d'une fonction implémentant une customAction</h3>
<p>Une fonction implémentant une <em>customAction</em> se déclare de la manière suivante :</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="x">/*</span>
<a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a><span class="x"> * Ma fonction implémentant ma customAction</span>
<a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a><span class="x"> *</span>
<a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a><span class="x"> * Paramètre :</span>
<a id="__codelineno-7-5" name="__codelineno-7-5" href="#__codelineno-7-5"></a><span class="x"> * - $search : L&#39;objet LSsearch de la recherche sur lequel mon action doit être exécutée</span>
<a id="__codelineno-7-6" name="__codelineno-7-6" href="#__codelineno-7-6"></a><span class="x"> *</span>
<a id="__codelineno-7-7" name="__codelineno-7-7" href="#__codelineno-7-7"></a><span class="x"> * Valeurs retournées :</span>
<a id="__codelineno-7-8" name="__codelineno-7-8" href="#__codelineno-7-8"></a><span class="x"> * - True : Tout s&#39;est bien passé</span>
<a id="__codelineno-7-9" name="__codelineno-7-9" href="#__codelineno-7-9"></a><span class="x"> * - False : Une erreur est survenue</span>
<a id="__codelineno-7-10" name="__codelineno-7-10" href="#__codelineno-7-10"></a><span class="x"> */</span>
<a id="__codelineno-7-11" name="__codelineno-7-11" href="#__codelineno-7-11"></a><span class="x">function maFonction ($search) {</span>
<a id="__codelineno-7-12" name="__codelineno-7-12" href="#__codelineno-7-12"></a>
<a id="__codelineno-7-13" name="__codelineno-7-13" href="#__codelineno-7-13"></a><span class="x"> // Actions</span>
<a id="__codelineno-7-14" name="__codelineno-7-14" href="#__codelineno-7-14"></a>
<a id="__codelineno-7-15" name="__codelineno-7-15" href="#__codelineno-7-15"></a><span class="x">}</span>
</code></pre></div>
<p>Cette fonction doit prendre pour seul paramètre, l'objet <a href="#lssearch">LSsearch</a>. sur lequel l'action
personnalisée doit être exécutée et doit retourner soit <code>True</code> si tout s'est bien passé, soit
<code>False</code> en cas de problème.</p>
<div class="admonition important">
<p class="admonition-title">Important</p>
<p>La recherche passée en paramètre n'a pas encore été exécutée. En conséquence, si vous avez
besoin d'accéder au résultat de la recherche, il est nécessaire d'exécuter au préalable :
<code>$search -&gt; run();</code>. Cela permet en outre, de modifier les paramètres de la recherche avant de
l'exécuter. Cela peut par exemple être utile, si vous avez besoin d'accèder aux valeurs
d'attributs particuliers, d'ajouter des attributs au résultat de la recherche :</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a><span class="x">$search -&gt; setParam(&#39;attributes&#39;,array(&#39;attr1&#39;,&#39;attr2&#39;));</span>
</code></pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Ces fonctions sont le plus couramment définies au sein
d'<a href="../../LSaddon/#configuration-des-lsaddons">LSaddon</a>.</p>
</div>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
<div class="md-copyright__highlight">
Easter-eggs
</div>
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../../..", "features": [], "search": "../../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copi\u00e9 dans le presse-papier", "clipboard.copy": "Copier dans le presse-papier", "search.result.more.one": "1 de plus sur cette page", "search.result.more.other": "# de plus sur cette page", "search.result.none": "Aucun document trouv\u00e9", "search.result.one": "1 document trouv\u00e9", "search.result.other": "# documents trouv\u00e9s", "search.result.placeholder": "Taper pour d\u00e9marrer la recherche", "search.result.term.missing": "Non trouv\u00e9", "select.version": "S\u00e9lectionner la version"}, "version": {"provider": "mike"}}</script>
<script src="../../../assets/javascripts/bundle.081f42fc.min.js"></script>
<script src="../../../js/print-site.js"></script>
</body>
</html>
Reference in a new issue View git blame Copy permalink