CAssetManager

Подробное описание свойств

basePath свойство

public string getBasePath()
public void setBasePath(string $value)

корневой каталог, хранящий опубликованные файлы активов. По умолчанию 'WebRoot/assets'.

baseUrl свойство

public string getBaseUrl()
public void setBaseUrl(string $value)

базовый URL, по которому можно получить доступ к опубликованным файлам ресурсов. Обратите внимание, что конечные слеши удаляются. По умолчанию равно '/AppBaseUrl/assets'.

excludeFiles свойство (доступно начиная с v1.1.6)

public array $excludeFiles;

список каталогов и файлов, которые должны быть исключены из процесса публикации. По умолчанию исключаются только файлы '.svn' и '.gitignore'. Этот параметр не имеет эффекта, если включен linkAssets.

forceCopy свойство (доступно начиная с v1.1.11)

public boolean $forceCopy;

определяет, нужно ли копировать файлы и каталоги ресурсов, даже если они уже были опубликованы ранее. Это свойство используется только на стадии разработки. Основной случай использования этого свойства — когда необходимо всегда форсировать копирование исходных ресурсов, изменив только одно значение, без необходимости поиска вызовов метода publish по всему коду приложения. Также оно полезно в операционных системах, которые не полностью поддерживают символические ссылки (поэтому нельзя использовать $linkAssets) или мы не хотим их использовать. Это свойство устанавливает значение параметра $forceCopy в методе publish по умолчанию. Значение по умолчанию этого свойства — false, что означает, что ресурсы будут опубликованы только в том случае, если они не существуют в каталоге ресурсов webroot.

Обратите внимание, что это свойство не может быть истинным, когда свойство $linkAssets также имеет значение true. В противном случае будет выброшено исключение. Одновременное использование обоих свойств нелогично, так как оба решают схожие задачи, но разными способами. Для получения более подробной информации см. документацию по $linkAssets.

linkAssets свойство (доступно начиная с v1.1.5)

public boolean $linkAssets;

использовать ли символическую ссылку для публикации файлов ресурсов. По умолчанию false, что означает, что файлы ресурсов копируются в общедоступные папки. Использование символических ссылок обеспечивает, что опубликованные ресурсы всегда будут согласованы с исходными ресурсами. Это особенно полезно во время разработки.

Однако существуют специальные требования для сред хостинга для использования символических ссылок. В частности, символические ссылки поддерживаются только в Linux/Unix и Windows Vista/2008 или выше. Последнее требует PHP 5.3 или выше.

Кроме того, некоторым веб-серверам необходимо правильно настроить доступ к связанным ресурсам для веб-пользователей. Например, для веб-сервера Apache необходимо добавить следующее директиву в конфигурацию для веб-папки:

Options FollowSymLinks

newDirMode свойство (доступно начиная с v1.1.8)

public integer $newDirMode;

права доступа, которые должны быть установлены для вновь созданных каталогов ресурсов. Это значение будет использовано функцией PHP chmod. По умолчанию 0777, что означает, что каталог может быть прочитан, записан и выполнен всеми пользователями.

newFileMode свойство (доступно начиная с v1.1.8)

public integer $newFileMode;

права доступа, которые должны быть установлены для вновь созданных файлов ресурсов. Это значение будет использовано функцией PHP chmod. По умолчанию 0666, что означает, что файл может быть прочитан и записан всеми пользователями.

Подробное описание методов

generatePath() метод (доступно начиная с v1.1.13)

protected string generatePath(string $file, bool $hashByName=false)

protected function generatePath($file,$hashByName=false)
{
    if (is_file($file))
        $pathForHashing=$hashByName ? dirname($file) : dirname($file).filemtime($file);
    else
        $pathForHashing=$hashByName ? $file : $file.filemtime($file);

    return $this->hash($pathForHashing);
}

Генерирует сегменты пути, относящиеся к basePath.

getBasePath() метод

public string getBasePath()

public function getBasePath()
{
    if($this->_basePath===null)
    {
        $request=Yii::app()->getRequest();
        $this->setBasePath(dirname($request->getScriptFile()).DIRECTORY_SEPARATOR.self::DEFAULT_BASEPATH);
    }
    return $this->_basePath;
}

getBaseUrl() метод

public string getBaseUrl()

public function getBaseUrl()
{
    if($this->_baseUrl===null)
    {
        $request=Yii::app()->getRequest();
        $this->setBaseUrl($request->getBaseUrl().'/'.self::DEFAULT_BASEPATH);
    }
    return $this->_baseUrl;
}

getPublishedPath() метод

public string getPublishedPath(string $path, boolean $hashByName=false)

