Skip to content

Commit

Permalink
* Renaming getCssFiles hook to getStylesheetFiles
Browse files Browse the repository at this point in the history 
* Renaming function names
* Removing getCss and getJs from CoreHome module since they are expected in the Proxy module

Refs #4134
  • Loading branch information
@mattab
mattab committed Sep 6, 2013
1 parent 6a9e242 commit d91d0d8
Show file tree
Hide file tree
Showing 27 changed files with 113 additions and 137 deletions.
26 changes: 13 additions & 13 deletions core/AssetManager.php
View file
Expand Up @@ -46,7 +46,7 @@ class AssetManager
{
const MERGED_CSS_FILE = "asset_manager_global_css.css";
const MERGED_JS_FILE = "asset_manager_global_js.js";
const CSS_IMPORT_EVENT = "AssetManager.getCssFiles";
const CSS_IMPORT_EVENT = "AssetManager.getStylesheetFiles";
const JS_IMPORT_EVENT = "AssetManager.getJsFiles";
const MERGED_FILE_DIR = "tmp/assets/";
const CSS_IMPORT_DIRECTIVE = "<link rel=\"stylesheet\" type=\"text/css\" href=\"%s\" />\n";
Expand Down Expand Up @@ -110,7 +110,7 @@ private static function prepareMergedCssFile()
$less = self::makeLess();

// Loop through each css file
$files = self::getCssFiles();
$files = self::getStylesheetFiles();
$mergedContent = "";
foreach ($files as $file) {

Expand Down Expand Up @@ -234,9 +234,9 @@ private static function getIndividualCssIncludes()
{
$cssIncludeString = '';

$cssFiles = self::getCssFiles();
$stylesheets = self::getStylesheetFiles();

foreach ($cssFiles as $cssFile) {
foreach ($stylesheets as $cssFile) {

self::validateCssFile($cssFile);
$cssIncludeString = $cssIncludeString . sprintf(self::CSS_IMPORT_DIRECTIVE, $cssFile);
Expand All @@ -250,12 +250,12 @@ private static function getIndividualCssIncludes()
*
* @return Array
*/
private static function getCssFiles()
private static function getStylesheetFiles()
{
$cssFiles = array();
Piwik_PostEvent(self::CSS_IMPORT_EVENT, array(&$cssFiles));
$stylesheets = array();
Piwik_PostEvent(self::CSS_IMPORT_EVENT, array(&$stylesheets));

$cssFiles = self::sortCssFiles($cssFiles);
$stylesheets = self::sortCssFiles($stylesheets);

// We also look for the currently enabled theme and add CSS from the json
$theme = PluginsManager::getInstance()->getThemeEnabled();
Expand All @@ -264,18 +264,18 @@ private static function getCssFiles()
if(isset($info['stylesheet'])) {
$themeStylesheetFile = 'plugins/'. $theme->getPluginName() . '/' . $info['stylesheet'];
}
$cssFiles[] = $themeStylesheetFile;
$stylesheets[] = $themeStylesheetFile;
}
return $cssFiles;
return $stylesheets;
}

/**
* Ensure CSS stylesheets are loaded in a particular order regardless of the order that plugins are loaded.
*
* @param array $cssFiles Array of CSS stylesheet files
* @param array $stylesheets Array of CSS stylesheet files
* @return array
*/
private static function sortCssFiles($cssFiles)
private static function sortCssFiles($stylesheets)
{
$priorityCssOrdered = array(
'libs/',
Expand All @@ -287,7 +287,7 @@ private static function sortCssFiles($cssFiles)
'tests/',
);

return self::prioritySort($priorityCssOrdered, $cssFiles);
return self::prioritySort($priorityCssOrdered, $stylesheets);
}

/**
Expand Down
6 changes: 3 additions & 3 deletions plugins/API/API.php
View file
Expand Up @@ -638,7 +638,7 @@ public function __construct()
public function getListHooksRegistered()
{
return array(
'AssetManager.getCssFiles' => 'getCssFiles',
'AssetManager.getStylesheetFiles' => 'getStylesheetFiles',
'TopMenu.add' => 'addTopMenu',
);
}
Expand All @@ -665,8 +665,8 @@ protected function addTopMenuMobileApp()
}
}

public function getCssFiles(&$cssFiles)
public function getStylesheetFiles(&$stylesheets)
{
$cssFiles[] = "plugins/API/stylesheets/listAllAPI.less";
$stylesheets[] = "plugins/API/stylesheets/listAllAPI.less";
}
}
6 changes: 3 additions & 3 deletions plugins/Actions/Actions.php
View file
Expand Up @@ -61,15 +61,15 @@ public function getListHooksRegistered()
'API.getReportMetadata' => 'getReportMetadata',
'API.getSegmentsMetadata' => 'getSegmentsMetadata',
'ViewDataTable.getReportDisplayProperties' => 'getReportDisplayProperties',
'AssetManager.getCssFiles' => 'getCssFiles',
'AssetManager.getStylesheetFiles' => 'getStylesheetFiles',
'AssetManager.getJsFiles' => 'getJsFiles'
);
return $hooks;
}

public function getCssFiles(&$cssFiles)
public function getStylesheetFiles(&$stylesheets)
{
$cssFiles[] = "plugins/Actions/stylesheets/dataTableActions.less";
$stylesheets[] = "plugins/Actions/stylesheets/dataTableActions.less";
}

public function getJsFiles(&$jsFiles)
Expand Down
6 changes: 3 additions & 3 deletions plugins/Annotations/Annotations.php
View file
Expand Up @@ -24,17 +24,17 @@ class Annotations extends \Piwik\Plugin
public function getListHooksRegistered()
{
return array(
'AssetManager.getCssFiles' => 'getCssFiles',
'AssetManager.getStylesheetFiles' => 'getStylesheetFiles',
'AssetManager.getJsFiles' => 'getJsFiles'
);
}

/**
* Adds css files for this plugin to the list in the event notification.
*/
public function getCssFiles(&$cssFiles)
public function getStylesheetFiles(&$stylesheets)
{
$cssFiles[] = "plugins/Annotations/stylesheets/annotations.less";
$stylesheets[] = "plugins/Annotations/stylesheets/annotations.less";
}

/**
Expand Down
12 changes: 6 additions & 6 deletions plugins/CoreAdminHome/CoreAdminHome.php
View file
Expand Up @@ -30,7 +30,7 @@ class CoreAdminHome extends \Piwik\Plugin
public function getListHooksRegistered()
{
return array(
'AssetManager.getCssFiles' => 'getCssFiles',
'AssetManager.getStylesheetFiles' => 'getStylesheetFiles',
'AssetManager.getJsFiles' => 'getJsFiles',
'AdminMenu.add' => 'addMenu',
'TaskScheduler.getScheduledTasks' => 'getScheduledTasks',
Expand All @@ -56,12 +56,12 @@ public function getScheduledTasks(&$tasks)
$tasks[] = $optimizeArchiveTableTask;
}

public function getCssFiles(&$cssFiles)
public function getStylesheetFiles(&$stylesheets)
{
$cssFiles[] = "libs/jquery/themes/base/jquery-ui.css";
$cssFiles[] = "plugins/CoreAdminHome/stylesheets/menu.less";
$cssFiles[] = "plugins/Zeitgeist/stylesheets/base.less";
$cssFiles[] = "plugins/CoreAdminHome/stylesheets/generalSettings.less";
$stylesheets[] = "libs/jquery/themes/base/jquery-ui.css";
$stylesheets[] = "plugins/CoreAdminHome/stylesheets/menu.less";
$stylesheets[] = "plugins/Zeitgeist/stylesheets/base.less";
$stylesheets[] = "plugins/CoreAdminHome/stylesheets/generalSettings.less";
}

public function getJsFiles(&$jsFiles)
Expand Down
24 changes: 0 additions & 24 deletions plugins/CoreHome/Controller.php
View file
Expand Up @@ -108,30 +108,6 @@ public function index()
echo $view->render();
}

/**
* This method is called when the asset manager is configured in merged mode.
* It returns the content of the css merged file.
*
* @see core/AssetManager.php
*/
public function getCss()
{
$cssMergedFile = AssetManager::getMergedCssFileLocation();
Piwik::serveStaticFile($cssMergedFile, "text/css");
}

/**
* This method is called when the asset manager is configured in merged mode.
* It returns the content of the js merged file.
*
* @see core/AssetManager.php
*/
public function getJs()
{
$jsMergedFile = AssetManager::getMergedJsFileLocation();
Piwik::serveStaticFile($jsMergedFile, "application/javascript; charset=UTF-8");
}

// --------------------------------------------------------
// ROW EVOLUTION
// The following methods render the popover that shows the
Expand Down
32 changes: 16 additions & 16 deletions plugins/CoreHome/CoreHome.php
View file
Expand Up @@ -24,7 +24,7 @@ class CoreHome extends \Piwik\Plugin
public function getListHooksRegistered()
{
return array(
'AssetManager.getCssFiles' => 'getCssFiles',
'AssetManager.getStylesheetFiles' => 'getStylesheetFiles',
'AssetManager.getJsFiles' => 'getJsFiles',
'WidgetsList.add' => 'addWidgets',
);
Expand All @@ -39,22 +39,22 @@ public function addWidgets()
WidgetsList::add('Example Widgets', 'Installation_Welcome', 'CoreHome', 'getPromoVideo');
}

public function getCssFiles(&$cssFiles)
public function getStylesheetFiles(&$stylesheets)
{
$cssFiles[] = "libs/jquery/themes/base/jquery-ui.css";
$cssFiles[] = "libs/jquery/stylesheets/jquery.jscrollpane.css";
$cssFiles[] = "libs/jquery/stylesheets/scroll.less";
$cssFiles[] = "plugins/Zeitgeist/stylesheets/base.less";
$cssFiles[] = "plugins/CoreHome/stylesheets/coreHome.less";
$cssFiles[] = "plugins/CoreHome/stylesheets/menu.less";
$cssFiles[] = "plugins/CoreHome/stylesheets/dataTable.less";
$cssFiles[] = "plugins/CoreHome/stylesheets/cloud.less";
$cssFiles[] = "plugins/CoreHome/stylesheets/jquery.ui.autocomplete.css";
$cssFiles[] = "plugins/CoreHome/stylesheets/jqplotColors.less";
$cssFiles[] = "plugins/CoreHome/stylesheets/sparklineColors.less";
$cssFiles[] = "plugins/CoreHome/stylesheets/promo.less";
$cssFiles[] = "plugins/CoreHome/stylesheets/color_manager.css";
$cssFiles[] = "plugins/CoreHome/stylesheets/sparklineColors.less";
$stylesheets[] = "libs/jquery/themes/base/jquery-ui.css";
$stylesheets[] = "libs/jquery/stylesheets/jquery.jscrollpane.css";
$stylesheets[] = "libs/jquery/stylesheets/scroll.less";
$stylesheets[] = "plugins/Zeitgeist/stylesheets/base.less";
$stylesheets[] = "plugins/CoreHome/stylesheets/coreHome.less";
$stylesheets[] = "plugins/CoreHome/stylesheets/menu.less";
$stylesheets[] = "plugins/CoreHome/stylesheets/dataTable.less";
$stylesheets[] = "plugins/CoreHome/stylesheets/cloud.less";
$stylesheets[] = "plugins/CoreHome/stylesheets/jquery.ui.autocomplete.css";
$stylesheets[] = "plugins/CoreHome/stylesheets/jqplotColors.less";
$stylesheets[] = "plugins/CoreHome/stylesheets/sparklineColors.less";
$stylesheets[] = "plugins/CoreHome/stylesheets/promo.less";
$stylesheets[] = "plugins/CoreHome/stylesheets/color_manager.css";
$stylesheets[] = "plugins/CoreHome/stylesheets/sparklineColors.less";
}

public function getJsFiles(&$jsFiles)
Expand Down
8 changes: 4 additions & 4 deletions plugins/CoreVisualizations/CoreVisualizations.php
View file
Expand Up @@ -28,7 +28,7 @@ class CoreVisualizations extends \Piwik\Plugin
public function getListHooksRegistered()
{
return array(
'AssetManager.getCssFiles' => 'getCssFiles',
'AssetManager.getStylesheetFiles' => 'getStylesheetFiles',
'AssetManager.getJsFiles' => 'getJsFiles',
'DataTableVisualization.getAvailable' => 'getAvailableDataTableVisualizations',
);
Expand All @@ -45,10 +45,10 @@ public function getAvailableDataTableVisualizations(&$visualizations)
$visualizations[] = 'Piwik\\Plugins\\CoreVisualizations\\Visualizations\\JqplotGraph\\Evolution';
}

public function getCssFiles(&$cssFiles)
public function getStylesheetFiles(&$stylesheets)
{
$cssFiles[] = "plugins/CoreVisualizations/stylesheets/dataTableVisualizations.less";
$cssFiles[] = "plugins/CoreVisualizations/stylesheets/jqplot.css";
$stylesheets[] = "plugins/CoreVisualizations/stylesheets/dataTableVisualizations.less";
$stylesheets[] = "plugins/CoreVisualizations/stylesheets/jqplot.css";
}

public function getJsFiles(&$jsFiles)
Expand Down
6 changes: 3 additions & 3 deletions plugins/DBStats/DBStats.php
View file
Expand Up @@ -31,7 +31,7 @@ class DBStats extends \Piwik\Plugin
public function getListHooksRegistered()
{
return array(
'AssetManager.getCssFiles' => 'getCssFiles',
'AssetManager.getStylesheetFiles' => 'getStylesheetFiles',
'AdminMenu.add' => 'addMenu',
'TaskScheduler.getScheduledTasks' => 'getScheduledTasks',
'ViewDataTable.getReportDisplayProperties' => 'getReportDisplayProperties',
Expand Down Expand Up @@ -75,9 +75,9 @@ public function cacheDataByArchiveNameReports()
Piwik_SetOption(self::TIME_OF_LAST_TASK_RUN_OPTION, $now);
}

public function getCssFiles(&$cssFiles)
public function getStylesheetFiles(&$stylesheets)
{
$cssFiles[] = "plugins/DBStats/stylesheets/dbStatsTable.less";
$stylesheets[] = "plugins/DBStats/stylesheets/dbStatsTable.less";
}

/** Returns the date when the cacheDataByArchiveNameReports was last run. */
Expand Down
8 changes: 4 additions & 4 deletions plugins/Dashboard/Dashboard.php
View file
Expand Up @@ -30,7 +30,7 @@ public function getListHooksRegistered()
{
return array(
'AssetManager.getJsFiles' => 'getJsFiles',
'AssetManager.getCssFiles' => 'getCssFiles',
'AssetManager.getStylesheetFiles' => 'getStylesheetFiles',
'UsersManager.deleteUser' => 'deleteDashboardLayout',
'Menu.add' => 'addMenus',
'TopMenu.add' => 'addTopMenu',
Expand Down Expand Up @@ -237,10 +237,10 @@ public function getJsFiles(&$jsFiles)
$jsFiles[] = "plugins/Dashboard/javascripts/dashboard.js";
}

public function getCssFiles(&$cssFiles)
public function getStylesheetFiles(&$stylesheets)
{
$cssFiles[] = "plugins/CoreHome/stylesheets/dataTable.less";
$cssFiles[] = "plugins/Dashboard/stylesheets/dashboard.less";
$stylesheets[] = "plugins/CoreHome/stylesheets/dataTable.less";
$stylesheets[] = "plugins/Dashboard/stylesheets/dashboard.less";
}

public function deleteDashboardLayout($userLogin)
Expand Down
6 changes: 3 additions & 3 deletions plugins/ExampleRssWidget/ExampleRssWidget.php
View file
Expand Up @@ -24,14 +24,14 @@ class ExampleRssWidget extends \Piwik\Plugin
public function getListHooksRegistered()
{
return array(
'AssetManager.getCssFiles' => 'getCssFiles',
'AssetManager.getStylesheetFiles' => 'getStylesheetFiles',
'WidgetsList.add' => 'addWidgets'
);
}

public function getCssFiles(&$cssFiles)
public function getStylesheetFiles(&$stylesheets)
{
$cssFiles[] = "plugins/ExampleRssWidget/stylesheets/rss.less";
$stylesheets[] = "plugins/ExampleRssWidget/stylesheets/rss.less";
}

public function addWidgets()
Expand Down
6 changes: 3 additions & 3 deletions plugins/Feedback/Feedback.php
View file
Expand Up @@ -24,7 +24,7 @@ class Feedback extends \Piwik\Plugin
public function getListHooksRegistered()
{
return array(
'AssetManager.getCssFiles' => 'getCssFiles',
'AssetManager.getStylesheetFiles' => 'getStylesheetFiles',
'AssetManager.getJsFiles' => 'getJsFiles',
'TopMenu.add' => 'addTopMenu',
);
Expand All @@ -42,9 +42,9 @@ public function addTopMenu()
);
}

public function getCssFiles(&$cssFiles)
public function getStylesheetFiles(&$stylesheets)
{
$cssFiles[] = "plugins/Feedback/stylesheets/feedback.less";
$stylesheets[] = "plugins/Feedback/stylesheets/feedback.less";
}

public function getJsFiles(&$jsFiles)
Expand Down
6 changes: 3 additions & 3 deletions plugins/Goals/Goals.php
View file
Expand Up @@ -89,7 +89,7 @@ public function getListHooksRegistered()
{
$hooks = array(
'AssetManager.getJsFiles' => 'getJsFiles',
'AssetManager.getCssFiles' => 'getCssFiles',
'AssetManager.getStylesheetFiles' => 'getStylesheetFiles',
'Common.fetchWebsiteAttributes' => 'fetchGoalsFromDb',
'ArchiveProcessing_Day.compute' => 'archiveDay',
'ArchiveProcessing_Period.compute' => 'archivePeriod',
Expand Down Expand Up @@ -406,9 +406,9 @@ public function getJsFiles(&$jsFiles)
$jsFiles[] = "plugins/Goals/javascripts/goalsForm.js";
}

public function getCssFiles(&$cssFiles)
public function getStylesheetFiles(&$stylesheets)
{
$cssFiles[] = "plugins/Goals/stylesheets/goals.css";
$stylesheets[] = "plugins/Goals/stylesheets/goals.css";
}

public function fetchGoalsFromDb(&$array, $idSite)
Expand Down
6 changes: 3 additions & 3 deletions plugins/Installation/Installation.php
View file
Expand Up @@ -31,7 +31,7 @@ public function getListHooksRegistered()
'FrontController.NoConfigurationFile' => 'dispatch',
'FrontController.badConfigurationFile' => 'dispatch',
'AdminMenu.add' => 'addMenu',
'AssetManager.getCssFiles' => 'getCss',
'AssetManager.getStylesheetFiles' => 'getStylesheetFiles',
);
return $hooks;
}
Expand Down Expand Up @@ -86,8 +86,8 @@ public function addMenu()
/**
* Adds CSS files to list of CSS files for asset manager.
*/
public function getCss(&$cssFiles)
public function getStylesheetFiles(&$stylesheets)
{
$cssFiles[] = "plugins/Installation/stylesheets/systemCheckPage.less";
$stylesheets[] = "plugins/Installation/stylesheets/systemCheckPage.less";
}
}

2 comments on commit d91d0d8

@halfdan
Copy link
Member

@halfdan halfdan commented on d91d0d8 Sep 6, 2013

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice one! Renamign AssetManager.filterMergedCss should be the next step, right?

@mattab
Copy link
Member Author

@mattab mattab commented on d91d0d8 Sep 6, 2013

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

once it's merged it's CSS so this name is ok

Please sign in to comment.