glpi-project / docdev Goto Github PK
View Code? Open in Web Editor NEWDocumentation for glpi developpers
Home Page: http://glpi-developer-documentation.rtfd.io/
License: Other
Documentation for glpi developpers
Home Page: http://glpi-developer-documentation.rtfd.io/
License: Other
@yllen already wrote some documentation about plugins development in GLPi. It's available here:
https://forge.glpi-project.org/projects/plugins/wiki/Fr_CreatePlugin084
Have to update/fix the plugins part with that one.
Not sure for this one, maybe it's more userdoc related; even if we could drop a line on how to implement that.
Hi dears, i want the database (DER) for the glpi, latest. I don't find that in web. I can't build a reverse engineering, in mysqlworkbranch, because the number of the tables is more than 360.
There are the DER to projet?
Hello,
I just read the updates of dev doc : great job !
I suggest to add a § on source code management : how to rebase a github fork to keep up to date with the master one.
I usually made inversed pull requests too my repository, but this isn't clean...
If some one could write doc about this, I think it can help some developpers too :)
Regards
Hello,
As discuss on glpi-project/glpi#2100 (comment) typehint should be introduced.
If required, i can made a PR to update the doc.
Regards,
Anael
Following glpi-priject/glpi#1100, we should add a bit on documentation on that.
Explain how main objects works (CommGLPI, CommonDBTM, CommonDbRelation and so on)
There are DER(Diagram) for glpi database? If yes, Where are?!
Proposal, change "Database queries" to:
Direct call to $DB->query() should be avoid.
To add / update / delete rows, use the appropriate CommonDBTM methods.
To select data from the DB, use the $DB->request method()
When direct SQL cannot be avoid
... previous content...
On variables types, we suggest to use object for object type.
Reading the phpdoc doc, I found that
object, the element to which this type applies is the instance of an undetermined class.
We should use type "object" when the element isn't undetermined.
Else, we should use the object class name .
This will help to have a more accurate GLPI documentation ;-)
I can made a PR for this if required.
Regards
Some methods have been deprecated or removed; we should maybe (re)add a "migration" page or something similar to explain what have been changed.
See for example glpi-project/glpi#1901 (comment)
Hi,
I find the documentation of the deprecated functions, because example Dropdown::showInteger() and Dropdown::showDateFormItem() didn't use functions in GLI 9.2 plugins.
When adding a new migration, there are several files to change; and there are various cases to keep in mind (such as using or not the -dev
in version).
Since this is quite complex to understand each time we add a new migration script; adding some documentation would be interesting.
Follows glpi-project/glpi#1940
Explain how entities work
Some plugins rely on ZF Loader that will be removed soon:
fusioninventory/fusioninventory-for-glpi#2079
We'll need a word about autoloading (when required) in the docs.
There are many available hooks... They should be listed and (briefly at least) documented.
I was reading documentation about coding standards (http://glpi-developer-documentation.readthedocs.io/en/master/codingstandards.html), but some of your standards aren't following some of the PSR (http://www.php-fig.org/) which are used by a lot of open source projects.
The idea of this issue is to discuss about change the standards or at least start applying PSR-1 and PSR-2 to this project, all this in benefit of let know all developers and community about this standards used by many open source projects and frameworks, make this project another reference of good practices and follower of standards and maybe you can contribute to other PSR draft.
You can use the PHP-CS-Fixer tool (https://github.com/FriendsOfPHP/PHP-CS-Fixer) to apply those standards with out a problem and add it to a Text Editor, IDE, Git hook or C.I. to fix all code committed
I read about 50 times the documentation to create a plugin, but I can't achieve to do what I want.
Even if my PR are not merged on Read the docs, I don't understand what to do after this section.
It says, do a CRUD with you object. Fine, but how to access it after.
I think the doc should be re-read/re-written (I talk about the plugin part).
If some one can help me, I sent it to the forum, but no one answers, maybe here.
Thanks
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.