eZ Publish  [4.2]
eZISBN10To13Converter Class Reference

List of all members.

Public Member Functions

 addAllClasses ()
 addAttribute ($attributeID)
 addClass ($classID)
 attributeCount ()
 execute ()
 eZISBN10To13Converter ($script, $cli, $params)
 updateClassAttributeToISBN13 ($classAttributeID)
 updateContentFromClassAttribute ($classAttributeID)
 updateContentISBNNumber ($contentObjectAttribute, $formatedISBN13Value)
 updateContentObjectAttribute ($contentObjectAttribute)

Public Attributes

 $AttributeArray
 $Cli
 $Script

Detailed Description

Definition at line 27 of file ezisbn10to13converter.php.


Member Function Documentation

eZISBN10To13Converter::addAllClasses ( )

Add all classes. Will fetch all class attributes from the database that has the ISBN datatype and register it in a class variable AttributeArray for later processing.

Returns:
true if successfull and false if not.

Definition at line 58 of file ezisbn10to13converter.php.

eZISBN10To13Converter::addAttribute ( attributeID)

Add one ezisbn class attribute with a specific class attribute id and register it in a class variable AttributeArray for later processing.

Returns:
true if successfull and false if not.

Definition at line 157 of file ezisbn10to13converter.php.

eZISBN10To13Converter::addClass ( classID)

Add all ezisbn class attributes from a class with a specific id and register them in a class variable AttributeArray for later processing.

Returns:
true if successfull and false if not.

Definition at line 99 of file ezisbn10to13converter.php.

eZISBN10To13Converter::attributeCount ( )
Returns:
count of the current amount of class attributes registered in the attribute array.

Definition at line 203 of file ezisbn10to13converter.php.

eZISBN10To13Converter::execute ( )

Start processing the content object attributes.

Definition at line 211 of file ezisbn10to13converter.php.

eZISBN10To13Converter::eZISBN10To13Converter ( script,
cli,
params 
)

Constructor

Parameters:
$scriptThe variable is set earlier in the script and transfered to the class.
$cliIs set earlier in the script, and used to send output / feedback to the user.
$paramscustom parameters to the class. The Force parameter is now set as a class variable for the other functions.

Definition at line 36 of file ezisbn10to13converter.php.

eZISBN10To13Converter::updateClassAttributeToISBN13 ( classAttributeID)

Does the update of the class attribute directly to the database, which will only alter the attribute for if the ISBN datatype is ISBN-13.

Parameters:
$classAttributeIDis the Class attribute id for the ISBN datatype.

Definition at line 343 of file ezisbn10to13converter.php.

Referenced by execute().

eZISBN10To13Converter::updateContentFromClassAttribute ( classAttributeID)

Update content in a ezisbn datatype for one specific class attribute id.

Parameters:
$classAttributeIDis the class attribute id for for the ISBN datatype.

Definition at line 232 of file ezisbn10to13converter.php.

Referenced by execute().

eZISBN10To13Converter::updateContentISBNNumber ( contentObjectAttribute,
formatedISBN13Value 
)

Does the update of the content object attribute directly to the database, which will only alter the attribute for if the ISBN datatype is ISBN-13.

Parameters:
$contentObjectAttributeIs an object of eZContentObjectAttribute.
$formatedISBN13Valuecontains the formated version of the ISBN-13 number with hyphen as delimiter.

Definition at line 356 of file ezisbn10to13converter.php.

Referenced by updateContentObjectAttribute().

eZISBN10To13Converter::updateContentObjectAttribute ( contentObjectAttribute)

Convert the ISBN number for a content object attribute with the specific content attribute id.

Parameters:
$contentObjectAttributeShould be a object of eZContentObjectAttribute.

Definition at line 285 of file ezisbn10to13converter.php.

Referenced by updateContentFromClassAttribute().


Member Data Documentation

eZISBN10To13Converter::$AttributeArray

Definition at line 368 of file ezisbn10to13converter.php.

eZISBN10To13Converter::$Cli

Definition at line 366 of file ezisbn10to13converter.php.

eZISBN10To13Converter::$Script

Definition at line 367 of file ezisbn10to13converter.php.


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