Inheritance diagram for Holding:

Public Member Functions
	offsetSet ($offset, $value)

	offsetGet ($offset)

	loadFromAlma ($mms_id, $holding_id)
	populates the record from Alma More...

	getMmsIfNeeded ()
	populates the MMS ID if not already known More...

	loadFromAlmaX ($holding_id)
	populates the record from Alma - only requires holding_id More...

	addToAlmaBib ($mms_id)
	adds a new holding record to the specified bib More...

	hasItems ()
	checks whether a holding record has any items More...

	updateAlma ()
	update holding record in Alma More...

	deleteFromAlma ()
	delete the holding record from Alma More...

	getMethodOfAcquisition ()
	retrieves method of acquisition, fixed field 008/07 https://www.loc.gov/marc/holdings/hd008.html More...

	setMethodOfAcquisition ($code)
	sets method of acquisition, fixed field 008/07 https://www.loc.gov/marc/holdings/hd008.html More...

	getInstitutionCode ()
	retrieves institution code from 852a More...

	setInstitutionCode ($code)
	sets institution code from 852a More...

	getLibraryCode ()
	retrieves library code from 852b More...

	setLibraryCode ($code)
	sets library code from 852b More...

	getLocationCode ()
	retrieves location code from 852c More...

	setLocationCode ($code)
	sets location code from 852c More...

	setCallNumberType ($ind1) # upgrade to normac

	setCallNumber ($h, $i, $ind1) # upgrade to normac

	moveToBib ($mms_id)
	moves the holding from one bib to another – only for empty holdings! More...

	getItems ()
	populate items property with Items objects ## XXX TEST More...

	getItemList ()
	populates itemList property from Alma More...

	deleteTreeFromAlma ()
	delete the holding and all of its items More...

	deleteSubfieldMatching ($tag, $code, $regex)
	delete subfields matching a regex More...

	deleteFieldMatching ($tag, $code, $regex)
	delete fields with subfields matching a regex More...

Public Member Functions inherited from AlmaObjectWithMARC
	useNormac ()

	addControlField ($tag, $data)
	add a data field to the MARC record using Normac More...

	addDataField ($tag, $indicators, $subfields)
	add a data field to the MARC record using Normac More...

	normacToXML ()
	convert normac fields back to XML More...

	appendField ($tag, $ind1, $ind2, $subfields) ## XXX
	add a field to the MARC record More...

	getFields ($tag)
	get fields for the given MARC tag More...

	getMarcFields ($tag)
	get fields for the given MARC tag More...

	getSubfieldValues ($tag, $code)
	get subfield value More...

	deleteField ($tag)
	delete all $tag fields from the MARC record More...

	deleteSubfieldMatching ($tag, $code, $regex)
	delete subfields matching a regex More...

	deleteFieldMatching ($tag, $code, $regex)
	delete fields with subfields matching a regex More...

	replaceOrAddSubfield ($tag, $code, $value) ## XXX
	replace or add subfield value in marc More...

Public Member Functions inherited from AlmaObject
	__construct ()
	create new blank Alma Object More...

	offsetExists ($offset)

	offsetGet ($offset)

	offsetSet ($offset, $value)

	offsetUnset ($offset)

Static Public Member Functions
static	getMmsFromHoldingID ($holding_id)
	populates the MMS ID More...

Public Attributes
	$itemList

	$items = array()

	$xml

	$el_address

Public Attributes inherited from AlmaObjectWithMARC
	$marc

Public Attributes inherited from AlmaObject
	$el_access = array()

	$xml

	$templateDir = __DIR__ . "/templates"

Detailed Description

class Holding

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

Member Function Documentation

◆ addToAlmaBib()

Holding::addToAlmaBib ( $mms_id )

adds a new holding record to the specified bib

Parameters

string $mms_id bib record to add the holdings record

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

    {

        global $grima;

        $this->normacToXML();

        $this->xml = $grima->postHolding($mms_id, $this->xml);

        $this['mms_id'] = $mms_id;

    }

