Docs for page functions

/includes/functions_charts.php

Description

Functions used for charts

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

version: $Id: functions_charts.php 981 2007-03-21 13:24:38Z fisharebest $

Includes

require_once ("includes/person_class.php") (line 32)

Functions used for charts

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

version: $Id: functions_charts.php 981 2007-03-21 13:24:38Z fisharebest $

Functions

ancestry_array (line 730)

creates an array with all of the individual ids to be displayed on an ascendancy chart

the id in position 1 is the root person. The other positions are filled according to the following algorithm if an individual is at position $i then individual $i's father will occupy position ($i*2) and $i's mother will occupy ($i*2)+1

array ancestry_array (string $rootid, [ $maxgen = 0])

string $rootid
$maxgen

check_rootid (line 692)

check root id for pedigree tree

return: validated root ID

string check_rootid (string $rootid)

string $rootid: root ID

find_last_sfam (line 1091)

find last family ID where this person is a spouse

return: last sfam ID

string find_last_sfam (string $pid)

string $pid: individual ID

find_last_spouse (line 1104)

find last spouse for this person

return: last spouse ID

string find_last_spouse (string $pid)

string $pid: individual ID

get_children_ids (line 794)

find all children from a family

return: array of child ID

array get_children_ids (string $famid)

string $famid: family ID

get_sosa_name (line 837)

builds and returns sosa relationship name in the active language

void get_sosa_name (string $sosa)

string $sosa: sosa number

pedigree_array (line 769)

creates an array with all of the individual ids to be displayed on the pedigree chart

the id in position 0 is the root person. The other positions are filled according to the following algorithm if an individual is at position $i then individual $i's father will occupy position ($i*2)+1 and $i's mother will occupy ($i*2)+2

deprecated: This function has been deprecated by the ancestry_array function, it is still provided for backwards compatibility but it should no longer be used in new code

array pedigree_array (string $rootid)

string $rootid

print_childbox_popup (line 1001)

print a popup menu for descendants so that we can move down the tree

void print_childbox_popup (string $rootid, string $indirec, string $url)

string $rootid: the Gedcom Xref ID of the person to print
string $indirec: the rootid Gedcom record
string $url: the rootid action url

print_cousins (line 1118)

print cousins list

void print_cousins (string $famid, [ $personcount = "1"])

string $famid: family ID
$personcount

print_family_children (line 265)

print the children table for a family

void print_family_children (string $famid, [string $childid = ""], [int $sosa = 0], [string $label = ""], [ $personcount = "1"])

string $famid: family gedcom ID
string $childid: optional child ID
int $sosa: optional child sosa number
string $label: optional indi label (descendancy booklet)
$personcount

print_family_facts (line 435)

print the facts table for a family

void print_family_facts (string $famid, [int $sosa = 0])

string $famid: family gedcom ID
int $sosa: optional child sosa number

print_family_header (line 68)

print family header

void print_family_header (string $famid)

string $famid: family gedcom ID

print_family_parents (line 95)

print the parents table for a family

void print_family_parents (string $famid, [int $sosa = 0], [string $label = ""], [string $parid = ""], [string $gparid = ""], [ $personcount = "1"])

string $famid: family gedcom ID
int $sosa: optional child sosa number
string $label: optional indi label (descendancy booklet)
string $parid: optional parent ID (descendancy booklet)
string $gparid: optional gd-parent ID (descendancy booklet)
$personcount

print_sosa_family (line 670)

print a family with Sosa-Stradonitz numbering system ($rootid=1, father=2, mother=3 ...)

void print_sosa_family (string $famid, string $childid, string $sosa, [string $label = ""], [string $parid = ""], [string $gparid = ""], [ $personcount = "1"])

string $famid: family gedcom ID
string $childid: tree root ID
string $sosa: starting sosa number
string $label: optional indi label (descendancy booklet)
string $parid: optional parent ID (descendancy booklet)
string $gparid: optional gd-parent ID (descendancy booklet)
$personcount

print_sosa_number (line 41)

print a table cell with sosa number

void print_sosa_number (int $sosa, [string $pid = ""], [string $arrowDirection = "up"])

int $sosa
string $pid: optional pid
string $arrowDirection: direction of link arrow

print_url_arrow (line 812)

print an arrow to a new url

void print_url_arrow (string $id, string $url, string $label, [string $dir = 2])

string $id: Id used for arrow img name (must be unique on the page)
string $url: target url
string $label: arrow label
string $dir: arrow direction 0=left 1=right 2=up 3=down (default=2)

Documentation generated on Wed, 28 Mar 2007 09:54:17 -0600 by phpDocumentor 1.3.1