Jump to main content Jump to doc navigation

xPDOObject::getOption()

Получает значение параметра для этого экземпляра xPDOObject, используя параметры xPDO, если не существует конкретного параметра.

Синтаксис

API Docs: http://api.modxcms.com/xpdo/om/xPDOObject.html#getOption

mixed getOption (string $key [, array|null $options [, mixed $default [, boolean $skipEmpty]]] )
  • $key: ключ настройки или опции для загрузки.
  • $options: источник настройки или опции. Либо null (который пытается найти ключ в основной конфигурации), либо массив параметров.
  • $default: значение, возвращаемое, когда ключ не найден.
  • $skipEmpty: если установлено значение true, $default также будет возвращено, если значение $key / $key's является пустой строкой. Добавлено в xPDO 2.2.1 / MODX 2.2.0-rc2.

Примеры

Simple Option Retrieval

Получает параметр конфигурации для xPDO::OPT_HYDRATE_FIELDS.

$hydrateFields = $xpdo->getOption(xPDO::OPT_HYDRATE_FIELDS);

Получает параметр конфигурации для 'test' и, если не установлен, возвращает «123».

$test = $xpdo->getOption('test',null,'123');

Проверяет массив $props на наличие ключа 'depth', и, если он не существует, то проверяет $xpdo->config и, если он все еще не существует, устанавливает 10.

$props = array();
$depth = $xpdo->getOption('depth',$props,10);
echo $depth; // prints 10

$xpdo->setOption('depth',20);
$depth = $xpdo->getOption('depth',$props,10);
echo $depth; // prints 20

$props['depth'] = 30;
$depth = $xpdo->getOption('depth',$props,10);
echo $depth; // prints 30

Support the team building MODX with a monthly donation.

The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.

Backers

  • modmore
  • modmore
  • Jens Wittmann – Gestaltung & Entwicklung
  • Raffy
  • eydolan
  • Digital Penguin
  • Fabian Christen
  • Dannevang Digital
  • deJaya
  • Sepia River Studios
  • Following Sea
  • Anton Tarasov
  • Lefthandmedia
  • Nick Clark
  • Chris Fickling
  • Murray Wood
  • YJ
  • CrewMark
  • Richard

Budget

$305 per month—let's make that $500!

Learn more