Issue #2210197 by sun, longwave, Sutharsan: Remove public access to...

Issue #2210197 by sun, longwave, Sutharsan: Remove public access to Extension::$type, ::$name, ::$filename.

core/includes/install.core.inc

@@ -684,7 +684,7 @@ function install_tasks($install_state) {
     // Load the profile install file, because it is not always loaded when
     // hook_install_tasks() is invoked (e.g. batch processing).
     $profile = $install_state['parameters']['profile'];
-    $profile_install_file = dirname($install_state['profiles'][$profile]->uri) . '/' . $profile . '.install';
+    $profile_install_file = $install_state['profiles'][$profile]->getPath() . '/' . $profile . '.install';
     if (file_exists($profile_install_file)) {
       include_once DRUPAL_ROOT . '/' . $profile_install_file;
     }
@@ -1256,19 +1256,19 @@ function _install_select_profile($profiles) {
   $request_params = \Drupal::request()->request;
   if (count($profiles) == 1) {
     $profile = array_pop($profiles);
-    return $profile->name;
+    return $profile->getName();
   }
   elseif ($request_params->has('profile') && ($profile = $request_params->get('profile')) && isset($profiles[$profile])) {
-    return $profiles[$profile]->name;
+    return $profiles[$profile]->getName();
   }
   // Check for a profile marked as "exclusive" and ensure that only one
   // profile is marked as such.
   $exclusive_profile = NULL;
   foreach ($profiles as $profile) {
-    $profile_info = install_profile_info($profile->name);
+    $profile_info = install_profile_info($profile->getName());
     if (!empty($profile_info['exclusive'])) {
       if (empty($exclusive_profile)) {
-        $exclusive_profile = $profile->name;
+        $exclusive_profile = $profile->getName();
       }
       else {
         // We found a second "exclusive" profile. There's no way to choose
@@ -1294,7 +1294,7 @@ function install_select_profile_form($form, &$form_state, $install_state) {
   $profiles = array();
   $names = array();
   foreach ($install_state['profiles'] as $profile) {
-    $details = install_profile_info($profile->name);
+    $details = install_profile_info($profile->getName());
     // Skip this extension if its type is not profile.
     if (!isset($details['type']) || $details['type'] != 'profile') {
       continue;
@@ -1304,12 +1304,12 @@ function install_select_profile_form($form, &$form_state, $install_state) {
     if ($details['hidden'] === TRUE) {
       continue;
     }
-    $profiles[$profile->name] = $details;
+    $profiles[$profile->getName()] = $details;
 
     // Determine the name of the profile; default to file name if defined name
     // is unspecified.
-    $name = isset($details['name']) ? $details['name'] : $profile->name;
-    $names[$profile->name] = $name;
+    $name = isset($details['name']) ? $details['name'] : $profile->getName();
+    $names[$profile->getName()] = $name;
   }
 
   // Display radio buttons alphabetically by human-readable name, but always

core/includes/install.inc

@@ -573,9 +573,7 @@ function drupal_verify_profile($install_state) {
   include_once __DIR__ . '/common.inc';
 
   $profile = $install_state['parameters']['profile'];
-  $profile_file = $install_state['profiles'][$profile]->uri;
-
-  if (!isset($profile) || !file_exists($profile_file)) {
+  if (!isset($profile) || !isset($install_state['profiles'][$profile])) {
     throw new Exception(install_no_profile_error());
   }
   $info = $install_state['profile_info'];
@@ -584,7 +582,7 @@ function drupal_verify_profile($install_state) {
   $listing = new ExtensionDiscovery();
   $present_modules = array();
   foreach ($listing->scan('module') as $present_module) {
-    $present_modules[] = $present_module->name;
+    $present_modules[] = $present_module->getName();
   }
 
   // The installation profile is also a module, which needs to be installed

core/includes/module.inc

@@ -63,7 +63,7 @@ function system_list($type) {
         $lists['filepaths'][] = array(
           'type' => 'theme',
           'name' => $name,
-          'filepath' => $theme->filename,
+          'filepath' => $theme->getPathname(),
         );
       }
     }

core/includes/theme.inc

@@ -79,7 +79,7 @@
  */
 function drupal_theme_access($theme) {
   if ($theme instanceof Extension) {
-    $theme = $theme->name;
+    $theme = $theme->getName();
   }
   return \Drupal::service('access_check.theme')->checkAccess($theme);
 }
@@ -135,7 +135,7 @@ function _drupal_theme_initialize($theme, $base_theme = array()) {
   $theme_info = $theme;
   $base_theme_info = $base_theme;
 
-  $theme_path = dirname($theme->filename);
+  $theme_path = $theme->getPath();
 
   // Prepare stylesheets from this theme as well as all ancestor themes.
   // We work it this way so that we can have child themes override parent
@@ -155,7 +155,7 @@ function _drupal_theme_initialize($theme, $base_theme = array()) {
         }
       }
     }
-    $base_theme_path = dirname($base->filename);
+    $base_theme_path = $base->getPath();
     if (!empty($base->info['stylesheets-remove'])) {
       foreach ($base->info['stylesheets-remove'] as $basename) {
         $theme->stylesheets_remove[$basename] = $base_theme_path . '/' . $basename;
@@ -793,7 +793,7 @@ function drupal_find_theme_templates($cache, $extension, $path) {
   $theme_paths = array();
   foreach (list_themes() as $theme_info) {
     if (!empty($theme_info->base_theme)) {
-      $theme_paths[$theme_info->base_theme][$theme_info->name] = dirname($theme_info->filename);
+      $theme_paths[$theme_info->base_theme][$theme_info->getName()] = $theme_info->getPath();
     }
   }
   foreach ($theme_paths as $basetheme => $subthemes) {
@@ -955,7 +955,7 @@ function theme_get_setting($setting_name, $theme = NULL) {
       if ($cache[$theme]->get('features.logo')) {
         $logo_path = $cache[$theme]->get('logo.path');
         if ($cache[$theme]->get('logo.use_default')) {
-          $cache[$theme]->set('logo.url', file_create_url(dirname($theme_object->filename) . '/logo.png'));
+          $cache[$theme]->set('logo.url', file_create_url($theme_object->getPath() . '/logo.png'));
         }
         elseif ($logo_path) {
           $cache[$theme]->set('logo.url', file_create_url($logo_path));
@@ -966,7 +966,7 @@ function theme_get_setting($setting_name, $theme = NULL) {
       if ($cache[$theme]->get('features.favicon')) {
         $favicon_path = $cache[$theme]->get('favicon.path');
         if ($cache[$theme]->get('favicon.use_default')) {
-          if (file_exists($favicon = dirname($theme_object->filename) . '/favicon.ico')) {
+          if (file_exists($favicon = $theme_object->getPath() . '/favicon.ico')) {
             $cache[$theme]->set('favicon.url', file_create_url($favicon));
           }
           else {

core/lib/Drupal/Core/DrupalKernel.php

@@ -290,10 +290,8 @@ public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQ
    * @param $module
    *   The name of the module.
    *
-   * @return \stdClass|bool
-   *   Returns a stdClass object if the module data is found containing at
-   *   least an uri property with the module path, for example
-   *   core/modules/user/user.module.
+   * @return \Drupal\Core\Extension\Extension|bool
+   *   Returns an Extension object if the module is found, FALSE otherwise.
    */
   protected function moduleData($module) {
     if (!$this->moduleData) {

core/lib/Drupal/Core/Extension/Extension.php

@@ -15,7 +15,7 @@ class Extension implements \Serializable {
   /**
    * The type of the extension (e.g., 'module').
    *
-   * @todo Replace all uses of $type with getType() method.
+   * @todo Change to protected once external test dependencies are resolved.
    *
    * @var string
    */
@@ -31,7 +31,7 @@ class Extension implements \Serializable {
   /**
    * The internal name of the extension (e.g., 'node').
    *
-   * @todo Replace all uses of $name with getName() method.
+   * @todo Remove this property once external test dependencies are resolved.
    *
    * @var string
    */
@@ -48,23 +48,22 @@ class Extension implements \Serializable {
   public $uri;
 
   /**
-   * The filename of the main extension file (e.g., 'node.module').
+   * Same as $uri.
    *
-   * Note that this is not necessarily a filename but a pathname and also not
-   * necessarily the filename of the info file. Due to legacy code and property
-   * value overloading, it is either the filename of the main extension file or
-   * the relative pathname of the main extension file (== $uri), depending on
-   * whether the object has been post-processed or not.
+   * @todo Remove this property once external test dependencies are resolved.
    *
-   * @see _system_rebuild_module_data()
-   * @see \Drupal\Core\Extension\ThemeHandler::rebuildThemeData()
+   * @var string
+   */
+  public $filename;
+
+  /**
+   * The filename of the main extension file (e.g., 'node.module').
    *
-   * @todo Remove this property and do not require .module/.profile files.
-   * @see https://drupal.org/node/340723
+   * @todo Rename to $filename once external test dependencies are resolved.
    *
    * @var string
    */
-  public $filename;
+  protected $_filename;
 
   /**
    * An SplFileInfo instance for the extension's info file.
@@ -89,10 +88,11 @@ class Extension implements \Serializable {
   public function __construct($type, $pathname, $filename) {
     $this->type = $type;
     $this->pathname = $pathname;
+    $this->_filename = $filename;
     // Set legacy public properties.
-    $this->name = basename($pathname, '.info.yml');
-    $this->filename = $filename;
-    $this->uri = dirname($pathname) . '/' . $filename;
+    $this->name = $this->getName();
+    $this->uri = $this->getPath() . '/' . $filename;
+    $this->filename = $this->uri;
   }
 
   /**
@@ -177,14 +177,9 @@ public function serialize() {
     $data = array(
       'type' => $this->type,
       'pathname' => $this->pathname,
+      '_filename' => $this->_filename,
     );
 
-    // Include legacy public properties.
-    // @todo Remove this property and do not require .module/.profile files.
-    // @see https://drupal.org/node/340723
-    // @see Extension::$filename
-    $data['filename'] = basename($this->uri);
-
     // @todo ThemeHandler::listInfo(), ThemeHandler::rebuildThemeData(), and
     //   system_list() are adding custom properties to the Extension object.
     $info = new \ReflectionObject($this);
@@ -202,14 +197,14 @@ public function unserialize($data) {
     $data = unserialize($data);
     $this->type = $data['type'];
     $this->pathname = $data['pathname'];
+    $this->_filename = $data['_filename'];
 
     // Restore legacy public properties.
     // @todo Remove these properties and do not require .module/.profile files.
     // @see https://drupal.org/node/340723
-    // @see Extension::$filename
-    $this->name = basename($data['pathname'], '.info.yml');
-    $this->uri = dirname($data['pathname']) . '/' . $data['filename'];
-    $this->filename = $data['filename'];
+    $this->name = $this->getName();
+    $this->uri = $this->getPath() . '/' . $this->_filename;
+    $this->filename = $this->uri;
 
     // @todo ThemeHandler::listInfo(), ThemeHandler::rebuildThemeData(), and
     //   system_list() are adding custom properties to the Extension object.

core/lib/Drupal/Core/Extension/ExtensionDiscovery.php

@@ -278,14 +278,14 @@ protected function process(array $all_files) {
     // e.g. new modules were introduced in core while older contrib modules with
     // the same name still exist in a later search path.
     foreach ($all_files as $file) {
-      if (isset($files[$file->name])) {
+      if (isset($files[$file->getName()])) {
         // Skip the extension if it is incompatible with Drupal core.
         $info = $this->getInfoParser()->parse($file->getPathname());
         if (!isset($info['core']) || $info['core'] != \Drupal::CORE_COMPATIBILITY) {
           continue;
         }
       }
-      $files[$file->name] = $file;
+      $files[$file->getName()] = $file;
     }
     return $files;
   }
@@ -366,16 +366,12 @@ protected function scanDirectory($dir, $include_tests) {
       $name = $fileinfo->getBasename('.info.yml');
       $pathname = $dir_prefix . $fileinfo->getSubPathname();
 
-      // Supply main extension filename being used throughout Drupal.
-      // For themes, the filename is the info file itself.
-      if ($type == 'theme') {
-        $filename = $fileinfo->getFilename();
-      }
+      // Determine whether the extension has a main extension file.
       // For theme engines, the file extension is .engine.
-      elseif ($type == 'theme_engine') {
+      if ($type == 'theme_engine') {
         $filename = $name . '.engine';
       }
-      // Otherwise, it is .module/.profile; i.e., the extension type.
+      // For profiles/modules/themes, it is the extension type.
       else {
         $filename = $name . '.' . $type;
       }

core/lib/Drupal/Core/Extension/ModuleHandler.php

@@ -145,11 +145,11 @@ public function setModuleList(array $module_list = array()) {
    */
   public function buildModuleDependencies(array $modules) {
     foreach ($modules as $module) {
-      $graph[$module->name]['edges'] = array();
+      $graph[$module->getName()]['edges'] = array();
       if (isset($module->info['dependencies']) && is_array($module->info['dependencies'])) {
         foreach ($module->info['dependencies'] as $dependency) {
           $dependency_data = static::parseDependency($dependency);
-          $graph[$module->name]['edges'][$dependency_data['name']] = $dependency_data;
+          $graph[$module->getName()]['edges'][$dependency_data['name']] = $dependency_data;
         }
       }
     }
@@ -382,7 +382,7 @@ public function alter($type, &$data, &$context1 = NULL, &$context2 = NULL) {
       if (isset($theme)) {
         $theme_keys = array();
         foreach ($base_theme_info as $base) {
-          $theme_keys[] = $base->name;
+          $theme_keys[] = $base->getName();
         }
         $theme_keys[] = $theme;
         foreach ($theme_keys as $theme_key) {

core/lib/Drupal/Core/Extension/ThemeHandler.php

@@ -220,7 +220,7 @@ public function listInfo() {
         if (!isset($theme->status)) {
           $theme->status = 0;
         }
-        $this->list[$theme->name] = $theme;
+        $this->list[$theme->getName()] = $theme;
       }
     }
     return $this->list;
@@ -271,7 +271,6 @@ public function rebuildThemeData() {
     $sub_themes = array();
     // Read info files for each theme.
     foreach ($themes as $key => $theme) {
-      $theme->filename = $theme->uri;
       $theme->info = $this->infoParser->parse($theme->getPathname()) + $defaults;
 
       // Add the info file modification time, so it becomes available for
@@ -292,7 +291,7 @@ public function rebuildThemeData() {
       $engine = $theme->info['engine'];
       if (isset($engines[$engine])) {
         $theme->owner = $engines[$engine]->uri;
-        $theme->prefix = $engines[$engine]->name;
+        $theme->prefix = $engines[$engine]->getName();
       }
 
       // Prefix stylesheets, scripts, and screenshot with theme path.

core/lib/Drupal/Core/Template/TwigEnvironment.php

@@ -39,13 +39,16 @@ public function __construct(\Twig_LoaderInterface $loader = NULL, $options = arr
     $this->cache_object = \Drupal::cache();
 
     // Set twig path namespace for themes and modules.
-    $namespaces = $module_handler->getModuleList();
-    foreach ($theme_handler->listInfo() as $theme => $info) {
-      $namespaces[$theme] = $info->filename;
+    $namespaces = array();
+    foreach ($module_handler->getModuleList() as $name => $filename) {
+      $namespaces[$name] = dirname($filename);
+    }
+    foreach ($theme_handler->listInfo() as $name => $extension) {
+      $namespaces[$name] = $extension->getPath();
     }
 
-    foreach ($namespaces as $name => $filename) {
-      $templatesDirectory = dirname($filename) . '/templates';
+    foreach ($namespaces as $name => $path) {
+      $templatesDirectory = $path . '/templates';
       if (file_exists($templatesDirectory)) {
         $loader->addPath($templatesDirectory, $name);
       }

core/lib/Drupal/Core/Theme/Registry.php

@@ -154,7 +154,7 @@ protected function init($theme_name = NULL) {
       }
       // #2: The testing framework only cares for the global $theme variable at
       // this point. Cope with that.
-      if ($GLOBALS['theme'] != $GLOBALS['theme_info']->name) {
+      if ($GLOBALS['theme'] != $GLOBALS['theme_info']->getName()) {
         unset($this->runtimeRegistry);
         unset($this->registry);
         $this->initializeTheme();
@@ -207,7 +207,7 @@ public function get() {
     if (isset($this->registry)) {
       return $this->registry;
     }
-    if ($cache = $this->cache->get('theme_registry:' . $this->theme->name)) {
+    if ($cache = $this->cache->get('theme_registry:' . $this->theme->getName())) {
       $this->registry = $cache->data;
     }
     else {
@@ -230,7 +230,7 @@ public function get() {
    */
   public function getRuntime() {
     if (!isset($this->runtimeRegistry)) {
-      $this->runtimeRegistry = new ThemeRegistry('theme_registry:runtime:' . $this->theme->name, $this->cache, $this->lock, array('theme_registry' => TRUE), $this->moduleHandler->isLoaded());
+      $this->runtimeRegistry = new ThemeRegistry('theme_registry:runtime:' . $this->theme->getName(), $this->cache, $this->lock, array('theme_registry' => TRUE), $this->moduleHandler->isLoaded());
     }
     return $this->runtimeRegistry;
   }
@@ -239,7 +239,7 @@ public function getRuntime() {
    * Persists the theme registry in the cache backend.
    */
   protected function setCache() {
-    $this->cache->set('theme_registry:' . $this->theme->name, $this->registry, Cache::PERMANENT, array('theme_registry' => TRUE));
+    $this->cache->set('theme_registry:' . $this->theme->getName(), $this->registry, Cache::PERMANENT, array('theme_registry' => TRUE));
   }
 
   /**
@@ -319,20 +319,20 @@ protected function build() {
     // Process each base theme.
     foreach ($this->baseThemes as $base) {
       // If the base theme uses a theme engine, process its hooks.
-      $base_path = dirname($base->filename);
+      $base_path = $base->getPath();
       if ($this->engine) {