PHP Bitrix\Main\Config Option::getRealValue примеры использования

Пример #1

Файл: option.php Проект: ASDAFF/bxApiDocs

	/**
	 * <p>Возвращает строковое значение параметра <i>option_id</i>, принадлежащего модулю <i>module_id</i>. Если не установлен параметр <i>site_id</i> то делается попытка найти числовой параметр <i>option_id</i>, принадлежащий модулю <i>module_id</i> для текущего сайта. Если такого параметра нет, возвращается параметр, общий для всех сайтов.</p>
	 *
	 *
	 *
	 *
	 * @param string $module_id  <a href="http://dev.1c-bitrix.ru/api_help/main/general/identifiers.php">Идентификатор модуля</a>.
	 *
	 *
	 *
	 * @param string $option_id  Идентификатор параметра.
	 *
	 *
	 *
	 * @param mixed $default_value = false Значение по умолчанию.<br>Если <i>default_value</i> не задан, то значение для
	 * <i>default_value</i> будет браться из массива с именем ${<i>module_id</i>."_default_option"}
	 * заданного в файле <b>/bitrix/modules/</b><i>module_id</i><b>/default_option.php</b>.
	 *
	 *
	 *
	 * @param string $site_id = false Идентификатор сайта для которого будут возвращены параметры.
	 * Необязательный. По умолчанию - false (для текущего сайта или если не
	 * установлены то общие для всех сайтов)
	 *
	 *
	 *
	 * @return string 
	 *
	 *
	 * <h4>Example</h4> 
	 * <pre>
	 * &lt;?
	 * // получим поле "При регистрации добавлять в группу" 
	 * // из настроек главного модуля
	 * $default_group = <b>COption::GetOptionString</b>("main", "new_user_registration_def_group", "2");
	 * if($default_group!="")
	 *     $arrGroups = explode(",",$default_group);
	 * ?&gt;
	 * </pre>
	 *
	 *
	 *
	 * <h4>See Also</h4> 
	 * <ul> <li>[link=89621]Параметры модуля[/link] </li> <li> <a
	 * href="http://dev.1c-bitrix.ru/api_help/main/settings.php">Настройки главного модуля</a> </li>
	 * <li> <a href="http://dev.1c-bitrix.ru/api_help/main/reference/coption/getoptionint.php">COption::GetOptionInt</a> </li>
	 * </ul><a name="examples"></a>
	 *
	 *
	 * @static
	 * @link http://dev.1c-bitrix.ru/api_help/main/reference/coption/getoptionstring.php
	 * @author Bitrix
	 */
	public static function GetOptionString($module_id, $name, $def="", $site=false, $bExactSite=false)
	{
		if ($bExactSite)
		{
			$v = \Bitrix\Main\Config\Option::getRealValue($module_id, $name, $site);
			return $v === null ? false : $v;
		}

		return \Bitrix\Main\Config\Option::get($module_id, $name, $def, $site);
	}

Пример #2

Файл: option.php Проект: andy-profi/bxApiDocs

 /**
  * <p>Возвращает строковое значение параметра <i>option_id</i>, принадлежащего модулю <i>module_id</i>. Если не установлен параметр <i>site_id</i> то делается попытка найти числовой параметр <i>option_id</i>, принадлежащий модулю <i>module_id</i> для текущего сайта. Если такого параметра нет, возвращается параметр, общий для всех сайтов. Статичный метод.</p>
  *
  *
  * @param string $module_id  <a href="http://dev.1c-bitrix.ru/api_help/main/general/identifiers.php">Идентификатор модуля</a>.
  *
  * @param string $name  Идентификатор параметра.
  *
  * @param mixed $def = false Значение по умолчанию.<br>Если <i>default_value</i> не задан, то значение для
  * <i>default_value</i> будет браться из массива с именем ${<i>module_id</i>."_default_option"}
  * заданного в файле <b>/bitrix/modules/</b><i>module_id</i><b>/default_option.php</b>.
  *
  * @param string $site = false Идентификатор сайта для которого будут возвращены параметры.
  * Необязательный. По умолчанию - false (для текущего сайта или если не
  * установлены то общие для всех сайтов)
  *
  * @param bool $ExactSite = false Необязательный. По умолчанию "false".
  *
  * @return string 
  *
  * <h4>Example</h4> 
  * <pre>
  * &lt;?
  * // получим поле "При регистрации добавлять в группу" 
  * // из настроек главного модуля
  * $default_group = <b>COption::GetOptionString</b>("main", "new_user_registration_def_group", "2");
  * if($default_group!="")
  *     $arrGroups = explode(",",$default_group);
  * ?&gt;
  * 
  * Смотрите также
  * <li><a href="http://dev.1c-bitrix.ru/community/webdev/user/11948/blog/7799/">В многосайтовой конфигурации на втором сайте сделаем e-mail НЕ уникальным при регистрации. </a></li>
  * </pre>
  *
  *
  * <h4>See Also</h4> 
  * <ul> <li> <a href="https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=43&amp;LESSON_ID=2824"
  * >Параметры модуля</a> </li> <li> <a
  * href="http://dev.1c-bitrix.ru/api_help/main/settings.php">Настройки главного модуля</a> </li>
  * <li> <a href="http://dev.1c-bitrix.ru/api_help/main/reference/coption/getoptionint.php">COption::GetOptionInt</a> </li>
  * </ul> <a name="examples"></a>
  *
  *
  * @static
  * @link http://dev.1c-bitrix.ru/api_help/main/reference/coption/getoptionstring.php
  * @author Bitrix
  */
 public static function GetOptionString($module_id, $name, $def = "", $site = false, $bExactSite = false)
 {
     $v = null;
     try {
         if ($bExactSite) {
             $v = \Bitrix\Main\Config\Option::getRealValue($module_id, $name, $site);
             return $v === null ? false : $v;
         }
         $v = \Bitrix\Main\Config\Option::get($module_id, $name, $def, $site);
     } catch (\Bitrix\Main\ArgumentNullException $e) {
     }
     return $v;
 }