diff --git a/README.md b/README.md old mode 100644 new mode 100755 diff --git a/SUMMARY.md b/SUMMARY.md old mode 100644 new mode 100755 index e69c40d..b8c33cd --- a/SUMMARY.md +++ b/SUMMARY.md @@ -13,15 +13,24 @@ * [Html Coding Standards]({%}?page=standards/html) * [Php Coding Standards]({%}?page=standards/php) -## Examples +## Application Examples * [Application Sample]({%}?page=example_app/app) * [Modules]({%}?page=example_module/module) * [Packages]({%}?page=example_module/packages) - -## Application Specific * [Language Files]({%}?page=basics/language_files) ## API + +### Backend +* [Codes]({%}?page=services/codes) +* [Routing]({%}?page=basics/routing) +* [Dispatching]({%}?page=basics/dispatching) +* [Views]({%}?page=basics/views) +* [Validation]({%}?page=services/validation) + +### Frontend +* [Notifications]({%}?page=frontend/notifications) + ### Message * [Uri]({%}?page=services/uri) * [Requests]({%}?page=basics/requests) @@ -49,15 +58,27 @@ * [Queues]({%}?page=services/queues) * [Collection]({%}?page=services/collection) -### UI -* [Styles and Layout]({%}?page=frontend/styles_and_layout) -* [Charting]({%}?page=services/charting) -* [Codes]({%}?page=services/codes) -* [Routing]({%}?page=basics/routing) -* [Dispatching]({%}?page=basics/dispatching) -* [Views]({%}?page=basics/views) -* [Validation]({%}?page=services/validation) - ### Security * [Encoding]({%}?page=services/encoding) -* [Encryption]({%}?page=services/encryption) \ No newline at end of file +* [Encryption]({%}?page=services/encryption) + +## UI + +### Layout + +* [Tables]({%}?page=frontend/elements/tables/tables) +* [Data selection]({%}?page=frontend/elements/dataselection/dataselection) +* [Alerts]({%}?page=frontend/elements/alerts/alerts) +* [Buttons]({%}?page=frontend/elements/buttons/buttons) +* [Tags]({%}?page=frontend/elements/tags/tags) +* [Panels]({%}?page=frontend/elements/panels/panels) +* [Tabs]({%}?page=frontend/elements/tabs/tabs) +* [Breadcrumbs]({%}?page=frontend/elements/breadcrumbs/breadcrumbs) +* [Progress]({%}?page=frontend/elements/progress/progress) +* [Layout]({%}?page=frontend/grid/grid) +* [Charting]({%}?page=services/charting) + +### Forms +* [Forms]({%}?page=frontend/elements/forms/forms) +* [Inputs]({%}?page=frontend/elements/inputs/inputs) +* [Tables]({%}?page=frontend/elements/tables/tables) diff --git a/basics/dispatching.md b/basics/dispatching.md old mode 100644 new mode 100755 diff --git a/basics/language_files.md b/basics/language_files.md old mode 100644 new mode 100755 index 24a18eb..76598a2 --- a/basics/language_files.md +++ b/basics/language_files.md @@ -13,14 +13,14 @@ The content of the language files is very simple. All you need is the module nam ```php true` as column information to the respective column. ```php -public COLUMNS = [ +public const COLUMNS = [ 'db_field_name_1' => ['name' => 'db_field_name_1', 'type' => 'int', 'internal' => 'model_var_name_1', 'autocomplete' => true], 'db_field_name_2' => ['name' => 'db_field_name_2', 'type' => 'string', 'internal' => 'model_var_name_2'], ]; diff --git a/datastorage/database/queries.md b/datastorage/database/queries.md old mode 100644 new mode 100755 diff --git a/datastorage/localstorage.md b/datastorage/localstorage.md old mode 100644 new mode 100755 diff --git a/datastorage/session.md b/datastorage/session.md old mode 100644 new mode 100755 diff --git a/example_app/app.md b/example_app/app.md old mode 100644 new mode 100755 diff --git a/example_module/module.md b/example_module/module.md old mode 100644 new mode 100755 index ac863f7..f5291f0 --- a/example_module/module.md +++ b/example_module/module.md @@ -334,11 +334,11 @@ The `info.json` file contains general module information used during installatio ### Name -The name category contains the names used for internal as well as external identification. Both `id` and `internal` are globally unique between all modules and is assigned generated by Orange Management. The `id` can also be used by other modules which need integer identification of modules. The `id` has the form `xxxxx00000` which means, that modules don't only occupy a single id but a range of ids. This can be useful for other modules where additional module specific information need to be assigned (e.g. `Navigation` module). The `external` name is the name the creator of the module can give the module. This is the name that will be used during searches for modules and shown to customers. +The name category contains the names used for internal as well as external identification. Both `id` and `internal` are globally unique between all modules and is assigned generated by Karaka. The `id` can also be used by other modules which need integer identification of modules. The `id` has the form `xxxxx00000` which means, that modules don't only occupy a single id but a range of ids. This can be useful for other modules where additional module specific information need to be assigned (e.g. `Navigation` module). The `external` name is the name the creator of the module can give the module. This is the name that will be used during searches for modules and shown to customers. ### Version -The version is automatically incremented by Orange Management. The version might be used by other modules in order to require a specific version of a module. Versions must follow the following format: +The version is automatically incremented by Karaka. The version might be used by other modules in order to require a specific version of a module. Versions must follow the following format: ```js major.minor.build = 2.512.19857 diff --git a/example_module/packages.md b/example_module/packages.md old mode 100644 new mode 100755 diff --git a/example_module/update.md b/example_module/update.md old mode 100644 new mode 100755 diff --git a/frontend/elements/alerts/alerts.md b/frontend/elements/alerts/alerts.md new file mode 100644 index 0000000..80f99f5 --- /dev/null +++ b/frontend/elements/alerts/alerts.md @@ -0,0 +1,50 @@ +# Alerts + +Alerts are boxes styled in such a way that they attract the attention of the user which makes them ideal to provide important information to the user. Alerts are often used on a page header, footer or as popup. + +## Examples + +### Ok + +![Alert ok](Developer-Guide/frontend/elements/alerts/ok.png) + +```html +
This is ok
+``` + +#### Advanced + +![Alert ok advanced](Developer-Guide/frontend/elements/alerts/ok_advanced.png) + +```html +
+

