Les API EditGrid pour vos tableurs en ligne

IV. Pour une meilleure compréhension… Les entités▲

… Mais nous n'allons pas commencer tout de suite :-) ! Car auparavant, il nous faut bien comprendre ce que nous allons faire, et notamment les types d'éléments que nous allons rencontrer. Si vous avez déjà fait un peu de VBA, vous n'aurez sans doute pas de difficultés à comprendre. Mais même dans le cas contraire, rassurez-vous, ce n'est pas très compliqué.

IV-A. WorkSpace▲

La première chose à connaître, c'est votre espace de travail. En effet, vos documents sont regroupés et rattachés à votre compte par ce moyen. Imaginez cela comme votre bureau, sur lequel vous mettriez exclusivement des classeurs Excel.

Cet espace de travail, c'est le « WorkSpace » (logique !). Il possède une structure bien précise, que vous serez amené à comprendre un peu plus tard.

Pour le connaître, rien de plus simple : c'est « /user/ » suivi de votre login. Dans mon cas, par exemple, c'est « /user/Halleck ».

Nom	Type	Modif.
id	string		Identifiant du workspace
path	string		Chemin complet du workspace
name	string	x	Nom du workspace
organisation	string		The full path of the belonging organisation.
organisationId	string		The id of the belonging organisation.
defaultBookPermission	string	x	Permission par défaut pour les workbook de ce workspace: {private/read/read-write}.
defaultListPublic	string	x	Paramètres par défaut d'affichage public des classeurs pour le workspace : {0/1}.

IV-B. WorkBook▲

le WorkBook, c'est tout simplement un document Excel. Il correspond au fichier .xls que vous êtes habitué à manipuler, et contient des feuilles, des cellules…

Structure de l'entité WorkBook.

Nom	Type	Modif.	Req.
id	string		x	Identifiant du workbook
path	string			Chemin complet du workbook
name	string	x	x	Nom du workbook
currRevId	string			« Identifiant révisé » du workbook"
workspaceId	string			Identifiant du workspace
workspace	string			Chemin complet du workspace
organisationId	string			The id of the owner organisation.
organisation	string			The full path of the owner organisation.
publicAccess	string	x		Droit d'accès du public
isTemplate	int	x	x	1 ou 0. Indique si le workbook est un template ou non
isDeleted	int			1 ou 0. Indique si le workbook est supprimé ou non
timeZone	string	x	x	Zone horaire du workbook
note	string	x	x	Note du workbook
createUserId	string		x	Identifiant de l'utilisateur qui a créé le workbook
createUser	string			Chemin complet de l'utilisateur qui a créé le workbook
createTime	string		x	Date de création du workbook
lastModifiedUserId	string		x	Identifiant de l'utilisateur qui a modifié le workbook en dernier
lastModifiedUser	string			Chemin complet de l'utilisateur qui a modifié le workbook en dernier
lastModifiedTime	string		x	Dernière date de modification du workbook
accessToken	string			Jeton d'authentification pour ce workbook

IV-C. WorkSheet▲

Comme son nom l'indique, le WorkSheet est la feuille de votre workbook. Si vous ne voyez pas de quoi il s'agit, et bien il s'agit simplement des pages au sein desquelles vous naviguez en cliquant sur les onglets en bas à gauche.

Structure de l'entité WorkSheet.

Nom	Type	Modif.
id	string		Identifiant de la feuille
path	string		Chemin complet de la feuille
name	string	x	Nom de la feuille
index	int		Index de la feuille
workbookId	string		Identifiant du workbook parent (conteneur)
workbook	string		Chemin complet du workbook parent (conteneur)

IV-D. Cell▲

Une grille contient des cellules ; elles sont désignées ici par « cell ».

Structure de l'entité Cell.

Nom	Type	Modif.
sheet	string		Nom de la feuille parente (conteneur)
col	int		Index de la colonne
row	int		Index de la ligne
input	int	x	Valeur saisie par l'utilisateur
display	string		Valeur affichée
value	string		Valeur sans formatage de texte

IV-E. Ouf !▲

Il y en a d'autres bien sûr, mais nous n'aurons pas besoin d'en savoir plus dans notre exemple.

Pour plus d'informations, voici la liste complète :

IV-F. Configuration▲

Nous allons regrouper toute notre configuration dans un tableau, d'où les lignes suivantes au début de notre fichier index.php, lignes qui pourraient être placées dans un fichier de configuration par exemple :

Sélectionnez

//
// configuration EditGrid
//
$config = array (
'appKey'               =>    '[votre appKey]',
'user'            =>    'user/[votre pseudo]',
'sessionKey'           =>    '[votre sessionKey]',
'authToken'        =>    '[votre token]',
'name'            =>    '[le nom de l application]',
'workspace'        =>    '/user/[votre pseudo]',
);
);

Copyright © 2009 Jean-François Lépine. Aucune reproduction, même partielle, ne peut être faite de ce site ni de l'ensemble de son contenu : textes, documents, images, etc. sans l'autorisation expresse de l'auteur. Sinon vous encourez selon la loi jusqu'à trois ans de prison et jusqu'à 300 000 € de dommages et intérêts.