From 49803ff07989528c8a9ac82034d19ea5c65311d4 Mon Sep 17 00:00:00 2001 From: LuisParada7 <146735108+LuisParada7@users.noreply.github.com> Date: Thu, 21 Mar 2024 08:28:25 -0500 Subject: [PATCH] Resolved line length violation and applied HTML formatting --- ....php_1aebe46520eef162b4cba4939fddea61.html | 154 +- ....php_77fc09509f01f7aaccd03f7ab250b7f8.html | 131 +- ....php_2098f8b10dac8279189fb64e0cf19b58.html | 182 ++- ....php_b7f1b3ef628801cb4d798615e6f51528.html | 502 +++++- ....php_d07b4f4487b0e7d8be5b9565de1680c1.html | 1431 ++++++++++++++--- ....php_df94f9c9f06a3bd8592f0a887db91e47.html | 194 ++- ....php_b33cb6a0be974c2a717c7551e2cb3392.html | 147 +- ....php_130fbc642e5778bc139412ebb569c3be.html | 510 ++++-- ....php_2d255e8d018617d4ffe86fe10e326331.html | 555 +++++-- ....php_69f093d72103b85451a8ad3f71467993.html | 540 ++++++- ....php_9809169f01018eeb3cf9d2f74794d0d5.html | 121 +- ....php_b26ad4e1eaa1277b115e31683118039b.html | 1274 ++++++++++++--- ....php_c1a862a8922f2c4590de2cdacca66e16.html | 262 ++- ....php_a164674c6c86cad0df598a0c1a4c5e7d.html | 375 ++++- ....php_f389601b3e05a1419f1535326d57dad1.html | 410 ++++- ....php_d3d1ad1ba515d5bb293bcdd3739c3ad0.html | 331 +++- ....php_a4df7da15f0287015b6305b4c2b86e1b.html | 395 ++++- ....php_907d127b4229faab06ab733be81f51f8.html | 282 +++- 18 files changed, 6401 insertions(+), 1395 deletions(-) diff --git a/docs/__examplesource/exsource__Sites_joule2-maint_blocks_helloworld_settings.php_1aebe46520eef162b4cba4939fddea61.html b/docs/__examplesource/exsource__Sites_joule2-maint_blocks_helloworld_settings.php_1aebe46520eef162b4cba4939fddea61.html index cefff006..b31b4470 100644 --- a/docs/__examplesource/exsource__Sites_joule2-maint_blocks_helloworld_settings.php_1aebe46520eef162b4cba4939fddea61.html +++ b/docs/__examplesource/exsource__Sites_joule2-maint_blocks_helloworld_settings.php_1aebe46520eef162b4cba4939fddea61.html @@ -1,38 +1,124 @@ - - - - - See how to save global config to work with this method - - - -

See how to save global config to work with this method

-
-
  1. <?php
    2. -
  2. /**
    3. -
  3.  * Global Settings Example
    4. -
  4.  *
    5. -
  5.  * @author Mark Nielsen
    6. -
  6.  * @version $Id$
    7. -
  7.  * @package blocks/helloworld
    8. -
  8.  ***/
    9. -
  9.  
    10. -
  10. defined('MOODLE_INTERNAL') or die('Direct access to this script is forbidden.');
    11. -
  11.  
    12. -
  12. $configs   = array();
    13. -
  13. $configs[] = new admin_setting_configtext('textexample', get_string('textexample', 'block_helloworld'), get_string('textexampledesc', 'block_helloworld'), 'Hello World!');
    14. -
  14.  
    15. -
  15. // Define the config plugin so it is saved to
    16. -
  16. // the config_plugin table then add to the settings page
    17. -
  17. foreach ($configs as $config) {
    18. -
  18.     $config->plugin = 'blocks/helloworld';
    19. -
  19.     $settings->add($config);
    20. -
  20. }
    21. -
-
+ + + + + + See how to save global config to work with this method + + + + +

See how to save global config to work with this method

+
+
+
    +
  1. +
    <?php
    +
    2. +
  2. +
    /**
    +
    3. +
  3. +
     * Global Settings Example +
    +
    4. +
  4. +
     *
    +
    5. +
  5. +
     * @author Mark Nielsen +
    +
    6. +
  6. +
     * @version $Id$
    +
    7. +
  7. +
     * @package blocks/helloworld +
    +
    8. +
  8. +
     ***/
    +
    9. +
  9. +
     
    +
    10. +
  10. +
    defined('MOODLE_INTERNAL') or die('Direct access to this script is forbidden.');
    +
    11. +
  11. +
     
    +
    12. +
  12. +
    $configs   = array();
    +
    13. +
  13. +
    $configs[] = new admin_setting_configtext('textexample', get_string('textexample', 'block_helloworld'), get_string('textexampledesc', 'block_helloworld'), 'Hello World!');
    +
    14. +
  14. +
     
    +
    15. +
  15. +
    // Define the config plugin so it is saved to +
    +
    16. +
  16. +
    // the config_plugin table then add to the settings page +
    +
    17. +
  17. +
    foreach ($configs as $config) {
    +
    18. +
  18. +
        $config->plugin = 'blocks/helloworld';
    +
    19. +
  19. +
        $settings->add($config);
    +
    20. +
  20. +
    }
    +
    21. +
+
+

- Documentation generated on Thu, 28 Jun 2012 16:33:48 -0700 by phpDocumentor 1.4.3 + Documentation generated on Thu, 28 Jun 2012 16:33:48 -0700 by phpDocumentor 1.4.3

- + + \ No newline at end of file diff --git a/docs/__examplesource/exsource_e2-maint_blocks_helloworld_lib_server_response.php_77fc09509f01f7aaccd03f7ab250b7f8.html b/docs/__examplesource/exsource_e2-maint_blocks_helloworld_lib_server_response.php_77fc09509f01f7aaccd03f7ab250b7f8.html index fa1fba64..a695844b 100644 --- a/docs/__examplesource/exsource_e2-maint_blocks_helloworld_lib_server_response.php_77fc09509f01f7aaccd03f7ab250b7f8.html +++ b/docs/__examplesource/exsource_e2-maint_blocks_helloworld_lib_server_response.php_77fc09509f01f7aaccd03f7ab250b7f8.html @@ -1,36 +1,103 @@ - - - - - Example class definition - - - -

Example class definition

-
-
  1. <?php
    2. -
  2. /**
    3. -
  3.  * Web Service Responses
    4. -
  4.  *
    5. -
  5.  * @package blocks/helloworld
    6. -
  6.  * @author Mark Nielsen
    7. -
  7.  */
    8. -
  8. class blocks_helloworld_lib_server_response extends mr_server_response_abstract {
    9. -
  9.     /**
    10. -
  10.      * Response for service: test
    11. -
  11.      *
    12. -
  12.      * @param string $say Tell the service what to say
    13. -
  13.      * @return string 
    14. -
  14.      */
    15. -
  15.     public function test($say) {
    16. -
  16.         return $this->standard($say);
    17. -
  17.     }
    18. -
  18. }
    19. -
-
+ + + + + + Example class definition + + + + +

Example class definition

+
+
+
    +
  1. +
    <?php
    +
    2. +
  2. +
    /**
    +
    3. +
  3. +
     * Web Service Responses +
    +
    4. +
  4. +
     *
    +
    5. +
  5. +
     * @package blocks/helloworld +
    +
    6. +
  6. +
     * @author Mark Nielsen +
    +
    7. +
  7. +
     */
    +
    8. +
  8. +
    class blocks_helloworld_lib_server_response extends mr_server_response_abstract {
    +
    9. +
  9. +
        /**
    +
    10. +
  10. +
         * Response for service: test +
    +
    11. +
  11. +
         *
    +
    12. +
  12. +
         * @param string $say Tell the service what to say
    +
    13. +
  13. +
         * @return string  +
    +
    14. +
  14. +
         */
    +
    15. +
  15. +
        public function test($say) {
    +
    16. +
  16. +
            return $this->standard($say);
    +
    17. +
  17. +
        }
    +
    18. +
  18. +
    }
    +
    19. +
+
+

- Documentation generated on Thu, 28 Jun 2012 16:33:45 -0700 by phpDocumentor 1.4.3 + Documentation generated on Thu, 28 Jun 2012 16:33:45 -0700 by phpDocumentor 1.4.3

- + + \ No newline at end of file diff --git a/docs/__examplesource/exsource_es_joule2-maint_blocks_helloworld_helper_world.php_2098f8b10dac8279189fb64e0cf19b58.html b/docs/__examplesource/exsource_es_joule2-maint_blocks_helloworld_helper_world.php_2098f8b10dac8279189fb64e0cf19b58.html index 355f2061..5894f3ba 100644 --- a/docs/__examplesource/exsource_es_joule2-maint_blocks_helloworld_helper_world.php_2098f8b10dac8279189fb64e0cf19b58.html +++ b/docs/__examplesource/exsource_es_joule2-maint_blocks_helloworld_helper_world.php_2098f8b10dac8279189fb64e0cf19b58.html @@ -1,47 +1,143 @@ - - - - - See a helper implemented in a plugin - - - -

See a helper implemented in a plugin

-
-
  1. <?php
    2. -
  2. /**
    3. -
  3.  * World Helper
    4. -
  4.  *
    5. -
  5.  * @author Mark Nielsen
    6. -
  6.  * @package blocks/helloworld
    7. -
  7.  ***/
    8. -
  8.  
    9. -
  9. defined('MOODLE_INTERNAL') or die('Direct access to this script is forbidden.');
    10. -
  10.  
    11. -
  11. class blocks_helloworld_helper_world extends mr_helper_abstract {
    12. -
  12.     /**
    13. -
  13.      * Direct call to world helper
    14. -
  14.      *
    15. -
  15.      * @return string 
    16. -
  16.      */
    17. -
  17.     public function direct() {
    18. -
  18.         return 'Hello direct()!';
    19. -
  19.     }
    20. -
  20.  
    21. -
  21.     /**
    22. -
  22.      * Say Hello
    23. -
  23.      *
    24. -
  24.      * @return string 
    25. -
  25.      */
    26. -
  26.     public function say_hello() {
    27. -
  27.         return 'Hello World!';
    28. -
  28.     }
    29. -
  29. }
    30. -
-
+ + + + + + See a helper implemented in a plugin + + + + +

See a helper implemented in a plugin

+
+
+
    +
  1. +
    <?php
    +
    2. +
  2. +
    /**
    +
    3. +
  3. +
     * World Helper
    +
    4. +
  4. +
     *
    +
    5. +
  5. +
     * @author Mark Nielsen +
    +
    6. +
  6. +
     * @package blocks/helloworld +
    +
    7. +
  7. +
     ***/
    +
    8. +
  8. +
     
    +
    9. +
  9. +
    defined('MOODLE_INTERNAL') or die('Direct access to this script is forbidden.');
    +
    10. +
  10. +
     
    +
    11. +
  11. +
    class blocks_helloworld_helper_world extends mr_helper_abstract {
    +
    12. +
  12. +
        /**
    +
    13. +
  13. +
         * Direct call to world helper +
    +
    14. +
  14. +
         *
    +
    15. +
  15. +
         * @return string  +
    +
    16. +
  16. +
         */
    +
    17. +
  17. +
        public function direct() { +
    +
    18. +
  18. +
            return 'Hello direct()!';
    +
    19. +
  19. +
        }
    +
    20. +
  20. +
     
    +
    21. +
  21. +
        /**
    +
    22. +
  22. +
         * Say Hello
    +
    23. +
  23. +
         *
    +
    24. +
  24. +
         * @return string  +
    +
    25. +
  25. +
         */
    +
    26. +
  26. +
        public function say_hello() { +
    +
    27. +
  27. +
            return 'Hello World!';
    +
    28. +
  28. +
        }
    +
    29. +
  29. +
    }
    +
    30. +
+
+

- Documentation generated on Thu, 28 Jun 2012 16:33:44 -0700 by phpDocumentor 1.4.3 + Documentation generated on Thu, 28 Jun 2012 16:33:44 -0700 by phpDocumentor 1.4.3

- + + \ No newline at end of file diff --git a/docs/__examplesource/exsource_es_joule2-maint_blocks_helloworld_report_users.php_b7f1b3ef628801cb4d798615e6f51528.html b/docs/__examplesource/exsource_es_joule2-maint_blocks_helloworld_report_users.php_b7f1b3ef628801cb4d798615e6f51528.html index 5d5713c2..e7b0de85 100644 --- a/docs/__examplesource/exsource_es_joule2-maint_blocks_helloworld_report_users.php_b7f1b3ef628801cb4d798615e6f51528.html +++ b/docs/__examplesource/exsource_es_joule2-maint_blocks_helloworld_report_users.php_b7f1b3ef628801cb4d798615e6f51528.html @@ -1,91 +1,419 @@ - - - - - See how to extend this class - - - -

See how to extend this class

-
-
  1. <?php
    2. -
  2. /**
    3. -
  3.  * A report for viewing user accounts
    4. -
  4.  *
    5. -
  5.  * @package blocks/helloworld
    6. -
  6.  * @author Mark Nielsen
    7. -
  7.  */
    8. -
  8. class blocks_helloworld_report_users extends mr_report_abstract {
    9. -
  9.     /**
    10. -
  10.      * Report's init routine
    11. -
  11.      *
    12. -
  12.      * @return void 
    13. -
  13.      */
    14. -
  14.     public function init() {
    15. -
  15.         $this->config->set(array(
    16. -
  16.             'export' => '**',
    17. -
  17.             'perpage' => true,
    18. -
  18.             'ajax'    => true,
    19. -
  19.             'perpageopts' => array('all', 1, 5, 10, 50),
    20. -
  20.         ));
    21. -
  21.     }
    22. -
  22.  
    23. -
  23.     /**
    24. -
  24.      * The component string, used for get_string() calls
    25. -
  25.      *
    26. -
  26.      * @return string 
    27. -
  27.      */
    28. -
  28.     public function get_component() {
    29. -
  29.         return 'block_helloworld';
    30. -
  30.     }
    31. -
  31.  
    32. -
  32.     /**
    33. -
  33.      * Filter setup
    34. -
  34.      *
    35. -
  35.      * @return void 
    36. -
  36.      */
    37. -
  37.     public function filter_init() {
    38. -
  38.         $url = clone($this->url);
    39. -
  39.         $url->param('action', 'autocomplete');
    40. -
  40.  
    41. -
  41.         $this->filter = new mr_html_filter($this->preferences, $this->url);
    42. -
  42.         $this->filter->new_autocomplete('username', get_string('username'), $url);
    43. -
  43.         $this->filter->new_autocompleteid('userid', get_string('usernamebyid', 'block_helloworld'), $url, false, 'id');
    44. -
  44.     }
    45. -
  45.  
    46. -
  46.     /**
    47. -
  47.      * Table setup
    48. -
  48.      *
    49. -
  49.      * @return void 
    50. -
  50.      */
    51. -
  51.     public function table_init() {
    52. -
  52.         $this->table = new mr_html_table($this->preferences, $this->url, 'username');
    53. -
  53.         $this->table->add_column('id', '', array('display' => false))
    54. -
  54.                     ->add_column('username', get_string('username'))
    55. -
  55.                     ->add_column('firstname', get_string('firstname'))
    56. -
  56.                     ->add_column('lastname', get_string('lastname'))
    57. -
  57.                     ->add_column('email', get_string('email'))
    58. -
  58.                     ->add_column('lastaccess', get_string('lastaccess'))
    59. -
  59.                     ->add_format('lastaccess', 'date')
    60. -
  60.                     ->add_format(array('username', 'firstname', 'lastname', 'email'), 'string');
    61. -
  61.     }
    62. -
  62.  
    63. -
  63.     /**
    64. -
  64.      * Report SQL
    65. -
  65.      */
    66. -
  66.     public function get_sql($fields, $filtersql, $filterparams) {
    67. -
  67.         $sql = "SELECT $fields
    68. -
  68.                   FROM {user}
    69. -
  69.                  WHERE $filtersql";
    70. -
  70.  
    71. -
  71.         return array($sql, $filterparams);
    72. -
  72.     }
    73. -
  73. }
    74. -
-
+ + + + + + See how to extend this class + + + + +

See how to extend this class

+
+
+
    +
  1. +
    <?php
    +
    2. +
  2. +
    /**
    +
    3. +
  3. +
     * A report for viewing user accounts +
    +
    4. +
  4. +
     *
    +
    5. +
  5. +
     * @package blocks/helloworld +
    +
    6. +
  6. +
     * @author Mark Nielsen +
    +
    7. +
  7. +
     */
    +
    8. +
  8. +
    class blocks_helloworld_report_users extends mr_report_abstract {
    +
    9. +
  9. +
        /**
    +
    10. +
  10. +
         * Report's init routine +
    +
    11. +
  11. +
         *
    +
    12. +
  12. +
         * @return void  +
    +
    13. +
  13. +
         */
    +
    14. +
  14. +
        public function init() { +
    +
    15. +
  15. +
            $this->config->set(array(
    +
    16. +
  16. +
                'export' => '**',
    +
    17. +
  17. +
                'perpage' => true,
    +
    18. +
  18. +
                'ajax'    => true,
    +
    19. +
  19. +
                'perpageopts' => array('all', 1, 5, 10, 50),
    +
    20. +
  20. +
            ));
    +
    21. +
  21. +
        }
    +
    22. +
  22. +
     
    +
    23. +
  23. +
        /**
    +
    24. +
  24. +
         * The component string, +  used for get_string() calls +
    +
    25. +
  25. +
         *
    +
    26. +
  26. +
         * @return string  +
    +
    27. +
  27. +
         */
    +
    28. +
  28. +
        public function get_component() { +
    +
    29. +
  29. +
            return 'block_helloworld';
    +
    30. +
  30. +
        }
    +
    31. +
  31. +
     
    +
    32. +
  32. +
        /**
    +
    33. +
  33. +
         * Filter setup
    +
    34. +
  34. +
         *
    +
    35. +
  35. +
         * @return void  +
    +
    36. +
  36. +
         */
    +
    37. +
  37. +
        public function filter_init() { +
    +
    38. +
  38. +
            $url = clone($this->url);
    +
    39. +
  39. +
            $url->param('action', 'autocomplete');
    +
    40. +
  40. +
     
    +
    41. +
  41. +
            $this->filter = new mr_html_filter($this->preferences, $this->url);
    +
    42. +
  42. +
            $this->filter->new_autocomplete('username', get_string('username'), $url);
    +
    43. +
  43. +
            $this->filter->new_autocompleteid('userid', get_string('usernamebyid', 'block_helloworld'), $url, false, 'id');
    +
    44. +
  44. +
        }
    +
    45. +
  45. +
     
    +
    46. +
  46. +
        /**
    +
    47. +
  47. +
         * Table setup
    +
    48. +
  48. +
         *
    +
    49. +
  49. +
         * @return void  +
    +
    50. +
  50. +
         */
    +
    51. +
  51. +
        public function table_init() { +
    +
    52. +
  52. +
            $this->table = new mr_html_table($this->preferences, $this->url, 'username');
    +
    53. +
  53. +
            $this->table->add_column('id', '', array('display' => false))
    +
    54. +
  54. +
    +                     ->add_column('username', get_string('username'))
    +
    55. +
  55. +
    +                     ->add_column('firstname', get_string('firstname'))
    +
    56. +
  56. +
    +                     ->add_column('lastname', get_string('lastname'))
    +
    57. +
  57. +
    +                     ->add_column('email', get_string('email')) +
    +
    58. +
  58. +
    +                     ->add_column('lastaccess', get_string('lastaccess'))
    +
    59. +
  59. +
    +                     ->add_format('lastaccess', 'date')
    +
    60. +
  60. +
    +                     ->add_format(array('username', 'firstname', 'lastname', 'email'), 'string'); +
    +
    61. +
  61. +
        }
    +
    62. +
  62. +
     
    +
    63. +
  63. +
        /**
    +
    64. +
  64. +
         * Report SQL
    +
    65. +
  65. +
         */
    +
    66. +
  66. +
        public function get_sql($fields, $filtersql, $filterparams) {
    +
    67. +
  67. +
            $sql = "SELECT $fields
    +
    68. +
  68. +
                   +     FROM {user} +
    +
    69. +
  69. +
                   +    WHERE $filtersql";
    +
    70. +
  70. +
     
    +
    71. +
  71. +
            return array($sql, $filterparams);
    +
    72. +
  72. +
        }
    +
    73. +
  73. +
    }
    +
    74. +
