Methods for fields and subfields in Alma's MARCXML. More...

Inheritance diagram for AlmaObjectWithMARC:

Public Member Functions
	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)

Public Attributes
	$marc

Public Attributes inherited from AlmaObject
	$el_access = array()

	$xml

	$templateDir = __DIR__ . "/templates"

Detailed Description

Methods for fields and subfields in Alma's MARCXML.

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

Member Function Documentation

◆ addControlField()

AlmaObjectWithMARC::addControlField	(	$tag,
		$data
	)

add a data field to the MARC record using Normac

Parameters

string	$tag	a three character MARC tag
string	$data	control field data

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

    {

        $this->useNormac(); // this function uses normac

        $subarray = array();

        $field = new ISO2709Field($tag, $data);

        $this->marc->AppendField($field, true);

    }

References useNormac().

◆ addDataField()

AlmaObjectWithMARC::addDataField	(	$tag,
		$indicators,
		$subfields
	)

add a data field to the MARC record using Normac

Parameters

string	$tag	a three character MARC tag
string	$indicators	both indicators in one string
Array	$subfields	each entry of the form $code => $value

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

    {

        $this->useNormac(); // this function uses normac

        $subarray = array();

        foreach ($subfields as $k => $v) {

            $subarray[] = new ISO2709Subfield($k, $v);

        }

        $field = new ISO2709Field($tag, null, $indicators, $subarray);

        $fieldstr = $field->AsMnemonicString();

        $fields = $this->marc->getFields($tag);

        $found = false;

        foreach($fields as $f) {

            $fstr = $f->AsMnemonicString();

            if ($fstr == $fieldstr) {

                $found = true;

            } else {

                #error_log($fstr . " vs " . $fieldstr);

            }

        }

        if (! $found) {

            $this->marc->AppendField($field, true);

        }

    }

References useNormac().

◆ appendField()

AlmaObjectWithMARC::appendField	(	$tag,
		$ind1,
		$ind2,
		$subfields
	)

add a field to the MARC record

Parameters

string	$tag	a three character MARC tag
Int	$ind1	one digit, first indicator
Int	$ind2	second digit, second indicator
Array	$subfields	each entry of the form $code => $value

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

          : replace with normac

    {

        $this->useNormac(); // this function uses normac

        $subs = array();

        foreach ($subfields as $k => $v) {

            $subfa = new ISO2709Subfield($k, $v);

            $subs[] = $subfa;

        }

        $field = new ISO2709Field($tag, null, $ind1.$ind2, $subs);

        $this->marc->AppendField($field,true);

        /* XXX: sheesh

        $frag = "<datafield ind1=\"$ind1\" ind2=\"$ind2\" tag=\"$tag\">";

        foreach ($subfields as $k => $v) {

            $frag .= "<subfield code=\"$k\">$v</subfield>";

        }

        $frag .= "</datafield>";

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

        $record = $xpath->query("//record");

        appendInnerXML($record[0], $frag);

        */

    }

References useNormac().

Referenced by replaceOrAddSubfield().

◆ deleteField()

AlmaObjectWithMARC::deleteField ( $tag )

delete all $tag fields from the MARC record

Parameters

string $tag a three character MARC tag

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

    {

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

        $fields = $xpath->query("//record/datafield[@tag='$tag']");

        foreach ($fields as $field) {

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

        }

    }

◆ deleteFieldMatching()

AlmaObjectWithMARC::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 in Holding.

Definition at line 2472 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 getFields(), and useNormac().

◆ deleteSubfieldMatching()

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

delete subfields matching a regex

Parameters

Array $subfields each entry of the form $code => $value

Reimplemented in Holding.

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

    {

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

        $subfs = $xpath->query("//datafield[@tag='$tag']/subfield[@code='$code']");

        foreach ($subfs as $subf) {

            if (preg_match($regex, $subf->nodeValue)) {

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

            }

        }

    }

◆ getFields()

AlmaObjectWithMARC::getFields ( $tag )

get fields for the given MARC tag

Parameters

String $tag field

Returns: Array of ISO2709Field objects

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

    {

        $this->useNormac(); // this function uses normac

        return $this->marc->getFields($tag);

    }

References useNormac().

Referenced by deleteFieldMatching(), Holding\deleteFieldMatching(), Holding\deleteSubfieldMatching(), Holding\getInstitutionCode(), Holding\getLibraryCode(), Holding\getLocationCode(), Holding\getMethodOfAcquisition(), Bib\offsetGet(), Holding\setCallNumberType(), Holding\setInstitutionCode(), Holding\setLibraryCode(), Holding\setLocationCode(), and Holding\setMethodOfAcquisition().

