Developer API

Apart from the current documentation, you can also generate the full PHP documentation of GLPI (built with apigen) using the tools/genapidoc.sh script.

• Main framework objects
  • CommonGLPI
  • CommonDBTM
  • CommonDropdown
  • CommonTreeDropdown
  • CommonImplicitTreeDropdown
  • CommonDBVisible
  • CommonDBConnexity
  • CommonDBChild
  • CommonDBRelation
  • CommonDevice
  • Common ITIL objects
• Database
  • Database model
  • Querying
  • Updating
• Search Engine
  • Goal
  • GET Parameters
  • Search options
  • Default Select/Where/Join
  • Bookmarks
  • Display Preferences
• Controllers
  • Creating a controller
  • Routing
  • Reading query parameters
  • Firewall
  • Possible responses
  • General best practices
• Symfony Twig Components
  • Alert
  • Mfa:CodeInput
  • Usage
  • Creating a Component
• High-Level API
  • Schemas
  • Search
  • Versioning
• Massive Actions
  • Goals
  • Stages
  • Update item’s fields
  • Specific massive actions
• Rules Engine
  • Classes
  • Database Model
  • Add a new Rule class
  • Apply a rule collection
  • Test for rule collection
  • Dictionaries
  • Example: Adding Custom Actions with Customized display
• Translations
  • PHP Functions
  • Javascript Functions
• Right Management
  • Goals
  • Profiles
  • Rights definition
  • Check rights
  • CommonDBRelation and CommonDBChild specificities
• Re-authentication (“sudo mode”)
  • Goals
  • Architecture
  • Protecting a page or an action
  • Impersonation
  • Massive actions
  • Providing a re-authentication strategy from a plugin
  • Development and testing
  • Limits
• Automatic actions
  • Goals
  • Implementation overview
  • Implementation
  • Register an automatic actions
• Logging Systems
  • PHP logs
  • Event Log
  • File logs - Toolbox::logInFile()
  • Pitfalls & Tips
• Tools
  • locale/
  • make_release.sh
  • Modify and check code files headers
  • getsearchoptions.php
  • Not yet documented…
• Javascript
  • Vue.js
• Extra
  • Override mailing recipient