Source for file services.cfg.php

Documentation is available at services.cfg.php

  1. <?php
  2.  
  3. /**
  4. * Services Configuration
  5. *
  6. * In this file, include whatever class files you need and register the
  7. * necessary services.
  8. *
  9. * @package harmoni.services
  10. *
  11. * @copyright Copyright &copy; 2005, Middlebury College
  12. * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
  13. *
  14. * @version $Id: services.cfg.php,v 1.62 2007/09/19 14:00:41 adamfranco Exp $
  15. */
  16.  
  17. /* :: what services should we load? you can disable some to save on startup time :: */
  18.  
  19.  
  20. /**
  21. * functionality affected: Debug output
  22. */
  23. if (!defined("LOAD_DEBUG")) define("LOAD_DEBUG", true);
  24.  
  25. /**
  26. * functionality affected: Themes/Layouts through the GUIManager
  27. */
  28. if(!defined("LOAD_GUI")) define("LOAD_GUI",false);
  29.  
  30. /**
  31. * functionality affected: HarmoniDataManager, sub-services: DataSetTypeManager, DataTypeManager, DataSetManager
  32. */
  33. if (!defined("LOAD_DATAMANAGER")) define("LOAD_DATAMANAGER", true);
  34.  
  35. /**
  36. * functionality affected: Database connectivity, and anything that depends on it.
  37. */
  38. if (!defined("LOAD_DBC")) define("LOAD_DBC", true);
  39.  
  40. /**
  41. * functionality affected: Sets
  42. */
  43. if (!defined("LOAD_SETS")) define("LOAD_SETS", true);
  44.  
  45. /**
  46. * functionality affected: MIME Type sniffing, ImageProcessing
  47. */
  48. if (!defined("LOAD_MIME")) define("LOAD_MIME", true);
  49.  
  50. /**
  51. * functionality affected: ImageProcessing
  52. */
  53. if (!defined("LOAD_IMAGEPROCESSOR")) define("LOAD_IMAGEPROCESSOR", true);
  54.  
  55. /**
  56. * functionality affected: Language Localization
  57. */
  58. if (!defined("LOAD_LANG")) define("LOAD_LANG", true);
  59.  
  60.  
  61.  
  62.  
  63. /**
  64. * functionality affected: OKI Agent calls.
  65. */
  66. if (!defined("LOAD_AGENT")) define("LOAD_AGENT", true);
  67.  
  68. /**
  69. * functionality affected: OKI AuthN calls.
  70. */
  71. if (!defined("LOAD_AUTHN")) define("LOAD_AUTHN", true);
  72.  
  73. /**
  74. * functionality affected: OKI AuthN calls.
  75. */
  76. if (!defined("LOAD_AGENT_MANAGEMENT")) define("LOAD_AGENT_MANAGEMENT", true);
  77.  
  78. /**
  79. * functionality affected: OKI AuthZ calls.
  80. */
  81. if (!defined("LOAD_AUTHZ")) define("LOAD_AUTHZ", true);
  82.  
  83. /**
  84. * functionality affected: Hiearchy, Digital Repository.
  85. */
  86. if (!defined("LOAD_HIERARCHY")) define("LOAD_HIERARCHY", true);
  87.  
  88. /**
  89. * functionality affected: OKI Id calls.
  90. */
  91. if (!defined("LOAD_ID")) define("LOAD_ID", true);
  92.  
  93. /**
  94. * functionality affected: OKI Logging calls.
  95. */
  96. if (!defined("LOAD_LOGGING")) define("LOAD_LOGGING", true);
  97.  
  98. /**
  99. * functionality affected: Digital Repository.
  100. */
  101. if (!defined("LOAD_REPOSITORY")) define("LOAD_REPOSITORY", true);
  102.  
  103. /**
  104. * functionality affected: Scheduling.
  105. */
  106. if (!defined("LOAD_SCHEDULING")) define("LOAD_SCHEDULING", true);
  107.  
  108. /**
  109. * functionality affected: Course Management.
  110. */
  111. if (!defined("LOAD_COURSE_MANAGEMENT")) define("LOAD_COURSE_MANAGEMENT", true);
  112.  
  113. /**
  114. * functionality affected: Grading.
  115. */
  116. if (!defined("LOAD_GRADING")) define("LOAD_GRADING", true);
  117.  
  118. /**
  119. * functionality affected: Tagging.
  120. */
  121. if (!defined("LOAD_TAGGING")) define("LOAD_TAGGING", true);
  122.  
  123.  
  124.  
  125. /**
  126. * USER DEFINED SERVICES
  127. *
  128. * In this section, you can register your own services for your use in your
  129. * scripts. The syntax for registering a service is:
  130. *
  131. * Services::registerService(<user-defined name>,<class name>);
  132. *
  133. * where <class name> stands for the class that will be instantiated when the
  134. * service starts -- service classes can not have any parameters required by
  135. * the constructor. Implement the methods in OsidManager, assignConfiguration()
  136. * and assignOsidContext() for assigning configuration.
  137. *
  138. * You can also create aliases by which to access services:
  139. *
  140. * Services::createServiceAlias(<user-defined name>, <first alias name>);
  141. * Services::createServiceAlias(<user-defined name>, <second alias name>);
  142. * ...
  143. * Services::createServiceAlias(<user-defined name>, <N'th alias name>);
  144. *
  145. * All services methods can be used with the aliases instead of the original name.
  146. *
  147. * Using this feature, your scripts can use the service like this:
  148. *
  149. * Services::startManagerAsService(<user-defined name>, <OsidContext>, <configuration>);
  150. * $var = Service::getService(<user-defined name>);
  151. * ...
  152. * $var->someMethod($someParameter,...);
  153. * ...
  154. *
  155. * Please look at the PHPDoc included with Harmoni for more details on Services.
  156. */
  157.  
  158.  
  159.  
  160.  
  161. /**
  162. * DON'T EDIT BELOW THIS LINE!
  163. *
  164. * HARMONI REQUIRED SERVICES
  165. *
  166. * These Services are *required* for proper Harmoni functionality.
  167. * If you choose to replace them, make SURE your classes implement the proper
  168. * interface so that compatibility can be assured.
  169. */
  170.  
  171.  
  172. /**
  173. * Load property manager
  174. */
  175. require_once(HARMONI."oki2/agent/HarmoniPropertyManager.class.php");
  176. Services::registerService("Property", "HarmoniPropertyManager");
  177. Services::createServiceAlias("Property", "PropertyManager");
  178.  
  179.  
  180. /**
  181. * load ArgumentValidator
  182. */
  183. require_once(HARMONI."utilities/ArgumentValidator.class.php");
  184.  
  185. require_once(OKI2."osid/OsidContext.php");
  186. $context = new OsidContext;
  187. $context->assignContext('harmoni', $harmoni);
  188.  
  189.  
  190. /**
  191. * load our custom exceptions
  192. */
  193. require_once(HARMONI."errorHandler/HarmoniException.class.php");
  194. require_once(HARMONI."errorHandler/Error.class.php");
  195. require_once(HARMONI."errorHandler/throw.inc.php");
  196.  
  197. /**
  198. * load DBHandler
  199. */
  200. require_once(HARMONI."DBHandler/DBHandler.class.php");
  201. Services::registerService("DatabaseManager","DBHandler");
  202. Services::createServiceAlias("DatabaseManager", "DBHandler");
  203.  
  204. /**
  205. * load debug handler
  206. */
  207. if (LOAD_DEBUG) {
  208. require_once(HARMONI."debugHandler/DebugHandler.class.php");
  209. Services::registerService("DebugManager","DebugHandler");
  210. Services::createServiceAlias("DebugManager", "Debug");
  211. require_once(HARMONI."debugHandler/debug.class.php");
  212. require_once(HARMONI."oki2/shared/ConfigurationProperties.class.php");
  213. $configuration = new ConfigurationProperties;
  214. Services::startManagerAsService("DebugManager", $context, $configuration);
  215. }
  216.  
  217. /**
  218. * load the GuiManager
  219. */
  220. if(LOAD_GUI) {
  221.  
  222. require_once(HARMONI."GUIManager/GUIManager.class.php");
  223. Services::registerService("GUIManager","GUIManager");
  224. Services::createServiceAlias("GUIManager", "GUI");
  225.  
  226. }
  227.  
  228. /**
  229. * include DataManager files
  230. */
  231. if (LOAD_DATAMANAGER) {
  232. require_once(HARMONI."dataManager/DataManager.abstract.php");
  233. // The DataManager class is simply a shell that creates other
  234. // services that handle specific parts of the DataManager system's
  235. // functionality.
  236. Services::registerService("DataManager","DataManager");
  237. }
  238.  
  239. /**
  240. * load the LanguageLocalization service
  241. */
  242. if (LOAD_LANG) {
  243. require_once(HARMONI."languageLocalizer/LanguageLocalizer.class.php");
  244. Services::registerService("LanguageManager","LanguageLocalizer");
  245. Services::createServiceAlias("LanguageManager", "Lang");
  246. }
  247.  
  248. /**
  249. * load the Sets service
  250. */
  251. if (LOAD_SETS) {
  252. require_once(HARMONI."sets/SetManager.class.php");
  253. Services::registerService("SetManager","SetManager");
  254. Services::createServiceAlias("SetManager", "Sets");
  255. }
  256.  
  257. /**
  258. * load the Sets service
  259. */
  260. if (LOAD_MIME) {
  261. require_once(HARMONI."utilities/MIMETypes.class.php");
  262. Services::registerService("MIMEManager", "MIMETypes");
  263. Services::createServiceAlias("MIMEManager", "MIME");
  264. }
  265.  
  266. /**
  267. * load the Sets service
  268. */
  269. if (LOAD_IMAGEPROCESSOR) {
  270. require_once(HARMONI."ImageProcessor/ImageProcessor.class.php");
  271. Services::registerService("ImageProcessingManager", "ImageProcessor");
  272. Services::createServiceAlias("ImageProcessingManager", "ImageProcessor");
  273. }
  274.  
  275.  
  276. /**
  277. * OKI OSID implementations:
  278. */
  279.  
  280.  
  281. /**
  282. * load the AgentManager
  283. */
  284. if (LOAD_AGENT) {
  285. require_once(HARMONI."oki2/agent/HarmoniAgentManager.class.php");
  286. Services::registerService("AgentManager","HarmoniAgentManager");
  287. Services::createServiceAlias("AgentManager", "Agent");
  288. }
  289. /**
  290. * load the AuthNManager
  291. */
  292. if (LOAD_AUTHN) {
  293. require_once(HARMONI."oki2/authentication/HarmoniAuthenticationManager.class.php");
  294. Services::registerService("AuthenticationManager","HarmoniAuthenticationManager");
  295. Services::createServiceAlias("AuthenticationManager", "AuthN");
  296. }
  297.  
  298. /**
  299. * load the AuthNManager
  300. */
  301. if (LOAD_AGENT_MANAGEMENT) {
  302. require_once(HARMONI."oki2/agentmanagement/AuthNMethods/AuthNMethodManager.class.php");
  303. Services::registerService("AuthNMethodManager","AuthNMethodManager");
  304. Services::createServiceAlias("AuthNMethodManager", "AuthNMethods");
  305. require_once(HARMONI."oki2/agentmanagement/AgentTokenMapping/AgentTokenMappingManager.class.php");
  306. Services::registerService("AgentTokenMappingManager","AgentTokenMappingManager");
  307. Services::createServiceAlias("AgentTokenMappingManager", "AgentTokenMapping");
  308. }
  309.  
  310. /**
  311. * load the AuthZManager
  312. */
  313. if (LOAD_AUTHZ) {
  314. require_once(HARMONI."oki2/authorization/HarmoniAuthorizationManager.class.php");
  315. Services::registerService("AuthorizationManager","HarmoniAuthorizationManager");
  316. Services::createServiceAlias("AuthorizationManager", "AuthZ");
  317. }
  318.  
  319. /**
  320. * load the HierarchyManager.
  321. */
  322. if (LOAD_HIERARCHY) {
  323. require_once(HARMONI."oki2/hierarchy/HarmoniHierarchyManager.class.php");
  324. Services::registerService("HierarchyManager","HarmoniHierarchyManager");
  325. Services::createServiceAlias("HierarchyManager", "Hierarchy");
  326. }
  327.  
  328. /**
  329. * load the IdManager
  330. */
  331. if (LOAD_ID) {
  332. require_once(HARMONI."oki2/id/HarmoniIdManager.class.php");
  333. Services::registerService("IdManager","HarmoniIdManager");
  334. Services::createServiceAlias("IdManager", "Id");
  335. }
  336.  
  337. /**
  338. * load the LoggingManager
  339. */
  340. if (LOAD_LOGGING) {
  341. require_once(HARMONI."oki2/logging/HarmoniLoggingManager.class.php");
  342. Services::registerService("LoggingManager","HarmoniLoggingManager");
  343. Services::createServiceAlias("LoggingManager", "Logging");
  344. }
  345. /**
  346. * load the DigitalRepositoryManager.
  347. */
  348. if (LOAD_REPOSITORY) {
  349. require_once(HARMONI."oki2/repository/HarmoniRepositoryManager.class.php");
  350. Services::registerService("RepositoryManager","HarmoniRepositoryManager");
  351. Services::createServiceAlias("RepositoryManager", "Repository");
  352. }
  353.  
  354. /**
  355. * load the SchedulingManager.
  356. */
  357. if (LOAD_SCHEDULING) {
  358. require_once(HARMONI."oki2/scheduling/HarmoniSchedulingManager.class.php");
  359. Services::registerService("SchedulingManager","HarmoniSchedulingManager");
  360. Services::createServiceAlias("SchedulingManager", "Scheduling");
  361. }
  362.  
  363. /**
  364. * load the CourseManagementManager.
  365. */
  366. if (LOAD_COURSE_MANAGEMENT) {
  367. require_once(HARMONI."oki2/coursemanagement/CourseManagementManager.class.php");
  368. Services::registerService("CourseManagementManager","HarmoniCourseManagementManager");
  369. Services::createServiceAlias("CourseManagementManager", "CourseManagement");
  370. }
  371.  
  372. if (LOAD_GRADING) {
  373. require_once(HARMONI."oki2/grading/HarmoniGradingManager.class.php");
  374. Services::registerService("GradingManager","HarmoniGradingManager");
  375. Services::createServiceAlias("GradingManager", "Grading");
  376. }
  377.  
  378. /**
  379. * load the TaggingManager.
  380. */
  381. if (LOAD_TAGGING) {
  382. require_once(HARMONI."Tagging/TagManager.class.php");
  383. Services::registerService("TagManager","TagManager");
  384. Services::createServiceAlias("TagManager", "Tagging");
  385. }
  386.  
  387.  
  388.  
  389. ?>

Documentation generated on Wed, 19 Sep 2007 10:26:25 -0400 by phpDocumentor 1.3.0RC3