| <?xml version="1.0" encoding="UTF-8"?> |
| <!-- |
| |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| |
| --> |
| |
| <symfony> |
| <commands> |
| <command id="help" name="help"> |
| <usage>help [--xml] [command_name]</usage> |
| <description>Displays help for a command</description> |
| <help>The <info>help</info> command displays help for a given command: |
| |
| <info>php app/console help list</info> |
| |
| You can also output the help as XML by using the <comment>--xml</comment> option: |
| |
| <info>php app/console help --xml list</info></help> |
| <aliases/> |
| <arguments> |
| <argument name="command_name" is_required="0" is_array="0"> |
| <description>The command name</description> |
| <defaults> |
| <default>help</default> |
| </defaults> |
| </argument> |
| </arguments> |
| <options> |
| <option name="--xml" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>To output help as XML</description> |
| </option> |
| </options> |
| </command> |
| <command id="list" name="list"> |
| <usage>list [--xml] [--raw] [namespace]</usage> |
| <description>Lists commands</description> |
| <help>The <info>list</info> command lists all commands: |
| |
| <info>php app/console list</info> |
| |
| You can also display the commands for a specific namespace: |
| |
| <info>php app/console list test</info> |
| |
| You can also output the information as XML by using the <comment>--xml</comment> option: |
| |
| <info>php app/console list --xml</info> |
| |
| It's also possible to get raw list of commands (useful for embedding command runner): |
| |
| <info>php app/console list --raw</info></help> |
| <aliases/> |
| <arguments> |
| <argument name="namespace" is_required="0" is_array="0"> |
| <description>The namespace name</description> |
| <defaults/> |
| </argument> |
| </arguments> |
| <options> |
| <option name="--xml" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>To output help as XML</description> |
| </option> |
| <option name="--raw" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>To output raw command list</description> |
| </option> |
| </options> |
| </command> |
| <command id="assetic:dump" name="assetic:dump"> |
| <usage>assetic:dump [--watch] [--force] [--period="..."] [write_to]</usage> |
| <description>Dumps all assets to the filesystem</description> |
| <help></help> |
| <aliases/> |
| <arguments> |
| <argument name="write_to" is_required="0" is_array="0"> |
| <description>Override the configured asset root</description> |
| <defaults/> |
| </argument> |
| </arguments> |
| <options> |
| <option name="--watch" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>Check for changes every second, debug mode only</description> |
| </option> |
| <option name="--force" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>Force an initial generation of all assets (used with --watch)</description> |
| </option> |
| <option name="--period" shortcut="" accept_value="1" is_value_required="1" is_multiple="0"> |
| <description>Set the polling period in seconds (used with --watch)</description> |
| <defaults> |
| <default>1</default> |
| </defaults> |
| </option> |
| </options> |
| </command> |
| <command id="assets:install" name="assets:install"> |
| <usage>assets:install [--symlink] [--relative] [target]</usage> |
| <description>Installs bundles web assets under a public web directory</description> |
| <help>The <info>assets:install</info> command installs bundle assets into a given |
| directory (e.g. the web directory). |
| |
| <info>php app/console assets:install web</info> |
| |
| A "bundles" directory will be created inside the target directory, and the |
| "Resources/public" directory of each bundle will be copied into it. |
| |
| To create a symlink to each bundle instead of copying its assets, use the |
| <info>--symlink</info> option: |
| |
| <info>php app/console assets:install web --symlink</info> |
| |
| To make symlink relative, add the <info>--relative</info> option: |
| |
| <info>php app/console assets:install web --symlink --relative</info> |
| </help> |
| <aliases/> |
| <arguments> |
| <argument name="target" is_required="0" is_array="0"> |
| <description>The target directory</description> |
| <defaults> |
| <default>web</default> |
| </defaults> |
| </argument> |
| </arguments> |
| <options> |
| <option name="--symlink" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>Symlinks the assets instead of copying it</description> |
| </option> |
| <option name="--relative" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>Make relative symlinks</description> |
| </option> |
| </options> |
| </command> |
| <command id="cache:clear" name="cache:clear"> |
| <usage>cache:clear [--no-warmup] [--no-optional-warmers]</usage> |
| <description>Clears the cache</description> |
| <help>The <info>cache:clear</info> command clears the application cache for a given environment |
| and debug mode: |
| |
| <info>php app/console cache:clear --env=dev</info> |
| <info>php app/console cache:clear --env=prod --no-debug</info></help> |
| <aliases/> |
| <arguments/> |
| <options> |
| <option name="--no-warmup" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>Do not warm up the cache</description> |
| </option> |
| <option name="--no-optional-warmers" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>Skip optional cache warmers (faster)</description> |
| </option> |
| </options> |
| </command> |
| <command id="cache:warmup" name="cache:warmup"> |
| <usage>cache:warmup [--no-optional-warmers]</usage> |
| <description>Warms up an empty cache</description> |
| <help>The <info>cache:warmup</info> command warms up the cache. |
| |
| Before running this command, the cache must be empty. |
| |
| This command does not generate the classes cache (as when executing this |
| command, too many classes that should be part of the cache are already loaded |
| in memory). Use <comment>curl</comment> or any other similar tool to warm up |
| the classes cache if you want.</help> |
| <aliases/> |
| <arguments/> |
| <options> |
| <option name="--no-optional-warmers" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>Skip optional cache warmers (faster)</description> |
| </option> |
| </options> |
| </command> |
| <command id="config:dump-reference" name="config:dump-reference"> |
| <usage>config:dump-reference name</usage> |
| <description>Dumps default configuration for an extension</description> |
| <help>The <info>config:dump-reference</info> command dumps the default configuration for an extension/bundle. |
| |
| The extension alias or bundle name can be used: |
| |
| Example: |
| |
| <info>php app/console config:dump-reference framework</info> |
| |
| or |
| |
| <info>php app/console config:dump-reference FrameworkBundle</info></help> |
| <aliases/> |
| <arguments> |
| <argument name="name" is_required="1" is_array="0"> |
| <description>The Bundle or extension alias</description> |
| <defaults/> |
| </argument> |
| </arguments> |
| <options/> |
| </command> |
| <command id="container:debug" name="container:debug"> |
| <usage>container:debug [--show-private] [name]</usage> |
| <description>Displays current services for an application</description> |
| <help>The <info>container:debug</info> command displays all configured <comment>public</comment> services: |
| |
| <info>php app/console container:debug</info> |
| |
| To get specific information about a service, specify its name: |
| |
| <info>php app/console container:debug validator</info> |
| |
| By default, private services are hidden. You can display all services by |
| using the --show-private flag: |
| |
| <info>php app/console container:debug --show-private</info></help> |
| <aliases/> |
| <arguments> |
| <argument name="name" is_required="0" is_array="0"> |
| <description>A service name (foo)</description> |
| <defaults/> |
| </argument> |
| </arguments> |
| <options> |
| <option name="--show-private" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>Use to show public *and* private services</description> |
| </option> |
| </options> |
| </command> |
| <command id="doctrine:cache:clear-metadata" name="doctrine:cache:clear-metadata"> |
| <usage>doctrine:cache:clear-metadata [--flush] [--em[="..."]]</usage> |
| <description>Clears all metadata cache for a entity manager</description> |
| <help>The <info>doctrine:cache:clear-metadata</info> command clears all metadata |
| cache for the default entity manager: |
| |
| <info>php app/console doctrine:cache:clear-metadata</info> |
| |
| You can also optionally specify the <comment>--em</comment> option to specify |
| which entity manager to clear the cache for: |
| |
| <info>php app/console doctrine:cache:clear-metadata --em=default</info></help> |
| <aliases/> |
| <arguments/> |
| <options> |
| <option name="--flush" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>If defined, cache entries will be flushed instead of deleted/invalidated.</description> |
| </option> |
| <option name="--em" shortcut="" accept_value="1" is_value_required="0" is_multiple="0"> |
| <description>The entity manager to use for this command</description> |
| <defaults/> |
| </option> |
| </options> |
| </command> |
| <command id="doctrine:cache:clear-query" name="doctrine:cache:clear-query"> |
| <usage>doctrine:cache:clear-query [--flush] [--em[="..."]]</usage> |
| <description>Clears all query cache for a entity manager</description> |
| <help>The <info>doctrine:cache:clear-query</info> command clears all query cache for |
| the default entity manager: |
| |
| <info>php app/console doctrine:cache:clear-query</info> |
| |
| You can also optionally specify the <comment>--em</comment> option to specify |
| which entity manager to clear the cache for: |
| |
| <info>php app/console doctrine:cache:clear-query --em=default</info></help> |
| <aliases/> |
| <arguments/> |
| <options> |
| <option name="--flush" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>If defined, cache entries will be flushed instead of deleted/invalidated.</description> |
| </option> |
| <option name="--em" shortcut="" accept_value="1" is_value_required="0" is_multiple="0"> |
| <description>The entity manager to use for this command</description> |
| <defaults/> |
| </option> |
| </options> |
| </command> |
| <command id="doctrine:cache:clear-result" name="doctrine:cache:clear-result"> |
| <usage>doctrine:cache:clear-result [--flush] [--em[="..."]]</usage> |
| <description>Clears result cache for a entity manager</description> |
| <help>The <info>doctrine:cache:clear-result</info> command clears all result cache |
| for the default entity manager: |
| |
| <info>php app/console doctrine:cache:clear-result</info> |
| |
| You can also optionally specify the <comment>--em</comment> option to specify |
| which entity manager to clear the cache for: |
| |
| <info>php app/console doctrine:cache:clear-result --em=default</info></help> |
| <aliases/> |
| <arguments/> |
| <options> |
| <option name="--flush" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>If defined, cache entries will be flushed instead of deleted/invalidated.</description> |
| </option> |
| <option name="--em" shortcut="" accept_value="1" is_value_required="0" is_multiple="0"> |
| <description>The entity manager to use for this command</description> |
| <defaults/> |
| </option> |
| </options> |
| </command> |
| <command id="doctrine:database:create" name="doctrine:database:create"> |
| <usage>doctrine:database:create [--connection[="..."]]</usage> |
| <description>Creates the configured databases</description> |
| <help>The <info>doctrine:database:create</info> command creates the default |
| connections database: |
| |
| <info>php app/console doctrine:database:create</info> |
| |
| You can also optionally specify the name of a connection to create the |
| database for: |
| |
| <info>php app/console doctrine:database:create --connection=default</info></help> |
| <aliases/> |
| <arguments/> |
| <options> |
| <option name="--connection" shortcut="" accept_value="1" is_value_required="0" is_multiple="0"> |
| <description>The connection to use for this command</description> |
| <defaults/> |
| </option> |
| </options> |
| </command> |
| <command id="doctrine:database:drop" name="doctrine:database:drop"> |
| <usage>doctrine:database:drop [--connection[="..."]] [--force]</usage> |
| <description>Drops the configured databases</description> |
| <help>The <info>doctrine:database:drop</info> command drops the default connections |
| database: |
| |
| <info>php app/console doctrine:database:drop</info> |
| |
| The --force parameter has to be used to actually drop the database. |
| |
| You can also optionally specify the name of a connection to drop the database |
| for: |
| |
| <info>php app/console doctrine:database:drop --connection=default</info> |
| |
| <error>Be careful: All data in a given database will be lost when executing |
| this command.</error></help> |
| <aliases/> |
| <arguments/> |
| <options> |
| <option name="--connection" shortcut="" accept_value="1" is_value_required="0" is_multiple="0"> |
| <description>The connection to use for this command</description> |
| <defaults/> |
| </option> |
| <option name="--force" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>Set this parameter to execute this action</description> |
| </option> |
| </options> |
| </command> |
| <command id="doctrine:ensure-production-settings" name="doctrine:ensure-production-settings"> |
| <usage>doctrine:ensure-production-settings [--complete] [--em[="..."]]</usage> |
| <description>Verify that Doctrine is properly configured for a production environment.</description> |
| <help>The <info>doctrine:ensure-production-settings</info> command ensures that |
| Doctrine is properly configured for a production environment.: |
| |
| <info>php app/console doctrine:ensure-production-settings</info> |
| |
| You can also optionally specify the <comment>--em</comment> option to specify |
| which entity manager to use: |
| |
| <info>php app/console doctrine:ensure-production-settings --em=default</info></help> |
| <aliases/> |
| <arguments/> |
| <options> |
| <option name="--complete" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>Flag to also inspect database connection existance.</description> |
| </option> |
| <option name="--em" shortcut="" accept_value="1" is_value_required="0" is_multiple="0"> |
| <description>The entity manager to use for this command</description> |
| <defaults/> |
| </option> |
| </options> |
| </command> |
| <command id="doctrine:generate:crud" name="doctrine:generate:crud"> |
| <usage>doctrine:generate:crud [--entity="..."] [--route-prefix="..."] [--with-write] [--format="..."]</usage> |
| <description>Generates a CRUD based on a Doctrine entity</description> |
| <help>The <info>doctrine:generate:crud</info> command generates a CRUD based on a Doctrine entity. |
| |
| The default command only generates the list and show actions. |
| |
| <info>php app/console doctrine:generate:crud --entity=AcmeBlogBundle:Post --route-prefix=post_admin</info> |
| |
| Using the --with-write option allows to generate the new, edit and delete actions. |
| |
| <info>php app/console doctrine:generate:crud --entity=AcmeBlogBundle:Post --route-prefix=post_admin --with-write</info></help> |
| <aliases> |
| <alias>generate:doctrine:crud</alias> |
| </aliases> |
| <arguments/> |
| <options> |
| <option name="--entity" shortcut="" accept_value="1" is_value_required="1" is_multiple="0"> |
| <description>The entity class name to initialize (shortcut notation)</description> |
| <defaults/> |
| </option> |
| <option name="--route-prefix" shortcut="" accept_value="1" is_value_required="1" is_multiple="0"> |
| <description>The route prefix</description> |
| <defaults/> |
| </option> |
| <option name="--with-write" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>Whether or not to generate create, new and delete actions</description> |
| </option> |
| <option name="--format" shortcut="" accept_value="1" is_value_required="1" is_multiple="0"> |
| <description>Use the format for configuration files (php, xml, yml, or annotation)</description> |
| <defaults> |
| <default>annotation</default> |
| </defaults> |
| </option> |
| </options> |
| </command> |
| <command id="doctrine:generate:entities" name="doctrine:generate:entities"> |
| <usage>doctrine:generate:entities [--path="..."] [--no-backup] name</usage> |
| <description>Generates entity classes and method stubs from your mapping information</description> |
| <help>The <info>doctrine:generate:entities</info> command generates entity classes |
| and method stubs from your mapping information: |
| |
| You have to limit generation of entities: |
| |
| * To a bundle: |
| |
| <info>php app/console doctrine:generate:entities MyCustomBundle</info> |
| |
| * To a single entity: |
| |
| <info>php app/console doctrine:generate:entities MyCustomBundle:User</info> |
| <info>php app/console doctrine:generate:entities MyCustomBundle/Entity/User</info> |
| |
| * To a namespace |
| |
| <info>php app/console doctrine:generate:entities MyCustomBundle/Entity</info> |
| |
| If the entities are not stored in a bundle, and if the classes do not exist, |
| the command has no way to guess where they should be generated. In this case, |
| you must provide the <comment>--path</comment> option: |
| |
| <info>php app/console doctrine:generate:entities Blog/Entity --path=src/</info> |
| |
| By default, the unmodified version of each entity is backed up and saved |
| (e.g. Product.php~). To prevent this task from creating the backup file, |
| pass the <comment>--no-backup</comment> option: |
| |
| <info>php app/console doctrine:generate:entities Blog/Entity --no-backup</info> |
| |
| <error>Important:</error> Even if you specified Inheritance options in your |
| XML or YAML Mapping files the generator cannot generate the base and |
| child classes for you correctly, because it doesn't know which |
| class is supposed to extend which. You have to adjust the entity |
| code manually for inheritance to work! |
| </help> |
| <aliases> |
| <alias>generate:doctrine:entities</alias> |
| </aliases> |
| <arguments> |
| <argument name="name" is_required="1" is_array="0"> |
| <description>A bundle name, a namespace, or a class name</description> |
| <defaults/> |
| </argument> |
| </arguments> |
| <options> |
| <option name="--path" shortcut="" accept_value="1" is_value_required="1" is_multiple="0"> |
| <description>The path where to generate entities when it cannot be guessed</description> |
| <defaults/> |
| </option> |
| <option name="--no-backup" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>Do not backup existing entities files.</description> |
| </option> |
| </options> |
| </command> |
| <command id="doctrine:generate:entity" name="doctrine:generate:entity"> |
| <usage>doctrine:generate:entity [--entity="..."] [--fields="..."] [--format="..."] [--with-repository]</usage> |
| <description>Generates a new Doctrine entity inside a bundle</description> |
| <help>The <info>doctrine:generate:entity</info> task generates a new Doctrine |
| entity inside a bundle: |
| |
| <info>php app/console doctrine:generate:entity --entity=AcmeBlogBundle:Blog/Post</info> |
| |
| The above command would initialize a new entity in the following entity |
| namespace <info>Acme\BlogBundle\Entity\Blog\Post</info>. |
| |
| You can also optionally specify the fields you want to generate in the new |
| entity: |
| |
| <info>php app/console doctrine:generate:entity --entity=AcmeBlogBundle:Blog/Post --fields="title:string(255) body:text"</info> |
| |
| The command can also generate the corresponding entity repository class with the |
| <comment>--with-repository</comment> option: |
| |
| <info>php app/console doctrine:generate:entity --entity=AcmeBlogBundle:Blog/Post --with-repository</info> |
| |
| By default, the command uses annotations for the mapping information; change it |
| with <comment>--format</comment>: |
| |
| <info>php app/console doctrine:generate:entity --entity=AcmeBlogBundle:Blog/Post --format=yml</info> |
| |
| To deactivate the interaction mode, simply use the `--no-interaction` option |
| without forgetting to pass all needed options: |
| |
| <info>php app/console doctrine:generate:entity --entity=AcmeBlogBundle:Blog/Post --format=annotation --fields="title:string(255) body:text" --with-repository --no-interaction</info></help> |
| <aliases> |
| <alias>generate:doctrine:entity</alias> |
| </aliases> |
| <arguments/> |
| <options> |
| <option name="--entity" shortcut="" accept_value="1" is_value_required="1" is_multiple="0"> |
| <description>The entity class name to initialize (shortcut notation)</description> |
| <defaults/> |
| </option> |
| <option name="--fields" shortcut="" accept_value="1" is_value_required="1" is_multiple="0"> |
| <description>The fields to create with the new entity</description> |
| <defaults/> |
| </option> |
| <option name="--format" shortcut="" accept_value="1" is_value_required="1" is_multiple="0"> |
| <description>Use the format for configuration files (php, xml, yml, or annotation)</description> |
| <defaults> |
| <default>annotation</default> |
| </defaults> |
| </option> |
| <option name="--with-repository" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>Whether to generate the entity repository or not</description> |
| </option> |
| </options> |
| </command> |
| <command id="doctrine:generate:form" name="doctrine:generate:form"> |
| <usage>doctrine:generate:form entity</usage> |
| <description>Generates a form type class based on a Doctrine entity</description> |
| <help>The <info>doctrine:generate:form</info> command generates a form class based on a Doctrine entity. |
| |
| <info>php app/console doctrine:generate:form AcmeBlogBundle:Post</info></help> |
| <aliases> |
| <alias>generate:doctrine:form</alias> |
| </aliases> |
| <arguments> |
| <argument name="entity" is_required="1" is_array="0"> |
| <description>The entity class name to initialize (shortcut notation)</description> |
| <defaults/> |
| </argument> |
| </arguments> |
| <options/> |
| </command> |
| <command id="doctrine:mapping:convert" name="doctrine:mapping:convert"> |
| <usage>doctrine:mapping:convert [--filter="..."] [--force] [--from-database] [--extend[="..."]] [--num-spaces[="..."]] [--namespace[="..."]] [--em[="..."]] to-type dest-path</usage> |
| <description>Convert mapping information between supported formats.</description> |
| <help>The <info>doctrine:mapping:convert</info> command converts mapping information |
| between supported formats: |
| |
| <info>php app/console doctrine:mapping:convert xml /path/to/output</info></help> |
| <aliases/> |
| <arguments> |
| <argument name="to-type" is_required="1" is_array="0"> |
| <description>The mapping type to be converted.</description> |
| <defaults/> |
| </argument> |
| <argument name="dest-path" is_required="1" is_array="0"> |
| <description>The path to generate your entities classes.</description> |
| <defaults/> |
| </argument> |
| </arguments> |
| <options> |
| <option name="--filter" shortcut="" accept_value="1" is_value_required="1" is_multiple="1"> |
| <description>A string pattern used to match entities that should be processed.</description> |
| <defaults/> |
| </option> |
| <option name="--force" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>Force to overwrite existing mapping files.</description> |
| </option> |
| <option name="--from-database" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>Whether or not to convert mapping information from existing database.</description> |
| </option> |
| <option name="--extend" shortcut="" accept_value="1" is_value_required="0" is_multiple="0"> |
| <description>Defines a base class to be extended by generated entity classes.</description> |
| <defaults/> |
| </option> |
| <option name="--num-spaces" shortcut="" accept_value="1" is_value_required="0" is_multiple="0"> |
| <description>Defines the number of indentation spaces</description> |
| <defaults> |
| <default>4</default> |
| </defaults> |
| </option> |
| <option name="--namespace" shortcut="" accept_value="1" is_value_required="0" is_multiple="0"> |
| <description>Defines a namespace for the generated entity classes, if converted from database.</description> |
| <defaults/> |
| </option> |
| <option name="--em" shortcut="" accept_value="1" is_value_required="0" is_multiple="0"> |
| <description>The entity manager to use for this command</description> |
| <defaults/> |
| </option> |
| </options> |
| </command> |
| <command id="doctrine:mapping:import" name="doctrine:mapping:import"> |
| <usage>doctrine:mapping:import [--em[="..."]] [--filter="..."] [--force] bundle [mapping-type]</usage> |
| <description>Imports mapping information from an existing database</description> |
| <help>The <info>doctrine:mapping:import</info> command imports mapping information |
| from an existing database: |
| |
| <info>php app/console doctrine:mapping:import "MyCustomBundle" xml</info> |
| |
| You can also optionally specify which entity manager to import from with the |
| <info>--em</info> option: |
| |
| <info>php app/console doctrine:mapping:import "MyCustomBundle" xml --em=default</info> |
| |
| If you don't want to map every entity that can be found in the database, use the |
| <info>--filter</info> option. It will try to match the targeted mapped entity with the |
| provided pattern string. |
| |
| <info>php app/console doctrine:mapping:import "MyCustomBundle" xml --filter=MyMatchedEntity</info> |
| |
| Use the <info>--force</info> option, if you want to override existing mapping files: |
| |
| <info>php app/console doctrine:mapping:import "MyCustomBundle" xml --force</info></help> |
| <aliases/> |
| <arguments> |
| <argument name="bundle" is_required="1" is_array="0"> |
| <description>The bundle to import the mapping information to</description> |
| <defaults/> |
| </argument> |
| <argument name="mapping-type" is_required="0" is_array="0"> |
| <description>The mapping type to export the imported mapping information to</description> |
| <defaults/> |
| </argument> |
| </arguments> |
| <options> |
| <option name="--em" shortcut="" accept_value="1" is_value_required="0" is_multiple="0"> |
| <description>The entity manager to use for this command</description> |
| <defaults/> |
| </option> |
| <option name="--filter" shortcut="" accept_value="1" is_value_required="1" is_multiple="1"> |
| <description>A string pattern used to match entities that should be mapped.</description> |
| <defaults/> |
| </option> |
| <option name="--force" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>Force to overwrite existing mapping files.</description> |
| </option> |
| </options> |
| </command> |
| <command id="doctrine:mapping:info" name="doctrine:mapping:info"> |
| <usage>doctrine:mapping:info [--em[="..."]]</usage> |
| <description>Shows basic information about all mapped entities</description> |
| <help>The <info>doctrine:mapping:info</info> shows basic information about which |
| entities exist and possibly if their mapping information contains errors or |
| not. |
| |
| <info>php app/console doctrine:mapping:info</info> |
| |
| If you are using multiple entity managers you can pick your choice with the |
| <info>--em</info> option: |
| |
| <info>php app/console doctrine:mapping:info --em=default</info></help> |
| <aliases/> |
| <arguments/> |
| <options> |
| <option name="--em" shortcut="" accept_value="1" is_value_required="0" is_multiple="0"> |
| <description>The entity manager to use for this command</description> |
| <defaults/> |
| </option> |
| </options> |
| </command> |
| <command id="doctrine:query:dql" name="doctrine:query:dql"> |
| <usage>doctrine:query:dql [--hydrate="..."] [--first-result="..."] [--max-result="..."] [--depth="..."] [--em[="..."]] dql</usage> |
| <description>Executes arbitrary DQL directly from the command line.</description> |
| <help>The <info>doctrine:query:dql</info> command executes the given DQL query and |
| outputs the results: |
| |
| <info>php app/console doctrine:query:dql "SELECT u FROM UserBundle:User u"</info> |
| |
| You can also optional specify some additional options like what type of |
| hydration to use when executing the query: |
| |
| <info>php app/console doctrine:query:dql "SELECT u FROM UserBundle:User u" --hydrate=array</info> |
| |
| Additionally you can specify the first result and maximum amount of results to |
| show: |
| |
| <info>php app/console doctrine:query:dql "SELECT u FROM UserBundle:User u" --first-result=0 --max-result=30</info></help> |
| <aliases/> |
| <arguments> |
| <argument name="dql" is_required="1" is_array="0"> |
| <description>The DQL to execute.</description> |
| <defaults/> |
| </argument> |
| </arguments> |
| <options> |
| <option name="--hydrate" shortcut="" accept_value="1" is_value_required="1" is_multiple="0"> |
| <description>Hydration mode of result set. Should be either: object, array, scalar or single-scalar.</description> |
| <defaults> |
| <default>object</default> |
| </defaults> |
| </option> |
| <option name="--first-result" shortcut="" accept_value="1" is_value_required="1" is_multiple="0"> |
| <description>The first result in the result set.</description> |
| <defaults/> |
| </option> |
| <option name="--max-result" shortcut="" accept_value="1" is_value_required="1" is_multiple="0"> |
| <description>The maximum number of results in the result set.</description> |
| <defaults/> |
| </option> |
| <option name="--depth" shortcut="" accept_value="1" is_value_required="1" is_multiple="0"> |
| <description>Dumping depth of Entity graph.</description> |
| <defaults> |
| <default>7</default> |
| </defaults> |
| </option> |
| <option name="--em" shortcut="" accept_value="1" is_value_required="0" is_multiple="0"> |
| <description>The entity manager to use for this command</description> |
| <defaults/> |
| </option> |
| </options> |
| </command> |
| <command id="doctrine:query:sql" name="doctrine:query:sql"> |
| <usage>doctrine:query:sql [--depth="..."] [--connection[="..."]] sql</usage> |
| <description>Executes arbitrary SQL directly from the command line.</description> |
| <help>The <info>doctrine:query:sql</info> command executes the given SQL query and |
| outputs the results: |
| |
| <info>php app/console doctrine:query:sql "SELECT * from user"</info></help> |
| <aliases/> |
| <arguments> |
| <argument name="sql" is_required="1" is_array="0"> |
| <description>The SQL statement to execute.</description> |
| <defaults/> |
| </argument> |
| </arguments> |
| <options> |
| <option name="--depth" shortcut="" accept_value="1" is_value_required="1" is_multiple="0"> |
| <description>Dumping depth of result set.</description> |
| <defaults> |
| <default>7</default> |
| </defaults> |
| </option> |
| <option name="--connection" shortcut="" accept_value="1" is_value_required="0" is_multiple="0"> |
| <description>The connection to use for this command</description> |
| <defaults/> |
| </option> |
| </options> |
| </command> |
| <command id="doctrine:schema:create" name="doctrine:schema:create"> |
| <usage>doctrine:schema:create [--dump-sql] [--em[="..."]]</usage> |
| <description>Executes (or dumps) the SQL needed to generate the database schema</description> |
| <help>The <info>doctrine:schema:create</info> command executes the SQL needed to |
| generate the database schema for the default entity manager: |
| |
| <info>php app/console doctrine:schema:create</info> |
| |
| You can also generate the database schema for a specific entity manager: |
| |
| <info>php app/console doctrine:schema:create --em=default</info> |
| |
| Finally, instead of executing the SQL, you can output the SQL: |
| |
| <info>php app/console doctrine:schema:create --dump-sql</info></help> |
| <aliases/> |
| <arguments/> |
| <options> |
| <option name="--dump-sql" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>Instead of try to apply generated SQLs into EntityManager Storage Connection, output them.</description> |
| </option> |
| <option name="--em" shortcut="" accept_value="1" is_value_required="0" is_multiple="0"> |
| <description>The entity manager to use for this command</description> |
| <defaults/> |
| </option> |
| </options> |
| </command> |
| <command id="doctrine:schema:drop" name="doctrine:schema:drop"> |
| <usage>doctrine:schema:drop [--dump-sql] [--force] [--full-database] [--em[="..."]]</usage> |
| <description>Executes (or dumps) the SQL needed to drop the current database schema</description> |
| <help>The <info>doctrine:schema:drop</info> command generates the SQL needed to |
| drop the database schema of the default entity manager: |
| |
| <info>php app/console doctrine:schema:drop --dump-sql</info> |
| |
| Alternatively, you can execute the generated queries: |
| |
| <info>php app/console doctrine:schema:drop --force</info> |
| |
| You can also optionally specify the name of a entity manager to drop the |
| schema for: |
| |
| <info>php app/console doctrine:schema:drop --em=default</info></help> |
| <aliases/> |
| <arguments/> |
| <options> |
| <option name="--dump-sql" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>Instead of try to apply generated SQLs into EntityManager Storage Connection, output them.</description> |
| </option> |
| <option name="--force" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>Don't ask for the deletion of the database, but force the operation to run.</description> |
| </option> |
| <option name="--full-database" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>Instead of using the Class Metadata to detect the database table schema, drop ALL assets that the database contains.</description> |
| </option> |
| <option name="--em" shortcut="" accept_value="1" is_value_required="0" is_multiple="0"> |
| <description>The entity manager to use for this command</description> |
| <defaults/> |
| </option> |
| </options> |
| </command> |
| <command id="doctrine:schema:update" name="doctrine:schema:update"> |
| <usage>doctrine:schema:update [--complete] [--dump-sql] [--force] [--em[="..."]]</usage> |
| <description>Executes (or dumps) the SQL needed to update the database schema to match the current mapping metadata</description> |
| <help>The <info>doctrine:schema:update</info> command generates the SQL needed to |
| synchronize the database schema with the current mapping metadata of the |
| default entity manager. |
| |
| For example, if you add metadata for a new column to an entity, this command |
| would generate and output the SQL needed to add the new column to the database: |
| |
| <info>php app/console doctrine:schema:update --dump-sql</info> |
| |
| Alternatively, you can execute the generated queries: |
| |
| <info>php app/console doctrine:schema:update --force</info> |
| |
| You can also update the database schema for a specific entity manager: |
| |
| <info>php app/console doctrine:schema:update --em=default</info></help> |
| <aliases/> |
| <arguments/> |
| <options> |
| <option name="--complete" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>If defined, all assets of the database which are not relevant to the current metadata will be dropped.</description> |
| </option> |
| <option name="--dump-sql" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>Dumps the generated SQL statements to the screen (does not execute them).</description> |
| </option> |
| <option name="--force" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>Causes the generated SQL statements to be physically executed against your database.</description> |
| </option> |
| <option name="--em" shortcut="" accept_value="1" is_value_required="0" is_multiple="0"> |
| <description>The entity manager to use for this command</description> |
| <defaults/> |
| </option> |
| </options> |
| </command> |
| <command id="doctrine:schema:validate" name="doctrine:schema:validate"> |
| <usage>doctrine:schema:validate [--em[="..."]]</usage> |
| <description>Validates the doctrine mapping files</description> |
| <help>The <info>doctrine:schema:validate</info> checks the current mappings |
| for valid forward and reverse mappings. |
| |
| <info>php app/console doctrine:schema:validate</info> |
| |
| You can also optionally specify the <comment>--em</comment> option to specify |
| which entity manager use for the validation. |
| |
| <info>php app/console doctrine:schema:validate --em=default</info></help> |
| <aliases/> |
| <arguments/> |
| <options> |
| <option name="--em" shortcut="" accept_value="1" is_value_required="0" is_multiple="0"> |
| <description>The entity manager to use for this command</description> |
| <defaults/> |
| </option> |
| </options> |
| </command> |
| <command id="generate:bundle" name="generate:bundle"> |
| <usage>generate:bundle [--namespace="..."] [--dir="..."] [--bundle-name="..."] [--format="..."] [--structure]</usage> |
| <description>Generates a bundle</description> |
| <help>The <info>generate:bundle</info> command helps you generates new bundles. |
| |
| By default, the command interacts with the developer to tweak the generation. |
| Any passed option will be used as a default value for the interaction |
| (<comment>--namespace</comment> is the only one needed if you follow the |
| conventions): |
| |
| <info>php app/console generate:bundle --namespace=Acme/BlogBundle</info> |
| |
| Note that you can use <comment>/</comment> instead of <comment>\ </comment>for the namespace delimiter to avoid any |
| problem. |
| |
| If you want to disable any user interaction, use <comment>--no-interaction</comment> but don't forget to pass all needed options: |
| |
| <info>php app/console generate:bundle --namespace=Acme/BlogBundle --dir=src [--bundle-name=...] --no-interaction</info> |
| |
| Note that the bundle namespace must end with "Bundle".</help> |
| <aliases/> |
| <arguments/> |
| <options> |
| <option name="--namespace" shortcut="" accept_value="1" is_value_required="1" is_multiple="0"> |
| <description>The namespace of the bundle to create</description> |
| <defaults/> |
| </option> |
| <option name="--dir" shortcut="" accept_value="1" is_value_required="1" is_multiple="0"> |
| <description>The directory where to create the bundle</description> |
| <defaults/> |
| </option> |
| <option name="--bundle-name" shortcut="" accept_value="1" is_value_required="1" is_multiple="0"> |
| <description>The optional bundle name</description> |
| <defaults/> |
| </option> |
| <option name="--format" shortcut="" accept_value="1" is_value_required="1" is_multiple="0"> |
| <description>Use the format for configuration files (php, xml, yml, or annotation)</description> |
| <defaults> |
| <default>annotation</default> |
| </defaults> |
| </option> |
| <option name="--structure" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>Whether to generate the whole directory structure</description> |
| </option> |
| </options> |
| </command> |
| <command id="init:acl" name="init:acl"> |
| <usage>init:acl</usage> |
| <description>Mounts ACL tables in the database</description> |
| <help>The <info>init:acl</info> command mounts ACL tables in the database. |
| |
| <info>php app/console init:acl</info> |
| |
| The name of the DBAL connection must be configured in your <info>app/config/security.yml</info> configuration file in the <info>security.acl.connection</info> variable. |
| |
| <info>security: |
| acl: |
| connection: default</info></help> |
| <aliases/> |
| <arguments/> |
| <options/> |
| </command> |
| <command id="init:jms-secure-random" name="init:jms-secure-random"> |
| <usage>init:jms-secure-random [--dump-sql] [--force] phrase</usage> |
| <description></description> |
| <help></help> |
| <aliases/> |
| <arguments> |
| <argument name="phrase" is_required="1" is_array="0"> |
| <description>Whatever comes to your mind right now. You do not need to remember it, it does not need to be cryptic, or long, and it will not be stored in a decipherable way. One restriction however, you should not let this be generated in an automated fashion.</description> |
| <defaults/> |
| </argument> |
| </arguments> |
| <options> |
| <option name="--dump-sql" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>Whether the SQL should be dumped.</description> |
| </option> |
| <option name="--force" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>Whether the SQL should be executed.</description> |
| </option> |
| </options> |
| </command> |
| <command id="router:debug" name="router:debug"> |
| <usage>router:debug [name]</usage> |
| <description>Displays current routes for an application</description> |
| <help>The <info>router:debug</info> displays the configured routes: |
| |
| <info>php app/console router:debug</info></help> |
| <aliases/> |
| <arguments> |
| <argument name="name" is_required="0" is_array="0"> |
| <description>A route name</description> |
| <defaults/> |
| </argument> |
| </arguments> |
| <options/> |
| </command> |
| <command id="router:dump-apache" name="router:dump-apache"> |
| <usage>router:dump-apache [--base-uri="..."] [script_name]</usage> |
| <description>Dumps all routes as Apache rewrite rules</description> |
| <help>The <info>router:dump-apache</info> dumps all routes as Apache rewrite rules. |
| These can then be used with the ApacheUrlMatcher to use Apache for route |
| matching. |
| |
| <info>php app/console router:dump-apache</info></help> |
| <aliases/> |
| <arguments> |
| <argument name="script_name" is_required="0" is_array="0"> |
| <description>The script name of the application's front controller.</description> |
| <defaults/> |
| </argument> |
| </arguments> |
| <options> |
| <option name="--base-uri" shortcut="" accept_value="1" is_value_required="1" is_multiple="0"> |
| <description>The base URI</description> |
| <defaults/> |
| </option> |
| </options> |
| </command> |
| <command id="router:match" name="router:match"> |
| <usage>router:match path_info</usage> |
| <description>Helps debug routes by simulating a path info match</description> |
| <help>The <info>router:match</info> simulates a path info match: |
| |
| <info>php app/console router:match /foo</info></help> |
| <aliases/> |
| <arguments> |
| <argument name="path_info" is_required="1" is_array="0"> |
| <description>A path info</description> |
| <defaults/> |
| </argument> |
| </arguments> |
| <options/> |
| </command> |
| <command id="swiftmailer:spool:send" name="swiftmailer:spool:send"> |
| <usage>swiftmailer:spool:send [--message-limit[="..."]] [--time-limit[="..."]] [--recover-timeout[="..."]]</usage> |
| <description>Sends emails from the spool</description> |
| <help>The <info>swiftmailer:spool:send</info> command sends all emails from the spool. |
| |
| <info>php app/console swiftmailer:spool:send --message-limit=10 --time-limit=10 --recover-timeout=900</info> |
| </help> |
| <aliases/> |
| <arguments/> |
| <options> |
| <option name="--message-limit" shortcut="" accept_value="1" is_value_required="0" is_multiple="0"> |
| <description>The maximum number of messages to send.</description> |
| <defaults/> |
| </option> |
| <option name="--time-limit" shortcut="" accept_value="1" is_value_required="0" is_multiple="0"> |
| <description>The time limit for sending messages (in seconds).</description> |
| <defaults/> |
| </option> |
| <option name="--recover-timeout" shortcut="" accept_value="1" is_value_required="0" is_multiple="0"> |
| <description>The timeout for recovering messages that have taken too long to send (in seconds).</description> |
| <defaults/> |
| </option> |
| </options> |
| </command> |
| <command id="translation:update" name="translation:update"> |
| <usage>translation:update [--prefix[="..."]] [--output-format[="..."]] [--dump-messages] [--force] locale bundle</usage> |
| <description>Updates the translation file</description> |
| <help>The <info>translation:update</info> command extract translation strings from templates |
| of a given bundle. It can display them or merge the new ones into the translation files. |
| When new translation strings are found it can automatically add a prefix to the translation |
| message. |
| |
| <info>php app/console translation:update --dump-messages en AcmeBundle</info> |
| <info>php app/console translation:update --force --prefix="new_" fr AcmeBundle</info></help> |
| <aliases/> |
| <arguments> |
| <argument name="locale" is_required="1" is_array="0"> |
| <description>The locale</description> |
| <defaults/> |
| </argument> |
| <argument name="bundle" is_required="1" is_array="0"> |
| <description>The bundle where to load the messages</description> |
| <defaults/> |
| </argument> |
| </arguments> |
| <options> |
| <option name="--prefix" shortcut="" accept_value="1" is_value_required="0" is_multiple="0"> |
| <description>Override the default prefix</description> |
| <defaults> |
| <default>__</default> |
| </defaults> |
| </option> |
| <option name="--output-format" shortcut="" accept_value="1" is_value_required="0" is_multiple="0"> |
| <description>Override the default output format</description> |
| <defaults> |
| <default>yml</default> |
| </defaults> |
| </option> |
| <option name="--dump-messages" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>Should the messages be dumped in the console</description> |
| </option> |
| <option name="--force" shortcut="" accept_value="0" is_value_required="0" is_multiple="0"> |
| <description>Should the update be done</description> |
| </option> |
| </options> |
| </command> |
| <command id="twig:lint" name="twig:lint"> |
| <usage>twig:lint [filename]</usage> |
| <description>Lints a template and outputs encountered errors</description> |
| <help>The <info>twig:lint</info> command lints a template and outputs to stdout |
| the first encountered syntax error. |
| |
| <info>php app/console twig:lint filename</info> |
| |
| The command gets the contents of <comment>filename</comment> and validates its syntax. |
| |
| <info>php app/console twig:lint dirname</info> |
| |
| The command finds all twig templates in <comment>dirname</comment> and validates the syntax |
| of each Twig template. |
| |
| <info>php app/console twig:lint @AcmeMyBundle</info> |
| |
| The command finds all twig templates in the <comment>AcmeMyBundle</comment> bundle and validates |
| the syntax of each Twig template. |
| |
| <info>cat filename | php app/console twig:lint</info> |
| |
| The command gets the template contents from stdin and validates its syntax.</help> |
| <aliases/> |
| <arguments> |
| <argument name="filename" is_required="0" is_array="0"> |
| <description></description> |
| <defaults/> |
| </argument> |
| </arguments> |
| <options/> |
| </command> |
| </commands> |
| <namespaces> |
| <namespace id="_global"> |
| <command>help</command> |
| <command>list</command> |
| </namespace> |
| <namespace id="assetic"> |
| <command>assetic:dump</command> |
| </namespace> |
| <namespace id="assets"> |
| <command>assets:install</command> |
| </namespace> |
| <namespace id="cache"> |
| <command>cache:clear</command> |
| <command>cache:warmup</command> |
| </namespace> |
| <namespace id="config"> |
| <command>config:dump-reference</command> |
| </namespace> |
| <namespace id="container"> |
| <command>container:debug</command> |
| </namespace> |
| <namespace id="doctrine"> |
| <command>doctrine:cache:clear-metadata</command> |
| <command>doctrine:cache:clear-query</command> |
| <command>doctrine:cache:clear-result</command> |
| <command>doctrine:database:create</command> |
| <command>doctrine:database:drop</command> |
| <command>doctrine:ensure-production-settings</command> |
| <command>doctrine:generate:crud</command> |
| <command>doctrine:generate:entities</command> |
| <command>doctrine:generate:entity</command> |
| <command>doctrine:generate:form</command> |
| <command>doctrine:mapping:convert</command> |
| <command>doctrine:mapping:import</command> |
| <command>doctrine:mapping:info</command> |
| <command>doctrine:query:dql</command> |
| <command>doctrine:query:sql</command> |
| <command>doctrine:schema:create</command> |
| <command>doctrine:schema:drop</command> |
| <command>doctrine:schema:update</command> |
| <command>doctrine:schema:validate</command> |
| </namespace> |
| <namespace id="generate"> |
| <command>generate:bundle</command> |
| </namespace> |
| <namespace id="init"> |
| <command>init:acl</command> |
| <command>init:jms-secure-random</command> |
| </namespace> |
| <namespace id="router"> |
| <command>router:debug</command> |
| <command>router:dump-apache</command> |
| <command>router:match</command> |
| </namespace> |
| <namespace id="swiftmailer"> |
| <command>swiftmailer:spool:send</command> |
| </namespace> |
| <namespace id="translation"> |
| <command>translation:update</command> |
| </namespace> |
| <namespace id="twig"> |
| <command>twig:lint</command> |
| </namespace> |
| </namespaces> |
| </symfony> |