Class CollectionContent
A description of the content of a collection by resource type.
-
Gedcomx\Common\ExtensibleData
-
Gedcomx\Links\HypermediaEnabledData
implements
Gedcomx\Links\SupportsLinks
-
Gedcomx\Records\CollectionContent
Methods summary
public
|
#
__construct( mixed $o = null )
Constructs a CollectionContent from a (parsed) JSON hash
Constructs a CollectionContent from a (parsed) JSON hash
Parameters
- $o
- Either an array (JSON) or an XMLReader.
Throws
Exception
Overrides
|
public
float
|
#
getCompleteness( )
A completeness factor for this content aspect, a value between 0 and 1.
A completeness factor for this content aspect, a value between 0 and 1.
Returns
float
|
public
|
#
setCompleteness( float $completeness )
A completeness factor for this content aspect, a value between 0 and 1.
A completeness factor for this content aspect, a value between 0 and 1.
Parameters
|
public
integer
|
#
getCount( )
The count of the items applicable to this content aspect.
The count of the items applicable to this content aspect.
Returns
integer
|
public
|
#
setCount( integer $count )
The count of the items applicable to this content aspect.
The count of the items applicable to this content aspect.
Parameters
|
public
string
|
#
getResourceType( )
The type of resource being covered in this collection.
The type of resource being covered in this collection.
Returns
string
|
public
|
#
setResourceType( string $resourceType )
The type of resource being covered in this collection.
The type of resource being covered in this collection.
Parameters
|
public
array
|
#
toArray( )
Returns the associative array for this CollectionContent
Returns the associative array for this CollectionContent
Returns
array
Overrides
|
public
|
#
initFromArray( array $o )
Initializes this CollectionContent from an associative array
Initializes this CollectionContent from an associative array
Parameters
Overrides
|
public
|
#
toXml( XMLWriter $writer, boolean $includeNamespaces = true )
Writes this CollectionContent to an XML writer.
Writes this CollectionContent 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 CollectionContent to an XML writer. The startElement is expected to be already
provided.
Writes the contents of this CollectionContent to an XML writer. The startElement is expected to be already
provided.
Parameters
Overrides
|
addExtensionElement()
,
findExtensionOfType()
,
findExtensionsOfType()
,
getExtensionElements()
,
getId()
,
initFromReader()
,
removeExtensionElements()
,
setExtensionElement()
,
setExtensionElements()
,
setId()
,
toJson()