API des organigrammes : Différence entre versions

De OviWiki
Aller à : navigation, rechercher
Ligne 6 : Ligne 6 :
  
 
== bab_OCGetChildsEntities($idroot='', $idoc='') ==
 
== bab_OCGetChildsEntities($idroot='', $idoc='') ==
 +
 +
liste des entités d'un organigramme, le idroot est optionnel, si non renseigné, c'est la racine de l'organigramme principal
 +
tout les sous noeuds sont listés dans tout les sous niveaux
  
 
== bab_OCGetCollaborators($identity) ==
 
== bab_OCGetCollaborators($identity) ==
Ligne 98 : Ligne 101 :
  
 
The result set is ordered by role types (in order 1,2,3,0) and by user name (according to ovidentia name ordering rules).
 
The result set is ordered by role types (in order 1,2,3,0) and by user name (according to ovidentia name ordering rules).
 +
 +
 +
 +
 +
== class bab_OrgChartUtil ==
 +
 +
=== __construct($iIdOrgChart, $iIdSessUser = null) ===
 +
 +
=== haveAdminRight() ===
 +
 +
=== isAccessValid() ===
 +
 +
=== create($sName, $sDescription, $iIdDelegation, $iIdDirectory) ===
 +
 +
A transformer en static ??? a supprimer ???
 +
 +
 +
=== getRoot() ===
 +
 +
Returns information about a specified organizational chart.
 +
The current user must have "view" or "update" access to the organizational chart.
 +
The returned array has the following keys :
 +
 +
* id
 +
* name
 +
* description
 +
* edit
 +
* edit_author
 +
* edit_date
 +
* id_dgowner
 +
* id_directory
 +
* type
 +
* id_first_node
 +
* id_closed_nodes

Version du 19 septembre 2012 à 09:56

ocapi.php

bab_OCGetChildCount($iIdEntity)

bab_OCGetChildNodeByPosition($iIdParentEntity, $iPosition)

bab_OCGetChildsEntities($idroot=, $idoc=)

liste des entités d'un organigramme, le idroot est optionnel, si non renseigné, c'est la racine de l'organigramme principal tout les sous noeuds sont listés dans tout les sous niveaux

bab_OCGetCollaborators($identity)

liste des collaborateurs d'une entité

array(
   array(id_user, lastname, firstname, middlename)
)

bab_OCGetEntities($idoc = )

bab_OCGetEntity($ide)

bab_OCGetEntityTypes($entityId)

Returns an ordered mysql result set containing the entity types for the specified entity.


bab_OCGetLastChild($iIdEntity)

Returns the id of the specified entity's last child.

bab_OCGetOrgChartEntityTypes($idoc)

Returns an ordered mysql result set containing the entity types avaiblable for the specified orgchart.

bab_OCgetPrimaryOcId()

Retourne l'ID de l'organigramme principale l'info est stockée dans $babBody->idprimaryoc mais il ne faut pas utiliser cette propriété


bab_OCGetRootEntity($idoc=)

Entité racine d'un organigramme

array(id, name, description);


bab_OCGetSuperior($identity)

Le supérieur de l'entité

array(id_user, lastname, firstname, middlename);


bab_OCGetSuperiors($idoc=)

liste des supérieurs de toutes les entités de l'organigramme

bab_OCGetTemporaryEmployee($identity)

search for a temporary employee in the entity used for approbation


bab_OCGetTemporaryEmployees($idoc=)

les intérimaires de l'organigramme


bab_OCGetUserEntities($iduser, $idoc=)

Liste des entités d'un utilisateur dans un organigramme particulier ou dans l'organigramme principale


bab_OCIsEntityChildOfRoot($iIdEntity)

Checks whether the entity $iIdEntity is a child of the root entity.


bab_OCIsEntityParentOf($iIdParentEntity, $iIdEntity)

bab_OCSelectEntityCollaborators($entityId)

Returns an ordered mysql result set containing the members of the entity $entityId.

Results fetched from the result set have the following structure:

array(
		'id_dir_entry' => directory entry id (@see bab_getDirEntry)
		'role_type' =>  1 = Superior, 2 = Temporary employee, 3 = Members, 0 = Other collaborators
		'role_name' => The role title
		'user_disabled' => 1 = disabled, 0 = not disabled
		'user_confirmed' => 1 = confirmed, 0 = not confirmed
		'sn' =>	The member's surname (last name)
		'givenname' => The member's given name (first name)
)

The result set is ordered by role types (in order 1,2,3,0) and by user name (according to ovidentia name ordering rules).



class bab_OrgChartUtil

__construct($iIdOrgChart, $iIdSessUser = null)

haveAdminRight()

isAccessValid()

create($sName, $sDescription, $iIdDelegation, $iIdDirectory)

A transformer en static ??? a supprimer ???


getRoot()

Returns information about a specified organizational chart. The current user must have "view" or "update" access to the organizational chart. The returned array has the following keys :

  • id
  • name
  • description
  • edit
  • edit_author
  • edit_date
  • id_dgowner
  • id_directory
  • type
  • id_first_node
  • id_closed_nodes