$debug
$debug : boolean
Debug mode switch.
ACDH dessimination service is modeled as a Fedora resource described by RDF properties:
Dissemination service parameters are modeled as its child resources (cfg:fedoraRelProp) - see Parameter class description for details.
Matching between repository resources and dissemination services can be described in two ways:
Service::addMatch() method
(see below)$fedora : \acdhOeaw\fedora\Fedora
Fedora connection object.
$res : \acdhOeaw\fedora\FedoraResource
Repository resource representing given entity.
$location : string
Dissemination service location (URL).
It should contain references to all parameters passed by the query URL
in form of {parameterName|transformation}. Remarks:
RES_URI parameter available providing the URI
of the resource being disseminated\acdhOeaw\fedora\dissemination\Parameter::transform().An example value: `https://my.service?res={RES_URI|url}&myParam={myParam|}
__construct(\acdhOeaw\fedora\Fedora $fedora, string $id, string $location, array $format, boolean $revProxy)
Creates an object representing the dissemination service
| \acdhOeaw\fedora\Fedora | $fedora | repository connection object |
| string | $id | dissemination service id |
| string | $location | dissemination service location (see the
|
| array | $format | list of return types provided by the dissemination service |
| boolean | $revProxy | should calls to the diss service be reverse proxied? |
getResource(boolean $create = true, boolean $uploadBinary = true) : \acdhOeaw\fedora\FedoraResource
Returns repository resource representing given real-world entity.
If it does not exist, it can be created.
| boolean | $create | should repository resource be created if it does not exist? |
| boolean | $uploadBinary | should binary data of the real-world entity be uploaded uppon repository resource creation? |
updateRms(boolean $create = true, boolean $uploadBinary = true, string $path = '/') : \acdhOeaw\fedora\FedoraResource
Updates the dissemination service definition in the repository.
| boolean | $create | should repository resource be created if it does not exist? |
| boolean | $uploadBinary | should binary data of the real-world entity be uploaded uppon repository resource creation? |
| string | $path | where to create a resource (if it does not exist). If it it ends with a "/", the resource will be created as a child of a given collection). All the parents in the Fedora resource tree have to exist (you can not create "/foo/bar" if "/foo" does not exist already). |
getCreated() : boolean
Informs about the corresponding repository resource state uppon last call to the `updateRms()` method: - null - the updateRms() was not called yet - true - repository resource was created by last call to the updateRms() - false - repository resource already existed uppoin last call to the updateRms()
setMetadata(Resource $meta, array $preserve = array())
Sets an external metadata to be appended to automatically generated ones.
If a given metatada property exists both in automatically generated and provided metadata, then the final result depends on the $preserve parameter:
| Resource | $meta | external metadata |
| array | $preserve | list of metadata properties to be kept - see above |
createNewVersion(boolean $uploadBinary = true, string $path = '/', boolean $pidPass = false) : \acdhOeaw\fedora\FedoraResource
Creates a new version of the resource. The new version inherits all IDs but the UUID and epic PIDs. The old version looses all IDs but the UUID and spic PIDs. It also looses all RC::relProp() connections with collections.
The old and the new resource are linked with cfg:fedoraIsNewVersionProp
and cfg:fedoraIsOldVersionProp.
| boolean | $uploadBinary | should binary data of the real-world entity be uploaded uppon repository resource creation? |
| string | $path | where to create a resource (if it does not exist). If it it ends with a "/", the resource will be created as a child of a given collection). All the parents in the Fedora resource tree have to exist (you can not create "/foo/bar" if "/foo" does not exist already). |
| boolean | $pidPass | should PIDs (epic handles) be migrated to the new
version ( |
old version resource
addParameter(string $name, string $defaultValue = '', string $rdfProperty = '_')
Defines a dissemination service parameter.
| string | $name | parameter name |
| string | $defaultValue | default parameter value |
| string | $rdfProperty | RDF property holding parameter value in resources' metadata |
addMatch(string $property, string $value, boolean $required)
Defines a matching rule for the dissemination service
| string | $property | RDF property to be checked in resource's metadata |
| string | $value | expected RDF property value in resource's metadata |
| boolean | $required | is this match rule compulsory? |
findResource(boolean $create = true, boolean $uploadBinary = true, string $path = '') : boolean
Tries to find a repository resource representing a given object.
| boolean | $create | should repository resource be created if it was not found? |
| boolean | $uploadBinary | should binary data of the real-world entity be uploaded uppon repository resource creation? |
| string | $path | where to create a resource (if it does not exist). If it it ends with a "/", the resource will be created as a child of a given collection). All the parents in the Fedora resource tree have to exist (you can not create "/foo/bar" if "/foo" does not exist already). |
if a repository resource was found