+
+

- Documentation generated on Thu, 28 Jun 2012 16:33:46 -0700 by phpDocumentor 1.4.3 + Documentation generated on Thu, 28 Jun 2012 16:33:46 -0700 by phpDocumentor 1.4.3

- + + \ No newline at end of file diff --git a/docs/__examplesource/exsource_le2-maint_blocks_helloworld_controller_default.php_d07b4f4487b0e7d8be5b9565de1680c1.html b/docs/__examplesource/exsource_le2-maint_blocks_helloworld_controller_default.php_d07b4f4487b0e7d8be5b9565de1680c1.html index d0048362..d6cac7cd 100644 --- a/docs/__examplesource/exsource_le2-maint_blocks_helloworld_controller_default.php_d07b4f4487b0e7d8be5b9565de1680c1.html +++ b/docs/__examplesource/exsource_le2-maint_blocks_helloworld_controller_default.php_d07b4f4487b0e7d8be5b9565de1680c1.html @@ -1,227 +1,1212 @@ - - - - - See more examples - - - -

See more examples

-
-
  1. <?php
    2. -
  2. /**
    3. -
  3.  * Default controller
    4. -
  4.  *
    5. -
  5.  * @author Mark Nielsen
    6. -
  6.  * @version $Id$
    7. -
  7.  * @package blocks/helloworld
    8. -
  8.  */
    9. -
  9.  
    10. -
  10. defined('MOODLE_INTERNAL') or die('Direct access to this script is forbidden.');
    11. -
  11.  
    12. -
  12. class block_helloworld_controller_default extends mr_controller_block {
    13. -
  13.  
    14. -
  14.     /**
    15. -
  15.      * Do common setup routines or use to change defaults
    16. -
  16.      */
    17. -
  17.     public function init() {
    18. -
  18.         // Example, change default for tab
    19. -
  19.         // $this->tabs->set($this->action);
    20. -
  20.     }
    21. -
  21.  
    22. -
  22.     /**
    23. -
  23.      * Require capability for viewing this controller
    24. -
  24.      */
    25. -
  25.     public function require_capability() {
    26. -
  26.         /* Example implementation
    27. -
  27.         switch ($this->action) {
    28. -
  28.             case 'view':
    29. -
  29.                 require_capability(...);
    30. -
  30.                 break;
    31. -
  31.             case 'foo':
    32. -
  32.                 require_capability(...);
    33. -
  33.                 break;
    34. -
  34.             default:
    35. -
  35.                 require_capability(...);
    36. -
  36.         }
    37. -
  37.         */
    38. -
  38.  
    39. -
  39.         // Require admin for our admin action
    40. -
  40.         switch ($this->action) {
    41. -
  41.             case 'admin':
    42. -
  42.                 require_capability('moodle/site:config', $this->get_context());
    43. -
  43.                 break;
    44. -
  44.         }
    45. -
  45.     }
    46. -
  46.  
    47. -
  47.     /**
    48. -
  48.      * Define tabs for all controllers
    49. -
  49.      *
    50. -
  50.      * Demo mr_tabs
    51. -
  51.      */
    52. -
  52.     public static function add_tabs($controller, &$tabs) {
    53. -
  53.         // This is the NEW and prefered way to setup tabs.
    54. -
  54.         // Only implement add_tabs in the default controller
    55. -
  55.         // and then use the new mr_tabs methods toptab() and
    56. -
  56.         // subtab() to create the tab structure.
    57. -
  57.         $tabs->toptab('default')
    58. -
  58.              ->subtab('view')
    59. -
  59.              ->subtab('admin', array('action' => 'admin'), has_capability('moodle/site:config', $controller->get_context())) // Visible to admins
    60. -
  60.              ->toptab('html', array('action' => 'html'))
    61. -
  61.              ->toptab('db', array('controller' => 'db'))
    62. -
  62.              ->subtab('view', array('controller' => 'db'))
    63. -
  63.              ->subtab('record', array('controller' => 'db', 'action' => 'record'))
    64. -
  64.              ->subtab('queue', array('controller' => 'db', 'action' => 'queue'))
    65. -
  65.              ->toptab('plugin', array('controller' => 'plugin'))
    66. -
  66.              ->toptab('cache', array('controller' => 'cache'))
    67. -
  67.              ->toptab('filter', array('controller' => 'filter'))
    68. -
  68.              ->toptab('table', array('controller' => 'table'))
    69. -
  69.              ->toptab('report', array('controller' => 'report'))
    70. -
  70.              ->toptab('server', array('controller' => 'server'))
    71. -
  71.              ->toptab('model', array('controller' => 'model'));
    72. -
  72.     }
    73. -
  73.  
    74. -
  74.     /**
    75. -
  75.      * Default screen
    76. -
  76.      *
    77. -
  77.      * Demo of the buffer helper
    78. -
  78.      * Demo of mr_html_tag and tag helper
    79. -
  79.      */
    80. -
  80.     public function view_action() {
    81. -
  81.         // Note, you can get an instance of mr_html_tag like so:
    82. -
  82.         $tag = $this->helper->tag();
    83. -
  83.  
    84. -
  84.         // Advanced usage of mr_html_tag, calls are explained below
    85. -
  85.         return $this->helper->tag->div()->class('centerpara')->close(  // Passing tag contents through close() instead of the opening call: div().  This increases readability.  I can also pass as many params as I want.
    86. -
  86.             $this->helper->tag->p(  // Below, I can pass as many params as I want, all will be added to the contents of this <p> tag
    87. -
  87.                 $this->helper->world->say_hello(),
    88. -
  88.                 $this->helper->tag->p('Global config:'),  // Don't need to call close(), EG: "$this->helper->tag->p('Global config:')->close()" because the tag will be casted to a string and mr_html_tag implements __toString()
    89. -
  89.                 $this->helper->buffer('print_object', $this->config)
    90. -
  90.             ), // Same here, don't need to call close()
    91. -
  91.             $this->output->single_button($this->url->out(false, array('action' => 'saygood')), 'Say good'),
    92. -
  92.             $this->output->single_button($this->url->out(false, array('action' => 'saybad')), 'Say bad')
    93. -
  93.         );
    94. -
  94.     }
    95. -
  95.  
    96. -
  96.     /**
    97. -
  97.      * Example of setting a positive message and then going back to originating screen
    98. -
  98.      *
    99. -
  99.      * Demo of mr_notify
    100. -
  100.      */
    101. -
  101.     public function saygood_action() {
    102. -
  102.         $this->notify->good('good');
    103. -
  103.         redirect($this->url);
    104. -
  104.     }
    105. -
  105.  
    106. -
  106.     /**
    107. -
  107.      * Example of setting a negative message and then going back to originating screen
    108. -
  108.      *
    109. -
  109.      * Demo of mr_notify
    110. -
  110.      */
    111. -
  111.     public function saybad_action() {
    112. -
  112.         $this->notify->bad('bad');
    113. -
  113.         redirect($this->url);
    114. -
  114.     }
    115. -
  115.  
    116. -
  116.     /**
    117. -
  117.      * Admin only, restricted access by $this->require_capability()
    118. -
  118.      */
    119. -
  119.     public function admin_action() {
    120. -
  120.         return 'admin only';
    121. -
  121.     }
    122. -
  122.  
    123. -
  123.     /**
    124. -
  124.      * HTML demo
    125. -
  125.      *
    126. -
  126.      * Demo of mr_html_tag
    127. -
  127.      * Demo of tag helper
    128. -
  128.      */
    129. -
  129.     public function html_action() {
    130. -
  130.         $this->tabs->set('html');
    131. -
  131.         $this->print_header();
    132. -
  132.  
    133. -
  133.         echo $this->output->heading('Demo of mr_html_tag');
    134. -
  134.         $this->helper->highlight(__CLASS__, __FUNCTION__);
    135. -
  135.         echo $this->output->box_start('generalbox boxaligncenter boxwidthnormal');
    136. -
  136.  
    137. -
  137.         #### DEMO CODE ####
    138. -
  138.         // New instance
    139. -
  139.         $tag = new mr_html_tag();
    140. -
  140.         // Create html with the mr_html_tag instance
    141. -
  141.         $html = $tag->a('Click me!')
    142. -
  142.                     ->title('This " should be encoded')
    143. -
  143.                     ->href('http://google.com')
    144. -
  144.                     ->close();
    145. -
  145.         $this->helper->dump($html, 1);
    146. -
  146.  
    147. -
  147.         // Create html with the mr_html_tag::open()
    148. -
  148.         $html = mr_html_tag::open()->a('Click me!')
    149. -
  149.                                    ->title('This " should be encoded')
    150. -
  150.                                    ->href('http://google.com')
    151. -
  151.                                    ->close();
    152. -
  152.         $this->helper->dump($html, 2);
    153. -
  153.  
    154. -
  154.         // Create html with the helper
    155. -
  155.         $html = $this->helper->tag->a('Click me!')
    156. -
  156.                              ->title('This " should be encoded')
    157. -
  157.                              ->href('http://google.com')
    158. -
  158.                              ->close();
    159. -
  159.         $this->helper->dump($html, 3);
    160. -
  160.  
    161. -
  161.         // Example of using the other special methods
    162. -
  162.         $link = $tag->a('Click me!')
    163. -
  163.                     ->title('This " should be encoded')
    164. -
  164.                     ->href('http://google.com')
    165. -
  165.                     ->class('foo');
    166. -
  166.  
    167. -
  167.         // Modify attributes (Note, you can do these in bluk
    168. -
  168.         // with add_attributes(), append_attributes(), prepend_attributes()
    169. -
  169.         // and remove_attributes())
    170. -
  170.         $link->prepend_class('bar')
    171. -
  171.              ->append_class('baz')
    172. -
  172.              ->remove_title();
    173. -
  173.         $this->helper->dump($link->get_class(), 4);
    174. -
  174.  
    175. -
  175.         // When $link is casted to a string, it will automatically render to HTML
    176. -
  176.         $this->helper->dump((string) $link, 5);
    177. -
  177.  
    178. -
  178.         // You can bulk add/modify attributes as well
    179. -
  179.  
    180. -
  180.         // Example of making a tag with no content
    181. -
  181.         $html = $tag->input()
    182. -
  182.                     ->type('submit')
    183. -
  183.                     ->value(get_string('savechanges'))
    184. -
  184.                     ->close();
    185. -
  185.         $this->helper->dump($html, 6);
    186. -
  186.  
    187. -
  187.         // You can pass tag content to either the first call or to close()
    188. -
  188.         $html = $tag->div('This is ')
    189. -
  189.                     ->class('generalbox')
    190. -
  190.                     ->close('cool!');
    191. -
  191.         $this->helper->dump($html, 7);
    192. -
  192.  
    193. -
  193.         // Advanced usage
    194. -
  194.         // Taking advantage of mr_html_tag::__toString to avoid calling close()
    195. -
  195.         // Taking advantage of passing multiple tag content strings
    196. -
  196.         $html = $tag->div()->class('generalbox')->close(
    197. -
  197.             $tag->p(
    198. -
  198.                 'Hello all!',
    199. -
  199.                 $tag->strong('This is cool and stuffs')
    200. -
  200.             ),
    201. -
  201.             $tag->span('Dingo')->class('centerpara')
    202. -
  202.         );
    203. -
  203.         $this->helper->dump($html, 8);
    204. -
  204.         #### DEMO CODE ####
    205. -
  205.  
    206. -
  206.         $this->output->box_end();
    207. -
  207.         $this->print_footer();
    208. -
  208.     }
    209. -
  209. }
    210. -
-
+ + + + + + See more examples + + + + +

See more examples

