Issue #3367439: Add proper documentation for entity type's admin_permission and collection_permission
4 unresolved threads
Merge request reports
Activity
72 72 /** 73 73 * The name of the default administrative permission. 74 74 * 75 * This permission must be declared by the module providing the entity type. 76 * Users with the administrative permission can perform create, view, update 77 * or delete operations on any entity of that type. They also are granted 78 * access to the overview (or collection) of the entities of that type, if one -
I'm not keen on this wording. It makes it sound like something called an 'overview' of entities might also exist, which is different from the collection.
Also, we don't use the word 'overview' in the entity system AFAICT.
The EntityListBuilderInterface class calls them 'entity listings', and lots of other thing calls it the collection.
To avoid tautology here, I'd just say 'the entity listing'.
79 88 /** 80 89 * The name of the collection permission. 81 90 * 91 * This permission must be declared by the module providing the entity type. 92 * Users with the collection permission are allowed to access the overview (or 93 * collection) of the entities of that type, if one exists. It does not grant 94 * access to any particular entities, but is used in combination with other 95 * permissions. For example. this makes it possible to grant users access to 79 88 /** 80 89 * The name of the collection permission. 81 90 * 91 * This permission must be declared by the module providing the entity type. 92 * Users with the collection permission are allowed to access the overview (or 79 88 /** 80 89 * The name of the collection permission. 81 90 * 91 * This permission must be declared by the module providing the entity type. 92 * Users with the collection permission are allowed to access the overview (or 93 * collection) of the entities of that type, if one exists. It does not grant 94 * access to any particular entities, but is used in combination with other 95 * permissions. For example. this makes it possible to grant users access to 96 * view entities of a particular type in the overview, but not edit or delete
Please register or sign in to reply