References $grima, and AlmaObjectWithMARC\normacToXML().

Referenced by moveToBib().

◆ deleteFieldMatching()

Holding::deleteFieldMatching	(	$tag,
		$code,
		$regex
	)

delete fields with subfields matching a regex

For example, delete all 856 fields with $u that contain "ezproxy" case insensitively, like: $this->deleteFieldMatching("856","u","/ezproxy/i");

Parameters

string	$tag	a three character MARC tag
string	$code	a subfield code
string	$regex	a regular expression

Reimplemented from AlmaObjectWithMARC.

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

    {

        $this->useNormac();

        foreach ($this->getFields($tag) as $field) {

            foreach ($field->getSubfields($code) as $subfield) {

                if (preg_match($regex,$subfield->data)) {

                    $field->delete();

                    break;

                }

            }

        }

    }

References AlmaObjectWithMARC\getFields(), and AlmaObjectWithMARC\useNormac().

◆ deleteFromAlma()

Holding::deleteFromAlma ( )

delete the holding record from Alma

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

    {

        global $grima;

        $grima->deleteHolding($this['mms_id'], $this['holding_id']);

    }

References $grima.

Referenced by deleteTreeFromAlma(), and moveToBib().

◆ deleteSubfieldMatching()

Holding::deleteSubfieldMatching	(	$tag,
		$code,
		$regex
	)

delete subfields matching a regex

For example, delete all subfield $z in an 856 that contain "click" case insensitively, like: $this->deleteSubfieldMatching("856","z","/click/i");

Parameters

string	$tag	a three character MARC tag
string	$code	a subfield code
string	$regex	a regular expression

Reimplemented from AlmaObjectWithMARC.

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

    {

        $this->useNormac();

        foreach ($this->getFields($tag) as $field) {

            foreach ($field->getSubfields($code) as $subfield) {

                if (preg_match($regex,$subfield->data)) {

                    $subfield->delete();

                }

            }

        }

    }

References AlmaObjectWithMARC\getFields(), and AlmaObjectWithMARC\useNormac().

◆ deleteTreeFromAlma()

Holding::deleteTreeFromAlma ( )

delete the holding and all of its items

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

    {

        global $grima;

        $this->getItemList();

        foreach ($this->itemList->items as $item) {

            $item->deleteFromAlma("true");

        }

        $this->deleteFromAlma();

    }

References $grima, deleteFromAlma(), and getItemList().

◆ getInstitutionCode()

Holding::getInstitutionCode ( )

retrieves institution code from 852a

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

    {

        $this->useNormac();

        return $this->getFields("852")[0]->getSubFields("a")[0]->data;

    }

References AlmaObjectWithMARC\getFields(), and AlmaObjectWithMARC\useNormac().

Referenced by offsetGet().

◆ getItemList()

Holding::getItemList ( )

populates itemList property from Alma

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

    {

        global $grima;

        $this->getMmsIfNeeded();

        $this->itemList = new ItemList($this['mms_id'], $this['holding_id']);

    }

References $grima, and getMmsIfNeeded().

Referenced by deleteTreeFromAlma(), getItems(), and hasItems().

◆ getItems()

Holding::getItems ( )

populate items property with Items objects ## XXX TEST

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

    {

        $this->getItemList();

        $this->items =& $this->itemList->items;

        return $this->items;

    }

References $items, and getItemList().

◆ getLibraryCode()

Holding::getLibraryCode ( )

retrieves library code from 852b

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

    {

        $this->useNormac();

        return $this->getFields("852")[0]->getSubFields("b")[0]->data;

    }

References AlmaObjectWithMARC\getFields(), and AlmaObjectWithMARC\useNormac().

Referenced by offsetGet().

◆ getLocationCode()

Holding::getLocationCode ( )

