eZPublishCommunityProject(LegacyStack)  2013.9
eZISBNRegistrantRange Class Reference

The class eZISBNRegistrantRange handles Registrant ranges. More...

+ Inheritance diagram for eZISBNRegistrantRange:
+ Collaboration diagram for eZISBNRegistrantRange:

Public Member Functions

 eZISBNRegistrantRange ($row)
 
- Public Member Functions inherited from eZPersistentObject
 attribute ($attr, $noFunction=false)
 Returns the attribute data for $attr, this is either returned from the member variables or a member function depending on whether the definition field or function attributes matched. More...
 
 attributes ()
 Returns the attributes for this object, taken from the definition fields and function attributes. More...
 
 eZPersistentObject ($row)
 Initializes the object with the $row. More...
 
 fill ($row)
 Tries to fill in the data in the object by using the object definition which is returned by the function definition() and the database row data $row. More...
 
 hasAttribute ($attr)
 Checks if $attr is part of the definition fields or function attributes. More...
 
 hasDirtyData ()
 Returns true if the data is considered dirty and needs to be stored. More...
 
 remove ($conditions=null, $extraConditions=null)
 Removes the object from the database, it will use the keys in the object definition to figure out which table row should be removed unless $conditions is defined as an array with fieldnames. More...
 
 setAttribute ($attr, $val)
 Sets the attribute $attr to the value $val. More...
 
 setHasDirtyData ($hasDirtyData)
 Sets whether the object has dirty data or not. More...
 
 store ($fieldFilters=null)
 Stores the object in the database, uses storeObject() to do the actual job and passes $fieldFilters to it. More...
 
 sync ($fieldFilters=null)
 Makes sure data is stored if the data is considered dirty. More...
 

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)
 
- Static Public Member Functions inherited from eZPersistentObject
static conditionText ($conditions)
 Calls conditionTextByRow with an empty row and $conditions. More...
 
static conditionTextByRow ($conditions, $row)
 Generates an SQL sentence from the conditions $conditions and row data $row. More...
 
static count ($def, $conds=null, $field=null)
 Fetches the number of rows by using the object definition. More...
 
static definition ()
 Returns the definition for the object, the default implementation is to return an empty array. More...
 
static escapeArray ($array)
 Escapes strings in an array with the help of eZDBInterface::escapeString(). More...
 
static fetchObject ($def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 Fetches and returns an object based on the given parameters and returns is either as an object or as an array. More...
 
static fetchObjectList ($def, $field_filters=null, $conds=null, $sorts=null, $limit=null, $asObject=true, $grouping=false, $custom_fields=null, $custom_tables=null, $custom_conds=null)
 Creates an SQL query out of the different parameters and returns an array with the result. More...
 
static getShortAttributeName ($db, $def, $attrName)
 Returns the short attribute name (alias) if it's defined, given attribute name otherwise. More...
 
static handleRows ($rows, $class_name, $asObject)
 Creates PHP objects out of the database rows $rows. More...
 
static newObjectOrder ($def, $orderField, $conditions)
 Returns an order value which can be used for new items in table, for instance placement. More...
 
static removeObject ($def, $conditions=null, $extraConditions=null)
 Deletes the object from the table defined in $def with conditions $conditions and extra conditions $extraConditions. More...
 
static reorderObject ($def, $orderField, $conditions, $down=true)
 Moves a row in a database table. More...
 
static replaceFieldsWithShortNames ($db, $fieldDefs, &$fields)
 For the given array $fields treats its keys (for associative array) or values (for non-associative array) as table fields names and replaces them with short names (aliases) found in $fieldDefs. More...
 
static storeObject ($obj, $fieldFilters=null)
 Stores the data in $obj to database. More...
 
static swapRow ($table, $keys, $order_id, $rows, $id1, $id2)
 Sets row id $id2 to have the placement of row id $id1. More...
 
static updateObjectList ($parameters)
 Updates rows matching the given parameters. More...
 

Additional Inherited Members

- Public Attributes inherited from eZPersistentObject
 $PersistentDataDirty
 

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

Member Function Documentation

static eZISBNRegistrantRange::cleanAll ( )
static

Removes all ISBN group ranges from the database.

Referenced by eZISBNType\cleanDBDataBeforeImport().

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

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

Returns
A new eZISBNRegistrantRange object.
static eZISBNRegistrantRange::definition ( )
static

Definition of the ranges for ISBN Registrant.

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
$isbnNrShould be a stripped down ISBN number with just the digits (ean number).
$groupis an object of eZISBNGroup, which needs to be known before this function is called. Contains information about the group itself.
$groupRangeis an object of eZISBNGroupRange, which needs to be known before this function is called. Contains information about the valid ranges for the ISBN group.
$registrantLengthis 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.

Referenced by eZISBN13\extractISBNNumber().

eZISBNRegistrantRange::eZISBNRegistrantRange (   $row)

Constructor

Referenced by create().

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

Fetch the registrant group for a unique registration group area.

Parameters
$groupIDThe id that point to the ISBN Group object (Which contain info about the area and the unique group number).
$asObjectIf the result should be returned as object or an array.
Returns
the registrant list for an ISBN registration group id.
static eZISBNRegistrantRange::removeByID (   $id)
static

Removes the registrant area based on ID $id.


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