1. <?php
  2. /**
  3. * Plugin array structure
  4. *
  5. * Goals:
  6. * To define routes so we can facilitate 'Clean URLS' and future development
  7. * To define permissions
  8. * To allow plugins to override/add to other core, provider (3rd Pary) and custom plugins, without touching their core code
  9. * Note: Template overrides are separate from Plugin overrides and will be applied in
  10. * the Template system using the directory structure
  11. */
  13. /**
  14. * Plugin page array structure
  15. *
  16. * Defines:
  17. * plugin page name -
  18. * Example Values:
  19. * array('Blog Posts' => array($route, $permissions)) // page to list blog posts
  20. * array('View Blog Post' => array($route, $permissions)) // page to display on full blog post
  21. *
  22. * plugin page route -
  23. * Example Value:
  24. * array('/blog/2013/06/19' => 'page_view_post')
  25. *
  26. * The resulting URL would be:
  27. * http://your_site.com/index.php?a=/blog/2013/06/19 - without clean URLS
  28. * http://your_site.com/blog/2013/06/19 - with clean URLS
  29. *
  30. * The function that is called would be:
  31. * function page_view_post() {}
  32. *
  33. * plugin page permissions -
  34. * Example Value:
  35. * array('Edit Post' => true) // means this permission is active and will display on the Permissions admin page
  36. */
  38. $plugins[$plugin_name] = array();
  39. $plugins[$plugin_name][$pages] = array();
  40. $plugins[$plugin_name][$pages][$page_name] = array();
  41. $plugins[$plugin_name][$pages][$page_name][$route] = array();
  42. $plugins[$plugin_name][$pages][$page_name][$route][$route_path] = 'callbackFunction';
  43. $plugins[$plugin_name][$pages][$page_name][$permissions] = array();
  44. $plugins[$plugin_name][$pages][$page_name][$permissions][$perm_name] = true;
  46. /**
  47. * Plugin blocks array structure
  48. *
  49. * Defines:
  50. * plugin block name -
  51. * Examples:
  52. * array('Blog Categories' => array($route, $permissions)) // block to list recent blog posts
  53. *
  54. * plugin block route -
  55. * Example Value:
  56. * 'block_blog_categories'
  57. *
  58. * The function that is called would be:
  59. * function block_blog_categories() {}
  60. *
  61. * plugin block permissions -
  62. * Example:
  63. * array('View Block' => true) - means this permission is active and will display on the Permissions admin page
  64. */
  66. $plugins[$plugin_name][$blocks] = array();
  67. $plugins[$plugin_name][$blocks][$block_name] = array();
  68. $plugins[$plugin_name][$blocks][$block_name][$route] = 'callbackFunction';
  69. $plugins[$plugin_name][$blocks][$block_name][$permissions] = array();
  70. $plugins[$plugin_name][$blocks][$block_name][$permissions][$perm_name] = true;
  72. /**
  73. * Plugin overrides array structure
  74. *
  75. * First the plugin data structures will be parsed and compiled, then overrides will be applied. Any conflicts between
  76. * overrides (inside the current plugin and with other plugins) will be caught and an error/exception will be thrown.
  77. */
  79. $plugins[$plugin_name][$overrides] = array();
  80. $plugins[$plugin_name][$overrides][$plugin_name] = array();
  81. $plugins[$plugin_name][$overrides][$plugin_name][$pages] = array();
  82. $plugins[$plugin_name][$overrides][$plugin_name][$pages][$page_name] = array();
  83. $plugins[$plugin_name][$overrides][$plugin_name][$pages][$page_name][$route] = array();
  84. $plugins[$plugin_name][$overrides][$plugin_name][$pages][$page_name][$route][$route_path] = 'callbackFunction';
  85. $plugins[$plugin_name][$overrides][$plugin_name][$pages][$page_name][$permissions] = array();
  86. $plugins[$plugin_name][$overrides][$plugin_name][$pages][$page_name][$permissions][$perm_name] = true;
  88. $plugins[$plugin_name][$overrides][$plugin_name][$blocks] = array();
  89. $plugins[$plugin_name][$overrides][$plugin_name][$blocks][$block_name] = array();
  90. $plugins[$plugin_name][$overrides][$plugin_name][$blocks][$block_name][$route] = 'callbackFunction';
  91. $plugins[$plugin_name][$overrides][$plugin_name][$blocks][$block_name][$permissions] = array();
  92. $plugins[$plugin_name][$overrides][$plugin_name][$blocks][$block_name][$permissions][$perm_name] = true;

Initial array overview