retrieves location code from 852c

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

    {

        $this->useNormac();

        return $this->getFields("852")[0]->getSubFields("c")[0]->data;

    }

References AlmaObjectWithMARC\getFields(), and AlmaObjectWithMARC\useNormac().

Referenced by offsetGet().

◆ getMethodOfAcquisition()

Holding::getMethodOfAcquisition ( )

retrieves method of acquisition, fixed field 008/07 https://www.loc.gov/marc/holdings/hd008.html

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

    {

        $this->useNormac(); 

        $fixed_fields = $this->getFields("008")[0];

        return substr($fixed_fields->data, 7, 1);

    }

References AlmaObjectWithMARC\getFields(), and AlmaObjectWithMARC\useNormac().

◆ getMmsFromHoldingID()

static Holding::getMmsFromHoldingID ( $holding_id )

static

populates the MMS ID

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

    {

        global $grima;

        $report = new AnalyticsReport();

        // $report->path = "/shared/UK Libraries- University of Kentucky (UKY)/Reports/Kathryn/HoldingToMMS";

        $report->path = "/shared/Community/Reports/Institutions/University of Kentucky/Kathryn/HoldingToMMS";

        $report->filter = '

<sawx:expr xsi:type="sawx:comparison" op="equal" xmlns:saw="com.siebel.analytics.web/report/v1.1"

xmlns:sawx="com.siebel.analytics.web/expression/v1.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <sawx:expr xsi:type="sawx:sqlExpression">"Holding Details"."Holding Id"</sawx:expr><sawx:expr xsi:type="xsd:string">{holding_id}</sawx:expr>

</sawx:expr>';

        $report->runReport(array('holding_id' => $holding_id), 1);

        if (count($report->rows) == 1) {

            return $report->rows[0][1];

        } else {

            throw new Exception("No MMS for Holding ID $holding_id");

        }

    }

References $grima.

Referenced by getMmsIfNeeded(), and loadFromAlmaX().

◆ getMmsIfNeeded()

Holding::getMmsIfNeeded ( )

populates the MMS ID if not already known

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

    {

        global $grima;

        if (!isset($this['mms_id']) or (!$this['mms_id'])) {

            $this['mms_id'] = Holding::getMmsFromHoldingID($this['holding_id']);

        }

    }

References $grima, and getMmsFromHoldingID().

Referenced by getItemList().

◆ hasItems()

Holding::hasItems ( )

checks whether a holding record has any items

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

    {

        $this->getItemList();

        return (sizeof($this->itemList->items) > 0); // XXX test

    }

References getItemList().

◆ loadFromAlma()

Holding::loadFromAlma	(	$mms_id,
		$holding_id
	)

populates the record from Alma

Parameters

$mms_id	MMS ID of bib record
$holding_id	Holding ID of holding

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

    {

        global $grima;

        $this->xml = $grima->getHolding($mms_id, $holding_id);

        $this['mms_id'] = $mms_id;

    }

References $grima.

◆ loadFromAlmaX()

Holding::loadFromAlmaX ( $holding_id )

populates the record from Alma - only requires holding_id

Parameters

$holding_id Holding ID of holding

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

    {

        global $grima;

        $mms_id = Holding::getMmsFromHoldingID($holding_id);

        $this->xml = $grima->getHolding($mms_id, $holding_id);

        $this['mms_id'] = $mms_id;

    }

References $grima, and getMmsFromHoldingID().

◆ moveToBib()

Holding::moveToBib ( $mms_id )

moves the holding from one bib to another – only for empty holdings!

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

    {

        $this->deleteFromAlma();

        $this->addToAlmaBib($mms_id);

    }

References addToAlmaBib(), and deleteFromAlma().

◆ offsetGet()

Holding::offsetGet ( $offset )

