PHP Class geneweb\api\GenewebAPI

Datei anzeigen Open project: geneweb/geneweb

Public Properties

Property Type Description
$lastUrl

Protected Properties

Property Type Description
$base
$filters
$fullInfos
$instances
$iz
$modeFriend
$modeWizard
$output
$password
$url
$user

Public Methods

Method Description
__construct ( $base ) : GenewebAPI Constructeur privé
addFamily ( $family ) : object\ModificationStatus Permet d'ajouter une famille
addFilter ( Filter $filter )
addPerson ( $person ) : object\ModificationStatus Permet d'ajouter une personne
addPersonStartOk ( $person ) : object\ModificationStatus Permet d'ajouter une personne
approximativeSearch ( string $lastname, string $firstname = null, boolean $only_sosa = false, boolean $only_recent = false, boolean $maiden_name = false ) : object\ListPersons Permet de rechercher les individus contenant le nom ET le prénom Exemple: $lastname = mar et $firstname = jean renverra MARTIN Jean / MARTIN Nicolas Jean / GALLIMARD Claudette-Jeanne
deleteFamily ( $family ) : object\ModificationStatus Permet de supprimer une personne
deletePerson ( $person ) : object\ModificationStatus Permet de supprimer une personne
enableModeFriend ( $user, $password )
enableModeWizard ( $user, $password )
executeRequests ( $handlers ) : mixed Envoi de la requête à l'API de Geneweb
exportBase ( $directory )
exportBaseSearch ( $directory )
findSosa ( string $n, string $p, string $oc ) : object\ReferencePerson Permet de récupérer le sosa à partir d'une personne
getAllFamilies ( integer $from = null, integer $limit = null ) : object\ListPerson Permet de récupérer toutes les familles d'une base
getAllImages ( ) : object\ListImages Permet de récupérer toutes les images
getAllImagesExt ( ) : object\ListImages Permet de récupérer toutes les images internes
getAllImagesExtNb ( ) : object\ListImages Permet de récupérer toutes les images externes
getAllImagesInt ( ) : object\ListImages Permet de récupérer toutes les images
getAllImagesIntNb ( ) : object\ListImages Permet de récupérer toutes les images
getAllImagesNb ( ) : object\ListImages Permet de récupérer toutes les images
getAllPersons ( integer $from = null, integer $limit = null ) : object\ListPerson Permet de récupérer toutes les personnes d'une base
getBaseInfos ( ) : object\BaseInfos Permet de récupérer des infos sur la base
getBaseWarnings ( ) : object\BaseWarnings Permet de récupérer tous les warnings d'une base
getBirthdayPersons ( integer $month1, integer $day1 = null, integer $month2 = null, integer $day2 = null ) : object\ListPerson Permet de récupérer une liste de personnes ayant leur anniversaire dans la fourchette de date donnée 1 => janvier, 12 => décembre
getClosePersons ( string $n, string $p, string $oc, boolean $onlyRecent = null, boolean $spouseAscend = null, integer $nbGenAsc = null, integer $nbGenDesc = null ) : object\ListPerson Permet de récupérer une liste de personnes proches d'une personne
getCplRelation ( string $n1, string $p1, string $oc1, string $n2, string $p2, string $oc2 ) : object\ListPersons Permet de récupérer le couple commun entre deux individus
getGraphAscPerson ( string $n, string $p, string $oc, integer $generation ) : object\Graph Permet de récupérer le graphe d'ascendance d'une personne
getGraphDescPerson ( string $n, string $p, string $oc, integer $generation ) : object\Graph Permet de récupérer le graphe de descendance d'une personne
getGraphRelation ( string $n1, string $p1, string $oc1, string $n2, string $p2, string $oc2 ) : object\Graph Permet de récupérer le graphe entre deux relations
getImagePerson ( $id ) : object\ImageAddress Permet de récupérer l'image d'une personne à partir de son index
getIndividualInfos ( string $n, string $p, string $oc ) : object\Person Permet de récupérer les infos d'un individu
getInstance ( string $base, string $signature ) : GenewebAPI Instance de classe
getListIndividualInfos ( array $array ) : object\ListPerson Permet de récupérer les infos d'une liste d'individus Exemple: $array = array(array('n' => 'n', 'p' => 'p', 'oc' => 'oc'));
getLoopBase ( ) : object\Person Permet de récupérer la boucle de la base
getMaxAncestors ( ) : object\ReferencePerson Permet de récupérer la personne ayant le plus d'ancêtre
getNotificationBirthday ( string $n, string $p, integer $oc, string $type, integer $month, integer $day ) : object\NotificationBirthday Permet de récupérer une liste de personnes ayant leur anniversaire dans la date donnée
getReferencePerson ( $id ) : object\ImageAddress Permet de récupérer la référence personne à partir de son index
getUrl ( ) * Récupère l'url de l'instance GwAPI
initFilter ( )
lastnameOrFirstnameSearch ( string $lastname, string $firstname ) : object\ListPersons Permet de rechercher les individus contenant le nom OU le prénom Exemple: $lastname = mar et $firstname = jean renverra DUPOND Jean / MARTIN Pierre / MARTIN Nicolas Jean / .
prepareAllPersons ( integer $from = null, integer $limit = null, $protoFilter = null ) : object\ListPerson Permet de récupérer toutes les personnes d'une base
printPersons ( )
removeAllImagesExt ( ) : object\ListImages Permet de récupérer toutes les images externes (toutes)
removeImagesExt ( ) : object\ListImages Permet de récupérer toutes les images externes (http uniquement)
resetFilter ( )
setFullInfos ( boolean $fullInfos ) : void Permet de définir le type d'infos souhaitées (partielles ou complètes)
setIz ( $iz )
setOutput ( string $output ) : void Permet de définir le type de sortie
setUrl ( $url ) * Modifie l'url de l'instance GwAPI
startingWithSearch ( string $lastname, string $firstname = null, boolean $onlySosa = false, boolean $onlyRecent = false ) : object\ListPersons Permet de rechercher les individus commençant par le nom ET le prénom Exemple: $lastname = mar et $firstname = jean renverra MARTIN Jean / MARTIN Jean Nicolas / MARTINIERE Jeanne
synchroBase ( $directory, $timestamp )
updateFamily ( $family ) : object\ModificationStatus Permet de mettre à jour une personne
updateImagePerson ( string $n, string $p, integer $oc, string $url ) : void Permet de mettre à jour l'image d'une personne
updateListImagePerson ( array $array ) : void Permet de mettre à jour l'image d'une liste de personnes Exemple: $array = array(array('n' => 'n', 'p' => 'p', 'oc' => 'oc', 'img' => 'http://.
updatePerson ( $person ) : object\ModificationStatus Permet de mettre à jour une personne

Protected Methods

Method Description
getIz ( )
isFullInfos ( )
isModeFriend ( )
isModeWizard ( )
prepareRequest ( string $type, $data, string $class, $protoFilters ) : curl Prepare une requete à l'API de Geneweb
request ( string $type, $data, string $class ) : mixed Envoi de la requête à l'API de Geneweb

Private Methods

Method Description
getClassname ( $classname )

Method Details

__construct() public method

Constructeur privé
public __construct ( $base ) : GenewebAPI
return GenewebAPI

addFamily() public method

Permet d'ajouter une famille
public addFamily ( $family ) : object\ModificationStatus
return object\ModificationStatus

addFilter() public method

public addFilter ( Filter $filter )
$filter geneweb\api\filters\Filter

addPerson() public method

Permet d'ajouter une personne
public addPerson ( $person ) : object\ModificationStatus
$person object\Person
return object\ModificationStatus

addPersonStartOk() public method

Permet d'ajouter une personne
public addPersonStartOk ( $person ) : object\ModificationStatus
$person object\Person
return object\ModificationStatus

approximativeSearch() public method

Permet de rechercher les individus contenant le nom ET le prénom Exemple: $lastname = mar et $firstname = jean renverra MARTIN Jean / MARTIN Nicolas Jean / GALLIMARD Claudette-Jeanne
public approximativeSearch ( string $lastname, string $firstname = null, boolean $only_sosa = false, boolean $only_recent = false, boolean $maiden_name = false ) : object\ListPersons
$lastname string
$firstname string
$only_sosa boolean
$only_recent boolean
$maiden_name boolean
return object\ListPersons

deleteFamily() public method

Permet de supprimer une personne
public deleteFamily ( $family ) : object\ModificationStatus
return object\ModificationStatus

deletePerson() public method

Permet de supprimer une personne
public deletePerson ( $person ) : object\ModificationStatus
$person object\FullPerson
return object\ModificationStatus

enableModeFriend() public method

public enableModeFriend ( $user, $password )

enableModeWizard() public method

public enableModeWizard ( $user, $password )

executeRequests() public method

Envoi de la requête à l'API de Geneweb
public executeRequests ( $handlers ) : mixed
return mixed

exportBase() public method

public exportBase ( $directory )

exportBaseSearch() public method

public exportBaseSearch ( $directory )

findSosa() public method

Permet de récupérer le sosa à partir d'une personne
public findSosa ( string $n, string $p, string $oc ) : object\ReferencePerson
$n string
$p string
$oc string
return object\ReferencePerson

getAllFamilies() public method

Permet de récupérer toutes les familles d'une base
public getAllFamilies ( integer $from = null, integer $limit = null ) : object\ListPerson
$from integer [optional]
$limit integer [optional]
return object\ListPerson

getAllImages() public method

Permet de récupérer toutes les images
public getAllImages ( ) : object\ListImages
return object\ListImages

getAllImagesExt() public method

Permet de récupérer toutes les images internes
Deprecation: DO NOT USE THIS !
public getAllImagesExt ( ) : object\ListImages
return object\ListImages

getAllImagesExtNb() public method

Permet de récupérer toutes les images externes
Deprecation: DO NOT USE THIS !
public getAllImagesExtNb ( ) : object\ListImages
return object\ListImages

getAllImagesInt() public method

Permet de récupérer toutes les images
public getAllImagesInt ( ) : object\ListImages
return object\ListImages

getAllImagesIntNb() public method

Permet de récupérer toutes les images
public getAllImagesIntNb ( ) : object\ListImages
return object\ListImages

getAllImagesNb() public method

Permet de récupérer toutes les images
public getAllImagesNb ( ) : object\ListImages
return object\ListImages

getAllPersons() public method

Permet de récupérer toutes les personnes d'une base
public getAllPersons ( integer $from = null, integer $limit = null ) : object\ListPerson
$from integer [optional]
$limit integer [optional]
return object\ListPerson

getBaseInfos() public method

Permet de récupérer des infos sur la base
public getBaseInfos ( ) : object\BaseInfos
return object\BaseInfos

getBaseWarnings() public method

Permet de récupérer tous les warnings d'une base
public getBaseWarnings ( ) : object\BaseWarnings
return object\BaseWarnings

getBirthdayPersons() public method

Permet de récupérer une liste de personnes ayant leur anniversaire dans la fourchette de date donnée 1 => janvier, 12 => décembre
public getBirthdayPersons ( integer $month1, integer $day1 = null, integer $month2 = null, integer $day2 = null ) : object\ListPerson
$month1 integer
$day1 integer
$month2 integer
$day2 integer
return object\ListPerson

getClosePersons() public method

Permet de récupérer une liste de personnes proches d'une personne
public getClosePersons ( string $n, string $p, string $oc, boolean $onlyRecent = null, boolean $spouseAscend = null, integer $nbGenAsc = null, integer $nbGenDesc = null ) : object\ListPerson
$n string
$p string
$oc string
$onlyRecent boolean
$spouseAscend boolean
$nbGenAsc integer
$nbGenDesc integer
return object\ListPerson

getCplRelation() public method

Permet de récupérer le couple commun entre deux individus
public getCplRelation ( string $n1, string $p1, string $oc1, string $n2, string $p2, string $oc2 ) : object\ListPersons
$n1 string
$p1 string
$oc1 string
$n2 string
$p2 string
$oc2 string
return object\ListPersons

getGraphAscPerson() public method

Permet de récupérer le graphe d'ascendance d'une personne
public getGraphAscPerson ( string $n, string $p, string $oc, integer $generation ) : object\Graph
$n string
$p string
$oc string
$generation integer
return object\Graph

getGraphDescPerson() public method

Permet de récupérer le graphe de descendance d'une personne
public getGraphDescPerson ( string $n, string $p, string $oc, integer $generation ) : object\Graph
$n string
$p string
$oc string
$generation integer
return object\Graph

getGraphRelation() public method

Permet de récupérer le graphe entre deux relations
public getGraphRelation ( string $n1, string $p1, string $oc1, string $n2, string $p2, string $oc2 ) : object\Graph
$n1 string
$p1 string
$oc1 string
$n2 string
$p2 string
$oc2 string
return object\Graph

getImagePerson() public method

Permet de récupérer l'image d'une personne à partir de son index
public getImagePerson ( $id ) : object\ImageAddress
return object\ImageAddress

getIndividualInfos() public method

Permet de récupérer les infos d'un individu
public getIndividualInfos ( string $n, string $p, string $oc ) : object\Person
$n string
$p string
$oc string
return object\Person

getInstance() public static method

Instance de classe
public static getInstance ( string $base, string $signature ) : GenewebAPI
$base string
$signature string
return GenewebAPI

getIz() protected method

protected getIz ( )

getListIndividualInfos() public method

Permet de récupérer les infos d'une liste d'individus Exemple: $array = array(array('n' => 'n', 'p' => 'p', 'oc' => 'oc'));
public getListIndividualInfos ( array $array ) : object\ListPerson
$array array
return object\ListPerson

getLoopBase() public method

Permet de récupérer la boucle de la base
public getLoopBase ( ) : object\Person
return object\Person

getMaxAncestors() public method

Permet de récupérer la personne ayant le plus d'ancêtre
public getMaxAncestors ( ) : object\ReferencePerson
return object\ReferencePerson

getNotificationBirthday() public method

Permet de récupérer une liste de personnes ayant leur anniversaire dans la date donnée
public getNotificationBirthday ( string $n, string $p, integer $oc, string $type, integer $month, integer $day ) : object\NotificationBirthday
$n string
$p string
$oc integer
$type string
$month integer
$day integer
return object\NotificationBirthday

getReferencePerson() public method

Permet de récupérer la référence personne à partir de son index
public getReferencePerson ( $id ) : object\ImageAddress
return object\ImageAddress

getUrl() public method

* Récupère l'url de l'instance GwAPI
public getUrl ( )

initFilter() public method

public initFilter ( )

isFullInfos() protected method

protected isFullInfos ( )

isModeFriend() protected method

protected isModeFriend ( )

isModeWizard() protected method

protected isModeWizard ( )

lastnameOrFirstnameSearch() public method

..
public lastnameOrFirstnameSearch ( string $lastname, string $firstname ) : object\ListPersons
$lastname string
$firstname string
return object\ListPersons

prepareAllPersons() public method

Permet de récupérer toutes les personnes d'une base
public prepareAllPersons ( integer $from = null, integer $limit = null, $protoFilter = null ) : object\ListPerson
$from integer [optional]
$limit integer [optional]
return object\ListPerson

prepareRequest() protected method

Prepare une requete à l'API de Geneweb
protected prepareRequest ( string $type, $data, string $class, $protoFilters ) : curl
$type string
$class string
return curl handler

printPersons() public method

public printPersons ( )

removeAllImagesExt() public method

Permet de récupérer toutes les images externes (toutes)
Deprecation: DO NOT USE THIS !
public removeAllImagesExt ( ) : object\ListImages
return object\ListImages

removeImagesExt() public method

Permet de récupérer toutes les images externes (http uniquement)
Deprecation: DO NOT USE THIS !
public removeImagesExt ( ) : object\ListImages
return object\ListImages

request() protected method

Envoi de la requête à l'API de Geneweb
protected request ( string $type, $data, string $class ) : mixed
$type string
$class string
return mixed

resetFilter() public method

public resetFilter ( )

setFullInfos() public method

Permet de définir le type d'infos souhaitées (partielles ou complètes)
public setFullInfos ( boolean $fullInfos ) : void
$fullInfos boolean
return void

setIz() public method

public setIz ( $iz )

setOutput() public method

Permet de définir le type de sortie
public setOutput ( string $output ) : void
$output string (voir constante)
return void

setUrl() public method

* Modifie l'url de l'instance GwAPI
public setUrl ( $url )
$url

startingWithSearch() public method

Permet de rechercher les individus commençant par le nom ET le prénom Exemple: $lastname = mar et $firstname = jean renverra MARTIN Jean / MARTIN Jean Nicolas / MARTINIERE Jeanne
public startingWithSearch ( string $lastname, string $firstname = null, boolean $onlySosa = false, boolean $onlyRecent = false ) : object\ListPersons
$lastname string
$firstname string
$onlySosa boolean
$onlyRecent boolean
return object\ListPersons

synchroBase() public method

public synchroBase ( $directory, $timestamp )

updateFamily() public method

Permet de mettre à jour une personne
public updateFamily ( $family ) : object\ModificationStatus
return object\ModificationStatus

updateImagePerson() public method

Permet de mettre à jour l'image d'une personne
public updateImagePerson ( string $n, string $p, integer $oc, string $url ) : void
$n string
$p string
$oc integer
$url string
return void

updateListImagePerson() public method

..'));
public updateListImagePerson ( array $array ) : void
$array array
return void

updatePerson() public method

Permet de mettre à jour une personne
public updatePerson ( $person ) : object\ModificationStatus
$person object\FullPerson
return object\ModificationStatus

Property Details

$base protected_oe property

protected $base

$filters protected_oe property

protected $filters

$fullInfos protected_oe property

protected $fullInfos

$instances protected_oe static_oe property

protected static $instances

$iz protected_oe property

protected $iz

$lastUrl public_oe property

public $lastUrl

$modeFriend protected_oe property

protected $modeFriend

$modeWizard protected_oe property

protected $modeWizard

$output protected_oe property

protected $output

$password protected_oe property

protected $password

$url protected_oe property

protected $url

$user protected_oe property

protected $user