Function cmsPageFilters
Arguments
$languageCode = string // response will be prepare in this language ( eg. 'pl', 'en', 'de' ... )
// empty value means default language defined in API config
$parameters = array(
[ 'requestedFilters' ] = array(); // lista nazw filtrów, dla których wartości mają być zwrócone.
// listę dostępnych filtrów można znaleźć w odpowiedzi
// w sekcji ['filtersEnabled'] ( zobacz przykładową odpowiedź poniżej )
[ 'filters' ] = array() ; // opcjonalne. Takie jak w funkcji cmsPageList()
// uzupełnienie powoduje zwrócenie filtrów zawęzonych
// dla określonego filtramio podzbioru podstron ( zwężanie filtrowania )
[ 'getDictionary' ] = bool ; // żądanie zwrócenia słowników dla encji Page ( true | false ) domyślnie false
[ 'getTranslations' ] = bool ; // żądanie zwrócenia translacji dla encji Page ( true | false ) domyślnie false
[ 'getDescription' ] = bool ; // żądanie zwrócenia opisu encji Page ( true | false ) domyślnie false
)
Returns
Status information and list of records.
Array (
[ 'status' ] = 'OK',
[ 'filtersPossibleValues' ] = Array(
// listy wartości fitrów
)
[ 'filtersEnabled' ] = Array(
// lista wszystkich dostępnych filtrów.
// Jeśli wartością przy filtrze to array() to znaczy że to filtr wielokrotnego wyboru (multiselect).
// Jeśli wartością przy filtrze jest null | '' to znaczy że to filtr pojedynczego wyboru.
)
[dictionary] => Array (
// optionally dictionary
)
[selectedLanguageCode] => [languageCode]
[translations] => Array(
//optionally translations
)
)
Example
require_once ( 'classUddsOx.php' ) ;
$udds = new classUddsOx ;
$udds->customerCode = $srvCustomerCode ;
$udds->login = $srvlogin ;
$udds->password = $srvPassword ;
$udds->serverUrl = $srvUrl ;
$udds->languageCode = 'pl' ;
$myParams = array() ;
$myParams [ 'requestedFilters' ] = array ( 'group1', 'group2', 'status', 'sortBy', 'sortOrder' ) ;
$myParams [ 'filters' ][ 'type' ] = array ( 'subpage' ) ; // opcjonalne tylko gdy chemy zawężać
$myParams [ 'getDictionary' ] = true ; // opcjonane
$myParams [ 'getTranslations' ] = true ; // opcjonane
$ret = $udds->cmsPageFilters ( $myParams ) ;
Returns $ret =
Array
(
[status] => OK
[filtersPossibleValues] => Array
(
[group1] => Array
(
[0] => OX Menu dolne
[1] => OX Menu górne
[2] => OX Menu w nagłówku
[3] => przyklady
[4] => testGroup1
)
[group2] => Array
(
[0] => DLA DZIECI I MŁODZIEŻY
[1] => DLA GRUP
[2] => KOLONIE / OBOZY
[3] => Menu dolne
[4] => Menu górne
[5] => Menu w nagłówku
[6] => przyklady
[7] => testGroup2
[8] => WYCIECZKI
)
[status] => Array
(
[0] => hidden
[1] => visible
)
[sortBy] => Array
(
[0] => group1
[1] => group2
[2] => status
[3] => name
[4] => title
[5] => languageCode
[6] => default
[7] => sysInsertIdPerson
[8] => sysInsertDate
[9] => sysInsertTime
[10] => sysModifyIdPerson
[11] => sysModifyDate
[12] => sysModifyTime
[13] => sysIdCompany
[14] => sysSource
[15] => sysIdSource
[16] => sysChange
)
[sortOrder] => Array
(
[0] => default
[1] => asc
[2] => desc
)
)
[filtersEnabled] => Array
(
[group1] => Array
(
)
[group2] => Array
(
)
[status] => Array
(
)
[name] =>
[title] =>
[text] =>
[sysInsertIdPerson] => Array
(
)
[sysInsertDateFrom] =>
[sysInsertDateTo] =>
[sysModifyIdPerson] => Array
(
)
[sysModifyDateFrom] =>
[sysModifyDateTo] =>
[sysIdCompany] => Array
(
)
[sysSource] => Array
(
)
[sysIdSource] => Array
(
)
)
[dictionary] => Array
(
[status] => Array
(
[0] => visible
[1] => hidden
)
[type] => Array
(
[0] => link
[1] => subpage
[2] => php
)
[linkTarget] => Array
(
[0] => currentWindow
[1] => newWindow
)
)
[selectedLanguageCode] => pl
[translations] => Array
(
[general] => Array
(
[txtYes] => Tak
[txtNo] => Nie
[txtCancel] => txtCancel
)
[list] => Array
(
[entityName] => Lista podstron
[fieldNames] => Array
(
[sysInsertIdPerson] => sysInsertIdPerson
[sysInsertDate] => sysInsertDate
[sysInsertTime] => sysInsertTime
[sysModifyIdPerson] => sysModifyIdPerson
[sysModifyDate] => sysModifyDate
[sysModifyTime] => sysModifyTime
[sysIdCompany] => sysIdCompany
[sysSource] => sysSource
[sysIdSource] => sysIdSource
[sysChange] => sysChange
[id] => id
[languageCode] => languageCode
[name] => name
[title] => title
[content] => content
[group1] => group1
[group2] => group2
[type] => type
[status] => status
[order] => order
[linkTarget] => linkTarget
[linkStyle] => linkStyle
[linkParameters] => linkParameters
[linkShort] => linkShort
[metaTitle] => metaTitle
[metaDescription] => metaDescription
[metaKeywords] => metaKeywords
[extraText1] => extraText1
[extraText2] => extraText2
[alternativeTemplate] => alternativeTemplate
)
[buttons] => Array
(
[btnInsert] => btnInsert
[btnGet] => btnGet
[btnDelete] => btnDelete
[btnUpdate] => btnUpdate
[btnRefresh] => btnRefresh
[btnClose] => btnClose
[btnSelect] => btnSelect
)
[messages] => Array
(
[askDeleteItem] => Czy chcesz usunąć podstronę [:details:] ?
)
)
[details] => Array
(
[entityName] => Lista podstron
[fieldNames] => Array
(
[sysInsertIdPerson] => sysInsertIdPerson
[sysInsertDate] => sysInsertDate
[sysInsertTime] => sysInsertTime
[sysModifyIdPerson] => sysModifyIdPerson
[sysModifyDate] => sysModifyDate
[sysModifyTime] => sysModifyTime
[sysIdCompany] => sysIdCompany
[sysSource] => sysSource
[sysIdSource] => sysIdSource
[sysChange] => sysChange
[id] => id
[languageCode] => languageCode
[name] => name
[title] => title
[content] => content
[group1] => group1
[group2] => group2
[type] => type
[status] => status
[order] => order
[linkTarget] => linkTarget
[linkStyle] => linkStyle
[linkParameters] => linkParameters
[linkShort] => linkShort
[metaTitle] => metaTitle
[metaDescription] => metaDescription
[metaKeywords] => metaKeywords
[extraText1] => extraText1
[extraText2] => extraText2
[alternativeTemplate] => alternativeTemplate
)
[buttons] => Array
(
[btnSave] => btnSave
[btnCancel] => btnCancel
[btnClose] => btnClose
)
[messages] => Array
(
)
)
[fieldValues] => Array
(
[status] => Array
(
[visible] => visible
[hidden] => hidden
)
[linkTarget] => Array
(
[currentWindow] => Bieżące okno
[newWindow] => Nowe okno
)
[type] => Array
(
[link] => Link/url
[subpage] => Podstrona
[php] => Kod PHP
)
)
)
[description] => Array
(
[fieldTypes] => Array
(
[sysInsertIdPerson] => Array
(
[type] => integer
[decimalPlaces] => 0
[divider] => 1
)
[sysInsertDate] => Array
(
[type] => date
[format] => yyyy-mm-dd
)
[sysInsertTime] => Array
(
[type] => time
[format] => hh-mm-ss
)
[sysModifyIdPerson] => Array
(
[type] => integer
[decimalPlaces] => 0
[divider] => 1
)
[sysModifyDate] => Array
(
[type] => date
[format] => YYYY-mm-dd
)
[sysModifyTime] => Array
(
[type] => time
[format] => hh-mm-ss
)
[sysIdCompany] => Array
(
[type] => integer
[decimalPlaces] => 0
[divider] => 1
)
[sysSource] => Array
(
[type] => string
[maxLength] => 32
)
[sysIdSource] => Array
(
[type] => string
[maxLength] => 32
)
[sysChange] => Array
(
[type] => timestamp
)
[id] => Array
(
[type] => string
[maxLength] => 32
)
[languageCode] => Array
(
[type] => string
[maxLength] => 6
)
[name] => Array
(
[type] => string
[maxLength] => 255
)
[title] => Array
(
[type] => string
[maxLength] => 255
)
[content] => Array
(
[type] => string
[maxLength] => 65535
)
[group1] => Array
(
[type] => string
[maxLength] => 128
)
[group2] => Array
(
[type] => string
[maxLength] => 128
)
[type] => Array
(
[type] => string
[maxLength] => 16
)
[status] => Array
(
[type] => string
[maxLength] => 16
)
[order] => Array
(
[type] => integer
[decimalPlaces] => 0
[divider] => 1
)
[linkTarget] => Array
(
[type] => string
[maxLength] => 32
)
[linkStyle] => Array
(
[type] => string
[maxLength] => 1024
)
[linkParameters] => Array
(
[type] => string
[maxLength] => 128
)
[linkShort] => Array
(
[type] => string
[maxLength] => 128
)
[metaTitle] => Array
(
[type] => string
[maxLength] => 512
)
[metaDescription] => Array
(
[type] => string
[maxLength] => 1024
)
[metaKeywords] => Array
(
[type] => string
[maxLength] => 1024
)
[extraText1] => Array
(
[type] => string
[maxLength] => 1024
)
[extraText2] => Array
(
[type] => string
[maxLength] => 1024
)
[alternativeTemplate] => Array
(
[type] => string
[maxLength] => 32
)
)
)
)