PHP Class Fisharebest\Webtrees\Functions\FunctionsPrintLists

显示文件 Open project: fisharebest/webtrees Class Usage Examples

Public Methods

Method	Description
chartByAge ( int[] $data, string $title ) : string	Print a chart by age using Google chart API
chartByDecade ( int[] $data, string $title ) : string	Print a chart by decade using Google chart API
eventsList ( integer $startjd, integer $endjd, string $events = 'BIRT MARR DEAT', boolean $only_living = false, string $sort_by = 'anniv' ) : string	Print a list of events
eventsTable ( integer $startjd, integer $endjd, string $events = 'BIRT MARR DEAT', boolean $only_living = false, string $sort_by = 'anniv' ) : string	Print a table of events
familyTable ( Fisharebest\Webtrees\Family[] $families ) : string	Print a table of families
individualTable ( Fisharebest\Webtrees\Individual[] $indiviudals, string $option = '' ) : string	Print a table of individuals
mediaTable ( Fisharebest\Webtrees\Media[] $media_objects ) : string	Print a table of media objects
noteTable ( Fisharebest\Webtrees\Note[] $notes ) : string	Print a table of shared notes
repositoryTable ( Fisharebest\Webtrees\Repository[] $repositories ) : string	Print a table of repositories
sourceTable ( Fisharebest\Webtrees\Source[] $sources ) : string	Print a table of sources
surnameList ( string[][] $surnames, integer $style, boolean $totals, string $script, Fisharebest\Webtrees\Tree $tree ) : string	Print a list of surnames.
surnameTable ( string[][] $surnames, string $script, Fisharebest\Webtrees\Tree $tree ) : string	Print a table of surnames, for the top surnames block, the indi/fam lists, etc.
surnameTagCloud ( string[][] $surnames, string $script, boolean $totals, Fisharebest\Webtrees\Tree $tree ) : string	Print a tagcloud of surnames.

Private Methods

Method	Description
sortableNames ( Fisharebest\Webtrees\Individual $individual ) : string[]	Generate a SURN,GIVN and GIVN,SURN sortable name for an individual.

Method Details

chartByAge() public static method

Print a chart by age using Google chart API

public static chartByAge ( int[] $data, string $title ) : string
$data	int[]
$title	string
return	string

chartByDecade() public static method

Print a chart by decade using Google chart API

public static chartByDecade ( int[] $data, string $title ) : string
$data	int[]
$title	string
return	string

eventsList() public static method

This performs the same function as print_events_table(), but formats the output differently.

public static eventsList ( integer $startjd, integer $endjd, string $events = 'BIRT MARR DEAT', boolean $only_living = false, string $sort_by = 'anniv' ) : string
$startjd	integer
$endjd	integer
$events	string
$only_living	boolean
$sort_by	string
return	string

eventsTable() public static method

Print a table of events

public static eventsTable ( integer $startjd, integer $endjd, string $events = 'BIRT MARR DEAT', boolean $only_living = false, string $sort_by = 'anniv' ) : string
$startjd	integer
$endjd	integer
$events	string
$only_living	boolean
$sort_by	string
return	string

familyTable() public static method

Print a table of families

public static familyTable ( Fisharebest\Webtrees\Family[] $families ) : string
$families	Fisharebest\Webtrees\Family[]
return	string

individualTable() public static method

Print a table of individuals

public static individualTable ( Fisharebest\Webtrees\Individual[] $indiviudals, string $option = '' ) : string
$indiviudals	Fisharebest\Webtrees\Individual[]
$option	string
return	string

mediaTable() public static method

Print a table of media objects

public static mediaTable ( Fisharebest\Webtrees\Media[] $media_objects ) : string
$media_objects	Fisharebest\Webtrees\Media[]
return	string

noteTable() public static method

Print a table of shared notes

public static noteTable ( Fisharebest\Webtrees\Note[] $notes ) : string
$notes	Fisharebest\Webtrees\Note[]
return	string

repositoryTable() public static method

Print a table of repositories

public static repositoryTable ( Fisharebest\Webtrees\Repository[] $repositories ) : string
$repositories	Fisharebest\Webtrees\Repository[]
return	string

sourceTable() public static method

Print a table of sources

public static sourceTable ( Fisharebest\Webtrees\Source[] $sources ) : string
$sources	Fisharebest\Webtrees\Source[]
return	string

surnameList() public static method

Print a list of surnames.

public static surnameList ( string[][] $surnames, integer $style, boolean $totals, string $script, Fisharebest\Webtrees\Tree $tree ) : string
$surnames	string[][]	array (of SURN, of array of SPFX_SURN, of array of PID)
$style	integer	1=bullet list, 2=semicolon-separated list, 3=tabulated list with up to 4 columns
$totals	boolean	show totals after each name
$script	string	indilist or famlist
$tree	Fisharebest\Webtrees\Tree	Link back to the individual list in this tree
return	string

surnameTable() public static method

Print a table of surnames, for the top surnames block, the indi/fam lists, etc.

public static surnameTable ( string[][] $surnames, string $script, Fisharebest\Webtrees\Tree $tree ) : string
$surnames	string[][]	array (of SURN, of array of SPFX_SURN, of array of PID)
$script	string	"indilist.php" (counts of individuals) or "famlist.php" (counts of spouses)
$tree	Fisharebest\Webtrees\Tree	generate links for this tree
return	string

surnameTagCloud() public static method

Print a tagcloud of surnames.

public static surnameTagCloud ( string[][] $surnames, string $script, boolean $totals, Fisharebest\Webtrees\Tree $tree ) : string
$surnames	string[][]	array (of SURN, of array of SPFX_SURN, of array of PID)
$script	string	indilist or famlist
$totals	boolean	show totals after each name
$tree	Fisharebest\Webtrees\Tree	generate links to this tree
return	string