This is a Title

+
This is a message
+
+``` + +### Info + +![Alert info](Developer-Guide/frontend/elements/alerts/info.png) + +```html +
This is a info
+``` + +### Warning + +![Alert warning](Developer-Guide/frontend/elements/alerts/warning.png) + +```html +
This is a warning
+``` + +### Error + +![Alert error](Developer-Guide/frontend/elements/alerts/error.png) + +```html +
This is an error
+``` + + diff --git a/frontend/elements/alerts/error.png b/frontend/elements/alerts/error.png new file mode 100644 index 0000000..bda37a9 Binary files /dev/null and b/frontend/elements/alerts/error.png differ diff --git a/frontend/elements/alerts/info.png b/frontend/elements/alerts/info.png new file mode 100644 index 0000000..8695fa2 Binary files /dev/null and b/frontend/elements/alerts/info.png differ diff --git a/frontend/elements/alerts/ok.png b/frontend/elements/alerts/ok.png new file mode 100644 index 0000000..9b804e0 Binary files /dev/null and b/frontend/elements/alerts/ok.png differ diff --git a/frontend/elements/alerts/ok_advanced.png b/frontend/elements/alerts/ok_advanced.png new file mode 100644 index 0000000..0b77be1 Binary files /dev/null and b/frontend/elements/alerts/ok_advanced.png differ diff --git a/frontend/elements/alerts/warning.png b/frontend/elements/alerts/warning.png new file mode 100644 index 0000000..faf441f Binary files /dev/null and b/frontend/elements/alerts/warning.png differ diff --git a/frontend/elements/breadcrumbs/breadcrumbs.md b/frontend/elements/breadcrumbs/breadcrumbs.md new file mode 100644 index 0000000..c464506 --- /dev/null +++ b/frontend/elements/breadcrumbs/breadcrumbs.md @@ -0,0 +1,17 @@ +# Breadcrumbs + +Breadcrumbs provide a visual feedback to the user at which step/location the user currently is. + +## Examples + +![Breadcrumb](Developer-Guide/frontend/elements/breadcrumbs/normal.png) + +```html + +``` \ No newline at end of file diff --git a/frontend/elements/breadcrumbs/normal.png b/frontend/elements/breadcrumbs/normal.png new file mode 100644 index 0000000..a1e6930 Binary files /dev/null and b/frontend/elements/breadcrumbs/normal.png differ diff --git a/frontend/elements/buttons/buttons.md b/frontend/elements/buttons/buttons.md new file mode 100644 index 0000000..0c8e1c9 --- /dev/null +++ b/frontend/elements/buttons/buttons.md @@ -0,0 +1,95 @@ +# Buttons + +The following default button styles are available for the different user interactions. Buttons can be created with the `button` tag or the `a` link tag with a `button` class. + +## Examples + +### Normal + +![Button normal](Developer-Guide/frontend/elements/buttons/normal.png) + +![Button normal icon](Developer-Guide/frontend/elements/buttons/normal_icon.png) + +```html + + +``` + +Alternative: + +```html +Test Button + Test Button +``` + +### Cancel + +![Button cancel](Developer-Guide/frontend/elements/buttons/cancel.png) + +![Button cancel icon](Developer-Guide/frontend/elements/buttons/cancel_icon.png) + +```html + + +``` + +Alternative: + +```html +Test Button + Test Button +``` + +### Save + +![Button save](Developer-Guide/frontend/elements/buttons/save.png) + +![Button save icon](Developer-Guide/frontend/elements/buttons/save_icon.png) + +```html + + +``` + +Alternative: + +```html +Test Button + Test Button +``` + +### Close + +![Button close](Developer-Guide/frontend/elements/buttons/close.png) + +![Button close icon](Developer-Guide/frontend/elements/buttons/close_icon.png) + +```html + + +``` + +Alternative: + +```html +Test Button + Test Button +``` + +### Disabled + +![Button disabled](Developer-Guide/frontend/elements/buttons/disabled.png) + +![Button disabled icon](Developer-Guide/frontend/elements/buttons/disabled_icon.png) + +```html + + +``` + +Alternative: + +```html +Test Button + Test Button +``` \ No newline at end of file diff --git a/frontend/elements/buttons/cancel.png b/frontend/elements/buttons/cancel.png new file mode 100644 index 0000000..5b67007 Binary files /dev/null and b/frontend/elements/buttons/cancel.png differ diff --git a/frontend/elements/buttons/cancel_icon.png b/frontend/elements/buttons/cancel_icon.png new file mode 100644 index 0000000..64a6bd3 Binary files /dev/null and b/frontend/elements/buttons/cancel_icon.png differ diff --git a/frontend/elements/buttons/close.png b/frontend/elements/buttons/close.png new file mode 100644 index 0000000..a68a921 Binary files /dev/null and b/frontend/elements/buttons/close.png differ diff --git a/frontend/elements/buttons/close_icon.png b/frontend/elements/buttons/close_icon.png new file mode 100644 index 0000000..c87d2f0 Binary files /dev/null and b/frontend/elements/buttons/close_icon.png differ diff --git a/frontend/elements/buttons/disabled.png b/frontend/elements/buttons/disabled.png new file mode 100644 index 0000000..0b03f9a Binary files /dev/null and b/frontend/elements/buttons/disabled.png differ diff --git a/frontend/elements/buttons/disabled_icon.png b/frontend/elements/buttons/disabled_icon.png new file mode 100644 index 0000000..4a7ac9e Binary files /dev/null and b/frontend/elements/buttons/disabled_icon.png differ diff --git a/frontend/elements/buttons/normal.png b/frontend/elements/buttons/normal.png new file mode 100644 index 0000000..7a5860a Binary files /dev/null and b/frontend/elements/buttons/normal.png differ diff --git a/frontend/elements/buttons/normal_icon.png b/frontend/elements/buttons/normal_icon.png new file mode 100644 index 0000000..b76599d Binary files /dev/null and b/frontend/elements/buttons/normal_icon.png differ diff --git a/frontend/elements/buttons/save.png b/frontend/elements/buttons/save.png new file mode 100644 index 0000000..25a0520 Binary files /dev/null and b/frontend/elements/buttons/save.png differ diff --git a/frontend/elements/buttons/save_icon.png b/frontend/elements/buttons/save_icon.png new file mode 100644 index 0000000..1d8f0d7 Binary files /dev/null and b/frontend/elements/buttons/save_icon.png differ diff --git a/frontend/elements/panels/header_footer.png b/frontend/elements/panels/header_footer.png new file mode 100644 index 0000000..e51ddba Binary files /dev/null and b/frontend/elements/panels/header_footer.png differ diff --git a/frontend/elements/panels/panels.md b/frontend/elements/panels/panels.md new file mode 100644 index 0000000..080df9a --- /dev/null +++ b/frontend/elements/panels/panels.md @@ -0,0 +1,35 @@ +# Panels + +Panels are for displaying content (e.g. forms, text) in a uniform style across the application. + +## Example + +### Plain + +![Panel normal](Developer-Guide/frontend/elements/panels/plain.png) + +```html +
+
+
+
....
+
+
+
+``` + +### Header & footer + +![Panel header & footer](Developer-Guide/frontend/elements/panels/header_footer.png) + +```html +
+
+
+
Header
+
...
+
Footer
+
+
+
+``` \ No newline at end of file diff --git a/frontend/elements/panels/plain.png b/frontend/elements/panels/plain.png new file mode 100644 index 0000000..3f615c2 Binary files /dev/null and b/frontend/elements/panels/plain.png differ diff --git a/frontend/elements/progress/meter.png b/frontend/elements/progress/meter.png new file mode 100644 index 0000000..243c628 Binary files /dev/null and b/frontend/elements/progress/meter.png differ diff --git a/frontend/elements/progress/meter_striped.png b/frontend/elements/progress/meter_striped.png new file mode 100644 index 0000000..07d8469 Binary files /dev/null and b/frontend/elements/progress/meter_striped.png differ diff --git a/frontend/elements/progress/progress.md b/frontend/elements/progress/progress.md new file mode 100644 index 0000000..71b9271 --- /dev/null +++ b/frontend/elements/progress/progress.md @@ -0,0 +1,35 @@ +# Progress + +A progress bar can be used to show the prograss of a background process, milestone progress, etc. + +## Examples + +### Progres bar + +![Progress](Developer-Guide/frontend/elements/progress/progress.png) + +```html + +``` + +### Meter without stripes + +![Meter](Developer-Guide/frontend/elements/progress/meter.png) + +```html +
+ +
+``` + +#### Meter striped without animation + +![Meter striped](Developer-Guide/frontend/elements/progress/meter_striped.png) + +```html +
+ +
+``` + +For a meter with animations remove the `noanimation` class. \ No newline at end of file diff --git a/frontend/elements/progress/progress.png b/frontend/elements/progress/progress.png new file mode 100644 index 0000000..8ff26aa Binary files /dev/null and b/frontend/elements/progress/progress.png differ diff --git a/frontend/elements/tabs/accordion.png b/frontend/elements/tabs/accordion.png new file mode 100644 index 0000000..76af8a2 Binary files /dev/null and b/frontend/elements/tabs/accordion.png differ diff --git a/frontend/elements/tabs/highlighted_horizontal.png b/frontend/elements/tabs/highlighted_horizontal.png new file mode 100644 index 0000000..d19495e Binary files /dev/null and b/frontend/elements/tabs/highlighted_horizontal.png differ diff --git a/frontend/elements/tabs/highlighted_vertical.png b/frontend/elements/tabs/highlighted_vertical.png new file mode 100644 index 0000000..534bde9 Binary files /dev/null and b/frontend/elements/tabs/highlighted_vertical.png differ diff --git a/frontend/elements/tabs/more.png b/frontend/elements/tabs/more.png new file mode 100644 index 0000000..5529ba0 Binary files /dev/null and b/frontend/elements/tabs/more.png differ diff --git a/frontend/elements/tabs/more_open.png b/frontend/elements/tabs/more_open.png new file mode 100644 index 0000000..c761d24 Binary files /dev/null and b/frontend/elements/tabs/more_open.png differ diff --git a/frontend/elements/tabs/tabs.md b/frontend/elements/tabs/tabs.md new file mode 100644 index 0000000..fd6bc9d --- /dev/null +++ b/frontend/elements/tabs/tabs.md @@ -0,0 +1,107 @@ +# Tabs + +Tabs allow for further content segmentation by showing only selected content. + +## Examples + +### Horizontal + +![Tab highlighted](Developer-Guide/frontend/elements/tabs/highlighted_horizontal.png) + +```html +
+ +
+ +
+ Test content +
+ +
+

