Browse Source

Update documentation.

pull/215/head
Adam Vessey 12 years ago
parent
commit
f93e35fe87
  1. 20
      islandora.api.php

20
islandora.api.php

@ -226,9 +226,14 @@ function hook_islandora_undeletable_datastreams(array $models) {}
/** /**
* Define steps used in the islandora_ingest_form() ingest process. * Define steps used in the islandora_ingest_form() ingest process.
* *
* @param array $form_state
* An array containing the form_state, on which infomation from step storage
* might be extracted. Note that the
*
* @return array * @return array
* An array of associative arrays which define each step in the ingest * An associative array of associative arrays which define each step in the
* process. Steps are defined by by a number of properties (keys) including: * ingest process. Each step should consist of a unique name mapped to an
* array of properties (keys) including:
* - type: The type of step. Currently, only "form" is implemented. * - type: The type of step. Currently, only "form" is implemented.
* - weight: The "weight" of this step--heavier(/"larger") values sink to the * - weight: The "weight" of this step--heavier(/"larger") values sink to the
* end of the process while smaller(/"lighter") values are executed first. * end of the process while smaller(/"lighter") values are executed first.
@ -240,9 +245,9 @@ function hook_islandora_undeletable_datastreams(array $models) {}
* - file: A file to include (relative to the module's path, including the * - file: A file to include (relative to the module's path, including the
* file's extension). * file's extension).
*/ */
function hook_islandora_ingest_steps(array $configuration) { function hook_islandora_ingest_steps(array $form_state) {
return array( return array(
array( 'my_cool_step_definition' => array(
'type' => 'form', 'type' => 'form',
'weight' => 1, 'weight' => 1,
'form_id' => 'my_cool_form', 'form_id' => 'my_cool_form',
@ -253,6 +258,11 @@ function hook_islandora_ingest_steps(array $configuration) {
/** /**
* Content model specific version of hook_islandora_ingest_steps(). * Content model specific version of hook_islandora_ingest_steps().
* *
* XXX: Content models are not selected in a generic manner. Currently, this
* gets called for every content model in the "configuration", yet the
* configuration never changes. We should determine a consistent way to bind
* content models, so as to consistently be able to build steps.
*
* @see hook_islandora_ingest_steps() * @see hook_islandora_ingest_steps()
*/ */
function hook_CMODEL_PID_islandora_ingest_steps(array $configuration) {} function hook_CMODEL_PID_islandora_ingest_steps(array $form_state) {}

Loading…
Cancel
Save