Поддержать Проект

Обратная связь

[MODX] Guru
  • Информация
  • Разработчикам
    • Теги
    • API
    • DBAPI
    • System Variables
    • MMrules
  • Дополнения
  • Виджеты
  • Уроки
  • Разработчики
  • Готовые примеры
  • Блог
  • Конфиги
  • HTML коды
© [MODX] Guru
  • API

getDocumentChildrenTVars API MODX Evo ✈ Evolution CMS

  • Разработчикам
  • API
  • getDocumentChildrenTVars
Menu
  • addEventListener
  • changeWebUserPassword
  • clearCache
  • getActiveChildren
  • getAllChildren
  • getCachePath
  • getChildIds
  • getChunk
  • getConfig
  • getDocument
  • getDocumentChildren
  • getDocumentChildrenTVarOutput
  • getDocumentChildrenTVars
  • getDocumentObject
  • getDocuments
  • getFullTableName
  • getKeywords
  • getLoginUserID
  • getLoginUserName
  • getLoginUserType
  • getManagerPath
  • getMETATags
  • getPageInfo
  • getParent
  • getParentIds
  • getPlaceholder
  • getSnippetId
  • getSnippetName
  • getTemplateVar
  • getTemplateVarOutput
  • getTemplateVars
  • getUserData
  • getUserDocGroups
  • getUserInfo
  • getVersionData
  • getWebUserInfo
  • hasPermission
  • insideManager
  • invokeEvent
  • isBackend
  • isFrontend
  • isMemberOfWebGroup
  • logEvent
  • makeList
  • makeUrl
  • mapPath
  • parseChunk
  • parseText
  • parseProperties
  • putChunk
  • regClientCSS
  • regClientHTMLBlock
  • regClientScript
  • regClientStartupHTMLBlock
  • regClientStartupScript
  • removeAllEventListener
  • removeEventListener
  • runSnippet
  • sendAlert
  • setPlaceholder
  • stripTags
  • toPlaceholder
  • toPlaceholders
  • userLoggedIn
  • webAlert
  • sendmail
2172

getDocumentChildrenTVars API MODX Evo ✈ Evolution CMS

Получение списка дочерних документов, для указанного документа со значениями основных и дополнительных параметров, которые указаны

Замечание: если не задан список требуемых параметров, то метод вернет пустой массив.

string getDocumentChildrenTVars(int $parentid, array $tvidnames[, int $published[, string $docsort[, string $docsortdir[,string $tvfields[, string $tvsort[, string $tvsortdir]]]]]]);

$parentid - идентификатор родительского документа

$tvidnames - массив с требуемыми TV-параметрами

$published - опубликованы ли документы
0 - документы не опубликованы
1 - документы опубликованы
По умолчанию: 1

$docsort - поле по которому сортируются документы
По умолчанию: menuindex

$docsortdir - правило сортировки документов
ASC - в порядке возрастания
DESC - в порядке убывания
по умолчанию: ASC

$tvfields - список параметров, которые нужно возвращаться для дополнительных TV- параметров.
Список параметров через запятую
* - возвращаться все параметры
По умолчанию: *

$tvsort - поле по которому сортируются дополнительные параметры
По умолчанию: rank

$tvsortdir - правило сортировки дополнительных TV-параметров
ASC - в порядке возрастания
DESC - в порядке убывания
по умолчанию: ASC


Формат данных результата:

Array ( 
	[0] => Array ( 
		[0] => Array ( 
			[id] => 4 
			[type] => text 
			[name] => МойПараметр 
			[caption] => Заголовок 
			[description] => Описание 
			[editor_type] => 0 
			[category] => 0 
			[locked] => 0 
			[elements] => Текст 
			[rank] => 0 
			[display] => 
			[display_params] => 
			[default_text] => 
			[value] => Это мой текст 
		) 
		[1] => Array ( 
			[name] => id 
			[value] => 16 
		) 
		[2] => Array ( 
			[name] => type 
			[value] => document 
		) 
	) ... 
)

Пример

/**Структура документов:
-Статьи (1)
--Недвижимость (11)
---Эконом(111)
---Элитная(112)
--Авто (12)
**/
$txt = $modx->getDocumentChildrenTVars(11,array('id','type','МойПараметр'));
//вернет информацию по основным параметрам id, type и дополнительному параметру 
//МойПараметр для документов 111 и 112.