Skip to content

Commit

Permalink
#2 package readme added
Browse files Browse the repository at this point in the history
  • Loading branch information
1stthomas committed May 24, 2021
1 parent 417ad9b commit 9a3a70d
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 2 deletions.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,20 @@
# ht7-concrete5-base
# ht7-concrete5-base - ht7_c5_base #

This is the base package for all ht7 concrete5 package. It provides the base dashboard page
architecture and some basic functionallity.

## Developer Notes ##

### Helper classes ###

#### PackageBase ####
This class determines the package from an instance of a class of the searched package.
Therfor no need to hardcode the package handle everywhere its needed. Simple retrive
this helper, call the related method with an instance of a class from the searched
package and get the package or its handle, depending on the called method.

This class provides also methods to gain the related package file/db config.

#### File Name Fixer ####
concrete 5 can not handle page paths with a dash ("-"). This helper can tranform page names with a "_"
into "-".
2 changes: 1 addition & 1 deletion controller.php
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ private function installUserGroups()
{
Group::add(
tc('ht7_c5_base-group_name', 'ht7'),
tc('ht7_c5_base', 'Base Group for ht7 applications.'),
tc('ht7_c5_base-group_name', 'Base Group for ht7 applications.'),
false,
$this->pkg
);
Expand Down

0 comments on commit 9a3a70d

Please sign in to comment.