/privacy.php

Description

Default Privacy File

This is the default privacy.php module that is distributed with phpGedView. Whenever a gedcom file is added to the PGV system a copy of this file is placed in the $INDEX_DIRECTORY for each gedcom so that each gedcom may use different privacy settings.

This privacy module allows you to hide the names and/or details of living people. Allows authenticated users to view the details of living people. It also allows Admins to change privacy settings for specific gedcom records or individuals.

This privacy file also acts as a module allowing programmers to extend the functionality of the privacy settings or implement a different privacy model for each gedcom. To provide your own privacy module simply implement the functions in this file and configure phpGedview to use your new file.

See http://www.phpgedview.net/modules.html for more information on modules in PhpGedView

phpGedView: Genealogy Viewer Copyright (C) 2002 to 2005 PGV Development Team

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

$Id: privacy.php 69 2006-05-24 20:40:08Z yalnifj $

Variables
boolean $CHECK_MARRIAGE_RELATIONS (line 205)

Follow Marriage Relationships

This setting tells the relationship privacy calculator whether or not to follow marriage relationships. Setting this to true would allow a user to view his brother's wife's family for example. The default setting is true.

integer $ENABLE_CLIPPINGS_CART (line 160)

Set the access level for the clippings cart

Sets the access level required to view the clippings cart. Can be one of the PRIV access levels:

  • $PRIV_HIDE
  • $PRIV_PUBLIC
  • $PRIV_USER
  • $PRIV_NONE
The default settings is set to $PRIV_PUBLIC allowing only authenticated users to have access.

integer $MAX_ALIVE_AGE (line 133)

how old a person must be before they are assumed to be dead

The $MAX_ALIVE_AGE variable is referenced by the privacy functions to determine how old a person must be before a person is assumed to be dead.

integer $MAX_RELATION_PATH_LENGTH (line 196)

Maximum path to allow when using relationship privacy

This setting is the maximum path length to allow users to view. The path length is defined as the number of steps it takes to get from 1 individual to another. The default value is 3, which would allow someone to access up to their second cousins

boolean $PRIVACY_BY_RESN (line 224)

Check for RESN privacy restrictions

This setting tells the privacy functions to look inside the gedcom record for a RESN restriction tag. The RESN tag was used by Ancestral File as a way of marking a record as private.

boolean $PRIVACY_BY_YEAR (line 215)

Use Year Based Privacy

This setting tells the privacy functions to change how the death status of an individual is calculated based on how long it has been since they died. So someone who died less than $MAX_ALIVE_AGE-25 years ago will still be shown as dead.

string $PRIVACY_VERSION (line 59)

Privacy file version number

This version number is used to track updates to the privacy functions between versions so that the program can automatically update the gedcom specific privacy files during the upgrade process.

integer $PRIV_HIDE (line 67)

Hide option from all users

Global constant privacy level to hide the item to all users including the admin

integer $PRIV_NONE (line 91)

accessible only by admin users - Only works with $global_facts

Global constant privacy level that only allows admin users to access the marked information.

integer $PRIV_PUBLIC (line 75)

Accessible by public

Global constant privacy level that allows non-authenticated public visitors to view the marked information.

integer $PRIV_USER (line 83)

accessible only by authenticated users

Global constant privacy level that only allows authenticated users to access the marked information.

integer $SHOW_DEAD_PEOPLE (line 101)

Set the access level for dead people

Sets the access level required to view the information of dead people. Can be one of the PRIV access levels: $PRIV_HIDE, $PRIV_PUBLIC, $PRIV_USER, $PRIV_NONE The default value is $PRIV_PUBLIC.

integer $SHOW_LIVING_NAMES (line 113)

Set the access level for the names of private people

Sets the access level required to view the names of private people. Can be one of the PRIV access levels: $PRIV_HIDE, $PRIV_PUBLIC, $PRIV_USER, $PRIV_NONE The default value is $PRIV_PUBLIC. Setting this to $PRIV_USER would mean that only authenticated users can view names of private people and public visitors would only see the name private.

boolean $SHOW_PRIVATE_RELATIONSHIPS (line 230)

When privatizing a gedom record should the relationship links be left in or stripped out

integer $SHOW_RESEARCH_ASSISTANT (line 147)

Set the access level for the research assistant add-on module

Sets the access level required to view the research assistant add-on module. Can be one of the PRIV access levels:

  • $PRIV_HIDE
  • $PRIV_PUBLIC
  • $PRIV_USER
  • $PRIV_NONE
The default settings is set to $PRIV_USER allowing only authenticated users to have access.

boolean $USE_RELATIONSHIP_PRIVACY (line 186)

Set the program to use relationship privacy

This tells the program that for private individuals calculate the relationship between the user and the individual and use the relationship path setting $MAX_RELATION_PATH_LENGTH to determine if the user has access.

A false value means authenticated users can see the details of all living people A true value means users can only see the private information of living people they are related to.

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