Grima  2018-08
Whispering into Alma's ear
Public Member Functions | Public Attributes | List of all members
Item Class Reference

class Item More...

Inheritance diagram for Item:
AlmaObject

Public Member Functions

  loadFromAlma ($mms_id, $holding_id, $item_pid)
  populates item record from Alma More...
 
  loadFromAlmaX ($item_pid)
  populates item record from Alma, only needs item_pid More...
 
  loadFromAlmaBarcode ($barcode)
  populates item record from Alma, using barcode More...
 
  loadFromAlmaBCorX ($id)
  populates item record from Alma using either identifier More...
 
  loadFromItemListNode ($node)
  populate item record from the information in an ItemList node More...
 
  addToAlmaHolding ($mms_id, $holding_id)
  add new item record to holding in Alma More...
 
  addToAlmaHoldingX ($holding_id)
  add new item record to holding in Alma More...
 
  updateAlma ()
  replace item record in Alma More...
 
  deleteFromAlma ($override="false", $holdings="retain")
  delete record from Alma More...
 
- Public Member Functions inherited from AlmaObject
  __construct ()
  create new blank Alma Object More...
 
  offsetExists ($offset)
 
  offsetGet ($offset)
 
  offsetSet ($offset, $value)
 
  offsetUnset ($offset)
 

Public Attributes

  $el_address
 
- Public Attributes inherited from AlmaObject
  $el_access = array()
 
  $xml
 
  $templateDir = __DIR__ . "/templates"
 

Detailed Description

class Item

Definition at line 2869 of file grima-lib.php.

Member Function Documentation

◆ addToAlmaHolding()

Item::addToAlmaHolding (   $mms_id,
  $holding_id 
)

add new item record to holding in Alma

Parameters
string $mms_id MMS ID of bib record
string $holding_id Holding ID of holding record to add item to
Returns
DomDocument item object as it now appears in Alma

Definition at line 3004 of file grima-lib.php.

References $grima.

3004  {
3005  global $grima;
3006  $this->mms_id = $mms_id;
3007  $this->holding_id = $holding_id;
3008  $this->xml = $grima->postItem($mms_id,$holding_id,$this->xml);
3009  return $this->xml;
3010  }
$grima
Definition: grima-lib.php:4293

◆ addToAlmaHoldingX()

Item::addToAlmaHoldingX (   $holding_id )

add new item record to holding in Alma

Parameters
string $holding_id Holding ID of holding record to add item to
Returns
DomDocument item object as it now appears in Alma

Definition at line 3020 of file grima-lib.php.

3020  {
3021  $this->addToAlmaHolding('X',$holding_id);
3022  return $this->xml;
3023  }
addToAlmaHolding($mms_id, $holding_id)
add new item record to holding in Alma
Definition: grima-lib.php:3004

◆ deleteFromAlma()

Item::deleteFromAlma (   $override = "false",
  $holdings = "retain" 
)

delete record from Alma

Parameters
string $override should the item be deleted even if warnings exist? (default false)
string $holdings method for handling holdings record left with no items (retain, delete, suppress)

Definition at line 3049 of file grima-lib.php.

References $grima.

3049  {
3050  global $grima;
3051  $grima->deleteItem($this['mms_id'],$this['holding_id'],$this['item_pid'],$override,$holdings);
3052  }
$grima
Definition: grima-lib.php:4293

◆ loadFromAlma()

Item::loadFromAlma (   $mms_id,
  $holding_id,
  $item_pid 
)

populates item record from Alma

Parameters
string $mms_id MMS ID of bib record
string $holding_id Holding ID of holding record
string $item_pid Item ID of item record

Definition at line 2939 of file grima-lib.php.

References $grima.

2939  {
2940  global $grima;
2941  $this->xml = $grima->getItem($mms_id,$holding_id,$item_pid);
2942  }
$grima
Definition: grima-lib.php:4293

◆ loadFromAlmaBarcode()

Item::loadFromAlmaBarcode (   $barcode )

populates item record from Alma, using barcode

Parameters
string $barcode barcode of record to load from Alma

Definition at line 2961 of file grima-lib.php.

References $grima.

2961  {
2962  global $grima;
2963  $this->xml = $grima->getItemBC($barcode);
2964  }
$grima
Definition: grima-lib.php:4293

◆ loadFromAlmaBCorX()

Item::loadFromAlmaBCorX (   $id )

populates item record from Alma using either identifier

Parameters
string $id identifer of record to load from Alma (can be barcode or item ID)

Definition at line 2974 of file grima-lib.php.

References $grima.

2974  {
2975  global $grima;
2976  if (preg_match("/^23.*/",$id)) { # item_pid
2977  # probably should know about suffix too
2978  $this->loadFromAlmaX($id);
2979  } else {
2980  $this->loadFromAlmaBarcode($id);
2981  }
2982  }
loadFromAlmaBarcode($barcode)
populates item record from Alma, using barcode
Definition: grima-lib.php:2961
$grima
Definition: grima-lib.php:4293
loadFromAlmaX($item_pid)
populates item record from Alma, only needs item_pid
Definition: grima-lib.php:2950

◆ loadFromAlmaX()

Item::loadFromAlmaX (   $item_pid )

populates item record from Alma, only needs item_pid

Parameters
string $item_pid item ID of record to load from Alma

Definition at line 2950 of file grima-lib.php.

References $grima.

2950  {
2951  global $grima;
2952  $this->xml = $grima->getItem('X','X',$item_pid);
2953  }
$grima
Definition: grima-lib.php:4293

◆ loadFromItemListNode()

Item::loadFromItemListNode (   $node )

populate item record from the information in an ItemList node

Parameters
DomNode $node node from an ItemList

Definition at line 2991 of file grima-lib.php.

2991  {
2992  $this->xml = new DomDocument();
2993  $this->xml->appendChild($this->xml->importNode($node,true));
2994  }

◆ updateAlma()

Item::updateAlma ( )

replace item record in Alma

Returns
DomDocument item object as it now appears in Alma

Definition at line 3031 of file grima-lib.php.

References $grima.

3031  {
3032  global $grima;
3033  return $grima->putItem(
3034  $this['mms_id'],
3035  $this['holding_id'],
3036  $this['item_pid'],
3037  $this->xml
3038  );
3039  }
$grima
Definition: grima-lib.php:4293

Member Data Documentation

◆ $el_address

Item::$el_address

Definition at line 2871 of file grima-lib.php.


The documentation for this class was generated from the following file: