2ff26b9b4a6c8cac788b3a85887e1718c175ea69
[atutor.git] / mods / phpdoc / PHPDoc / accessor / PhpdocModuleAccessor.php
1 <?php\r
2 /**\r
3 * Provides functions to access phpdoc xml documents that contain modules.\r
4 */\r
5 class PhpdocModuleAccessor extends PhpdocDocumentAccessor {\r
6         \r
7         var $xmlkey = "module";\r
8         \r
9         /**\r
10         * Returns an array with the data of a module (no functions etc, just the module docs).\r
11         * @return       array   $class\r
12         * @access       public\r
13         */\r
14         function getModuledata() {\r
15                 \r
16                 $module = $this->xml["module"];\r
17 \r
18                 unset($module["function"]);\r
19                 unset($module["uses"]);\r
20                 unset($module["constant"]);\r
21                 \r
22                 return $module;\r
23         } // end func getModuledata\r
24         \r
25         function init() {\r
26 \r
27                 list($this->data["functions"], $this->data["functionsaccess"]) = $this->getElementlist("function");             \r
28                 list($this->data["variables"], $this->data["variablesaccess"]) = $this->getElementlist("variable");\r
29                 list($this->data["constants"], $this->data["constantsaccess"]) = $this->getElementlist("constant");\r
30                 $this->buildUseslist();         \r
31 \r
32         } // end func Init\r
33         \r
34 } // end class PhpdocModuleAccessor\r
35 ?>