BundleInterface.php 850 Bytes
Newer Older
Ketan's avatar
Ketan committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
namespace Magento\Deploy\Package;

/**
 * Bundle Interface
 */
interface BundleInterface
{
    /**
     * Path relative to package directory where bundle files should be created
     */
    const BUNDLE_JS_DIR = 'js/bundle';

    /**
     * Add file that can be bundled
     *
     * @param string $filePath
     * @param string $sourcePath
     * @param string $contentType
     * @return bool true on success
     */
    public function addFile($filePath, $sourcePath, $contentType);

    /**
     * Flushes all files added to appropriate bundle
     *
     * @return bool true on success
     */
    public function flush();

    /**
     * Delete all bundles
     *
     * @return bool true on success
     */
    public function clear();
}