public function getPublishedPath($path,$hashByName=false)
{
    if(is_string($path) && ($path=realpath($path))!==false)
    {
        $base=$this->getBasePath().DIRECTORY_SEPARATOR.$this->generatePath($path,$hashByName);
        return is_file($path) ? $base.DIRECTORY_SEPARATOR.basename($path) : $base ;
    }
    else
        return false;
}

Возвращает опубликованный путь к файлу или каталогу. Этот метод не выполняет никакой публикации. Он просто сообщает, опубликован ли файл или каталог и где он будет находиться.

getPublishedUrl() метод

public string getPublishedUrl(string $path, boolean $hashByName=false)

public function getPublishedUrl($path,$hashByName=false)
{
    if(isset($this->_published[$path]))
        return $this->_published[$path];
    if(is_string($path) && ($path=realpath($path))!==false)
    {
        $base=$this->getBaseUrl().'/'.$this->generatePath($path,$hashByName);
        return is_file($path) ? $base.'/'.basename($path) : $base;
    }
    else
        return false;
}

Возвращает URL опубликованного файла или каталога. Этот метод не выполняет никакой публикации. Он просто сообщает, опубликован ли файл и какой URL будет использоваться для доступа к нему.

hash() метод

protected string hash(string $path)

protected function hash($path)
{
    return sprintf('%x',crc32($path.Yii::getVersion()));
}

Генерирует хэш CRC32 для пути к каталогу. Коллизии выше, чем у MD5, но генерируется значительно более короткая строка хэша.

publish() метод

public string publish(string $path, boolean $hashByName=false, integer $level=-1, boolean $forceCopy=NULL)

public function publish($path,$hashByName=false,$level=-1,$forceCopy=null)
{
    if($forceCopy===null)
        $forceCopy=$this->forceCopy;
    if($forceCopy && $this->linkAssets)
        throw new CException(Yii::t('yii','The "forceCopy" and "linkAssets" cannot be both true.'));
    if(isset($this->_published[$path]))
        return $this->_published[$path];
    elseif(is_string($path) && ($src=realpath($path))!==false)
    {
        $dir=$this->generatePath($src,$hashByName);
        $dstDir=$this->getBasePath().DIRECTORY_SEPARATOR.$dir;
        if(is_file($src))
        {
            $fileName=basename($src);
            $dstFile=$dstDir.DIRECTORY_SEPARATOR.$fileName;

            if(!is_dir($dstDir))
            {
                mkdir($dstDir,$this->newDirMode,true);
                @chmod($dstDir,$this->newDirMode);
            }

            if($this->linkAssets && !is_file($dstFile)) symlink($src,$dstFile);
            elseif(@filemtime($dstFile)<@filemtime($src))
            {
                copy($src,$dstFile);
                @chmod($dstFile,$this->newFileMode);
            }

            return $this->_published[$path]=$this->getBaseUrl()."/$dir/$fileName";
        }
        elseif(is_dir($src))
        {
            if($this->linkAssets && !is_dir($dstDir))
            {
                symlink($src,$dstDir);
            }
            elseif(!is_dir($dstDir) || $forceCopy)
            {
                CFileHelper::copyDirectory($src,$dstDir,array(
                    'exclude'=>$this->excludeFiles,
                    'level'=>$level,
                    'newDirMode'=>$this->newDirMode,
                    'newFileMode'=>$this->newFileMode,
                ));
            }

            return $this->_published[$path]=$this->getBaseUrl().'/'.$dir;
        }
    }
    throw new CException(Yii::t('yii','The asset "{asset}" to be published does not exist.',
        array('{asset}'=>$path)));
}

Опубликовывает файл или директорию. Этот метод скопирует указанный актив в доступную по сети директорию и вернет URL для доступа к опубликованному активу.

• Если актив — файл, будет проверено время его последнего изменения, чтобы избежать ненужного копирования;
• Если актив — директория, все файлы и поддиректории внутри нее будут опубликованы рекурсивно. Обратите внимание, что в случае, если $forceCopy равен false, метод проверяет только существование целевой директории, чтобы избежать повторного копирования.

setBasePath() метод

public void setBasePath(string $value)

public function setBasePath($value)
{
    if(($basePath=realpath($value))!==false && is_dir($basePath) && is_writable($basePath))
        $this->_basePath=$basePath;
    else
        throw new CException(Yii::t('yii','CAssetManager.basePath "{path}" is invalid. Please make sure the directory exists and is writable by the Web server process.',
            array('{path}'=>$value)));
}

Устанавливает корневую директорию, хранящую опубликованные файлы актива.

setBaseUrl() метод

public void setBaseUrl(string $value)

public function setBaseUrl($value)
{
    $this->_baseUrl=rtrim($value,'/');
}