├── .editorconfig ├── .gitattributes ├── .github ├── ISSUE_TEMPLATE │ ├── Bug-Report.yml │ ├── Feature-Request.yml │ ├── Improvement.yml │ └── config.yml └── workflows │ ├── cla.yml │ ├── php-style.yml │ └── stale.yml ├── .gitignore ├── .php_cs.dist ├── CONTRIBUTING.md ├── LICENSE.md ├── README.md ├── SECURITY.md ├── composer.json ├── gpl-3.0.txt └── src ├── Command ├── BaseGenerateBundleCommand.php ├── BaseGeneratorCommand.php ├── GenerateBundleCommand.php ├── Helper │ └── QuestionHelper.php └── Validators.php ├── DependencyInjection └── PimcoreBundleGeneratorExtension.php ├── Generator ├── BaseBundleGenerator.php ├── BundleGenerator.php └── Generator.php ├── Manipulator ├── Manipulator.php └── RoutingManipulator.php ├── Model ├── BaseBundle.php └── Bundle.php ├── PimcoreBundleGeneratorBundle.php └── Resources ├── config └── services.yaml └── skeleton ├── bundle ├── BaseBundle.php.twig ├── Bundle.php.twig ├── Configuration.php.twig ├── DefaultController.php.twig ├── DefaultControllerTest.php.twig ├── Extension.php.twig ├── index.html.twig.twig ├── routing.php.twig ├── routing.xml.twig ├── routing.yaml.twig ├── services.php.twig ├── services.xml.twig └── services.yaml.twig └── js └── pimcore └── startup.js.twig /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | charset = utf-8 5 | end_of_line = lf 6 | indent_style = space 7 | indent_size = 4 8 | 9 | [*.php] 10 | insert_final_newline = true 11 | trim_trailing_whitespace = true 12 | 13 | [*.md] 14 | trim_trailing_whitespace = false 15 | 16 | [*.yml] 17 | indent_size = 4 18 | 19 | [composer.json] 20 | indent_style = space 21 | indent_size = 2 22 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * -text -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/Bug-Report.yml: -------------------------------------------------------------------------------- 1 | name: Bug Report 2 | description: File a bug report 3 | title: "[Bug]: " 4 | labels: [Bug] 5 | body: 6 | - type: markdown 7 | attributes: 8 | value: | 9 | ## Important notice 10 | As an open source project we love to work together with our community to improve and develop our products. 11 | It's also important for us to make clear that **we're not working for you or your company**, 12 | but we enjoy to work together to solve existing bugs. 13 | So we would love to see PRs with bugfixes, discuss them and we are happy to merge them when they are ready. 14 | For details see also our [contributing guidelines](https://github.com/pimcore/pimcore/blob/10.x/CONTRIBUTING.md). 15 | 16 | Bug reports that do not meet the conditions listed below will be closed/deleted without comment. 17 | 18 | - Bug was verified on the latest supported version. 19 | - This is not a security issue -> see [our security policy](https://github.com/pimcore/pimcore/security/policy) instead. 20 | - You are not able to provide a pull request that fixes the issue. 21 | - There's no existing ticket for the same issue. 22 | 23 | - type: textarea 24 | attributes: 25 | label: Expected behavior 26 | validations: 27 | required: true 28 | - type: textarea 29 | attributes: 30 | label: Actual behavior 31 | validations: 32 | required: true 33 | - type: textarea 34 | attributes: 35 | label: Steps to reproduce 36 | validations: 37 | required: true 38 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/Feature-Request.yml: -------------------------------------------------------------------------------- 1 | name: Feature Request 2 | description: Request or propose a new feature 3 | title: "[Feature]: " 4 | labels: ["New Feature"] 5 | body: 6 | - type: markdown 7 | attributes: 8 | value: | 9 | ## Important notice 10 | As an open source project we love to work together with our community to improve and develop our products. 11 | It's also important for us to make clear that **we're not working for you or your company**, 12 | but we enjoy to work together to improve or add new features to the product. 13 | So we are always ready to discuss features and improvements with our community. 14 | Especially for bigger topics, please [start a discussion](https://github.com/pimcore/pimcore/discussions) first to aviod unnecessary efforts. 15 | 16 | As soon as a topic is more specific, feel free to create issues for it or even better provide a corresponding PR as we love to 17 | review and merge contributions. 18 | 19 | Feature requests that do not meet the conditions listed below will be closed/deleted without comment. 20 | - There's no existing ticket for the same topic 21 | - This is already a specific ready-to-work-on feature request 22 | 23 | - type: textarea 24 | attributes: 25 | label: Feature description 26 | validations: 27 | required: true 28 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/Improvement.yml: -------------------------------------------------------------------------------- 1 | name: Improvement 2 | description: Request or propose an improvement 3 | title: "[Improvement]: " 4 | labels: ["Improvement"] 5 | body: 6 | - type: markdown 7 | attributes: 8 | value: | 9 | ## Important notice 10 | As an open source project we love to work together with our community to improve and develop our products. 11 | It's also important for us to make clear that **we're not working for you or your company**, 12 | but we enjoy to work together to improve or add new features to the product. 13 | So we are always ready to discuss features and improvements with our community. 14 | Especially for bigger topics, please [start a discussion](https://github.com/pimcore/pimcore/discussions) first to aviod unnecessary efforts. 15 | 16 | As soon as a topic is more specific, feel free to create issues for it or even better provide a corresponding PR as we love to 17 | review and merge contributions. 18 | 19 | Feature requests that do not meet the conditions listed below will be closed/deleted without comment. 20 | - There's no existing ticket for the same topic 21 | - This is already a specific ready-to-work-on feature request 22 | 23 | - type: textarea 24 | attributes: 25 | label: Improvement description 26 | validations: 27 | required: true 28 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | blank_issues_enabled: false 2 | contact_links: 3 | - name: We are hiring! 4 | url: https://pimcore.com/en/careers?utm_source=github&utm_medium=issue-template-bundle-generator&utm_campaign=careers 5 | about: Enjoy working with Pimcore? Join us on our mission! 6 | - name: Community Support 7 | url: https://github.com/pimcore/pimcore/discussions 8 | about: Please ask and answer questions here. 9 | -------------------------------------------------------------------------------- /.github/workflows/cla.yml: -------------------------------------------------------------------------------- 1 | name: CLA check 2 | on: 3 | issue_comment: 4 | types: [created] 5 | pull_request_target: 6 | types: [opened, closed, synchronize] 7 | jobs: 8 | cla-workflow: 9 | uses: pimcore/workflows-collection-public/.github/workflows/reusable-cla-check.yaml@v1.3.0 10 | if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target' 11 | secrets: 12 | CLA_ACTION_ACCESS_TOKEN: ${{ secrets.CLA_ACTION_ACCESS_TOKEN }} -------------------------------------------------------------------------------- /.github/workflows/php-style.yml: -------------------------------------------------------------------------------- 1 | name: PHP Style 2 | 3 | on: [push] 4 | 5 | jobs: 6 | php-cs-fixer: 7 | runs-on: ubuntu-latest 8 | steps: 9 | - uses: actions/checkout@v2 10 | with: 11 | ref: ${{ github.head_ref }} 12 | 13 | - name: PHP-CS-Fixer 14 | uses: docker://oskarstark/php-cs-fixer-ga:2.19.0 15 | with: 16 | args: --config=.php_cs.dist --allow-risky yes 17 | 18 | - uses: stefanzweifel/git-auto-commit-action@v4 19 | with: 20 | commit_message: Apply php-cs-fixer changes 21 | -------------------------------------------------------------------------------- /.github/workflows/stale.yml: -------------------------------------------------------------------------------- 1 | name: Handle stale issues 2 | 3 | on: 4 | workflow_dispatch: 5 | schedule: 6 | - cron: '37 7 * * *' 7 | 8 | jobs: 9 | call-stale-workflow: 10 | uses: pimcore/workflows-collection-public/.github/workflows/stale.yml@v1.1.0 11 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | Thumbs.db 3 | *.log 4 | 5 | # PHP-CS-Fixer 6 | /.php_cs 7 | /.php_cs.cache 8 | 9 | # composer 10 | composer.lock 11 | 12 | # PhpStorm / IDEA 13 | .idea 14 | .idea_modules 15 | # NetBeans 16 | nbproject 17 | 18 | -------------------------------------------------------------------------------- /.php_cs.dist: -------------------------------------------------------------------------------- 1 | in([__DIR__ . '/src']) 5 | 6 | // do not fix views 7 | ->notName('*.html.php'); 8 | 9 | return PhpCsFixer\Config::create() 10 | ->setRules([ 11 | '@PSR1' => true, 12 | '@PSR2' => true, 13 | 'array_syntax' => ['syntax' => 'short'], 14 | 15 | 'header_comment' => [ 16 | 'commentType' => 'PHPDoc', 17 | 'header' => 'Pimcore' . PHP_EOL . PHP_EOL . 18 | 'This source file is available under two different licenses:' . PHP_EOL . 19 | '- GNU General Public License version 3 (GPLv3)' . PHP_EOL . 20 | '- Pimcore Commercial License (PCL)' . PHP_EOL . 21 | 'Full copyright and license information is available in' . PHP_EOL . 22 | 'LICENSE.md which is distributed with this source code.' . PHP_EOL . 23 | PHP_EOL . 24 | ' @copyright Copyright (c) Pimcore GmbH (http://www.pimcore.org)' . PHP_EOL . 25 | ' @license http://www.pimcore.org/license GPLv3 and PCL' 26 | ], 27 | 28 | // keep aligned = and => operators as they are: do not force aligning, but do not remove it 29 | 'binary_operator_spaces' => ['align_double_arrow' => null, 'align_equals' => null], 30 | 31 | 'blank_line_before_return' => true, 32 | 'encoding' => true, 33 | 'function_typehint_space' => true, 34 | 'hash_to_slash_comment' => true, 35 | 'lowercase_cast' => true, 36 | 'magic_constant_casing' => true, 37 | 'method_argument_space' => ['ensure_fully_multiline' => false], 38 | 'method_separation' => true, 39 | 'native_function_casing' => true, 40 | 'no_blank_lines_after_class_opening' => true, 41 | 'no_blank_lines_after_phpdoc' => true, 42 | 'no_empty_comment' => true, 43 | 'no_empty_phpdoc' => true, 44 | 'no_empty_statement' => true, 45 | 'no_extra_consecutive_blank_lines' => true, 46 | 'no_leading_import_slash' => true, 47 | 'no_leading_namespace_whitespace' => true, 48 | 'no_short_bool_cast' => true, 49 | 'no_spaces_around_offset' => true, 50 | 'no_unneeded_control_parentheses' => true, 51 | 'no_unused_imports' => true, 52 | 'no_whitespace_before_comma_in_array' => true, 53 | 'no_whitespace_in_blank_line' => true, 54 | 'object_operator_without_whitespace' => true, 55 | 'ordered_imports' => true, 56 | 'phpdoc_indent' => true, 57 | 'phpdoc_no_useless_inheritdoc' => true, 58 | 'phpdoc_scalar' => true, 59 | 'phpdoc_separation' => true, 60 | 'phpdoc_single_line_var_spacing' => true, 61 | 'return_type_declaration' => true, 62 | 'self_accessor' => true, 63 | 'short_scalar_cast' => true, 64 | 'single_blank_line_before_namespace' => true, 65 | 'single_quote' => true, 66 | 'space_after_semicolon' => true, 67 | 'standardize_not_equals' => true, 68 | 'ternary_operator_spaces' => true, 69 | 'whitespace_after_comma_in_array' => true, 70 | ]) 71 | ->setFinder($finder); 72 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to Pimcore Bundle Generator 2 | 3 | ## Bug Reports & Feature Requests 4 | The Pimcore team heavily uses (and loves!) GitHub for all of our software management. 5 | We use GitHub issues exclusively to track all bugs and features. 6 | 7 | * [Open an issue](https://github.com/pimcore/bundle-generator/issues) here on GitHub. 8 | If you can, **please provide a fix and create a pull request (PR) instead**; this will automatically create an issue for you. 9 | * Report security issues only to security@pimcore.org 10 | * Please be patient as not all items will be tested immediately - remember, Pimcore Bundle Generator is open source and free of charge. 11 | * Occasionally we'll close issues if they appear stale or are too vague - please don't take this personally! 12 | Please feel free to re-open issues we've closed if there's something we've missed, and they still need to be addressed. 13 | 14 | ## Contributing Pull Requests 15 | PR's are even better than issues. 16 | We gladly accept community pull requests. 17 | There are a few necessary steps before we can accept a pull request: 18 | 19 | * [Fork us!](https://help.github.com/articles/fork-a-repo/) 20 | * Select the right branch. `master` for features and improvements, latest maintenance branch for bug fixes (e.g. `6.6`) 21 | * Code! Follow the coding standards defined [here](https://github.com/pimcore/bundle-generator/blob/master/.php_cs.dist). 22 | * [Send a pull request](https://help.github.com/articles/using-pull-requests/) from your fork’s branch to our `master` branch. 23 | * [Sign the CLA](https://cla-assistant.io/pimcore/bundle-generator) - see also below. 24 | 25 | 26 | ### Contributor License Agreement 27 | The following terms are used throughout this agreement: 28 | 29 | * **You** - the person or legal entity including its affiliates asked to accept this agreement. An affiliate is any 30 | entity that controls or is controlled by the legal entity, or is under common control with it. 31 | 32 | * **Project** - is an umbrella term that refers to any and all Pimcore projects. 33 | 34 | * **Contribution** - any type of work that is submitted to a Project, including any modifications or additions to 35 | existing work. 36 | 37 | * **Submitted** - conveyed to a Project via a pull request, commit, issue, or any form of electronic, written, or 38 | verbal communication with Pimcore, contributors or maintainers. 39 | 40 | #### 1. Grant of Copyright License. 41 | Subject to the terms and conditions of this agreement, You grant to the Projects’ maintainers, contributors, users and 42 | to Pimcore a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, 43 | prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your contributions and such 44 | derivative works. Except for this license, You reserve all rights, title, and interest in your contributions. 45 | 46 | #### 2. Grant of Patent License. 47 | Subject to the terms and conditions of this agreement, You grant to the Projects’ maintainers, contributors, users and 48 | to Pimcore a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) 49 | patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer your contributions, where 50 | such license applies only to those patent claims licensable by you that are necessarily infringed by your contribution 51 | or by combination of your contribution with the project to which this contribution was submitted. 52 | 53 | If any entity institutes patent litigation - including cross-claim or counterclaim in a lawsuit - against You alleging 54 | that your contribution or any project it was submitted to constitutes or is responsible for direct or contributory 55 | patent infringement, then any patent licenses granted to that entity under this agreement shall terminate as of the 56 | date such litigation is filed. 57 | 58 | #### 3. Source of Contribution. 59 | Your contribution is either your original creation, based upon previous work that, to the best of your knowledge, is 60 | covered under an appropriate open source license and you have the right under that license to submit that work with 61 | modifications, whether created in whole or in part by you, or you have clearly identified the source of the contribution 62 | and any license or other restriction (like related patents, trademarks, and license agreements) of which you are 63 | personally aware. 64 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | # License 2 | Copyright (C) Pimcore GmbH 3 | 4 | This software is available under two different licenses: 5 | * GNU General Public License version 3 (GPLv3) as Pimcore Community Edition 6 | * Pimcore Commercial License (PCL) 7 | 8 | The default Pimcore license, without a valid Pimcore Commercial License agreement, is the Open-Source GPLv3 license. 9 | 10 | ## GNU General Public License version 3 (GPLv3) 11 | If you decide to choose the GPLv3 license, you must comply with the following terms: 12 | 13 | This program is free software: you can redistribute it and/or modify 14 | it under the terms of the GNU General Public License as published by 15 | the Free Software Foundation, either version 3 of the License, or 16 | (at your option) any later version. 17 | 18 | This program is distributed in the hope that it will be useful, 19 | but WITHOUT ANY WARRANTY; without even the implied warranty of 20 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 21 | GNU General Public License for more details. 22 | 23 | You should have received a copy of the GNU General Public License 24 | along with this program. If not, see . 25 | 26 | ## Pimcore Commercial License (PCL) 27 | Alternatively, commercial and supported versions of the program - also known as 28 | Commercial Distributions - must be used in accordance with the terms and conditions 29 | contained in a separate written agreement between you and Pimcore GmbH. 30 | For more information about the Pimcore Commercial License (PCL) please contact info@pimcore.com. 31 | 32 | 33 | 34 | Please see also (files in this directory): 35 | - [Licensing FAQ - license-faq.md](https://github.com/pimcore/pimcore/blob/master/license-faq.md) 36 | - [GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 - gpl-3.0.txt](gpl-3.0.txt) -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Pimcore Bundle Generator 2 | 3 | This bundle provides a bundle generator for Pimcore to generate bundle skeletons and give you a head start 4 | for bundle development. 5 | 6 | To generate bundle skeletons just install and activate this bundle, use one of the two commands provided and 7 | follow the instructions: 8 | - `generate:bundle` - to generate default symfony bundles 9 | - `pimcore:generate:bundle` - to generate Pimcore bundles 10 | 11 | # Installation 12 | 13 | 1. On your Pimcore 11 root project 14 | 15 | ```bash 16 | $ composer require pimcore/bundle-generator 17 | ``` 18 | 19 | 2. Make sure the bundle is enabled in the `config/bundles.php` file. The following lines should be added: 20 | 21 | ```bash 22 | use Pimcore\Bundle\BundleGeneratorBundle\PimcoreBundleGeneratorBundle; 23 | 24 | return [ 25 | PimcoreBundleGeneratorBundle::class => ['all' => true], 26 | ]; 27 | ``` 28 | 29 | Go to your terminal/command prompt, And you're ready to rock ! 30 | 31 | ## Contributions 32 | As Pimcore Bundle Generator is a community project, any contributions highly appreciated. 33 | For details see our [Contributing guide](https://github.com/pimcore/bundle-generator/blob/master/CONTRIBUTING.md). 34 | -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | 3 | ## Reporting a Vulnerability 4 | 5 | If you think that you have found a security issue, 6 | don’t use the bug tracker and don’t publish it publicly. 7 | Instead, all security issues must be reported via a private vulnerability report. 8 | 9 | Please follow the [instructions](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability#privately-reporting-a-security-vulnerability) to submit a private report. 10 | 11 | 12 | ## Resolving Process 13 | Every submitted security issue is handled with top priority by following these steps: 14 | 15 | 1. Confirm the vulnerability 16 | 2. Determine the severity 17 | 3. Contact reporter 18 | 4. Work on a patch 19 | 5. Get a CVE identification number (may be done by the reporter or a security service provider) 20 | 6. Patch reviewing 21 | 7. Tagging a new release for supported versions 22 | 8. Publish security announcement 23 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "pimcore/bundle-generator", 3 | "license": "GPL-3.0+", 4 | "type": "pimcore-bundle", 5 | "description": "Pimcore Bundle Generator", 6 | "config": { 7 | "discard-changes": true 8 | }, 9 | "autoload": { 10 | "psr-4": { 11 | "Pimcore\\Bundle\\BundleGeneratorBundle\\": "src/" 12 | } 13 | }, 14 | "require": { 15 | "pimcore/pimcore": "^11.0" 16 | }, 17 | "extra": { 18 | "pimcore": { 19 | "bundles": [ 20 | "Pimcore\\Bundle\\BundleGeneratorBundle\\PimcoreBundleGeneratorBundle" 21 | ] 22 | } 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /gpl-3.0.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /src/Command/BaseGenerateBundleCommand.php: -------------------------------------------------------------------------------- 1 | setName('generate:bundle') 41 | ->setDescription('Generates a bundle') 42 | ->setDefinition([ 43 | new InputOption('namespace', '', InputOption::VALUE_REQUIRED, 'The namespace of the bundle to create'), 44 | new InputOption('dir', '', InputOption::VALUE_REQUIRED, 'The directory where to create the bundle', 'bundles/'), 45 | new InputOption('bundle-name', '', InputOption::VALUE_REQUIRED, 'The optional bundle name'), 46 | new InputOption('format', '', InputOption::VALUE_REQUIRED, 'Use the format for configuration files (php, xml, yaml, or annotation)'), 47 | new InputOption('shared', '', InputOption::VALUE_NONE, 'Are you planning on sharing this bundle across multiple applications?'), 48 | ]) 49 | ->setHelp(<<%command.name% command helps you generates new bundles. 51 | 52 | By default, the command interacts with the developer to tweak the generation. 53 | Any passed option will be used as a default value for the interaction 54 | (--namespace is the only one needed if you follow the 55 | conventions): 56 | 57 | php %command.full_name% --namespace=Acme/BlogBundle 58 | 59 | Note that you can use / instead of \\ for the namespace delimiter to avoid any 60 | problems. 61 | 62 | If you want to disable any user interaction, use --no-interaction but don't forget to pass all needed options: 63 | 64 | php %command.full_name% --namespace=Acme/BlogBundle --dir=src [--bundle-name=...] --no-interaction 65 | 66 | Note that the bundle namespace must end with "Bundle". 67 | EOT 68 | ) 69 | ; 70 | } 71 | 72 | /** 73 | * @see Command 74 | * 75 | * @throws \InvalidArgumentException When namespace doesn't end with Bundle 76 | * @throws \RuntimeException When bundle can't be executed 77 | * 78 | * @return int 79 | */ 80 | protected function execute(InputInterface $input, OutputInterface $output) 81 | { 82 | $questionHelper = $this->getQuestionHelper(); 83 | 84 | $bundle = $this->createBundleObject($input); 85 | $questionHelper->writeSection($output, 'Bundle generation'); 86 | 87 | /** @var BundleGenerator $generator */ 88 | $generator = $this->getGenerator(); 89 | 90 | $output->writeln(sprintf( 91 | '> Generating a sample bundle skeleton into %s', 92 | $this->makePathRelative($bundle->getTargetDirectory()) 93 | )); 94 | $generator->generateBundle($bundle); 95 | 96 | $errors = []; 97 | $runner = $questionHelper->getRunner($output, $errors); 98 | 99 | // check that the namespace is already auto loaded 100 | $runner($this->checkAutoloader($output, $bundle), false); 101 | 102 | // register the bundle in the Kernel class 103 | $runner($this->updateKernel($this->getContainer()->get('kernel'), $bundle), false); 104 | 105 | // routing importing 106 | $runner($this->updateRouting($bundle), false); 107 | 108 | if (!$bundle->shouldGenerateDependencyInjectionDirectory()) { 109 | // we need to import their services.yaml manually! 110 | $runner($this->updateConfiguration($output, $bundle)); 111 | } 112 | 113 | $questionHelper->writeGeneratorSummary($output, $errors); 114 | 115 | return 0; 116 | } 117 | 118 | protected function interact(InputInterface $input, OutputInterface $output) 119 | { 120 | $questionHelper = $this->getQuestionHelper(); 121 | $questionHelper->writeSection($output, 'Welcome to the Symfony bundle generator!'); 122 | 123 | /* 124 | * shared option 125 | */ 126 | $shared = $input->getOption('shared'); 127 | // ask, but use $shared as the default 128 | $question = new ConfirmationQuestion($questionHelper->getQuestion( 129 | 'Are you planning on sharing this bundle across multiple applications?', 130 | $shared ? 'yes' : 'no' 131 | ), $shared); 132 | $shared = $questionHelper->ask($input, $output, $question); 133 | $input->setOption('shared', $shared); 134 | 135 | /* 136 | * namespace option 137 | */ 138 | $namespace = $input->getOption('namespace'); 139 | $output->writeln([ 140 | '', 141 | 'Your application code must be written in bundles. This command helps', 142 | 'you generate them easily.', 143 | '', 144 | ]); 145 | 146 | $askForBundleName = true; 147 | if ($shared) { 148 | // a shared bundle, so it should probably have a vendor namespace 149 | $output->writeln([ 150 | 'Each bundle is hosted under a namespace (like Acme/BlogBundle).', 151 | 'The namespace should begin with a "vendor" name like your company name, your', 152 | 'project name, or your client name, followed by one or more optional category', 153 | 'sub-namespaces, and it should end with the bundle name itself', 154 | '(which must have Bundle as a suffix).', 155 | '', 156 | 'See http://symfony.com/doc/current/cookbook/bundles/best_practices.html#bundle-name for more', 157 | 'details on bundle naming conventions.', 158 | '', 159 | 'Use / instead of \\ for the namespace delimiter to avoid any problems.', 160 | '', 161 | ]); 162 | 163 | $question = new Question($questionHelper->getQuestion( 164 | 'Bundle namespace', 165 | $namespace 166 | ), $namespace); 167 | $question->setValidator(function ($answer) { 168 | return Validators::validateBundleNamespace($answer, true); 169 | }); 170 | $namespace = $questionHelper->ask($input, $output, $question); 171 | } else { 172 | // a simple application bundle 173 | $output->writeln([ 174 | 'Give your bundle a descriptive name, like BlogBundle.', 175 | ]); 176 | 177 | $question = new Question($questionHelper->getQuestion( 178 | 'Bundle name', 179 | $namespace 180 | ), $namespace); 181 | $question->setValidator(function ($inputNamespace) { 182 | return Validators::validateBundleNamespace($inputNamespace, false); 183 | }); 184 | $namespace = $questionHelper->ask($input, $output, $question); 185 | 186 | if (strpos($namespace, '\\') === false) { 187 | // this is a bundle name (FooBundle) not a namespace (Acme\FooBundle) 188 | // so this is the bundle name (and it is also the namespace) 189 | $input->setOption('bundle-name', $namespace); 190 | $askForBundleName = false; 191 | } 192 | } 193 | $input->setOption('namespace', $namespace); 194 | 195 | /* 196 | * bundle-name option 197 | */ 198 | if ($askForBundleName) { 199 | $bundle = $input->getOption('bundle-name'); 200 | // no bundle yet? Get a default from the namespace 201 | if (!$bundle) { 202 | $bundle = strtr($namespace, ['\\Bundle\\' => '', '\\' => '']); 203 | } 204 | 205 | $output->writeln([ 206 | '', 207 | 'In your code, a bundle is often referenced by its name. It can be the', 208 | 'concatenation of all namespace parts but it\'s really up to you to come', 209 | 'up with a unique name (a good practice is to start with the vendor name).', 210 | 'Based on the namespace, we suggest '.$bundle.'.', 211 | '', 212 | ]); 213 | $question = new Question($questionHelper->getQuestion( 214 | 'Bundle name', 215 | $bundle 216 | ), $bundle); 217 | $question->setValidator( 218 | ['Pimcore\Bundle\BundleGeneratorBundle\Command\Validators', 'validateBundleName'] 219 | ); 220 | $bundle = $questionHelper->ask($input, $output, $question); 221 | $input->setOption('bundle-name', $bundle); 222 | } 223 | 224 | /* 225 | * dir option 226 | */ 227 | // defaults to src/ in the option 228 | $dir = $input->getOption('dir'); 229 | $output->writeln([ 230 | '', 231 | 'We recommend adding bundles to a bundles/ directory. Unless you\'re', 232 | 'doing something custom, hit enter to keep this default!', 233 | '', 234 | ]); 235 | 236 | $question = new Question($questionHelper->getQuestion( 237 | 'Target Directory', 238 | $dir 239 | ), $dir); 240 | $dir = $questionHelper->ask($input, $output, $question); 241 | $input->setOption('dir', $dir); 242 | 243 | /* 244 | * format option 245 | */ 246 | $format = $input->getOption('format'); 247 | if (!$format) { 248 | $format = $shared ? 'xml' : 'annotation'; 249 | } 250 | $output->writeln([ 251 | '', 252 | 'What format do you want to use for your generated configuration?', 253 | '', 254 | ]); 255 | 256 | $question = new Question($questionHelper->getQuestion( 257 | 'Configuration format (annotation, yaml, xml, php)', 258 | $format 259 | ), $format); 260 | $question->setValidator(function ($format) { 261 | return Validators::validateFormat($format); 262 | }); 263 | $question->setAutocompleterValues(['annotation', 'yaml', 'xml', 'php']); 264 | $format = $questionHelper->ask($input, $output, $question); 265 | $input->setOption('format', $format); 266 | } 267 | 268 | protected function checkAutoloader(OutputInterface $output, Bundle $bundle) 269 | { 270 | $output->writeln('> Checking that the bundle is autoloaded'); 271 | if (!class_exists($bundle->getBundleClassName())) { 272 | return [ 273 | '- Edit the composer.json file and register the bundle', 274 | ' namespace in the "autoload:psr-4" section and run composer dump-autoload:', 275 | sprintf(' "%s\\\\": "%s"', str_replace('\\', '\\\\', $bundle->getNamespace()), $bundle->getRelativeTargetDirectory() . '/src'), 276 | ]; 277 | } 278 | } 279 | 280 | protected function updateKernel(KernelInterface $kernel, Bundle $bundle) 281 | { 282 | $reflected = new \ReflectionObject($kernel); 283 | 284 | return [ 285 | sprintf('- Edit %s', $reflected->getFilename()), 286 | ' and add the following bundle in the Kernel::registerBundlesToCollection() method:', 287 | '', 288 | sprintf(' $collection->addBundle(%s::class);,', $bundle->getBundleClassName()), 289 | '', 290 | ]; 291 | } 292 | 293 | protected function updateRouting(Bundle $bundle) 294 | { 295 | if ('annotation' === $bundle->getConfigurationFormat()) { 296 | $help = sprintf(" resource: \"@%s/Controller/\"\n type: annotation\n", $bundle->getName()); 297 | } else { 298 | $help = sprintf(" resource: \"@%s/Resources/config/pimcore/routing.%s\"\n", $bundle->getName(), $bundle->getConfigurationFormat()); 299 | } 300 | $help .= " prefix: /\n"; 301 | 302 | return [ 303 | '- Import the bundle\'s routing resource in the app\'s main routing file:', 304 | '', 305 | sprintf(' %s:', $bundle->getName()), 306 | $help, 307 | '', 308 | ]; 309 | } 310 | 311 | protected function updateConfiguration(OutputInterface $output, Bundle $bundle) 312 | { 313 | $importCode = sprintf(<<getName(), 318 | $bundle->getServicesConfigurationFilename() 319 | ); 320 | 321 | return [ 322 | sprintf('- Import the bundle\'s "%s" resource in the app\'s main configuration file:', $bundle->getServicesConfigurationFilename()), 323 | '', 324 | $importCode, 325 | '', 326 | ]; 327 | } 328 | 329 | /** 330 | * Creates the Bundle object based on the user's (non-interactive) input. 331 | * 332 | * @param InputInterface $input 333 | * 334 | * @return Bundle 335 | */ 336 | protected function createBundleObject(InputInterface $input) 337 | { 338 | foreach (['namespace', 'dir'] as $option) { 339 | if (null === $input->getOption($option)) { 340 | throw new \RuntimeException(sprintf('The "%s" option must be provided.', $option)); 341 | } 342 | } 343 | 344 | $shared = $input->getOption('shared'); 345 | 346 | $namespace = Validators::validateBundleNamespace($input->getOption('namespace'), $shared); 347 | if (!$bundleName = $input->getOption('bundle-name')) { 348 | $bundleName = strtr($namespace, ['\\' => '']); 349 | } 350 | $bundleName = Validators::validateBundleName($bundleName); 351 | $dir = $input->getOption('dir'); 352 | if (null === $input->getOption('format')) { 353 | $input->setOption('format', 'annotation'); 354 | } 355 | $format = Validators::validateFormat($input->getOption('format')); 356 | 357 | // an assumption that the kernel root dir is in a directory (like app/) 358 | $projectRootDirectory = $this->getContainer()->getParameter('kernel.project_dir'); 359 | 360 | if (realpath($dir) !== $dir) { 361 | $dir = $projectRootDirectory.'/'.$dir; 362 | } 363 | // add trailing / if necessary 364 | $dir = '/' === substr($dir, -1, 1) ? $dir : $dir.'/'; 365 | 366 | $bundle = new Bundle( 367 | $namespace, 368 | $bundleName, 369 | $dir, 370 | $format, 371 | $shared 372 | ); 373 | 374 | // not shared - put the tests in the root 375 | if (!$shared) { 376 | $testsDir = $projectRootDirectory.'/tests/'.$bundleName; 377 | $bundle->setTestsDirectory($testsDir); 378 | } 379 | 380 | return $bundle; 381 | } 382 | 383 | protected function createGenerator() 384 | { 385 | return new BundleGenerator(); 386 | } 387 | } 388 | -------------------------------------------------------------------------------- /src/Command/BaseGeneratorCommand.php: -------------------------------------------------------------------------------- 1 | generator) { 40 | $this->generator = $this->createGenerator(); 41 | $this->generator->setSkeletonDirs($this->getSkeletonDirs($bundle)); 42 | } 43 | 44 | return $this->generator; 45 | } 46 | 47 | protected $container; 48 | 49 | protected function getContainer() 50 | { 51 | if (null === $this->container) { 52 | $application = $this->getApplication(); 53 | if (null === $application) { 54 | throw new \LogicException('The container cannot be retrieved as the application instance is not yet set.'); 55 | } 56 | 57 | $this->container = $application->getKernel()->getContainer(); 58 | } 59 | 60 | return $this->container; 61 | } 62 | 63 | protected function getSkeletonDirs(BundleInterface $bundle = null) 64 | { 65 | $skeletonDirs = []; 66 | 67 | if (isset($bundle) && is_dir($dir = $bundle->getPath().'/Resources/GeneratorBundle/skeleton')) { 68 | $skeletonDirs[] = $dir; 69 | } 70 | 71 | if (is_dir($dir = $this->getContainer()->get('kernel')->getProjectDir().'/Resources/GeneratorBundle/skeleton')) { 72 | $skeletonDirs[] = $dir; 73 | } 74 | 75 | $skeletonDirs[] = __DIR__.'/../Resources/skeleton'; 76 | $skeletonDirs[] = __DIR__.'/../Resources'; 77 | 78 | return $skeletonDirs; 79 | } 80 | 81 | protected function getQuestionHelper() 82 | { 83 | $question = $this->getHelperSet()->get('question'); 84 | if (!$question || get_class($question) !== QuestionHelper::class) { 85 | $this->getHelperSet()->set($question = new QuestionHelper()); 86 | } 87 | 88 | return $question; 89 | } 90 | 91 | /** 92 | * Tries to make a path relative to the project, which prints nicer. 93 | * 94 | * @param string $absolutePath 95 | * 96 | * @return string 97 | */ 98 | protected function makePathRelative($absolutePath) 99 | { 100 | $projectRootDir = dirname($this->getContainer()->getParameter('kernel.project_dir')); 101 | 102 | return str_replace($projectRootDir.'/', '', realpath($absolutePath) ?: $absolutePath); 103 | } 104 | } 105 | -------------------------------------------------------------------------------- /src/Command/GenerateBundleCommand.php: -------------------------------------------------------------------------------- 1 | setName('pimcore:generate:bundle') 36 | ->setDescription('Generates a Pimcore bundle') 37 | ->setHelp( 38 | <<%command.name% command helps you generates new Pimcore bundles. If you need to create a normal Symfony 40 | bundle, please use the generate:bundle command without pimcore: prefix. 41 | 42 | By default, the command interacts with the developer to tweak the generation. 43 | Any passed option will be used as a default value for the interaction 44 | (--namespace is the only one needed if you follow the 45 | conventions): 46 | 47 | php %command.full_name% --namespace=Acme/BlogBundle 48 | 49 | Note that you can use / instead of \\ for the namespace delimiter to avoid any 50 | problems. 51 | 52 | If you want to disable any user interaction, use --no-interaction but don't forget to pass all needed options: 53 | 54 | php %command.full_name% --namespace=Acme/BlogBundle --dir=src [--bundle-name=...] --no-interaction 55 | 56 | Note that the bundle namespace must end with "Bundle". 57 | EOT 58 | ); 59 | } 60 | 61 | /** 62 | * @inheritDoc 63 | */ 64 | protected function initialize(InputInterface $input, OutputInterface $output) 65 | { 66 | $input->setOption('format', 'annotation'); 67 | 68 | parent::initialize($input, $output); 69 | } 70 | 71 | /** 72 | * @see Command 73 | * 74 | * @throws \InvalidArgumentException When namespace doesn't end with Bundle 75 | * @throws \RuntimeException When bundle can't be executed 76 | * 77 | * @return int 78 | */ 79 | protected function execute(InputInterface $input, OutputInterface $output) 80 | { 81 | $questionHelper = $this->getQuestionHelper(); 82 | 83 | $bundle = $this->createBundleObject($input); 84 | $bundle->setTestsDirectory($bundle->getTargetDirectory() . '/tests'); 85 | 86 | $questionHelper->writeSection($output, 'Bundle generation'); 87 | 88 | /** @var BundleGenerator $generator */ 89 | $generator = $this->getGenerator(); 90 | 91 | $output->writeln(sprintf( 92 | '> Generating a sample bundle skeleton into %s', 93 | $this->makePathRelative($bundle->getTargetDirectory()) 94 | )); 95 | 96 | $generator->generateBundle($bundle); 97 | 98 | $errors = []; 99 | 100 | $runner = $questionHelper->getRunner($output, $errors); 101 | 102 | // check that the namespace is already auto loaded 103 | $runner($this->checkAutoloader($output, $bundle), false); 104 | $runner($this->checkBundleSearchDirectory($bundle), false); 105 | $runner($this->checkBundlesPhp($bundle), false); 106 | 107 | $questionHelper->writeGeneratorSummary($output, $errors); 108 | 109 | return 0; 110 | } 111 | 112 | protected function checkBundleSearchDirectory(Bundle $bundle) 113 | { 114 | return [ 115 | '- Edit the application configuration and make sure', 116 | sprintf(' you have added the %s to the Pimcore bundle search paths: ', $bundle->getRelativeTargetDirectory()), 117 | ' pimcore:', 118 | ' bundles:', 119 | ' search_paths:', 120 | sprintf(' - %s', $bundle->getRelativeTargetDirectory()) 121 | ]; 122 | } 123 | 124 | protected function checkBundlesPhp(Bundle $bundle) 125 | { 126 | return [ 127 | '- Edit the application config/bundles.php and make sure', 128 | sprintf(' you have added the %s to the bundles array like following: ', $bundle->getBundleClassName()), 129 | sprintf(' %s::class => [\'all\' => true],', $bundle->getBundleClassName()) 130 | ]; 131 | } 132 | } 133 | -------------------------------------------------------------------------------- /src/Command/Helper/QuestionHelper.php: -------------------------------------------------------------------------------- 1 | writeSection($output, 'Everything is OK! Now get to work :).'); 30 | } else { 31 | $this->writeSection($output, [ 32 | 'The command was not able to configure everything automatically.', 33 | 'You\'ll need to make the following changes manually.', 34 | ], 'error'); 35 | 36 | $output->writeln($errors); 37 | } 38 | } 39 | 40 | public function getRunner(OutputInterface $output, &$errors) 41 | { 42 | $runner = function ($err, $outputResponseStatus = true) use ($output, &$errors) { 43 | if ($err) { 44 | if ($outputResponseStatus) { 45 | $output->writeln('FAILED'); 46 | } 47 | $errors = array_merge($errors, $err); 48 | } elseif ($outputResponseStatus) { 49 | $output->writeln('OK'); 50 | } 51 | }; 52 | 53 | return $runner; 54 | } 55 | 56 | public function getQuestion($question, $default, $sep = ':') 57 | { 58 | return $default ? sprintf('%s [%s]%s ', $question, $default, $sep) : sprintf('%s%s ', $question, $sep); 59 | } 60 | 61 | public function writeSection(OutputInterface $output, $text, $style = 'bg=blue;fg=white') 62 | { 63 | $text = str_replace('Symfony bundle generator', 'Pimcore bundle generator', $text); 64 | 65 | /** @var FormatterHelper $formatter */ 66 | $formatter = $this->getHelperSet()->get('formatter'); 67 | $output->writeln([ 68 | '', 69 | $formatter->formatBlock($text, $style, true), 70 | '', 71 | ]); 72 | } 73 | } 74 | -------------------------------------------------------------------------------- /src/Command/Validators.php: -------------------------------------------------------------------------------- 1 | load('services.yaml'); 35 | } 36 | } 37 | -------------------------------------------------------------------------------- /src/Generator/BaseBundleGenerator.php: -------------------------------------------------------------------------------- 1 | getTargetDirectory(); 30 | 31 | if (file_exists($dir)) { 32 | if (!is_dir($dir)) { 33 | throw new \RuntimeException(sprintf('Unable to generate the bundle as the target directory "%s" exists but is a file.', realpath($dir))); 34 | } 35 | $files = scandir($dir); 36 | if ($files != ['.', '..']) { 37 | throw new \RuntimeException(sprintf('Unable to generate the bundle as the target directory "%s" is not empty.', realpath($dir))); 38 | } 39 | if (!is_writable($dir)) { 40 | throw new \RuntimeException(sprintf('Unable to generate the bundle as the target directory "%s" is not writable.', realpath($dir))); 41 | } 42 | } 43 | 44 | $parameters = [ 45 | 'namespace' => $bundle->getNamespace(), 46 | 'bundle' => $bundle->getName(), 47 | 'format' => $bundle->getConfigurationFormat(), 48 | 'bundle_basename' => $bundle->getBasename(), 49 | 'extension_alias' => $bundle->getExtensionAlias(), 50 | ]; 51 | 52 | $this->renderFile('bundle/Bundle.php.twig', $dir.'/src/'.$bundle->getName().'.php', $parameters); 53 | if ($bundle->shouldGenerateDependencyInjectionDirectory()) { 54 | $this->renderFile('bundle/Extension.php.twig', $dir.'/src/DependencyInjection/'.$bundle->getBasename().'Extension.php', $parameters); 55 | $this->renderFile('bundle/Configuration.php.twig', $dir.'/src/DependencyInjection/Configuration.php', $parameters); 56 | } 57 | $this->renderFile('bundle/DefaultController.php.twig', $dir.'/src/Controller/DefaultController.php', $parameters); 58 | $this->renderFile('bundle/DefaultControllerTest.php.twig', $bundle->getTestsDirectory().'/Controller/DefaultControllerTest.php', $parameters); 59 | 60 | // render the services.yaml/xml file 61 | $servicesFilename = $bundle->getServicesConfigurationFilename(); 62 | $this->renderFile( 63 | sprintf('bundle/%s.twig', $servicesFilename), 64 | $dir.'/config/'.$servicesFilename, $parameters 65 | ); 66 | 67 | if ($routingFilename = $bundle->getRoutingConfigurationFilename()) { 68 | $this->renderFile( 69 | sprintf('bundle/%s.twig', $routingFilename), 70 | $dir.'/config/pimcore/'.$routingFilename, $parameters 71 | ); 72 | } 73 | } 74 | } 75 | -------------------------------------------------------------------------------- /src/Generator/BundleGenerator.php: -------------------------------------------------------------------------------- 1 | getTargetDirectory(); 30 | 31 | $parameters = [ 32 | 'namespace' => $bundle->getNamespace(), 33 | 'bundle' => $bundle->getName(), 34 | 'format' => $bundle->getConfigurationFormat(), 35 | 'bundle_basename' => $bundle->getBasename(), 36 | 'extension_alias' => $bundle->getExtensionAlias(), 37 | ]; 38 | 39 | $routingFilename = $bundle->getRoutingConfigurationFilename() ?: 'routing.yaml'; 40 | $routingTarget = $dir . '/config/pimcore/' . $routingFilename; 41 | 42 | // create routing file for default annotation 43 | if ($bundle->getConfigurationFormat() == 'annotation') { 44 | self::mkdir(dirname($routingTarget)); 45 | self::dump($routingTarget, ''); 46 | 47 | $routing = new RoutingManipulator($routingTarget); 48 | $routing->addResource($bundle->getName(), 'annotation'); 49 | } else { 50 | // update routing file created by default implementation 51 | $this->renderFile( 52 | sprintf('bundle/%s.twig', $routingFilename), 53 | $dir.'/config/pimcore/'.$routingFilename, $parameters 54 | ); 55 | } 56 | 57 | $this->renderFile( 58 | 'js/pimcore/startup.js.twig', 59 | $dir . '/public/js/pimcore/startup.js', 60 | $parameters 61 | ); 62 | } 63 | } 64 | -------------------------------------------------------------------------------- /src/Generator/Generator.php: -------------------------------------------------------------------------------- 1 | skeletonDirs = is_array($skeletonDirs) ? $skeletonDirs : [$skeletonDirs]; 43 | } 44 | 45 | protected function render($template, $parameters) 46 | { 47 | $twig = $this->getTwigEnvironment(); 48 | 49 | return $twig->render($template, $parameters); 50 | } 51 | 52 | /** 53 | * Gets the twig environment that will render skeletons. 54 | * 55 | * @return Environment 56 | */ 57 | protected function getTwigEnvironment() 58 | { 59 | return new Environment(new FilesystemLoader($this->skeletonDirs), [ 60 | 'debug' => true, 61 | 'cache' => false, 62 | 'strict_variables' => true, 63 | 'autoescape' => false, 64 | ]); 65 | } 66 | 67 | protected function renderFile($template, $target, $parameters) 68 | { 69 | self::mkdir(dirname($target)); 70 | 71 | return self::dump($target, $this->render($template, $parameters)); 72 | } 73 | 74 | /** 75 | * @internal 76 | */ 77 | public static function mkdir($dir, $mode = 0777, $recursive = true) 78 | { 79 | if (!is_dir($dir)) { 80 | mkdir($dir, $mode, $recursive); 81 | self::writeln(sprintf(' created %s', self::relativizePath($dir))); 82 | } 83 | } 84 | 85 | /** 86 | * @internal 87 | */ 88 | public static function dump($filename, $content) 89 | { 90 | if (file_exists($filename)) { 91 | self::writeln(sprintf(' updated %s', self::relativizePath($filename))); 92 | } else { 93 | self::writeln(sprintf(' created %s', self::relativizePath($filename))); 94 | } 95 | 96 | return file_put_contents($filename, $content); 97 | } 98 | 99 | private static function writeln($message) 100 | { 101 | if (null === self::$output) { 102 | self::$output = new ConsoleOutput(); 103 | } 104 | 105 | self::$output->writeln($message); 106 | } 107 | 108 | private static function relativizePath($absolutePath) 109 | { 110 | $relativePath = str_replace(getcwd(), '.', $absolutePath); 111 | 112 | return is_dir($absolutePath) ? rtrim($relativePath, '/').'/' : $relativePath; 113 | } 114 | } 115 | -------------------------------------------------------------------------------- /src/Manipulator/Manipulator.php: -------------------------------------------------------------------------------- 1 | tokens = $tokens; 37 | $this->line = $line; 38 | } 39 | 40 | /** 41 | * Gets the next token. 42 | * 43 | * @return string|null 44 | */ 45 | protected function next() 46 | { 47 | while ($token = array_shift($this->tokens)) { 48 | $this->line += substr_count($this->value($token), "\n"); 49 | 50 | if (is_array($token) && in_array($token[0], [T_WHITESPACE, T_COMMENT, T_DOC_COMMENT])) { 51 | continue; 52 | } 53 | 54 | return $token; 55 | } 56 | 57 | return null; 58 | } 59 | 60 | /** 61 | * Peeks the next token. 62 | * 63 | * @param int $nb 64 | * 65 | * @return string|null 66 | */ 67 | protected function peek($nb = 1) 68 | { 69 | $i = 0; 70 | $tokens = $this->tokens; 71 | while ($token = array_shift($tokens)) { 72 | if (is_array($token) && in_array($token[0], [T_WHITESPACE, T_COMMENT, T_DOC_COMMENT])) { 73 | continue; 74 | } 75 | 76 | ++$i; 77 | if ($i == $nb) { 78 | return $token; 79 | } 80 | } 81 | 82 | return null; 83 | } 84 | 85 | /** 86 | * Gets the value of a token. 87 | * 88 | * @param string|string[] $token The token value 89 | * 90 | * @return string 91 | */ 92 | protected function value($token) 93 | { 94 | return is_array($token) ? $token[1] : $token; 95 | } 96 | } 97 | -------------------------------------------------------------------------------- /src/Manipulator/RoutingManipulator.php: -------------------------------------------------------------------------------- 1 | file = $file; 36 | } 37 | 38 | /** 39 | * Adds a routing resource at the top of the existing ones. 40 | * 41 | * @param string $bundle 42 | * @param string $format 43 | * @param string $prefix 44 | * @param string $path 45 | * 46 | * @return bool Whether the operation succeeded 47 | * 48 | * @throws \RuntimeException If bundle is already imported 49 | */ 50 | public function addResource($bundle, $format, $prefix = '/', $path = 'routing') 51 | { 52 | $current = ''; 53 | $code = sprintf("%s:\n", $this->getImportedResourceYamlKey($bundle, $prefix)); 54 | 55 | if (file_exists($this->file)) { 56 | $current = file_get_contents($this->file); 57 | 58 | // Don't add same bundle twice 59 | if (false !== strpos($current, '@'.$bundle)) { 60 | throw new \RuntimeException(sprintf('Bundle "%s" is already imported.', $bundle)); 61 | } 62 | } elseif (!is_dir($dir = dirname($this->file))) { 63 | Generator::mkdir($dir); 64 | } 65 | 66 | if ('annotation' == $format) { 67 | $code .= sprintf(" resource: \"@%s/src/Controller/\"\n type: annotation\n", $bundle); 68 | } else { 69 | $code .= sprintf(" resource: \"@%s/Resources/config/%s.%s\"\n", $bundle, $path, $format); 70 | } 71 | $code .= sprintf(" prefix: %s\n", $prefix); 72 | $code .= "\n"; 73 | $code .= $current; 74 | 75 | if (false === Generator::dump($this->file, $code)) { 76 | return false; 77 | } 78 | 79 | return true; 80 | } 81 | 82 | public function getImportedResourceYamlKey($bundle, $prefix) 83 | { 84 | $snakeCasedBundleName = Container::underscore(substr($bundle, 0, -6)); 85 | $routePrefix = self::getRouteNamePrefix($prefix); 86 | 87 | return sprintf('%s%s%s', $snakeCasedBundleName, '' !== $routePrefix ? '_' : '', $routePrefix); 88 | } 89 | 90 | private static function getRouteNamePrefix($prefix) 91 | { 92 | $prefix = preg_replace('/{(.*?)}/', '', $prefix); // {foo}_bar -> _bar 93 | $prefix = str_replace('/', '_', $prefix); 94 | $prefix = preg_replace('/_+/', '_', $prefix); // foo__bar -> foo_bar 95 | $prefix = trim($prefix, '_'); 96 | 97 | return $prefix; 98 | } 99 | } 100 | -------------------------------------------------------------------------------- /src/Model/BaseBundle.php: -------------------------------------------------------------------------------- 1 | namespace = $namespace; 42 | $this->name = $name; 43 | $this->targetDirectory = $targetDirectory; 44 | $this->configurationFormat = $configurationFormat; 45 | $this->isShared = $isShared; 46 | $this->testsDirectory = $this->getTargetDirectory().'/tests'; 47 | } 48 | 49 | public function getNamespace() 50 | { 51 | return $this->namespace; 52 | } 53 | 54 | public function getName() 55 | { 56 | return $this->name; 57 | } 58 | 59 | public function getConfigurationFormat() 60 | { 61 | return $this->configurationFormat; 62 | } 63 | 64 | public function isShared() 65 | { 66 | return $this->isShared; 67 | } 68 | 69 | /** 70 | * Returns the directory where the bundle will be generated. 71 | * 72 | * @return string 73 | */ 74 | public function getTargetDirectory() 75 | { 76 | return rtrim($this->targetDirectory, '/').'/'.trim(strtr($this->namespace, '\\', '/'), '/'); 77 | } 78 | 79 | public function getRelativeTargetDirectory() 80 | { 81 | return ltrim(str_replace(PIMCORE_PROJECT_ROOT, '', $this->getTargetDirectory()), '/'); 82 | } 83 | 84 | /** 85 | * Returns the name of the bundle without the Bundle suffix. 86 | * 87 | * @return string 88 | */ 89 | public function getBasename() 90 | { 91 | return substr($this->name, 0, -6); 92 | } 93 | 94 | /** 95 | * Returns the dependency injection extension alias for this bundle. 96 | * 97 | * @return string 98 | */ 99 | public function getExtensionAlias() 100 | { 101 | return Container::underscore($this->getBasename()); 102 | } 103 | 104 | /** 105 | * Should a DependencyInjection directory be generated for this bundle? 106 | * 107 | * @return bool 108 | */ 109 | public function shouldGenerateDependencyInjectionDirectory() 110 | { 111 | return $this->isShared; 112 | } 113 | 114 | /** 115 | * What is the filename for the services.yaml/xml file? 116 | * 117 | * @return string 118 | */ 119 | public function getServicesConfigurationFilename() 120 | { 121 | if ('yaml' === $this->getConfigurationFormat() || 'annotation' === $this->configurationFormat) { 122 | return 'services.yaml'; 123 | } else { 124 | return 'services.'.$this->getConfigurationFormat(); 125 | } 126 | } 127 | 128 | /** 129 | * What is the filename for the routing.yaml/xml file? 130 | * 131 | * If false, no routing file will be generated 132 | * 133 | * @return string|bool 134 | */ 135 | public function getRoutingConfigurationFilename() 136 | { 137 | if ($this->getConfigurationFormat() == 'annotation') { 138 | return false; 139 | } 140 | 141 | return 'routing.'.$this->getConfigurationFormat(); 142 | } 143 | 144 | /** 145 | * Returns the class name of the Bundle class. 146 | * 147 | * @return string 148 | */ 149 | public function getBundleClassName() 150 | { 151 | return $this->namespace.'\\'.$this->name; 152 | } 153 | 154 | public function setTestsDirectory($testsDirectory) 155 | { 156 | $this->testsDirectory = $testsDirectory; 157 | } 158 | 159 | public function getTestsDirectory() 160 | { 161 | return $this->testsDirectory; 162 | } 163 | } 164 | -------------------------------------------------------------------------------- /src/Model/Bundle.php: -------------------------------------------------------------------------------- 1 | request('GET', '/'); 19 | 20 | $this->assertContains('Hello World', $client->getResponse()->getContent()); 21 | } 22 | {% endblock class_body %} 23 | } 24 | -------------------------------------------------------------------------------- /src/Resources/skeleton/bundle/Extension.php.twig: -------------------------------------------------------------------------------- 1 | processConfiguration($configuration, $configs); 31 | 32 | {% if format == 'yaml' or format == 'annotation' -%} 33 | $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../../config')); 34 | $loader->load('services.yaml'); 35 | {%- elseif format == 'xml' -%} 36 | $loader = new Loader\XmlFileLoader($container, new FileLocator(__DIR__.'/../../config')); 37 | $loader->load('services.xml'); 38 | {%- elseif format == 'php' -%} 39 | $loader = new Loader\PhpFileLoader($container, new FileLocator(__DIR__.'/../../config')); 40 | $loader->load('services.php'); 41 | {%- endif %} 42 | 43 | } 44 | {% endblock class_body %} 45 | } 46 | -------------------------------------------------------------------------------- /src/Resources/skeleton/bundle/index.html.twig.twig: -------------------------------------------------------------------------------- 1 | Hello World! 2 | -------------------------------------------------------------------------------- /src/Resources/skeleton/bundle/routing.php.twig: -------------------------------------------------------------------------------- 1 | add('{{ extension_alias }}_homepage', new Route('/{{ extension_alias }}', array( 14 | '_controller' => '{{ namespace }}\Controller\DefaultController::indexAction', 15 | ))); 16 | {% endblock body %} 17 | 18 | {% block return %} 19 | return $collection; 20 | {% endblock return %} 21 | -------------------------------------------------------------------------------- /src/Resources/skeleton/bundle/routing.xml.twig: -------------------------------------------------------------------------------- 1 | 2 | 3 | 6 | 7 | {% block body %} 8 | 9 | {{ namespace }}\Controller\DefaultController::indexAction 10 | 11 | {% endblock body %} 12 | 13 | -------------------------------------------------------------------------------- /src/Resources/skeleton/bundle/routing.yaml.twig: -------------------------------------------------------------------------------- 1 | {{ extension_alias }}_homepage: 2 | path: /{{ extension_alias }} 3 | defaults: { _controller: {{ namespace }}\Controller\DefaultController::indexAction } 4 | -------------------------------------------------------------------------------- /src/Resources/skeleton/bundle/services.php.twig: -------------------------------------------------------------------------------- 1 | setDefinition( 13 | '{{ extension_alias }}.example', 14 | new Definition( 15 | '{{ namespace }}\Example', 16 | array( 17 | new Reference('service_id'), 18 | "plain_value", 19 | new Parameter('parameter_name'), 20 | ) 21 | ) 22 | ); 23 | {% endblock services %} 24 | 25 | */ 26 | -------------------------------------------------------------------------------- /src/Resources/skeleton/bundle/services.xml.twig: -------------------------------------------------------------------------------- 1 | 2 | 3 | 6 | 7 | 18 | 19 | -------------------------------------------------------------------------------- /src/Resources/skeleton/bundle/services.yaml.twig: -------------------------------------------------------------------------------- 1 | services: 2 | {% block services %} 3 | # default configuration for services in *this* file 4 | _defaults: 5 | # automatically injects dependencies in your services 6 | autowire: true 7 | # automatically registers your services as commands, event subscribers, etc. 8 | autoconfigure: true 9 | # this means you cannot fetch services directly from the container via $container->get() 10 | # if you need to do this, you can override this setting on individual services 11 | public: false 12 | 13 | # controllers are imported separately to make sure they're public 14 | # and have a tag that allows actions to type-hint services 15 | {{ namespace }}\Controller\: 16 | resource: '../src/Controller' 17 | public: true 18 | tags: ['controller.service_arguments'] 19 | 20 | # add more services, or override services that need manual wiring 21 | # {{ namespace }}\ExampleClass: 22 | # arguments: 23 | # - "@service_id" 24 | # - "plain_value" 25 | # - "%parameter%" 26 | {% endblock services %} 27 | -------------------------------------------------------------------------------- /src/Resources/skeleton/js/pimcore/startup.js.twig: -------------------------------------------------------------------------------- 1 | pimcore.registerNS("pimcore.plugin.{{ bundle }}"); 2 | 3 | pimcore.plugin.{{ bundle }} = Class.create({ 4 | 5 | initialize: function () { 6 | document.addEventListener(pimcore.events.pimcoreReady, this.pimcoreReady.bind(this)); 7 | }, 8 | 9 | pimcoreReady: function (e) { 10 | // alert("{{ bundle }} ready!"); 11 | } 12 | }); 13 | 14 | var {{ bundle }}Plugin = new pimcore.plugin.{{ bundle }}(); 15 | --------------------------------------------------------------------------------