Previous Next

Zend_ProgressBar

Introduction

Zend_ProgressBar est un composant pour créer et mettre à jour les barres de progression dans différents environnements. Il consiste en un backend unique, qui affiche la progression au travers de l'un des multiples adaptateurs. A chaque mise à jour, il prend un chemin absolu et un message d'état, et appelle ensuite l'adaptateur avec certaines valeurs précalculées comme le pourcentage et le temps restant estimé.

Utilisation basique de Zend_Progressbar

Zend_ProgressBar est assez simple d'utilisation. Vous créez simplement une nouvelle instance de Zend_Progressbar, en définissant des valeurs minimum et maximum, et en choisissant un adaptateur pour afficher les données. Si vous voulez travailler avec un fichier, vous pouvez faire comme ceci :

$progressBar = new Zend_ProgressBar(0, $fileSize, $adapter);

while (!feof($fp)) {
    // Faire quelque chose

    $progressBar->update($currentByteCount);
}

$progressBar->finish();

Dans un premier temps, une instance de Zend_ProgressBar, avec une valeur minimum de 0, une valeur maximum correspondant à la taille totale du fichier et un adaptateur spécifique. Ensuite on travaille avec le fichier et à chaque boucle la barre de progression est mise à jour avec le nombre d'octets courant. A la fin de la boucle, le statut de la barre de progression est réglé à terminé.

Zend_ProgressBar possède aussi une méthode refresh() qui recalcule le temps restant estimé et met à jour l'adaptateur. Ceci est pratique quand il n'y a aucune donnée à mettre à jour mais que vous souhaitez que la barre de progression soit mise à jour.

Adaptateurs standard

Zend_ProgressBar est fourni avec les deux adaptateurs suivants :

Zend_ProgressBar_Adapter_Console

Zend_ProgressBar_Adapter_Console est un adaptateur de type texte pour les terminaux. Il peut automatiquement détecter la largeur du terminal mais supporte aussi des largeurs personnalisées. Vous pouvez définir quels éléments seront affichés avec la barre de progression et personnaliser leur ordre. Vous pouvez aussi définir le style de la barre de progression elle-même.

Note: Reconnaissance automatique de la largeur de la console

shell_exec est nécessaire pour que ceci fonctionne sur les systèmes de type *nix. Sur Windows, il y a toujours un terminal fixe de 80 caractères de large, donc la reconnaissance automatique n'est pas nécessaire.

Vous pouvez paramétrer les options de l'adaptateur soit via les méthodes set* soit en fournissant un tableau ("array") ou une instance Zend_Config en tant que premier paramètre du constructeur. Les options disponibles sont :

  • outputStream : un flux de sortie différent, si vous ne souhaitez pas utiliser STDOUT. Peut être n'importe quel autre flux come php://stderr ou un chemin vers un fichier.

  • width : soit un entier ou la constante AUTO de Zend_Console_ProgressBar.

  • elements : soit NULL par défaut ou un tableau avec au moins l'une des constantes de Zend_Console_ProgressBar suivantes comme valeur :

    • ELEMENT_PERCENT : la valeur courante en pourcentage.

    • ELEMENT_BAR : la barre qui va représenter le pourcentage.

    • ELEMENT_ETA : le calcul automatique du temps restant estimé (NDT. : "Estimated Time for Accomplishment"). Cet élément est affiché pour la première fois qu'après cinq secondes, car durant ce temps, il n'est pas possible de calculer des résultats précis.

    • ELEMENT_TEXT : un message de statut optionnel concernant le processus courant.

  • textWidth : largeur en caractères de l'élément ELEMENT_TEXT. Par défaut vaut 20.

  • charset : encodage de l'élément ELEMENT_TEXT. Par défaut vaut "utf-8".

  • barLeftChar : un caractère qui est utilisé du côté gauche de l'indicateur de la barre de progression.

  • barRightChar : un caractère qui est utilisé du côté droit de l'indicateur de la barre de progression.

  • barIndicatorChar : un caractère qui est utilisé pour l'indicateur de la barre de progression. Celui-ci peut être vide.

Zend_ProgressBar_Adapter_JsPush

Zend_ProgressBar_Adapter_JsPush est un adaptateur qui vous permet de mettre à jour une barre de progression dans un navigateur au travers de Javascript. Ceci veut dire qu'une seconde connexion n'est pas nécessaire pour recueillir le statut du processus courant, mais que le processus lui-même envoie son statut directement au navigateur.

