/**
* Zikula_View function to provide easy access to an image
*
* This function provides an easy way to include an image. The function will return the
* full source path to the image. It will as well provite the width and height attributes
* if none are set.
*
* Available parameters:
* - src The file name of the image
* - modname The well-known name of a module (default: the current module)
* - modplugin The name of the plugin in the passed module
* - sysplugin The name of the system plugin
* - width, height If set, they will be passed. If none is set, they are obtained from the image
* - alt If not set, an empty string is being assigned
* - title If set it will be passed as a title attribute
* - assign If set, the results are assigned to the corresponding variable instead of printed out
* - optional If set then the plugin will not return an error if an image is not found
* - default If set then a default image is used should the requested image not be found (Note: full path required)
* - set If modname is 'core' then the set parameter is set to define the directory in /images/
* - nostoponerror If set and error ocurs (image not found or src is no image), do not trigger_error, but return false
* - retval If set indicated the field to return instead the array of values (src, width, etc.)
* - fqurl If set the image path is absolute, if not relative
* - all remaining parameters are passed to the image tag
*
* Example: {img src='heading.png'}
* Output: <img src="modules/Example/images/en/heading.png" alt="" width="261" height="69" />
*
* Example: {img src='heading.png' width='100' border='1' __alt='foobar'}
* Output: <img src="modules/Example/images/en/heading.png" width="100" border="1" alt="foobar" />
*
* Example: {img src='xhtml11.png' modname='core' set='powered'}
* Output: <img src="themes/Theme/images/powered/xhtml11.png" alt="" width="88" height="31" />
*
* Example: {img src='iconX.png' modname='ModName' modplugin='Plug1' set='icons'}
* Output: <img src="modules/ModName/plugins/Plug1/images/icons/iconX.png" alt="" width="16" height="16" />
*
* Example: {img src='iconY.png' sysplugin='Plug2' set='icons/small'}
* Output: <img src="plugins/Plug2/images/icons/small/iconY.png" alt="" width="16" height="16" />
*
* If the parameter assign is set, the results are assigned as an array. The components of
* this array are the same as the attributes of the img tag; additionally an entry 'imgtag' is
* set to the complete image tag.
*
* Example:
* {img src="heading.png" assign="myvar"}
* {$myvar.src}
* {$myvar.width}
* {$myvar.imgtag}
*
* Output:
* modules/Example/images/en/heading.gif
* 261
* <img src="modules/Example/images/en/heading.gif" alt="" width="261" height="69" />
*
* @param array $params All attributes passed to this function from the template.
* @param Zikula_View $view Reference to the Zikula_View object.
*
* @return string|void The img tag, null if $params['nostoponerror'] true and there is an error.
*/
function smarty_function_img($params, Zikula_View $view)
{
$nostoponerror = isset($params['nostoponerror']) && $params['nostoponerror'] ? true : false;
if (!isset($params['src']) || !$params['src']) {
if (!$nostoponerror) {
$view->trigger_error(__f('Error! in %1$s: the %2$s parameter must be specified.', array('img', 'src')));
return;
} else {
return false;
}
}
// process the image location
$modname = isset($params['modname']) ? $params['modname'] : $view->toplevelmodule;
$modplugin = isset($params['modplugin']) ? $params['modplugin'] : null;
$sysplugin = isset($params['sysplugin']) ? $params['sysplugin'] : null;
// process the image set
$set = isset($params['set']) ? $params['set'] : null;
$osset = DataUtil::formatForOS($set);
// if the module name is 'core'
if ($modname == 'core') {
if (System::isLegacyMode() && (strpos($osset, 'icons/') !== false || strpos($osset, 'global/') !== false) && strpos($params['src'], '.gif')) {
LogUtil::log(__f('Core image %s does not exist, please use the png format (called from %s).', array($params['src'], $view->getTemplatePath())), E_USER_DEPRECATED);
$params['src'] = str_replace('.gif', '.png', $params['src']);
}
}
// always provide an alt attribute.
// if none is set, assign an empty one.
$params['alt'] = isset($params['alt']) ? $params['alt'] : '';
// prevent overwriting surrounding titles (#477)
if (isset($params['title']) && empty($params['title'])) {
unset($params['title']);
}
// language
$lang = ZLanguage::transformFS(ZLanguage::getLanguageCode());
if ($sysplugin) {
$osplugdir = DataUtil::formatForOS($sysplugin);
$pluglangpath = "plugins/{$osplugdir}/images/{$lang}";
$plugpath = "plugins/{$osplugdir}/images";
// form the array of paths
$paths = array($pluglangpath, $plugpath);
} else {
// module directory
if ($modname != 'core') {
$modinfo = ModUtil::getInfoFromName($modname);
$osmoddir = DataUtil::formatForOS($modinfo['directory']);
$moduleDir = $modinfo['type'] == ModUtil::TYPE_SYSTEM ? 'system' : 'modules';
}
if ($modplugin) {
$osmodplugdir = DataUtil::formatForOS($modplugin);
$modpluglangpath = "{$moduleDir}/{$osmoddir}/plugins/{$osmodplugdir}/Resources/public/images/{$lang}";
$modplugpath = "{$moduleDir}/{$osmoddir}/plugins/{$osmodplugdir}/Resources/public/images";
$modpluglangpathOld = "{$moduleDir}/{$osmoddir}/plugins/{$osmodplugdir}/images/{$lang}";
$modplugpathOld = "{$moduleDir}/{$osmoddir}/plugins/{$osmodplugdir}/images";
// form the array of paths
$paths = array($modpluglangpath, $modplugpath, $modpluglangpathOld, $modplugpathOld);
} else {
// theme directory
$ostheme = DataUtil::formatForOS(UserUtil::getTheme());
$theme = ThemeUtil::getTheme($ostheme);
$themePath = null === $theme ? '' : $theme->getRelativePath() . '/Resources/public/images';
$themepath = $themePath;
$corethemepath = "themes/{$ostheme}/images";
if ($modname == 'core') {
$modpath = "images";
$paths = array($themepath, $corethemepath, $modpath);
} else {
$osmodname = DataUtil::formatForOS($modname);
$themelangpath = "{$themePath}/{$lang}";
$themelangpathOld = "themes/{$ostheme}/templates/modules/{$osmodname}/images/{$lang}";
$themepathOld = "themes/{$ostheme}/templates/modules/{$osmodname}/images";
$module = ModUtil::getModule($modinfo['name']);
$moduleBasePath = null === $module ? '' : $module->getRelativePath() . '/Resources/public/images';
$modlangpath = "{$moduleBasePath}/{$lang}";
$modpath = $moduleBasePath;
$modlangpathOld = "{$moduleDir}/{$osmoddir}/images/{$lang}";
$modpathOld = "{$moduleDir}/{$osmoddir}/images";
$modlangpathOld2 = "{$moduleDir}/{$osmoddir}/pnimages/{$lang}";
$modpathOld2 = "{$moduleDir}/{$osmoddir}/pnimages";
// form the array of paths
if (preg_match('/^admin.(png|gif|jpg)$/', $params['src'])) {
// special processing for modules' admin icon
$paths = array($modlangpath, $modpath, $modlangpathOld, $modpathOld, $modlangpathOld, $modpathOld, $modlangpathOld2, $modpathOld2);
} else {
$paths = array($themelangpath, $themepath, $themelangpathOld, $themepathOld, $corethemepath, $modlangpath, $modpath, $modlangpathOld, $modpathOld, $modlangpathOld2, $modpathOld2);
}
}
}
}
$ossrc = DataUtil::formatForOS($params['src']);
// search for the image
$imgsrc = '';
foreach ($paths as $path) {
$fullpath = $path . ($osset ? "/{$osset}/" : '/') . $ossrc;
if (is_readable($fullpath)) {
$imgsrc = $fullpath;
break;
}
}
if ($imgsrc == '' && isset($params['default'])) {
$imgsrc = $params['default'];
}
// default for the optional flag
$optional = isset($params['optional']) ? $params['optional'] : true;
if ($imgsrc == '') {
if ($optional) {
if (!$nostoponerror) {
$view->trigger_error(__f("%s: Image '%s' not found", array('img', DataUtil::formatForDisplay(($set ? "{$set}/" : '') . $params['src']))));
return;
} else {
return false;
}
}
return;
}
// If neither width nor height is set, get these parameters.
// If one of them is set, we do NOT obtain the real dimensions.
// This way it is easy to scale the image to a certain dimension.
if (!isset($params['width']) && !isset($params['height'])) {
if (!($_image_data = @getimagesize($imgsrc))) {
if (!$nostoponerror) {
$view->trigger_error(__f("%s: Image '%s' is not a valid image file", array('img', DataUtil::formatForDisplay(($set ? "{$set}/" : '') . $params['src']))));
return;
} else {
return false;
}
}
$params['width'] = $_image_data[0];
$params['height'] = $_image_data[1];
}
$basepath = isset($params['fqurl']) && $params['fqurl'] ? System::getBaseUrl() : System::getBaseUri();
$params['src'] = $basepath . '/' . $imgsrc;
$retval = isset($params['retval']) ? $params['retval'] : null;
$assign = isset($params['assign']) ? $params['assign'] : null;
unset($params['modname']);
unset($params['retval']);
unset($params['assign']);
if (isset($params['altml'])) {
// legacy
unset($params['altml']);
}
if (isset($params['titleml'])) {
// legacy
unset($params['titleml']);
}
unset($params['optional']);
unset($params['default']);
unset($params['set']);
unset($params['nostoponerror']);
unset($params['fqurl']);
$imgtag = '<img ';
foreach ($params as $key => $value) {
$imgtag .= $key . '="' . $value . '" ';
}
$imgtag .= '/>';
if (!empty($retval) && isset($params[$retval])) {
return $params[$retval];
} elseif (!empty($assign)) {
$params['imgtag'] = $imgtag;
$view->assign($assign, $params);
} else {
return $imgtag;
}
}
/**
* Zikula_View function to provide easy access to an image
*
* This function provides an easy way to include an image. The function will return the
* full source path to the image. It will as well provite the width and height attributes
* if none are set.
*
* Available parameters:
* - src The file name of the image
* - modname The well-known name of a module (default: the current module)
* - width, height If set, they will be passed. If none is set, they are obtained from the image
* - alt If not set, an empty string is being assigned
* - title If set it will be passed as a title attribute
* - assign If set, the results are assigned to the corresponding variable instead of printed out
* - optional If set then the plugin will not return an error if an image is not found
* - default If set then a default image is used should the requested image not be found (Note: full path required)
* - set If modname is 'core' then the set parameter is set to define the directory in /images/
* - nostoponerror If set and error ocurs (image not found or src is no image), do not trigger_error, but return false and fill pnimg_error instead
* - retval If set indicated the field to return instead the array of values (src, width, etc.)
* - fqurl If set the image path is absolute, if not relative
* - all remaining parameters are passed to the image tag
*
* Example: {img src="heading.png" }
* Output: <img src="modules/Example/images/en/heading.png" alt="" width="261" height="69" />
*
* Example: {img src="heading.png" width="100" border="1" alt="foobar" }
* Output: <img src="modules/Example/images/en/heading.png" width="100" border="1" alt="foobar" />
*
* Example {img src=xhtml11.png modname=core set=powered}
* <img src="/Theme/images/powered/xhtml11.png" alt="" width="88" height="31" />
*
* If the parameter assign is set, the results are assigned as an array. The components of
* this array are the same as the attributes of the img tag; additionally an entry 'imgtag' is
* set to the complete image tag.
*
* Example:
* {img src="heading.png" assign="myvar"}
* {$myvar.src}
* {$myvar.width}
* {$myvar.imgtag}
*
* Output:
* modules/Example/images/en/heading.gif
* 261
* <img src="modules/Example/images/en/heading.gif" alt="" width="261" height="69" />
*
* @param array $params All attributes passed to this function from the template.
* @param Zikula_View $view Reference to the Zikula_View object.
*
* @return string|void The img tag, null if $params['nostoponerror'] true and there is an error.
*/
function smarty_function_img($params, Zikula_View $view)
{
$nostoponerror = (isset($params['nostoponerror'])) ? true : false;
if (!isset($params['src'])) {
$view->trigger_error(__f('Error! in %1$s: the %2$s parameter must be specified.', array('img', 'src')));
if ($nostoponerror == true) {
return;
} else {
return false;
}
}
// default for the module
$modname = isset($params['modname']) ? $params['modname'] : $view->toplevelmodule;
// if the module name is 'core' then we require an image set
if ($modname == 'core') {
if (!isset($params['set'])) {
$view->trigger_error(__f('Error! in %1$s: the %2$s parameter must be specified.', array('img', 'set')));
if ($nostoponerror == true) {
return;
} else {
return false;
}
}
$osset = DataUtil::formatForOS($params['set']);
if (System::isLegacyMode() && (strpos($osset, 'icons/') !== false || strpos($osset, 'global/') !== false) && strpos($params['src'], '.gif')) {
LogUtil::log(__f('Core image %s does not exist, please use the png format (called from %s).', array($params['src'], $view->getTemplatePath())), E_DEPRECATED);
$params['src'] = str_replace('.gif', '.png', $params['src']);
}
}
// default for the optional flag
$optional = isset($params['optional']) ? $params['optional'] : true;
// always provide an alt attribute.
// if none is set, assign an empty one.
$params['alt'] = isset($params['alt']) ? $params['alt'] : '';
if (!isset($params['title'])) {
$params['title'] = '';
}
// prevent overwriting surrounding titles (#477)
if (empty($params['title'])) {
unset($params['title']);
}
// language
$lang = ZLanguage::transformFS(ZLanguage::getLanguageCode());
// theme directory
$theme = DataUtil::formatForOS(UserUtil::getTheme());
$osmodname = DataUtil::formatForOS($modname);
$themelangpath = "themes/$theme/templates/modules/$osmodname/images/$lang";
$themepath = "themes/$theme/templates/modules/$osmodname/images";
$corethemepath = "themes/$theme/images";
// module directory
$modinfo = ModUtil::getInfoFromName($modname);
$osmoddir = DataUtil::formatForOS($modinfo['directory']);
$moduleDir = ($modinfo['type'] == ModUtil::TYPE_SYSTEM ? 'system' : 'modules');
if ($modname == 'core') {
$modpath = "images/$osset";
} else {
$modlangpath = "$moduleDir/$osmoddir/images/$lang";
$modpath = "$moduleDir/$osmoddir/images";
$modlangpathOld = "$moduleDir/$osmoddir/pnimages/$lang";
$modpathOld = "$moduleDir/$osmoddir/pnimages";
}
$ossrc = DataUtil::formatForOS($params['src']);
// form the array of paths
if ($modname == 'core') {
$paths = array($themepath, $corethemepath, $modpath);
} else {
$paths = array($themelangpath, $themepath, $corethemepath, $modlangpath, $modpath, $modlangpathOld, $modpathOld);
}
// search for the image
$imgsrc = '';
foreach ($paths as $path) {
if (is_readable("$path/$ossrc")) {
$imgsrc = "$path/$ossrc";
break;
}
}
if ($imgsrc == '' && isset($params['default'])) {
$imgsrc = $params['default'];
}
if ($imgsrc == '') {
if ($optional) {
$view->trigger_error(__f("%s: Image '%s' not found", array('img', DataUtil::formatForDisplay($params['src']))));
if ($nostoponerror == true) {
return;
} else {
return false;
}
}
return;
}
// If neither width nor height is set, get these parameters.
// If one of them is set, we do NOT obtain the real dimensions.
// This way it is easy to scale the image to a certain dimension.
if (!isset($params['width']) && !isset($params['height'])) {
if (!($_image_data = @getimagesize($imgsrc))) {
$view->trigger_error(__f("%s: Image '%s' is not a valid image file", array('pnimg', DataUtil::formatForDisplay($params['src']))));
if ($nostoponerror == true) {
return;
} else {
return false;
}
}
$params['width'] = $_image_data[0];
$params['height'] = $_image_data[1];
}
$basepath = (isset($params['fqurl']) && $params['fqurl']) ? System::getBaseUrl() : System::getBaseUri();
$params['src'] = $basepath . '/' . $imgsrc;
$retval = isset($params['retval']) ? $params['retval'] : null;
unset($params['modname']);
$assign = null;
if (isset($params['assign'])) {
$assign = $params['assign'];
unset($params['assign']);
}
unset($params['retval']);
if (isset($params['altml'])) {
// legacy
unset($params['altml']);
}
if (isset($params['titleml'])) {
// legacy
unset($params['titleml']);
}
unset($params['optional']);
unset($params['default']);
unset($params['set']);
unset($params['nostoponerror']);
unset($params['fqurl']);
$imgtag = '<img ';
foreach ($params as $key => $value) {
$imgtag .= $key . '="' .$value . '" ';
}
$imgtag .= '/>';
if (!empty($retval) && isset($params[$retval])) {
return $params[$retval];
} else if (!empty($assign)) {
$params['imgtag'] = $imgtag;
$view->assign($assign, $params);
} else {
return $imgtag;
}
}
