Forums / Developer / Looking for a developer reference

Looking for a developer reference

Author Message

francis Nart

Wednesday 17 March 2004 2:22:58 am

We love eZ publish but we currently really waste a lot of time trying to figure out what this or that file does. I think that a developer reference would really be of help for the community, especially to help develop new features and contribute !

The content could be :

- an up to date database structure and a description of each table and field
- a list of all the files with a description of their use

This could be a pdf file that would make the search really easy !

Francis.

Paul Forsyth

Wednesday 17 March 2004 2:47:41 am

You try running doxygen, to create html docs for the eZ system:

http://ez.no/ez_publish/documentation/development/using_doxygen_to_create_api_documentation

the docs are slightly out of date, after building your files goto:

http://<ez-admin>//reference/view/ez

to view the docs, or you can just browse to the index file with your browser.

alternatively, goto pubsvn, and view the generated docs there:

http://pubsvn.ez.no/doxygen/

paul

francis Nart

Wednesday 17 March 2004 2:55:27 am

Thanks !

But I can't find anything about the database structure, fields and tables description.

Francis.

Paul Forsyth

Wednesday 17 March 2004 3:01:25 am

No, that is sadly missing. The docs on pubsvn have some db info but they are out of date.

You may need to install something like phpmyadmin to see this in detail.

However, eZ use an interface to the db, which does tell you some info about the db structure. For example:

Look at eZuser: http://pubsvn.ez.no/doxygen/ezuser_8php-source.html. It has a function called 'definition()', defines which db table and fields to use. You will find eZ interfaces with all db tables in the same way.

Look at http://pubsvn.ez.no/doxygen/classeZPersistentObject.html for more examples.

paul

K259

Wednesday 17 March 2004 3:50:57 am

I really agree! I've been missing a database structure for eZ about a year know. AND, it's not so simple to write it yourself, because there are new releases every 3'th month, so this should actually be written by the EZ crew themselves..because they know the future changes in the db.

Maybe eZ have a databasemodel in house, which their developers are using? Every company should have such a thing, to get an overview.

If this exist eZ, then it would be nice if you could post this in the docs. area :)

Tnx

Bård Farstad

Wednesday 17 March 2004 4:03:14 am

We do have some database models, but we need to do a job before we can post it to the docs. It's simply too many tables to have in one diagram. We will need to split this up and write some good descriptions for these. We will add this, but the reference documentation is the part we are currently working on.

--bård

Documentation: http://ez.no/doc

K259

Wednesday 17 March 2004 4:20:00 am

Great. Do you know if there will be great changes in the db-tables and attributes in the future, or will new tables just be added?

francis Nart

Wednesday 17 March 2004 7:10:15 am

It's good to know that you are working on a reference documentation but I am a bit sad that you wait to give the database model right now for, as mentioned above, your team certainly does have at least a basci one. And a basic one is really much better that none !(for us the community !) If we have to wait another 3 months for example it would really be a problem for us !

Francis.

K259

Wednesday 17 March 2004 12:39:02 pm

Forget this message..I just notised a bug.. :/

Ronny Vedå

Friday 26 March 2004 3:45:07 am

I hope you can post the database models really soon, Bård. We could really need some descriptions on the tables containing the content objects and nodes. This would allow us to optimize our modules that are making changes to the object data.