Vous pouvez paramétrer les options de l'adaptateur soit avec les méthodes set* soit en fournissant un tableau ("array") ou une instance de Zend_Config contenant les options en tant que premier paramètre du constructeur. Les options disponibles sont :

  • updateMethodName : la méthode Javascript qui sera appelée à chaque mise à jour. La valeur par défaut est Zend_ProgressBar_Update.

  • finishMethodName : la méthode Javascript qui sera appelée lorsque le statut terminé sera atteint. La valeur par défaut est NULL, qui veut dire que rien n'est fait.

L'utilisation de cet adaptateur est assez simple. Premièrement vous créez une barre de progression pour le navigateur, soit avec Javascript ou auparavant en pur HTML. Ensuite vous définissez une méthode de mise à jour et optionnellement une méthode de finalisation en Javascript, les deux acceptant un objet JSON en tant qu'unique argument. Ensuite vous appelez une page Web avec un processus chronophage dans une balise iframe ou object masqué. Pendant que le processus tourne, l'adaptateur appelle la méthode de mise à jour à chaque mise à jour avec un objet JSON, contenant le paramètres suivants :

  • current : la valeur courante

  • max : la valeur maximum

  • percent : le pourcentage calculé

  • timeTaken : le temps depuis quand le processus courant est en marche

  • timeRemaining : le temps estimé pour que le processus se termine

  • text : le message de statut optionnel, si fourni

Example #1 Exemple basique du fonctionnement côté-client

Cet exemple illustre un paramétrage basique du HTML, CSS et JavaScript pour l'adaptateur JsPush :

#long-running-process {
    position: absolute;
    left: -100px;
    top: -100px;

    width: 1px;
    height: 1px;
}

#zend-progressbar-container {
    width: 100px;
    height: 30px;

    border: 1px solid #000000;
    background-color: #ffffff;
}

#zend-progressbar-done {
    width: 0;
    height: 30px;

    background-color: #000000;
}
function Zend_ProgressBar_Update(data)
{
    document.getElementById('zend-progressbar-done').style.width = data.percent + '%';
}

Ceci créera un simple conteneur avec une bordure noire et un bloc qui indique le niveau du processus courant. Vous ne devez pas masquer l'iframe ou l'object par display: none;, car dans ce cas les navigateurs comme Safari 2 ne chargeront pas le contenu réel.

Plutôt que de créer votre barre de progression personnalisée, vous pouvez utiliser une de celles disponibles dans les librairies JavaScript comme Dojo, jQuery etc. Par exemple, il existe :

  • Dojo : http://dojotoolkit.org/book/dojo-book-0-9/part-2-dijit/user-assistance-and-feedback/progress-bar

  • jQuery : http://t.wits.sg/2008/06/20/jquery-progress-bar-11/

  • MooTools : http://davidwalsh.name/dw-content/progress-bar.php

  • Prototype : http://livepipe.net/control/progressbar

Note: Intervalle de mise à jour

Vous devez faire attention à ne pas envoyer trop de mises à jour, puisque chaque mise à jour a une taille minimum de 1ko. Ceci est requis par le navigateur Safari pour rendre et exécuter l'appel de fonction. Internet Explorer possède une limitation similaire mais à 256 octets.

Zend_ProgressBar_Adapter_JsPull

Zend_ProgressBar_Adapter_JsPull est l'opposé de jsPush, car il requiert de venir récupérer les nouvelles mises à jour, plutôt que d'envoyer les mises à jour vers le navigateur. Généralement, vous devriez utiliser l'adaptateur avec l'option de persistance de Zend_ProgressBar. Lors de l'appel, l'adaptateur envoie une chaîne JSON vers le navigateur, qui est comparable à la chaîne JSON envoyée par l'adaptateur jsPush. La seule différence est qu'il contient un paramètre supplémentaire "finished", qui vaut false quand update() est appelée ou true quand finish() est appelée.

Vous pouvez paramétrer les options de l'adaptateur soit avec les méthodes set* soit en fournissant un tableau ("array") ou une instance de Zend_Config contenant les options en tant que premier paramètre du constructeur. Les options disponibles sont :

  • exitAfterSend : sort de la requête courante après que les données aient été envoyées au navigateur. Vaut true par défaut.

