gedcomx-php-client
  • Namespace
  • Class

Namespaces

  • Gedcomx
    • Agent
    • Atom
    • Common
    • Conclusion
    • Extensions
      • FamilySearch
        • Platform
          • Artifacts
          • Discussions
          • Tree
          • Users
        • Rs
          • Client
            • FamilyTree
            • Helpers
            • Memories
            • Util
        • Rt
        • Types
    • GedcomxFile
    • Links
    • Records
    • Rs
      • Client
        • Exception
        • Options
        • Util
    • Rt
    • Search
    • Source
    • Support
    • Types
    • Util
    • Vocab

Classes

  • AgentState
  • AncestryResultsState
  • CollectionsState
  • CollectionState
  • DescendancyResultsState
  • GedcomxApplicationState
  • GedcomxSearchQuery
  • PersonChildrenState
  • PersonParentsState
  • PersonSearchResultsState
  • PersonSpousesState
  • PersonsState
  • PersonState
  • PlaceDescriptionsState
  • PlaceDescriptionState
  • PlaceGroupState
  • PlaceSearchResultsState
  • RecordsState
  • RecordState
  • Rel
  • RelationshipsState
  • RelationshipState
  • SearchParameter
  • SourceDescriptionsState
  • SourceDescriptionState
  • StateFactory
  • VocabConstants
  • VocabElementListState
  • VocabElementState

Interfaces

  • SupportsExtensionElements

Class GedcomxSearchQuery

This is a helper utility for building syntactically correct person search query strings.

Class GedcomxSearchQuery

Namespace: Gedcomx\Rs\Client
Package: Gedcomx\Rs\Client
Located at Rs/Client/GedcomxSearchQuery.php

Methods summary

public string
# __toString( )

Builds the query string to use for searching.

Builds the query string to use for searching.

Returns

string
public Gedcomx\Rs\Client\GedcomxSearchQuery
# param( string $name, string $value = null, boolean $exact = false )

Creates a generic search parameter with the specified name and value. The parameter is added to the array of current parameters and $this is returned.

Creates a generic search parameter with the specified name and value. The parameter is added to the array of current parameters and $this is returned.

Parameters

$name
$value
$exact

Returns

Gedcomx\Rs\Client\GedcomxSearchQuery
$this

Constants summary

string NAME

The name parameter in person search queries

The name parameter in person search queries
# "name"
string GIVEN_NAME

The given name parameter in person search queries

The given name parameter in person search queries
# "givenName"
string SURNAME

The surname parameter in person search queries

The surname parameter in person search queries
# "surname"
string GENDER

The gender parameter in person search queries

The gender parameter in person search queries
# "gender"
string BIRTH_DATE

The birth date parameter in person search queries

The birth date parameter in person search queries
# "birthDate"
string BIRTH_PLACE

The birth place parameter in person search queries

The birth place parameter in person search queries
# "birthPlace"
string DEATH_DATE

The death date parameter in person search queries

The death date parameter in person search queries
# "deathDate"
string DEATH_PLACE

The death place parameter in person search queries

The death place parameter in person search queries
# "deathPlace"
string MARRIAGE_DATE

The marriage date parameter in person search queries

The marriage date parameter in person search queries
# "marriageDate"
string MARRIAGE_PLACE

The marriage place parameter in person search queries

The marriage place parameter in person search queries
# "marriagePlace"
string FATHER_NAME

The father name parameter in person search queries

The father name parameter in person search queries
# "fatherName"
string FATHER_GIVEN_NAME

The father given name parameter in person search queries

The father given name parameter in person search queries
# "fatherGivenName"
string FATHER_SURNAME

The father surname parameter in person search queries

The father surname parameter in person search queries
# "fatherSurname"
string FATHER_GENDER

The father gender parameter in person search queries

The father gender parameter in person search queries
# "fatherGender"
string FATHER_BIRTH_DATE

The father birth date parameter in person search queries

The father birth date parameter in person search queries
# "fatherBirthDate"
string FATHER_BIRTH_PLACE

The father birth place parameter in person search queries

The father birth place parameter in person search queries
# "fatherBirthPlace"
string FATHER_DEATH_DATE

The father death date parameter in person search queries

The father death date parameter in person search queries
# "fatherDeathDate"
string FATHER_DEATH_PLACE

The father death place parameter in person search queries

The father death place parameter in person search queries
# "fatherDeathPlace"
string FATHER_MARRIAGE_DATE

The father marriage date parameter in person search queries

