Uploaded image for project: 'In-Portal CMS'
  1. In-Portal CMS
  2. INP-1662

Add methods for handling deprecations

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Resolved
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 5.2.2-B2
    • Component/s: Development Sugar
    • Labels:
      None
    • Change Log Group:
      Added
    • Change Log Message:
      Added "kUtil::deprecateMethod" and "kUtil::deprecateArgument" methods for deprecation handling.
    • Story Points:
      1
    • Copy Issue Key:
    • Patch Instructions:

      Patches must be submitted through Phabricator.

      Description

      Plan:

      1. borrow "_deprecated_function" and "_deprecated_argument" functions from WordPress
        • rename them to "kUtil::deprecatedMethod" and "kUtil::deprecatedArgument"
        • change used naming to use "method" instead of "function"
        • trigger silenced user deprecation notice instead of user notice
        • don't do anything if not in Debug Mode
      2. locate code elements, that should be deprecated and for each of them:
        • indicate deprecation version in "@deprecated" tag of DocBlock (add one if missing)
        • add "@see ClassName::methodName()" tag to indicate replacement method to be called
        • instead of manually triggering a deprecation notice use methods, added above

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                alex Alex
                Reporter:
                alex Alex
                Developer:
                Alex
                Reviewer:
                Erik Snarski [Intechnic]
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 0.75h
                  0.75h