PHPDoc inline documentation

Swiftlet/App.php

@@ -4,32 +4,68 @@
 
 /**
  * Application class
- *
- * @property string $action
- * @property array $args
- * @property array $config
- * @property Interfaces\Controller $controller
- * @property string $controllerName
- * @property array $hooks
- * @property array $plugins
- * @property string $rootPath
- * @property array $singletons
- * @property Interfaces\View $view
  */
 class App implements Interfaces\App
 {
- protected
- $action = 'index',
- $args = array(),
- $config = array(),
- $controller,
- $controllerName = 'Index',
- $hooks = array(),
- $plugins = array(),
- $rootPath = '/',
- $singletons = array(),
- $view
- ;
+ /**
+ * Action name
+ * @var string
+ */
+ protected $action = 'index';
+
+ /**
+ * Arguments
+ * @var array
+ */
+ protected $args = array();
+
+ /**
+ * Configuration values
+ * @var array
+ */
+ protected $config = array();
+
+ /**
+ * Controller intance
+ * @var Interfaces/Controller
+ */
+ protected $controller;
+
+ /**
+ * Controller name
+ * @var string
+ */
+ protected $controllerName = 'Index';
+
+ /**
+ * Hooks
+ * @var array
+ */
+ protected $hooks = array();
+
+ /**
+ * Plugins
+ * @var array
+ */
+ protected $plugins = array();
+
+ /**
+ * Root path
+ * @var string
+ */
+ protected $rootPath = '/';
+
+ /**
+ * Re-usable model instances
+ * @var array
+ */
+ protected $singletons = array();
+
+ /**
+ * View instance
+ * @var Interfaces/View
+ */
+ protected $view;
 
  /**
  * Run the application
@@ -266,7 +302,6 @@ public function autoload($className)
  * @param string $string
  * @param string $file
  * @param int $line
- *
  * @throws Exception
  */
  public function error($number, $string, $file, $line)

Swiftlet/Controller.php

@@ -4,23 +4,33 @@
 
 /**
  * Controller class
- *
  * @abstract
  * @property Interfaces\App $app
  * @property Interfaces\View $view
  * @property string $title
  */
 abstract class Controller implements Interfaces\Controller
 {
- protected
- $app,
- $view,
- $title
- ;
+ /**
+ * Application instance
+ * @var Interfaces\App
+ */
+ protected $app;
+
+ /**
+ * View instance
+ * @var Interfaces\View
+ */
+ protected $view;
+
+ /**
+ * Page title
+ * @var string
+ */
+ protected $title;
 
  /**
  * Constructor
- *
  * @param Interfaces\App $app
  * @param Interfaces\View $view
  */
@@ -41,7 +51,6 @@ public function index()
 
  /**
  * Fallback in case action doesn't exist
- *
  * @throws Exception
  */
  public function notImplemented()

Swiftlet/Controllers/Error404.php

@@ -4,14 +4,14 @@
 
 /**
  * Error 404 controller
- *
- * @property $title
  */
 class Error404 extends \Swiftlet\Controller
 {
- protected
- $title = 'Error 404'
- ;
+ /**
+ * Page title
+ * @var string
+ */
+ protected $title = 'Error 404';
 
  /**
  * Default action

Swiftlet/Controllers/Index.php

@@ -4,14 +4,14 @@
 
 /**
  * Index controller
- *
- * @property $title
  */
 class Index extends \Swiftlet\Controller
 {
- protected
- $title = 'Home'
- ;
+ /**
+ * Page title
+ * @var string
+ */
+ protected $title = 'Home';
 
  /**
  * Default action

Swiftlet/Interfaces/App.php

@@ -7,29 +7,89 @@
  */
 interface App
 {
+ /**
+ * Run the application
+ */
  public function run();
 
+ /**
+ * Serve the page
+ */
  public function serve();
 
+ /**
+ * Get a configuration value
+ * @param string $variable
+ * @return mixed|null
+ */
  public function getConfig($variable);
 
+ /**
+ * Set a configuration value
+ * @param string $variable
+ * @param mixed $value
+ */
  public function setConfig($variable, $value);
 
+ /**
+ * Get the client-side path to root
+ * @return string
+ */
  public function getRootPath();
 
+ /**
+ * Get the controller name
+ * @return string
+ */
  public function getControllerName();
 
+ /**
+ * Get the action name
+ * @return string
+ */
  public function getAction();
 
+ /**
+ * Get the arguments
+ * @return array
+ */
  public function getArgs();
 
+ /**
+ * Get a model
+ * @param string $modelName
+ * @return object
+ */
  public function getModel($modelName);
 
+ /**
+ * Get a model singleton
+ * @param string $modelName
+ * @return object
+ */
  public function getSingleton($modelName);
 
+ /**
+ * Register a hook for plugins to implement
+ * @param string $hookName
+ * @param array $params
+ */
  public function registerHook($hookName, array $params = array());
 
+ /**
+ * Class autoloader
+ * @param $className
+ * @see https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md
+ */
  public function autoload($className);
 
+ /**
+ * Error handler
+ * @param int $number
+ * @param string $string
+ * @param string $file
+ * @param int $line
+ * @throws Exception
+ */
  public function error($number, $string, $file, $line);
 }

Swiftlet/Interfaces/Controller.php

@@ -7,9 +7,21 @@
  */
 interface Controller
 {
+ /**
+ * Constructor
+ * @param App $app
+ * @param View $view
+ */
  public function __construct(App $app, View $view);
 
+ /**
+ * Default action
+ */
  public function index();
 
+ /**
+ * Fallback in case action doesn't exist
+ * @throws Exception
+ */
  public function notImplemented();
 }

Swiftlet/Interfaces/Model.php

@@ -7,5 +7,9 @@
  */
 interface Model
 {
+ /**
+ * Constructor
+ * @param App $app
+ */
  public function __construct(App $app);
 }

Swiftlet/Interfaces/Plugin.php

@@ -7,5 +7,11 @@
  */
 interface Plugin
 {
+ /**
+ * Constructor
+ * @param App $app
+ * @param View $view
+ * @param Controller $controller
+ */
  public function __construct(App $app, View $view, Controller $controller);
 }

Swiftlet/Interfaces/View.php

@@ -7,19 +7,59 @@
  */
 interface View
 {
+ /**
+ * Constructor
+ * @param App $app
+ * @param string $name
+ */
  public function __construct(App $app, $name);
 
+ /**
+ * Get a view variable
+ * @param string $variable
+ * @param bool $htmlEncode
+ * @return mixed|null
+ */
  public function get($variable, $htmlEncode = true);
 
+ /**
+ * Magic method to get a view variable, forwards to $this->get()
+ * @param string $variable
+ * @return mixed
+ */
  public function __get($variable);
 
- public function set($variable, $value = null);
-
+ /**
+ * Magic method to set a view variable, forwards to $this->set()
+ * @param string $variable
+ * @param mixed $value
+ */
  public function __set($variable, $value = null);
 
+ /**
+ * Magic method to set a view variable, forwards to $this->set()
+ * @param string $variable
+ * @param mixed $value
+ */
+ public function set($variable, $value = null);
+
+ /**
+ * Recursively make a value safe for HTML
+ * @param mixed $value
+ * @return mixed
+ */
  public function htmlEncode($value);
 
+ /**
+ * Recursively decode an HTML encoded value
+ * @param mixed $value
+ * @return mixed
+ */
  public function htmlDecode($value);
 
+ /**
+ * Render the view
+ * @throws Exception
+ */
  public function render();
 }