Documentation

RepoResourceDb
in package
implements RepoResourceInterface Uses RepoResourceTrait

Provides a read-only access to the repository resource's metadata.

Tags
author

zozlak

Table of Contents

Interfaces

RepoResourceInterface

Properties

$id  : int
$metadata  : Resource|null
$metaSynced  : bool
$repo  : RepoDb
$repoInt  : RepoInterface
$url  : string

Methods

__construct()  : mixed
Creates an object representing a repository resource.
getClasses()  : array<string|int, string>
Returns all RDF types (classes) of a given repository resource.
getGraph()  : resource
Returns resource metadata.
getIds()  : array<string|int, string>
Returns an array with all repository resource identifiers.
getMetadata()  : resource
Returns resource metadata.
getMetadataStatement()  : PDOStatement
Returns a QueryPart object with an SQL query loading resource's metadata in a given mode.
getRepo()  : RepoInterface
Returns repository connection object associated with the given resource object.
getUri()  : string
Returns the repository resource URL.
isA()  : bool
Naivly checks if the resource is of a given class.
loadMetadata()  : void
Loads current metadata from the repository.
setGraph()  : void
Replaces resource metadata with a given RDF resource graph. A reference to the provided metadata is stored meaning future modifications of the $metadata object automatically affect the resource metadata.
setMetadata()  : void
Replaces resource metadata with a given RDF resource graph. A deep copy of the provided metadata is stored meaning future modifications of the $metadata object don't affect the resource metadata.

Properties

Methods

__construct()

Creates an object representing a repository resource.

public __construct(string $urlOrId, RepoInterface $repo) : mixed
Parameters
$urlOrId : string

either a resource URL or just the numeric id

$repo : RepoInterface

repository connection object

getClasses()

Returns all RDF types (classes) of a given repository resource.

public getClasses() : array<string|int, string>
Return values
array<string|int, string>

getGraph()

Returns resource metadata.

public getGraph() : resource

Fetches them from the repository with the loadMetadata() if they were not fetched already.

A reference to the metadata is returned meaning adjusting the returned object automatically affects the resource metadata.

Tags
see
setGraph()
see
getMetadata()
Return values
resource

getIds()

Returns an array with all repository resource identifiers.

public getIds() : array<string|int, string>
Return values
array<string|int, string>

getMetadata()

Returns resource metadata.

public getMetadata() : resource

Fetches them from the repository with the loadMetadata() if they were not fetched already.

A deep copy of metadata is returned meaning adjusting the returned object does not automatically affect the resource metadata. Use the setMetadata() method to write back the changes you made.

Tags
see
setMetadata()
see
setGraph()
see
getGraph()
Return values
resource

getMetadataStatement()

Returns a QueryPart object with an SQL query loading resource's metadata in a given mode.

public getMetadataStatement([string $mode = self::META_RESOURCE ][, string $parentProperty = null ][, array<string|int, string> $resourceProperties = [] ][, array<string|int, string> $relativesProperties = [] ]) : PDOStatement
Parameters
$mode : string = self::META_RESOURCE

scope of the metadata returned by the repository - see the RepoDb()::getPdoStatementBySqlQuery() method

$parentProperty : string = null

RDF property name used to find related resources

$resourceProperties : array<string|int, string> = []

list of RDF properties to be includes for a resource (if the list is empty, all exsiting RDF properties are included)

$relativesProperties : array<string|int, string> = []

list of RDF properties to be includes for resources being relatives (if the list is empty, all exsiting RDF properties are included)

Return values
PDOStatement

getUri()

Returns the repository resource URL.

public getUri() : string
Return values
string

isA()

Naivly checks if the resource is of a given class.

public isA(string $class) : bool

Naivly means that a given rdfs:type triple must exist in the resource metadata.

Parameters
$class : string
Return values
bool

loadMetadata()

Loads current metadata from the repository.

public loadMetadata([bool $force = false ][, string $mode = self::META_RESOURCE ][, string $parentProperty = null ][, array<string|int, string> $resourceProperties = [] ][, array<string|int, string> $relativesProperties = [] ]) : void
Parameters
$force : bool = false

enforce fetch from the repository (when you want to make sure metadata are in line with ones in the repository or e.g. reset them back to their current state in the repository)

$mode : string = self::META_RESOURCE

scope of the metadata returned by the repository - see the RepoDb()::getPdoStatementBySqlQuery() method

$parentProperty : string = null

RDF property name used to find related resources

  • see the getMetadataQuery() method
$resourceProperties : array<string|int, string> = []

list of RDF properties to be includes for a resource (if the list is empty, all exsiting RDF properties are included)

$relativesProperties : array<string|int, string> = []

list of RDF properties to be includes for resources being relatives (if the list is empty, all exsiting RDF properties are included)

Tags
throws
RepoLibException
see
getMetadataQuery

setGraph()

Replaces resource metadata with a given RDF resource graph. A reference to the provided metadata is stored meaning future modifications of the $metadata object automatically affect the resource metadata.

public setGraph(resource $resource) : void

New metadata are not automatically written back to the repository. Use the updateMetadata() method to write them back.

Parameters
$resource : resource
Tags
see
updateMetadata()
see
setMetadata()

setMetadata()

Replaces resource metadata with a given RDF resource graph. A deep copy of the provided metadata is stored meaning future modifications of the $metadata object don't affect the resource metadata.

public setMetadata(resource $metadata) : void

New metadata are not automatically written back to the repository. Use the updateMetadata() method to write them back.

Parameters
$metadata : resource
Tags
see
updateMetadata()
see
setGraph()

        
On this page

Search results