← Back to team overview

mahara-contributors team mailing list archive

[Bug 1526101] [NEW] Refactor $CFG->siteclosed to $CFG->siteclosedforupgrade

 

Public bug reported:

Every time I look at init.php I get confused about what the difference
is between "siteclosed" and "siteclosedbyadmin" and the various
$siteclosedforupgrade variables.

Here's how it actually works:

1. $CFG->siteclosedbyadmin is the config that indicates whether the
admin has used the "close site" button to put the site into maintenance
mode

2. $CFG->siteclosed is set by Mahara itself, if it detects that there is
a database upgrade ready to be deployed. It should *not* be manipulated
by users, in normal circumstances.

I think it would make things clearer for future developers, if we
renamed "siteclosed" to "siteautoclosedforupgrade". This indicates why
we're closing it (for upgrade), and that it was done automatically.

** Affects: mahara
     Importance: Low
     Assignee: Aaron Wells (u-aaronw)
         Status: In Progress


** Tags: api refactoring

-- 
You received this bug notification because you are a member of Mahara
Contributors, which is subscribed to Mahara.
Matching subscriptions: Subscription for all Mahara Contributors -- please ask on #mahara-dev or mahara.org forum before editing or unsubscribing it!
https://bugs.launchpad.net/bugs/1526101

Title:
  Refactor $CFG->siteclosed to $CFG->siteclosedforupgrade

Status in Mahara:
  In Progress

Bug description:
  Every time I look at init.php I get confused about what the difference
  is between "siteclosed" and "siteclosedbyadmin" and the various
  $siteclosedforupgrade variables.

  Here's how it actually works:

  1. $CFG->siteclosedbyadmin is the config that indicates whether the
  admin has used the "close site" button to put the site into
  maintenance mode

  2. $CFG->siteclosed is set by Mahara itself, if it detects that there
  is a database upgrade ready to be deployed. It should *not* be
  manipulated by users, in normal circumstances.

  I think it would make things clearer for future developers, if we
  renamed "siteclosed" to "siteautoclosedforupgrade". This indicates why
  we're closing it (for upgrade), and that it was done automatically.

To manage notifications about this bug go to:
https://bugs.launchpad.net/mahara/+bug/1526101/+subscriptions


Follow ups