Previous Next
Introduction to Zend Framework
Présentation
Installation
Zend_Acl
Introduction
Affiner les Contrôles d'Accès
Utilisation avancée
Zend_Amf
Introduction
Zend_Amf_Server
Zend_Application
Introduction
Zend_Application Quick Start
Théorie générale
Exemples
Core Functionality
Available Resource Plugins
Zend_Auth
Introduction
Authentification avec une table de base de données
Authentification "Digest"
Adaptateur d'authentification HTTP
LDAP Authentication
Authentification OpenID
Zend_Cache
Introduction
Aspect théorique
Les frontends Zend_Cache
Les backends Zend_Cache
Zend_Captcha
Introduction
Opération Captcha
Adaptateurs CAPTCHA
Zend_CodeGenerator
Introduction
Exemples Zend_CodeGenerator
Zend_CodeGenerator Réference
Zend_Config
Introduction
Aspect théorique
Zend_Config_Ini
Zend_Config_Xml
Zend_Config_Writer
Zend_Config_Writer
Zend_Console_Getopt
Introduction
Déclarer les règles Getopt
Extraire les options et les arguments
Configurer Zend_Console_Getopt
Zend_Controller
Zend_Controller - Démarrage rapide
Fondations de Zend_Controller
Le contrôleur frontal (Front Controller)
L'objet Requête
Routeur Standard
Le distributeur
Contrôleurs d'action
Aides d'action (Helper)
Objet de réponse
Plugins
Utilisation de conventions de dossiers modulaires
Exceptions avec MVC
Migrer depuis des versions précédentes
Zend_Currency
Introduction à Zend_Currency
How to Work with Currencies
Migrer depuis des versions antérieures
Zend_Date
Introduction
Aspect théorique
Méthodes de base
Zend_Date API Overview
Créer des dates
Constants for General Date Functions
Exemples concrets
Zend_Db
Zend_Db_Adapter
Zend_Db_Statement
Zend_Db_Profiler
Zend_Db_Select
Zend_Db_Table
Zend_Db_Table_Row
Zend_Db_Table_Rowset
Relations Zend_Db_Table
Zend_Debug
Afficher des informations
Zend_Dojo
Introduction
Zend_Dojo_Data: dojo.data Envelopes
Les aides de vues Dojo
Les éléments de formulaire et les décorateurs Dojo
Zend_Dom
Introduction
Zend_Dom_Query
Zend_Exception
Utiliser les exceptions
Zend_Feed
Introduction
Importer des flux
Obtenir des flux à partir de pages Web
Consommer un flux RSS
Consommer un flux Atom
Consommer une entrée Atom particulière
Modifier la structure du flux ou des entrées
Classes personnalisées pour les flux et entrées
Zend_File
Zend_File_Transfer
Validateurs pour Zend_File_Transfer
Filtres pour Zend_File_Transfer
Migrer à partir des versions précédentes
Zend_Filter
Introduction
Classes de filtre standards
Chaînes de filtrage
Écriture de filtres
Zend_Filter_Input
Zend_Filter_Inflector
Zend_Form
Zend_Form
Zend_Form démarrage rapide
Creating Form Elements Using Zend_Form_Element
Creating Forms Using Zend_Form
Créer un visuel personnalisé en utilisant Zend_Form_Decorator
Standard Form Elements Shipped With Zend Framework
Décorateurs standards fournis avec Zend Framework
Internationaliser un formulaire Zend_Form
Advanced Zend_Form Usage
Zend_Gdata
Introduction
Authentification par procédé AuthSub
Using the Book Search Data API
Authentification avec ClientLogin
Using Google Calendar
Using Google Documents List Data API
Using Google Health
Using Google Spreadsheets
Using Google Apps Provisioning
Using Google Base
Utilisation des albums Web Picasa
Using the YouTube Data API
Attraper les exceptions Gdata
Zend_Http
Introduction
Zend_Http_Client - Utilisation avancée
Zend_Http_Client - Adaptateurs de connexion
Zend_Http_Cookie and Zend_Http_CookieJar
Zend_Http_Response
Zend_InfoCard
Introduction
Zend_Json
Introduction
Utilisation de base
Utilisation avancée de Zend_Json
XML to JSON conversion
Zend_Json_Server - JSON-RPC server
Zend_Layout
Introduction
Zend_Layout - Démarrage rapide
Zend_Layout options de configuration
Zend_Layout, utilisation avancée
Zend_Ldap
Introduction
Zend_Loader
Charger les fichiers et les classes dynamiquement
L'autoloader
Autoloaders de ressources
Chargeur de Plugins
Zend_Locale
Introduction
Using Zend_Locale
Normalization and Localization
Working with Dates and Times
Supported locales
Migrer à partir des versions précédentes
Zend_Log
Présentation
Rédacteurs (Writers)
Formateurs (mise en forme)
Filtres
Zend_Mail
Introduction
Envoyer des émail en utilisant SMTP
Envoyer plusieurs émail par connexion SMTP
Utiliser différents transports
Émail HTML
Fichiers joints
Ajouter des destinataires
Contrôler les limites MIME
En-têtes additionnels
Jeux de caractères
Encodage
Authentification SMTP
Sécuriser les transports SMTP
Lire des émail
Zend_Measure
Introduction
Création d'une mesure
Récupérer des mesures
Manipuler des mesures
Types de mesures
Zend_Memory
Présentation
Manager de mémoire
Objet mémoire
Zend_Mime
Zend_Mime
Zend_Mime_Message
Zend_Mime_Part
Zend_Navigation
Introduction
Pages
Containers
Zend_OpenId
Introduction
Zend_OpenId_Consumer Basics
Zend_OpenId_Provider
Zend_Paginator
Introduction
Utilisation
Configuration
Utilisation avancée
Zend_Pdf
Introduction
Créer et charger des documents PDF
Sauvegarder les changement dans un document PDF
Les pages d'un document
Dessiner
Informations du document et métadonnées
Exemple d'utilisation du module Zend_Pdf
Zend_ProgressBar
Zend_ProgressBar
Zend_Reflection
Introduction
Zend_Reflection Exemples
Réference de Zend_Reflection
Zend_Registry
Utiliser le registre
Zend_Rest
Introduction
Zend_Rest_Client
Zend_Rest_Server
Zend_Search_Lucene
Vue d'ensemble
Créer des index
Searching an Index
Query Language
Query Construction API
Jeu de caractères
Extensibility
Agir avec Lucene Java
Avancé
Bonnes pratiques
Zend_Server
Introduction
Zend_Server_Reflection
Zend_Service
Introduction
Zend_Service_Akismet
Zend_Service_Amazon
Zend_Service_Amazon_Ec2
Zend_Service_Amazon_Ec2: Instances
Zend_Service_Amazon_Ec2: Windows Instances
Zend_Service_Amazon_Ec2: Reserved Instances
Zend_Service_Amazon_Ec2: CloudWatch Monitoring
Zend_Service_Amazon_Ec2: Amazon Machine Images (AMI)
Zend_Service_Amazon_Ec2: Elastic Block Stroage (EBS)
Zend_Service_Amazon_Ec2: Elastic IP Addresses
Zend_Service_Amazon_Ec2: Keypairs
Zend_Service_Amazon_Ec2: Regions and Availability Zones
Zend_Service_Amazon_Ec2: Security Groups
Zend_Service_Amazon_S3
Zend_Service_Audioscrobbler
Zend_Service_Delicious
Zend_Service_Flickr
Zend_Service_Nirvanix
Zend_Service_ReCaptcha
Zend_Service_Simpy
Introduction
Zend_Service_StrikeIron
Zend_Service_StrikeIron: Bundled Services
Zend_Service_StrikeIron: Advanced Uses
Zend_Service_Technorati
Zend_Service_Twitter
Zend_Service_Yahoo
Zend_Session
Introduction
Usage basique
Utilisation avancée
Gestion générale de la session
Zend_Session_SaveHandler_DbTable
Zend_Soap
Zend_Soap_Server
Zend_Soap_Client
WSDL
Auto découverte
Zend_Tag
Introduction
Zend_Tag_Cloud
Zend_Test
Introduction
Zend_Test_PHPUnit
Zend_Text
Zend_Text_Figlet
Zend_Text_Table
Zend_TimeSync
Introduction
Utiliser Zend_TimeSync
Zend_Tool_Framework
Introduction
Using the CLI Tool
Architecture
Creating Providers to use with Zend_Tool_Framework
Shipped System Providers
Zend_Tool_Project
Zend_Tool_Project Introduction
Create A Project
Zend Tool Project Providers
Zend_Translate
Introduction
Adaptateurs pour Zend_Translate
Utiliser les adaptateurs de traduction
Migrer à partir des versions précédentes
Zend_Uri
Zend_Uri
Zend_Validate
Introduction
Classes de validation standard
Chaînes de validation
Écrire des validateurs
Validation Messages
Zend_Version
Lire la version de Zend Framework
Zend_View
Introduction
Scripts de contrôleur
Scripts de vue
Aides de vue
Zend_View_Abstract
Migration depuis les versions précédentes
Zend_Wildfire
Zend_Wildfire
Zend_XmlRpc
Introduction
Zend_XmlRpc_Client
Zend_XmlRpc_Server
Configuration système requise par Zend Framework
Introduction
Convention de codage PHP de Zend Framework
Vue d'ensemble
Formatage des fichiers PHP
Conventions de nommage
Style de codage
Zend Framework Performance Guide
Introduction
Chargement des classes
Zend_Db Performance
Internationalisation (i18n) and Localisation (l10n)
View Rendering
Informations de copyright