improved the docs a bit

parent 300070c1
<?php <?php
namespace ACP3;
/** /**
* Front Controller of the CMS
*
* @author Tino Goratsch * @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/ */
namespace ACP3;
class Application { class Application {
/** /**
......
<?php <?php
/**
* Access Control List
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core; namespace ACP3\Core;
/** /**
* ACL Klasse * Access control lists
* *
* @author Tino Goratsch * @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/ */
abstract class ACL abstract class ACL
{ {
......
<?php <?php
/**
* Authentification
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core; namespace ACP3\Core;
/** /**
* Authentifiziert den Benutzer * Authenticates the user
* *
* @author Tino Goratsch * @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/ */
class Auth class Auth
{ {
......
<?php <?php
/**
* Breadcrumbs
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core; namespace ACP3\Core;
/** /**
* Erzeugt die Brotkrümelspur und gibt den Titel der jeweiligen Seite aus * Generates the breadcrumb and page title
* *
* @author Tino Goratsch * @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/ */
class Breadcrumb { class Breadcrumb {
......
<?php <?php
/**
* Cache
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core; namespace ACP3\Core;
/** /**
* lasse zur Ersetllung des Caches, um die Leistung von bestimmten Aktionen des ACP3 zu steigern * Klasse zur Erstellung des Caches, um die Leistung von bestimmten Aktionen des ACP3 zu steigern
* *
* @author Tino Goratsch * @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/ */
abstract class Cache abstract class Cache
{ {
......
<?php <?php
/**
* Config
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core; namespace ACP3\Core;
use \ACP3\Core\Cache; use \ACP3\Core\Cache;
/** /**
* Erstellt die jeweiligen Konfigurationsdateien für Module, etc. * Manages the various module settings
* *
* @author Tino Goratsch * @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/ */
abstract class Config abstract class Config {
{
/** /**
* Gibt die Systemeinstellungen aus * Gibt die Systemeinstellungen aus
*/ */
public static function getSystemSettings() public static function getSystemSettings() {
{
$settings = self::getSettings('system'); $settings = self::getSettings('system');
foreach ($settings as $key => $value) { foreach ($settings as $key => $value) {
define('CONFIG_' . strtoupper($key), $value); define('CONFIG_' . strtoupper($key), $value);
} }
return; return;
} }
/** /**
* Erstellt/Verändert die Konfigurationsdateien für die Module * Erstellt/Verändert die Konfigurationsdateien für die Module
* *
...@@ -37,8 +28,7 @@ abstract class Config ...@@ -37,8 +28,7 @@ abstract class Config
* @param array $data * @param array $data
* @return boolean * @return boolean
*/ */
public static function setSettings($module, $data) public static function setSettings($module, $data) {
{
$bool = $bool2 = false; $bool = $bool2 = false;
$mod_id = Registry::get('Db')->fetchColumn('SELECT id FROM ' . DB_PRE . 'modules WHERE name = ?', array($module)); $mod_id = Registry::get('Db')->fetchColumn('SELECT id FROM ' . DB_PRE . 'modules WHERE name = ?', array($module));
if (!empty($mod_id)) { if (!empty($mod_id)) {
...@@ -50,27 +40,27 @@ abstract class Config ...@@ -50,27 +40,27 @@ abstract class Config
return $bool !== false && $bool2 !== false ? true : false; return $bool !== false && $bool2 !== false ? true : false;
} }
/** /**
* Gibt den Inhalt der Konfigurationsdateien der Module aus * Gibt den Inhalt der Konfigurationsdateien der Module aus
* *
* @param string $module * @param string $module
* @return array * @return array
*/ */
public static function getSettings($module) public static function getSettings($module) {
{
if (Cache::check($module, 'settings') === false) if (Cache::check($module, 'settings') === false)
self::setModuleCache($module); self::setModuleCache($module);
return Cache::output($module, 'settings'); return Cache::output($module, 'settings');
} }
/** /**
* Setzt den Cache für die Einstellungen eines Moduls * Setzt den Cache für die Einstellungen eines Moduls
* *
* @param string $module * @param string $module
* @return boolean * @return boolean
*/ */
private static function setModuleCache($module) private static function setModuleCache($module) {
{
$settings = Registry::get('Db')->executeQuery('SELECT s.name, s.value FROM ' . DB_PRE . 'settings AS s JOIN ' . DB_PRE . 'modules AS m ON(m.id = s.module_id) WHERE m.name = ?', array($module))->fetchAll(); $settings = Registry::get('Db')->executeQuery('SELECT s.name, s.value FROM ' . DB_PRE . 'settings AS s JOIN ' . DB_PRE . 'modules AS m ON(m.id = s.module_id) WHERE m.name = ?', array($module))->fetchAll();
$c_settings = count($settings); $c_settings = count($settings);
...@@ -86,4 +76,5 @@ abstract class Config ...@@ -86,4 +76,5 @@ abstract class Config
return Cache::create($module, $cache_ary, 'settings'); return Cache::create($module, $cache_ary, 'settings');
} }
} }
\ No newline at end of file
<?php <?php
/**
* Date
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core; namespace ACP3\Core;
/** /**
* Stellt Funktionen zur Datumsformatierung und Ausrichtung an den Zeitzonen bereit * Stellt Funktionen zur Datumsformatierung und Ausrichtung an den Zeitzonen bereit
* *
* @author Tino Goratsch * @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/ */
class Date { class Date {
......
<?php <?php
namespace ACP3\Core;
/** /**
* Diese Datei ist für die häufig verwendeten Funktionen im ACP3 zuständig * Manages the most used functions in the ACP3
* *
* @author Tino Goratsch * @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/ */
namespace ACP3\Core;
abstract class Functions { abstract class Functions {
/** /**
......
<?php <?php
/**
* Image
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core; namespace ACP3\Core;
/** /**
* Klasse zum beliebigen Skalieren und Ausgeben von Bildern * Klasse zum beliebigen Skalieren und Ausgeben von Bildern
* *
* @author Tino Goratsch * @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/ */
class Image class Image
{ {
......
<?php <?php
/**
* Language
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core; namespace ACP3\Core;
/** /**
* Stellt Funktionen bereit, um das ACP3 in verschiedene Sprachen zu übersetzen * Stellt Funktionen bereit, um das ACP3 in verschiedene Sprachen zu übersetzen
* *
* @author Tino Goratsch * @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/ */
class Lang class Lang
{ {
......
...@@ -3,9 +3,9 @@ ...@@ -3,9 +3,9 @@
namespace ACP3\Core; namespace ACP3\Core;
/** /**
* Description of ModuleController * Module controller
* *
* @author Tino * @author Tino Goratsch
*/ */
abstract class ModuleController { abstract class ModuleController {
......
<?php <?php
/**
* Module Installer
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core; namespace ACP3\Core;
/** /**
* Module Installer Klasse * Module Installer Klasse
* *
* @author Tino Goratsch * @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/ */
abstract class ModuleInstaller { abstract class ModuleInstaller {
......
<?php <?php
/**
* Modules
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core; namespace ACP3\Core;
/** /**
* Klasse für die Module * Klasse für die Module
* *
* @author Tino Goratsch * @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/ */
abstract class Modules { abstract class Modules {
......
<?php <?php
/**
* Nested Sets
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core; namespace ACP3\Core;
/** /**
...@@ -14,8 +6,6 @@ namespace ACP3\Core; ...@@ -14,8 +6,6 @@ namespace ACP3\Core;
* Umsortieren von Knoten in einem Nested Set Baum * Umsortieren von Knoten in einem Nested Set Baum
* *
* @author Tino Goratsch * @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/ */
class NestedSet { class NestedSet {
......
...@@ -2,9 +2,9 @@ ...@@ -2,9 +2,9 @@
namespace ACP3\Core; namespace ACP3\Core;
/** /**
* Description of Registry * Class Registry
* *
* @author goratsch * @author Tino Goratsch
*/ */
abstract class Registry { abstract class Registry {
private static $registry = array(); private static $registry = array();
......
<?php <?php
/**
* SEO
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core; namespace ACP3\Core;
/** /**
* Klasse zum Setzen von URI Aliases, Keywords und Beschreibungen für Seiten * Klasse zum Setzen von URI Aliases, Keywords und Beschreibungen für Seiten
* *
* @author Tino Goratsch * @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/ */
abstract class SEO abstract class SEO
{ {
......
<?php <?php
/**
* Sessions
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core; namespace ACP3\Core;
/** /**
...@@ -14,8 +6,6 @@ namespace ACP3\Core; ...@@ -14,8 +6,6 @@ namespace ACP3\Core;
* Diese ist zuständig für das Sessionhandling in der Datenbank * Diese ist zuständig für das Sessionhandling in der Datenbank
* *
* @author Tino Goratsch * @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/ */
class Session { class Session {
/** /**
......
<?php <?php
/**
* URI
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core; namespace ACP3\Core;
/** /**
* Verarbeitet die URI Query * URI Router
* *
* @author Tino Goratsch * @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/ */
class URI { class URI {
......
<?php <?php
/**
* Validate
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core; namespace ACP3\Core;
/** /**
* Klasse zur Validierung von bestimmten Einträgen * Klasse zur Validierung von bestimmten Einträgen
* *
* @author Tino Goratsch * @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/ */
abstract class Validate { abstract class Validate {
......
<?php <?php
/**
* View
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core; namespace ACP3\Core;
/** /**
* Klasse für die Ausgabe der Seite * Klasse für die Ausgabe der Seite
* *
* @author Tino Goratsch * @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/ */
class View class View
{ {
......
<?php <?php
namespace ACP3\Core\View; namespace ACP3\Core\View;
/**
* Abstract Class for the various renderers
*/
abstract class AbstractRenderer { abstract class AbstractRenderer {
protected $config = array(); protected $config = array();
public $renderer = null; public $renderer = null;
......
<?php <?php
namespace ACP3\Core\View; namespace ACP3\Core\View;
/**
* Renderer for the output of RSS and ATOM newsfeeds
*/
class FeedGenerator extends AbstractRenderer { class FeedGenerator extends AbstractRenderer {
public function __construct($params) public function __construct($params)
{ {
......
...@@ -2,6 +2,9 @@ ...@@ -2,6 +2,9 @@
namespace ACP3\Core\View; namespace ACP3\Core\View;
/**
* Renderer for the Smarty template engine
*/
class Smarty extends AbstractRenderer { class Smarty extends AbstractRenderer {
/** /**
* *
......
...@@ -3,9 +3,9 @@ ...@@ -3,9 +3,9 @@
namespace ACP3\Core; namespace ACP3\Core;
/** /**
* Description of WYSIWYG * Wrapper class for the WYSIWYG editors
* *
* @author goratsch * @author Tino Goratsch
*/ */
class WYSIWYG { class WYSIWYG {
......
...@@ -2,9 +2,9 @@ ...@@ -2,9 +2,9 @@
namespace ACP3\Core\WYSIWYG; namespace ACP3\Core\WYSIWYG;
/** /**
* Description of AbstractWYSIWYG * Abstract Class for the various WYSIWYG editors
* *
* @author goratsch * @author Tino Goratsch
*/ */
abstract class AbstractWYSIWYG { abstract class AbstractWYSIWYG {
/** /**
......
...@@ -2,6 +2,9 @@ ...@@ -2,6 +2,9 @@
namespace ACP3\Core\WYSIWYG; namespace ACP3\Core\WYSIWYG;
/**