eZ Publish  [4.2]
eZISBNGroupRange Class Reference

The class eZISBNGroupRange handle registration group ranges. More...

+ Inheritance diagram for eZISBNGroupRange:
+ Collaboration diagram for eZISBNGroupRange:

List of all members.

Public Member Functions

 eZISBNGroupRange ($row)

Static Public Member Functions

static cleanAll ()
static create ($fromNumber, $toNumber, $groupFrom, $groupTo, $length)
static definition ()
static extractGroup ($isbnNr)
static fetchList ($asObject=true)
static removeByID ($id)

Detailed Description

The class eZISBNGroupRange handle registration group ranges.

Has information about how the different ranges the registration group element could be in. Example: From 0 to 5 and continues from 600-602. This means that the length of the registration group can differ from range to range.

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

Definition at line 46 of file ezisbngrouprange.php.


Member Function Documentation

static eZISBNGroupRange::cleanAll ( ) [static]

Removes all ISBN group ranges from the database.

Definition at line 171 of file ezisbngrouprange.php.

Referenced by eZISBNType\cleanDBDataBeforeImport().

static eZISBNGroupRange::create ( fromNumber,
toNumber,
groupFrom,
groupTo,
length 
) [static]

Create a new group range for an ISBN number.

Parameters:
$fromNumberGroup is starting from test number, which is based on the 5 numbers after the Prefix number.
$toNumberGroup is ending on the To test number, which is based on the 5 numbers after the Prefix number.
$groupFromGroup number is starting on, based on the length set in the Group.
$groupToGroup number is ending on, based on the length set in the group.
$lengthHow many characters $groupFrom and $groupTo should have.
Returns:
a new eZISBNGroupRange object.

Definition at line 107 of file ezisbngrouprange.php.

static eZISBNGroupRange::definition ( ) [static]

Definition of the ranges for ISBN groups.

Reimplemented from eZPersistentObject.

Definition at line 60 of file ezisbngrouprange.php.

Referenced by cleanAll(), extractGroup(), fetchList(), and removeByID().

static eZISBNGroupRange::extractGroup ( isbnNr) [static]

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

Parameters:
$isbnNrShould be a stripped down ISBN number with just the digits (ean number).
Returns:
the group range object if found and false if not found.

Definition at line 149 of file ezisbngrouprange.php.

Referenced by eZISBN13\extractISBNNumber().

eZISBNGroupRange::eZISBNGroupRange ( row)

Constructor

Definition at line 51 of file ezisbngrouprange.php.

Referenced by create().

static eZISBNGroupRange::fetchList ( asObject = true) [static]
Parameters:
$asObjectWhether if the result should be sent back as objects or an array.
Returns:
the group range list for ISBN groups.

Definition at line 134 of file ezisbngrouprange.php.

Referenced by eZISBN13\attribute().

static eZISBNGroupRange::removeByID ( id) [static]

Removes the ISBN group based on ID $id.

Definition at line 124 of file ezisbngrouprange.php.


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