Citation::getCitTypeText

Up: class Citation

This method returns a character string identifying the event or fact that the idime value refers to:

    $typeText           = $citation->getCitTypeText();

Note: This method is obsolete. Its functionality has been moved to the I18N translation table.

    $translate         = $template->getTranslate();
    $citTrans          = $translate['typeText'];
    $typeText          = $citTrans[$citation->getCitType()];

For example if the end-user has requested the use of German and a citation with type STYPE_DEATH is being handled $citation->getCitTypeText() returns 'Death' while $citTrans[$citation->getCitType()] returns 'Todesereignis''.

The return value is one of the following:

defined constant	value	returned string
	null	'null'
	<0	'temporary'
STYPE_UNSPECIFIED	0	'Unspecified'
STYPE_NAME	1	'Name'
STYPE_BIRTH	2	'Birth'
STYPE_CHRISTEN	3	'Christening'
STYPE_DEATH	4	'Death'
STYPE_BURIED	5	'Buried'
STYPE_NOTESGENERAL	6	'General Notes'
STYPE_NOTESRESEARCH	7	'Research Notes'
STYPE_NOTESMEDICAL	8	'Medical Notes'
STYPE_DEATHCAUSE	9	'Death Cause'
STYPE_ALTNAME	10	'Alternate Name'
STYPE_CHILDSTATUS	11	'Child Status'
STYPE_CPRELDAD	12	'Child Relationship to Dad'
STYPE_CPRELMOM	13	'Child Relationship to Mom'
STYPE_LDSB	15	'LDS Baptism'
STYPE_LDSE	16	'LDS Endowment'
STYPE_LDSP	17	'LDS Sealed to Parents'
STYPE_LDSS	18	'LDS Sealed to Spouse'
STYPE_NEVERMARRIED	19	'Never Married'
STYPE_MAR	20	'Marriage'
STYPE_MARNOTE	21	'Marriage Note'
STYPE_MARNEVER	22	'Marriage Never'
STYPE_MARNOKIDS	23	'Marriage No Children'
STYPE_MAREND	24	'Marriage Ended'
STYPE_LDSC	26	'LDS Confirmation'
STYPE_LDSI	27	'LDS Initiatory'
STYPE_EVENT	30	'Event'
STYPE_MAREVENT	31	'Marriage Event'
STYPE_CHILDEVENT	32	'Child Event'
STYPE_TODO	40	'To Do'
	otherwise	'undefined <decimal value>'

Next: $citation->getDetail()