gedcomx-php
  • Namespace
  • Class

Namespaces

  • Gedcomx
    • Agent
    • Atom
    • Common
    • Conclusion
    • Extensions
      • FamilySearch
        • Platform
          • Artifacts
          • Discussions
          • Tree
          • Users
        • Rt
        • Types
    • GedcomxFile
    • Links
    • Records
    • Rt
    • Search
    • Source
    • Support
    • Types
    • Util
    • Vocab

Classes

  • HypermediaEnabledData
  • Link

Interfaces

  • SupportsLinks

Interface SupportsLinks

An interface declaring support for managing hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. Interface SupportsLinks

Direct known implementers

Gedcomx\Atom\Entry, Gedcomx\Links\HypermediaEnabledData

Indirect known implementers

Gedcomx\Agent\Agent, Gedcomx\Common\EvidenceReference, Gedcomx\Conclusion\Person, Gedcomx\Conclusion\PlaceDescription, Gedcomx\Conclusion\Relationship, Gedcomx\Conclusion\Subject, Gedcomx\Extensions\FamilySearch\FamilySearchPlatform, Gedcomx\Extensions\FamilySearch\Platform\Discussions\Comment, Gedcomx\Extensions\FamilySearch\Platform\Discussions\Discussion, Gedcomx\Extensions\FamilySearch\Platform\Tree\ChildAndParentsRelationship, Gedcomx\Extensions\FamilySearch\Platform\Tree\DiscussionReference, Gedcomx\Extensions\FamilySearch\Platform\Users\User, Gedcomx\Common\Note, Gedcomx\Gedcomx, Gedcomx\Records\Collection, Gedcomx\Records\CollectionContent, Gedcomx\Records\Field, Gedcomx\Records\FieldDescriptor, Gedcomx\Records\FieldValue, Gedcomx\Records\FieldValueDescriptor, Gedcomx\Records\RecordDescriptor, Gedcomx\Records\RecordSet, Gedcomx\Source\Coverage, Gedcomx\Conclusion\Conclusion, Gedcomx\Source\SourceCitation, Gedcomx\Source\SourceDescription, Gedcomx\Source\SourceReference, Gedcomx\Conclusion\Document, Gedcomx\Conclusion\Event, Gedcomx\Conclusion\EventRole, Gedcomx\Conclusion\Fact, Gedcomx\Conclusion\Gender, Gedcomx\Conclusion\Name

Namespace: Gedcomx\Links
Package: Gedcomx\Links
Located at Links/SupportsLinks.php

Methods summary

public array
# getLinks( )

Gets the array of hypermedia links.

Gets the array of hypermedia links.

Returns

array
public
# setLinks( array $links )

Sets the array of hypermedia links.

Sets the array of hypermedia links.

Parameters

$links
public
# addLink( Gedcomx\Links\Link $link )

Adds a hypermedia link to the current array of links.

Adds a hypermedia link to the current array of links.

Parameters

$link
public
# addLinkRelation( string $rel, string $href )

Add a hypermedia link relationship

Add a hypermedia link relationship

Parameters

$rel
see Gedcom\Rs\Client\Rel
$href
The target URI.
public
# addTemplatedLink( string $rel, string $template )

Add a templated link.

Add a templated link.

Parameters

$rel
see Gedcom\Rs\Client\Rel
$template
The link template.
public Gedcomx\Links\Link
# getLink( string $rel )

Get a link by its rel.

Get a link by its rel.

Parameters

$rel
see Gedcom\Rs\Client\Rel

Returns

Gedcomx\Links\Link
public Gedcomx\Links\Link[]
# getLinksByRel( string $rel )

Get a list of links by rel.

Get a list of links by rel.

Parameters

$rel
see Gedcom\Rs\Client\Rel

Returns

Gedcomx\Links\Link[]
gedcomx-php API documentation generated by ApiGen