Menu
▾
▴
Tree [r14] / History
| File | Date | Author | Commit |
|---|---|---|---|
| Classes | 2020-08-04 | vaclavmacurek | [r14] [chg,add,del] copyright years changed, interfac... |
| Exceptions | 2020-08-04 | vaclavmacurek | [r14] [chg,add,del] copyright years changed, interfac... |
| Interfaces | 2020-08-04 | vaclavmacurek | [r14] [chg,add,del] copyright years changed, interfac... |
| License | 2015-03-21 | vaclavmacurek | [r1] [add] initial upload |
| Memory | 2020-08-04 | vaclavmacurek | [r14] [chg,add,del] copyright years changed, interfac... |
| Traits | 2020-08-04 | vaclavmacurek | [r14] [chg,add,del] copyright years changed, interfac... |
| ReadMe.rst | 2019-04-28 | vaclavmacurek | [r13] [chg,add] CodeGenerator rewritten, new content ... |
| StySheC.php | 2020-08-04 | vaclavmacurek | [r14] [chg,add,del] copyright years changed, interfac... |
Read Me
VMaX-StySheC
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
- PascalCase
- Array keys, named matches
- lowercase_with_underscores
- Class may contain method named
Execute. - Protected and private methods (excepting magic methods) have to contain one of following prefixes in name.
- Public methods (excepting magic methods) should have to contain one of following prefixes in name.
- Classes with methods only for saving and reading of data may not need to have methods with prefix in name.
| PREFIX | MEANING |
|---|---|
| add | extend code with something, add something to code |
| assemble | assemble from more parts, concat more parts into one |
| convert | change form |
| 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 |
| set | set from external scope |
| load | load from properties |
| count | count anything |
Prefix add differs from prefix set in place of usage of current element.
Set element is used in a independent way on place of its usage.
About used formatting convention
- indentations are done by tabs (NOT SPACES)
- tabs have length of 5 spaces
About used coding convention
- condition
switchcannot contain another such condition unless it is inside of else condition - ternar operator should not be inserted into else ternar operator
Concrete and final classes
CheckOptions
Extension for VMaX-UniCAT's CheckOptions. Adds following non-pattern options.
| METHOD | DESCRIPTION |
|---|---|
| Is_Direction | direction of SASS-like generation of stylesheets |
| Is_Relation | selectors relation |
CheckPatterns
Extension for VMaX-UniCAT's CheckPatterns. Adds following pattern options.
| METHOD | DESCRIPTION |
|---|---|
| Is_AssignSelector | selectors |
LoadOptions
Extension for VMaX-UniCAT's LoadOptions. Adds following non-pattern options.
| METHOD | DESCRIPTION |
|---|---|
| Direction | direction of SASS-like generation of stylesheets |
| Relation | selectors relation |
LoadPatterns
Extension for VMaX-UniCAT's LoadPatterns. Adds following pattern options.
| METHOD | DESCRIPTION |
|---|---|
| AssignSelector | selectors |
CodeGenerator
Generates one simple stylesheet. Only pure CSS is supported.
| METHOD | DESCRIPTION |
|---|---|
| Enable_Multilevel | enables saving of styles and selectors into static memory - for multilevel stylesheets generation |
| Execute | executes stylesheets creation |
MultilevelStylesheetAssembler
SASS-like stylesheets generator. Only pure CSS is supported.
| METHOD | DESCRIPTION |
|---|---|
| Set_Direction | sets direction of stylesheets generation |
| Set_Stylesheet | sets extended/extending stylesheet |
| Execute | executes stylesheets creation |
Traits with concrete methods
CommonSetting
Trait contains methods for setting of styles, selectors and selectors relation.
| METHOD | DESCRIPTION |
|---|---|
| Set_Relation | sets relation for multiple selectors |
| Set_Selector | sets selector(s) |
| Set_Style | sets style(s) |
Usages in classes of VMaX projects:
| PROJECT | CLASS |
|---|---|
| StySheC | CodeGenerator |
| MultilevelStylesheetAssembler |
KeyGenerator
Trait contains method for creation of key (id) for stylesheets (split into relation, styles and selectors).
| METHOD | DESCRIPTION |
|---|---|
| Get_Key | gets key from selectors |
Usages in classes of VMaX projects:
| PROJECT | CLASS |
|---|---|
| StySheC | CodeGenerator |
| MultilevelStylesheetAssembler |
Exceptions
Exception
Extension for VMaX-UniCAT's Exception
