Skip to content

added asset file mapping parameter to define files which are remapped af... #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
schmunk42 wants to merge 3 commits into
base: master
Choose a base branch
from
Open

added asset file mapping parameter to define files which are remapped af... #5

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
82de6ed
added asset file mapping parameter to define files which are remapped…
schmunk42 Oct 10, 2013
775b695
updated property name and handling
schmunk42 Oct 13, 2013
781796a
fixed comments
schmunk42 Oct 23, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions PackageCompressor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,16 @@ class PackageCompressor extends CClientScript
*/
public $combineOnly = false;

/**
* Files defined in this array ('foo.js','bar.js') are available for package compression but not registered as a
* stand-alone file.
* You can use this parameter for example to override the client-script registration of files which are already
* published as an asset.
Copy link
Owner

@mikehaertl mikehaertl Nov 25, 2013

Choose a reason for hiding this comment

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

I think, we should update this docs once again, to be 100% precise. What about this (and please correct me if I'm wrong):

When compression is enabled, scripts defined in this array will be ignored if registered 
through `CClientScript::registerScriptFile()`. This way you can package assets from
widgets that don't use the package system. For the time being this is for example the
case for CListView. So you could use:

    'blockedScripts' => array(
        'jquery.yiilistview.js',
    ),
    'packages' => array(
        'listview' => array(
            'basePath' => 'zii.widgets.assets.listview',
            'js' => array('jquery.yiilistview.js'),
        ),
        'mypackage' => array(
           'js' => array( ... ),
           'depends' => array(
               'listview',
           ),
        ),
    ),

*
* @var blocked script files for clientscript registration
*/
public $blockedScripts = array();

/**
* If this is enabled, during compression all other requests will wait until the compressing
* process has completed. If disabled, the uncompressed files will be delivered for these
Expand Down Expand Up @@ -225,6 +235,13 @@ public function render(&$output)

$this->renderCoreScripts();

// Merge scripts from `blockedScripts` if compression is enabled,
// since it is assumed the files have been bundled into packages or handled elsewhere.
if ($this->enableCompression && $this->blockedScripts!==array()) {
foreach($this->blockedScripts AS $script) {
$this->scriptMap[$script] = false;
}
}
if(!empty($this->scriptMap))
$this->remapScripts();

Expand Down