+
+
+
    +
  1. +
    <?php
    +
    2. +
  2. +
    /**
    +
    3. +
  3. +
     * Default controller
    +
    4. +
  4. +
     *
    +
    5. +
  5. +
     * @author Mark Nielsen +
    +
    6. +
  6. +
     * @version $Id$
    +
    7. +
  7. +
     * @package blocks/helloworld +
    +
    8. +
  8. +
     */
    +
    9. +
  9. +
     
    +
    10. +
  10. +
    defined('MOODLE_INTERNAL') or die('Direct access to this script is forbidden.');
    +
    11. +
  11. +
     
    +
    12. +
  12. +
    class block_helloworld_controller_default extends mr_controller_block {
    +
    13. +
  13. +
     
    +
    14. +
  14. +
        /**
    +
    15. +
  15. +
         * Do common setup routines  + or use to change defaults +
    +
    16. +
  16. +
         */
    +
    17. +
  17. +
        public function init() { +
    +
    18. +
  18. +
            // Example, change default for tab
    +
    19. +
  19. +
            // $this->tabs->set($this->action);
    +
    20. +
  20. +
        }
    +
    21. +
  21. +
     
    +
    22. +
  22. +
        /**
    +
    23. +
  23. +
         * Require capability for  + viewing this controller +
    +
    24. +
  24. +
         */
    +
    25. +
  25. +
        public function require_capability() { +
    +
    26. +
  26. +
            /* Example implementation
    +
    27. +
  27. +
            switch ($this->action) { +
    +
    28. +
  28. +
                case 'view': +
    +
    29. +
  29. +
                     + require_capability(...); +
    +
    30. +
  30. +
                     + break; +
    +
    31. +
  31. +
                case 'foo': +
    +
    32. +
  32. +
                     + require_capability(...); +
    +
    33. +
  33. +
                     + break; +
    +
    34. +
  34. +
                default: +
    +
    35. +
  35. +
                     + require_capability(...); +
    +
    36. +
  36. +
            }
    +
    37. +
  37. +
            */
    +
    38. +
  38. +
     
    +
    39. +
  39. +
            // Require admin for our admin action +
    +
    40. +
  40. +
            switch ($this->action) {
    +
    41. +
  41. +
                case 'admin':
    +
    42. +
  42. +
    +                 require_capability('moodle/site:config', $this->get_context());
    +
    43. +
  43. +
    +                 break;
    +
    44. +
  44. +
            } +
    +
    45. +
  45. +
        }
    +
    46. +
  46. +
     
    +
    47. +
  47. +
        /**
    +
    48. +
  48. +
         * Define tabs for all controllers +
    +
    49. +
  49. +
         *
    +
    50. +
  50. +
         * Demo mr_tabs
    +
    51. +
  51. +
         */
    +
    52. +
  52. +
        public static function add_tabs($controller, &$tabs) {
    +
    53. +
  53. +
            // This is the NEW and prefered way to setup tabs. +
    +
    54. +
  54. +
            // Only implement add_tabs in the default controller +
    +
    55. +
  55. +
            // and then use the new mr_tabs methods toptab() and +
    +
    56. +
  56. +
            // subtab() to create the tab structure. +
    +
    57. +
  57. +
            $tabs->toptab('default')
    +
    58. +
  58. +
    +              ->subtab('view') +
    +
    59. +
  59. +
    +              ->subtab('admin', array('action' => 'admin'), has_capability('moodle/site:config', $controller->get_context())) // Visible to admins
    +
    60. +
  60. +
    +              ->toptab('html', array('action' => 'html'))
    +
    61. +
  61. +
    +              ->toptab('db', array('controller' => 'db'))
    +
    62. +
  62. +
    +              ->subtab('view', array('controller' => 'db'))
    +
    63. +
  63. +
    +              ->subtab('record', array('controller' => 'db', 'action' => 'record'))
    +
    64. +
  64. +
    +              ->subtab('queue', array('controller' => 'db', 'action' => 'queue'))
    +
    65. +
  65. +
    +              ->toptab('plugin', array('controller' => 'plugin'))
    +
    66. +
  66. +
    +              ->toptab('cache', array('controller' => 'cache'))
    +
    67. +
  67. +
    +              ->toptab('filter', array('controller' => 'filter'))
    +
    68. +
  68. +
    +              ->toptab('table', array('controller' => 'table'))
    +
    69. +
  69. +
    +              ->toptab('report', array('controller' => 'report'))
    +
    70. +
  70. +
    +              ->toptab('server', array('controller' => 'server'))
    +
    71. +
  71. +
    +              ->toptab('model', array('controller' => 'model')); +
    +
    72. +
  72. +
        }
    +
    73. +
  73. +
     
    +
    74. +
  74. +
        /**
    +
    75. +
  75. +
         * Default screen
    +
    76. +
  76. +
         *
    +
    77. +
  77. +
         * Demo of the buffer helper +
    +
    78. +
  78. +
         * Demo of mr_html_tag and tag helper +
    +
    79. +
  79. +
         */
    +
    80. +
  80. +
        public function view_action() { +
    +
    81. +
  81. +
            // Note, you can get an instance  + of mr_html_tag like so: +
    +
    82. +
  82. +
            $tag = $this->helper->tag();
    +
    83. +
  83. +
     
    +
    84. +
  84. +
            // Advanced usage of mr_html_tag, calls are explained below +
    +
    85. +
  85. +
            return $this->helper->tag->div()->class('centerpara')->close(  // Passing tag contents through close() instead of the  + opening call: div().  This increases readability.  I can also  + pass as  + many params as I want. +
    +
    86. +
  86. +
                $this->helper->tag->p(  // Below, I can pass as many params as I want,  + all will  + be added to the contents of this <p> tag +
    +
    87. +
  87. +
    +                 $this->helper->world->say_hello(),
    +
    88. +
  88. +
    +                 $this->helper->tag->p('Global config:'),  // Don't need to call close(), EG: "$this->helper->tag-> + p('Global config:')->close()" because the tag will be casted to  + a string and mr_html_tag implements __toString() +
    +
    89. +
  89. +
    +                 $this->helper->buffer('print_object', $this->config)
    +
    90. +
  90. +
                ), // Same here, don't need to call close() +
    +
    91. +
  91. +
                $this->output->single_button($this->url->out(false, array('action' => 'saygood')), 'Say good'),
    +
    92. +
  92. +
                $this->output->single_button($this->url->out(false, array('action' => 'saybad')), 'Say bad')
    +
    93. +
  93. +
            );
    +
    94. +
  94. +
        }
    +
    95. +
  95. +
     
    +
    96. +
  96. +
        /**
    +
    97. +
  97. +
         * Example of setting a positive  + message and then going back to originating screen +
    +
    98. +
  98. +
         *
    +
    99. +
  99. +
         * Demo of mr_notify +
    +
    100. +
  100. +
         */
    +
    101. +
  101. +
        public function saygood_action() { +
    +
    102. +
  102. +
            $this->notify->good('good'); +
    +
    103. +
  103. +
            redirect($this->url);
    +
    104. +
  104. +
        }
    +
    105. +
  105. +
     
    +
    106. +
  106. +
        /**
    +
    107. +
  107. +
         * Example of setting a negative message  + and then going back to originating screen +
    +
    108. +
  108. +
         *
    +
    109. +
  109. +
         * Demo of mr_notify +
    +
    110. +
  110. +
         */
    +
    111. +
  111. +
        public function saybad_action() { +
    +
    112. +
  112. +
            $this->notify->bad('bad'); +
    +
    113. +
  113. +
            redirect($this->url);
    +
    114. +
  114. +
        }
    +
    115. +
  115. +
     
    +
    116. +
  116. +
        /**
    +
    117. +
  117. +
         * Admin only, restricted access by  + $this->require_capability() +
    +
    118. +
  118. +
         */
    +
    119. +
  119. +
        public function admin_action() { +
    +
    120. +
  120. +
            return 'admin only';
    +
    121. +
  121. +
        }
    +
    122. +
  122. +
     
    +
    123. +
  123. +
        /**
    +
    124. +
  124. +
         * HTML demo
    +
    125. +
  125. +
         *
    +
    126. +
  126. +
         * Demo of mr_html_tag +
    +
    127. +
  127. +
         * Demo of tag helper +
    +
    128. +
  128. +
         */
    +
    129. +
  129. +
        public function html_action() { +
    +
    130. +
  130. +
            $this->tabs->set('html'); +
    +
    131. +
  131. +
            $this->print_header();
    +
    132. +
  132. +
     
    +
    133. +
  133. +
            echo $this->output->heading('Demo of mr_html_tag');
    +
    134. +
  134. +
            $this->helper->highlight(__CLASS__, __FUNCTION__);
    +
    135. +
  135. +
            echo $this->output->box_start('generalbox boxaligncenter boxwidthnormal');
    +
    136. +
  136. +
     
    +
    137. +
  137. +
            #### DEMO CODE ####
    +
    138. +
  138. +
            // New instance
    +
    139. +
  139. +
            $tag = new mr_html_tag();
    +
    140. +
  140. +
            // Create html with the mr_html_tag instance +
    +
    141. +
  141. +
            $html = $tag->a('Click me!')
    +
    142. +
  142. +
    +                     ->title('This " should be encoded')
    +
    143. +
  143. +
    +                     ->href('http://google.com')
    +
    144. +
  144. +
    +                     ->close();
    +
    145. +
  145. +
            $this->helper->dump($html, 1);
    +
    146. +
  146. +
     
    +
    147. +
  147. +
            // Create html with the mr_html_tag::open() +
    +
    148. +
  148. +
            $html = mr_html_tag::open()->a('Click me!')
    +
    149. +
  149. +
    +                      +                ->title('This " should be encoded')
    +
    150. +
  150. +
    +                      +                ->href('http://google.com')
    +
    151. +
  151. +
    +                      +                ->close();
    +
    152. +
  152. +
            $this->helper->dump($html, 2);
    +
    153. +
  153. +
     
    +
    154. +
  154. +
            // Create html with the helper
    +
    155. +
  155. +
            $html = $this->helper->tag->a('Click me!')
    +
    156. +
  156. +
    +                      +          ->title('This " should be encoded')
    +
    157. +
  157. +
    +                      +          ->href('http://google.com')
    +
    158. +
  158. +
    +                      +          ->close();
    +
    159. +
  159. +
            $this->helper->dump($html, 3);
    +
    160. +
  160. +
     
    +
    161. +
  161. +
            // Example of using the other special methods +
    +
    162. +
  162. +
            $link = $tag->a('Click me!')
    +
    163. +
  163. +
    +                     ->title('This " should be encoded')
    +
    164. +
  164. +
    +                     ->href('http://google.com')
    +
    165. +
  165. +
    +                     ->class('foo');
    +
    166. +
  166. +
     
    +
    167. +
  167. +
            // Modify attributes (Note, you can do these in bluk +
    +
    168. +
  168. +
            // with add_attributes(), append_attributes(), prepend_attributes() +
    +
    169. +
  169. +
            // and remove_attributes())
    +
    170. +
  170. +
            $link->prepend_class('bar')
    +
    171. +
  171. +
    +              ->append_class('baz') +
    +
    172. +
  172. +
    +              ->remove_title();
    +
    173. +
  173. +
            $this->helper->dump($link->get_class(), 4);
    +
    174. +
  174. +
     
    +
    175. +
  175. +
            // When $link is casted to a string, it will  + automatically render to HTML +
    +
    176. +
  176. +
            $this->helper->dump((string) $link, 5);
    +
    177. +
  177. +
     
    +
    178. +
  178. +
            // You can bulk add/modify attributes as well +
    +
    179. +
  179. +
     
    +
    180. +
  180. +
            // Example of making a tag with no content +
    +
    181. +
  181. +
            $html = $tag->input()
    +
    182. +
  182. +
    +                     ->type('submit') +
    +
    183. +
  183. +
    +                     ->value(get_string('savechanges'))
    +
    184. +
  184. +
    +                     ->close();
    +
    185. +
  185. +
            $this->helper->dump($html, 6);
    +
    186. +
  186. +
     
    +
    187. +
  187. +
            // You can pass tag content to either the first  + call or to close() +
    +
    188. +
  188. +
            $html = $tag->div('This is ')
    +
    189. +
  189. +
    +                     ->class('generalbox')
    +
    190. +
  190. +
    +                     ->close('cool!');
    +
    191. +
  191. +
            $this->helper->dump($html, 7);
    +
    192. +
  192. +
     
    +
    193. +
  193. +
            // Advanced usage
    +
    194. +
  194. +
            // Taking advantage of mr_html_tag::__toString to  + avoid calling close() +
    +
    195. +
  195. +
            // Taking advantage of passing multiple tag content strings +
    +
    196. +
  196. +
            $html = $tag->div()->class('generalbox')->close(
    +
    197. +
  197. +
                $tag->p(
    +
    198. +
  198. +
    +                 'Hello all!',
    +
    199. +
  199. +
    +                 $tag->strong('This is cool and stuffs')
    +
    200. +
  200. +
                ),
    +
    201. +
  201. +
                $tag->span('Dingo')->class('centerpara')
    +
    202. +
  202. +
            );
    +
    203. +
  203. +
            $this->helper->dump($html, 8);
    +
    204. +
  204. +
            #### DEMO CODE ####
    +
    205. +
  205. +
     
    +
    206. +
  206. +
            $this->output->box_end();
    +
    207. +
  207. +
            $this->print_footer();
    +
    208. +
  208. +
        }
    +
    209. +
  209. +
    }
    +
    210. +
+
+

- Documentation generated on Thu, 28 Jun 2012 16:33:53 -0700 by phpDocumentor 1.4.3 + Documentation generated on Thu, 28 Jun 2012 16:33:53 -0700 by phpDocumentor 1.4.3

- + + \ No newline at end of file diff --git a/docs/__examplesource/exsource_le2-maint_blocks_helloworld_lib_server_service.php_df94f9c9f06a3bd8592f0a887db91e47.html b/docs/__examplesource/exsource_le2-maint_blocks_helloworld_lib_server_service.php_df94f9c9f06a3bd8592f0a887db91e47.html index 606fc915..dbdeb5aa 100644 --- a/docs/__examplesource/exsource_le2-maint_blocks_helloworld_lib_server_service.php_df94f9c9f06a3bd8592f0a887db91e47.html +++ b/docs/__examplesource/exsource_le2-maint_blocks_helloworld_lib_server_service.php_df94f9c9f06a3bd8592f0a887db91e47.html @@ -1,47 +1,155 @@ - - - - - Example class definition - - - -

Example class definition

-
-
  1. <?php
    2. -
  2. /**
    3. -
  3.  * Available Web Services
    4. -
  4.  *
    5. -
  5.  * @package blocks/helloworld
    6. -
  6.  * @author Mark Nielsen
    7. -
  7.  */
    8. -
  8. class blocks_helloworld_lib_server_service extends mr_server_service_abstract {
    9. -
  9.     /**
    10. -
  10.      * Constructor hook: this is a great place to call mr_on
    11. -
  11.      *
    12. -
  12.      * @return void 
    13. -
  13.      */
    14. -
  14.     protected function init() {
    15. -
  15.         if (!mr_on('helloworld', 'block')) {
    16. -
  16.             throw new Exception('Block is not enabled: blocks/helloworld');
    17. -
  17.         }
    18. -
  18.     }
    19. -
  19.  
    20. -
  20.     /**
    21. -
  21.      * Test Service
    22. -
  22.      *
    23. -
  23.      * @param string $say Tell the service what to say
    24. -
  24.      * @return string 
    25. -
  25.      */
    26. -
  26.     public function test($say) {
    27. -
  27.         return $this->response->test($say);
    28. -
  28.     }
    29. -
  29. }
    30. -
-
+ + + + + + Example class definition + + + + +

Example class definition

+
+
+
    +
  1. +
    <?php
    +
    2. +
  2. +
    /**
    +
    3. +
  3. +
     * Available Web Services +
    +
    4. +
  4. +
     *
    +
    5. +
  5. +
     * @package blocks/helloworld +
    +
    6. +
  6. +
     * @author Mark Nielsen +
    +
    7. +
  7. +
     */
    +
    8. +
  8. +
    class blocks_helloworld_lib_server_service extends mr_server_service_abstract {
    +
    9. +
  9. +
        /**
    +
    10. +
  10. +
         * Constructor hook: this  + is a great place to call mr_on +
    +
    11. +
  11. +
         *
    +
    12. +
  12. +
         * @return void  +
    +
    13. +
  13. +
         */
    +
    14. +
  14. +
        protected function init() { +
    +
    15. +
  15. +
            if (!mr_on('helloworld', 'block')) {
    +
    16. +
  16. +
    +             throw new Exception('Block is not enabled: blocks/helloworld');
    +
    17. +
  17. +
            } +
    +
    18. +
  18. +
        }
    +
    19. +
  19. +
     
    +
    20. +
  20. +
        /**
    +
    21. +
  21. +
         * Test Service
    +
    22. +
  22. +
         *
    +
    23. +
  23. +
         * @param string $say Tell the service what to say
    +
    24. +
  24. +
         * @return string  +
    +
    25. +
  25. +
         */
    +
    26. +
  26. +
        public function test($say) {
    +
    27. +
  27. +
            return $this->response->test($say);
    +
    28. +
  28. +
        }
    +
    29. +
  29. +
    }
    +
    30. +
+
+

- Documentation generated on Thu, 28 Jun 2012 16:33:45 -0700 by phpDocumentor 1.4.3 + Documentation generated on Thu, 28 Jun 2012 16:33:45 -0700 by phpDocumentor 1.4.3

- + + \ No newline at end of file diff --git a/docs/__examplesource/exsource_mark_Sites_joule2-maint_blocks_helloworld_view.php_b33cb6a0be974c2a717c7551e2cb3392.html b/docs/__examplesource/exsource_mark_Sites_joule2-maint_blocks_helloworld_view.php_b33cb6a0be974c2a717c7551e2cb3392.html index 3008c4cb..545ea88b 100644 --- a/docs/__examplesource/exsource_mark_Sites_joule2-maint_blocks_helloworld_view.php_b33cb6a0be974c2a717c7551e2cb3392.html +++ b/docs/__examplesource/exsource_mark_Sites_joule2-maint_blocks_helloworld_view.php_b33cb6a0be974c2a717c7551e2cb3392.html @@ -1,39 +1,116 @@ - - - - - See how to use this file - - - -

See how to use this file

-
-
  1. <?php
    2. -
  2. /**
    3. -
  3.  * View renderer
    4. -
  4.  *
    5. -
  5.  * @author Mark Nielsen
    6. -
  6.  * @version $Id$
    7. -
  7.  * @package blocks/helloworld
    8. -
  8.  */
    9. -
  9.  
    10. -
  10. require_once('../../config.php');
    11. -
  11.  
    12. -
  12. // By including mr/bootstrap.php, all mr
    13. -
  13. // classes become available to us.  So now
    14. -
  14. // we can call mr_controller without explicitly
    15. -
  15. // including its class file.
    16. -
  16. // Use mr_bootstrap::shutdown(); to turn off
    17. -
  17. // class autoloading (basically the opposite of
    18. -
  18. // mr_bootstrap::startup();)
    19. -
  19. require($CFG->dirroot.'/local/mr/bootstrap.php');
    20. -
  20.  
    21. -
  21. mr_controller::render('blocks/helloworld', 'blockname', 'block_helloworld');
    22. -
-
+ + + + + + See how to use this file + + + + +

See how to use this file

+
+
+
    +
  1. +
    <?php
    +
    2. +
  2. +
    /**
    +
    3. +
  3. +
     * View renderer
    +
    4. +
  4. +
     *
    +
    5. +
  5. +
     * @author Mark Nielsen +
    +
    6. +
  6. +
     * @version $Id$
    +
    7. +
  7. +
     * @package blocks/helloworld +
    +
    8. +
  8. +
     */
    +
    9. +
  9. +
     
    +
    10. +
  10. +
    require_once('../../config.php');
    +
    11. +
  11. +
     
    +
    12. +
  12. +
    // By including mr/bootstrap.php, all mr +
    +
    13. +
  13. +
    // classes become available to us.  So now +
    +
    14. +
  14. +
    // we can call mr_controller without explicitly +
    +
    15. +
  15. +
    // including its class file. +
    +
    16. +
  16. +
    // Use mr_bootstrap::shutdown(); to turn off +
    +
    17. +
  17. +
    // class autoloading (basically the opposite of +
    +
    18. +
  18. +
    // mr_bootstrap::startup();)
    +
    19. +
  19. +
    require($CFG->dirroot.'/local/mr/bootstrap.php');
    +
    20. +
  20. +
     
    +
    21. +
  21. +
    mr_controller::render('blocks/helloworld', 'blockname', 'block_helloworld');
    +
    22. +
+
+

- Documentation generated on Thu, 28 Jun 2012 16:33:46 -0700 by phpDocumentor 1.4.3 + Documentation generated on Thu, 28 Jun 2012 16:33:46 -0700 by phpDocumentor 1.4.3

- + + \ No newline at end of file diff --git a/docs/__examplesource/exsource_oule2-maint_blocks_helloworld_controller_cache.php_130fbc642e5778bc139412ebb569c3be.html b/docs/__examplesource/exsource_oule2-maint_blocks_helloworld_controller_cache.php_130fbc642e5778bc139412ebb569c3be.html index 9915af85..0a91dd3b 100644 --- a/docs/__examplesource/exsource_oule2-maint_blocks_helloworld_controller_cache.php_130fbc642e5778bc139412ebb569c3be.html +++ b/docs/__examplesource/exsource_oule2-maint_blocks_helloworld_controller_cache.php_130fbc642e5778bc139412ebb569c3be.html @@ -1,95 +1,423 @@ - - - - - See the cache in action - - - -

See the cache in action

-
-
  1. <?php
    2. -
  2. /**
    3. -
  3.  * Cache controller
    4. -
  4.  *
    5. -
  5.  * @author Mark Nielsen
    6. -
  6.  * @version $Id$
    7. -
  7.  * @package blocks/helloworld
    8. -
  8.  */
    9. -
  9.  
    10. -
  10. defined('MOODLE_INTERNAL') or die('Direct access to this script is forbidden.');
    11. -
  11.  
    12. -
  12. class block_helloworld_controller_cache extends mr_controller_block {
    13. -
  13.     /**
    14. -
  14.      * Default screen
    15. -
  15.      *
    16. -
  16.      * Demo of cache
    17. -
  17.      */
    18. -
  18.     public function view_action() {
    19. -
  19.         $this->print_header();
    20. -
  20.         echo $this->output->heading('Demo of mr_cache');
    21. -
  21.         $this->helper->highlight(__CLASS__, __FUNCTION__);
    22. -
  22.         echo $this->output->box_start('generalbox boxaligncenter boxwidthnormal');
    23. -
  23.  
    24. -
  24.         #### DEMO CODE ####
    25. -
  25.         // Note: you can make your very own instance of mr_cache!
    26. -
  26.         // $this->helper->cache is EXACTLY the same as:
    27. -
  27.         // $cache = new mr_cache('blocks_helloworld_');
    28. -
  28.  
    29. -
  29.         // Try to load cache ID = time_string from cache
    30. -
  30.         if (!$string = $this->helper->cache->load('time_string')) {
    31. -
  31.             // Failed to get from cache, create a new string to cache
    32. -
  32.             $string = 'Last cache: '.userdate(time(), '%A, %d %B %Y, %r');
    33. -
  33.  
    34. -
  34.             // Save the string to cache using cache ID = time_string
    35. -
  35.             $this->helper->cache($string, 'time_string');
    36. -
  36.  
    37. -
  37.             // Note: the above line is EXACTLY the same as:
    38. -
  38.             // $this->helper->cache->save($string, 'time_string');
    39. -
  39.         }
    40. -
  40.         $this->helper->dump($string, 'Currently cached value');
    41. -
  41.  
    42. -
  42.         // See if a cached ID exists or not
    43. -
  43.         if (!$this->helper->cache->test('time_string')) {
    44. -
  44.             // In this case, if we get here, its bad, cache isn't working
    45. -
  45.             $this->notify->add_string('cache doesnt exist');
    46. -
  46.         }
    47. -
  47.  
    48. -
  48.         // EXAMPLE:
    49. -
  49.         // Slightly different code when storing data that fails to pass is_string()
    50. -
  50.         // Data like this, gets serialized, need to tell load method to unserialize it like so
    51. -
  51.         // if (!$array = $this->helper->cache->load('array_example', true)) {  // ADDED: true
    52. -
  52.         //     $array = array('foo', 'bar', $string);
    53. -
  53.         //
    54. -
  54.         //     // Save as we normally do, mr_cache will automatically serialize $array
    55. -
  55.         //     $this->helper->cache($array, 'array_example');
    56. -
  56.         // }
    57. -
  57.         // print_object($array);
    58. -
  58.         #### DEMO CODE ####
    59. -
  59.  
    60. -
  60.         echo $this->output->single_button($this->url->out(false, array('action' => 'delete')), 'Delete cache');
    61. -
  61.         echo $this->output->box_end();
    62. -
  62.         $this->print_footer();
    63. -
  63.     }
    64. -
  64.  
    65. -
  65.     /**
    66. -
  66.      * Delete cached item
    67. -
  67.      *
    68. -
  68.      * Demo of cache
    69. -
  69.      */
    70. -
  70.     public function delete_action() {
    71. -
  71.         // Remove the cached item
    72. -
  72.         $this->helper->cache->remove('time_string');
    73. -
  73.  
    74. -
  74.         $this->notify->add_string('cache reset', mr_notify::GOOD);
    75. -
  75.         redirect($this->url);
    76. -
  76.     }
    77. -
  77. }
    78. -
