Inheritance diagram for Zend_Validate_Isbn:

Public Member Functions
	__construct ($options=array())

	isValid ($value)

	setSeparator ($separator)

	getSeparator ()

	setType ($type)

	getType ()

Public Member Functions inherited from Zend_Validate_Abstract
	getMessages ()

	getMessageVariables ()

	getMessageTemplates ()

	setMessage ($messageString, $messageKey=null)

	setMessages (array $messages)

	__get ($property)

	getErrors ()

	setObscureValue ($flag)

	getObscureValue ()

	setTranslator ($translator=null)

	getTranslator ()

	hasTranslator ()

	setDisableTranslator ($flag)

	translatorIsDisabled ()

Data Fields
const	AUTO = 'auto'

const	ISBN10 = '10'

const	ISBN13 = '13'

const	INVALID = 'isbnInvalid'

const	NO_ISBN = 'isbnNoIsbn'

Protected Member Functions
	_detectFormat ()

Protected Member Functions inherited from Zend_Validate_Abstract
	_createMessage ($messageKey, $value)

	_implodeRecursive (array $pieces)

	_error ($messageKey, $value=null)

	_setValue ($value)

Protected Attributes
	$_messageTemplates

	$_type = self::AUTO

	$_separator = ''

Protected Attributes inherited from Zend_Validate_Abstract
	$_value

	$_messageVariables = array()

	$_messageTemplates = array()

	$_messages = array()

	$_obscureValue = false

	$_errors = array()

	$_translator

	$_translatorDisabled = false

Additional Inherited Members
Static Public Member Functions inherited from Zend_Validate_Abstract
static	setDefaultTranslator ($translator=null)

static	getDefaultTranslator ()

static	hasDefaultTranslator ()

static	getMessageLength ()

static	setMessageLength ($length=-1)

Static Protected Attributes inherited from Zend_Validate_Abstract
static	$_defaultTranslator

static	$_messageLength = -1

Detailed Description

Definition at line 33 of file Isbn.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( $options = array() )

Set up options.

Parameters

Zend_Config | array $options

Exceptions

Zend_Validate_Exception When $options is not valid

See also: Zend_Validate_Exception

Definition at line 71 of file Isbn.php.

     {
         // prepare options
         if ($options instanceof Zend_Config) {
             $options = $options->toArray();
         }
         if (!is_array($options)) {
             #require_once 'Zend/Validate/Exception.php';
             throw new Zend_Validate_Exception('Invalid options provided.');
         }
 
         // set type
         if (array_key_exists('type', $options)) {
             $this->setType($options['type']);
         }
 
         // set separator
         if (array_key_exists('separator', $options)) {
             $this->setSeparator($options['separator']);
         }
     }

Member Function Documentation

◆ _detectFormat()

_detectFormat ( )

protected

Detect input format.

Returns: string

Definition at line 101 of file Isbn.php.

     {
         // prepare separator and pattern list
         $sep      = quotemeta($this->_separator);
         $patterns = array();
         $lengths  = array();
 
         // check for ISBN-10
         if ($this->_type == self::ISBN10 || $this->_type == self::AUTO) {
             if (empty($sep)) {
                 $pattern = '/^[0-9]{9}[0-9X]{1}$/';
                 $length  = 10;
             } else {
                 $pattern = "/^[0-9]{1,7}[{$sep}]{1}[0-9]{1,7}[{$sep}]{1}[0-9]{1,7}[{$sep}]{1}[0-9X]{1}$/";
                 $length  = 13;
             }
 
             $patterns[$pattern] = self::ISBN10;
             $lengths[$pattern]  = $length;
         }
 
         // check for ISBN-13
         if ($this->_type == self::ISBN13 || $this->_type == self::AUTO) {
             if (empty($sep)) {
                 $pattern = '/^[0-9]{13}$/';
                 $length  = 13;
             } else {
                 $pattern = "/^[0-9]{1,9}[{$sep}]{1}[0-9]{1,5}[{$sep}]{1}[0-9]{1,9}[{$sep}]{1}[0-9]{1,9}[{$sep}]{1}[0-9]{1}$/";
                 $length  = 17;
             }
 
             $patterns[$pattern] = self::ISBN13;
             $lengths[$pattern]  = $length;
         }
 
         // check pattern list
         foreach ($patterns as $pattern => $type) {
             if ((strlen($this->_value) == $lengths[$pattern]) && preg_match($pattern, $this->_value)) {
                 return $type;
             }
         }
 
         return null;
     }

◆ getSeparator()

getSeparator ( )

Get separator characters.

Returns: string

