{"type":"doc","content":[{"type":"paragraph"},{"type":"paragraph"},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"780b1a40-5b1e-4440-b239-0c7778e667f1"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"2dac64f1-71fc-4649-97d6-8ce9b1d1aad8"}},{"type":"heading","attrs":{"level":3},"content":[{"text":"What this guide is","type":"text"}]},{"type":"paragraph","content":[{"text":"This Guide will walk you through the module creation process for FreePBX 2.10+.","type":"text"}]},{"type":"paragraph","content":[{"text":"If you would like to create a module outside of FreePBX that isn't a FreePBX module, but has access to all of the features and functions, then please take a look at ","type":"text"},{"text":"Bootstrap","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/FP/pages/10584317"}}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"We generally try to follow a loose ","type":"text"},{"text":"MVC","type":"text","marks":[{"type":"link","attrs":{"href":"http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller"}}]},{"text":" model of programming.","type":"text"}]},{"type":"paragraph","content":[{"text":"For a visual example of a working FreePBX module, please see our \"Hello World\" example on GitHub: ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://github.com/FreePBX/helloworld"}},{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Directory Structure","type":"text"}]},{"type":"paragraph","content":[{"text":"Our module directory should be created in //admin/modules, and the structure will be as follows (click each for more information):","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"a563f375-74bc-4a35-b109-178f57b05563"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"/","type":"text"},{"text":"module.xml","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/FP/pages/10289830"}}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"install.php","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"uninstall.php","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"functions.inc.php","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae5","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"bin","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae5","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"assets","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae5","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"i18n","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae5","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"views","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Additional files can be as such (and there is no limit to these):","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"f1e02ac2-fbc4-4122-9465-255f50f6b628"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"page..php","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":".html.php","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Note: install.sql and uninstall.sql are depreciated and never worked quite right","type":"text","marks":[{"type":"em"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Assets","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"a4d480cc-6dce-4d38-ab51-9de3c0a6d11f"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"assets","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"js","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"yourfiles.js","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"css","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"yourfiles.css","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"less","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":".less (.less is loaded first if it exists)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"images","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"fonts","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph"}]}]}]},{"type":"paragraph","content":[{"text":"These files are linked on \"apply config\".","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"FreePBX 12.0 and Higher Additions","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"01e3440b-aa7f-4077-acc3-eded15e6d5d0"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":".class.php (CamelCase)","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"For BMO development see: ","type":"text"},{"text":"FreePBX Big Module Object (BMO)","type":"text","marks":[{"type":"link","attrs":{"href":"https://sangomakb.atlassian.net/wiki/spaces/FP/pages/10617134/FreePBX+Big+Module+Object+BMO"}}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"FreePBX 13.0 and Higher","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"e60c4fe8-ab49-428b-9dae-9095e757546d"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Console","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"

Browser not supported