-
+ + + + + + See the cache in action + + + + +

See the cache in action

+
+
+
    +
  1. +
    <?php
    +
    2. +
  2. +
    /**
    +
    3. +
  3. +
     * Cache controller
    +
    4. +
  4. +
     *
    +
    5. +
  5. +
     * @author Mark Nielsen +
    +
    6. +
  6. +
     * @version $Id$
    +
    7. +
  7. +
     * @package blocks/helloworld +
    +
    8. +
  8. +
     */
    +
    9. +
  9. +
     
    +
    10. +
  10. +
    defined('MOODLE_INTERNAL') or die('Direct access to this script is forbidden.');
    +
    11. +
  11. +
     
    +
    12. +
  12. +
    class block_helloworld_controller_cache extends mr_controller_block {
    +
    13. +
  13. +
        /**
    +
    14. +
  14. +
         * Default screen
    +
    15. +
  15. +
         *
    +
    16. +
  16. +
         * Demo of cache
    +
    17. +
  17. +
         */
    +
    18. +
  18. +
        public function view_action() { +
    +
    19. +
  19. +
            $this->print_header();
    +
    20. +
  20. +
            echo $this->output->heading('Demo of mr_cache');
    +
    21. +
  21. +
            $this->helper->highlight(__CLASS__, __FUNCTION__);
    +
    22. +
  22. +
            echo $this->output->box_start('generalbox boxaligncenter boxwidthnormal');
    +
    23. +
  23. +
     
    +
    24. +
  24. +
            #### DEMO CODE ####
    +
    25. +
  25. +
            // Note: you can make your very  + own instance of mr_cache! +
    +
    26. +
  26. +
            // $this->helper->cache is EXACTLY the same as: +
    +
    27. +
  27. +
            // $cache = new mr_cache('blocks_helloworld_'); +
    +
    28. +
  28. +
     
    +
    29. +
  29. +
            // Try to load cache ID = time_string from cache +
    +
    30. +
  30. +
            if (!$string = $this->helper->cache->load('time_string')) {
    +
    31. +
  31. +
                // Failed to get from cache, create a new string  + to cache +
    +
    32. +
  32. +
                $string = 'Last cache: '.userdate(time(), '%A, %d %B %Y, %r');
    +
    33. +
  33. +
     
    +
    34. +
  34. +
                // Save the string to cache using cache  + ID = time_string +
    +
    35. +
  35. +
                $this->helper->cache($string, 'time_string');
    +
    36. +
  36. +
     
    +
    37. +
  37. +
                // Note: the above line is EXACTLY the same as: +
    +
    38. +
  38. +
                // $this->helper->cache->save($string, 'time_string'); +
    +
    39. +
  39. +
            } +
    +
    40. +
  40. +
            $this->helper->dump($string, 'Currently cached value');
    +
    41. +
  41. +
     
    +
    42. +
  42. +
            // See if a cached ID exists or not +
    +
    43. +
  43. +
            if (!$this->helper->cache->test('time_string')) {
    +
    44. +
  44. +
                // In this case, if we get here, its  + bad, cache isn't working +
    +
    45. +
  45. +
                $this->notify->add_string('cache doesnt exist');
    +
    46. +
  46. +
            } +
    +
    47. +
  47. +
     
    +
    48. +
  48. +
            // EXAMPLE:
    +
    49. +
  49. +
            // Slightly different code when storing data  + that fails to pass is_string() +
    +
    50. +
  50. +
            // Data like this, gets serialized, need to tell  + load method to unserialize it like so +
    +
    51. +
  51. +
            // if (!$array = $this->helper->cache-> + load('array_example', true))  + {  // ADDED: true +
    +
    52. +
  52. +
            //     $array = array('foo', 'bar', $string); +
    +
    53. +
  53. +
            //
    +
    54. +
  54. +
            //     // Save as we normally do, mr_cache  + will automatically serialize $array +
    +
    55. +
  55. +
            //     $this->helper->cache($array, 'array_example'); +
    +
    56. +
  56. +
            // }
    +
    57. +
  57. +
            // print_object($array);
    +
    58. +
  58. +
            #### DEMO CODE ####
    +
    59. +
  59. +
     
    +
    60. +
  60. +
            echo $this->output->single_button($this->url->out(false, array('action' => 'delete')), 'Delete cache');
    +
    61. +
  61. +
            echo $this->output->box_end();
    +
    62. +
  62. +
            $this->print_footer();
    +
    63. +
  63. +
        }
    +
    64. +
  64. +
     
    +
    65. +
  65. +
        /**
    +
    66. +
  66. +
         * Delete cached item +
    +
    67. +
  67. +
         *
    +
    68. +
  68. +
         * Demo of cache
    +
    69. +
  69. +
         */
    +
    70. +
  70. +
        public function delete_action() { +
    +
    71. +
  71. +
            // Remove the cached item
    +
    72. +
  72. +
            $this->helper->cache->remove('time_string');
    +
    73. +
  73. +
     
    +
    74. +
  74. +
            $this->notify->add_string('cache reset', mr_notify::GOOD);
    +
    75. +
  75. +
            redirect($this->url);
    +
    76. +
  76. +
        }
    +
    77. +
  77. +
    }
    +
    78. +
+
+

- Documentation generated on Thu, 28 Jun 2012 16:33:47 -0700 by phpDocumentor 1.4.3 + Documentation generated on Thu, 28 Jun 2012 16:33:47 -0700 by phpDocumentor 1.4.3

- + + \ No newline at end of file diff --git a/docs/__examplesource/exsource_oule2-maint_blocks_helloworld_controller_model.php_2d255e8d018617d4ffe86fe10e326331.html b/docs/__examplesource/exsource_oule2-maint_blocks_helloworld_controller_model.php_2d255e8d018617d4ffe86fe10e326331.html index 2fccf57b..1766a8d6 100644 --- a/docs/__examplesource/exsource_oule2-maint_blocks_helloworld_controller_model.php_2d255e8d018617d4ffe86fe10e326331.html +++ b/docs/__examplesource/exsource_oule2-maint_blocks_helloworld_controller_model.php_2d255e8d018617d4ffe86fe10e326331.html @@ -1,99 +1,464 @@ - - - - - See this class in action - - - -

See this class in action

-
-
  1. <?php
    2. -
  2. /**
    3. -
  3.  * Model controller
    4. -
  4.  *
    5. -
  5.  * @author Mark Nielsen
    6. -
  6.  * @package block_helloworld
    7. -
  7.  */
    8. -
  8.  
    9. -
  9. defined('MOODLE_INTERNAL') or die('Direct access to this script is forbidden.');
    10. -
  10.  
    11. -
  11. class block_helloworld_controller_model extends mr_controller_block {
    12. -
  12.     /**
    13. -
  13.      * Default screen
    14. -
  14.      *
    15. -
  15.      * Demo of mr_model_record_abstract
    16. -
  16.      * Demo of mr_repository_abstract
    17. -
  17.      */
    18. -
  18.     public function view_action() {
    19. -
  19.         global $CFG;
    20. -
  20.  
    21. -
  21.         require_once($CFG->dirroot.'/blocks/helloworld/repository/helloworld.php');
    22. -
  22.  
    23. -
  23.         $output = '';
    24. -
  24.  
    25. -
  25.         #### DEMO CODE ####
    26. -
  26.         // Our repository
    27. -
  27.         $repo = new block_helloworld_repository_helloworld();
    28. -
  28.  
    29. -
  29.         // Create a new instance of our model, set some properties
    30. -
  30.         $bat = new block_helloworld_model_helloworld();
    31. -
  31.         $bat->set_name('Fred')->set_foo('foo')->set_bar('bar');
    32. -
  32.  
    33. -
  33.         // Save it, repository figures out its an insert based on id property
    34. -
  34.         $repo->save($bat);
    35. -
  35.  
    36. -
  36.         $output .= $this->helper->dump($bat, '$bat after insert (id is now set for us)', true);
    37. -
  37.  
    38. -
  38.         // ...later we can get $bat
    39. -
  39.         $model = $repo->get(array('id' => $bat->get_id()));
    40. -
  40.  
    41. -
  41.         $output .= $this->helper->dump($model, 'Result of $repo->get(...)', true);
    42. -
  42.  
    43. -
  43.         // Because of the @method in our repository class's PHPDoc,
    44. -
  44.         // our ID can auto-complete on our $model, try it out!
    45. -
  45.         $name = $model->get_name();
    46. -
  46.  
    47. -
  47.         $output .= $this->helper->dump($name, 'Result of $model->get_name()', true);
    48. -
  48.  
    49. -
  49.         // Now we can delete Fred!
    50. -
  50.         $repo->delete($model);
    51. -
  51.  
    52. -
  52.         $output .= $this->helper->dump($model, '$model after delete (id is now set to null)', true);
    53. -
  53.  
    54. -
  54.         // Let's try iterating over a mr_repository_recordset!
    55. -
  55.  
    56. -
  56.         // Make some records...
    57. -
  57.         $repo->save(new block_helloworld_model_helloworld(array('name' => 'Tom')))
    58. -
  58.              ->save(new block_helloworld_model_helloworld(array('name' => 'Martin')))
    59. -
  59.              ->save(new block_helloworld_model_helloworld(array('name' => 'Kris')));
    60. -
  60.  
    61. -
  61.  
    62. -
  62.         // Our repository mapper can return a special record set, mr_repository_recordset, that returns
    63. -
  63.         // instances of our models when we iterate over it
    64. -
  64.         $rs = $repo->get_recordset();
    65. -
  65.         foreach ($rs as $instance) {
    66. -
  66.             // This PHPDoc tells our IDE that $instance is an instance of block_helloworld_model_helloworld
    67. -
  67.             /** @var $instance block_helloworld_model_helloworld */
    68. -
  68.             $instance->get_name(); // Try it out!
    69. -
  69.  
    70. -
  70.             $output .= $this->helper->dump($instance, '$instance dump in foreach loop', true);
    71. -
  71.  
    72. -
  72.             $repo->delete($instance);
    73. -
  73.         }
    74. -
  74.         $rs->close();  // Don't forget to close, just like usual!
    75. -
  75.         #### DEMO CODE ####
    76. -
  76.  
    77. -
  77.         return $this->output->heading('Demo of mr_model_record_abstract and mr_repository_abstract').
    78. -
  78.                $this->helper->highlight(__CLASS__, __FUNCTION__, true).
    79. -
  79.                $this->output->box($output, 'generalbox boxaligncenter boxwidthnormal');
    80. -
  80.     }
    81. -
  81. }
    82. -
-
+ + + + + + See this class in action + + + + +

See this class in action

+
+
+
    +
  1. +
    <?php
    +
    2. +
  2. +
    /**
    +
    3. +
  3. +
     * Model controller
    +
    4. +
  4. +
     *
    +
    5. +
  5. +
     * @author Mark Nielsen +
    +
    6. +
  6. +
     * @package block_helloworld +
    +
    7. +
  7. +
     */
    +
    8. +
  8. +
     
    +
    9. +
  9. +
    defined('MOODLE_INTERNAL') or die('Direct access to this script is forbidden.');
    +
    10. +
  10. +
     
    +
    11. +
  11. +
    class block_helloworld_controller_model extends mr_controller_block {
    +
    12. +
  12. +
        /**
    +
    13. +
  13. +
         * Default screen
    +
    14. +
  14. +
         *
    +
    15. +
  15. +
         * Demo of mr_model_record_abstract +
    +
    16. +
  16. +
         * Demo of mr_repository_abstract +
    +
    17. +
  17. +
         */
    +
    18. +
  18. +
        public function view_action() { +
    +
    19. +
  19. +
            global $CFG;
    +
    20. +
  20. +
     
    +
    21. +
  21. +
            require_once($CFG->dirroot.'/blocks/helloworld/repository/helloworld.php');
    +
    22. +
  22. +
     
    +
    23. +
  23. +
            $output = '';
    +
    24. +
  24. +
     
    +
    25. +
  25. +
            #### DEMO CODE ####
    +
    26. +
  26. +
            // Our repository
    +
    27. +
  27. +
            $repo = new block_helloworld_repository_helloworld();
    +
    28. +
  28. +
     
    +
    29. +
  29. +
            // Create a new instance of our model,  + set some properties +
    +
    30. +
  30. +
            $bat = new block_helloworld_model_helloworld();
    +
    31. +
  31. +
            $bat->set_name('Fred')->set_foo('foo')->set_bar('bar'); +
    +
    32. +
  32. +
     
    +
    33. +
  33. +
            // Save it, repository figures out its an insert  + based on id property +
    +
    34. +
  34. +
            $repo->save($bat); +
    +
    35. +
  35. +
     
    +
    36. +
  36. +
            $output .= $this->helper->dump($bat, '$bat after insert (id is now set for us)', true);
    +
    37. +
  37. +
     
    +
    38. +
  38. +
            // ...later we can get $bat
    +
    39. +
  39. +
            $model = $repo->get(array('id' => $bat->get_id()));
    +
    40. +
  40. +
     
    +
    41. +
  41. +
            $output .= $this->helper->dump($model, 'Result of $repo->get(...)', true);
    +
    42. +
  42. +
     
    +
    43. +
  43. +
            // Because of the @method in our  + repository class's PHPDoc, +
    +
    44. +
  44. +
            // our ID can auto-complete on our  + $model, try it out! +
    +
    45. +
  45. +
            $name = $model->get_name();
    +
    46. +
  46. +
     
    +
    47. +
  47. +
            $output .= $this->helper->dump($name, 'Result of $model->get_name()', true);
    +
    48. +
  48. +
     
    +
    49. +
  49. +
            // Now we can delete Fred!
    +
    50. +
  50. +
            $repo->delete($model); +
    +
    51. +
  51. +
     
    +
    52. +
  52. +
            $output .= $this->helper->dump($model, '$model after delete (id is now set to null)', true);
    +
    53. +
  53. +
     
    +
    54. +
  54. +
            // Let's try iterating over a mr_repository_recordset! +
    +
    55. +
  55. +
     
    +
    56. +
  56. +
            // Make some records...
    +
    57. +
  57. +
            $repo->save(new block_helloworld_model_helloworld(array('name' => 'Tom')))
    +
    58. +
  58. +
    +              ->save(new block_helloworld_model_helloworld(array('name' => 'Martin')))
    +
    59. +
  59. +
    +              ->save(new block_helloworld_model_helloworld(array('name' => 'Kris')));
    +
    60. +
  60. +
     
    +
    61. +
  61. +
     
    +
    62. +
  62. +
            // Our repository mapper can return a special  + record set, mr_repository_recordset, that returns +
    +
    63. +
  63. +
            // instances of our models when we iterate over it +
    +
    64. +
  64. +
            $rs = $repo->get_recordset();
    +
    65. +
  65. +
            foreach ($rs as $instance) {
    +
    66. +
  66. +
                // This PHPDoc tells our IDE that $instance  + is an instance of block_helloworld_model_helloworld +
    +
    67. +
  67. +
    +             /** @var $instance  + block_helloworld_model_helloworld */ +
    +
    68. +
  68. +
                $instance->get_name(); // Try it out!
    +
    69. +
  69. +
     
    +
    70. +
  70. +
                $output .= $this->helper->dump($instance, '$instance dump in foreach loop', true);
    +
    71. +
  71. +
     
    +
    72. +
  72. +
                $repo->delete($instance); +
    +
    73. +
  73. +
            } +
    +
    74. +
  74. +
            $rs->close();  // Don't forget to close, just like usual! +
    +
    75. +
  75. +
            #### DEMO CODE ####
    +
    76. +
  76. +
     
    +
    77. +
  77. +
            return $this->output->heading('Demo of mr_model_record_abstract and mr_repository_abstract').
    +
    78. +
  78. +
    +                $this->helper->highlight(__CLASS__, __FUNCTION__, true).
    +
    79. +
  79. +
    +                $this->output->box($output, 'generalbox boxaligncenter boxwidthnormal');
    +
    80. +
  80. +
        }
    +
    81. +
  81. +
    }
    +
    82. +
+
+

- Documentation generated on Thu, 28 Jun 2012 16:33:51 -0700 by phpDocumentor 1.4.3 + Documentation generated on Thu, 28 Jun 2012 16:33:51 -0700 by phpDocumentor 1.4.3

- + + \ No newline at end of file diff --git a/docs/__examplesource/exsource_oule2-maint_blocks_helloworld_controller_table.php_69f093d72103b85451a8ad3f71467993.html b/docs/__examplesource/exsource_oule2-maint_blocks_helloworld_controller_table.php_69f093d72103b85451a8ad3f71467993.html index 55c40014..7bc3edbd 100644 --- a/docs/__examplesource/exsource_oule2-maint_blocks_helloworld_controller_table.php_69f093d72103b85451a8ad3f71467993.html +++ b/docs/__examplesource/exsource_oule2-maint_blocks_helloworld_controller_table.php_69f093d72103b85451a8ad3f71467993.html @@ -1,92 +1,456 @@ - - - - - See how to use this class - - - -

See how to use this class