The father marriage date parameter in person search queries
# "fatherMarriageDate"
string FATHER_MARRIAGE_PLACE

The father marriage place parameter in person search queries

The father marriage place parameter in person search queries
# "fatherMarriagePlace"
string MOTHER_NAME

The mother name parameter in person search queries

The mother name parameter in person search queries
# "motherName"
string MOTHER_GIVEN_NAME

The mother given name parameter in person search queries

The mother given name parameter in person search queries
# "motherGivenName"
string MOTHER_SURNAME

The mother surname parameter in person search queries

The mother surname parameter in person search queries
# "motherSurname"
string MOTHER_GENDER

The mother gender parameter in person search queries

The mother gender parameter in person search queries
# "motherGender"
string MOTHER_BIRTH_DATE

The mother birth date parameter in person search queries

The mother birth date parameter in person search queries
# "motherBirthDate"
string MOTHER_BIRTH_PLACE

The mother birth place parameter in person search queries

The mother birth place parameter in person search queries
# "motherBirthPlace"
string MOTHER_DEATH_DATE

The mother death date parameter in person search queries

The mother death date parameter in person search queries
# "motherDeathDate"
string MOTHER_DEATH_PLACE

The mother death place parameter in person search queries

The mother death place parameter in person search queries
# "motherDeathPlace"
string MOTHER_MARRIAGE_DATE

The mother marriage date parameter in person search queries

The mother marriage date parameter in person search queries
# "motherMarriageDate"
string MOTHER_MARRIAGE_PLACE

The mother marriage place parameter in person search queries

The mother marriage place parameter in person search queries
# "motherMarriagePlace"
string SPOUSE_NAME

The spouse name parameter in person search queries

The spouse name parameter in person search queries
# "spouseName"
string SPOUSE_GIVEN_NAME

The spouse given name parameter in person search queries

The spouse given name parameter in person search queries
# "spouseGivenName"
string SPOUSE_SURNAME

The spouse surname parameter in person search queries

The spouse surname parameter in person search queries
# "spouseSurname"
string SPOUSE_GENDER

The spouse gender parameter in person search queries

The spouse gender parameter in person search queries
# "spouseGender"
string SPOUSE_BIRTH_DATE

The spouse birth date parameter in person search queries

The spouse birth date parameter in person search queries
# "spouseBirthDate"
string SPOUSE_BIRTH_PLACE

The spouse birth place parameter in person search queries

The spouse birth place parameter in person search queries
# "spouseBirthPlace"
string SPOUSE_DEATH_DATE

The spouse death date parameter in person search queries

The spouse death date parameter in person search queries
# "spouseDeathDate"
string SPOUSE_DEATH_PLACE

The spouse death place parameter in person search queries

The spouse death place parameter in person search queries
# "spouseDeathPlace"
string SPOUSE_MARRIAGE_DATE

The spouse marriage date parameter in person search queries

The spouse marriage date parameter in person search queries
# "spouseMarriageDate"
string SPOUSE_MARRIAGE_PLACE

The spouse marriage place parameter in person search queries

The spouse marriage place parameter in person search queries
# "spouseMarriagePlace"
string PARENT_NAME

The parent name parameter in person search queries

The parent name parameter in person search queries
# "parentName"
string PARENT_GIVEN_NAME

The parent given name parameter in person search queries

The parent given name parameter in person search queries
# "parentGivenName"
string PARENT_SURNAME

The parent surname parameter in person search queries

The parent surname parameter in person search queries
# "parentSurname"
string PARENT_GENDER

The parent gender parameter in person search queries

The parent gender parameter in person search queries
# "parentGender"
string PARENT_BIRTH_DATE

The parent birth date parameter in person search queries

The parent birth date parameter in person search queries
# "parentBirthDate"
string PARENT_BIRTH_PLACE

The parent birth place parameter in person search queries

The parent birth place parameter in person search queries
# "parentBirthPlace"
string PARENT_DEATH_DATE

The parent death date parameter in person search queries

The parent death date parameter in person search queries
# "parentDeathDate"
string PARENT_DEATH_PLACE

The parent death place parameter in person search queries

The parent death place parameter in person search queries
# "parentDeathPlace"
string PARENT_MARRIAGE_DATE

The parent marriage date parameter in person search queries

The parent marriage date parameter in person search queries
# "parentMarriageDate"
string PARENT_MARRIAGE_PLACE

The parent marriage place parameter in person search queries

The parent marriage place parameter in person search queries
# "parentMarriagePlace"
gedcomx-php-client API documentation generated by ApiGen