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

  • ArtifactMetadata
  • ArtifactType

Class ArtifactMetadata

Class ArtifactMetadata

Namespace: Gedcomx\Extensions\FamilySearch\Platform\Artifacts
Package: Gedcomx\Extensions\FamilySearch\Platform\Artifacts
Located at Extensions/FamilySearch/Platform/Artifacts/ArtifactMetadata.php

Methods summary

public
# __construct( mixed $o = null )

Constructs a ArtifactMetadata from a (parsed) JSON hash

Constructs a ArtifactMetadata from a (parsed) JSON hash

Parameters

$o
Either an array (JSON) or an XMLReader.
public string
# getArtifactType( )

The type of the gender.

The type of the gender.

Returns

string
public
# setArtifactType( string $artifactType )

The type of the gender.

The type of the gender.

Parameters

$artifactType
public string
# getFilename( )

The original filename of the memories item.

The original filename of the memories item.

Returns

string
public
# setFilename( string $filename )

The original filename of the memories item.

The original filename of the memories item.

Parameters

$filename
public integer
# getHeight( )

The height of the artifact (presumably an image).

The height of the artifact (presumably an image).

Returns

integer
public
# setHeight( integer $height )

The height of the artifact (presumably an image).

The height of the artifact (presumably an image).

Parameters

$height
public integer
# getWidth( )

The width of the artifact (presumably an image).

The width of the artifact (presumably an image).

Returns

integer
public
# setWidth( integer $width )

The width of the artifact (presumably an image).

The width of the artifact (presumably an image).

Parameters

$width
public array
# toArray( )

Returns the associative array for this ArtifactMetadata

Returns the associative array for this ArtifactMetadata

Returns

array
public string
# toJson( )

Returns the JSON string for this ArtifactMetadata

Returns the JSON string for this ArtifactMetadata

Returns

string
public
# initFromArray( array $o )

Initializes this ArtifactMetadata from an associative array

Initializes this ArtifactMetadata from an associative array

Parameters

$o
public
# initFromReader( XMLReader $xml )

Initializes this ArtifactMetadata from an XML reader.

Initializes this ArtifactMetadata from an XML reader.

Parameters

$xml
The reader to use to initialize this object.
public
# toXml( XMLWriter $writer, boolean $includeNamespaces = true )

Writes this ArtifactMetadata to an XML writer.

Writes this ArtifactMetadata to an XML writer.

Parameters

$writer
The XML writer.
$includeNamespaces
Whether to write out the namespaces in the element.
public
# writeXmlContents( XMLWriter $writer )

Writes the contents of this ArtifactMetadata to an XML writer. The startElement is expected to be already provided.

Writes the contents of this ArtifactMetadata to an XML writer. The startElement is expected to be already provided.

Parameters

$writer
The XML writer.
gedcomx-php API documentation generated by ApiGen