Author: as
Date: Tue Oct 9 10:51:41 2007
New Revision: 6399
Log:
- Added comments to struct classes.
Modified:
trunk/Feed/src/structs/item_module_data.php
trunk/Feed/src/structs/module_data.php
Modified: trunk/Feed/src/structs/item_module_data.php
==============================================================================
--- trunk/Feed/src/structs/item_module_data.php [iso-8859-1] (original)
+++ trunk/Feed/src/structs/item_module_data.php [iso-8859-1] Tue Oct 9
10:51:41 2007
@@ -10,24 +10,59 @@
*/
/**
- * Container for module data
+ * Container for module data in feed items.
*
* @package Feed
* @version //autogentag//
+ * @access private
*/
class ezcFeedItemModuleData
{
+ /**
+ * Holds the module name (eg. 'DublinCore').
+ *
+ * @var string
+ */
public $moduleName;
+
+ /**
+ * Holds the module object.
+ *
+ * @var ezcFeedModule
+ */
public $moduleObj;
+
+ /**
+ * Holds the feed item object.
+ *
+ * @var ezcFeedItem
+ */
protected $item;
- public function __construct( $moduleName, $moduleObj, $item )
+ /**
+ * Constructs a new ezcFeedItemModuleData object.
+ *
+ * @param string $moduleName The module name (eg. 'DublinCore')
+ * @param ezcFeedModule $moduleObj The module object
+ * @param ezcFeedItem $item The feed item object
+ */
+ public function __construct( $moduleName, ezcFeedModule $moduleObj,
ezcFeedItem $item )
{
$this->moduleName = $moduleName;
$this->moduleObj = $moduleObj;
$this->item = $item;
}
+ /**
+ * Sets the property $element to $value.
+ *
+ * @throws ezcFeedUnsupportedModuleItemElementException
+ * If $element is not allowed in the module of the item.
+ *
+ * @param string $element The property name
+ * @param mixed $value The property value
+ * @ignore
+ */
public function __set( $element, $value )
{
if ( !$this->moduleObj->isItemElementAllowed( $element ) )
@@ -40,6 +75,13 @@
}
}
+ /**
+ * Returns the value of property $element.
+ *
+ * @param string $element The property name
+ * @return mixed
+ * @ignore
+ */
public function __get( $element )
{
return $this->item->feedProcessor->getModuleItemData(
$this->moduleName, $this->moduleObj, $this->item, $element );
Modified: trunk/Feed/src/structs/module_data.php
==============================================================================
--- trunk/Feed/src/structs/module_data.php [iso-8859-1] (original)
+++ trunk/Feed/src/structs/module_data.php [iso-8859-1] Tue Oct 9 10:51:41 2007
@@ -10,24 +10,59 @@
*/
/**
- * Container for module data
+ * Container for module data.
*
* @package Feed
* @version //autogentag//
+ * @access private
*/
class ezcFeedModuleData
{
+ /**
+ * Holds the module name (eg. 'DublinCore').
+ *
+ * @var string
+ */
public $moduleName;
+
+ /**
+ * Holds the module object.
+ *
+ * @var ezcFeedModule
+ */
public $moduleObj;
+
+ /**
+ * Holds the feed processor object.
+ *
+ * @var ezcFeedProcessor
+ */
protected $feedProcessor;
- public function __construct( $moduleName, $moduleObj, $feedProcessor )
+ /**
+ * Constructs a new ezcFeedModuleData object.
+ *
+ * @param string $moduleName The module name (eg. 'DublinCore')
+ * @param ezcFeedModule $moduleObj The module object
+ * @param ezcFeedProcessor $feedProcessor The feed processor object
+ */
+ public function __construct( $moduleName, ezcFeedModule $moduleObj,
ezcFeedProcessor $feedProcessor )
{
$this->moduleName = $moduleName;
$this->moduleObj = $moduleObj;
$this->feedProcessor = $feedProcessor;
}
+ /**
+ * Sets the property $element to $value.
+ *
+ * @throws ezcFeedUnsupportedModuleElementException
+ * If $element is not allowed in the module.
+ *
+ * @param string $element The property name
+ * @param mixed $value The property value
+ * @ignore
+ */
public function __set( $element, $value )
{
if ( !$this->moduleObj->isChannelElementAllowed( $element ) )
@@ -40,6 +75,13 @@
}
}
+ /**
+ * Returns the value of property $element.
+ *
+ * @param string $element The property name
+ * @return mixed
+ * @ignore
+ */
public function __get( $element )
{
return $this->feedProcessor->getModuleMetaData( $this->moduleName,
$this->moduleObj, $element );
--
svn-components mailing list
[email protected]
http://lists.ez.no/mailman/listinfo/svn-components
