1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
| //mrParcour.class.php
/**
* Description de mrParcour
*
* Cette classe est destinée à faciliter le parcours d'une table dans tous les
* besoins d'accès possibles.
*
* Il est possible de définir :
* - des filtres temporaires et permanents.
* - trois select pour :
* - le parcours (parcourir les enregistrements sélectionnés, premier, dernier
* précédant, suivant, nombre d'enregistrement, position de l'enregistrement
* courant)
* - la liste (récupération d'une liste pour l'affichage d'un tableau de
* sélection d'un enregistrement)
* - le détail (récupération des informations nécessaires à l'édition d'un
* enregistrement
* - les options de tris
* - l'enregistrement courant
*
* Les données sont stockées pour partie dans la gestion de la session (filtre,
* tris). Les données permettant le parcours sont stockées dans le cache pour
* accélérer l'accès
*
* @author Michel Rotta pour Diag
*/
abstract class mrParcour implements ArrayAccess, Serializable
{
/**
* @var array()
* Tableau des Id pour le parcour
* non serializé
*/
private $listeParcour = null;
/**
* offset du parcour (enregistrement courant)
* @var integer
*/
private $offSetActu = null;
/**
* Id de l'enregistrement actuel, null si non défini
* @var integer
*/
private $CurrentId = null;
// ********** Gestion des données du filtre
/**
* @var sfFilter
* objet filtre (non serializé)
*/
private $filtre_object = null;
/**
* le nom du filtre. non attribué = null
* @var string
*/
private $filtre_nom = null;
/**
* @var string
* le query du filtre (ou le querry généré par l'objet filtre
* non attribué = null
*/
private $filtre_query = null;
/**
* Les objets ayant permis au filtre de générer le query
* non attribué = null
* @var array
*/
private $filtre_data = null;
/**
* Le query obligatoire pour tous les filtres (en plus du query généré)
* non attribué = null
* @var string
*/
private $filtre_master_query = null;
/**
* le champ pour le tris
* @var string
*/
private $filtre_tris_champ = null;
/**
* l'ordre de tris
* @var string
*/
private $filtre_tris_ordre = null;
/**
* @var Doctrine_Query
* l'objet de base pour le query permettant de peupler la liste. Positionne le
* from et le select. Ne doit retourner qu'un champ clef. Il est possible de
* prépositioner des conditions et des tris (le tris ont de forte chance d'être
* remplacés.
*/
private $query_liste_base = null;
private $test = "aie";
public function __construct()
{
echo 'construc object<br />';
$this->configure();
}
/** configure
* méthode appelée à l'initialisation de l'objet pour configurer son comportement
*/
abstract public function configure();
/**
* Renseigne le query a utiliser pour récupérer les données nécessaire à la
* construction de la liste de parcour.
* @param Doctrine_Query $q Objet de départ pour la création du query.
* Générallement avec un select et un form.
* Il ne doit sélectioner qu'un champs.
* @return object This object
*/
public function setNameQueryListeBase( Doctrine_Query $q )
{
$this->query_liste_base = $q;
echo('initialisé');
$this->test = $this->query_liste_base->getDql();
var_dump( $this->test );
return $this;
}
/* * *********************************************************************
* * Méthodes pour l'accès au parcour
*/
/** findCurentId
* @return mixed Retourne l'Id de l'enregistrement courant
* null si l'enregistrement courant n'est pas défini
*/
public function findCurrentId()
{
return $this->CurrentId;
}
/** findPrecedId
* Retourne l'Id de l'enregistrement précédant l'enregistrement courant.
* Retourne null si l'enregistrement courant ne fait pas partie du scop de
* parcour ou qu ele scop n'est pas défini
* Retourne null si l'enregistrement courrant est le premier du scop
* @return mixed l'Id de l'enregistrement précédant ou null
*/
public function findPrecedId()
{
if ( $this->CurrentId or !$this->offSetActu or 0 == $this->offSetActu )
{
return null;
}
return $this[ $this->offSetActu - 1 ];
}
/** findSuivId
* Retourne l'Id de l'enregistrement suivant l'enregistrement courant.
* Retourne null si l'enregistrement courant ne fait pas partie du scop de
* parcour ou que le scop n'est pas défini.
* Retourne null si l'enregistrement courant est le dernier du scop
* @return mixed l'Id de l'enregistrement suivant ou null
*/
public function findSuivId()
{
if ( !$this->CurrentId or !$this->offSetActu or $this->offsetLast() == $this->offSetActu )
{
return null;
}
return $this[ $this->offSetActu + 1 ];
}
/** findPremsId
* Retourne l'Id du premier enregistrement dans le scop
* Retourne null si le scop n'est pas défini
*/
public function findPremsId()
{
return ($this->offSetActu) ? $this[ 0 ] : null;
}
/** findDerId
* Returne l'Id du dernier enregistrement dans le scop
* Retourne null si le scop n'est aps défini
*/
public function findDerId()
{
return ($this->offSetActu) ? $this[ $this->offsetLast() ] : null;
}
/** offsetLast
* Retourne l'Id du dernier enregistrement du scop.
* Retourne null si le scop n'est pas défini
*/
public function offsetLast()
{
return (end( $this->listeParcour )) ? key( $this->listeParcour ) : null;
}
/** initParcour
* @return void
*
* Initialise la liste des parcour si elle n'existe pas elle est créé et les
* données de positionnnement sont initialisées.
*/
public function initParcour()
{
if ( !is_null( $this->listeParcour ) ) return;
echo ('<br />test: ' . $this->test);
var_dump( $this->query_liste_base );
return $this;
$q = new Doctrine_Query();
// Initialisation de la liste
$q->parseDqlQuery( $this->query_liste_base->getDql() );
if ( $this->filtre_master_query )
$q->andWhere( $this->filtre_master_query );
if ( $this->filtre_query ) $q->andWhere( $this->filtre_query );
if ( $this->filtre_tris_champ ) $q->orderBy( $this->getFiltreTris() );
$this->listeParcour = $q->execute( array( ), Doctrine_Core::HYDRATE_SINGLE_SCALAR );
// Vérifie que l'offset en mémoire correspond bien à l'offset de la liste
// si non réattribue l'offset. Idem si l'offset n'est pas défini.
if (
is_null( $this->offSetActu ) or
!($this->listeParcour[ $this->offSetActu ] == $this->CurrentId)
)
{
if ( !($this->offSetActu = array_search( $this->CurrentId, $this->listeParcour )) )
{
$this->offSetActu = null;
}
}
}
/* * **********************************************************************
* * Méthodes pour la gestion des filtres et tris
*/
/** setFiltreQuery
* Permet d'indiquer la chaine de filtre à utiliser
* @param string $query_string Chaine de query a utiliser, null si le query
* doit être réinitialisé
* @return object Cet objet
*/
public function setFiltreQuery( $query_string )
{
if ( $query_string )
{
$this->filtre_query = ( string ) $query_string;
}
else
{
$this->filtre_query = null;
$this->filtre_data = null;
}
$this->listeParcour = null;
return $this;
}
/** getFiltreQuery
* Récupération de la chaine de filtre à utiliser
* @return string/mixed La chaine ou null si non initialisé
*/
public function getFiltreQuery()
{
return $this->filtre_query;
}
/** setFiltreMasterQuery
* Permet de positionner le filtre principal de tris
* @param string $query_string Chaine de query a utiliser en priorité, nul si
* pour annuler le query master
* @return object Cet objet
*/
public function setFiltreMasterQuery( $query_string )
{
if ( $query_string )
{
$this->filtre_master_query = ( string ) $query_string;
}
else
{
$this->filtre_master_query = null;
}
$this->listeParcour = null;
return $this;
}
/** getFiltreMasterQuery
* Récupère la chaîne de filtre principale
* @return string le query principal ou null
*/
public function getFiltreMasterQuery()
{
return $this->filtre_master_query;
}
/** setFiltreObjectNom
* Permet d'indiquer le nom du filtre a utiliser pour générer le query a partir
* des objets.
* @param string $filtre_nom Nom du filtre
* @return object Cet objet
*/
public function setFiltreObjectNom( $filtre_nom )
{
$this->filtre_nom = ( string ) $filtre_nom;
$this->filtre_query = null;
return $this;
}
/** getFiltreObjectNom
* Retourne le nom défini pour l'objet filtre a utiliser pour calculer la
* chaine de query
* @return string Le nom ou null
*/
public function getFiltreObjectNom()
{
return $this->filtre_nom;
}
/** setFiltreData
* Permet de sauvegarder les données du filtre (généralement retournées par
* le formulaire filtre), de les testées, de les sauvegarder sous la forme
* d'une chaine avec un setFiltreQuery.
* @param array $filtre_data Un tableau des paramètres de filtre
* @return boolean Retourne vrai si les paramètres données ont pu retourner
* un filtre valide. Faux si non.
*/
public function setFiltreData( $filtre_data )
{
$filtre = $this->getFiltreObject();
$filtre->bind( $filtre_data );
if ( $filtre->isValid() )
{
$this->setFiltreQuery( $filtre->getQuery() );
return true;
}
return FALSE;
}
/** makeQueryFromQuery
* Rajoute à un objet query les deux query partiel et master ainsi que
* la chaine de tris définie
* @param Doctrine_Query $q Le query a compléter
* @param array $options_tris Les options pour l'ordre de tris
* - champ : le nom du champs si le tris n'est pas défini
* - ordre : l'ordre de tris si non défini (ASC par défaut)
* - prioritaire : si vrai, les deux options primes sur ce qui est défini
* @return Doctrine_Query L'objet query complété
*/
public function makeQueryFromQuery( Doctrine_Query $q )
{
if ( $this->getFiltreMasterQuery() )
{
$q->andWhere( $this->getFiltreMasterQuery() );
}
if ( $this->getFiltreQuery() )
{
$q->andWhere( $this->getFiltreQuery() );
}
$q->orderBy( '' );
return $q;
}
/** getFiltreObject
* Récupère l'object filtre courant
* @return object L'object filtre
*/
public function getFiltreObject()
{
if ( !$this->filtre_object )
{
$filtreNom = $this->filtre_nom;
$this->filtre_object = new $filtreNom;
}
return $this->filtre_object;
}
/** setFiltreTris
* Positione les valeurs pour le tris. Si nul annule les données pour le tris.
* @param string $champ nom du champ pour le tris ou null pour annuler
* @param string $ordre ASC (défaut) ou DESC, null si le champ est null
* @return object Cet objet
*/
public function setFiltreTris( $champ = null, $ordre = 'ASC' )
{
if ( !$this->filtre_tris_champ = $champ )
{
$this->filtre_tris_ordre = NULL;
}
else
{
$this->filtre_tris_ordre = mrParcour::valideTrisOrdre( $ordre );
}
}
/** valideTrisOrdre
* Valide l'ordre de tris demandé.
* @param string $ordre Ordre de tris demandé
* @return string Ordre de tris retenu
*/
static function valideTrisOrdre( $ordre )
{
return (in_array( $ordre, array( 'ASC', 'DESC' ) )) ?
$ordre :
'ASC';
}
/** getFiltreTris
* Retourne la chaine de tris a prendre en compte
* @param array Voir makeQueryFromQuery pour les options
* @return string La chaine de tris ou une chaine vide
*/
public function getFiltreTris( $options_tris )
{
if ( $tris = $this->getFiltreTrisData( $options_tris ) )
{
return '';
}
return $tris[ 'champ' ] . ' ' . $tris[ 'ordre' ];
}
/** getFiltreTrisData
* Returne le tableau d'option de tris à prendre en compte
* @param array Voir makeQueryFromQuery pour les options
* @return array Le tableau effectif de tris à utiliser, null si pas de tris
* définis
*/
public function getFiltreTrisData( $options_tris )
{
$tris = array( );
$tris[ 'champ' ] = $this->filtre_tris_champ;
$tris[ 'ordre' ] = $this->filtre_tris_ordre;
if ( $options_tris[ 'prioritaire' ] == true or !$tris[ 'champ' ] )
{
$tris[ 'champ' ] = $options_tris[ 'champ' ];
$tris[ 'ordre' ] = $options_tris[ 'ordre' ];
}
if ( $tris[ 'champ' ] )
{
return NULL;
}
$tris[ 'ordre' ] = mrParcour::valideTrisOrdre( $tris[ 'ordre' ] );
return $tris;
}
/* * *********************************************************************
* * Méthode pour l'interface Serializable
*/
public function serialize()
{
return serialize( array(
$this->offSetActu,
$this->CurrentId,
$this->filtre_query,
$this->filtre_data,
$this->filtre_master_query,
$this->filtre_tris_champ,
$this->filtre_tris_ordre
) );
}
public function unserialize( $serialized )
{
list (
$this->offSetActu,
$this->CurrentId,
$this->filtre_query,
$this->filtre_data,
$this->filtre_master_query,
$this->filtre_tris_champ,
$this->filtre_tris_ordre
)
= $serialized;
}
/* * *********************************************************************
* * Méthodes pour l'interface ArrayAccess
*/
/* offsetExists
* @param mixed $offset Le numéro d'offset de l'enregistrement recherché
* @return boolean Vrais si le numéro existe
*/
public function offsetExists( $offset )
{
return isset( $this->listeParcour[ $offset ] );
}
/* offsetGet
* @param mixed $offset Le numéro d'offset de l'enregistrement dont on veut
* récupérer l'Id
* @return integer Le numéro d'Id
*/
public function offsetGet( $offset )
{
return $this->offsetExists( $offset ) ? $this->listeParcour( $offset ) : null;
}
/* offsetSet
* Impossible de définir un élément, la fonction ne traite pas la demande et
* retourne toujours null
* @param mixed $offset Le numéro d'offset à modifier
* @param mixed $value La valeur à implémenter
* @return null Retourne toujours la valeur null
*/
public function offsetSet( $offset, $value )
{
return null;
}
/* offsetUnset
* Impossible de supprimer un élémnet du tableau, la fonction ne traite pas la
* demande et retourne toujours null
* @param mixed $offSet Le numéro d'offset à supprimer
* @return null Retourne toujours la valeur null
*/
public function offsetUnset( $offset )
{
return null;
}
} |
Partager