Forum

Welcome to ProjeQtOr new Forum. We migrated old forum to the new website.
You will find all your posts here, with your usual account.
Just one point : you’ll have to reinitialize your password. Use “Lost password” feature.

Developer Documenta...
 
Notifications
Clear all

Developer Documentation

13 Posts
4 Users
0 Reactions
19.2 K Views
(@adrien_obs)
Posts: 19
Active Member
Topic starter
 
[#489]

Hello there,

I understand from the Forum that the Project’Or RIA PHP Framework is a homemade one.

I would like to understand how this Framework works in order to do new report, try to custom display, reduce description field from activities and maybe implement new functionalities...
I would be able to understand it by myself but it’s going to take me lot of time.

As there isn’t so much comment in the code, I was hoping someone has already done a kind of guide for developers.

So if someone is into it or already did it, I’ll be glad if he could share it to me. I’ll also be glad to complete it once I’ll be more familiar with this framework.

Best,


 
Posted : 03 May 2012 17H51
(@babynus)
Posts: 14952
Member Admin
 

Hi,
There is not developer document except the few comments in the code.
But the core is not hard to understand :
- all classes are in /model
- main persistence framework is in /model/persistence
- in most cases, you'll just have to upgrade the model to have changes, for instance :
=> comment a property to stop showing (and managing) it
=> create a new property at the place you want it to appear, create corresponding field on corresponding table : the new field appears (format depending on field format)

This should help you to start.

Regards.


 
Posted : 04 May 2012 2H38
(@adrien_obs)
Posts: 19
Active Member
Topic starter
 

Hello,

This will help to start for sure.

Thank you 😉


 
Posted : 04 May 2012 11H22
(@babynus)
Posts: 14952
Member Admin
 

Other information :
Framework is based on some MVC strructure (not very strict).
=> /view : all the GUI tools, including all the js code
=> /tool : kind of controler, including code to manage updates, page refresh
=> /model : the model, including definition of elements
=> /model/persistence : the persistence framework
=> /external : external libraries (dojo, html2pdf,...)
=> /db => the sql statements for upgrades
=> /reports => source for reports


 
Posted : 04 May 2012 12H10
(@adrien_obs)
Posts: 19
Active Member
Topic starter
 

I'm starting to understand how the framework works.

I'm not very familiar with js and Dojo so I'll get back to it later.

Actualy I'm trying to build a new report that I'll share if people are intersted in it.

Best,


 
Posted : 04 May 2012 12H34
(@babynus)
Posts: 14952
Member Admin
 

Things to know to buil new report :
=> add new report in report table, including file name = php script that will generate report
=> add parameters in reportparameter table, if needed
=> manage habilitations so that user can access the report
At this step you should be able to see new report in report selection screen
=> design your new report as php script (easier is to copy an exiting one)
=> run / test your new report


 
Posted : 04 May 2012 13H57
(@adrien_obs)
Posts: 19
Active Member
Topic starter
 

Thank you but I've already seen that on the post about custom report.

Anyway I built my first report. Its very cloth from “Cost synthesis per activity” except that it’s about work instead of cost. The report highlight the assigned, planned and left work when there is a difference between assigned and planned work.

It’s easier to see if the left work has been changed during the development.

If someone is interested in it I’ll be glad to share it with you.

Best,


 
Posted : 04 May 2012 14H25
(@adrien_obs)
Posts: 19
Active Member
Topic starter
 

I've attached an overview of what my report looks like.


 
Posted : 04 May 2012 16H01
(@babynus)
Posts: 14952
Member Admin
 

Hi,
Good.
If you want to share, it could be included in a next version.

NB : indicators seem inversed :unsure:


 
Posted : 04 May 2012 22H09
Ambroise
(@ambroise1er)
Posts: 96
Active Member
 

Hi,

Is-it possible to add in this report the number of days left ?

Cdt


 
Posted : 13 May 2012 14H53
(@babynus)
Posts: 14952
Member Admin
 

"Left" column exists yet.

For information, similar report exists yet (report/planning/work synthesis) but without colors and smiley indicators (which is a great idea from adrien).


 
Posted : 13 May 2012 15H09
(@palousc)
Posts: 3
New Member
 

Hello
I'm french. I don't know if this topic is is the right place to post my question but...
I am looking for documentation in french. Where could I find this ?
I found a PowerPoint file (8 Mo) in english. Is there a french translation
Yhanks for your answer


 
Posted : 23 May 2012 1H12
(@babynus)
Posts: 14952
Member Admin
 

I am looking for documentation in french. Where could I find this ?

Unfortunately nowhere. 🙁

It's just a hard work to maintain user manual in only one language...
English version is the only one.

You can find a post n the forum about some translation try, but I'm not sure it came to an end.


 
Posted : 23 May 2012 1H48
Share:

Scroll to Top