-
-
  1. <?php
    2. -
  2. /**
    3. -
  3.  * Table controller
    4. -
  4.  *
    5. -
  5.  * @author Mark Nielsen
    6. -
  6.  * @version $Id$
    7. -
  7.  * @package blocks/helloworld
    8. -
  8.  */
    9. -
  9.  
    10. -
  10. defined('MOODLE_INTERNAL') or die('Direct access to this script is forbidden.');
    11. -
  11.  
    12. -
  12. class block_helloworld_controller_table extends mr_controller_block {
    13. -
  13.     /**
    14. -
  14.      * Default screen
    15. -
  15.      *
    16. -
  16.      * Demo of mr_html_table, mr_html_paging, mr_file_export and mr_preferences
    17. -
  17.      */
    18. -
  18.     public function view_action() {
    19. -
  19.         global $DB, $COURSE;
    20. -
  20.  
    21. -
  21.         #### DEMO CODE ####
    22. -
  22.         // Table stores sorting info in mr_preferences
    23. -
  23.         // Paging store perpage info in mr_preferences
    24. -
  24.         $preferences = new mr_preferences($COURSE->id, 'blocks/helloworld');
    25. -
  25.  
    26. -
  26.         // Setup the paging bar
    27. -
  27.         $paging = new mr_html_paging($preferences, $this->url);
    28. -
  28.         $paging->set_total($DB->count_records('user'));
    29. -
  29.         $paging->set_perpageopts(array('all', 1, 5, 50, 100));
    30. -
  30.  
    31. -
  31.         // Setup a new table
    32. -
  32.         $table = new mr_html_table($preferences, $this->url, 'username');
    33. -
  33.  
    34. -
  34.         // Add columns and column formatting
    35. -
  35.         $table->add_column('username', get_string('username'))
    36. -
  36.               ->add_column('firstname', get_string('firstname'))
    37. -
  37.               ->add_column('lastname', get_string('lastname'))
    38. -
  38.               ->add_column('email', get_string('email'))
    39. -
  39.               ->add_column('lastaccess', get_string('lastaccess'))
    40. -
  40.               ->add_format('lastaccess', 'date')
    41. -
  41.               ->add_format(array('username', 'firstname', 'lastname', 'email'), 'string');
    42. -
  42.  
    43. -
  43.         // Export handler - autodetects if we are exporting
    44. -
  44.         $export = new mr_file_export('**', false, $this->url);
    45. -
  45.  
    46. -
  46.         // When exporting, sets the limitfrom and limitnum appropriately
    47. -
  47.         $paging->set_export($export);
    48. -
  48.  
    49. -
  49.         // When exporting, send column headers to the export
    50. -
  50.         // And then route all rows to the export as well
    51. -
  51.         $table->set_export($export);
    52. -
  52.  
    53. -
  53.         // Fetch rows to add to the table
    54. -
  54.         $rows = $DB->get_records('user', NULL, $table->get_sql_sort(), $table->get_sql_select(),
    55. -
  55.                                  $paging->get_limitfrom(), $paging->get_limitnum());
    56. -
  56.  
    57. -
  57.         foreach ($rows as $row) {
    58. -
  58.             $table->add_row($row);
    59. -
  59.         }
    60. -
  60.         // If exporting, sends file, if not, does nothing
    61. -
  61.         $export->send();
    62. -
  62.  
    63. -
  63.         // Render the result
    64. -
  64.         $output  = $this->mroutput->render($paging);
    65. -
  65.         $output .= $this->mroutput->render($table);
    66. -
  66.         $output .= $this->mroutput->render($paging);
    67. -
  67.         $output .= $this->mroutput->render($export);
    68. -
  68.         #### DEMO CODE ####
    69. -
  69.  
    70. -
  70.         return $this->output->heading('Demo of mr_table_*').
    71. -
  71.                $this->helper->highlight(__CLASS__, __FUNCTION__, true).
    72. -
  72.                $this->output->box($output, 'generalbox boxaligncenter boxwidthnormal');
    73. -
  73.     }
    74. -
  74. }
    75. -
-
+ + + + + + See how to use this class + + + + +

See how to use this class

+
+
+
    +
  1. +
    <?php
    +
    2. +
  2. +
    /**
    +
    3. +
  3. +
     * Table controller
    +
    4. +
  4. +
     *
    +
    5. +
  5. +
     * @author Mark Nielsen +
    +
    6. +
  6. +
     * @version $Id$
    +
    7. +
  7. +
     * @package blocks/helloworld +
    +
    8. +
  8. +
     */
    +
    9. +
  9. +
     
    +
    10. +
  10. +
    defined('MOODLE_INTERNAL') or die('Direct access to this script is forbidden.');
    +
    11. +
  11. +
     
    +
    12. +
  12. +
    class block_helloworld_controller_table extends mr_controller_block {
    +
    13. +
  13. +
        /**
    +
    14. +
  14. +
         * Default screen
    +
    15. +
  15. +
         *
    +
    16. +
  16. +
         * Demo of mr_html_table,  + mr_html_paging, mr_file_export and mr_preferences +
    +
    17. +
  17. +
         */
    +
    18. +
  18. +
        public function view_action() { +
    +
    19. +
  19. +
            global $DB, $COURSE;
    +
    20. +
  20. +
     
    +
    21. +
  21. +
            #### DEMO CODE ####
    +
    22. +
  22. +
            // Table stores sorting info in mr_preferences +
    +
    23. +
  23. +
            // Paging store perpage info in mr_preferences +
    +
    24. +
  24. +
            $preferences = new mr_preferences($COURSE->id, 'blocks/helloworld');
    +
    25. +
  25. +
     
    +
    26. +
  26. +
            // Setup the paging bar
    +
    27. +
  27. +
            $paging = new mr_html_paging($preferences, $this->url);
    +
    28. +
  28. +
            $paging->set_total($DB->count_records('user')); +
    +
    29. +
  29. +
            $paging->set_perpageopts(array('all', 1, 5, 50, 100)); +
    +
    30. +
  30. +
     
    +
    31. +
  31. +
            // Setup a new table
    +
    32. +
  32. +
            $table = new mr_html_table($preferences, $this->url, 'username');
    +
    33. +
  33. +
     
    +
    34. +
  34. +
            // Add columns and column formatting
    +
    35. +
  35. +
            $table->add_column('username', get_string('username'))
    +
    36. +
  36. +
    +               ->add_column('firstname', get_string('firstname'))
    +
    37. +
  37. +
    +               ->add_column('lastname', get_string('lastname'))
    +
    38. +
  38. +
    +               ->add_column('email', get_string('email')) +
    +
    39. +
  39. +
    +               ->add_column('lastaccess', get_string('lastaccess'))
    +
    40. +
  40. +
    +               ->add_format('lastaccess', 'date')
    +
    41. +
  41. +
    +               ->add_format(array('username', 'firstname', 'lastname', 'email'), 'string'); +
    +
    42. +
  42. +
     
    +
    43. +
  43. +
            // Export handler - autodetects if we are exporting +
    +
    44. +
  44. +
            $export = new mr_file_export('**', false, $this->url);
    +
    45. +
  45. +
     
    +
    46. +
  46. +
            // When exporting, sets the limitfrom  + and limitnum appropriately +
    +
    47. +
  47. +
            $paging->set_export($export); +
    +
    48. +
  48. +
     
    +
    49. +
  49. +
            // When exporting, send column headers to the export +
    +
    50. +
  50. +
            // And then route all rows to the export as well +
    +
    51. +
  51. +
            $table->set_export($export); +
    +
    52. +
  52. +
     
    +
    53. +
  53. +
            // Fetch rows to add to the table +
    +
    54. +
  54. +
            $rows = $DB->get_records('user', NULL, $table->get_sql_sort(), $table->get_sql_select(),
    +
    55. +
  55. +
    +                   +                 $paging->get_limitfrom(), $paging->get_limitnum());
    +
    56. +
  56. +
     
    +
    57. +
  57. +
            foreach ($rows as $row) {
    +
    58. +
  58. +
                $table->add_row($row); +
    +
    59. +
  59. +
            } +
    +
    60. +
  60. +
            // If exporting, sends file, if not, does nothing +
    +
    61. +
  61. +
            $export->send();
    +
    62. +
  62. +
     
    +
    63. +
  63. +
            // Render the result
    +
    64. +
  64. +
            $output  = $this->mroutput->render($paging);
    +
    65. +
  65. +
            $output .= $this->mroutput->render($table);
    +
    66. +
  66. +
            $output .= $this->mroutput->render($paging);
    +
    67. +
  67. +
            $output .= $this->mroutput->render($export);
    +
    68. +
  68. +
            #### DEMO CODE ####
    +
    69. +
  69. +
     
    +
    70. +
  70. +
            return $this->output->heading('Demo of mr_table_*').
    +
    71. +
  71. +
    +                $this->helper->highlight(__CLASS__, __FUNCTION__, true).
    +
    72. +
  72. +
    +                $this->output->box($output, 'generalbox boxaligncenter boxwidthnormal');
    +
    73. +
  73. +
        }
    +
    74. +
  74. +
    }
    +
    75. +
+
+

- Documentation generated on Thu, 28 Jun 2012 16:33:52 -0700 by phpDocumentor 1.4.3 + Documentation generated on Thu, 28 Jun 2012 16:33:52 -0700 by phpDocumentor 1.4.3

- + + \ No newline at end of file diff --git a/docs/__examplesource/exsource_oule2-maint_blocks_helloworld_plugin_one_class.php_9809169f01018eeb3cf9d2f74794d0d5.html b/docs/__examplesource/exsource_oule2-maint_blocks_helloworld_plugin_one_class.php_9809169f01018eeb3cf9d2f74794d0d5.html index 7b4b8282..273237be 100644 --- a/docs/__examplesource/exsource_oule2-maint_blocks_helloworld_plugin_one_class.php_9809169f01018eeb3cf9d2f74794d0d5.html +++ b/docs/__examplesource/exsource_oule2-maint_blocks_helloworld_plugin_one_class.php_9809169f01018eeb3cf9d2f74794d0d5.html @@ -1,34 +1,95 @@ - - - - - Plugin class, extending base plugin class - - - -

Plugin class, extending base plugin class

-
-
  1. <?php
    2. -
  2. /**
    3. -
  3.  * Plugin: One
    4. -
  4.  *
    5. -
  5.  * @author Mark Nielsen
    6. -
  6.  */
    7. -
  7.  
    8. -
  8. defined('MOODLE_INTERNAL') or die('Direct access to this script is forbidden.');
    9. -
  9.  
    10. -
  10. require_once($CFG->dirroot.'/blocks/helloworld/plugin/base/class.php');
    11. -
  11.  
    12. -
  12. class block_helloworld_plugin_one_class extends block_helloworld_plugin_base_class {
    13. -
  13.     public function abstract_method() {
    14. -
  14.         return 'block_helloworld_plugin_one_class';
    15. -
  15.     }
    16. -
  16. }
    17. -
-
+ + + + + + Plugin class, extending base plugin class + + + + +

Plugin class, extending base plugin class

+
+
+
    +
  1. +
    <?php
    +
    2. +
  2. +
    /**
    +
    3. +
  3. +
     * Plugin: One
    +
    4. +
  4. +
     *
    +
    5. +
  5. +
     * @author Mark Nielsen +
    +
    6. +
  6. +
     */
    +
    7. +
  7. +
     
    +
    8. +
  8. +
    defined('MOODLE_INTERNAL') or die('Direct access to this script is forbidden.');
    +
    9. +
  9. +
     
    +
    10. +
  10. +
    require_once($CFG->dirroot.'/blocks/helloworld/plugin/base/class.php');
    +
    11. +
  11. +
     
    +
    12. +
  12. +
    class block_helloworld_plugin_one_class extends block_helloworld_plugin_base_class { +
    +
    13. +
  13. +
        public function abstract_method() { +
    +
    14. +
  14. +
            return 'block_helloworld_plugin_one_class'; +
    +
    15. +
  15. +
        }
    +
    16. +
  16. +
    }
    +
    17. +
+
+

- Documentation generated on Thu, 28 Jun 2012 16:33:50 -0700 by phpDocumentor 1.4.3 + Documentation generated on Thu, 28 Jun 2012 16:33:50 -0700 by phpDocumentor 1.4.3

- + + \ No newline at end of file diff --git a/docs/__examplesource/exsource_s_joule2-maint_blocks_helloworld_controller_db.php_b26ad4e1eaa1277b115e31683118039b.html b/docs/__examplesource/exsource_s_joule2-maint_blocks_helloworld_controller_db.php_b26ad4e1eaa1277b115e31683118039b.html index ba929713..000afd59 100644 --- a/docs/__examplesource/exsource_s_joule2-maint_blocks_helloworld_controller_db.php_b26ad4e1eaa1277b115e31683118039b.html +++ b/docs/__examplesource/exsource_s_joule2-maint_blocks_helloworld_controller_db.php_b26ad4e1eaa1277b115e31683118039b.html @@ -1,210 +1,1072 @@ - - - - - See this class in action - - - -

See this class in action

-
-
  1. <?php
    2. -
  2. /**
    3. -
  3.  * db controller
    4. -
  4.  *
    5. -
  5.  * @author Mark Nielsen
    6. -
  6.  * @version $Id$
    7. -
  7.  * @package blocks/helloworld
    8. -
  8.  */
    9. -
  9.  
    10. -
  10. defined('MOODLE_INTERNAL') or die('Direct access to this script is forbidden.');
    11. -
  11.  
    12. -
  12. class block_helloworld_controller_db extends mr_controller_block {
    13. -
  13.     /**
    14. -
  14.      * Default screen
    15. -
  15.      *
    16. -
  16.      * Demo of mr_db_table
    17. -
  17.      */
    18. -
  18.     public function view_action() {
    19. -
  19.         $this->print_header();
    20. -
  20.  
    21. -
  21.         echo $this->output->heading('Demo of mr_db_table');
    22. -
  22.         $this->helper->highlight(__CLASS__, __FUNCTION__);
    23. -
  23.         echo $this->output->box_start('generalbox boxaligncenter boxwidthnormal');
    24. -
  24.  
    25. -
  25.         #### DEMO CODE ####
    26. -
  26.         // Create a new instance for table 'block_helloworld'
    27. -
  27.         $table = new mr_db_table('block_helloworld');
    28. -
  28.  
    29. -
  29.         // Get table columns
    30. -
  30.         $result = $table->get_columns();
    31. -
  31.         $this->helper->dump($result, 'get_columns result');
    32. -
  32.  
    33. -
  33.         // Get detailed column information
    34. -
  34.         $result = $table->get_metacolumns();
    35. -
  35.         $this->helper->dump($result, 'get_metacolumns result');
    36. -
  36.  
    37. -
  37.         // Check for existing column
    38. -
  38.         $result = $table->column_exists('foo');
    39. -
  39.         $this->helper->dump($result, 'column_exists result');
    40. -
  40.  
    41. -
  41.         // Check non-existent column
    42. -
  42.         $result = $table->column_exists('baz');
    43. -
  43.         $this->helper->dump($result, 'column_exists result');
    44. -
  44.  
    45. -
  45.         // Generates a mr_db_record setup for this table
    46. -
  46.         $result = $table->record();
    47. -
  47.         $this->helper->dump($result, 'record result');
    48. -
  48.  
    49. -
  49.         // Form handling example:
    50. -
  50.         // } else if ($data = $mform->get_data()) {
    51. -
  51.         //     $table = new mr_db_table('tablename');
    52. -
  52.         //     $table->save($data);
    53. -
  53.         //     redirect(...);
    54. -
  54.         // }
    55. -
  55.  
    56. -
  56.         // $table has access to a lot of lib/dmllib.php methods
    57. -
  57.         // The following routes the call to $DB->get_records()
    58. -
  58.         $result = $table->get_records();
    59. -
  59.         $this->helper->dump($result, 'get_records result');
    60. -
  60.         #### DEMO CODE ####
    61. -
  61.  
    62. -
  62.         echo $this->output->box_end();
    63. -
  63.         $this->print_footer();
    64. -
  64.     }
    65. -
  65.  
    66. -
  66.     /**
    67. -
  67.      * Demo of mr_db_record
    68. -
  68.      */
    69. -
  69.     public function record_action() {
    70. -
  70.         global $DB;
    71. -
  71.  
    72. -
  72.         $this->print_header();
    73. -
  73.  
    74. -
  74.         echo $this->output->heading('Demo of mr_db_record');
    75. -
  75.         $this->helper->highlight(__CLASS__, __FUNCTION__);
    76. -
  76.         echo $this->output->box_start('generalbox boxaligncenter boxwidthnormal');
    77. -
  77.  
    78. -
  78.         #### DEMO CODE ####
    79. -
  79.         // Create a new record
    80. -
  80.         $record = new mr_db_record('block_helloworld');
    81. -
  81.  
    82. -
  82.         echo $this->output->heading('Insert demo');
    83. -
  83.  
    84. -
  84.         // Example: direct access
    85. -
  85.         $record = new mr_db_record('block_helloworld');
    86. -
  86.         $record->name = "It's";
    87. -
  87.         $record->foo  = 'a';
    88. -
  88.         $record->bar  = 'boy';
    89. -
  89.         $this->helper->dump($record, 'It\'s a boy result');  // Data is set
    90. -
  90.  
    91. -
  91.         // Example: Use set() and save()
    92. -
  92.         $record = new mr_db_record('block_helloworld');
    93. -
  93.         $data = array(
    94. -
  94.             'name' => "It's",
    95. -
  95.             'foo'  => 'a',
    96. -
  96.             'bar'  => 'boy',
    97. -
  97.             'ding' => 'pow', // This will be ignored by set() because it's an nonexistent field
    98. -
  98.         );
    99. -
  99.         $record->set($data)->save();
    100. -
  100.         $this->helper->dump($record, 'saved record result');  // id will be set
    101. -
  101.  
    102. -
  102.         // You can iterate a record! Woaaaaah!
    103. -
  103.         echo $this->output->heading('Iteration demo');
    104. -
  104.         foreach ($record as $key => $value) {
    105. -
  105.             print_object("$key = $value");
    106. -
  106.         }
    107. -
  107.  
    108. -
  108.         // You can count!
    109. -
  109.         echo $this->output->heading('Count demo');
    110. -
  110.         $this->helper->dump(count($record), 'count result');
    111. -
  111.  
    112. -
  112.         // You can access it like an array!
    113. -
  113.         echo $this->output->heading('Array access demo');
    114. -
  114.         $this->helper->dump($record['name'], 'array access result');
    115. -
  115.  
    116. -
  116.         // Example: working with an existing record
    117. -
  117.         $default = $DB->get_record('block_helloworld', array('id' => $record->id));
    118. -
  118.         $record  = new mr_db_record('block_helloworld', $default);
    119. -
  119.         // Do something to change the record otherwise save() will not do anything (which is good!)
    120. -
  120.         $record->name = 'Dingo';
    121. -
  121.         $record->save();
    122. -
  122.  
    123. -
  123.         $result = $DB->get_record('block_helloworld', array('id' => $record->id));
    124. -
  124.         $this->helper->dump($result, 'save result name = \'Dingo\'');
    125. -
  125.  
    126. -
  126.         // Example: delete a record
    127. -
  127.         $default = $DB->get_record('block_helloworld', array('id' => $record->id));
    128. -
  128.         $record  = new mr_db_record('block_helloworld', $default);
    129. -
  129.         $oldid   = $record->id;
    130. -
  130.         // Something happens and now you have to delete...
    131. -
  131.         $record->delete();
    132. -
  132.  
    133. -
  133.         // Let's see what's in the record now (should be empty)
    134. -
  134.         $this->helper->dump($record, 'how record looks after delete()');
    135. -
  135.  
    136. -
  136.         // See if the record really was deleted
    137. -
  137.         $result = $DB->get_record('block_helloworld', array('id' => $oldid));
    138. -
  138.         $this->helper->dump($result, 'record no longer exists');
    139. -
  139.         #### DEMO CODE ####
    140. -
  140.  
    141. -
  141.         echo $this->output->box_end();
    142. -
  142.         $this->print_footer();
    143. -
  143.     }
    144. -
  144.  
    145. -
  145.     /**
    146. -
  146.      * Demo of mr_db_queue
    147. -
  147.      */
    148. -
  148.     public function queue_action() {
    149. -
  149.         global $DB;
    150. -
  150.  
    151. -
  151.         $this->print_header();
    152. -
  152.  
    153. -
  153.         echo $this->output->heading('Demo of mr_db_queue');
    154. -
  154.         $this->helper->highlight(__CLASS__, __FUNCTION__);
    155. -
  155.         echo $this->output->box_start('generalbox boxaligncenter boxwidthnormal');
    156. -
  156.  
    157. -
  157.         #### DEMO CODE ####
    158. -
  158.         // Setup a new queue
    159. -
  159.         $queue = new mr_db_queue();
    160. -
  160.  
    161. -
  161.         // Load up the queue with inserts and deletes
    162. -
  162.         for ($i = 0; $i < 5; $i++) {
    163. -
  163.             $record = new mr_db_record('block_helloworld');
    164. -
  164.             $data = array(
    165. -
  165.                 'name' => "It's",  // DO NOT SLASH IT!
    166. -
  166.                 'foo'  => 'a',
    167. -
  167.                 'bar'  => 'boy',
    168. -
  168.             );
    169. -
  169.             $record->set($data);
    170. -
  170.             $queue->add($record); // Could also add an array of records!
    171. -
  171.         }
    172. -
  172.         if ($records = $DB->get_records('block_helloworld')) {
    173. -
  173.             foreach ($records as $record) {
    174. -
  174.                 $record = new mr_db_record('block_helloworld', $record);
    175. -
  175.                 $record->queue_delete();
    176. -
  176.                 $queue->add($record);
    177. -
  177.             }
    178. -
  178.         }
    179. -
  179.         // Show whats in the queue
    180. -
  180.         $this->helper->dump($queue, 'The loaded queue');
    181. -
  181.  
    182. -
  182.         // Flush the queue, should do everything in 2 transactions
    183. -
  183.         $queue->flush();
    184. -
  184.  
    185. -
  185.         // Show whats in the queue after flush
    186. -
  186.         $this->helper->dump($queue, 'The flushed queue');
    187. -
  187.         #### DEMO CODE ####
    188. -
  188.  
    189. -
  189.         echo $this->output->box_end();
    190. -
  190.         $this->print_footer();
    191. -
  191.     }
    192. -
  192. }
    193. -