Reimplemented from AlmaObject.

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

    {

        // XXX TEST

        if ($offset == "library") {

            $lib = new Library();

            $lib->loadFromAlma($this['library_code']);

            return $lib['name'];

        }

        if ($offset == "location") {

            $loc = new Location();

            $loc->loadFromAlma($this['library_code'], $this['location_code']);

            return $loc['name'];

        }

        if ($offset == "inst_code") {

            return $this->getInstitutionCode();

        }

        if ($offset == "library_code") {

            return $this->getLibraryCode();

        }

        if ($offset == "location_code") {

            return $this->getLocationCode();

        }

        if ($offset == "call_number") {

            $Hs = $this->getSubfieldValues("852", "h");

            $Is = $this->getSubfieldValues("852", "i");

            $acc = "";

            foreach ($Hs as $h) {

                $acc .= "$h ";

            }

            foreach ($Is as $i) {

                $acc .= "$i ";

            }

            return rtrim($acc);

        }

        return parent::offsetGet($offset);

    }

References getInstitutionCode(), getLibraryCode(), getLocationCode(), and AlmaObjectWithMARC\getSubfieldValues().

◆ offsetSet()

Holding::offsetSet	(	$offset,
		$value
	)

Reimplemented from AlmaObject.

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

    {

        if ($offset == "mms_id") {

            $this->el_override['mms_id'] = $value;

            return;

        } 

        if ($offset == "location_code") {

            $this->setLocationCode($value);

            return;

        }

        parent::offsetSet($offset, $value);

    }

References setLocationCode().

◆ setCallNumber()

Holding::setCallNumber	(	$h,
		$i,
		$ind1
	)

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

    {

        $this->normacToXML();

        $xpath = new DomXpath($this->xml);

        $xpath->query("//record/datafield[@tag='852']")->item(0)->setAttribute("ind1", $ind1);

        $field852 = $xpath->query("//record/datafield[@tag='852']")->item(0);

        $subfieldHs = $xpath->query("subfield[@code='h']", $field852);

        foreach ($subfieldHs as $subfieldH) {

            $subfieldH->parentNode->removeChild($subfieldH);

        }

        $subfieldIs = $xpath->query("subfield[@code='i']", $field852);

        foreach ($subfieldIs as $subfieldI) {

            $subfieldI->parentNode->removeChild($subfieldI);

        }

        appendInnerXML($field852, "<subfield code=\"h\">$h</subfield>");

        if ($i) {

            appendInnerXML($field852, "<subfield code=\"i\">$i</subfield>");

        }

    }

References appendInnerXML(), and AlmaObjectWithMARC\normacToXML().

◆ setCallNumberType()

Holding::setCallNumberType ( $ind1 )

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

    {

        # XXX check argument

        $this->useNormac();

        $the852 = $this->getFields("852")[0];

        $the852->indicators[0] = $ind1;

        /*

        $this->normacToXML();

        $xpath = new DomXpath($this->xml);

        $xpath->query("//record/datafield[@tag='852']")->item(0)->setAttribute("ind1", $ind1);

        $field852 = $xpath->query("//record/datafield[@tag='852']")->item(0);

        $subfieldHs = $xpath->query("subfield[@code='h']", $field852);

        foreach ($subfieldHs as $subfieldH) {

            $subfieldH->parentNode->removeChild($subfieldH);

        }

        $subfieldIs = $xpath->query("subfield[@code='i']", $field852);

        foreach ($subfieldIs as $subfieldI) {

            $subfieldI->parentNode->removeChild($subfieldI);

        }

        appendInnerXML($field852, "<subfield code=\"h\">$h</subfield>");

        if ($i) {

            appendInnerXML($field852, "<subfield code=\"i\">$i</subfield>");

        }

        */

    }

References AlmaObjectWithMARC\getFields(), and AlmaObjectWithMARC\useNormac().

◆ setInstitutionCode()

Holding::setInstitutionCode ( $code )

sets institution code from 852a

Parameters

