Documentation

User command

Table of Contents ▼

Presentation

This command manages users registered in the database.

It is compatible with the Auth controller/plugin, the Auth attribute and the Api plugin.

Add a user

$ bin/comma User add --email=string [--name=string] [--roles=string] [--services=string]

Parameters:

  • email: (mandatory) User's email address.
  • name: (optional) User name.
  • roles: (optional) String containing comma-separated list of user roles (e.g. 'writer,reviewer').
  • services: (optional) String containing comma-separated list of services the user can access (e.g. 'text,images').

Delete a user

$ bin/comma User remove [--id=id] [--email=string]

Parameters:

  • id: (optional) Identifier of the user to be removed.
  • email: (optional) Mail address of the user to be removed.

One of the two parameters (id or email) must be supplied. If both parameters are supplied, the id takes precedence.

List users

This command allows you to list users. If no options are given, all users will be displayed. Depending on the options supplied, the list will be filtered.

$ bin/comma User list [--email=string] [--name=string] [--role=string] [--service=string] [--dateCreationFrom=string] [--dateCreationTo=string] [--dateLastLoginFrom=string] [--dateLastLoginTo=string] [--dateLastAccessFrom=string] [--dateLastAccessTo=string]

Parameters:

  • email: (optional) Mail address prefix.
  • name: (optional) User name prefix.
  • role: (optional) Role users must have.
  • service: (optional) Service to which users must have access.
  • dateCreationFrom: (optional) Minimum user creation date (format YYYY-MM-DD).
  • dateCreationTo: (optional) Maximum user creation date (format YYYY-MM-DD).
  • dateLastLoginFrom: (optional) Minimum date of last user authentication (format YYYY-MM-DD).
  • dateLastLoginTo: (optional) Maximum date of last user authentication (format YYYY-MM-DD).
  • dateLastAccessFrom: (optional) Minimum date of last user access (format YYYY-MM-DD).
  • dateLastAccessTo: (optional) Maximum date of last user access (format YYYY-MM-DD).
Previous: Cache command helper
Next: Auth controller helper

Table of Contents

  1. Migration : How to upgrade from Temma 1.x to version 2
  2. Installation : Download Temma and install it to start your web project
  3. Configuration : All the configuration directives of the etc/temma.json file and the optional environment variables
  4. External libraries : How to use external function libraries
  5. Routing : Temma's default routing system, and advanced routing
  6. Log : Use of the log system, management by criticality levels
  7. Controllers : Essential parts of your web application
  8. Views : Smarty templates or JSON/CSV/RSS/iCal/INI exports
  9. Dependency injection : The backbone of your application developments
  10. Sessions : Extension of user sessions managed by PHP
  11. Data sources : Unified data access management
  12. Model : How to use DAOs to access databases
  13. Execution flow : How to manage the execution flow, between plugins and the controller
  14. Plugins : How to use plugins, and create your own plugins to modularize your code
  15. Attributes : How to filter access to controllers and actions
  16. Tests : To write automated integration tests.
  17. Command-line interface : To create executable scripts on the command line, automatically initialized by Temma
  18. Helpers : Items offered by Temma to help you in various circumstances
    • Command-line scripts
      1. Cache : To clear the cache.
      2. User : To manage users.
    • Controller + plugin
      1. Auth : Controller and plugin to manage user authentication
    • Plugins
      1. Api : To manage API access
      2. Cache : To cache the generated HTML pages
      3. Language : Multilingual localization management
    • Attributes
      1. Auth : To restrict access to authenticated users
      2. Method : To manage the authorized HTTP methods
      3. Referer : To filter access by HTTP REFERER
      4. Redirect : To redirect requests automatically
    • Smarty plugins
      1. urlize : Modifier to transform a text into an URL
      2. filenamize : Modifier to transform a text into a file name
      3. nbsp : Modifier to transform spaces into non-breakable spaces
    • Utility objects
      1. ANSI : To format texts written to standard output
      2. BaseConvert : To do digital base conversions
      3. DataFilter : To filter and validate data
      4. Email : To send emails
      5. HTMLCleaner : To clean up an HTML stream coming from a WYSIWYG editor
      6. IniExport : To export data in INI format
      7. Json : To read JSON streams that may contain comments
      8. Lock : To lock access to a file, or the execution of the current PHP script
      9. Registry : To properly store global variables
      10. Smarty : To process Smarty templates outside the view
      11. Term : Terminal management (TTY)
      12. Text : Different treatments on character strings
      13. Timer : To manage stopwatches