Giter Club home page Giter Club logo

specmodule's Introduction

StyleCI ZikulaSpecModule

Warning

Installing this module and the ZikulaSpecTheme creates a conflict in the container due to their similar names. Themes are always "installed" so you must remove the theme in order for this module to function properly.

Beta (for discussion)

This is a module depicting the Core-2.0.0 Extension specification.

For theme spec, please see https://github.com/zikula/SpecTheme

The module is installable, though it has no function. The module is documented throughout and is useful mainly in solidifying and documenting the specification.

Extension File Structure

Reference: http://symfony.com/doc/current/cookbook/bundles/best_practices.html

SpecBundle/
    Block/
        FooBlock.php
    Controller/
        FooController.php
        BarController.php
    DependencyInjection/
        ZikulaSpecExtension.php (required if services are used)
    Entity/
        FooEntity.php
    Form/
        Type/
            FooType.php
    Helper/
        FooHelper.php
    Listener/
        FooListener.php
    Resources/
        config/
            routing.yml (required if controllers used)
            services.xml (required if services are used)
        docs/
            index.rst
        meta/
            LICENSE
        public/
            css/
            images/
            js/
        translations/
            messages.en.pot
            zikulaspecmodule.pot
        views/
            Bar/
                index.html.twig
            Bar/
                index.html.twig
            Block/
                fooBlockDisplay.html.twig
                fooBlockModify.html.twig
    Tests/
        Controller/
           FooControllerTest.php
    vendor/
    SpecModuleInstaller.php (required)
    ZikulaSpecModule.php (required)
    CHANGELOG.md
    README.md
    composer.json (required)
    phpunit.xml.dist

note: Api is not a required structural item and can be best replaced by services. Other optional items are allowed see various examples (in Zikula and Symfony ecosystems) for ideas on best practice for structural design.

note: There is no longer a FooModuleVersion.php file. All this data is moved to the composer.json file and hook registration is moved to a Helper class.

specmodule's People

Contributors

craigh avatar guite avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

ccandreva

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.