-
+ + + + + + See this class in action + + + + +

See this class in action

+
+
+
    +
  1. +
    <?php
    +
    2. +
  2. +
    /**
    +
    3. +
  3. +
     * db controller
    +
    4. +
  4. +
     *
    +
    5. +
  5. +
     * @author Mark Nielsen +
    +
    6. +
  6. +
     * @version $Id$
    +
    7. +
  7. +
     * @package blocks/helloworld +
    +
    8. +
  8. +
     */
    +
    9. +
  9. +
     
    +
    10. +
  10. +
    defined('MOODLE_INTERNAL') or die('Direct access to this script is forbidden.');
    +
    11. +
  11. +
     
    +
    12. +
  12. +
    class block_helloworld_controller_db extends mr_controller_block {
    +
    13. +
  13. +
        /**
    +
    14. +
  14. +
         * Default screen
    +
    15. +
  15. +
         *
    +
    16. +
  16. +
         * Demo of mr_db_table +
    +
    17. +
  17. +
         */
    +
    18. +
  18. +
        public function view_action() { +
    +
    19. +
  19. +
            $this->print_header();
    +
    20. +
  20. +
     
    +
    21. +
  21. +
            echo $this->output->heading('Demo of mr_db_table');
    +
    22. +
  22. +
            $this->helper->highlight(__CLASS__, __FUNCTION__);
    +
    23. +
  23. +
            echo $this->output->box_start('generalbox boxaligncenter boxwidthnormal');
    +
    24. +
  24. +
     
    +
    25. +
  25. +
            #### DEMO CODE ####
    +
    26. +
  26. +
            // Create a new instance for table 'block_helloworld' +
    +
    27. +
  27. +
            $table = new mr_db_table('block_helloworld');
    +
    28. +
  28. +
     
    +
    29. +
  29. +
            // Get table columns
    +
    30. +
  30. +
            $result = $table->get_columns();
    +
    31. +
  31. +
            $this->helper->dump($result, 'get_columns result');
    +
    32. +
  32. +
     
    +
    33. +
  33. +
            // Get detailed column information
    +
    34. +
  34. +
            $result = $table->get_metacolumns();
    +
    35. +
  35. +
            $this->helper->dump($result, 'get_metacolumns result');
    +
    36. +
  36. +
     
    +
    37. +
  37. +
            // Check for existing column
    +
    38. +
  38. +
            $result = $table->column_exists('foo');
    +
    39. +
  39. +
            $this->helper->dump($result, 'column_exists result');
    +
    40. +
  40. +
     
    +
    41. +
  41. +
            // Check non-existent column
    +
    42. +
  42. +
            $result = $table->column_exists('baz');
    +
    43. +
  43. +
            $this->helper->dump($result, 'column_exists result');
    +
    44. +
  44. +
     
    +
    45. +
  45. +
            // Generates a mr_db_record setup for this table +
    +
    46. +
  46. +
            $result = $table->record();
    +
    47. +
  47. +
            $this->helper->dump($result, 'record result');
    +
    48. +
  48. +
     
    +
    49. +
  49. +
            // Form handling example:
    +
    50. +
  50. +
            // } else if ($data = $mform->get_data()) { +
    +
    51. +
  51. +
            //     $table = new mr_db_table('tablename'); +
    +
    52. +
  52. +
            //     $table->save($data);
    +
    53. +
  53. +
            //     redirect(...);
    +
    54. +
  54. +
            // }
    +
    55. +
  55. +
     
    +
    56. +
  56. +
            // $table has access to a lot of lib/dmllib.php methods +
    +
    57. +
  57. +
            // The following routes the call to $DB->get_records() +
    +
    58. +
  58. +
            $result = $table->get_records();
    +
    59. +
  59. +
            $this->helper->dump($result, 'get_records result');
    +
    60. +
  60. +
            #### DEMO CODE ####
    +
    61. +
  61. +
     
    +
    62. +
  62. +
            echo $this->output->box_end();
    +
    63. +
  63. +
            $this->print_footer();
    +
    64. +
  64. +
        }
    +
    65. +
  65. +
     
    +
    66. +
  66. +
        /**
    +
    67. +
  67. +
         * Demo of mr_db_record +
    +
    68. +
  68. +
         */
    +
    69. +
  69. +
        public function record_action() { +
    +
    70. +
  70. +
            global $DB;
    +
    71. +
  71. +
     
    +
    72. +
  72. +
            $this->print_header();
    +
    73. +
  73. +
     
    +
    74. +
  74. +
            echo $this->output->heading('Demo of mr_db_record');
    +
    75. +
  75. +
            $this->helper->highlight(__CLASS__, __FUNCTION__);
    +
    76. +
  76. +
            echo $this->output->box_start('generalbox boxaligncenter boxwidthnormal');
    +
    77. +
  77. +
     
    +
    78. +
  78. +
            #### DEMO CODE ####
    +
    79. +
  79. +
            // Create a new record
    +
    80. +
  80. +
            $record = new mr_db_record('block_helloworld');
    +
    81. +
  81. +
     
    +
    82. +
  82. +
            echo $this->output->heading('Insert demo');
    +
    83. +
  83. +
     
    +
    84. +
  84. +
            // Example: direct access
    +
    85. +
  85. +
            $record = new mr_db_record('block_helloworld');
    +
    86. +
  86. +
            $record->name = "It's";
    +
    87. +
  87. +
            $record->foo  = 'a';
    +
    88. +
  88. +
            $record->bar  = 'boy';
    +
    89. +
  89. +
            $this->helper->dump($record, 'It\'s a boy result');  // Data is set
    +
    90. +
  90. +
     
    +
    91. +
  91. +
            // Example: Use set() and save()
    +
    92. +
  92. +
            $record = new mr_db_record('block_helloworld');
    +
    93. +
  93. +
            $data = array(
    +
    94. +
  94. +
                'name' => "It's",
    +
    95. +
  95. +
                'foo'  => 'a',
    +
    96. +
  96. +
                'bar'  => 'boy',
    +
    97. +
  97. +
                'ding' => 'pow', // This will be ignored by set() because  + it's an nonexistent field +
    +
    98. +
  98. +
            );
    +
    99. +
  99. +
            $record->set($data)->save();
    +
    100. +
  100. +
            $this->helper->dump($record, 'saved record result');  // id will be set
    +
    101. +
  101. +
     
    +
    102. +
  102. +
            // You can iterate a record! Woaaaaah! +
    +
    103. +
  103. +
            echo $this->output->heading('Iteration demo');
    +
    104. +
  104. +
            foreach ($record as $key => $value) {
    +
    105. +
  105. +
                print_object("$key = $value"); +
    +
    106. +
  106. +
            } +
    +
    107. +
  107. +
     
    +
    108. +
  108. +
            // You can count!
    +
    109. +
  109. +
            echo $this->output->heading('Count demo');
    +
    110. +
  110. +
            $this->helper->dump(count($record), 'count result');
    +
    111. +
  111. +
     
    +
    112. +
  112. +
            // You can access it like an array! +
    +
    113. +
  113. +
            echo $this->output->heading('Array access demo');
    +
    114. +
  114. +
            $this->helper->dump($record['name'], 'array access result');
    +
    115. +
  115. +
     
    +
    116. +
  116. +
            // Example: working with an existing record +
    +
    117. +
  117. +
            $default = $DB->get_record('block_helloworld', array('id' => $record->id));
    +
    118. +
  118. +
            $record  = new mr_db_record('block_helloworld', $default);
    +
    119. +
  119. +
            // Do something to change the record otherwise  + save() will not do anything (which is good!) +
    +
    120. +
  120. +
            $record->name = 'Dingo';
    +
    121. +
  121. +
            $record->save();
    +
    122. +
  122. +
     
    +
    123. +
  123. +
            $result = $DB->get_record('block_helloworld', array('id' => $record->id));
    +
    124. +
  124. +
            $this->helper->dump($result, 'save result name = \'Dingo\'');
    +
    125. +
  125. +
     
    +
    126. +
  126. +
            // Example: delete a record
    +
    127. +
  127. +
            $default = $DB->get_record('block_helloworld', array('id' => $record->id));
    +
    128. +
  128. +
            $record  = new mr_db_record('block_helloworld', $default);
    +
    129. +
  129. +
            $oldid   = $record->id;
    +
    130. +
  130. +
            // Something happens and now you have to delete... +
    +
    131. +
  131. +
            $record->delete();
    +
    132. +
  132. +
     
    +
    133. +
  133. +
            // Let's see what's in the  + record now (should be empty) +
    +
    134. +
  134. +
            $this->helper->dump($record, 'how record looks after delete()');
    +
    135. +
  135. +
     
    +
    136. +
  136. +
            // See if the record really was deleted +
    +
    137. +
  137. +
            $result = $DB->get_record('block_helloworld', array('id' => $oldid)); +
    +
    138. +
  138. +
            $this->helper->dump($result, 'record no longer exists');
    +
    139. +
  139. +
            #### DEMO CODE ####
    +
    140. +
  140. +
     
    +
    141. +
  141. +
            echo $this->output->box_end();
    +
    142. +
  142. +
            $this->print_footer();
    +
    143. +
  143. +
        }
    +
    144. +
  144. +
     
    +
    145. +
  145. +
        /**
    +
    146. +
  146. +
         * Demo of mr_db_queue +
    +
    147. +
  147. +
         */
    +
    148. +
  148. +
        public function queue_action() { +
    +
    149. +
  149. +
            global $DB;
    +
    150. +
  150. +
     
    +
    151. +
  151. +
            $this->print_header();
    +
    152. +
  152. +
     
    +
    153. +
  153. +
            echo $this->output->heading('Demo of mr_db_queue');
    +
    154. +
  154. +
            $this->helper->highlight(__CLASS__, __FUNCTION__);
    +
    155. +
  155. +
            echo $this->output->box_start('generalbox boxaligncenter boxwidthnormal');
    +
    156. +
  156. +
     
    +
    157. +
  157. +
            #### DEMO CODE ####
    +
    158. +
  158. +
            // Setup a new queue
    +
    159. +
  159. +
            $queue = new mr_db_queue();
    +
    160. +
  160. +
     
    +
    161. +
  161. +
            // Load up the queue with inserts and deletes +
    +
    162. +
  162. +
            for ($i = 0; $i < 5; $i++) {
    +
    163. +
  163. +
                $record = new mr_db_record('block_helloworld');
    +
    164. +
  164. +
                $data = array(
    +
    165. +
  165. +
    +                 'name' => "It's",  // DO NOT SLASH IT!
    +
    166. +
  166. +
    +                 'foo'  => 'a',
    +
    167. +
  167. +
    +                 'bar'  => 'boy',
    +
    168. +
  168. +
                );
    +
    169. +
  169. +
                $record->set($data); +
    +
    170. +
  170. +
                $queue->add($record); // Could also add an array of records! +
    +
    171. +
  171. +
            } +
    +
    172. +
  172. +
            if ($records = $DB->get_records('block_helloworld')) {
    +
    173. +
  173. +
                foreach ($records as $record) {
    +
    174. +
  174. +
    +                 $record = new mr_db_record('block_helloworld', $record);
    +
    175. +
  175. +
    +                 $record->queue_delete();
    +
    176. +
  176. +
    +                 $queue->add($record); +
    +
    177. +
  177. +
                }
    +
    178. +
  178. +
            } +
    +
    179. +
  179. +
            // Show whats in the queue
    +
    180. +
  180. +
            $this->helper->dump($queue, 'The loaded queue');
    +
    181. +
  181. +
     
    +
    182. +
  182. +
            // Flush the queue, should do everything  + in 2 transactions +
    +
    183. +
  183. +
            $queue->flush();
    +
    184. +
  184. +
     
    +
    185. +
  185. +
            // Show whats in the queue after flush +
    +
    186. +
  186. +
            $this->helper->dump($queue, 'The flushed queue');
    +
    187. +
  187. +
            #### DEMO CODE ####
    +
    188. +
  188. +
     
    +
    189. +
  189. +
            echo $this->output->box_end();
    +
    190. +
  190. +
            $this->print_footer();
    +
    191. +
  191. +
        }
    +
    192. +
  192. +
    }
    +
    193. +
+
+

- Documentation generated on Thu, 28 Jun 2012 16:33:51 -0700 by phpDocumentor 1.4.3 + Documentation generated on Thu, 28 Jun 2012 16:33:51 -0700 by phpDocumentor 1.4.3

- + + \ No newline at end of file diff --git a/docs/__examplesource/exsource_tes_joule2-maint_blocks_helloworld_webservices.php_c1a862a8922f2c4590de2cdacca66e16.html b/docs/__examplesource/exsource_tes_joule2-maint_blocks_helloworld_webservices.php_c1a862a8922f2c4590de2cdacca66e16.html index e7c6e3b1..37544dc4 100644 --- a/docs/__examplesource/exsource_tes_joule2-maint_blocks_helloworld_webservices.php_c1a862a8922f2c4590de2cdacca66e16.html +++ b/docs/__examplesource/exsource_tes_joule2-maint_blocks_helloworld_webservices.php_c1a862a8922f2c4590de2cdacca66e16.html @@ -1,54 +1,216 @@ - - - - - Example server usage - - - -

Example server usage

-
-
  1. <?php
    2. -
  2. /**
    3. -
  3.  * Example Web Services
    4. -
  4.  *
    5. -
  5.  * Example structure for a more complex web service
    6. -
  6.  * that can support multiple endpoints and service types:
    7. -
  7.  *      /path/to/plugin/
    8. -
  8.  *                  webservices/
    9. -
  9.  *                      TYPE/                (EG: rest)
    10. -
  10.  *                          ENDPOINTNAME.php (EG: user.php)
    11. -
  11.  *                  model/
    12. -
  12.  *                      response/            (Store response classes here)
    13. -
  13.  *                      service/             (Store service classes here)
    14. -
  14.  *
    15. -
  15.  * @author Mark Nielsen
    16. -
  16.  * @package blocks/helloworld
    17. -
  17.  ***/
    18. -
  18.  
    19. -
  19. define('NO_DEBUG_DISPLAY', true);
    20. -
  20. define('NO_MOODLE_COOKIES', true);
    21. -
  21.  
    22. -
  22. require_once('../../config.php');
    23. -
  23. require($CFG->dirroot.'/local/mr/bootstrap.php');
    24. -
  24. require($CFG->dirroot.'/blocks/helloworld/lib/server/service.php');
    25. -
  25. require($CFG->dirroot.'/blocks/helloworld/lib/server/response.php');
    26. -
  26.  
    27. -
  27. // Server validation (Mix and match)
    28. -
  28. $validator = new Zend_Validate();
    29. -
  29. $validator->addValidator(new mr_server_validate_secure())
    30. -
  30.           ->addValidator(new mr_server_validate_method())
    31. -
  31.           ->addValidator(new mr_server_validate_ip('127.0.0.1'))
    32. -
  32.           ->addValidator(new mr_server_validate_token('tokenvalue'))
    33. -
  33.           ->addValidator(new mr_server_validate_login());
    34. -
  34.  
    35. -
  35. $server = new mr_server_rest('blocks_helloworld_lib_server_service', 'blocks_helloworld_lib_server_response', $validator);
    36. -
  36. $server->handle();
    37. -
-
+ + + + + + Example server usage + + + + +

Example server usage

