improved the docs a bit

parent 300070c1
<?php
namespace ACP3;
/**
* Front Controller of the CMS
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3;
class Application {
/**
......
<?php
/**
* Access Control List
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core;
/**
* ACL Klasse
* Access control lists
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
abstract class ACL
{
......
<?php
/**
* Authentification
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core;
/**
* Authentifiziert den Benutzer
* Authenticates the user
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
class Auth
{
......
<?php
/**
* Breadcrumbs
*
* @author Tino Goratsch
* @package ACP3
* @subpackage 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
* @package ACP3
* @subpackage Core
*/
class Breadcrumb {
......
<?php
/**
* Cache
*
* @author Tino Goratsch
* @package ACP3
* @subpackage 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
* @package ACP3
* @subpackage Core
*/
abstract class Cache
{
......
<?php
/**
* Config
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core;
use \ACP3\Core\Cache;
/**
* Erstellt die jeweiligen Konfigurationsdateien für Module, etc.
* Manages the various module settings
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
abstract class Config
{
abstract class Config {
/**
* Gibt die Systemeinstellungen aus
*/
public static function getSystemSettings()
{
public static function getSystemSettings() {
$settings = self::getSettings('system');
foreach ($settings as $key => $value) {
define('CONFIG_' . strtoupper($key), $value);
}
return;
}
/**
* Erstellt/Verändert die Konfigurationsdateien für die Module
*
......@@ -37,8 +28,7 @@ abstract class Config
* @param array $data
* @return boolean
*/
public static function setSettings($module, $data)
{
public static function setSettings($module, $data) {
$bool = $bool2 = false;
$mod_id = Registry::get('Db')->fetchColumn('SELECT id FROM ' . DB_PRE . 'modules WHERE name = ?', array($module));
if (!empty($mod_id)) {
......@@ -50,27 +40,27 @@ abstract class Config
return $bool !== false && $bool2 !== false ? true : false;
}
/**
* Gibt den Inhalt der Konfigurationsdateien der Module aus
*
* @param string $module
* @return array
*/
public static function getSettings($module)
{
public static function getSettings($module) {
if (Cache::check($module, 'settings') === false)
self::setModuleCache($module);
return Cache::output($module, 'settings');
}
/**
* Setzt den Cache für die Einstellungen eines Moduls
*
* @param string $module
* @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();
$c_settings = count($settings);
......@@ -86,4 +76,5 @@ abstract class Config
return Cache::create($module, $cache_ary, 'settings');
}
}
\ No newline at end of file
<?php
/**
* Date
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core;
/**
* Stellt Funktionen zur Datumsformatierung und Ausrichtung an den Zeitzonen bereit
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
class Date {
......
<?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
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core;
abstract class Functions {
/**
......
<?php
/**
* Image
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core;
/**
* Klasse zum beliebigen Skalieren und Ausgeben von Bildern
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
class Image
{
......
<?php
/**
* Language
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core;
/**
* Stellt Funktionen bereit, um das ACP3 in verschiedene Sprachen zu übersetzen
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
class Lang
{
......
......@@ -3,9 +3,9 @@
namespace ACP3\Core;
/**
* Description of ModuleController
* Module controller
*
* @author Tino
* @author Tino Goratsch
*/
abstract class ModuleController {
......
<?php
/**
* Module Installer
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core;
/**
* Module Installer Klasse
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
abstract class ModuleInstaller {
......
<?php
/**
* Modules
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core;
/**
* Klasse für die Module
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
abstract class Modules {
......
<?php
/**
* Nested Sets
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core;
/**
......@@ -14,8 +6,6 @@ namespace ACP3\Core;
* Umsortieren von Knoten in einem Nested Set Baum
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
class NestedSet {
......
......@@ -2,9 +2,9 @@
namespace ACP3\Core;
/**
* Description of Registry
* Class Registry
*
* @author goratsch
* @author Tino Goratsch
*/
abstract class Registry {
private static $registry = array();
......
<?php
/**
* SEO
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core;
/**
* Klasse zum Setzen von URI Aliases, Keywords und Beschreibungen für Seiten
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
abstract class SEO
{
......
<?php
/**
* Sessions
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core;
/**
......@@ -14,8 +6,6 @@ namespace ACP3\Core;
* Diese ist zuständig für das Sessionhandling in der Datenbank
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
class Session {
/**
......
<?php
/**
* URI
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core;
/**
* Verarbeitet die URI Query
* URI Router
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
class URI {
......
<?php
/**
* Validate
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core;
/**
* Klasse zur Validierung von bestimmten Einträgen
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
abstract class Validate {
......
<?php
/**
* View
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core;
/**
* Klasse für die Ausgabe der Seite
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
class View
{
......
<?php
namespace ACP3\Core\View;
/**
* Abstract Class for the various renderers
*/
abstract class AbstractRenderer {
protected $config = array();
public $renderer = null;
......
<?php
namespace ACP3\Core\View;
/**
* Renderer for the output of RSS and ATOM newsfeeds
*/
class FeedGenerator extends AbstractRenderer {
public function __construct($params)
{
......
......@@ -2,6 +2,9 @@
namespace ACP3\Core\View;
/**
* Renderer for the Smarty template engine
*/
class Smarty extends AbstractRenderer {
/**
*
......
......@@ -3,9 +3,9 @@
namespace ACP3\Core;
/**
* Description of WYSIWYG
* Wrapper class for the WYSIWYG editors
*
* @author goratsch
* @author Tino Goratsch
*/
class WYSIWYG {
......
......@@ -2,9 +2,9 @@
namespace ACP3\Core\WYSIWYG;
/**
* Description of AbstractWYSIWYG
* Abstract Class for the various WYSIWYG editors
*
* @author goratsch
* @author Tino Goratsch
*/
abstract class AbstractWYSIWYG {
/**
......
......@@ -2,6 +2,9 @@
namespace ACP3\Core\WYSIWYG;
/**
* Implementation of the AbstractWYSIWYG class for CKEditor
*/
class CKEditor extends AbstractWYSIWYG {
public function __construct($id, $name, $value = '', $toolbar = '', $advanced = false, $height = '') {
$this->id = $id;
......
<?php
namespace ACP3\Core\WYSIWYG;
namespace ACP3\Core\WYSIWYG;
/**
* Description of Textarea
*
* @author goratsch
* Implementation of the AbstractWYSIWYG class for a simple Textarea
*/
class Textarea extends AbstractWYSIWYG {
public function __construct($id, $name, $value = '', $toolbar = '', $advanced = false, $height = '') {
$this->id = $id;
$this->name = $name;
......@@ -28,6 +27,6 @@ class Textarea extends AbstractWYSIWYG {
}
$out.= '<textarea name="' . $this->name . '" id="' . $this->id . '" cols="50" rows="6" class="span6">' . $this->value . '</textarea>';
return $out;
}
}
\ No newline at end of file
......@@ -2,6 +2,9 @@
namespace ACP3\Core\WYSIWYG;
/**
* Implementation of the AbstractWYSIWYG class for TinyMCE
*/
class TinyMCE extends AbstractWYSIWYG {
public function __construct($id, $name, $value = '', $toolbar = '', $advanced = false, $height = '') {
......
<?php
/**
* XML Parser
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Core;
/**
* Parst XML Dateien, z.B. die diversen info.xml bzw. module.xml Dateien
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
abstract class XML {
......
<?php
namespace ACP3\Installer;
/**
* Front Controller of the Installer
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Core
*/
namespace ACP3\Installer;
class Application {
/**
* Führt alle nötigen Schritte aus, um die Seite anzuzeigen
* run Methode für den Installer
*/
public static function runInstaller() {
self::defineDirConstants();
......@@ -21,7 +20,7 @@ class Application {
}
/**
*
* rund() Methode für den Database Updater
*/
public static function runUpdater() {
self::defineDirConstants();
......
......@@ -4,10 +4,9 @@ namespace ACP3\Installer\Core;
use ACP3\Core;
/**
* Ist für die häufig verwendeten Funktionen im Installer zuständig
* Manages the most used function of the installer
*
* @author Tino Goratsch
* @package ACP3 Installer
*/
abstract class Functions {
......
<?php
/**
* Language
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Installer
*/
namespace ACP3\Installer\Core;
/**
* Stellt Funktionen bereit, um das ACP3 in verschiendene Sprachen zu übersetzen
*
* @author Tino Goratsch
* @package ACP3
* @subpackage Installer
*/
class InstallerLang extends \ACP3\Core\Lang
{
function __construct($lang)
{
class InstallerLang extends \ACP3\Core\Lang {
function __construct($lang) {
$this->lang = $lang;
}
/**
* Cached die Sprachfiles, um diese schneller verarbeiten zu können
*/
private function parseLanguageFile()
{
private function parseLanguageFile() {
$data = array();
$path = ACP3_ROOT_DIR . 'installation/languages/' . $this->lang . '.xml';
if (is_file($path) === true) {
......@@ -38,14 +28,14 @@ class InstallerLang extends \ACP3\Core\Lang
}
return $data;
}
/**
* Gibt den angeforderten Sprachstring aus
*
* @param string $key
* @return string
*/
public function t($key, $unused = '')
{
public function t($key, $unused = '') {
static $lang_data = array();
if (empty($lang_data)) {
......@@ -54,14 +44,15 @@ class InstallerLang extends \ACP3\Core\Lang
return isset($lang_data[$key]) ? $lang_data[$key] : strtoupper('{' . $key . '}');
}
/**
* Überprüft, ob das angegebene Sprachpaket existiert
*
* @param string $lang
* @return boolean
*/
public static function languagePackExists($lang)
{
public static function languagePackExists($lang) {
return !preg_match('=/=', $lang) && is_file(ACP3_ROOT_DIR . 'installation/languages/' . $lang . '.xml') === true;
}
}
\ No newline at end of file
<?php
namespace ACP3\Installer\Core;
use ACP3\Core;
/**
* Description of InstallerModuleController
* Module Controller of the installer modules
*
* @author goratsch
* @author Tino Goratsch
*/
class InstallerModuleController extends Core\ModuleController {
public function display()
{
public function display() {
$view =