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 SearchParameter

Represents a generic search parameter.

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

Methods summary

public
# __construct( string $name, string $value, boolean $exact = false )

Constructs a new generic search parameter using the specified values.

Constructs a new generic search parameter using the specified values.

Parameters

$name
$value
$exact
public boolean
# getExact( )

Gets a value indicating whether the current search parameter requires exact value match results. See remarks.

Gets a value indicating whether the current search parameter requires exact value match results. See remarks.

Returns

boolean
public string
# getName( )

Gets the name of the current search parameter..

Gets the name of the current search parameter..

Returns

string
public string
# getValue( )

Gets the value of the current search parameter.

Gets the value of the current search parameter.

Returns

string
public string
# __toString( )

Returns a string that is a syntactically conformant search query that can be used in REST API search requests.

Returns a string that is a syntactically conformant search query that can be used in REST API search requests.

Returns

string
gedcomx-php-client API documentation generated by ApiGen