Test content 2

asdf

+
+
+
+``` + +> In order to remove the blue outline and white background color from the content section of the tab, replace the class name `tab-1` with `tab-2` + +### Vertical + +![Tab highlighted](Developer-Guide/frontend/elements/tabs/highlighted_vertical.png) + +```html +
+ +
+ +
+ Test content +
+ +
+

Test content 2

asdf

+
+
+
+``` + +> In order to remove the blue outline and white background color from the content section of the tab, replace the class name `tab-1` with `tab-2` + +### Accordion + +The accordion can show and hide multiple elements. This makes it possible to also hide or show all elements at the same time. + +![Accordion](Developer-Guide/frontend/elements/tabs/accordion.png) + +```html +
+ + +
+

...

+
+ + +
+

...

+
+ + +
+

...

+
+ + +
+

...

+
+
+``` + +### More + +With the more tab it's possible to show/hide content with a single click. This is perfect for created advanced content sections which should be initially hidden and only shown if the user desires to see them. + +![More](Developer-Guide/frontend/elements/tabs/more.png) + +![More open](Developer-Guide/frontend/elements/tabs/more_open.png) + +```html +
+ + +
+

...

+
+
+``` \ No newline at end of file diff --git a/frontend/elements/tags/dynamic_style.png b/frontend/elements/tags/dynamic_style.png new file mode 100644 index 0000000..2ca153c Binary files /dev/null and b/frontend/elements/tags/dynamic_style.png differ diff --git a/frontend/elements/tags/icon.png b/frontend/elements/tags/icon.png new file mode 100644 index 0000000..d10d28c Binary files /dev/null and b/frontend/elements/tags/icon.png differ diff --git a/frontend/elements/tags/normal.png b/frontend/elements/tags/normal.png new file mode 100644 index 0000000..5725c41 Binary files /dev/null and b/frontend/elements/tags/normal.png differ diff --git a/frontend/elements/tags/remove_icon.png b/frontend/elements/tags/remove_icon.png new file mode 100644 index 0000000..2b6bd04 Binary files /dev/null and b/frontend/elements/tags/remove_icon.png differ diff --git a/frontend/elements/tags/tags.md b/frontend/elements/tags/tags.md new file mode 100644 index 0000000..88f1bb0 --- /dev/null +++ b/frontend/elements/tags/tags.md @@ -0,0 +1,39 @@ +# Tags + +Tags or badges are often used to describe a category or type of an element. Alternatively they are also used to highlight dynamically added objects such as objects selected from a select/datalist/input list. + +## Examples + +### Plain + +![Tag normal](Developer-Guide/frontend/elements/tags/normal.png) + +```html +Test Tag +``` + +#### Color + +Since tags are often styled individually (e.g. per category, by user) we recommend to use inline style sheet for defining different background colors. + +![Tag colored](Developer-Guide/frontend/elements/tags/dynamic_style.png) + +```html +Test Tag +``` + +### Icon + +![Tag icon](Developer-Guide/frontend/elements/tags/icon.png) + +```html +Test Tag +``` + +### Remove and icon + +![Tag remove icon](Developer-Guide/frontend/elements/tags/remove_icon.png) + +```html +Test Tag +``` \ No newline at end of file diff --git a/frontend/grid/grid.md b/frontend/grid/grid.md new file mode 100644 index 0000000..fdafe55 --- /dev/null +++ b/frontend/grid/grid.md @@ -0,0 +1,90 @@ +# Layout + +The following layout allows you to define and structure content based on screen/browser window resoltion. Internally this implementation uses `flexbox`. + +## Examples + +![Grid](Developer-Guide/frontend/grid/grid.png) + +Available sizes are `xs-*`, `sm-*`, `md-*`, `lg-*` with a grid ranging from `1-12`. Every prefix (e.g. `xs-*`) represents a window size when it becomes active. It's also possible to combine them to define a layout for different browser window sizes. This is useful for different devices such as desktop, cellphone, tablet. + +* `xs-` extra small +* `sm-` small +* `md-` medium +* `lg-` large + + +```html +
+
+
 
