glpi-project/docdev

Documentation for glpi developpers

docdev's Issues

Packaging

https://forge.glpi-project.org/projects/glpi/wiki/GlpiPackaging

Document Search

First Work in https://forge.glpi-project.org/projects/glpi/wiki/SearchEngine

Document autoloader

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.

Document Notifications

Document hooks

There are many available hooks... They should be listed and (briefly at least) documented.

[discussion ] CS / SQL

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...

Github / Rebase

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

A word about CS

Following glpi-priject/glpi#1100, we should add a bit on documentation on that.

Many inactive links to https://forge.glpi-project.org/

Example on page:
https://glpi-developer-documentation.readthedocs.io/en/master/devapi/mainobjects.html

Document how to add migration in the core

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.

Document rules

Not sure for this one, maybe it's more userdoc related; even if we could drop a line on how to implement that.

Document ACLs

Typehinting

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

A word about static vs non static calls

See glpi-project/glpi#1899 (comment)

Variables types

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

Normal Form Database.

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?

Document caching possibilities

See glpi-project/glpi#2769

Document main objects

Explain how main objects works (CommGLPI, CommonDBTM, CommonDbRelation and so on)

DBmysqlIterator

GLPI v.9.1.6
I think count of DBmysqlIterator return wrong number (see attachement)

Document getFromIter and getFromDBByCrit

Follows glpi-project/glpi#1940

Coding Standards (proposal)

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

Document Automatic Actions

Document menu & breadcrumb usage

Backport db model doc

https://forge.glpi-project.org/projects/glpi/wiki/DBmodel

Document massive actions

document existence of the JS var CFG_GLPI

Add migration documentation for plugins

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)

Build status image broken

Document DBIterator count

See glpi-project/glpi#2434

Database Documentation

There are DER(Diagram) for glpi database? If yes, Where are?!

Document entities

Explain how entities work

Update plugins doc

@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.

Doc (plugin) not clear enough

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

Where can I find the documentation of the deprecated functions?

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.

Document javascript from plugins