CM2 Class Reference
[Undocumented Classes]

INSERT BRIEF DESCRIPTION HERE. More...

List of all members.

Public Member Functions

 __construct ()
 INSERT BRIEF DESCRIPTION HERE.
 addToList ($unit, $id, $name, $shortName, $content, $thumbnail="")
 generateXml ()
 INSERT BRIEF DESCRIPTION HERE.
 setCollectionName ($name)
 INSERT BRIEF DESCRIPTION HERE.
 setCollectionShortName ($name)
 INSERT BRIEF DESCRIPTION HERE.
 setModuleName ($name)
 INSERT BRIEF DESCRIPTION HERE.
 setModuleShortName ($name)
 INSERT BRIEF DESCRIPTION HERE.
 setUnitName ($shortName, $unitName)
 INSERT BRIEF DESCRIPTION HERE.
 setUnitOrder ($units)
 INSERT BRIEF DESCRIPTION HERE.

Private Member Functions

 generateModuleXml ()
 INSERT BRIEF DESCRIPTION HERE.
 generateUnits ()
 INSERT BRIEF DESCRIPTION HERE.


Detailed Description

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Author:
AUTHOR (DATE)

Definition at line 11 of file CM2.php5.


Constructor & Destructor Documentation

CM2::__construct (  ) 

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:
[TYPE]: RETURN DESCRIPTION

Definition at line 28 of file CM2.php5.


Member Function Documentation

CM2::addToList ( unit,
id,
name,
shortName,
content,
thumbnail = "" 
)

Parameters:
unit The grouping to add the item to
id Unimportant, according to Ismael
name Name of the element
shortName the linke for name apparently
content element's content
thumbnail image

Definition at line 121 of file CM2.php5.

CM2::generateModuleXml (  )  [private]

INSERT BRIEF DESCRIPTION HERE.

For internal use only.

INSERT FULL DESCRIPTION HERE

Returns:
[TYPE]: RETURN DESCRIPTION

Definition at line 151 of file CM2.php5.

Referenced by generateXml().

CM2::generateUnits (  )  [private]

INSERT BRIEF DESCRIPTION HERE.

For internal use only.

INSERT FULL DESCRIPTION HERE

Returns:
[TYPE]: RETURN DESCRIPTION

Definition at line 264 of file CM2.php5.

Referenced by generateXml().

CM2::generateXml (  ) 

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:
[TYPE]: RETURN DESCRIPTION

Definition at line 173 of file CM2.php5.

References generateModuleXml(), and generateUnits().

CM2::setCollectionName ( name  ) 

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:
$name [TYPE]: DESCRIPTION
Returns:
[TYPE]: RETURN DESCRIPTION

Definition at line 48 of file CM2.php5.

CM2::setCollectionShortName ( name  ) 

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:
$name [TYPE]: DESCRIPTION
Returns:
[TYPE]: RETURN DESCRIPTION

Definition at line 61 of file CM2.php5.

CM2::setModuleName ( name  ) 

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:
$name [TYPE]: DESCRIPTION
Returns:
[TYPE]: RETURN DESCRIPTION

Definition at line 94 of file CM2.php5.

CM2::setModuleShortName ( name  ) 

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:
$name [TYPE]: DESCRIPTION
Returns:
[TYPE]: RETURN DESCRIPTION

Definition at line 106 of file CM2.php5.

CM2::setUnitName ( shortName,
unitName 
)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:
$shortName [TYPE]: DESCRIPTION
$unitName [TYPE]: DESCRIPTION
Returns:
[TYPE]: RETURN DESCRIPTION

Definition at line 75 of file CM2.php5.

CM2::setUnitOrder ( units  ) 

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:
$units [TYPE]: DESCRIPTION
Returns:
[TYPE]: RETURN DESCRIPTION

Definition at line 325 of file CM2.php5.


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

Generated on Wed Nov 24 02:05:46 2010 for Common by  doxygen 1.5.6