Collection
class Collection extends Resource implements ArrayAccess, Countable, SeekableIterator
Sub-class of EasyRdf\Resource that represents an RDF collection (rdf:List)
This class can be used to iterate through a collection of items.
Note that items are numbered from 1 (not 0) for consistency with RDF Containers.
Properties
protected | $uri | The URI for this resource | from Resource |
protected | $graph | The Graph that this resource belongs to | from Resource |
Methods
Create a new collection - do not use this directly
Generates an HTML anchor tag, linking to this resource.
Returns the properties of the resource as an RDF/PHP associative array
Return pretty-print view of the resource
Perform a load (download of remote URI) of the resource into the graph
Delete a property (or optionally just a specific value)
Add a literal value as a property of the resource
Add a resource as a property of the resource
Get a single value for a property
Get a single literal value for a property of the resource
Get a single resource value for a property of the resource
Get all values for a property
Get all literal values for a property of the resource
Count the number of values for a property of a resource
Concatenate all values for a property into a string.
Get a list of all the shortened property names (qnames) for a resource.
Get a list of the full URIs for the properties that point to this resource.
Check to see if a property exists for this resource.
Get a human readable label for this resource
Return a human readable view of the resource and its properties
Magic method to set the value for a property of a resource
Array Access: check if a position exists in collection using array syntax
Array Access: get an item at a specified position in collection using array syntax
Array Access: set an item at a positon in collection using array syntax
Array Access: delete an item at a specific postion using array syntax
Seek to a specific position in the container
Rewind the iterator back to the start of the collection
Return the current item in the collection
Return the key / current position in the collection
Move forward to next item in the collection
Checks if current position is valid
Get a node for a particular offset into the collection
Counts the number of items in the collection
Append an item to the end of the collection
Details
at line 60
__construct($uri, $graph)
Create a new collection - do not use this directly
in
Resource at line 88
Graph
getGraph()
Return the graph that this resource belongs to
in
Resource at line 97
string
getUri()
Returns the URI for the resource.
in
Resource at line 106
bool
isBNode()
Check to see if a resource is a blank node.
in
Resource at line 121
string
getBNodeId()
Get the identifier for a blank node
Returns null if the resource is not a blank node.
in
Resource at line 137
string
prefix()
Get a the prefix of the namespace that this resource is part of
This method will return null the resource isn't part of any registered namespace.
in
Resource at line 149
string
shorten()
Get a shortened version of the resources URI.
This method will return the full URI if the resource isn't part of any registered namespace.
in
Resource at line 161
string
localName()
Gets the local name of the URI of this resource
The local name is defined as the part of the URI string after the last occurrence of the '#', ':' or '/' character.
in
Resource at line 172
ParsedUri
parseUri()
Parse the URI of the resource and return as a ParsedUri object
in
Resource at line 187
string
htmlLink(string $text = null, array $options = array())
Generates an HTML anchor tag, linking to this resource.
If no text is given, then the URI also uses as the link text.
in
Resource at line 217
array
toRdfPhp()
Returns the properties of the resource as an RDF/PHP associative array
For example: array('type' => 'uri', 'value' => 'http://www.example.com/')
in
Resource at line 233
string
dumpValue(string $format = 'html', string $color = 'blue')
Return pretty-print view of the resource
in
Resource at line 242
string
__toString()
Magic method to return URI of resource when casted to string
in
Resource at line 252
protected
checkHasGraph()
Throw can exception if the resource does not belong to a graph
@ignore
in
Resource at line 270
int
load(string $format = null)
Perform a load (download of remote URI) of the resource into the graph
The document type is optional but should be specified if it can't be guessed or got from the HTTP headers.
in
Resource at line 283
int
delete(string $property, object $value = null)
Delete a property (or optionally just a specific value)
in
Resource at line 299
int
add(mixed $property, mixed $value)
Add values to for a property of the resource
Example: $resource->add('prefix:property', 'value');
in
Resource at line 318
int
addLiteral(mixed $property, mixed $values, string $lang = null)
Add a literal value as a property of the resource
The value can either be a single value or an array of values.
Example: $resource->add('dc:title', 'Title of Page');
in
Resource at line 334
int
addResource(mixed $property, mixed $resource2)
Add a resource as a property of the resource
Example: $bob->add('foaf:knows', 'http://example.com/alice');
in
Resource at line 352
int
set(string $property, mixed $value)
Set value for a property
The new value(s) will replace the existing values for the property. The name of the property should be a string. If you set a property to null or an empty array, then the property will be deleted.
in
Resource at line 374
mixed
get(string|array $property, string $type = null, string $lang = null)
Get a single value for a property
If multiple values are set for a property then the value returned may be arbitrary.
If $property is an array, then the first item in the array that matches a property that exists is returned.
This method will return null if the property does not exist.
in
Resource at line 393
Literal
getLiteral(string|array $property, string $lang = null)
Get a single literal value for a property of the resource
If multiple values are set for a property then the value returned may be arbitrary.
This method will return null if there is not literal value for the property.
in
Resource at line 411
Resource
getResource(string|array $property)
Get a single resource value for a property of the resource
If multiple values are set for a property then the value returned may be arbitrary.
This method will return null if there is not resource for the property.
in
Resource at line 427
array
all(string $property, string $type = null, string $lang = null)
Get all values for a property
This method will return an empty array if the property does not exist.
in
Resource at line 443
array
allLiterals(string $property, string $lang = null)
Get all literal values for a property of the resource
This method will return an empty array if the resource does not has any literal values for that property.
in
Resource at line 458
array
allResources(string $property)
Get all resources for a property of the resource
This method will return an empty array if the resource does not has any resources for that property.
in
Resource at line 474
int
countValues(string $property, string $type = null, string $lang = null)
Count the number of values for a property of a resource
This method will return 0 if the property does not exist.
in
Resource at line 491
string
join(string $property, string $glue = ' ', string $lang = null)
Concatenate all values for a property into a string.
The default is to join the values together with a space character. This method will return an empty string if the property does not exist.
in
Resource at line 503
array
propertyUris()
Get a list of the full URIs for the properties of this resource.
This method will return an empty array if the resource has no properties.
in
Resource at line 515
array
properties()
Get a list of all the shortened property names (qnames) for a resource.
This method will return an empty array if the resource has no properties.
in
Resource at line 525
array
reversePropertyUris()
Get a list of the full URIs for the properties that point to this resource.
in
Resource at line 542
bool
hasProperty(string $property, mixed $value = null)
Check to see if a property exists for this resource.
This method will return true if the property exists. If the value parameter is given, then it will only return true if the value also exists for that property.
in
Resource at line 555
array
types()
Get a list of types for a resource.
The types will each be a shortened URI as a string. This method will return an empty array if the resource has no types.
in
Resource at line 570
string
type()
Get a single type for a resource.
The type will be a shortened URI as a string. If the resource has multiple types then the type returned may be arbitrary. This method will return null if the resource has no type.
in
Resource at line 585
resource
typeAsResource()
Get a single type for a resource, as a resource.
The type will be returned as an EasyRdf\Resource. If the resource has multiple types then the type returned may be arbitrary. This method will return null if the resource has no type.
in
Resource at line 597
resource[]
typesAsResources()
Get a list of types for a resource, as EasyRdf\Resource
in
Resource at line 609
bool
isA(string $type)
Check if a resource is of the specified type
in
Resource at line 621
int
addType(string $types)
Add one or more rdf:type properties to the resource
in
Resource at line 635
int
setType(string $type)
Change the rdf:type property for the resource
Note that the PHP class of the resource will not change.
in
Resource at line 647
resource
primaryTopic()
Get the primary topic of this resource.
Returns null if no primary topic is available.
in
Resource at line 664
Literal|null
label(string|null $lang = null)
Get a human readable label for this resource
This method will check a number of properties for the resource (in the order: skos:prefLabel, rdfs:label, foaf:name, dc:title) and return an approriate first that is available. If no label is available then it will return null.
in
Resource at line 679
string
dump(string $format = 'html')
Return a human readable view of the resource and its properties
This method is intended to be a debugging aid and will print a resource and its properties.
in
Resource at line 698
string
__get(string $name)
Magic method to get a property of a resource
Note that only properties in the default namespace can be accessed in this way.
Example: $value = $resource->title;
in
Resource at line 717
int
__set(string $name, string $value)
Magic method to set the value for a property of a resource
Note that only properties in the default namespace can be accessed in this way.
Example: $resource->title = 'Title';
in
Resource at line 735
bool
__isset(string $name)
Magic method to check if a property exists
Note that only properties in the default namespace can be accessed in this way.
Example: if (isset($resource->title)) { blah(); }
in
Resource at line 753
int
__unset(string $name)
Magic method to delete a property of the resource
Note that only properties in the default namespace can be accessed in this way.
Example: unset($resource->title);
at line 228
bool
offsetExists(mixed $offset)
Array Access: check if a position exists in collection using array syntax
Example: isset($list[2])
at line 244
mixed
offsetGet(mixed $offset)
Array Access: get an item at a specified position in collection using array syntax
Example: $item = $list[2];
at line 263
void
offsetSet(mixed $offset, mixed $value)
Array Access: set an item at a positon in collection using array syntax
Example: $list[2] = $item;
at line 298
void
offsetUnset(mixed $offset)
Array Access: delete an item at a specific postion using array syntax
Example: unset($seq[2]);
at line 76
seek(int $position)
Seek to a specific position in the container
The first item is postion 1
at line 98
rewind()
Rewind the iterator back to the start of the collection
at line 108
mixed
current()
Return the current item in the collection
at line 123
int
key()
Return the key / current position in the collection
Note: the first item is number 1
at line 131
next()
Move forward to next item in the collection
at line 145
bool
valid()
Checks if current position is valid
at line 169
array
getCollectionNode(int $offset)
Get a node for a particular offset into the collection
This function may not return the item you requested, if it does not exist. Please check the $postion parameter returned.
If the offset is null, then the last node in the collection (before rdf:nil) will be returned.
at line 188
int
count()
Counts the number of items in the collection
Note that this is an slow method - it is more efficient to use the iterator interface, if you can.
at line 205
int
append(mixed $value)
Append an item to the end of the collection