/ODataConnectorForMySQL/EDMXGenerator/IEDMXGenerator.php

http://odatamysqlphpconnect.codeplex.com · PHP · 122 lines · 19 code · 11 blank · 92 comment · 0 complexity · ba74072567bb0dac271502cfde2256e2 MD5 · raw file 

    

  1. <?php

    2. 

  2. /**

    3. 

  3.  * Contains ISchemaReader class is interface of Schema Reader.

    4. 

  4.  * 

    5. 

  5.  * PHP version 5.3

    6. 

  6.  * 

    7. 

  7.  * @category  ODataConnectorForMySQL

    8. 

  8.  * @package   ODataConnectorForMySQL_EDMXGenerator

    9. 

  9.  * @author    Yash K. Kothari <odataphpproducer_alias@microsoft.com>

    10. 

  10.  * @copyright 2011 Microsoft Corp. (http://www.microsoft.com)

    11. 

  11.  * @license   New BSD license, (http://www.opensource.org/licenses/bsd-license.php)

    12. 

  12.  * @version   SVN: 1.0

    13. 

  13.  * @link      

    14. 

  14.  * 

    15. 

  15.  */

    16. 

  16. namespace ODataConnectorForMySQL\EDMXGenerator;

    17. 

  17. use ODataConnectorForMySQL\ObjectModel\Association;

    18. 

  18. use ODataConnectorForMySQL\ObjectModel\AssociationSet;

    19. 

  19. /** 

    20. 

  20.  * OData writer interface.

    21. 

  21.  *

    22. 

  22.  * @category  ODataConnectorForMySQL

    23. 

  23.  * @package   ODataConnectorForMySQL_EDMXGenerator

    24. 

  24.  * @author    Yash K. Kothari <odataphpproducer_alias@microsoft.com>

    25. 

  25.  * @copyright 2011 Microsoft Corp. (http://www.microsoft.com)

    26. 

  26.  * @license   New BSD license, (http://www.opensource.org/licenses/bsd-license.php)

    27. 

  27.  * @version   Release: 1.0

    28. 

  28.  * @link      

    29. 

  29.  */

    30. 

  30. 

    31. 

  31. interface IEDMXGenerator

    32. 

  32. {

    33. 

  33.     /**

    34. 

  34.      * Start Generating EDMX file.

    35. 

  35.      *

    36. 

  36.      * @return EDMX xml object.

    37. 

  37.      */

    38. 

  38.     public function generateEDMX();

    39. 

  39. 

    40. 

  40.     /**

    41. 

  41.      * Write Tables in EDMX format from object model.

    42. 

  42.      *

    43. 

  43.      * @return void

    44. 

  44.      */

    45. 

  45.     public function writeEntityType();

    46. 

  46.     

    47. 

  47.     /**

    48. 

  48.      * Write primary keys for Tables in EDMX format from object model.

    49. 

  49.      *

    50. 

  50.      * @param array<Key> &$entityKeys array of key object of object model.

    51. 

  51.      *

    52. 

  52.      * @return void

    53. 

  53.      */

    54. 

  54.     public function writeKey(&$entityKeys);

    55. 

  55.     

    56. 

  56.     /**

    57. 

  57.      * Write properties of Tables in EDMX format from object model.

    58. 

  58.      *

    59. 

  59.      * @param array<Property> &$properties array of property object of object model.

    60. 

  60.      *

    61. 

  61.      * @return void

    62. 

  62.      */

    63. 

  63.     public function writeProperty(&$properties);

    64. 

  64.     

    65. 

  65.     /**

    66. 

  66.      * Writes navigation Property of the Entity type.

    67. 

  67.      *

    68. 

  68.      * @param array<NavigationProperty> &$navigationProperties array of navigation 

    69. 

  69.      *                                                         property of object 

    70. 

  70.      *                                                         model.

    71. 

  71.      *

    72. 

  72.      * @return void

    73. 

  73.      */

    74. 

  74.     public function writeNavigationProperty(&$navigationProperties);

    75. 

  75.     

    76. 

  76.     /**

    77. 

  77.      * Write Associations between entity types for the given database.

    78. 

  78.      *

    79. 

  79.      * @return void

    80. 

  80.      */

    81. 

  81.     public function writeAssociations();

    82. 

  82.         

    83. 

  83.     /**

    84. 

  84.      * Write Associations between entity types for the given database.

    85. 

  85.      *

    86. 

  86.      * @param Association &$association Association object of object model.

    87. 

  87.      *

    88. 

  88.      * @return void

    89. 

  89.      */

    90. 

  90.     public function writeAssociation(Association &$association);

    91. 

  91.     

    92. 

  92.     /**

    93. 

  93.      * Write Entity Container for given database.

    94. 

  94.      *

    95. 

  95.      * @return void

    96. 

  96.      */

    97. 

  97.     public function writeEntityContainer();

    98. 

  98.     

    99. 

  99.     /**

    100. 

  100.      * Write Entity Set for given database.

    101. 

  101.      *

    102. 

  102.      * @return void

    103. 

  103.      */

    104. 

  104.     public function writeEntitySet();

    105. 

  105.     

    106. 

  106.     /**

    107. 

  107.      * Write Association Sets for given database.

    108. 

  108.      *

    109. 

  109.      * @return void

    110. 

  110.      */

    111. 

  111.     public function writeAssociationSets();

    112. 

  112.     

    113. 

  113.     /**

    114. 

  114.      * Write Association Set for each association.

    115. 

  115.      *

    116. 

  116.      * @param AssociationSet &$associationSet Association set object of Object model.

    117. 

  117.      *

    118. 

  118.      * @return void

    119. 

  119.      */

    120. 

  120.     public function writeAssociationSet(AssociationSet &$associationSet);

    121. 

  121. }

    122. 

  122. ?>
    123.