Uploaded image for project: 'Moodle Community Sites'
  1. Moodle Community Sites
  2. MDLSITE-5967

Stop requiring MOODLE_INTERNAL for files without side-effects

    XMLWordPrintable

Details

    • Improvement
    • Status: Closed
    • Low
    • Resolution: Done
    • Coding style

    Description

      Policy: MOODLE_INTERNAL requirement

      Since 13th March 2020, these rules apply:

      1. Remove the warning about missing MOODLE_INTERNAL check in 1-artifact files (that are the future). Single class/interface/trait ones.
      2. Keep the warning from old multi-artifact files and the error to files with side effects.

      We should stop requiring MOODLE_INTERNAL for files which have no side-effects

      Side effects include:

      • requiring other files
      • defining functions outside of classes
      • etc.

      Side effects do not include:

      • defining classes, interfaces, or traits
      • using the use stanza to alias a classname

       

      Attachments

        Issue Links

          has to be done before

          Improvement - An enhancement to an existing Moodle feature. MDLSITE-5879 Respect PSR-1, and PSR-12 where no existing rule exists

          • Low - Cosmetic problems, nice-to-have features
          • Closed
          will be (partly) resolved by

          Task - A task that needs to be completed. Tasks usually refer to work that must be done outside the product. MDLSITE-6093 Codechecker behaviour to review MOODLE_INTERNAL requirement

          • Low - Cosmetic problems, nice-to-have features
          • Resolved

          Improvement - An enhancement to an existing Moodle feature. MDL-68176 Remove MOODLE_INTERNAL from files without side-effects

          • Minor - Minor loss of function where workaround is possible
          • Closed
          will help resolve

          Bug - A problem which impairs or prevents Moodle from functioning correctly. MDL-61446 not clear if defined('MOODLE_INTERNAL') is due

          • Minor - Minor loss of function where workaround is possible
          • Closed

          Activity

            People

              sarjona Sara Arjona (@sarjona)
              dobedobedoh Andrew Lyons
              Marina Glancy, Eloy Lafuente (stronk7)
              Votes:
              2 Vote for this issue
              Watchers:
              13 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: