Menu

Tree [r39] /
 History

HTTPS access


File Date Author Commit
 Classes 2022-09-01 vaclavmacurek [r39] [del] deleted obsolete files from version 37 an...
 Exceptions 2022-08-27 vaclavmacurek [r38] [chg,add,del]new classes, renamed classes, new ...
 Interfaces 2022-09-01 vaclavmacurek [r39] [del] deleted obsolete files from version 37 an...
 InternalMemory 2022-09-01 vaclavmacurek [r39] [del] deleted obsolete files from version 37 an...
 License 2015-02-05 vaclavmacurek [r1] UniCAT [add] first upload
 Traits 2022-09-01 vaclavmacurek [r39] [del] deleted obsolete files from version 37 an...
 ReadMe.rst 2022-08-27 vaclavmacurek [r38] [chg,add,del]new classes, renamed classes, new ...
 UniCAT.php 2022-08-27 vaclavmacurek [r38] [chg,add,del]new classes, renamed classes, new ...

Read Me

VMaX-UniCAT

Brief history of project

Originally developed only for my needs - as part of project that allowed generation of HTML, CSS and JavaScript. And in February of 2015, after separation from original project, I published it for public using, if someone would like to use it. And development goes on.

Development

You may write your ideas for further development through tickets, here, on SourceForge.net. Mostly awaited are ideas for

  • functionalities
  • changes of classes and methods

About used naming convention

Constants
UPPERCASE_WITH_UNDERSCORES
NULL, TRUE, FALSE constants
UPPERCASE
Methods, classes
PascalCase
Variables, properties, array keys, named matches
lowercase_with_underscores
  • Class may contain method named Execute.
  • Methods (excepting magic methods) should have to contain one of following prefixes in name.
PREFIX MEANING
add extend code with something, add something to code
count count anything
disable switch something off, set property to FALSE
enable switch something on, set property to TRUE
get load / prepare from source
has is owner of
is corresponds to, is equal to, has attribute
load load from properties
set set from external scope
assemble assemble from more parts, concat more parts into one
convert change form
subtract decrease numeric value
export exports scalar value - mostly without return
  • Classes with methods only for saving and reading of data may not need to have methods with prefix in name.
  • Classes for saving and reading of one data set (written in class name) may contain only methods code:save and code:load.

Prefix:code:add differs from prefix:code:set in place of usage of current * element * . Set element is used in a independent way on place of its usage. Added element is used in chosen place (mostly, if more than one method with prefix code:add is used).

About used formatting convention

  • indentations are done by tabs (NOT SPACES)
  • tabs have length of 5 spaces

About used coding convention

  • condition switch cannot contain another such condition unless it is inside of if-else condition
  • condition if-else should not be inside another if-else condition
  • ternar operator should not be inserted into else ternar operator