+
+
+
    +
  1. +
    <?php
    +
    2. +
  2. +
    /**
    +
    3. +
  3. +
     * Example Web Services
    +
    4. +
  4. +
     *
    +
    5. +
  5. +
     * Example structure for a more complex web service +
    +
    6. +
  6. +
     * that can support multiple endpoints and service types: +
    +
    7. +
  7. +
     *      /path/to/plugin/
    +
    8. +
  8. +
     *              +      webservices/ +
    +
    9. +
  9. +
     *                  +      TYPE/                +  (EG: rest) +
    +
    10. +
  10. +
     *                  +          ENDPOINTNAME.php (EG: user.php) +
    +
    11. +
  11. +
     *                  +  model/ +
    +
    12. +
  12. +
     *                  +      response/             + (Store response classes here) +
    +
    13. +
  13. +
     *                  +      service/              + (Store service classes here) +
    +
    14. +
  14. +
     *
    +
    15. +
  15. +
     * @author Mark Nielsen +
    +
    16. +
  16. +
     * @package blocks/helloworld +
    +
    17. +
  17. +
     ***/
    +
    18. +
  18. +
     
    +
    19. +
  19. +
    define('NO_DEBUG_DISPLAY', true);
    +
    20. +
  20. +
    define('NO_MOODLE_COOKIES', true);
    +
    21. +
  21. +
     
    +
    22. +
  22. +
    require_once('../../config.php');
    +
    23. +
  23. +
    require($CFG->dirroot.'/local/mr/bootstrap.php');
    +
    24. +
  24. +
    require($CFG->dirroot.'/blocks/helloworld/lib/server/service.php');
    +
    25. +
  25. +
    require($CFG->dirroot.'/blocks/helloworld/lib/server/response.php');
    +
    26. +
  26. +
     
    +
    27. +
  27. +
    // Server validation (Mix and match)
    +
    28. +
  28. +
    $validator = new Zend_Validate();
    +
    29. +
  29. +
    $validator->addValidator(new mr_server_validate_secure())
    +
    30. +
  30. +
              ->addValidator(new mr_server_validate_method())
    +
    31. +
  31. +
              ->addValidator(new mr_server_validate_ip('127.0.0.1'))
    +
    32. +
  32. +
              ->addValidator(new mr_server_validate_token('tokenvalue'))
    +
    33. +
  33. +
              ->addValidator(new mr_server_validate_login());
    +
    34. +
  34. +
     
    +
    35. +
  35. +
    $server = new mr_server_rest('blocks_helloworld_lib_server_service', 'blocks_helloworld_lib_server_response', $validator);
    +
    36. +
  36. +
    $server->handle();
    +
    37. +
+
+

- Documentation generated on Thu, 28 Jun 2012 16:33:51 -0700 by phpDocumentor 1.4.3 + Documentation generated on Thu, 28 Jun 2012 16:33:51 -0700 by phpDocumentor 1.4.3

- + + \ No newline at end of file diff --git a/docs/__examplesource/exsource_ule2-maint_blocks_helloworld_controller_filter.php_a164674c6c86cad0df598a0c1a4c5e7d.html b/docs/__examplesource/exsource_ule2-maint_blocks_helloworld_controller_filter.php_a164674c6c86cad0df598a0c1a4c5e7d.html index 347b02ce..056956d8 100644 --- a/docs/__examplesource/exsource_ule2-maint_blocks_helloworld_controller_filter.php_a164674c6c86cad0df598a0c1a4c5e7d.html +++ b/docs/__examplesource/exsource_ule2-maint_blocks_helloworld_controller_filter.php_a164674c6c86cad0df598a0c1a4c5e7d.html @@ -1,71 +1,312 @@ - - - - - See how to use this class - - - -

See how to use this class

-
-
  1. <?php
    2. -
  2. /**
    3. -
  3.  * Filter controller
    4. -
  4.  *
    5. -
  5.  * @author Mark Nielsen
    6. -
  6.  * @version $Id$
    7. -
  7.  * @package blocks/helloworld
    8. -
  8.  */
    9. -
  9.  
    10. -
  10. defined('MOODLE_INTERNAL') or die('Direct access to this script is forbidden.');
    11. -
  11.  
    12. -
  12. class block_helloworld_controller_filter extends mr_controller_block {
    13. -
  13.     /**
    14. -
  14.      * Default screen
    15. -
  15.      *
    16. -
  16.      * Demo of mr_filter et al
    17. -
  17.      */
    18. -
  18.     public function view_action() {
    19. -
  19.         global $COURSE;
    20. -
  20.  
    21. -
  21.         #### DEMO CODE ####
    22. -
  22.         // Filter values are stored here
    23. -
  23.         $preferences = new mr_preferences($COURSE->id, 'blocks/helloworld');
    24. -
  24.  
    25. -
  25.         // Create the filter "manager"
    26. -
  26.         $filter = new mr_html_filter($preferences, $this->url);
    27. -
  27.  
    28. -
  28.         // Add a filter
    29. -
  29.         $filter->add(new mr_html_filter_text('foo', 'Foo'));
    30. -
  30.  
    31. -
  31.         // Add the same filter, shortcut way
    32. -
  32.         $filter->new_text('bar', 'Bar');
    33. -
  33.  
    34. -
  34.         // You can chain these too (with add() as well)
    35. -
  35.         $filter->new_select('baz', 'Baz', array('0' => 'No', '1' => 'Yes'))
    36. -
  36.                ->new_daterange('bat', 'Bat');
    37. -
  37.  
    38. -
  38.         // Render the filter: This should be done before the print_header() - may redirect
    39. -
  39.         $output = $this->mroutput->render($filter);
    40. -
  40.  
    41. -
  41.         // Generate SQL based on filter values
    42. -
  42.         $output .= $this->helper->dump($filter->sql(), 'Filter SQL', true);
    43. -
  43.  
    44. -
  44.         // Access filter values through preferences
    45. -
  45.         $output .= $this->helper->dump($preferences->get('foo', 'NOT SET'), 'Preference foo', true);
    46. -
  46.         $output .= $this->helper->dump($preferences->get('bar', 'NOT SET'), 'Preference bar', true);
    47. -
  47.         #### DEMO CODE ####
    48. -
  48.  
    49. -
  49.         return $this->output->heading('Demo of mr_filter_*').
    50. -
  50.                $this->helper->highlight(__CLASS__, __FUNCTION__, true).
    51. -
  51.                $this->output->box($output, 'generalbox boxaligncenter boxwidthnormal');
    52. -
  52.     }
    53. -
  53. }
    54. -
-
+ + + + + + See how to use this class + + + + +

See how to use this class

+
+
+
    +
  1. +
    <?php
    +
    2. +
  2. +
    /**
    +
    3. +
  3. +
     * Filter controller
    +
    4. +
  4. +
     *
    +
    5. +
  5. +
     * @author Mark Nielsen +
    +
    6. +
  6. +
     * @version $Id$
    +
    7. +
  7. +
     * @package blocks/helloworld +
    +
    8. +
  8. +
     */
    +
    9. +
  9. +
     
    +
    10. +
  10. +
    defined('MOODLE_INTERNAL') or die('Direct access to this script is forbidden.');
    +
    11. +
  11. +
     
    +
    12. +
  12. +
    class block_helloworld_controller_filter extends mr_controller_block {
    +
    13. +
  13. +
        /**
    +
    14. +
  14. +
         * Default screen
    +
    15. +
  15. +
         *
    +
    16. +
  16. +
         * Demo of mr_filter et al +
    +
    17. +
  17. +
         */
    +
    18. +
  18. +
        public function view_action() { +
    +
    19. +
  19. +
            global $COURSE;
    +
    20. +
  20. +
     
    +
    21. +
  21. +
            #### DEMO CODE ####
    +
    22. +
  22. +
            // Filter values are stored here
    +
    23. +
  23. +
            $preferences = new mr_preferences($COURSE->id, 'blocks/helloworld');
    +
    24. +
  24. +
     
    +
    25. +
  25. +
            // Create the filter "manager"
    +
    26. +
  26. +
            $filter = new mr_html_filter($preferences, $this->url);
    +
    27. +
  27. +
     
    +
    28. +
  28. +
            // Add a filter
    +
    29. +
  29. +
            $filter->add(new mr_html_filter_text('foo', 'Foo'));
    +
    30. +
  30. +
     
    +
    31. +
  31. +
            // Add the same filter, shortcut way +
    +
    32. +
  32. +
            $filter->new_text('bar', 'Bar'); +
    +
    33. +
  33. +
     
    +
    34. +
  34. +
            // You can chain these too (with add() as well) +
    +
    35. +
  35. +
            $filter->new_select('baz', 'Baz', array('0' => 'No', '1' => 'Yes'))
    +
    36. +
  36. +
    +                ->new_daterange('bat', 'Bat');
    +
    37. +
  37. +
     
    +
    38. +
  38. +
            // Render the filter: This should be done  + before the print_header() - may redirect +
    +
    39. +
  39. +
            $output = $this->mroutput->render($filter);
    +
    40. +
  40. +
     
    +
    41. +
  41. +
            // Generate SQL based on filter values +
    +
    42. +
  42. +
            $output .= $this->helper->dump($filter->sql(), 'Filter SQL', true);
    +
    43. +
  43. +
     
    +
    44. +
  44. +
            // Access filter values through preferences +
    +
    45. +
  45. +
            $output .= $this->helper->dump($preferences->get('foo', 'NOT SET'), 'Preference foo', true);
    +
    46. +
  46. +
            $output .= $this->helper->dump($preferences->get('bar', 'NOT SET'), 'Preference bar', true);
    +
    47. +
  47. +
            #### DEMO CODE ####
    +
    48. +
  48. +
     
    +
    49. +
  49. +
            return $this->output->heading('Demo of mr_filter_*').
    +
    50. +
  50. +
    +                $this->helper->highlight(__CLASS__, __FUNCTION__, true).
    +
    51. +
  51. +
    +                $this->output->box($output, 'generalbox boxaligncenter boxwidthnormal');
    +
    52. +
  52. +
        }
    +
    53. +
  53. +
    }
    +
    54. +
+
+

- Documentation generated on Thu, 28 Jun 2012 16:33:48 -0700 by phpDocumentor 1.4.3 + Documentation generated on Thu, 28 Jun 2012 16:33:48 -0700 by phpDocumentor 1.4.3

- + + \ No newline at end of file diff --git a/docs/__examplesource/exsource_ule2-maint_blocks_helloworld_controller_plugin.php_f389601b3e05a1419f1535326d57dad1.html b/docs/__examplesource/exsource_ule2-maint_blocks_helloworld_controller_plugin.php_f389601b3e05a1419f1535326d57dad1.html index 95a52e5e..7224853b 100644 --- a/docs/__examplesource/exsource_ule2-maint_blocks_helloworld_controller_plugin.php_f389601b3e05a1419f1535326d57dad1.html +++ b/docs/__examplesource/exsource_ule2-maint_blocks_helloworld_controller_plugin.php_f389601b3e05a1419f1535326d57dad1.html @@ -1,77 +1,341 @@ - - - - - example - - - -

example

-
-
  1. <?php
    2. -
  2. /**
    3. -
  3.  * Plugin controller
    4. -
  4.  *
    5. -
  5.  * @author Mark Nielsen
    6. -
  6.  * @version $Id$
    7. -
  7.  * @package blocks/helloworld
    8. -
  8.  */
    9. -
  9.  
    10. -
  10. defined('MOODLE_INTERNAL') or die('Direct access to this script is forbidden.');
    11. -
  11.  
    12. -
  12. class block_helloworld_controller_plugin extends mr_controller_block {
    13. -
  13.     /**
    14. -
  14.      * Default screen
    15. -
  15.      *
    16. -
  16.      * Demo of plugins
    17. -
  17.      */
    18. -
  18.     public function view_action() {
    19. -
  19.         $this->print_header();
    20. -
  20.  
    21. -
  21.         echo $this->output->heading('Demo of mr_plugin and mr_helper_load');
    22. -
  22.         $this->helper->highlight(__CLASS__, __FUNCTION__);
    23. -
  23.         echo $this->output->box_start('generalbox boxaligncenter boxwidthnormal');
    24. -
  24.  
    25. -
  25.         #### DEMO CODE ####
    26. -
  26.         // Load all top-level plugins
    27. -
  27.         $result = $this->helper->load->plugin();
    28. -
  28.         $this->helper->dump($result, 'load->plugin() result');
    29. -
  29.  
    30. -
  30.         // Load plugin 'one'
    31. -
  31.         $result = $this->helper->load->plugin('one');
    32. -
  32.         $this->helper->dump($result, 'load->plugin(\'one\') result');
    33. -
  33.  
    34. -
  34.         // Inside of blocks/helloworld/plugin/one are more plugins which
    35. -
  35.         // resemble the Multiple plugin type layout.
    36. -
  36.  
    37. -
  37.         // All sub-plugins of plugin one
    38. -
  38.         $result = $this->helper->load->plugin('one/*');
    39. -
  39.         $this->helper->dump($result, 'load->plugin(\'one/*\') result');
    40. -
  40.  
    41. -
  41.         // Load plugin 'one/aa'
    42. -
  42.         $result = $this->helper->load->plugin('one/aa');
    43. -
  43.         $this->helper->dump($result, 'load->plugin(\'one/aa\') result');
    44. -
  44.  
    45. -
  45.         echo $this->output->heading('Example call to plugin methods:');
    46. -
  46.  
    47. -
  47.         foreach ($this->helper->load->plugin() as $name => $plugin) {
    48. -
  48.             echo $this->output->heading("For plugin $name:");
    49. -
  49.             print_object('name(): '.$plugin->name());
    50. -
  50.             print_object('type(): '.$plugin->type());
    51. -
  51.             print_object('parent_method(): '.$plugin->parent_method());
    52. -
  52.             print_object('abstract_method(): '.$plugin->abstract_method());
    53. -
  53.         }
    54. -
  54.         #### DEMO CODE ####
    55. -
  55.  
    56. -
  56.         echo $this->output->box_end();
    57. -
  57.         $this->print_footer();
    58. -
  58.     }
    59. -
  59. }
    60. -
-
+ + + + + + example + + + + +

example

+
+
+
    +
  1. +
    <?php
    +
    2. +
  2. +
    /**
    +
    3. +
  3. +
     * Plugin controller
    +
    4. +
  4. +
     *
    +
    5. +
  5. +
     * @author Mark Nielsen +
    +
    6. +
  6. +
     * @version $Id$
    +
    7. +
  7. +
     * @package blocks/helloworld +
    +
    8. +
  8. +
     */
    +
    9. +
  9. +
     
    +
    10. +
  10. +
    defined('MOODLE_INTERNAL') or die('Direct access to this script is forbidden.');
    +
    11. +
  11. +
     
    +
    12. +
  12. +
    class block_helloworld_controller_plugin extends mr_controller_block {
    +
    13. +
  13. +
        /**
    +
    14. +
  14. +
         * Default screen
    +
    15. +
  15. +
         *
    +
    16. +
  16. +
         * Demo of plugins
    +
    17. +
  17. +
         */
    +
    18. +
  18. +
        public function view_action() { +
    +
    19. +
  19. +
            $this->print_header();
    +
    20. +
  20. +
     
    +
    21. +
  21. +
            echo $this->output->heading('Demo of mr_plugin and mr_helper_load');
    +
    22. +
  22. +
            $this->helper->highlight(__CLASS__, __FUNCTION__);
    +
    23. +
  23. +
            echo $this->output->box_start('generalbox boxaligncenter boxwidthnormal');
    +
    24. +
  24. +
     
    +
    25. +
  25. +
            #### DEMO CODE ####
    +
    26. +
  26. +
            // Load all top-level plugins
    +
    27. +
  27. +
            $result = $this->helper->load->plugin();
    +
    28. +
  28. +
            $this->helper->dump($result, 'load->plugin() result');
    +
    29. +
  29. +
     
    +
    30. +
  30. +
            // Load plugin 'one'
    +
    31. +
  31. +
            $result = $this->helper->load->plugin('one');
    +
    32. +
  32. +
            $this->helper->dump($result, 'load->plugin(\'one\') result');
    +
    33. +
  33. +
     
    +
    34. +
  34. +
            // Inside of blocks/helloworld/plugin/one are more plugins which +
    +
    35. +
  35. +
            // resemble the Multiple plugin type layout. +
    +
    36. +
  36. +
     
    +
    37. +
  37. +
            // All sub-plugins of plugin one
    +
    38. +
  38. +
            $result = $this->helper->load->plugin('one/*');
    +
    39. +
  39. +
            $this->helper->dump($result, 'load->plugin(\'one/*\') result');
    +
    40. +
  40. +
     
    +
    41. +
  41. +
            // Load plugin 'one/aa'
    +
    42. +
  42. +
            $result = $this->helper->load->plugin('one/aa');
    +
    43. +
  43. +
            $this->helper->dump($result, 'load->plugin(\'one/aa\') result');
    +
    44. +
  44. +
     
    +
    45. +
  45. +
            echo $this->output->heading('Example call to plugin methods:');
    +
    46. +
  46. +
     
    +
    47. +
  47. +
            foreach ($this->helper->load->plugin() as $name => $plugin) {
    +
    48. +
  48. +
    +             echo $this->output->heading("For plugin $name:");
    +
    49. +
  49. +
                print_object('name(): '.$plugin->name());
    +
    50. +
  50. +
                print_object('type(): '.$plugin->type());
    +
    51. +
  51. +
                print_object('parent_method(): '.$plugin->parent_method());
    +
    52. +
  52. +
                print_object('abstract_method(): '.$plugin->abstract_method());
    +
    53. +
  53. +
            } +
    +
    54. +
  54. +
            #### DEMO CODE ####
    +
    55. +
  55. +
     
    +
    56. +
  56. +
            echo $this->output->box_end();
    +
    57. +
  57. +
            $this->print_footer();
    +
    58. +
  58. +
        }
    +
    59. +
  59. +
    }
    +
    60. +
+
+

- Documentation generated on Thu, 28 Jun 2012 16:33:49 -0700 by phpDocumentor 1.4.3 + Documentation generated on Thu, 28 Jun 2012 16:33:49 -0700 by phpDocumentor 1.4.3

- + + \ No newline at end of file diff --git a/docs/__examplesource/exsource_ule2-maint_blocks_helloworld_controller_report.php_d3d1ad1ba515d5bb293bcdd3739c3ad0.html b/docs/__examplesource/exsource_ule2-maint_blocks_helloworld_controller_report.php_d3d1ad1ba515d5bb293bcdd3739c3ad0.html index d6a16f61..ce9339b0 100644 --- a/docs/__examplesource/exsource_ule2-maint_blocks_helloworld_controller_report.php_d3d1ad1ba515d5bb293bcdd3739c3ad0.html +++ b/docs/__examplesource/exsource_ule2-maint_blocks_helloworld_controller_report.php_d3d1ad1ba515d5bb293bcdd3739c3ad0.html @@ -1,68 +1,271 @@ - - - - - See how to render this class - - - -

See how to render this class