+
+
+ +
+
+
 
+
+
+
 
+
+
+ +
+
+
 
+
+
+
 
+
+
+
 
+
+
+ +
+
+
 
+
+
+
 
+
+
+
 
+
+
+
 
+
+
+ +
+
+
 
+
+
+
 
+
+
+ +
+
+
 
+
+
+
 
+
+
+ +
+
+
 
+
+
+
 
+
+
+
 
+
+
+ +``` \ No newline at end of file diff --git a/frontend/grid/grid.png b/frontend/grid/grid.png new file mode 100644 index 0000000..22d994e Binary files /dev/null and b/frontend/grid/grid.png differ diff --git a/frontend/notifications.md b/frontend/notifications.md old mode 100644 new mode 100755 diff --git a/frontend/styles_and_layout.md b/frontend/styles_and_layout.md deleted file mode 100644 index 0919cad..0000000 --- a/frontend/styles_and_layout.md +++ /dev/null @@ -1,146 +0,0 @@ -# Styles and Layout - -## Css - -This project only supports scss and css. All css files need to be provided with a scss file which will be processed for every build. The css file has to be minimized, optimized and compressed as `.gz`. This means there is at least one scss file (multiple if you are combining/importing multiple scss files and creating one output css file), one css file and one compressed `.gz` file. The file name has to be lower case and the same for every file and only the extension is different. - -## Grid/Flexbox - -Flexboxes are preferred for all content containers. - -```html -
-
-
...
-
-
-``` - -Available sizes are `xs-*`, `sm-*`, `md-*`, `lg-*` with a grid ranging from `1-12`. - -## Sizes - -### Container - -A container (e.g. section, div, table, etc) can be sized by using `.wf-*` classes. Available sizes for `*` are `100`, `80`, `75`, `66`, `50`, `33`, `25`, `20`. - -## Icons - -This project uses font-awesome for its icons, the following example allows for stacked icons e.g. creating new/unread email notifications: - -```html - - 333 - -``` - -## Form Elements - -### Input with button - -The following snippet creates a 100% input with a button next to it. - -```html -
-
-
-
-``` - -### Input with dictionary - -The following snippet creates a dictionary button (e.g. for opening a popup window to search for accounts/groups etc) right before an input field. - -```html - - - - -``` - -### Checkbox - -The following snippet creates a checkbox. - -```html - -``` - -### Radio - -The following snippet creates a checkbox. - -```html - -
Title
-
- ... -
-
Footer
- -``` - -Additional coloring of sections can be achieved by adding a coloring class. - -```html -
- ... -
-``` - -## Tabs - -Tabs are a useful tool in order to display more information on one page. - -```html -
- -
- -
- ... Tab content ... -
- -
- ... Tab content ... -
- -
- ... Tab content ... -
-
-
-``` - -## Tables - -## Lists - -## Accordion - -## Breadcrumbs - -## Badges/Tags - -## Examples - -An example of all styles can be found in the tests called `StandardElements.htm`. \ No newline at end of file diff --git a/general/app_flow.drawio.svg b/general/app_flow.drawio.svg old mode 100644 new mode 100755 diff --git a/general/base_uml.drawio.svg b/general/base_uml.drawio.svg old mode 100644 new mode 100755 diff --git a/general/setup.md b/general/setup.md old mode 100644 new mode 100755 index b25c2e8..975d4ab --- a/general/setup.md +++ b/general/setup.md @@ -7,14 +7,14 @@ In order to setup the application for development for the first time please see Make sure your dev-environment or server fulfills the following requirements: * PHP >= 8.0 -* PHP extensions: mbstring, gd, zip, dom, mysql/pgsql/sqlsrv, sqlite, bcmath, imap\*, redis\*, memcached\*, ftp\*, socket\*, curl\*, xml\* -* databases: mysql, postgresql, sqlsrv -* web server: apache2 +* PHP extensions: mbstring, gd, zip, dom, pdo, pdo-mysql/pdo-pgsql/pdo-sqlsrv, sqlite, bcmath, imap\*, redis\*, memcached\*, ftp\*, socket\*, curl\*, xml\* +* databases: mysql/postgresql/sqlsrv +* web server: apache2/nginx * mod_headers (apache2) The application and frameworks can use different databases. For the normal development process you only need one (whichever you prefer). However, in order to test against all supported databases and all code paths you would have to install all above mentioned databases. -Extensions marked with `*` are optional. They are only required in special situations. +Extensions marked with `*` are optional but recommended. They are only required in special situations. Requirements with a `/` in between mean that only one of the dependencies is necessary depending on your preferences and previous decisions. Steps which are not explained in this documentation are how to install and setup the above mentioned software and extensions. You also should configure the web server paths accordingly in order to access the application in the browser. @@ -33,7 +33,7 @@ This also installs all required dev tools and sets up the directory structure by The following steps will setup the application, download all necessary tools and perform extensive code quality checks and documentation tasks: 1. Go to the directory where you want to install the build script -2. Run `git clone -b develop https://github.com/Orange-Management/Build.git` +2. Run `git clone -b develop https://github.com/karaka-management/Build.git` 3. Modify `config.sh` (most likely the db credentials and paths) 4. Run `chmod +x buildProject.sh` 5. Run `./buildProject.sh` @@ -58,12 +58,12 @@ This will only setup the application including some dummy data and also perform ### Steps 1. Go to the directory where you want to install the application -2. Run `git clone -b develop https://github.com/Orange-Management/Orange-Management.git` +2. Run `git clone -b develop https://github.com/karaka-management/Karaka.git` 3. Run `git submodule update --init --recursive` 4. Run `git submodule foreach git checkout develop` 5. Install Composer -6. Run `composer install` inside `Orange-Management` -7. Run `php vendor/bin/phpunit --configuration tests/phpunit_no_coverage.xml` inside `Orange-Management` or open `http://127.0.0.1/Install` +6. Run `composer install` inside `Karaka` +7. Run `php vendor/bin/phpunit --configuration tests/phpunit_no_coverage.xml` inside `Karaka` or open `http://127.0.0.1/Install` After the installation you'll have access to the following content: @@ -101,13 +101,13 @@ The following tools are important to test the application and to ensure the code This will only setup the application including some dummy data and also perform the code tests but no quality checks. Compared to option 2 this includes much more test data and it doesn't execute a unit test. 1. Go to the directory where you want to install the application -2. Run `git clone -b develop https://github.com/Orange-Management/Orange-Management.git` +2. Run `git clone -b develop https://github.com/karaka-management/Karaka.git` 3. Run `git submodule update --init --recursive` 4. Run `git submodule foreach git checkout develop` 5. Install Composer -6. Run `composer install` inside `Orange-Management` +6. Run `composer install` inside `Karaka` 7. Create the database table `oms` -7. Run `php demoSetup/setup.php` inside `Orange-Management` +7. Run `php demoSetup/setup.php` inside `Karaka` After the installation you'll have access to the following content: diff --git a/general/structure.md b/general/structure.md old mode 100644 new mode 100755 diff --git a/logo.png b/logo.png old mode 100644 new mode 100755 diff --git a/math/matrix.md b/math/matrix.md old mode 100644 new mode 100755 diff --git a/quality/inspections.md b/quality/inspections.md old mode 100644 new mode 100755 diff --git a/security/security_guidelines.md b/security/security_guidelines.md old mode 100644 new mode 100755 diff --git a/services/authentication.md b/services/authentication.md old mode 100644 new mode 100755 diff --git a/services/charting.md b/services/charting.md old mode 100644 new mode 100755 diff --git a/services/codes.md b/services/codes.md old mode 100644 new mode 100755 index 9ed6ad2..09402f8 --- a/services/codes.md +++ b/services/codes.md @@ -19,6 +19,8 @@ $c128b->saveToPngFile('path/code.png'); The barcodes can be either saved as `png` and `jpeg` or outputted directly. +![C128b Code](Developer-Guide/services/codes1.png) + ```php $c128b = new C128b('ABcdeFG0123+-!@?', 200, 50); $c128b = $C128a->get(); @@ -26,9 +28,3 @@ header ('Content-type: image/png'); imagepng($c128b); imagedestroy($c128b); ``` - -
- -![C128b Code](codes1.png) - -
\ No newline at end of file diff --git a/services/codes1.png b/services/codes1.png old mode 100644 new mode 100755 diff --git a/services/events.md b/services/events.md old mode 100644 new mode 100755 diff --git a/services/filesystem.md b/services/filesystem.md old mode 100644 new mode 100755 diff --git a/services/localization.md b/services/localization.md old mode 100644 new mode 100755 diff --git a/services/logging.md b/services/logging.md old mode 100644 new mode 100755 index b860066..1e7fdbb --- a/services/logging.md +++ b/services/logging.md @@ -14,7 +14,7 @@ Both logging implementations provide the following logging functions for the dif * `console()` * `log()` -All functions take at least two parameters where one is the message and the other one is the optional context that should be injected into the message. +All functions take at least two parameters where one is the message and the other one is the optional context that should be injected into the message. ```php $log->error(FileLogger::MSG_FULL, ['message' => 'Log me!']); @@ -37,3 +37,7 @@ On the client side a logger is also implemented providing the same functions as ```js let log = jsOMS.Log.Logger.getInstance(true, false, true); ``` + +* The first parameter defines if the log output will done in the console +* The second parameter defines if the log output should be done as notification +* The thrid parameter defines if the log output should be send to the backend diff --git a/services/mail.md b/services/mail.md old mode 100644 new mode 100755 diff --git a/services/money.md b/services/money.md old mode 100644 new mode 100755 diff --git a/services/parsers.md b/services/parsers.md old mode 100644 new mode 100755 diff --git a/services/queues.md b/services/queues.md old mode 100644 new mode 100755 diff --git a/services/rng.md b/services/rng.md old mode 100644 new mode 100755 diff --git a/services/tasks.md b/services/tasks.md old mode 100644 new mode 100755 diff --git a/services/uri.md b/services/uri.md old mode 100644 new mode 100755 diff --git a/services/validation.md b/services/validation.md old mode 100644 new mode 100755 diff --git a/standards/definitions.md b/standards/definitions.md old mode 100644 new mode 100755 diff --git a/standards/documentation.md b/standards/documentation.md old mode 100644 new mode 100755 index bb6f747..110278a --- a/standards/documentation.md +++ b/standards/documentation.md @@ -45,7 +45,7 @@ A file documentation MUST be implemented in the following form: * PHP Version 7.0 * * @package Package name - * @copyright Orange Management + * @copyright Karaka * @license OMS License 1.0 * @version 1.0.0 * @link http://your.url.com @@ -120,7 +120,7 @@ The javascript documentation is based on JsDoc, therefore only valid JsDoc comme * File description. * * @package Package name - * @copyright Orange Management + * @copyright Karaka * @license OMS License 1.0 * @version 1.0.0 * @link http://your.url.com @@ -175,7 +175,7 @@ In some cases it may be required to type hint a variable in this case the follow ## Todos -Todos should be documented in the [PROJECT.md](https://github.com/Orange-Management/Docs/blob/master/Project/PROJECT.md). +Todos should be documented in the [PROJECT.md](https://github.com/karaka-management/Docs/blob/master/Project/PROJECT.md). In code todos can be created like this diff --git a/standards/html.md b/standards/html.md old mode 100644 new mode 100755 diff --git a/standards/js.md b/standards/js.md old mode 100644 new mode 100755 diff --git a/standards/php.md b/standards/php.md old mode 100644 new mode 100755