eZISBNRegistrantRange Class Reference

The class eZISBNRegistrantRange handles Registrant ranges. More...

Inheritance diagram for eZISBNRegistrantRange:

Collaboration diagram for eZISBNRegistrantRange:

List of all members.

Public Member Functions
	eZISBNRegistrantRange ($row)
Static Public Member Functions
static	cleanAll ()
static	create ($ISBNGroupID, $fromNumber, $toNumber, $registrantFrom, $registrantTo, $length)
static	definition ()
static	extractRegistrant ($isbnNr, $group, $groupRange, &$registrantLength)
static	fetchListByGroupID ($groupID, $asObject=true)
static	removeByID ($id)

---

Detailed Description

The class eZISBNRegistrantRange handles Registrant ranges.

Has information about how the different ranges the registrant element could be in. Example: From 00 to 19 and continues from 200-699. This means that the length of the registrant can differ from range to range.

The registrant element is the third element in the ISBN-13 number, after the Prefix and Registration group number.

Example: 978-0-11-000222-4 where 11 is the registrant number.

The different Registrant ranges are described in more detail at http://www.isbn-international.org

Definition at line 29 of file ezisbnregistrantrange.php.

---

Member Function Documentation

static eZISBNRegistrantRange::cleanAll

(

)

[static]

Removes all ISBN group ranges from the database.

Definition at line 195 of file ezisbnregistrantrange.php.

Referenced by eZISBNType\cleanDBDataBeforeImport().

static eZISBNRegistrantRange::create	(	$	ISBNGroupID,
		$	fromNumber,
		$	toNumber,
		$	registrantFrom,
		$	registrantTo,
		$	length
	)		[static]

Parameters:

$ISBNGroupID	The id that point to the ISBN Group object (Which contain info about the area and the unique group number).
$fromNumber	Group is starting from test number, which is based on. Example: 20000 the 5 numbers after the Prefix number and Registration Group number.
$toNumber	Group is ending on test number, which is based on. Example: 69999 the 5 numbers after the Prefix number and Registration Group number.
$registrantFrom	Registrant number is starting on, based on the length set in the registrant range. Is a string to support 0 in front. Example: 200
$registrantTo	Registrant number ending on, based on the length set in the registrant range. Is a string to support 0 in front. Example: 699
$length	How many characters $registrantFrom and $registrantTo should have.

Create a new registrant range for an ISBN group / area.

Returns:

A new eZISBNRegistrantRange object.

Definition at line 100 of file ezisbnregistrantrange.php.

static eZISBNRegistrantRange::definition

(

)

[static]

Definition of the ranges for ISBN Registrant.

Reimplemented from eZPersistentObject.

Definition at line 42 of file ezisbnregistrantrange.php.

Referenced by cleanAll(), extractRegistrant(), fetchListByGroupID(), and removeByID().

static eZISBNRegistrantRange::extractRegistrant	(	$	isbnNr,
		$	group,
		$	groupRange,
		&$	registrantLength
	)		[static]

Will extract the registrant number based on the different ranges which is based on the 5 first digits after the Prefix field and the registration group number.

Parameters:

$isbnNr	Should be a stripped down ISBN number with just the digits (ean number).
$group	is an object of eZISBNGroup, which needs to be known before this function is called. Contains information about the group itself.
$groupRange	is an object of eZISBNGroupRange, which needs to be known before this function is called. Contains information about the valid ranges for the ISBN group.
$registrantLength	is the length of the Registrant in the range that was found. Is sent back in the reference variable.

Returns:

the registrant range object if found and false if not found.

Definition at line 159 of file ezisbnregistrantrange.php.

Referenced by eZISBN13\extractISBNNumber().

eZISBNRegistrantRange::eZISBNRegistrantRange

(

$

row

)

Constructor

Definition at line 34 of file ezisbnregistrantrange.php.

Referenced by create().

static eZISBNRegistrantRange::fetchListByGroupID	(	$	groupID,
		$	asObject = true
	)		[static]

Fetch the registrant group for a unique registration group area.

Parameters:

$groupID	The id that point to the ISBN Group object (Which contain info about the area and the unique group number).
$asObject	If the result should be returned as object or an array.

Returns:

the registrant list for an ISBN registration group id.

Definition at line 134 of file ezisbnregistrantrange.php.

static eZISBNRegistrantRange::removeByID

(

$

id

)

[static]

Removes the registrant area based on ID $id.

Definition at line 118 of file ezisbnregistrantrange.php.

---

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

• ezisbnregistrantrange.php