string $code - institution code

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

    {

        $this->useNormac();

        $instsf = $this->getFields("852")[0]->getSubFields("a")[0];

        $instsf->data = $code;

    }

References AlmaObjectWithMARC\getFields(), and AlmaObjectWithMARC\useNormac().

◆ setLibraryCode()

Holding::setLibraryCode ( $code )

sets library code from 852b

Parameters

string $code - library code

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

    {

        $this->useNormac();

        $libsf = $this->getFields("852")[0]->getSubFields("b")[0];

        $libsf->data = $code;

    }

References AlmaObjectWithMARC\getFields(), and AlmaObjectWithMARC\useNormac().

◆ setLocationCode()

Holding::setLocationCode ( $code )

sets location code from 852c

Parameters

string $code - location code

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

    {

        $this->useNormac();

        $locsf = $this->getFields("852")[0]->getSubFields("c")[0];

        $locsf->data = $code;

    }

References AlmaObjectWithMARC\getFields(), and AlmaObjectWithMARC\useNormac().

Referenced by offsetSet().

◆ setMethodOfAcquisition()

Holding::setMethodOfAcquisition ( $code )

sets method of acquisition, fixed field 008/07 https://www.loc.gov/marc/holdings/hd008.html

Parameters

char $code - code for method of acquisition

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

    {

        $this->useNormac(); 

        $fixed_fields = $this->getFields("008")[0];

        $newstr = substr_replace($fixed_fields->data,$code,7,1);

        $fixed_fields->data = $newstr;

    }

References AlmaObjectWithMARC\getFields(), and AlmaObjectWithMARC\useNormac().

◆ updateAlma()

Holding::updateAlma ( )

update holding record in Alma

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

    {

        global $grima;

        $this->normacToXML(); # XXX

        #error_log($this->xml->saveXML());

        $grima->putHolding($this['mms_id'], $this['holding_id'], $this->xml);

    }

References $grima, and AlmaObjectWithMARC\normacToXML().

Member Data Documentation

◆ $el_address

Holding::$el_address

Initial value:

= array(
        'holding_id' => '//holding_id',
        'shelving_scheme' => "/holding/record/datafield[@tag='852']/@ind1",
 
        
        'inst_code' => "/holding/record/datafield[@tag='852']/subfield[@code='a']",
        'library_code' => "/holding/record/datafield[@tag='852']/subfield[@code='b']",
        'location_code' => "/holding/record/datafield[@tag='852']/subfield[@code='c']",
 
        'classification_part' => "/holding/record/datafield[@tag='852']/subfield[@code='h']",
        '852h' => "/holding/record/datafield[@tag='852']/subfield[@code='h']",
 
        'item_part' => "/holding/record/datafield[@tag='852']/subfield[@code='i']",
        '852i' => "/holding/record/datafield[@tag='852']/subfield[@code='i']",
        
 
    )

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

◆ $itemList

Holding::$itemList

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

◆ $items

Holding::$items = array()

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

Referenced by getItems().

◆ $xml

Holding::$xml

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

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

grimas/grima-lib.php

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ addToAlmaBib()

◆ deleteFieldMatching()

◆ deleteFromAlma()

◆ deleteSubfieldMatching()

◆ deleteTreeFromAlma()

◆ getInstitutionCode()

◆ getItemList()

◆ getItems()

◆ getLibraryCode()

◆ getLocationCode()

◆ getMethodOfAcquisition()

◆ getMmsFromHoldingID()

◆ getMmsIfNeeded()

◆ hasItems()

◆ loadFromAlma()

◆ loadFromAlmaX()

◆ moveToBib()

◆ offsetGet()

◆ offsetSet()

◆ setCallNumber()

◆ setCallNumberType()

◆ setInstitutionCode()

◆ setLibraryCode()

◆ setLocationCode()

◆ setMethodOfAcquisition()

◆ updateAlma()

Member Data Documentation

◆ $el_address

◆ $itemList

◆ $items

◆ $xml