PGVWiki - User contributions [en]

4.2.4

2011-01-14T00:22:01Z

Yalnifj: Created page with ''''PhpGedView v4.2.4''' was released on 13 January, 2011. Note that PhpGedView 4.2 now requires PHP 5.2.0 or later in order to run. Please ensure your server…'

'''PhpGedView v4.2.4''' was released on [[13 January]], [[2011]].

Note that PhpGedView 4.2 now requires [[w:PHP|PHP]] 5.2.0 or later in order to run. Please ensure your server has a suitable version of PHP before upgrading. If you don't know your version, you can find it out from the phpinfo link on PGV's admin page.

== Features ==

{{main|Features v4.2.x}}

== Internal Links ==

* [[Download v4.2.x|Download Page]]
* [[Installation Guide v4.2.x|Installation Guide]]


{{DEFAULTSORT:4.2.4}}
[[Category:PhpGedView]]

Template:Latest version 4.2.x

2011-01-14T00:20:14Z

Yalnifj:

{{ #if: {{{release date|{{{release_date|}}}}}} | [[13 January]], [[2011]] | 4.2.4 }}<noinclude>
[[Category:Templates]]
{{template doc}}
</noinclude>

PhpGedView v4.2.4

2011-01-14T00:12:22Z

Yalnifj: Created page with ''''PhpGedView v4.2.4''' was released on 13 January, 2011. Note that PhpGedView 4.2 now requires PHP 5.2.0 or later in order to run. Please ensure your server…'

Download v4.2.x

2011-01-13T23:57:49Z

Yalnifj:

The latest release is v[[{{latest version|series=4.2.x}}]]. The release was on {{latest version|series=4.2.x|release date=1}}.[[image:gedview.gif|right]]
Older versions are still available ... [[Download_v4.2.1|v4.2.1]] for non-PDO enabled servers, and [[Download_v4.1.x|v4.1.7]] for servers that are only running php4.

==Download Packages==
For convenience PhpGedView {{latest version|series=4.2.x}} has been divided into several packages which allows you to choose what you want to download.

[[Modules]] are plug-ins to PhpGedView which provide additional features or functionality not found in the core files. Some modules may require additional software. See the installation instructions for each module for their requirements.

;[https://sourceforge.net/project/downloading.php?group_id=55456&filename=PhpGedView-basic-{{latest version|series=4.2.x}}.zip PhpGedView (BASIC) {{latest version|series=4.2.x}}]
: This package contains the core files to run PhpGedView. It includes the most commonly requested themes and language files. It does not include place maps or any modules.

;[https://sourceforge.net/project/downloading.php?group_id=55456&filename=PhpGedView-all-{{latest version|series=4.2.x}}.zip PhpGedView (ALL) {{latest version|series=4.2.x}}]
: This package contains the complete set files to run PhpGedView, including all themes and language files, place maps and modules. After installation you can disable the modules you don't need.

;[https://sourceforge.net/project/downloading.php?group_id=55456&filename=PGV-Demo-{{latest version|series=4.2.x}}.zip Windows Demo ]
: This package is a self contained demo version of PhpGedView which can be run out of the box on Windows based systems. This package is great if you want to take PGV for a test drive or if you want to burn your own data for distribution on a CD.

;[https://sourceforge.net/project/downloading.php?group_id=55456&filename=PGV-Themes-{{latest version|series=4.2.x}}.zip Themes ]
: This package includes other themes maintained with PhpGedView. Other user submitted themes can be found at http://www.pgvthemes.com/

;[https://sourceforge.net/project/downloading.php?group_id=55456&filename=PGV-Places-{{latest version|series=4.2.x}}.zip Places ]
: This package includes place maps for many different countries. Place maps can be enabled in the place hierarchy and on the editing pages.

;[https://sourceforge.net/project/downloading.php?group_id=55456&filename=PGV-Languages-{{latest version|series=4.2.x}}.zip Languages ]
: This package includes the other languages that have been submitted to PGV including Arabic, Catalan, Czech, Danish, Greek, Spanish, Estonian, Finnish, Hebrew, Hungarian, Indonesian, Italian, Lithuanian, Dutch, Polish, Portuguese, Romanian, Russian, Serbian, Slovakian, Slovenian, Turkish, Vietnamese, and Chinese.

==Download Modules==
To install a module just upload it to the "modules" directory in your PhpGedView folder. All of these modules are included in the "PhpGedView (ALL) {{latest version|series=4.2.x}}" package above.

;[https://sourceforge.net/project/downloading.php?group_id=55456&filename=PGV-Module-googlemap-{{latest version|series=4.2.x}}.zip GoogleMap Module ] : This module enables GoogleMap support in the program. It will put a person's events on a map from Google.

;[https://sourceforge.net/project/downloading.php?group_id=55456&filename=PGV-Module-research_assistant-{{latest version|series=4.2.x}}.zip Research Assistant Module ] : This module enables the a research assistant tool in PGV. This tool is designed to help you with your genealogical research. It provides a way to manage and track research tasks as well as the ability to quickly enter data from sources such as census forms.

;[https://sourceforge.net/project/downloading.php?group_id=55456&filename=PGV-Module-Module-lightbox-{{latest version|series=4.2.x}}.zip Lightbox Module ] : This module enables an alternate way to experience media in PhpGedView. It provides an "Album" tab on the individual page, media slideshows, and other media enhancements.

;[https://sourceforge.net/project/downloading.php?group_id=55456&filename=PGV-Module-gallery2-{{latest version|series=4.2.x}}.zip Gallery Module ] : This module enables support and integration with the Gallery project.

;[https://sourceforge.net/project/downloading.php?group_id=55456&filename=PGV-Module-punbb-{{latest version|series=4.2.x}}.zip PunBB Module ] : This module enables support and integration with the PunBB forum project. It will allow you to include message forums in your PGV site.

;[https://sourceforge.net/project/downloading.php?group_id=55456&filename=PGV-Module-phpsysinfo-{{latest version|series=4.2.x}}.zip PhpSysInfo Module ] : This module enables support and integration with the PhpSysInfo project.

;[https://sourceforge.net/project/downloading.php?group_id=55456&filename=PGV-Module-sitemap-{{latest version|series=4.2.x}}.zip Sitemap Module ] : This module enables a site map useful for crawlers and search engines.

==Source Repositories==
You can also obtain the files from one of the following source repositories

===Subversion v4.2+===
You can also get the latest bug fixes from the main trunk of the subversion repository. Code in the [[SVN]] repository can be considered Release Candidate quality.

If you would like to try out the latest features or help to beta test new versions, then you can get the latest development code from the 4.2 branch of the Subversion repository. Code in any branches of the repository should be considered alpha/beta quality and is not recommended for production environments.

The following SVN command will get you the latest code:

export LC_ALL=en_US
svn co https://phpgedview.svn.sourceforge.net/svnroot/phpgedview/trunk/phpGedView phpgedview

You can find out more information and browse the SVN repostory online at this location https://sourceforge.net/svn/?group_id=55456

[[Category:PhpGedView]]

Developers Guide

2010-11-30T23:23:55Z

Yalnifj:

[[Image:phpgedview.png|centre|]]
This is an annotated list of articles that comprise a '''Developer's Guide'''.

These are many of the original development resources on the [http://www.phpgedview.net/devdocs/ PhpGedView website Dev Docs section].

=Mashups=
* [[Mashups]] - Information on using PhpGedView mashups in other pages

=Setting Up a Development Environment=

If you want to help develop PhpGedView you will need to set up a development environment. Here are some guides to the sets required to do this:

* [[Installing PHP on Windows]]
* [[Installing MySQL on Windows]]
* [[Installing Eclipse on Windows]]
* [[Installing PhpGedView for Development]]

=Developer Tutorials and APIs=
;[[Developers Guide:Getting Started Tutorial|Getting Started Tutorial]] :A tutorial which will walk you through how to get started developing for PhpGedView.
;[http://www.phpgedview.net/devdocs/api/ Full Project API (PHPDoc)] :Details the full API in PHPDoc format for the entire project.
;[[Developers Guide:Editing API|Editing API]] :Describes the function calls for editing data in PhpGedView.
;[[Developers Guide:Creating a Module|Creating a Module]] :Describes how to create a basic module including menu for PGV
;[[Developers Guide:PGV Variables|PGV Variables]] :Variables available to modules
;[[Developers Guide:Translation and Internationalization|Translation and Internationalization]] :Describes how to use the language translation and internationalization features of PhpGedView.
;[[Developers Guide:Model-View-Controller Architecture|Model-View-Controller Architecture]] :Describes how PhpGedView uses the MVC pattern.
;[[Developers Guide:Commenting and Code Style|Commenting and Code Style]] :Describes the commenting practices for PhpGedView and the code formatting and style.
;[[Developers Guide:Language and text styles for Help screens|Language and text styles for Help screens]] :Provides some basic rules and guidelines for the presentation of Help text.
;[[GEDCOM SOAP Web Service API]] :Information on access PhpGedView data through a SOAP based web service.
;[[GEDCOM REST Web Service API]] :Information on access PhpGedView data through a REST based web service.

=Internal data structures=
;[[Developers Guide:Data Model|Data Model]] :The classes and objects which make up the PhpGedView data model.
;[[Developers Guide:Global Arrays|Global Arrays]] :A list describing all arrays used in the core data model.

=Report formats=
;PhpGedView [[Developers Guide:XML Report Templates|XML Report Templates]] :This page describes the PhpGedView XML report templates and provides information on how you can create your own reports

=Testing=
Testing, and frequent testing is important to the development and uptake of PhpGedView. Testing helps to minimise the occurrence of bugs as well as help stopping them from resurfacing at a later date.

[[SimpleTest]] can be used to write unit tests of classes.

==GEDCOM==
The [http://www.geditcom.com/gedcom.html GEDCOM 5.5 Torture Test Files] are valid but odd and confusing GEDCOMs that are useful in debugging problems with PhpGedView. It would be great if developers who made changes to PhpGedView to accommodate uncommon and weird GEDCOMs that are valid, update this file so that it can help other applications improve their GEDCOM support.

TODO: have a publicly available PhpGedView install that uses the Torture Test GEDCOM for testing. The PhpGedView modified GEDCOM should be submitted back to the author of the test. See [https://sourceforge.net/tracker/?func=detail&atid=634867&aid=1404488&group_id=55456]

==CSS==
There is a lot of optimization needed in the CSS code being used in PhpGedView. Many classes are redundant and a lot of streamlining is needed.

The [http://www.cssoptimiser.com|Online CSS Optimizer] can be used to reduce the size of the CSS files prior to a release. We should keep the original as is, and run them through this free online tool before release to greatly reduce the size of the files. Keeping the newlines option in the tool, will allow developers to still read the CSS and get ideas for better optimization (though it might not be in a format that we want to keep).

Another available tool is [http://cdburnerxp.se/cssparse/css_optimiser.php|CSS Formatter and Optimiser].

=Working with SVN=
; [[SVN]]
: An article detailing working with SVN.
; [[Developers Guide:Merging Branches|Merging Branches]]
: Describes the process for merging SVN branches in the PhpGedView project.


[[Category:Developers Guide]]
[[Category:phpGedView]]

[[fr:Guide du développeur]]

Getting Started Tutorial

2009-04-15T20:08:30Z

Yalnifj: /* Children */

Before starting this development tutorial, make sure that you have PhpGedView installed and running and that you have a way to edit PHP files.

This tutorial also assumes that you are familiar with PHP and are comfortable working with it.

==File Structure==
As a general rule, all pages which can be navigated to in a browser should be located in the root PhpGedView directory. Other directories contain function libraries or other supporting files.

==Basic Example==
Let's start by creating a basic example page that will give us the essential elements that are necessary for working on PhpGedView.

===PhpGedView Environment===
One of the first things you should do is load up the PhpGedView environment. The PhpGedView environment includes all of the functions, classes, and configuration settings for developing a page in PhpGedView. To load up the environment all you need to do is require the ''config.php'' file.
require_once('config.php');

Including the config file starts a chain reaction which loads up several other files:
* config.php loads includes/session.php
* session.php loads includes/functions.php
* session.php loads includes/functions_db.php
* session.php loads includes/functions_print.php
* session.php loads the index/gedcoms.php file which has all of the GEDCOMS defined
* session.php loads the specified GEDCOM's configuration and privacy files.
* session.php loads language files
* session.php loads the theme settings
* other files such as functions_date and functions_mediadb will also be loaded if configuration settings require the funtionality in them

===Headers and Footers===
With the environment loaded you can easily get the headers and footers which include the menus, favorites, and other links generally listed at the top of the page. To load the header, you use the print_header function. There is also a corresponding print_footer function. These functions are declared in the functions_print.php file and they include header and footer files from the themes to generate the basic PhpGedView page layout.

The follow code shows a basic page which loads up the environment, prints the header, does some basic HTML, and then prints the footer.
<?php

require_once('config.php');

print_header('My Page Title');

//-- do my stuff here

print_footer();
?>

===Accessing Data===
The simplest way to access data is through the object data model as it provides convenience when working with the data and automatically applies privacy rules. You can access information about a person through the Person object defined in the includes/person_class.php file. The constructor for the object takes a GEDCOM INDI record, but the easiest way to get a reference to a Person object is through the Person::getInstance() static singleton method. This method allows for objects to be cached and reused throughout the application. The following code shows an example of how to obtain a person object:
include_once('includes/person_class.php');
$person = Person::getInstance('I1');

The Person object has many convenience methods for working with the data. The next example shows a full page that displays a person's name and birth information:
<?php
require_once('config.php');
include_once('includes/person_class.php');

print_header('My Page Title');

$person = Person::getInstance('I1');
print '<h2>'.$person->getFullName()."</h2>\n";
print $factarray['BIRT'].': '.$person->getBirthDate()->Display().' '.$person->getBirthPlace()."<br />\n";

print_footer();
?>

====GEDCOM Data====
All GEDCOM data should be stored in the UTF-8 character encoding. Because data is entered by users, even though it is encoded correctly in may render incorrectly and there are times when some cleanup work needs to be done. So the general rule is that anything printed to the page from GEDCOM data should be run through the PrintReady() function. Among other things, the PrintReady() function ensures that the data is prepared to be printed for that particular language. So continuing our example again, the final code for this example would look like this:
<?php
require_once('config.php');
include_once('includes/person_class.php');

print_header($pgv_lang['individual_title']);

$person = Person::getInstance('I1');
print '<h2>'.$person->getFullName()."</h2>\n";
print $factarray['BIRT'].': '.$person->getBirthDate()->Display();
print ' '.PrintReady($person->getBirthPlace())."<br />\n";

print_footer();
?>

==Walking the Tree==
From the person object we can also walk the tree by referencing his/her parents and children. People are linked together through Family objects. The Family class is defined in the 'includes/family_class.php' file.

The core methods of the family class are:
getHusband()
getWife()
getChilren()

===Parents===
To reference a person's parents we first need to get a reference to a Family object where that person is a child. Due to adoption and other similar circumstances a person may have more than one family where they were a child. The getChildFamilies() method of the Person object will return an array of the families where this person is a child.

Let's add the person's parents to our example code:
<?php
require_once('config.php');
include_once('includes/person_class.php');

print_header($pgv_lang['individual_title']);

$person = Person::getInstance('I1');
print '<h2>'.$person->getFullName()."</h2>\n";
print $factarray['BIRT'].': '.$person->getBirthDate()->Display();
print ' '.PrintReady($person->getBirthPlace())."<br />\n";

print '<h3>'.$pgv_lang['parents']."</h3>\n";
$fams = $person->getChildFamilies();
foreach($fams as $famid=>$family) {
$father = $family->getHusband();
if (!is_null($father)) print PrintReady($father->getFullName())." + ";
$mother = $family->getWife();
if (!is_null($mother)) print PrintReady($mother->getFullName());
}
print_footer();
?>

===Children===
To reference a person's children we first need to get a reference to a Family object where that person is a spouse. Due to multiple marriages and other similar circumstances a person may have more than one family where they were a spouse. The getSpouseFamilies() method of the Person object will return an array of the families where this person is a spouse.

Now let's add the person's children to our example code:
<?php
require_once('config.php');
include_once('includes/person_class.php');

print_header($pgv_lang['individual_title']);

//-- personal details
$person = Person::getInstance('I1');
print '<h2>'.$person->getFullName()."</h2>\n";
print $factarray['BIRT'].': '.$person->getBirthDate()->Display();
print ' '.PrintReady($person->getBirthPlace())."<br />\n";

//-- parents
print '<h3>'.$pgv_lang['parents']."</h3>\n";
$fams = $person->getChildFamilies();
foreach($fams as $famid=>$family) {
$father = $family->getHusband();
if (!is_null($father)) print PrintReady($father->getFullName())." + ";
$mother = $family->getWife();
if (!is_null($mother)) print PrintReady($mother->getFullName());
print "<br />\n";
}

//-- children
print '<h3>'.$pgv_lang['children']."</h3>\n";
$fams = $person->getSpouseFamilies();
foreach($fams as $famid=>$family) {
$children= $family->getChildren();
foreach($children as $childid=>$child) {
if (!is_null($child)) print PrintReady($child->getFullName())."<br />\n";
}
}

print_footer();
?>

==Working with raw GEDCOM==
The Person, Family, and other objects are the preferred way to work with the genealogy data. These objects provide automatic caching, privacy filters, and remote linking. But if you want you can work with the raw GEDCOM data. (You will find that many of the existing pages use the raw GEDCOM APIs because those pages were written before the object oriented API existed.)

===Obtaining GEDCOM records===
The GEDCOM records are stored in the DB, but you don't have to write the SQL queries yourself to obtain the records. To get a person record you can use the function find_person_record() or the more generic find_gedcom_record(). There are similar find* functions for families, sources, media, and repositories.

Once you have a raw GEDCOM record you can obtain any data from it using the get_gedcom_value() function. The following example shows how you would get the birthdate for person I1.

<?php
require_once('config.php');

$indirec = find_person_record('I1');
$birthdate = get_gedcom_value('BIRT:DATE', 1, $indirec);
print get_changed_date($birthdate);

?>

The first parameter is a colon : separated list of GEDCOM tags in the GEDCOM hierarchy. So in this example BIRT:DATE references the first DATE record under the first BIRT record. The second parameter is the level of the first GEDCOM tag, 1 in this case. The third parameter is the raw GEDCOM record you want to search in.

When working with the raw GEDCOM data, none of it will have been privatized so you must check for privacy before displaying the data. Refer to the functions in the 'includes/functions_privacy.php' file for the privacy function APIs.

[[Category:Developers Guide]]

Mashups

2008-10-07T23:47:39Z

Yalnifj:

[[Image:phpgedview.png|centre|]]
==Embedding PhpGedView Features in Mashups==

"Mashing" or "Mashups" is the process of embedding content from other sites into your site. PhpGedView allows you to embed some its features in other web sites.

===Interactive Tree===
To embed an interactive tree from a PhpGedView site, you can modify the following line of code and paste it into your site:
<script type="text/javascript" src="http://yourserver/phpgedview/treenav.php?navAjax=embed&rootid=I14&width=400&height=300"></script>

The following parameters can be specified:
* navAjax=embed - Required in order for the tree to be embedded
* rootid - the ID of the person to start the tree at, the default is the default pedigree root id.
* width - the width of the tree's viewport
* height - the height of the tree's viewport
* ged - the name of the GEDCOM to view

Installing PHP on Windows

2008-01-22T23:22:40Z

Yalnifj: /* Getting PHP */

This document will help you to get PHP installed on Windows and running in your web server.

== Getting PHP ==
# Download the binary MSI or ZIP package of the latest PHP release from http://www.php.net/downloads.php
# If you install PHP from the MSI installer, make sure you select to install the GD2 and the MySQL extensions.
# If you don't use the installer then you will need to extract the ZIP to C:\PHP
# To run PhpGedView, we need to enable some optional extensions:
## From the C:\PHP\ext directory copy the following files up one level into the C:\PHP directory
##* php_gd2.dll
##* php_mysql.dll (Only if you are using PHP 5)
##* php_mssql.dll (If you want to run PHP with MS SQL Server)
## Edit the php.ini file: If php.ini does not exist then copy the php.ini-dist file to php.ini
### To uncomment a line, remove any leading semicolons from that line.
### Uncomment the line ''extension=php_gd2.dll''
### For PHP 5, uncomment the line ''extension=php_mysql.dll''
### For SQL Server support, uncomment ''extension=php_mssql.dll''
### If installing in IIS using CGI mode as described below, change the line '';cgi.force_redirect = 1'' to ''cgi.force_redirect = 0''. Note that the line has been uncommented as well as edited.
### Sometimes when running PHP in CGI mode on IIS you will get a "threads exited" error at the bottom of the page. This is a bug in the latest libmysql.dll that comes with PHP. You will need to replace this DLL with one from an older version of PHP 5.2.1 or with one from the mysql directory.
# The latest versions of PHP come with display_errors in the php.ini set to off which will likely cause you not to see any errors during your development. You probably want to set display_errors = On.

== Enable PHP in your Web server ==
=== Enabling PHP in IIS ===
# Modify the Windows PATH environment variable to include the PHP directory. This way the PHP DLL files, PHP executables, and php.ini can all remain in the PHP directory without cluttering up the Windows system directory. Control Panel -> System -> Advanced tab -> Environment Variables
# Associate IIS with PHP
## Open the ''Internet Information Services Manager''
## Open the ''Control Panel'', open ''Administrative Tools'', and then open ''Internet Information Services''
## Expand the tree on the left until you see ''Default Web Site''. Right click on ''Default Web Site'' and choose ''Properties''
## Under the ''Home Directory'' tab, set the ''Execute Permissions'' setting to ''Scripts only''
## Click on the 'Configuration' button, and choose the Application Mappings tab.
## Click Add and set the Executable path to the c:\php\php-cgi.exe. Supply .php as the extension. Check the 'Script engine' checkbox. Now, click OK a few times until you get back to the ''Home Directory'' tab.
## Switch to the ''Documents'' tab and add ''index.php'' to the list of Default Documents.
## Click OK
# Stop and start the ''Default Web Site''
## Right-click the ''Default Web Site'', and click stop
## Right-click the ''Default Web Site'', and click start
# For more detailed instructions, see the ''install.txt'' file in the C:\php directory.

=== Enabling PHP in Apache 2 ===
# Edit the httpd.conf file and add the following lines:
# For PHP 5 do something like this:
LoadModule php5_module "c:/php/php5apache2.dll"
AddType application/x-httpd-php .php

# configure the path to php.ini
PHPIniDir "C:/php"
# Add index.php to the DirectoryIndex
DirectoryIndex index.html index.html.var index.php
# Stop and start the apache service
# For more detailed instructions, see the install.txt file in the C:\php directory.

=== Test your PHP installation ===
# Go to your web document root.
#* Should be ''C:\inetpub\wwwroot'' for IIS
#* Should be ''C:\Program Files\Apache Software Foundation\Apache 2\htdocs'' for Apache 2
# Create a new text file named '''phpinfo.php''' and put the following line of code in it:<br /><tt><?php phpinfo(); ?></tt>
# Open a web browser and go to http://localhost/phpinfo.php. You should see a long page detailing your PHP configuration. [[Image:Clipboard01.png]]
# Scroll down the page and make sure that you find a section on '''gd''', '''mysql''' or '''mssql'''. If you don't see these sections, then go back and check you php.ini file again.


[[Category:Developers Guide]]
[[Category:phpGedView]]

File:Downloadcart.jpg

2007-10-22T19:02:01Z

Yalnifj:

File:Addchildrentocart.jpg

2007-10-22T19:01:41Z

Yalnifj:

File:Addbyid.jpg

2007-10-22T17:47:39Z

Yalnifj:

File:Cartexample.jpg

2007-10-22T17:47:25Z

Yalnifj:

File:Addparentstocart.jpg

2007-10-22T17:47:14Z

Yalnifj:

File:Addtocart.jpg

2007-10-22T17:46:58Z

Yalnifj:

File:Clickname.jpg

2007-10-22T17:46:44Z

Yalnifj:

File:Editname.jpg

2007-07-06T14:42:40Z

Yalnifj:

File:Addrelatives.jpg

2007-07-06T14:42:23Z

Yalnifj:

File:Addfather.jpg

2007-07-06T14:41:56Z

Yalnifj:

File:Basicexample.png

2006-10-13T23:12:46Z

Yalnifj:

File:Clipboard02.png

2006-10-09T19:59:13Z

Yalnifj: Image of IIS manager with Default Web Site expanded

Image of IIS manager with Default Web Site expanded

File:Clipboard01.png

2006-10-09T17:15:27Z

Yalnifj: Screenshot of a successfully rendered PHPInfo Page

Screenshot of a successfully rendered PHPInfo Page