Important

You are browsing the documentation for version 3.1 of OroCommerce, OroCRM and OroPlatform, which is no longer maintained. Read version 5.0 (the latest LTS version) of the Oro documentation to get the updated information.

See our Release Process documentation for more information on the currently supported and upcoming releases.

@Config

This annotation is used to configure default values for configurable entity classes.

Options

defaultValues

Configures default values for particular config options on a per property basis:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
// ...
use Oro\Bundle\EntityConfigBundle\Metadata\Annotation\Config;

/**
 * @Config(
 *      defaultValues={
 *          "dataaudit"={
 *              "auditable"=true
 *          }
 *      }
 * )
 */
class User
{
    // ...
}

This example sets the auditable option from the dataaudit scope to true for the User class.

routeName

The route name of view that shows the datagrid of available records:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
// ...
use Oro\Bundle\EntityConfigBundle\Metadata\Annotation\Config;

/**
 * @Config(
 *      routeName="oro_user_index"
 * )
 */
class User
{
    // ...
}

routeView

The route name of a controller that shows a particular object:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
// ...
use Oro\Bundle\EntityConfigBundle\Metadata\Annotation\Config;

/**
 * @Config(
 *      routeView="oro_user_view"
 * )
 */
class User
{
    // ...
}

routeCreate

The route name of a controller that creates an object:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
    // ...
    use Oro\Bundle\EntityConfigBundle\Metadata\Annotation\Config;

    /**
     * @Config(
     *      routeCreate="oro_user_create"
     * )
     */
    class User
    {
        // ...
    }

routeUpdate

The route name of controller action that updates an object:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
        // ...
        use Oro\Bundle\EntityConfigBundle\Metadata\Annotation\Config;

        /**
         * @Config(
         *      routeUpdate="oro_user_update"
         * )
         */
        class User
        {
            // ...
        }