summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJames Gilliland2008-12-28 03:47:37 (GMT)
committer James Gilliland2008-12-28 03:47:37 (GMT)
commitc77cd8dd650161a53e1ba3ce06b7fe583b8eef66 (patch)
treedbda33cfdf76be28aba47b0e5e066e61a8d55f68
parent9bc5b2308a93f3fb4e5385c1663506e4069f6680 (diff)
Add more documentation and an ingroup on classes.
-rw-r--r--export/views_bonus_plugin_style_export.inc5
-rw-r--r--export/views_bonus_plugin_style_export_csv.inc24
-rw-r--r--export/views_bonus_plugin_style_export_doc.inc23
-rw-r--r--export/views_bonus_plugin_style_export_txt.inc23
-rw-r--r--export/views_bonus_plugin_style_export_xml.inc24
5 files changed, 95 insertions, 4 deletions
diff --git a/export/views_bonus_plugin_style_export.inc b/export/views_bonus_plugin_style_export.inc
index d0500c6..4c422fd 100644
--- a/export/views_bonus_plugin_style_export.inc
+++ b/export/views_bonus_plugin_style_export.inc
@@ -7,12 +7,14 @@
/**
* Generalized style plugin for export plugins.
+ *
+ * @ingroup views_style_plugins
*/
class views_bonus_plugin_style_export extends views_plugin_style {
/**
* Attach this view to another display as a feed.
- *
+ *
* Provide basic functionality for all export style views like attaching a
* feed image link.
*/
@@ -26,4 +28,3 @@ class views_bonus_plugin_style_export extends views_plugin_style {
$this->view->feed_icon .= l($image, $path, $url_options);
}
}
-
diff --git a/export/views_bonus_plugin_style_export_csv.inc b/export/views_bonus_plugin_style_export_csv.inc
index 9c3eb42..a275b59 100644
--- a/export/views_bonus_plugin_style_export_csv.inc
+++ b/export/views_bonus_plugin_style_export_csv.inc
@@ -7,13 +7,26 @@
/**
* Generalized style plugin for export plugins.
+ *
+ * @ingroup views_style_plugins
*/
class views_bonus_plugin_style_export_csv extends views_bonus_plugin_style_export {
+ /**
+ * Initialize plugin.
+ *
+ * Set feed image for shared rendering later.
+ */
function init(&$view, &$display, $options = NULL) {
parent::init($view, $display, $options = NULL);
$this->feed_image = drupal_get_path('module', 'views_bonus_export') . '/images/csv.png';
}
+ /**
+ * Set options fields and default values.
+ *
+ * @return
+ * An array of options information.
+ */
function option_definition() {
$options = parent::option_definition();
@@ -33,6 +46,16 @@ class views_bonus_plugin_style_export_csv extends views_bonus_plugin_style_expor
return $options;
}
+ /**
+ * Options form mini callback.
+ *
+ * @param $form
+ * Form array to add additional fields to.
+ * @param $form_state
+ * State of the form.
+ * @return
+ * None.
+ */
function options_form(&$form, &$form_state) {
$form['filename'] = array(
'#type' => 'textfield',
@@ -53,5 +76,4 @@ class views_bonus_plugin_style_export_csv extends views_bonus_plugin_style_expor
'#default_value' => !empty($this->options['header']),
);
}
-
}
diff --git a/export/views_bonus_plugin_style_export_doc.inc b/export/views_bonus_plugin_style_export_doc.inc
index b1b93e8..228e9aa 100644
--- a/export/views_bonus_plugin_style_export_doc.inc
+++ b/export/views_bonus_plugin_style_export_doc.inc
@@ -7,13 +7,26 @@
/**
* Generalized style plugin for export plugins.
+ *
+ * @ingroup views_style_plugins
*/
class views_bonus_plugin_style_export_doc extends views_bonus_plugin_style_export {
+ /**
+ * Initialize plugin.
+ *
+ * Set feed image for shared rendering later.
+ */
function init(&$view, &$display, $options = NULL) {
parent::init($view, $display, $options = NULL);
$this->feed_image = drupal_get_path('module', 'views_bonus_export') . '/images/doc.png';
}
+ /**
+ * Set options fields and default values.
+ *
+ * @return
+ * An array of options information.
+ */
function option_definition() {
$options = parent::option_definition();
@@ -25,6 +38,16 @@ class views_bonus_plugin_style_export_doc extends views_bonus_plugin_style_expor
return $options;
}
+ /**
+ * Options form mini callback.
+ *
+ * @param $form
+ * Form array to add additional fields to.
+ * @param $form_state
+ * State of the form.
+ * @return
+ * None.
+ */
function options_form(&$form, &$form_state) {
$form['filename'] = array(
'#type' => 'textfield',
diff --git a/export/views_bonus_plugin_style_export_txt.inc b/export/views_bonus_plugin_style_export_txt.inc
index 549b380..d4148ea 100644
--- a/export/views_bonus_plugin_style_export_txt.inc
+++ b/export/views_bonus_plugin_style_export_txt.inc
@@ -7,13 +7,26 @@
/**
* Generalized style plugin for export plugins.
+ *
+ * @ingroup views_style_plugins
*/
class views_bonus_plugin_style_export_txt extends views_bonus_plugin_style_export {
+ /**
+ * Initialize plugin.
+ *
+ * Set feed image for shared rendering later.
+ */
function init(&$view, &$display, $options = NULL) {
parent::init($view, $display, $options = NULL);
$this->feed_image = drupal_get_path('module', 'views_bonus_export') . '/images/txt.png';
}
+ /**
+ * Set options fields and default values.
+ *
+ * @return
+ * An array of options information.
+ */
function option_definition() {
$options = parent::option_definition();
@@ -25,6 +38,16 @@ class views_bonus_plugin_style_export_txt extends views_bonus_plugin_style_expor
return $options;
}
+ /**
+ * Options form mini callback.
+ *
+ * @param $form
+ * Form array to add additional fields to.
+ * @param $form_state
+ * State of the form.
+ * @return
+ * None.
+ */
function options_form(&$form, &$form_state) {
$form['filename'] = array(
'#type' => 'textfield',
diff --git a/export/views_bonus_plugin_style_export_xml.inc b/export/views_bonus_plugin_style_export_xml.inc
index e7d002b..b28ad00 100644
--- a/export/views_bonus_plugin_style_export_xml.inc
+++ b/export/views_bonus_plugin_style_export_xml.inc
@@ -7,13 +7,26 @@
/**
* Generalized style plugin for export plugins.
+ *
+ * @ingroup views_style_plugins
*/
class views_bonus_plugin_style_export_xml extends views_bonus_plugin_style_export {
+ /**
+ * Initialize plugin.
+ *
+ * Set feed image for shared rendering later.
+ */
function init(&$view, &$display, $options = NULL) {
parent::init($view, $display, $options = NULL);
$this->feed_image = drupal_get_path('module', 'views_bonus_export') . '/images/xml.png';
}
+ /**
+ * Set options fields and default values.
+ *
+ * @return
+ * An array of options information.
+ */
function option_definition() {
$options = parent::option_definition();
@@ -25,8 +38,17 @@ class views_bonus_plugin_style_export_xml extends views_bonus_plugin_style_expor
return $options;
}
+ /**
+ * Options form mini callback.
+ *
+ * @param $form
+ * Form array to add additional fields to.
+ * @param $form_state
+ * State of the form.
+ * @return
+ * None.
+ */
function options_form(&$form, &$form_state) {
-
$form['filename'] = array(
'#type' => 'textfield',
'#title' => t('XML filename'),