Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-43063

Function download_file_content() inline documentation of return value incorrect

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 2.4.7, 2.6
    • Fix Version/s: 2.6.5, 2.7.2
    • Component/s: Files API
    • Labels:
    • Story Points:
      3
    • Sprint:
      BACKEND Sprint 14

      Description

      The inline docs for function download_file_content() in lib/filelib.php states: "@return mixed ... content of the file as string if ok"

      Actually it returns a the response as a stdClass object if ok containing the properties

      {status, headers, response_code, results, error}

        Attachments

          Activity

            People

            Assignee:
            lameze Simey Lameze
            Reporter:
            mwebster Mark van Hoek
            Peer reviewer:
            Andrew Davis
            Integrator:
            Sam Hemelryk
            Tester:
            Rajesh Taneja
            Participants:
            Component watchers:
            Matteo Scaramuccia, Andrew Nicols, Jun Pataleta, Michael Hawkins, Shamim Rezaie, Simey Lameze
            Votes:
            0 Vote for this issue
            Watchers:
            7 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:
              Fix Release Date:
              8/Sep/14