Source for file SqlManager.php

Documentation is available at SqlManager.php

  1. <?php
  2. include_once(dirname(__FILE__)."/../OsidManager.php");
  3. /**
  4. * The SqlManager provides a means to retrieve a connection to the database.
  5. *
  6. * <p>
  7. * All implementations of OsidManager (manager) provide methods for accessing
  8. * and manipulating the various objects defined in the OSID package. A manager
  9. * defines an implementation of an OSID. All other OSID objects come either
  10. * directly or indirectly from the manager. New instances of the OSID objects
  11. * are created either directly or indirectly by the manager. Because the OSID
  12. * objects are defined using interfaces, create methods must be used instead
  13. * of the new operator to create instances of the OSID objects. Create methods
  14. * are used both to instantiate and persist OSID objects. Using the
  15. * OsidManager class to define an OSID's implementation allows the application
  16. * to change OSID implementations by changing the OsidManager package name
  17. * used to load an implementation. Applications developed using managers
  18. * permit OSID implementation substitution without changing the application
  19. * source code. As with all managers, use the OsidLoader to load an
  20. * implementation of this interface.
  21. * </p>
  22. *
  23. * <p></p>
  24. *
  25. * <p>
  26. * OSID Version: 2.0
  27. * </p>
  28. *
  29. * <p>
  30. * Licensed under the {@link org.osid.SidImplementationLicenseMIT MIT}
  31. * O.K.I&#46; OSID Definition License}.
  32. * </p>
  33. *
  34. * @package org.osid.sql
  35. */
  36. class SqlManager
  37. extends OsidManager
  38. {
  39. /**
  40. * return a Connection associated with the specified connection string.
  41. *
  42. * @param string $connectionString
  43. *
  44. * @return object Connection
  45. *
  46. * @throws object SqlException An exception with one of the following
  47. * messages defined in org.osid.sql.SqlException may be thrown:
  48. * {@link org.osid.sql.SqlException#OPERATION_FAILED}
  49. * OPERATION_FAILED}, {@link }
  50. * org.osid.sql.SqlException#PERMISSION_DENIED PERMISSION_DENIED},
  51. * {@link org.osid.sql.SqlException#CONFIGURATION_ERROR}
  52. * CONFIGURATION_ERROR}, {@link }
  53. * org.osid.sql.SqlException#UNIMPLEMENTED UNIMPLEMENTED}
  54. *
  55. * @access public
  56. */
  57. function getConnection ( $connectionString ) {
  58. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  59. }
  60. }
  61.  
  62. ?>

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