Skip to content

Commit

Permalink
Dev PHPDoc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
c-schmitz committed Jan 20, 2017
1 parent d7662a2 commit cd703e6
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 11 deletions.
9 changes: 5 additions & 4 deletions application/controllers/admin/databaseupdate.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,14 @@

/**
* Update Database Controller
*
* @package LimeSurvey
* @subpackage Backend
*
* This controller must be accessible by unlogged user (in case of modifications of {{permissions}} blocking the login )
*
* @package LimeSurvey
* @subpackage Backend
*
*/


class databaseupdate extends Survey_Common_Action
{
/**
Expand Down
16 changes: 9 additions & 7 deletions application/controllers/admin/update.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,25 +15,27 @@
*/

/**
* Update Controller
*
* @package LimeSurvey
* @package LimeSurvey
* @subpackage Backend
*/

/**
*
* This controller performs updates, it is highly ajax oriented
* Methods are only called from JavaScript controller (wich is called from the global_setting view). comfortupdate.js is the first registred script.
* Methods are only called from JavaScript controller (wich is called from the global_setting view). comfortupdate.js is the first registered script.
*
*
*
* Public methods are written in a chronological way :
* - First, when the user click on the 'check for updates' button, the plugin buildComfortButtons.js call for getstablebutton() or getbothbuttons() method and inject the HTML inside the li#udapteButtonsContainer in the _checkButtons view
* Public methods are written in a chronological way:
* - First, when the user click on the 'check for updates' button, the plugin buildComfortButtons.js call for getstablebutton() or getbothbuttons() method and inject the HTML inside the li#udapteButtonsContainer in the _checkButtons view
* - Then, when the user click on one of those buttons, the comfortUpdateNextStep.js plugin will call for the getWelcome() method and inject the HTML inside div#updaterContainer in the _right_container view (all steps will be then injected here)
* - Then, when the user click on the continue button, the comfortUpdateNextStep.js plugin will call for the step1() method and inject the the HTML inside div#updaterContainer in the _right_container view
* - Then, when the user click on the continue button, the comfortUpdateNextStep.js plugin will call for the step1() method and inject the the HTML inside div#updaterContainer in the _right_container view
* - etc. etc.
*
*
*
* Some steps must be shown out of the chronological process : getNewKey and submitKey. They are at the end of the controller's interface.
* Some steps must be shown out of the chronological process: getNewKey and submitKey. They are at the end of the controller's interface.
* Some steps must be 'checked again' after the user fixed some errors (such as file permissions).
* Those steps are/can be diplayed by the plugin displayComfortStep.js. They are called from buttons like :
*
Expand Down

0 comments on commit cd703e6

Please sign in to comment.