◆ getMarcFields()

AlmaObjectWithMARC::getMarcFields ( $tag )

get fields for the given MARC tag

Parameters

String $tag field

Returns: Array of MARCField Objects

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

    {

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

        $tag = preg_replace('/X*$/', '', $tag);

        $tag = preg_replace('/\.*$/', '', $tag);

        $fields = $xpath->query("//record/datafield[starts-with(@tag,'$tag')]");

        $fieldarr = array();

        foreach ($fields as $field) {

            $marcfield = new MARCField();

            // indicators?

            $subfieldarr = array();

            foreach ($field->childNodes as $child) {

                $subfieldarr[] = array(

                    $child->attributes[0]->value,

                    $child->nodeValue

                );

            }

            $fieldarr[] = $subfieldarr;

        }

        return $fieldarr;

    }

◆ getSubfieldValues()

AlmaObjectWithMARC::getSubfieldValues	(	$tag,
		$code
	)

get subfield value

Parameters

String	$tag	field
String	$code	subfield

Returns: Array array containing all values of subfield

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

    {

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

        $subfields = $xpath->query("//record/datafield[@tag='$tag']/subfield[@code='$code']");

        $arr = array();

        foreach ($subfields as $subfield) {

            $arr[] = $subfield->nodeValue;

        }

        return $arr;

    }

Referenced by Holding\offsetGet().

◆ normacToXML()

AlmaObjectWithMARC::normacToXML ( )

convert normac fields back to XML

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

    {

        if (isset($this->marc)) {

            $newRecord = new DOMDocument;

            $marc = preg_replace('/&(?!#?[a-z0-9]+;)/', '&amp;', 

                $this->marc->asXMLString());

            $newRecord->loadXML($marc);

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

            $record = $xpath->query('//record');

            $node = $record[0];

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

            $node = $this->xml->importNode($newRecord->documentElement, true);

            $this->xml->documentElement->appendChild($node);

        }

    }

References $marc.

Referenced by Bib\addToAlma(), Holding\addToAlmaBib(), Holding\setCallNumber(), Bib\updateAlma(), and Holding\updateAlma().

◆ replaceOrAddSubfield()

AlmaObjectWithMARC::replaceOrAddSubfield	(	$tag,
		$code,
		$value
	)

replace or add subfield value in marc

Parameters

string	$tag	a three character MARC tag
string	$code	a one letter subfield code
string	$value	what to set the value to

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

          : replace with normac

    {

        // very shady but sometimes needed

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

        $fields = $xpath->query("//record/datafield[@tag='$tag']");

        if (sizeof($fields) == 0) {

            $this->appendField($tag, ' ', ' ', array($code => $value));

        } else {

            $done = false;

            foreach ($fields[0]->childNodes as $subfield) {

                if ($subfield->nodeType !== 1) {

                    continue;

                }

                if ($subfield->getAttribute("code") == $code) {

                    $subfield->nodeValue = $value;

                    $done = true;

                    break;

                }

            }

            if (!$done) {

                $subfield = $this->xml->createElement("subfield");

                $subfield->setAttribute("code", $code);

                $subfield->appendChild($this->xml->createTextNode($value));

                $fields[0]->appendChild($subfield);

            }

        }

    }

References appendField().

Referenced by Bib\offsetSet().

◆ useNormac()

AlmaObjectWithMARC::useNormac ( )

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

    {

        if (isset($this->marc)) { 

            return;

        }

        $this->marc = new MARC21Record();

        $this->marc->loadFromString($this->xml->saveXML());

    }

Referenced by addControlField(), addDataField(), appendField(), deleteFieldMatching(), Holding\deleteFieldMatching(), Holding\deleteSubfieldMatching(), getFields(), Holding\getInstitutionCode(), Holding\getLibraryCode(), Holding\getLocationCode(), Holding\getMethodOfAcquisition(), Bib\loadFromAlma(), Holding\setCallNumberType(), Holding\setInstitutionCode(), Holding\setLibraryCode(), Holding\setLocationCode(), and Holding\setMethodOfAcquisition().

Member Data Documentation

◆ $marc

AlmaObjectWithMARC::$marc

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

Referenced by normacToXML().

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

grimas/grima-lib.php

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ addControlField()

◆ addDataField()

◆ appendField()

◆ deleteField()

◆ deleteFieldMatching()

◆ deleteSubfieldMatching()

◆ getFields()

◆ getMarcFields()

◆ getSubfieldValues()

◆ normacToXML()

◆ replaceOrAddSubfield()

◆ useNormac()

Member Data Documentation

◆ $marc