Browse Source

Flesh out inline function documentation.

pull/306/head
Adam Vessey 12 years ago
parent
commit
12bd300584
  1. 8
      includes/breadcrumb.inc
  2. 4
      islandora.api.php

8
includes/breadcrumb.inc

@ -39,6 +39,14 @@ function islandora_get_breadcrumbs($object) {
* The object id whose parent will be fetched for the next link. * The object id whose parent will be fetched for the next link.
* @param FedoraRepository $repository * @param FedoraRepository $repository
* The fedora repository. * The fedora repository.
* @param array $context
* An associative array of context for internal use when recursing. Currently
* only used to track a single value:
* - level: The number of child-parent relationships to follow. Defaults to
* 10.
*
* @return array
* An array of links representing the breadcrumb trail, "root" first.
*/ */
function islandora_get_breadcrumbs_recursive($pid, FedoraRepository $repository, array &$context = NULL) { function islandora_get_breadcrumbs_recursive($pid, FedoraRepository $repository, array &$context = NULL) {
// Before executing the query, we have a base case of accessing the top-level // Before executing the query, we have a base case of accessing the top-level

4
islandora.api.php

@ -45,7 +45,7 @@ function hook_CMODEL_PID_islandora_view_object($object) {
* @param FedoraObject $object * @param FedoraObject $object
* A Tuque FedoraObject being operated on. * A Tuque FedoraObject being operated on.
* @param array $rendered * @param array $rendered
* An arr of rendered views. * The array of rendered views.
*/ */
function hook_islandora_view_object_alter(&$object, &$rendered) { function hook_islandora_view_object_alter(&$object, &$rendered) {
} }
@ -58,7 +58,7 @@ function hook_islandora_view_object_alter(&$object, &$rendered) {
* @param FedoraObject $object * @param FedoraObject $object
* A Tuque FedoraObject being operated on. * A Tuque FedoraObject being operated on.
* @param array $rendered * @param array $rendered
* An arr 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) {
} }

Loading…
Cancel
Save