class Set IN PROGRESS More...

Inheritance diagram for Set:

Public Member Functions
	addToAlma ()
	adds Set to Alma, updates object with current Alma version More...

	loadFromAlma ($set_id)
	populate set with info from Alma More...

	createFromImport ($job_id, $population)
	create a new set in Alma based on a job that just ran More...

	runOnElements ($function, $args=array(), $filter=null, $filter_args=array())
	run a function on every element in the set More...

	getMembers ($limit=-1)

	deleteFromAlma ()
	delete set from Alma More...

	addMember ($id)
	add member to a local set More...

	appendInAlma ($setToAppend)
	add elements to a set More...

	removeAllMembersInAlma ()
	remove all members of the set 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
	$xml

	$members = array()

	$el_address

Public Attributes inherited from AlmaObject
	$el_access = array()

	$xml

	$templateDir = __DIR__ . "/templates"

Detailed Description

class Set IN PROGRESS

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

Member Function Documentation

◆ addMember()

Set::addMember ( $id )

add member to a local set

Parameters

string $id ID of element to add

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

    {

        $frag = "<member><id>$id</id></member>";

        $source = new DOMDocument();

        $source->loadXML($frag);

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

        $members = $xpath->query('//members')->item(0);

        $members->appendChild($this->xml->importNode($source->documentElement, true));

    }

References $members.

◆ addToAlma()

Set::addToAlma ( )

adds Set to Alma, updates object with current Alma version

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

    {

        global $grima;

        $this->xml = $grima->postSet($this->xml);

    }

References $grima.

◆ appendInAlma()

Set::appendInAlma ( $setToAppend )

add elements to a set

Parameters

Set $setToAppend - set whose members should be added to main set

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

    {

        global $grima;

        $grima->postSetManageMembers(

            $this['set_id'], null, 'add_members',

            $setToAppend->xml

        );

    }

References $grima.

◆ createFromImport()

Set::createFromImport	(	$job_id,
		$population
	)

create a new set in Alma based on a job that just ran

Parameters

string	$job_id	- job ID
string	$population	- which records from the job # XXX include here

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

    {

        global $grima;

        $this->xml = $grima->createSetFromImport($job_id, $population);

    }

References $grima.

◆ deleteFromAlma()

Set::deleteFromAlma ( )

delete set from Alma

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

    {

        global $grima;

        $grima->deleteSet($this['set_id']);

    }

References $grima.

◆ getMembers()

Set::getMembers ( $limit = -1 )

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

    {

        // put in $members

        // limit -1 means all

        global $grima;

        if ($limit == -1) { // get them all

            $xml = $grima->getSetMembers($this['set_id'], 0);

            $xpath = new DomXpath($xml);

            $this->size = $xpath->query("//members")->item(0)->getAttribute("total_record_count");

            $limit = $this->size;

        }

        for ($j = 0; $j < ceil($limit/100); $j++) { // how many queries

            $xml = $grima->getSetMembers($this['id'], 100, $j*100);

            $xpath = new DomXpath($xml);

            foreach ($xpath->query("//member") as $member) {

                $this->members[] = new SetMember(

                    $member->childNodes[0]->nodeValue,

                    $member->childNodes[1]->nodeValue

                );

            }

        }

    }

References $grima, and $xml.

◆ loadFromAlma()

Set::loadFromAlma ( $set_id )

populate set with info from Alma

Parameters

string $set_id - id of set to pull from Alma

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

    {

        global $grima;

        $this->xml = $grima->getSet($set_id);

    }

References $grima.

◆ removeAllMembersInAlma()

Set::removeAllMembersInAlma ( )

remove all members of the set

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

    {

        global $grima;

        $emptyset = new Set();

        $emptyset->addMember('9941266686802636'); /* hack */

        $grima->postSetManageMembers(

            $this['set_id'], null, 'replace_members',

            $emptyset->xml

        );

        $grima->postSetManageMembers(

            $this['set_id'], null, 'delete_members',

            $emptyset->xml

        );

    }

References $grima.

◆ runOnElements()

Set::runOnElements	(	$function,
		$args = `array()`,
		$filter = `null`,
		$filter_args = `array()`
	)

run a function on every element in the set

Parameters

string	$function	name of function to run on set elements, accepts element as first argument
array	$args	list of arguments to pass to function in addition to element
string	$filter	run function on only elements where filter function returns true

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

    {

        global $grima;

        $xml = $grima->getSetMembers($this['set_id'], 0);

        $xpath = new DomXpath($xml);

        $this->size = $xpath->query("//members")->item(0)->getAttribute("total_record_count");

        $limit = $this->size;

        for ($j = 0; $j < ceil($limit/100); $j++) { // how many queries

            $xml = $grima->getSetMembers($this['id'], 100, $j*100);

            $xpath = new DomXpath($xml);

            foreach ($xpath->query("//member") as $member) {

                $id = $member->childNodes[0]->nodeValue;

                if (!isset($filter) or ($filter($id, $filter_args))) {

                    $function($id, $args);

                }

            }

        }

    }

References $grima, and $xml.

Member Data Documentation

◆ $el_address

Set::$el_address

Initial value:

= array(
        'set_id' => '//set/id',
        'id' => '//set/id',
        'name' => '//set/name',
        'description' => '//set/description',
        'type' => '//set/type',
        'content' => '//content',
        'private' => '//private',
        'status' => '//status',
        'status_date' => '//status_date',
        'note' => '//note',
        'created_by' => '//created_by',
        'created_date' => '//created_date',
        'query' => '//query',
        'number_of_members' => '//number_of_members',
        'additional_info' => '//additional_info',
    )

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

◆ $members

Set::$members = array()

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

Referenced by addMember().

◆ $xml

Set::$xml

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

Referenced by getMembers(), and runOnElements().

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

◆ addMember()

◆ addToAlma()

◆ appendInAlma()

◆ createFromImport()

◆ deleteFromAlma()

◆ getMembers()

◆ loadFromAlma()

◆ removeAllMembersInAlma()

◆ runOnElements()

Member Data Documentation

◆ $el_address

◆ $members

◆ $xml