Definition at line 242 of file Isbn.php.

     {
         return $this->_separator;
     }

◆ getType()

getType ( )

Get allowed ISBN type.

Returns: string

Definition at line 274 of file Isbn.php.

     {
         return $this->_type;
     }

◆ isValid()

isValid ( $value )

Defined by Zend_Validate_Interface.

Returns true if and only if $value is a valid ISBN.

Parameters

string $value

Returns: boolean

Implements Zend_Validate_Interface.

Definition at line 154 of file Isbn.php.

     {
         if (!is_string($value) && !is_int($value)) {
             $this->_error(self::INVALID);
             return false;
         }
 
         $value = (string) $value;
         $this->_setValue($value);
 
         switch ($this->_detectFormat()) {
             case self::ISBN10:
                 // sum
                 $isbn10 = str_replace($this->_separator, '', $value);
                 $sum    = 0;
                 for ($i = 0; $i < 9; $i++) {
                     $sum += (10 - $i) * $isbn10{$i};
                 }
 
                 // checksum
                 $checksum = 11 - ($sum % 11);
                 if ($checksum == 11) {
                     $checksum = '0';
                 } elseif ($checksum == 10) {
                     $checksum = 'X';
                 }
                 break;
 
             case self::ISBN13:
                 // sum
                 $isbn13 = str_replace($this->_separator, '', $value);
                 $sum    = 0;
                 for ($i = 0; $i < 12; $i++) {
                     if ($i % 2 == 0) {
                         $sum += $isbn13{$i};
                     } else {
                         $sum += 3 * $isbn13{$i};
                     }
                 }
                 // checksum
                 $checksum = 10 - ($sum % 10);
                 if ($checksum == 10) {
                     $checksum = '0';
                 }
                 break;
 
             default:
                 $this->_error(self::NO_ISBN);
                 return false;
         }
 
         // validate
         if (substr($this->_value, -1) != $checksum) {
             $this->_error(self::NO_ISBN);
             return false;
         }
         return true;
     }

◆ setSeparator()

setSeparator ( $separator )

Set separator characters.

It is allowed only empty string, hyphen and space.

Parameters

string $separator

Exceptions

Zend_Validate_Exception When $separator is not valid

Returns: Zend_Validate_Isbn Provides a fluent interface

See also: Zend_Validate_Exception

Definition at line 222 of file Isbn.php.

     {
         // check separator
         if (!in_array($separator, array('-', ' ', ''))) {
             #require_once 'Zend/Validate/Exception.php';
             throw new Zend_Validate_Exception('Invalid ISBN separator.');
         }
 
         $this->_separator = $separator;
         return $this;
     }

◆ setType()

setType ( $type )

Set allowed ISBN type.

Parameters

string $type

Exceptions

Zend_Validate_Exception When $type is not valid

Returns: Zend_Validate_Isbn Provides a fluent interface

See also: Zend_Validate_Exception

Definition at line 254 of file Isbn.php.

     {
         // check type
         if (!in_array($type, array(self::AUTO, self::ISBN10, self::ISBN13))) {
             #require_once 'Zend/Validate/Exception.php';
             throw new Zend_Validate_Exception('Invalid ISBN type');
         }
 
         $this->_type = $type;
         return $this;
     }

Field Documentation

◆ $_messageTemplates

$_messageTemplates

protected

Initial value:

= array(
        self::INVALID => "Invalid type given. String or integer expected",
        self::NO_ISBN => "'%value%' is not a valid ISBN number",
    )

Definition at line 46 of file Isbn.php.

◆ $_separator

$_separator = ''

protected

Definition at line 63 of file Isbn.php.

◆ $_type

$_type = self::AUTO

protected

Definition at line 56 of file Isbn.php.

◆ AUTO

const AUTO = 'auto'

Definition at line 35 of file Isbn.php.

◆ INVALID

const INVALID = 'isbnInvalid'

Definition at line 38 of file Isbn.php.

◆ ISBN10

const ISBN10 = '10'

Definition at line 36 of file Isbn.php.

◆ ISBN13

const ISBN13 = '13'

Definition at line 37 of file Isbn.php.

◆ NO_ISBN

const NO_ISBN = 'isbnNoIsbn'

Definition at line 39 of file Isbn.php.

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

vendor/magento/zendframework1/library/Zend/Validate/Isbn.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _detectFormat()

◆ getSeparator()

◆ getType()

◆ isValid()

◆ setSeparator()

◆ setType()

Field Documentation

◆ $_messageTemplates

◆ $_separator

◆ $_type

◆ AUTO

◆ INVALID

◆ ISBN10

◆ ISBN13

◆ NO_ISBN