-
-
  1. <?php
    2. -
  2. /**
    3. -
  3.  * Report controller
    4. -
  4.  *
    5. -
  5.  * @author Mark Nielsen
    6. -
  6.  * @version $Id$
    7. -
  7.  * @package blocks/helloworld
    8. -
  8.  */
    9. -
  9.  
    10. -
  10. defined('MOODLE_INTERNAL') or die('Direct access to this script is forbidden.');
    11. -
  11.  
    12. -
  12. class block_helloworld_controller_report extends mr_controller_block {
    13. -
  13.     /**
    14. -
  14.      * Default screen
    15. -
  15.      */
    16. -
  16.     public function view_action() {
    17. -
  17.         global $CFG, $COURSE;
    18. -
  18.  
    19. -
  19.         #### DEMO CODE ####
    20. -
  20.         require_once($CFG->dirroot.'/blocks/helloworld/report/users.php');
    21. -
  21.  
    22. -
  22.         $report = new blocks_helloworld_report_users($this->url, $COURSE->id);
    23. -
  23.         $output = $this->mroutput->render($report);
    24. -
  24.  
    25. -
  25.         // Alternative syntax...
    26. -
  26.         // $output = $this->mroutput->render(
    27. -
  27.         //     new blocks_helloworld_report_users($this->url, $COURSE->id)
    28. -
  28.         // );
    29. -
  29.         #### DEMO CODE ####
    30. -
  30.  
    31. -
  31.         return $this->output->heading('Demo of mr_report_abstract').
    32. -
  32.                $this->helper->highlight(__CLASS__, __FUNCTION__, true).
    33. -
  33.                $output;
    34. -
  34.     }
    35. -
  35.  
    36. -
  36.     /**
    37. -
  37.      * Report JSON endpoint
    38. -
  38.      */
    39. -
  39.     public function autocomplete_action() {
    40. -
  40.         global $DB;
    41. -
  41.  
    42. -
  42.         $query = required_param('query', PARAM_TEXT);
    43. -
  43.  
    44. -
  44.         $json = new stdClass;
    45. -
  45.         $json->results = $DB->get_records_select('user', 'username LIKE ?', array("%$query%"), 'username', 'id, username AS text');
    46. -
  46.         $json->results = array_values($json->results); // Makes proper JSON
    47. -
  47.         echo json_encode($json);
    48. -
  48.         die;
    49. -
  49.     }
    50. -
  50. }
    51. -
-
+ + + + + + See how to render this class + + + + +

See how to render this class

+
+
+
    +
  1. +
    <?php
    +
    2. +
  2. +
    /**
    +
    3. +
  3. +
     * Report controller
    +
    4. +
  4. +
     *
    +
    5. +
  5. +
     * @author Mark Nielsen +
    +
    6. +
  6. +
     * @version $Id$
    +
    7. +
  7. +
     * @package blocks/helloworld +
    +
    8. +
  8. +
     */
    +
    9. +
  9. +
     
    +
    10. +
  10. +
    defined('MOODLE_INTERNAL') or die('Direct access to this script is forbidden.');
    +
    11. +
  11. +
     
    +
    12. +
  12. +
    class block_helloworld_controller_report extends mr_controller_block {
    +
    13. +
  13. +
        /**
    +
    14. +
  14. +
         * Default screen
    +
    15. +
  15. +
         */
    +
    16. +
  16. +
        public function view_action() { +
    +
    17. +
  17. +
            global $CFG, $COURSE;
    +
    18. +
  18. +
     
    +
    19. +
  19. +
            #### DEMO CODE ####
    +
    20. +
  20. +
            require_once($CFG->dirroot.'/blocks/helloworld/report/users.php');
    +
    21. +
  21. +
     
    +
    22. +
  22. +
            $report = new blocks_helloworld_report_users($this->url, $COURSE->id);
    +
    23. +
  23. +
            $output = $this->mroutput->render($report);
    +
    24. +
  24. +
     
    +
    25. +
  25. +
            // Alternative syntax...
    +
    26. +
  26. +
            // $output = $this->mroutput->render(
    +
    27. +
  27. +
            //     new blocks_helloworld_report_users + ($this->url, $COURSE->id) +
    +
    28. +
  28. +
            // );
    +
    29. +
  29. +
            #### DEMO CODE ####
    +
    30. +
  30. +
     
    +
    31. +
  31. +
            return $this->output->heading('Demo of mr_report_abstract'). +
    +
    32. +
  32. +
    +                $this->helper->highlight(__CLASS__, __FUNCTION__, true).
    +
    33. +
  33. +
    +                $output;
    +
    34. +
  34. +
        }
    +
    35. +
  35. +
     
    +
    36. +
  36. +
        /**
    +
    37. +
  37. +
         * Report JSON endpoint +
    +
    38. +
  38. +
         */
    +
    39. +
  39. +
        public function autocomplete_action() { +
    +
    40. +
  40. +
            global $DB;
    +
    41. +
  41. +
     
    +
    42. +
  42. +
            $query = required_param('query', PARAM_TEXT);
    +
    43. +
  43. +
     
    +
    44. +
  44. +
            $json = new stdClass;
    +
    45. +
  45. +
            $json->results = $DB->get_records_select('user', 'username LIKE ?', array("%$query%"), 'username', 'id, username AS text');
    +
    46. +
  46. +
            $json->results = array_values($json->results); // Makes proper JSON
    +
    47. +
  47. +
            echo json_encode($json); +
    +
    48. +
  48. +
            die;
    +
    49. +
  49. +
        }
    +
    50. +
  50. +
    }
    +
    51. +
+
+

- Documentation generated on Thu, 28 Jun 2012 16:33:45 -0700 by phpDocumentor 1.4.3 + Documentation generated on Thu, 28 Jun 2012 16:33:45 -0700 by phpDocumentor 1.4.3

- + + \ No newline at end of file diff --git a/docs/__examplesource/exsource_ule2-maint_blocks_helloworld_controller_server.php_a4df7da15f0287015b6305b4c2b86e1b.html b/docs/__examplesource/exsource_ule2-maint_blocks_helloworld_controller_server.php_a4df7da15f0287015b6305b4c2b86e1b.html index 707616c4..e75cc3d1 100644 --- a/docs/__examplesource/exsource_ule2-maint_blocks_helloworld_controller_server.php_a4df7da15f0287015b6305b4c2b86e1b.html +++ b/docs/__examplesource/exsource_ule2-maint_blocks_helloworld_controller_server.php_a4df7da15f0287015b6305b4c2b86e1b.html @@ -1,75 +1,328 @@ - - - - - Example client - - - -

Example client

-
-
  1. <?php
    2. -
  2. /**
    3. -
  3.  * Server controller
    4. -
  4.  *
    5. -
  5.  * @author Mark Nielsen
    6. -
  6.  * @version $Id$
    7. -
  7.  * @package blocks/helloworld
    8. -
  8.  */
    9. -
  9.  
    10. -
  10. defined('MOODLE_INTERNAL') or die('Direct access to this script is forbidden.');
    11. -
  11.  
    12. -
  12. class block_helloworld_controller_server extends mr_controller_block {
    13. -
  13.     /**
    14. -
  14.      * Default screen
    15. -
  15.      *
    16. -
  16.      * Demo of mr_server_rest
    17. -
  17.      */
    18. -
  18.     public function view_action() {
    19. -
  19.         global $CFG, $DB;
    20. -
  20.  
    21. -
  21.         if (!$DB->record_exists('user', array('username' => 'administrator'))) {
    22. -
  22.             $this->notify->add_string('For the service to work correctly, please create a user with username/password = administrator');
    23. -
  23.         }
    24. -
  24.  
    25. -
  25.         #### DEMO CODE ####
    26. -
  26.         // Setup Zend
    27. -
  27.         mr_bootstrap::zend();
    28. -
  28.         require_once 'Zend/Rest/Client.php';
    29. -
  29.  
    30. -
  30.         // Lame-o
    31. -
  31.         $https = str_replace('http', 'https', $CFG->wwwroot);
    32. -
  32.  
    33. -
  33.         // Create a new HTTP client
    34. -
  34.         $client  = new Zend_Http_Client($https.'/blocks/helloworld/webservices.php');
    35. -
  35.  
    36. -
  36.         // Set the post parameters that we want
    37. -
  37.         $client->setParameterPost(array(
    38. -
  38.             'token'      => 'tokenvalue',      // Part of security requirements, pass a token
    39. -
  39.             'wsusername' => 'administrator',   // Part of security requirements, pass username
    40. -
  40.             'wspassword' => 'administrator',   // Part of security requirements, pass password
    41. -
  41.             'method'     => 'test',            // The service method to execute
    42. -
  42.             'say'        => 'Hello World!',    // The service parameter name
    43. -
  43.         ));
    44. -
  44.         // Send the request
    45. -
  45.         $response = $client->request('POST');
    46. -
  46.         $request  = $client->getLastRequest();
    47. -
  47.  
    48. -
  48.         // Dump the values
    49. -
  49.         $output  = $this->helper->dump($request, 'The sent request', true);
    50. -
  50.         $output .= $this->helper->dump($response->getBody(), 'The returned response', true);
    51. -
  51.         #### DEMO CODE ####
    52. -
  52.  
    53. -
  53.         return $this->output->heading('Demo of mr_server_rest').
    54. -
  54.                $this->helper->highlight(__CLASS__, __FUNCTION__, true).
    55. -
  55.                $this->output->box($output, 'generalbox boxaligncenter boxwidthnormal');
    56. -
  56.     }
    57. -
  57. }
    58. -
-
+ + + + + + Example client + + + + +

Example client

+
+
+
    +
  1. +
    <?php
    +
    2. +
  2. +
    /**
    +
    3. +
  3. +
     * Server controller
    +
    4. +
  4. +
     *
    +
    5. +
  5. +
     * @author Mark Nielsen +
    +
    6. +
  6. +
     * @version $Id$
    +
    7. +
  7. +
     * @package blocks/helloworld +
    +
    8. +
  8. +
     */
    +
    9. +
  9. +
     
    +
    10. +
  10. +
    defined('MOODLE_INTERNAL') or die('Direct access to this script is forbidden.');
    +
    11. +
  11. +
     
    +
    12. +
  12. +
    class block_helloworld_controller_server extends mr_controller_block {
    +
    13. +
  13. +
        /**
    +
    14. +
  14. +
         * Default screen
    +
    15. +
  15. +
         *
    +
    16. +
  16. +
         * Demo of mr_server_rest +
    +
    17. +
  17. +
         */
    +
    18. +
  18. +
        public function view_action() { +
    +
    19. +
  19. +
            global $CFG, $DB; +
    +
    20. +
  20. +
     
    +
    21. +
  21. +
            if (!$DB->record_exists('user', array('username' => 'administrator'))) {
    +
    22. +
  22. +
                $this->notify->add_string('For the service to work correctly, please  + create a user with username/password = administrator');
    +
    23. +
  23. +
            } +
    +
    24. +
  24. +
     
    +
    25. +
  25. +
            #### DEMO CODE ####
    +
    26. +
  26. +
            // Setup Zend
    +
    27. +
  27. +
            mr_bootstrap::zend();
    +
    28. +
  28. +
            require_once 'Zend/Rest/Client.php';
    +
    29. +
  29. +
     
    +
    30. +
  30. +
            // Lame-o
    +
    31. +
  31. +
            $https = str_replace('http', 'https', $CFG->wwwroot); +
    +
    32. +
  32. +
     
    +
    33. +
  33. +
            // Create a new HTTP client
    +
    34. +
  34. +
            $client  = new Zend_Http_Client($https.'/blocks/helloworld/webservices.php');
    +
    35. +
  35. +
     
    +
    36. +
  36. +
            // Set the post parameters that we want +
    +
    37. +
  37. +
            $client->setParameterPost(array(
    +
    38. +
  38. +
                'token'      => 'tokenvalue',      // Part of security requirements, pass a token +
    +
    39. +
  39. +
                'wsusername' => 'administrator',   // Part of security requirements, pass username +
    +
    40. +
  40. +
                'wspassword' => 'administrator',   // Part of security requirements, pass password +
    +
    41. +
  41. +
                'method'     => 'test',            // The service method to execute
    +
    42. +
  42. +
                'say'        => 'Hello World!',    // The service parameter name
    +
    43. +
  43. +
            ));
    +
    44. +
  44. +
            // Send the request
    +
    45. +
  45. +
            $response = $client->request('POST');
    +
    46. +
  46. +
            $request  = $client->getLastRequest();
    +
    47. +
  47. +
     
    +
    48. +
  48. +
            // Dump the values
    +
    49. +
  49. +
            $output  = $this->helper->dump($request, 'The sent request', true);
    +
    50. +
  50. +
            $output .= $this->helper->dump($response->getBody(), 'The returned response', true);
    +
    51. +
  51. +
            #### DEMO CODE ####
    +
    52. +
  52. +
     
    +
    53. +
  53. +
            return $this->output->heading('Demo of mr_server_rest').
    +
    54. +
  54. +
    +                $this->helper->highlight(__CLASS__, __FUNCTION__, true).
    +
    55. +
  55. +
    +                $this->output->box($output, 'generalbox boxaligncenter boxwidthnormal');
    +
    56. +
  56. +
        }
    +
    57. +
  57. +
    }
    +
    58. +
+
+

- Documentation generated on Thu, 28 Jun 2012 16:33:51 -0700 by phpDocumentor 1.4.3 + Documentation generated on Thu, 28 Jun 2012 16:33:51 -0700 by phpDocumentor 1.4.3

- + + \ No newline at end of file diff --git a/docs/__examplesource/exsource_ule2-maint_blocks_helloworld_plugin_base_class.php_907d127b4229faab06ab733be81f51f8.html b/docs/__examplesource/exsource_ule2-maint_blocks_helloworld_plugin_base_class.php_907d127b4229faab06ab733be81f51f8.html index 7d5ec022..5f6dc917 100644 --- a/docs/__examplesource/exsource_ule2-maint_blocks_helloworld_plugin_base_class.php_907d127b4229faab06ab733be81f51f8.html +++ b/docs/__examplesource/exsource_ule2-maint_blocks_helloworld_plugin_base_class.php_907d127b4229faab06ab733be81f51f8.html @@ -1,67 +1,223 @@ - - - - - Base plugin class - - - -

Base plugin class

-
-
  1. <?php
    2. -
  2. /**
    3. -
  3.  * Base plugin class
    4. -
  4.  *
    5. -
  5.  * @author Mark Nielsen
    6. -
  6.  */
    7. -
  7.  
    8. -
  8. defined('MOODLE_INTERNAL') or die('Direct access to this script is forbidden.');
    9. -
  9.  
    10. -
  10. require($CFG->dirroot.'/local/mr/bootstrap.php');
    11. -
  11.  
    12. -
  12. abstract class block_helloworld_plugin_base_class extends mr_plugin {
    13. -
  13.     /**
    14. -
  14.      * Helper
    15. -
  15.      *
    16. -
  16.      * @var mr_helper 
    17. -
  17.      */
    18. -
  18.     protected $helper;
    19. -
  19.  
    20. -
  20.     /**
    21. -
  21.      * Commonly you want to make helper readily available
    22. -
  22.      */
    23. -
  23.     public function __construct() {
    24. -
  24.         $this->helper = new mr_helper('blocks/helloworld');
    25. -
  25.     }
    26. -
  26.  
    27. -
  27.     /**
    28. -
  28.      * Implement abstract method of mr_plugin
    29. -
  29.      */
    30. -
  30.     public function get_component() {
    31. -
  31.         return 'block_helloworld';
    32. -
  32.     }
    33. -
  33.  
    34. -
  34.     /**
    35. -
  35.      * Custom abstract method
    36. -
  36.      *
    37. -
  37.      * @return string 
    38. -
  38.      */
    39. -
  39.     abstract public function abstract_method();
    40. -
  40.  
    41. -
  41.     /**
    42. -
  42.      * Parent method
    43. -
  43.      *
    44. -
  44.      * @return string 
    45. -
  45.      */
    46. -
  46.     public function parent_method() {
    47. -
  47.         return 'Parent method called';
    48. -
  48.     }
    49. -
  49. }
    50. -
-
+ + + + + + Base plugin class + + + + +

Base plugin class

+
+
+
    +
  1. +
    <?php
    +
    2. +
  2. +
    /**
    +
    3. +
  3. +
     * Base plugin class
    +
    4. +
  4. +
     *
    +
    5. +
  5. +
     * @author Mark Nielsen +
    +
    6. +
  6. +
     */
    +
    7. +
  7. +
     
    +
    8. +
  8. +
    defined('MOODLE_INTERNAL') or die('Direct access to this script is forbidden.');
    +
    9. +
  9. +
     
    +
    10. +
  10. +
    require($CFG->dirroot.'/local/mr/bootstrap.php');
    +
    11. +
  11. +
     
    +
    12. +
  12. +
    abstract class block_helloworld_plugin_base_class extends mr_plugin {
    +
    13. +
  13. +
        /**
    +
    14. +
  14. +
         * Helper
    +
    15. +
  15. +
         *
    +
    16. +
  16. +
         * @var mr_helper  +
    +
    17. +
  17. +
         */
    +
    18. +
  18. +
        protected $helper;
    +
    19. +
  19. +
     
    +
    20. +
  20. +
        /**
    +
    21. +
  21. +
         * Commonly you want  + to make helper readily available +
    +
    22. +
  22. +
         */
    +
    23. +
  23. +
        public function __construct() { +
    +
    24. +
  24. +
            $this->helper = new mr_helper('blocks/helloworld');
    +
    25. +
  25. +
        }
    +
    26. +
  26. +
     
    +
    27. +
  27. +
        /**
    +
    28. +
  28. +
         * Implement abstract method of mr_plugin +
    +
    29. +
  29. +
         */
    +
    30. +
  30. +
        public function get_component() { +
    +
    31. +
  31. +
            return 'block_helloworld';
    +
    32. +
  32. +
        }
    +
    33. +
  33. +
     
    +
    34. +
  34. +
        /**
    +
    35. +
  35. +
         * Custom abstract method +
    +
    36. +
  36. +
         *
    +
    37. +
  37. +
         * @return string  +
    +
    38. +
  38. +
         */
    +
    39. +
  39. +
        abstract public function abstract_method();
    +
    40. +
  40. +
     
    +
    41. +
  41. +
        /**
    +
    42. +
  42. +
         * Parent method
    +
    43. +
  43. +
         *
    +
    44. +
  44. +
         * @return string  +
    +
    45. +
  45. +
         */
    +
    46. +
  46. +
        public function parent_method() { +
    +
    47. +
  47. +
            return 'Parent method called';
    +
    48. +
  48. +
        }
    +
    49. +
  49. +
    }
    +
    50. +
+
+

- Documentation generated on Thu, 28 Jun 2012 16:33:50 -0700 by phpDocumentor 1.4.3 + Documentation generated on Thu, 28 Jun 2012 16:33:50 -0700 by phpDocumentor 1.4.3

- + + \ No newline at end of file