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 Rel

A collection of rel links to assist in looking up resource links. When a resource is consumed, it typically returns a set of hypermedia links that enable additional actions on the resource. While resources typically provide links, not all links will be available on a given resource (such as paging links on a person resource). The links exposed in this class are a set of predefined constants, which can be used to determine if a link is available on a given resource.

Direct known subclasses

Gedcomx\Extensions\FamilySearch\Rs\Client\Rel

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

Constants summary

string SELF

The link that points to oneself.

The link that points to oneself.
# "self"
string NEXT

A link that points to the next item, such as in a collection or result set.

A link that points to the next item, such as in a collection or result set.
# "next"
string PREV

A link that points to the previous item, such as in a collection or result set.

A link that points to the previous item, such as in a collection or result set.
# "prev"
PREVIOUS

A link that points to the previous item, such as in a collection or result set.

A link that points to the previous item, such as in a collection or result set.
# Gedcomx\Rs\Client\Rel::PREV
string FIRST

A link that points to the first item, such as in a collection or result set.

A link that points to the first item, such as in a collection or result set.
# "first"
string LAST

A link that points to the last item, such as in a collection or result set.

A link that points to the last item, such as in a collection or result set.
# "last"
string AGENT

A link that points to the agent resource.

A link that points to the agent resource.
# "agent"
string ANCESTRY

A link that points to the ancestry resource.

A link that points to the ancestry resource.
# "ancestry"
string ARTIFACTS

A link that points to the artifacts resource.

A link that points to the artifacts resource.
# "artifacts"
string CHILDREN

A link that points to the children resource.

A link that points to the children resource.
# "children"
string CHILD_RELATIONSHIPS

A link that points to the child relationships resource.

A link that points to the child relationships resource.
# "child-relationships"
string COLLECTION

A link that points to the collection resource.

A link that points to the collection resource.
# "collection"
string SUBCOLLECTIONS

A link that points to the subcollections resource.

A link that points to the subcollections resource.
# "subcollections"
string CONCLUSION

A link that points to the conclusion resource.

A link that points to the conclusion resource.
# "conclusion"
string CONCLUSIONS

A link that points to the conclusions resource.

A link that points to the conclusions resource.
# "conclusions"
string CURRENT_USER_PERSON

A link that points to the current user person resource.

A link that points to the current user person resource.
# "current-user-person"
string CURRENT_USER_RESOURCES

A link that points to the current user resources resource.

A link that points to the current user resources resource.
# "current-user-resources"
string DESCENDANCY

A link that points to the descendancy resource.

A link that points to the descendancy resource.
# "descendancy"
string DESCRIPTION

A link that points to the description resource.

A link that points to the description resource.
# "description"
string EVIDENCE_REFERENCE

A link that points to the evidence reference resource.

A link that points to the evidence reference resource.
# "evidence-reference"
string EVIDENCE_REFERENCES

A link that points to the evidence references resource.

A link that points to the evidence references resource.
# "evidence-references"
string IMAGE_RECORDS

A link that points to the image records resource.

A link that points to the image records resource.
# "image-records"
string MATCHES

A link that points to the matches resource.

A link that points to the matches resource.
# "matches"
string MEDIA_REFERENCE

A link that points to the media reference resource.

A link that points to the media reference resource.
# "media-reference"
string MEDIA_REFERENCES

A link that points to the media references resource.

A link that points to the media references resource.
# "media-references"
string NOTE

A link that points to the note resource.

A link that points to the note resource.
# "note"
string NOTES

A link that points to the notes resource.

A link that points to the notes resource.
# "notes"
string OAUTH2_AUTHORIZE

A link that points to the OAuth2 authorization resource.

A link that points to the OAuth2 authorization resource.
# "http://oauth.net/core/2.0/endpoint/authorize"
string OAUTH2_TOKEN

A link that points to the OAuth2 token resource.

A link that points to the OAuth2 token resource.
# "http://oauth.net/core/2.0/endpoint/token"
string PARENT_RELATIONSHIPS

A link that points to the parent relationships resource.

A link that points to the parent relationships resource.
# "parent-relationships"
string PARENTS

A link that points to the parents resource.

A link that points to the parents resource.
# "parents"
string PERSON1

A link that points to the person1 resource.

A link that points to the person1 resource.
# "person1"
string PERSON2

A link that points to the person2 resource.

A link that points to the person2 resource.
# "person2"
string PERSON

A link that points to the person resource.

A link that points to the person resource.
# "person"
string PERSONS

A link that points to the persons resource.

A link that points to the persons resource.
# "persons"
string PERSON_SEARCH

A link that points to the person search resource.

A link that points to the person search resource.
# "person-search"
string PLACE

A link that points to the place resource.

A link that points to the place resource.
# "place"
string PLACE_SEARCH

A link that points to the place search resource.

A link that points to the place search resource.
# "place-search"
string PLACE_TYPE_GROUPS

The A link that points to the place type groups resource.

The A link that points to the place type groups resource.
# "place-type-groups"
string PLACE_TYPE_GROUP

A link that points to the place type group resource.

A link that points to the place type group resource.
# "place-type-group"
string PLACE_TYPES

A link that points to the place types resource.

A link that points to the place types resource.
# "place-types"
string PLACE_TYPE

A link that points to the place type resource.

A link that points to the place type resource.
# "place-type"
string PLACE_GROUP

A link that points to the place group resource.

A link that points to the place group resource.
# "place-group"
string PLACE_DESCRIPTION

A link that points to the place description resource.

A link that points to the place description resource.
# "place-description"
string PROFILE

A link that points to the profile resource.

A link that points to the profile resource.
# "profile"
string RECORD

A link that points to the record resource.

A link that points to the record resource.
# "record"
string RECORDS

A link that points to the records resource.

A link that points to the records resource.
# "records"
string RELATIONSHIP

A link that points to the relationship resource.

A link that points to the relationship resource.
# "relationship"
string RELATIONSHIPS

A link that points to the relationships resource.

A link that points to the relationships resource.
# "relationships"
string SOURCE_DESCRIPTIONS

A link that points to the source descriptions resource.

A link that points to the source descriptions resource.
# "source-descriptions"
string SOURCE_REFERENCE

A link that points to the source reference resource.

A link that points to the source reference resource.
# "source-reference"
string SOURCE_REFERENCES

A link that points to the source references resource.

A link that points to the source references resource.
# "source-references"
string SOURCE_REFERENCES_QUERY

A link that points to the source references query resource.

A link that points to the source references query resource.
# "source-references-query"
string SPOUSES

A link that points to the spouses resource.

A link that points to the spouses resource.
# "spouses"
string SPOUSE_RELATIONSHIPS

A link that points to the spouse relationships resource.

A link that points to the spouse relationships resource.
# "spouse-relationships"
string DISCUSSION_REFERENCE

A link that points to the discussion reference resource.

A link that points to the discussion reference resource.
# "discussion-reference"
string DISCUSSION_REFERENCES

A link that points to the discussion references resource.

A link that points to the discussion references resource.
# "discussion-references"
gedcomx-php-client API documentation generated by ApiGen