Repository folder structure

Jump to bottom Edit New page

Gerrit Uitslag edited this page May 29, 2016 · 3 revisions

Repository/Setup folder structure

Some folders are auto-generated, some are a checkout from git.

Some highlights:

app -
- cache - cache files of app
- config - configuration files
- logs - log files of app
src -
- org/dokuwiki/ translatorBundle - contains translation tool code
  - Command - Classes for commands at console
  - Controller - Controllers, see also src/org/dokuwiki/translatorBundle/Resources/config/routing.yml
  - DependencyInjection - ??
  - Entity - annotated PHP entity class definitions, which are mapped to database by Doctrine
  - EventListener - ??
  - Form - ??
  - Resources - for framework
    - config - Config files for routing, services and validation
    - public - folders with respectively images, js and less files
    - views - folders with Twig template files like *.html.twig or *.txt.twig
  - Services (see Services)
    - DokuWikiRepositoryAPI - retrieve info from plugin repository at dokuwiki.org
    - Git - Wraps git commands
    - GitHub - Github interaction
    - Language - Handle language file generation
    - Mail - Serve mailing
    - Repository - Repositories e.g. Core, Plugins
  - Tests - Unit tests
  - Twig - Twig extensions
  - Validator - ??
vender - libraries downloaded by composer
web - Public accessible content
- bundles - related to vendor libraries
- js - autogenerated javascript
- css - autogenerated style files

Documentation

How to use

Routing: http://symfony.com/doc/current/book/routing.html (router, url generation)
Doctrine: Object-relational mapping from PHP to database, see http://symfony.com/doc/current/book/doctrine.html
Twig: Templating language, see http://symfony.com/doc/current/book/templating.html