Library Class Reference

class Library More...

Inheritance diagram for Library:

Public Member Functions
	loadFromAlma ($code)
	populate library with info from Alma More...
	getAllLocations ()
	get all locations configured for the library More...
	getOneLocation ($otherthan=array())
	get one location configured for the library 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	getAllLibraries ()
	get all libraries configured for the institution More...
static	getOneLibrary ($otherthan=array())
	get one library configured by the institution More...
static	getOneLibraryLocation ($otherthan=array())
	get one library configured by the institution More...

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

Detailed Description

class Library

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

Member Function Documentation

getAllLibraries()

static Library::getAllLibraries ( )

static

get all libraries configured for the institution

Returns

array of Library objects

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

    {

        global $grima;

        $xml = $grima->getAllLibraries();

        $xpath = new DomXpath($xml);

        $codes = $xpath->query('//library/code');

        $libarray = array();

        foreach ($codes as $code) {

            $lib = new Library();

            $lib->loadFromAlma($code->nodeValue);

            $libarray[] = $lib;

        }

        return $libarray;

    }

References $grima, and AlmaObject\$xml.

getAllLocations()

Library::getAllLocations

(

)

get all locations configured for the library

Returns

array of Location objects

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

    {

        global $grima;

        $xml = $grima->getAllLocations($this['code']);

        $xpath = new DomXpath($xml);

        $codes = $xpath->query('//location/code');

        $locarray = array();

        foreach ($codes as $code) {

            $loc = new Location();

            $loc->loadFromAlma($this['code'], $code->nodeValue);

            $locarray[] = $loc;

        }

        return $locarray;

    }

References $grima, and AlmaObject\$xml.

getOneLibrary()

static Library::getOneLibrary (   $otherthan = array() )

static

get one library configured by the institution

Parameters

Array

$otherthan

- a list of codes for libraries not wanted

Returns

one library object

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

    {

        global $grima;

        $xml = $grima->getAllLibraries();

        $xpath = new DomXpath($xml);

        $codes = $xpath->query('//library/code');

 

        foreach ($codes as $code) {

            if (! in_array($code, $otherthan)) {

                $lib = new Library();

                $lib->loadFromAlma($code);

                return $lib;

            }

        }

        throw new Exception("No libraries found.");

    }

References $grima, and AlmaObject\$xml.

Referenced by GrimaDataStore\setup().

getOneLibraryLocation()

static Library::getOneLibraryLocation (   $otherthan = array() )

static

get one library configured by the institution

Parameters

Array

$otherthan

- a list of pairs of codes for libraries/locations not wanted

Returns

one library object

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

    {

        global $grima;

 

        $xml = $grima->getAllLibraries();

        $xpath = new DomXpath($xml);

        $library_codes = $xpath->query('//library/code');

 

        foreach ($library_codes as $library_code) {

            $lib = new Library();

            $lib->loadFromAlma($library_code->nodeValue);

            $arr = array();

            foreach ($otherthan as $other) {

                if ($other[0] == $library_code->nodeValue) {

                    $arr[] = $other[1];

                }

            }

            try {

                $loc = $lib->getOneLocation($arr);

                return $loc;

            } catch (Exception $e) {

                continue;

            }

        }

        throw new Exception("No suitable library/location found.");

    }

References $grima, and AlmaObject\$xml.

getOneLocation()

Library::getOneLocation

(

$otherthan = array()

)

get one location configured for the library

Parameters

Array

$otherthan

- a list of codes for locations not wanted

Returns

Location object

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

    {

        global $grima;

        $xml = $grima->getAllLocations($this['code']);

        $xpath = new DomXpath($xml);

        $codes = $xpath->query('//location/code');

        foreach ($codes as $code) {

            if (! in_array($code->nodeValue, $otherthan)) {

                $loc = new Location();

                $loc->loadFromAlma($this['code'], $code->nodeValue);

                return $loc;

            }

        }

        throw new Exception("No locations found.");

    }

References $grima, and AlmaObject\$xml.

loadFromAlma()

Library::loadFromAlma

(

$code

)

populate library with info from Alma

Parameters

String

$code

- code of library to pull from Alma

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

    {

        global $grima;

        $this->xml = $grima->getLibrary($code);

    }

References $grima.

Member Data Documentation

$el_address

Library::$el_address

Initial value:

= array(
        'code' => '//code',
        'path' => '//path',
        'name' => '//name',
        'resource_sharing' => '//resource_sharing',
    )

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

---

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

• grimas/grima-lib.php