Code
/
islandora
7
0
Fork 0
Code Issues Pull Requests 1 Projects Releases Wiki Activity
Browse Source

more cleanup

pull/596/head
Kylea Jackson 10 years ago
parent
08ea614e6f
commit
e744476152
1 changed files with 76 additions and 0 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 76
      islandora.api.php

76
islandora.api.php
Unescape View File

@ -33,6 +33,7 @@ function hook_islandora_view_object($object, $user, $page_number, $page_size) {
} }
return $output; return $output;
} }
/** /**
* Generate a print friendly page for the given object. * Generate a print friendly page for the given object.
* *
@ -40,7 +41,9 @@ function hook_islandora_view_object($object, $user, $page_number, $page_size) {
* The object form to print. * The object form to print.
*/ */
function hook_islandora_view_print_object($object) { function hook_islandora_view_print_object($object) {
} }
/** /**
* Generate an object's display for the given content model. * Generate an object's display for the given content model.
* *
@ -54,7 +57,9 @@ function hook_islandora_view_print_object($object) {
* An array whose values are markup. * An array whose values are markup.
*/ */
function hook_cmodel_pid_islandora_view_object($object) { function hook_cmodel_pid_islandora_view_object($object) {
} }
/** /**
* Alter display output after it has been generated. * Alter display output after it has been generated.
* *
@ -64,7 +69,9 @@ function hook_cmodel_pid_islandora_view_object($object) {
* The array of rendered views. * The array of rendered views.
*/ */
function hook_islandora_view_object_alter(&$object, &$rendered) { function hook_islandora_view_object_alter(&$object, &$rendered) {
} }
/** /**
* Alter display output if the object has the given model. * Alter display output if the object has the given model.
* *
@ -76,7 +83,9 @@ function hook_islandora_view_object_alter(&$object, &$rendered) {
* The array of rendered views. * The array of rendered views.
*/ */
function hook_cmodel_pid_islandora_view_object_alter(&$object, &$rendered) { function hook_cmodel_pid_islandora_view_object_alter(&$object, &$rendered) {
} }
/** /**
* Generate an object's datastreams management display. * Generate an object's datastreams management display.
* *
@ -87,7 +96,9 @@ function hook_cmodel_pid_islandora_view_object_alter(&$object, &$rendered) {
* An array whose values are markup. * An array whose values are markup.
*/ */
function hook_islandora_edit_object($object) { function hook_islandora_edit_object($object) {
} }
/** /**
* Generate an object's datastreams management display based on content model. * Generate an object's datastreams management display based on content model.
* *
@ -101,7 +112,9 @@ function hook_islandora_edit_object($object) {
* An array whose values are markup. * An array whose values are markup.
*/ */
function hook_cmodel_pid_islandora_edit_object($object) { function hook_cmodel_pid_islandora_edit_object($object) {
} }
/** /**
* Allow datastreams management display output to be altered. * Allow datastreams management display output to be altered.
* *
@ -111,7 +124,9 @@ function hook_cmodel_pid_islandora_edit_object($object) {
* an arr of rendered views * an arr of rendered views
*/ */
function hook_islandora_edit_object_alter(&$object, &$rendered) { function hook_islandora_edit_object_alter(&$object, &$rendered) {
} }
/** /**
* Allows modules to alter the object or block/modify the given action. * Allows modules to alter the object or block/modify the given action.
* *
@ -142,14 +157,18 @@ function hook_islandora_edit_object_alter(&$object, &$rendered) {
* @see FedoraApiM::modifyObject() * @see FedoraApiM::modifyObject()
*/ */
function hook_islandora_object_alter(AbstractObject $object, array &$context) { function hook_islandora_object_alter(AbstractObject $object, array &$context) {
} }
/** /**
* Allows modules to alter the object or block/modify the given action. * Allows modules to alter the object or block/modify the given action.
* *
* @see hook_islandora_object_alter() * @see hook_islandora_object_alter()
*/ */
function hook_cmodel_pid_islandora_object_alter(AbstractObject $object, array &$context) { function hook_cmodel_pid_islandora_object_alter(AbstractObject $object, array &$context) {
} }
/** /**
* Allows modules to alter the datastream or block/modify the given action. * Allows modules to alter the datastream or block/modify the given action.
* *
@ -189,14 +208,18 @@ function hook_cmodel_pid_islandora_object_alter(AbstractObject $object, array &$
* @see FedoraApiM::modifyDatastream() * @see FedoraApiM::modifyDatastream()
*/ */
function hook_islandora_datastream_alter(AbstractObject $object, AbstractDatastream $datastream, array &$context) { function hook_islandora_datastream_alter(AbstractObject $object, AbstractDatastream $datastream, array &$context) {
} }
/** /**
* Allows modules to alter the datastream or block/modify the given action. * Allows modules to alter the datastream or block/modify the given action.
* *
* @see hook_islandora_datastream_alter() * @see hook_islandora_datastream_alter()
*/ */
function hook_cmodel_pid_dsid_islandora_datastream_alter(AbstractObject $object, AbstractDatastream $datastream, array &$context) { function hook_cmodel_pid_dsid_islandora_datastream_alter(AbstractObject $object, AbstractDatastream $datastream, array &$context) {
} }
/** /**
* Notify modules that the given object was ingested. * Notify modules that the given object was ingested.
* *
@ -211,14 +234,18 @@ function hook_cmodel_pid_dsid_islandora_datastream_alter(AbstractObject $object,
* The object that was ingested. * The object that was ingested.
*/ */
function hook_islandora_object_ingested(AbstractObject $object) { function hook_islandora_object_ingested(AbstractObject $object) {
} }
/** /**
* Notify modules that the given object was ingested. * Notify modules that the given object was ingested.
* *
* @see hook_islandora_object_ingested() * @see hook_islandora_object_ingested()
*/ */
function hook_cmodel_pid_islandora_object_ingested(AbstractObject $object) { function hook_cmodel_pid_islandora_object_ingested(AbstractObject $object) {
} }
/** /**
* Notify modules that the given object was modified. * Notify modules that the given object was modified.
* *
@ -234,14 +261,18 @@ function hook_cmodel_pid_islandora_object_ingested(AbstractObject $object) {
* parameter. * parameter.
*/ */
function hook_islandora_object_modified(AbstractObject $object) { function hook_islandora_object_modified(AbstractObject $object) {
} }
/** /**
* Notify modules that the given object was modified. * Notify modules that the given object was modified.
* *
* @see hook_islandora_object_modified() * @see hook_islandora_object_modified()
*/ */
function hook_cmodel_pid_islandora_object_modified(AbstractObject $object) { function hook_cmodel_pid_islandora_object_modified(AbstractObject $object) {
} }
/** /**
* Notify modules that the given object was purged/deleted. * Notify modules that the given object was purged/deleted.
* *
@ -252,14 +283,18 @@ function hook_cmodel_pid_islandora_object_modified(AbstractObject $object) {
* The ID of the object that was purged/deleted. * The ID of the object that was purged/deleted.
*/ */
function hook_islandora_object_purged($pid) { function hook_islandora_object_purged($pid) {
} }
/** /**
* Notify modules that the given object was purged/deleted. * Notify modules that the given object was purged/deleted.
* *
* @see hook_islandora_object_purged() * @see hook_islandora_object_purged()
*/ */
function hook_cmodel_pid_islandora_object_purged($pid) { function hook_cmodel_pid_islandora_object_purged($pid) {
} }
/** /**
* Notify modules that the given datastream was ingested. * Notify modules that the given datastream was ingested.
* *
@ -275,14 +310,18 @@ function hook_cmodel_pid_islandora_object_purged($pid) {
* The ingested datastream. * The ingested datastream.
*/ */
function hook_islandora_datastream_ingested(AbstractObject $object, AbstractDatastream $datastream) { function hook_islandora_datastream_ingested(AbstractObject $object, AbstractDatastream $datastream) {
} }
/** /**
* Notify modules that the given datastream was ingested. * Notify modules that the given datastream was ingested.
* *
* @see hook_islandora_object_ingested() * @see hook_islandora_object_ingested()
*/ */
function hook_cmodel_pid_dsid_islandora_datastream_ingested(AbstractObject $object, AbstractDatastream $datastream) { function hook_cmodel_pid_dsid_islandora_datastream_ingested(AbstractObject $object, AbstractDatastream $datastream) {
} }
/** /**
* Notify modules that the given datastream was modified. * Notify modules that the given datastream was modified.
* *
@ -300,14 +339,18 @@ function hook_cmodel_pid_dsid_islandora_datastream_ingested(AbstractObject $obje
* parameter. * parameter.
*/ */
function hook_islandora_datastream_modified(AbstractObject $object, AbstractDatastream $datastream) { function hook_islandora_datastream_modified(AbstractObject $object, AbstractDatastream $datastream) {
} }
/** /**
* Notify modules that the given datastream was modified. * Notify modules that the given datastream was modified.
* *
* @see hook_islandora_datastream_modified() * @see hook_islandora_datastream_modified()
*/ */
function hook_cmodel_pid_islandora_datastream_modified(AbstractObject $object, AbstractDatastream $datastream) { function hook_cmodel_pid_islandora_datastream_modified(AbstractObject $object, AbstractDatastream $datastream) {
} }
/** /**
* Notify modules that the given datastream was purged/deleted. * Notify modules that the given datastream was purged/deleted.
* *
@ -320,14 +363,18 @@ function hook_cmodel_pid_islandora_datastream_modified(AbstractObject $object, A
* The ID of the datastream that was purged/deleted. * The ID of the datastream that was purged/deleted.
*/ */
function hook_islandora_datastream_purged(AbstractObject $object, $dsid) { function hook_islandora_datastream_purged(AbstractObject $object, $dsid) {
} }
/** /**
* Notify modules that the given datastream was purged/deleted. * Notify modules that the given datastream was purged/deleted.
* *
* @see hook_islandora_datastream_purged() * @see hook_islandora_datastream_purged()
*/ */
function hook_cmodel_pid_islandora_datastream_purged(AbstractObject $object, $dsid) { function hook_cmodel_pid_islandora_datastream_purged(AbstractObject $object, $dsid) {
} }
/** /**
* Register a datastream edit route/form. * Register a datastream edit route/form.
* *
@ -349,6 +396,7 @@ function hook_islandora_edit_datastream_registry($object, $dsid) {
); );
return $routes; return $routes;
} }
/** /**
* Registry hook for required objects. * Registry hook for required objects.
* *
@ -361,7 +409,9 @@ function hook_islandora_edit_datastream_registry($object, $dsid) {
* @example islandora_islandora_required_objects() * @example islandora_islandora_required_objects()
*/ */
function hook_islandora_required_objects() { function hook_islandora_required_objects() {
} }
/** /**
* Registry hook for viewers that can be implemented by solution packs. * Registry hook for viewers that can be implemented by solution packs.
* *
@ -372,7 +422,9 @@ function hook_islandora_required_objects() {
* @see islandora_get_viewer_callback() * @see islandora_get_viewer_callback()
*/ */
function hook_islandora_viewer_info() { function hook_islandora_viewer_info() {
} }
/** /**
* Returns a list of datastreams that are determined to be undeletable. * Returns a list of datastreams that are determined to be undeletable.
* *
@ -387,6 +439,7 @@ function hook_islandora_viewer_info() {
function hook_islandora_undeletable_datastreams(array $models) { function hook_islandora_undeletable_datastreams(array $models) {
return array('DC', 'MODS'); return array('DC', 'MODS');
} }
/** /**
* Define steps used in the islandora_ingest_form() ingest process. * Define steps used in the islandora_ingest_form() ingest process.
* *
@ -446,6 +499,7 @@ function hook_islandora_ingest_steps(array $form_state) {
), ),
); );
} }
/** /**
* Alter the generated ingest steps. * Alter the generated ingest steps.
* *
@ -456,7 +510,9 @@ function hook_islandora_ingest_steps(array $form_state) {
* An array containing the Drupal form_state. * An array containing the Drupal form_state.
*/ */
function hook_islandora_ingest_steps_alter(array &$steps, array &$form_state) { function hook_islandora_ingest_steps_alter(array &$steps, array &$form_state) {
} }
/** /**
* Content model specific version of hook_islandora_ingest_steps(). * Content model specific version of hook_islandora_ingest_steps().
* *
@ -468,7 +524,9 @@ function hook_islandora_ingest_steps_alter(array &$steps, array &$form_state) {
* @see hook_islandora_ingest_steps() * @see hook_islandora_ingest_steps()
*/ */
function hook_cmodel_pid_islandora_ingest_steps(array $form_state) { function hook_cmodel_pid_islandora_ingest_steps(array $form_state) {
} }
/** /**
* Alter the generated ingest steps for the given content model. * Alter the generated ingest steps for the given content model.
* *
@ -479,7 +537,9 @@ function hook_cmodel_pid_islandora_ingest_steps(array $form_state) {
* An array containing the Drupal form_state. * An array containing the Drupal form_state.
*/ */
function hook_cmodel_pid_islandora_ingest_steps_alter(array &$steps, array &$form_state) { function hook_cmodel_pid_islandora_ingest_steps_alter(array &$steps, array &$form_state) {
} }
/** /**
* Object-level access callback hook. * Object-level access callback hook.
* *
@ -507,13 +567,16 @@ function hook_islandora_object_access($op, $object, $user) {
return NULL; return NULL;
} }
} }
/** /**
* Content model specific version of hook_islandora_object_access(). * Content model specific version of hook_islandora_object_access().
* *
* @see hook_islandora_object_access() * @see hook_islandora_object_access()
*/ */
function hook_cmodel_pid_islandora_object_access($op, $object, $user) { function hook_cmodel_pid_islandora_object_access($op, $object, $user) {
} }
/** /**
* Datastream-level access callback hook. * Datastream-level access callback hook.
* *
@ -541,19 +604,23 @@ function hook_islandora_datastream_access($op, $object, $user) {
return NULL; return NULL;
} }
} }
/** /**
* Content model specific version of hook_islandora_datastream_access(). * Content model specific version of hook_islandora_datastream_access().
* *
* @see hook_islandora_datastream_access() * @see hook_islandora_datastream_access()
*/ */
function hook_cmodel_pid_islandora_datastream_access($op, $object, $user) { function hook_cmodel_pid_islandora_datastream_access($op, $object, $user) {
} }
/** /**
* Lets one add to the overview tab in object management. * Lets one add to the overview tab in object management.
*/ */
function hook_islandora_overview_object(AbstractObject $object) { function hook_islandora_overview_object(AbstractObject $object) {
return drupal_render(drupal_get_form('some_form', $object)); return drupal_render(drupal_get_form('some_form', $object));
} }
/** /**
* Lets one add to the overview tab in object management. * Lets one add to the overview tab in object management.
* *
@ -562,12 +629,14 @@ function hook_islandora_overview_object(AbstractObject $object) {
function hook_cmodel_pid_islandora_overview_object(AbstractObject $object) { function hook_cmodel_pid_islandora_overview_object(AbstractObject $object) {
return drupal_render(drupal_get_form('some_form', $object)); return drupal_render(drupal_get_form('some_form', $object));
} }
/** /**
* Lets one alter the overview tab in object management. * Lets one alter the overview tab in object management.
*/ */
function hook_islandora_overview_object_alter(AbstractObject &$object, &$output) { function hook_islandora_overview_object_alter(AbstractObject &$object, &$output) {
$output = $output . drupal_render(drupal_get_form('some_form', $object)); $output = $output . drupal_render(drupal_get_form('some_form', $object));
} }
/** /**
* Lets one alter the overview tab in object management. * Lets one alter the overview tab in object management.
* *
@ -576,6 +645,7 @@ function hook_islandora_overview_object_alter(AbstractObject &$object, &$output)
function hook_cmodel_pid_islandora_overview_object_alter(AbstractObject &$object, &$output) { function hook_cmodel_pid_islandora_overview_object_alter(AbstractObject &$object, &$output) {
$output = $output . drupal_render(drupal_get_form('some_form', $object)); $output = $output . drupal_render(drupal_get_form('some_form', $object));
} }
/** /**
* Defines derivative functions to be executed based on certain conditions. * Defines derivative functions to be executed based on certain conditions.
* *
@ -648,13 +718,16 @@ function hook_islandora_derivative(AbstractObject $object = NULL) {
); );
return $derivatives; return $derivatives;
} }
/** /**
* Content model specific version of hook_islandora_derivative(). * Content model specific version of hook_islandora_derivative().
* *
* @see hook_islandora_derivative() * @see hook_islandora_derivative()
*/ */
function hook_cmodel_pid_islandora_derivative() { function hook_cmodel_pid_islandora_derivative() {
} }
/** /**
* Retrieves PIDS of related objects for property updating. * Retrieves PIDS of related objects for property updating.
* *
@ -669,6 +742,7 @@ function hook_islandora_update_related_objects_properties(AbstractObject $object
} }
return $pids_to_return; return $pids_to_return;
} }
/** /**
* Alters breadcrumbs used on Solr search results and within Islandora views. * Alters breadcrumbs used on Solr search results and within Islandora views.
* *
@ -680,7 +754,9 @@ function hook_islandora_update_related_objects_properties(AbstractObject $object
* (Optional) AbstractObject representing object providing breadcrumb path * (Optional) AbstractObject representing object providing breadcrumb path
*/ */
function hook_islandora_breadcrumbs_alter(&$breadcrumbs, $context, $object = NULL) { function hook_islandora_breadcrumbs_alter(&$breadcrumbs, $context, $object = NULL) {
} }
/** /**
* Registry hook for metadata display viewers. * Registry hook for metadata display viewers.
* *

Write Preview
Loading…
Cancel
Save