islandora_xacml_editor.api.php

<?php

/**
 * @file
 * This file documents all available hook functions to manipulate data.
 */

/**
 * Define custom queries to be used when batching through "children" of objects.
 *
 * @param AbstractObject $object
 *   A AbstractObject.
 *
 * @return array
 *   An array of queries to be returned to the islandora_xacml_editor module.
 *   Each entry in the array is an associate array itself with the following
 *   structure:
 *   - type: The type of query to be executed either itql or sparql.
 *   - query: The defined query string. The field we expect returned is that of
 *     "object". I.e select ?object. It's to be noted that if the "walk"
 *     parameter ?model must also be returned.
 *   - description: Human-readable description used in populating the options
 *   dropdown.
 *   - restricted_cmodels (Optional): An array defining restricted content
 *     models that shouldn't be recursed upon if encountered.
 */
function hook_islandora_xacml_editor_child_query(AbstractObject $object) {
  return array(
    'sample_query' => array(
      'type' => 'itql',
      'query' => 'select $object from <#ri> where $object <fedora-rels-ext:isMemberOfCollection> <info:fedora/islandora:root>',
      'description' => t('Sweet query bro.'),
    ),
  );
}