CORE-POS/IS4C

View on GitHub
documentation/Fannie/developer/plugins/index.html

Summary

Maintainability
Test Coverage
<html>
<head>
<title>Fannie Plugins</title>
</head>
<body>
<h1>Writing Plugins for Fannie</h1>
    <div style="border: solid 1px black; font-size: 115%; padding: 1em;">
    The latest documentation can be found on the <a href="https://github.com/CORE-POS/IS4C/wiki/Writing-Fannie-Plugins">Project Wiki</a>.
    The information below may be out of date. 
    </div>
<p>
Fannie's plugin system is object oriented. Writing plugins often involves 
classes. If you are not familiar with object-oriented programming, consider
reviewing information on the topic 
<a href="http://en.wikipedia.org/wiki/Object-oriented_programming">in general</a>
and <a href="http://php.net/manual/en/language.oop5.php">PHP's implementation</a>.
Inheritence is the most important concept in terms of interacting with 
API functionality exposed via Fannie's base classes. PHP5 syntax is preferred and
the understanding the difference between static and instance methods is necessary
to call API functions correctly.
</p>
<b>Plugin Subtopics</b>:
<ul>
<li><a href="define-a-plugin.html">Defining a Plugin</a></li>
<li><a href="pages.html">Creating a Page</a></li>
<li><a href="db.html">Database Best Practices</a></li>
</ul>
</body>
</html>