eZ Publish  [trunk]
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 11 of file ezisbn10to13converter.php.


Member Function Documentation

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 42 of file ezisbn10to13converter.php.

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 141 of file ezisbn10to13converter.php.

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 83 of file ezisbn10to13converter.php.

Returns:
count of the current amount of class attributes registered in the attribute array.

Definition at line 187 of file ezisbn10to13converter.php.

Start processing the content object attributes.

Definition at line 195 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 20 of file ezisbn10to13converter.php.

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 327 of file ezisbn10to13converter.php.

Referenced by execute().

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 216 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 340 of file ezisbn10to13converter.php.

Referenced by updateContentObjectAttribute().

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 269 of file ezisbn10to13converter.php.

Referenced by updateContentFromClassAttribute().


Member Data Documentation

eZISBN10To13Converter::$AttributeArray

Definition at line 352 of file ezisbn10to13converter.php.

eZISBN10To13Converter::$Cli

Definition at line 350 of file ezisbn10to13converter.php.

eZISBN10To13Converter::$Script

Definition at line 351 of file ezisbn10to13converter.php.


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