Core Functions that can be used by any page in PGV

The functions in this file are common to all PGV pages and include date conversion routines and sorting functions.

phpGedView: Genealogy Viewer Copyright (C) 2002 to 2003 John Finlay and Others

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.php 981 2007-03-21 13:24:38Z fisharebest $

• $pid
• $children
• $generations
• $show_empty

check if the page view rate for a session has been exeeded.

check file in

• return: whether the file was checked in

• string $logline: Log message
• string $filename: Filename
• string $dirname: Directory
• boolean $bInsert: Insert Log message

• $aName
• $bName
• $ignoreCase

compare two fact records by date

Compare facts function is used by the usort PHP function to sort fact baseds on date it parses out the year and if the year is the same, it creates a timestamp based on the current year and the month and day information of the fact

• return: -1 if $a should be sorted first, 0 if they are the same, 1 if $b should be sorted first

• mixed $a: an array with the fact record at index 1 or just a string with the factrecord
• mixed $b: an array with the fact record at index 1 or just a string with the factrecord

get the relative filename for a media item

gets the relative file path from the full media path for a media item. checks the $MEDIA_DIRECTORY_LEVELS to make sure the directory structure is maintained.

• return: a relative path that can be appended to the $MEDIA_DIRECTORY to reference the item

• string $fullpath: the full path from the media record

Function to sort GEDCOM fact tags based on their tanslations

• $a
• $b

encode a filename

windows doesn't use UTF-8 for its file system so we have to encode the filename before it can be used in PGV

• $filename

find the children in a family

find and return an array containing the children of the given family record

• author: John Finlay (yalnifj)

• string $famid: the gedcom xref id for the family
• string $me: an xref id of a child to ignore, useful when you want to get a person's siblings but do want to include them as well

find all family ids in the given record

searches an individual gedcom record and returns an array of the FAMS|C ids

• return: array of family ids

• string $indirec: the gedcom record for the person to look in
• string $tag: The family tag to look for

find the highlighted media object for a gedcom entity

Rules for finding the highlighted media object:

1. The first _THUM Y object will be used regardless of the object's level in the gedcom record
2. The first _PRIM Y object will be used if no _THUM Y exists regardless of level in gedcom record
3. The first level 1 object will be used if there is no _THUM Y or _PRIM Y and if its doesn't have _THUM N or _PRIM N (level 1 objects appear on the media tab on the individual page)
4. Adding _PRIM N to any object will cause it not to be shown as a highlighted media.

• return: an object array with indexes "thumb" and "file" for thumbnail and filename

• string $pid: the individual, source, or family id
• string $indirec: the gedcom record to look in

find the parents in a family record

find and return a two element array containing the parents of the given family record

• return: returns a two element array with indexes HUSB and WIFE for the parent ids
• author: John Finlay (yalnifj)

• string $famrec: the gedcom record of the family to search in

find all spouse family ids

searches an individual gedcom record and returns an array of the FAMS ids where this person is a spouse in the family

• return: array of family ids

• string $pid: the gedcom xref id for the person to look in

• $a
• $b

Get the current time in micro seconds

returns a timestamp for the current time in micro seconds obtained from online documentation for the microtime() function on php.net

• return: time in micro seconds

format a fact for calendar viewing

• return: a html text string that can be printed

• string $factrec: the fact record
• string $action: tells what type calendar the user is viewing
• string $filter: should the fact be filtered by living people etc
• string $pid: the gedcom xref id of the record this fact belongs to
• string $filterev: "all" to show all events; "bdm" to show only Births, Deaths, Marriages; Event code to show only that event
• $filterof

get CONT lines

get the N+1 CONT or CONC lines of a gedcom subrecord

• return: a string with all CONT or CONC lines merged

• int $nlevel: the level of the CONT lines to get
• string $nrec: the gedcom subrecord to search in
• $tobr

get a gedcom filename from its database id

• int $ged_id: The gedcom database id to get the filename for

get the next available xref

calculates the next available XREF id for the given type of record

• string $type: the type of record, defaults to 'INDI'
• $use_cache

Get the version of the privacy file

This function opens the given privacy file and returns the privacy version from the file

• return: the privacy file version number

• string $privfile: the path to the privacy file

Get relationship between two individuals in the gedcom

function to calculate the relationship between two people it uses hueristics based on the individuals birthdate to try and calculate the shortest path between the two individuals it uses a node cache to help speed up calculations when using relationship privacy this cache is indexed using the string "$pid1-$pid2"

• string $pid1: the ID of the first person to compute the relationship from
• string $pid2: the ID of the second person to compute the relatiohip to
• bool $followspouse: whether to add spouses to the path
• int $maxlenght: the maximim length of path
• bool $ignore_cache: enable or disable the relationship cache
• int $path_to_find: which path in the relationship to find, 0 is the shortest path, 1 is the next shortest path, etc
• $maxlength

get a gedcom subrecord

searches a gedcom record and returns a subrecord of it. A subrecord is defined starting at a line with level N and all subsequent lines greater than N until the next N level is reached. For example, the following is a BIRT subrecord:

• return: the subrecord that was found or an empty string "" if not found.
• author: John Finlay (yalnifj)
• author: Roland Dalmulder (roland-d)

• int $level: the N level of the subrecord to get
• string $tag: a gedcom tag or string to search for in the record (ie 1 BIRT or 2 DATE)
• string $gedrec: the parent gedcom record to search in
• int $num: this allows you to specify which matching $tag to get. Oftentimes a gedcom record will have more that 1 of the same type of subrecord. An individual may have multiple events for example. Passing $num=1 would get the first 1. Passing $num=2 would get the second one, etc.

check if the given string has UTF-8 characters

• $string

Determine the type of ID NOTE: Be careful when using this function as not all GEDCOMS have ID prefixes. Many GEDCOMS just use numbers like 100, 101, etc without the I, F, etc prefixes.

• string $id

sort arrays or strings

this function is called by the uasort PHP function to compare two items and tell which should be sorted first. It uses the language alphabets to create a string that will is used to compare the strings. For each letter in the strings, the letter's position in the alphabet string is found. Whichever letter comes first in the alphabet string should be sorted first.

• return: negative numbers sort $a first, positive sort $b first

• array $a: first item
• array $b: second item

Load language variables Set language-dependent global variables

This function loads the variables for the language, as specified by the first input parameter. It also loads any existing language-specific functions such special date handling for Finnish and Turkish.

If the forceLoad parameter is true, English will be loaded first, followed by the desired language file.

• $desiredLanguage
• $forceLoad

array merge function for PGV

the PHP array_merge function will reindex all numerical indexes This function should only be used for associative arrays

• array $array1
• array $array2

remove any custom PGV tags from the given gedcom record

custom tags include _PGVU and _THUM

• return: the updated gedcom record

• string $gedrec: the raw gedcom record
• $remove

This function will sort a list of facts It uses an insertion sort algorithm which is a slower algorithm but it insures that all of the items get checked against each other which works better with the way that facts are sorted.

New twist: Run the sort twice, first on dated material, then undated, inserting at the last position that matches sort order.

• $array $factlist: the array of facts to sort
• &$factlist

Store GEDCOMS array

this function will store the $GEDCOMS array in the $INDEX_DIRECTORY/gedcoms.php file. The gedcoms.php file is included in session.php to create the $GEDCOMS array with every page request.

• see: session.php

• $aName
• $bName

User Name comparison Function

This function just needs to call the itemsort function on the fullname field of the array

• return: negative numbers sort $a first, positive sort $b first

• array $a: first user array
• array $b: second user array