Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ikkez/f3-phpstorm-snippets
Fat-Free Framework snippets for PhpStorm Snippets
https://github.com/ikkez/f3-phpstorm-snippets
fat-free-framework phpstorm-snippets template-snippets
Last synced: about 1 month ago
JSON representation
Fat-Free Framework snippets for PhpStorm Snippets
- Host: GitHub
- URL: https://github.com/ikkez/f3-phpstorm-snippets
- Owner: ikkez
- License: mit
- Created: 2013-10-08T13:00:43.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2019-09-23T14:21:36.000Z (over 5 years ago)
- Last Synced: 2023-04-10T11:22:06.052Z (almost 2 years ago)
- Topics: fat-free-framework, phpstorm-snippets, template-snippets
- Size: 17.6 KB
- Stars: 36
- Watchers: 11
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# F3 PhpStorm Snippets
[Fat-Free Framework](https://github.com/bcosca/fatfree) snippets for [PhpStorm](http://www.jetbrains.com/phpstorm/).
## How-To install
to install PhpStorm schemes, settings and templates, you need to find its user config folder first. This should be present at:
+ Windows: `\.PhpStorm\config\`
+ Linux: `~/.PhpStorm/config/`
+ MacOS: `~/Library/Preferences/PhpStorm/`
## Code Style
The F3 code style uses a very compact alignment.
To install, copy `codestyles/F3_Codestyle.xml` to your config folder. If the `codestyles` directory does not exist, just create it. Restart PhpStorm and continue at Preferences > Editor > Code Style
* set default right margins (columns) to 90 (no exceptions)
* select F3 Scheme
* apply
when you now use your Menu > Code > Reformat Code, it should be all formatted in decent F3 style, oh yeah ;)
## Live-Template
To install, copy the `templates/F3.xml` file to your user config folder. If the `templates` directory does not exist, just create it.
Now restart PhpStorm and check if the F3 LiveTemplate is checked in the settings.
### Usage
Now you can write the following keywords, hit your `TAB` key and let the magic begin. Some snippets have multiple variables to be filled. Hit your `ENTER` key to proceed to the next input section.
Check out this little demo:
### PHP Snippets
#### base
expands to:
``` php
/** @var \Base $f3 */
$f3 = \Base::instance();
```
#### route
``` php
$f3->route('GET /','Class->method');
```
#### route function
``` php
$f3->route('GET /',function( Base $f3, $params) {
});
```
#### db_jig
``` php
$f3->set('DB', new \DB\Jig('data/'));
```
#### db_mongo
``` php
$f3->set('DB', new \DB\Mongo('mongodb://localhost:27017', 'testdb'));
```
#### db_mysql
``` php
$f3->set('DB', new \DB\SQL('mysql:host=localhost;port=3306;dbname=fatfree', 'fatfree', 'fatfree'));
```
#### db_pgsql
``` php
$f3->set('DB', new \DB\SQL('pgsql:host=localhost;dbname=fatfree', 'fatfree', 'fatfree'));
```
#### db_sqlsrv
``` php
$f3->set('DB', new \DB\SQL('sqlsrv:Server=localhost,1433;Database=fatfree', 'fatfree', ''));
```
#### db_sqlite
``` php
$f3->set('DB', new \DB\SQL('sqlite:data/sqlite.db'));
```
### Template Snippets
All template snippets are using the namespaced tags with a `F3:` prefix like the tag ``. This is helpful, since PhpStorm will colorize this in your html markup, so you'll find it easier to spot the F3 parts in your templates.
---
#### {{
``` html
{{ }}
```
#### {-
exclude an expression (useful for JS-variables)
``` html
{-{{ }}-}
```
#### {~
exclude a part (do not echo it)
``` html
{~ ~}
```
#### @
``` html
{{ @var }}
```
#### @?
a shortcut to print a variable, if it has been defined.
``` html
{{isset(@var)?@var:''}}
```
#### @esc
``` html
{{ @var | esc }}
```
#### @raw
``` html
{{ @var | raw }}
```
#### check
A check with true-only section
``` html
```
#### true
To extend the check section with true and false parts.
``` html
```
#### switch
``` html
```
#### case
adds an additional case with break option to a switch section
``` html
```
#### include
``` html
```
#### includeif
``` html
```
#### loop
``` html
```
#### repeat
``` html
{{ @val }}
```
#### repeat kv
expands to: repeat with key and value
``` html
{{@key}} {{@val}}
```
#### repeat vc
expands to: repeat with value and counter
``` html
{{@i}}: {{@val}}
```
#### repeat kvc
expands to: repeat with key, value and counter
``` html
{{@i}}: {{@key}} {{@val}}
```
#### set
``` html
{{@key}}
```