File phpboost/menu/links/LinksMenuElement.class.php
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: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: <?php
/**
* A LinksMenuElement contains a Title, an url, and an image url
* <div class="message-helper notice">Abstract class : Do not instanciate it
* LinksMenuLink and LinksMenuLink classes are based on this class
* use, on of these</div>
* @package PHPBoost
* @subpackage Menu\links
* @copyright © 2005-2019 PHPBoost
* @license https://www.gnu.org/licenses/gpl-3.0.html GNU/GPL-3.0
* @author Regis VIARRE <crowkait@phpboost.com>
* @version PHPBoost 5.2 - last update: 2016 10 24
* @since PHPBoost 2.0 - 2008 07 08
* @contributor Loic ROUCHON <horn@phpboost.com>
* @contributor Julien BRISWALTER <j1.seth@phpboost.com>
* @contributor Arnaud GENET <elenwii@phpboost.com>
*/
abstract class LinksMenuElement extends Menu
{
const LINKS_MENU_ELEMENT__CLASS = 'LinksMenuElement';
const LINKS_MENU_ELEMENT__FULL_DISPLAYING = true;
const LINKS_MENU_ELEMENT__CLASSIC_DISPLAYING = false;
/**
* @access protected
* @var string the LinksMenuElement url
*/
public $url = '';
/**
* @access protected
* @var string the image url. Could be relative to the website root or absolute
*/
public $image = '';
/**
* @access protected
* @var int Menu's uid
*/
public $uid = null;
/**
* @access protected
* @var int Menu's depth
*/
public $depth = 0;
/**
* Build a LinksMenuElement object
* @param $title
* @param $url
* @param $image
* @param int $id The Menu's id in the database
*/
public function __construct($title, $url, $image = '')
{
parent::__construct($title);
$this->set_url($url);
$this->set_image($image);
$this->uid = AppContext::get_uid();
}
/**
* Assign tpl vars
* @access protected
* @param Template $template the template on which we gonna assign vars
* @param int $mode in LinksMenuElement::LINKS_MENU_ELEMENT__CLASSIC_DISPLAYING mode, the links menu is
* displayed. With the LinksMenuElement::LINKS_MENU_ELEMENT__FULL_DISPLAYING mode, the authorization form is
* also shown.
*/
protected function _assign($template, $mode = self::LINKS_MENU_ELEMENT__CLASSIC_DISPLAYING)
{
if ($this->image)
{
if ($this->image instanceof Url)
$url = $this->image;
else
$url = new Url($this->image);
if (file_exists(PATH_TO_ROOT . $this->image))
{
if (!$url->is_relative())
$image = new Image($url->absolute());
else
$image = new Image(PATH_TO_ROOT . $this->image);
$template->put_all(array(
'C_IMG' => !empty($this->image),
'ABSOLUTE_IMG' => $url->absolute(),
'RELATIVE_IMG' => $url->relative(),
'REL_IMG' => $url->rel(),
'IMG_HEIGHT' => $image->get_height(),
'IMG_WIDTH' => $image->get_width()
));
}
}
parent::_assign($template);
if ($this->url instanceof Url)
$url = $this->url;
else
$url = new Url($this->url);
$template->put_all(array(
'C_MENU' => false,
'C_DISPLAY_AUTH' => AppContext::get_current_user()->check_auth($this->get_auth(), Menu::MENU_AUTH_BIT),
'TITLE' => $this->title,
'L_TITLE' => LangLoader::get_message('menu.link-to', 'user-common') . $this->title,
'DEPTH' => $this->depth,
'PARENT_DEPTH' => $this->depth - 1,
'C_URL' => $this->url,
'ABSOLUTE_URL' => $url->absolute(),
'RELATIVE_URL' => $url->relative(),
'REL_URL' => $url->rel(),
'ID' => $this->get_uid(),
'ID_VAR' => $this->get_uid()
));
//Full displaying: we also show the authorization formulary
if ($mode)
{
$template->put_all(array(
'C_AUTH_MENU_HIDDEN' => $this->get_auth() == array('r-1' => Menu::MENU_AUTH_BIT, 'r0' => Menu::MENU_AUTH_BIT, 'r1' => Menu::MENU_AUTH_BIT),
'AUTH_FORM' => Authorizations::generate_select(Menu::MENU_AUTH_BIT, $this->get_auth(), array(), 'menu_element_' . $this->uid . '_auth')
));
}
}
/**
* @param string $string_url the url to relativize / absolutize
* @param bool $compute_relative_url If true, computes relative urls to the website root
* @return string the $string_url url
*/
private function _get_url($string_url, $compute_relative_url = true)
{
if ($string_url instanceof Url)
$url = $string_url;
else
$url = new Url($string_url);
if ($compute_relative_url)
{
return $url->relative();
}
else
{
return $url->absolute();
}
}
/**
* Increase the Menu Depth and set the menu type to its parent one
* @access protected
*/
protected function _parent($type)
{
$this->depth++;
}
## Setters ##
/**
* @param string $image the value to set
*/
public function set_image($image)
{
$this->image = $image;
}
/**
* @param string $url the value to set
*/
public function set_url($url)
{
$this->url = $url;
}
## Getters ##
/**
* Returns the menu uid
* @return int the menu uid
*/
public function get_uid()
{
return $this->uid;
}
/**
* Update the menu uid
*/
public function update_uid()
{
$this->uid = AppContext::get_uid();
}
/**
* @param bool $compute_relative_url If true, computes relative urls to the website root
* @return string the link $url
*/
public function get_url($compute_relative_url = true)
{
return $this->_get_url($this->url, $compute_relative_url);
}
/**
* @param bool $compute_relative_url If true, computes relative urls to the website root
* @return string the $image url
*/
public function get_image($compute_relative_url = true)
{
return $this->_get_url($this->image, $compute_relative_url);
}
}
?>