docblocks+api functions

This commit is contained in:
Dennis Eichhorn 2018-02-17 18:31:04 +01:00
parent e953e0cebe
commit ba7cfc9abf
7 changed files with 46 additions and 16 deletions

View File

@ -4,7 +4,7 @@
* *
* PHP Version 7.1 * PHP Version 7.1
* *
* @package Modules\Admin\Install\Providing * @package Modules\Admin\Admin\Install
* @copyright Dennis Eichhorn * @copyright Dennis Eichhorn
* @license OMS License 1.0 * @license OMS License 1.0
* @version 1.0.0 * @version 1.0.0
@ -19,7 +19,7 @@ use phpOMS\DataStorage\Database\DatabasePool;
/** /**
* Navigation class. * Navigation class.
* *
* @package Modules\Admin\Install\Providing * @package Modules\Admin\Admin\Install
* @license OMS License 1.0 * @license OMS License 1.0
* @link http://website.orange-management.de * @link http://website.orange-management.de
* @since 1.0.0 * @since 1.0.0

View File

@ -4,7 +4,7 @@
* *
* PHP Version 7.1 * PHP Version 7.1
* *
* @package Modules\Admin\Install * @package Modules\Admin\Admin
* @copyright Dennis Eichhorn * @copyright Dennis Eichhorn
* @license OMS License 1.0 * @license OMS License 1.0
* @version 1.0.0 * @version 1.0.0
@ -19,7 +19,7 @@ use phpOMS\Stdlib\Base\Enum;
/** /**
* Install type enum. * Install type enum.
* *
* @package Modules\Admin\Install * @package Modules\Admin\Admin
* @license OMS License 1.0 * @license OMS License 1.0
* @link http://website.orange-management.de * @link http://website.orange-management.de
* @since 1.0.0 * @since 1.0.0

View File

@ -4,7 +4,7 @@
* *
* PHP Version 7.1 * PHP Version 7.1
* *
* @package Modules\Admin\Install * @package Modules\Admin\Admin
* @copyright Dennis Eichhorn * @copyright Dennis Eichhorn
* @license OMS License 1.0 * @license OMS License 1.0
* @version 1.0.0 * @version 1.0.0
@ -22,7 +22,7 @@ use phpOMS\Module\InstallerAbstract;
/** /**
* Admin install class. * Admin install class.
* *
* @package Modules\Admin\Install * @package Modules\Admin\Admin
* @license OMS License 1.0 * @license OMS License 1.0
* @link http://website.orange-management.de * @link http://website.orange-management.de
* @since 1.0.0 * @since 1.0.0
@ -271,7 +271,17 @@ class Installer extends InstallerAbstract
} }
} }
public static function installExternal(DatabasePool $dbPool, array $data) /**
* Provide group and permission install for other modules
*
* @param DatabasePool $dbPool Database pool
* @param array $data Data to install
*
* @return void
*
* @since 1.0.0
*/
public static function installExternal(DatabasePool $dbPool, array $data) /* : void */
{ {
foreach ($data as $type => $element) { foreach ($data as $type => $element) {
if ($type === InstallType::PERMISSION) { if ($type === InstallType::PERMISSION) {
@ -282,7 +292,17 @@ class Installer extends InstallerAbstract
} }
} }
public static function installPermission(DatabasePool $dbPool, array $data) /**
* Install permission
*
* @param DatabasePool $dbPool Database pool
* @param array $data Data to install
*
* @return void
*
* @since 1.0.0
*/
public static function installPermission(DatabasePool $dbPool, array $data) /* : void */
{ {
$sth = $dbPool->get()->con->prepare( $sth = $dbPool->get()->con->prepare(
'INSERT INTO `' . $dbPool->get()->prefix . 'permission` (`permission_id`, `permission_name`, `permission_description`) VALUES 'INSERT INTO `' . $dbPool->get()->prefix . 'permission` (`permission_id`, `permission_name`, `permission_description`) VALUES
@ -300,7 +320,17 @@ class Installer extends InstallerAbstract
$lastInsertID = $dbPool->get()->con->lastInsertId(); $lastInsertID = $dbPool->get()->con->lastInsertId();
} }
public static function installGroup(DatabasePool $dbPool, array $data) /**
* Install group
*
* @param DatabasePool $dbPool Database pool
* @param array $data Data to install
*
* @return void
*
* @since 1.0.0
*/
public static function installGroup(DatabasePool $dbPool, array $data) /* : void */
{ {
$sth = $dbPool->get()->con->prepare( $sth = $dbPool->get()->con->prepare(
'INSERT INTO `' . $dbPool->get()->prefix . 'group` (`group_id`, `group_name`, `group_description`) VALUES 'INSERT INTO `' . $dbPool->get()->prefix . 'group` (`group_id`, `group_name`, `group_description`) VALUES

View File

@ -4,7 +4,7 @@
* *
* PHP Version 7.1 * PHP Version 7.1
* *
* @package Modules\Admin\Install * @package Modules\Admin\Admin
* @copyright Dennis Eichhorn * @copyright Dennis Eichhorn
* @license OMS License 1.0 * @license OMS License 1.0
* @version 1.0.0 * @version 1.0.0
@ -21,7 +21,7 @@ use phpOMS\Module\InfoManager;
/** /**
* Activate class. * Activate class.
* *
* @package Modules\Admin\Install * @package Modules\Admin\Admin
* @license OMS License 1.0 * @license OMS License 1.0
* @link http://website.orange-management.de * @link http://website.orange-management.de
* @since 1.0.0 * @since 1.0.0

View File

@ -4,7 +4,7 @@
* *
* PHP Version 7.1 * PHP Version 7.1
* *
* @package Modules\Admin\Install * @package Modules\Admin\Admin
* @copyright Dennis Eichhorn * @copyright Dennis Eichhorn
* @license OMS License 1.0 * @license OMS License 1.0
* @version 1.0.0 * @version 1.0.0
@ -21,7 +21,7 @@ use phpOMS\Module\InfoManager;
/** /**
* Uninstall class. * Uninstall class.
* *
* @package Modules\Admin\Install * @package Modules\Admin\Admin
* @license OMS License 1.0 * @license OMS License 1.0
* @link http://website.orange-management.de * @link http://website.orange-management.de
* @since 1.0.0 * @since 1.0.0

View File

@ -4,7 +4,7 @@
* *
* PHP Version 7.1 * PHP Version 7.1
* *
* @package Modules\Admin\Install * @package Modules\Admin\Admin
* @copyright Dennis Eichhorn * @copyright Dennis Eichhorn
* @license OMS License 1.0 * @license OMS License 1.0
* @version 1.0.0 * @version 1.0.0
@ -22,7 +22,7 @@ use phpOMS\System\File\Directory;
/** /**
* Update class. * Update class.
* *
* @package Modules\Admin\Install * @package Modules\Admin\Admin
* @license OMS License 1.0 * @license OMS License 1.0
* @link http://website.orange-management.de * @link http://website.orange-management.de
* @since 1.0.0 * @since 1.0.0

View File

@ -44,7 +44,7 @@ use phpOMS\Views\View;
* *
* This class is responsible for the basic admin activities such as managing accounts, groups, permissions and modules. * This class is responsible for the basic admin activities such as managing accounts, groups, permissions and modules.
* *
* @package Modules * @package Modules\Admin
* @license OMS License 1.0 * @license OMS License 1.0
* @link http://website.orange-management.de * @link http://website.orange-management.de
* @since 1.0.0 * @since 1.0.0