Add all the phpdocs to the domframework

git-svn-id: https://svn.fournier38.fr/svn/ProgSVN/trunk@1246 bf3deb0d-5f1a-0410-827f-c0cc1f45334c
This commit is contained in:
2014-03-24 19:44:34 +00:00
parent 1b52b410c3
commit 350aa1dea8
28 changed files with 472 additions and 148 deletions

View File

@@ -1,8 +1,14 @@
<?php
/** DomFramework Blog
@package domframework-blog
@author Dominique Fournier <dominique@fournier38.fr> */
error_reporting (E_ALL);
/** The main class : manage all the blogs articles */
class blog
{
/** Return an article */
/** Return an article
@param string|integer|null $articleid The article to display */
private function get ($articleid = FALSE)
{
require_once ("models/model_file.php");
@@ -10,7 +16,8 @@ class blog
return $data->get ($articleid);
}
/** Return an article in text */
/** Return an article in text
@param string|integer|null $articleid The article to display */
public function getTxt ($articleid = FALSE)
{
try
@@ -25,7 +32,8 @@ class blog
catch (Exception $e) {};
}
/** Return an article in xml */
/** Return an article in xml
@param string|integer|null $articleid The article to display */
public function getXml ($articleid = FALSE)
{
try
@@ -40,7 +48,8 @@ class blog
catch (Exception $e) {};
}
/** Return an article in csv */
/** Return an article in CSV
@param string|integer|null $articleid The article to display */
public function getCsv ($articleid = FALSE)
{
try
@@ -55,7 +64,8 @@ class blog
catch (Exception $e) {};
}
/** Return an article in json */
/** Return an article in JSON
@param string|integer|null $articleid The article to display */
public function getJson ($articleid = FALSE)
{
try
@@ -70,7 +80,8 @@ class blog
catch (Exception $e) {};
}
/** Return an article in HTML */
/** Return an article in HTML
@param string|integer|null $articleid The article to display */
public function getHtml ($articleid = FALSE)
{
try

View File

@@ -1,4 +1,8 @@
<?php
/** DomFramework Blog
@package domframework
@author Dominique Fournier <dominique@fournier38.fr> */
require_once ("domframework/route.php");
require_once ("domframework/renderer.php");
$route = new route ();

View File

@@ -1,11 +1,16 @@
<?php
/** DomFramework Blog
@package domframework-blog
@author Dominique Fournier <dominique@fournier38.fr> */
/** Model_file : store the blog datas in files */
class model_file
{
/** The path where the blog articles files are stored */
public $dataPath = "datas/";
/** Return a provided article */
/** Return a provided article
@param string|integer|null $articleid Teh article to display */
function get ($articleid = FALSE)
{
$this->dataPath = realpath ($this->dataPath);

View File

@@ -1,11 +1,20 @@
<?php
/** DomFramework Blog
@package domframework-blog
@author Dominique Fournier <dominique@fournier38.fr> */
/** Display the articles of the blog */
class view_blog
{
/** Return the datas
@param array $data The list of titles */
function get ($data)
{
return $data;
}
/** Display the list of titles
@param array $data The list of titles */
function listing ($data)
{
$content = "<ul>\n";