Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Deprecate redundant use of plugin getName() #1152

Closed
mattab opened this Issue · 8 comments

2 participants

Matthieu Aubry Anthon Pang
Matthieu Aubry
Owner

Must it be the same as the class name?
Is it used anywhere?

let's clarify this and/or remove it if not useful (if we display the class name only, we don't need a human readable plugin name)

Anthon Pang
Collaborator

getName() isn't the same as the class name, e.g., 'CoreHome' vs 'Piwik_CoreHome'

getName() is used in two places:

  • in core/PluginsManager.php where it is used in the exception message if installPlugin() fails
  • in core/View.php where it is assigned to currentPluginName and displayed (human readable) next to the Piwik logo (in plugins/CoreHome/templates/logo.tpl)

This is not used by CorePluginsAdmin where it displays the name of each plugin. Here it uses readPluginsDirectory().

Given the above, we could enforce this consistency by adding a check to CorePluginsAdmin/Controller.php's index() -- skip any plugins where these don't match up.

Anthon Pang
Collaborator

Oh, I see what you mean. Yes, it would seem that getName() and getClassName() duplicate each other.

Ok. Revised suggestion:

  • document that getName() is the human readable plugin name (may contain spaces, punctuation; similarity to the plugin name is encouraged; translateable?)
  • in CorePluginsAdmin/Controller.php -- use getName() instead of the plugin's directory name when displaying the list of plugins
  • add a check to ensure all the human readable plugin names are unique, and that getClassName() matches the plugin's directory name; should be sufficient to check this constraint at installation, updates, and when installing new plugins
Matthieu Aubry
Owner

Sounds good

Matthieu Aubry
Owner

actually, why do we need getClassName() if it must return the directory name? maybe we can get rid of it and parse it from the dir name.

Anthon Pang
Collaborator

In http://dev.piwik.org/trac/wiki/Plugins/HowToWritePlugin?action=diff&version=15 - refs #1152, remove reference to "name" in getInformation() array

Anthon Pang
Collaborator

(In [2263]) refs #1152 -deprecate "name" in getInformation() array;use getClassName() instead of getName(); remove unused getName()

Anthon Pang
Collaborator

(In [2264]) fixes #1152 - remove deprecated "name" from getInformation() array

Anthon Pang
Collaborator

(In [2272]) refs #1152 - add "final" keyword to getClassName() because we dont want subclasses (plugins) to redefine this; remove "name" from phpdocs

Matthieu Aubry mattab added this to the Piwik 0.6.3 milestone
Anthon Pang robocoder was assigned by mattab
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.