Function cmsPageList
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(
[ 'filters' ] = array() ; // optional array including filters values:
// Possible filters:
// - status => array() ( multiselect )
// - group1 => array() ( multiselect )
// - group2 => array() ( multiselect )
// - languageCode => array() ( multiselect )
// - text => string ( search like %string% ) searching in fields
// name, title, linkShort
// +++ general for all lists:
// - 'sysInsertIdPerson' => 0
// - 'sysInsertDateFrom' => 'YYYY-MM-DD'
// - 'sysInsertDateTo' => 'YYYY-MM-DD'
// - 'sysModifyIdPerson' => 0
// - 'sysModifyDateFrom' => 'YYYY-MM-DD'
// - 'sysModifyDateTo' => 'YYYY-MM-DD'
// - 'sysIdCompany' => 0
// - 'sysSource' => ''
// - 'sysIdSource' => ''
[ 'resultsPageNumber' ] = 0 ; // first page index is = 1 ( in API 0 is converted to 1 )
[ 'resultsPerPage' ] = 0 ; // if is empty API get default value from config
[ 'resultsSortBy' ] = '' ; // sort by. Possible values
//
// - 'group1' => 'GRUPA_1, KOLEJNOSC'
// - 'group2' => 'GRUPA_2, KOLEJNOSC'
// - 'status' => 'STATUS, KOLEJNOSC'
// - 'group2' => 'STATUS, KOLEJNOSC'
// - 'name' => 'NAZWA_MENU, KOLEJNOSC'
// - 'title' => 'TYTUL, KOLEJNOSC'
// - 'linkShort' => 'PRZYJAZNY_LINK, KOLEJNOSC'
// - 'languageCode' => 'KOD_JEZYKA, KOLEJNOSC'
// +++ general for all lists:
// - 'sysInsertIdPerson'
// - 'sysInsertDate'
// - 'sysInsertTime'
// - 'sysModifyIdPerson'
// - 'sysModifyDate'
// - 'sysModifyTime'
// - 'sysIdCompany'
// - 'sysSource'
// - 'sysIdSource'
// - 'sysChange'
[ 'resultsSortOrder' ] = '' ; // sort order 'asc' | 'desc'
[ '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
)
Returns
Status information and list of records.
Array (
[ 'status' ] = 'OK',
[ 'items' ] = Array(
// list of pages,
)
[count] => 3
[totalCount] => 20
[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 [ 'filters' ][ 'group1' ] = array ( 'OX menu dolne', 'OX menu górne' ) ;
$myParams [ 'filters' ][ 'status' ] = array ( 'visible' ) ;
$myParams [ 'filters' ][ 'sysInsertDateTo' ] = '2019-12-31' ;
$myParams [ 'resultsSortBy' ] = 'sysInsertDate' ;
$myParams [ 'resultsSortOrder' ] = 'asc' ;
$myParams [ 'resultsPageNumber' ] = 1 ;
$myParams [ 'resultsPerPage' ] = 3 ;
$myParams [ 'getDictionary' ] = true ;
$myParams [ 'getTranslations' ] = true ;
$ret = $udds->cmsPageList ( $myParams ) ;
Returns $ret =
Array
(
[status] => OK
[items] => Array
(
[0] => Array
(
[id] => 0000000968DPY60I72X11336602EQJFP
[languageCode] => default
[name] => Regulamin serwisu
[title] => Regulamin serwisu
[group1] => OX Menu dolne
[group2] => Menu dolne
[type] => subpage
[status] => visible
[order] => 999900
[linkTarget] => currentWindow
[linkStyle] =>
[linkParameters] =>
[linkShort] => Regulamin-serwisu-
[alternativeTemplate] =>
[sysInsertIdPerson] => 1
[sysInsertDate] => 2015-08-27
[sysInsertTime] => 09:35:48
[sysModifyIdPerson] => 21
[sysModifyDate] => 2019-11-06
[sysModifyTime] => 13:54:32
[sysIdCompany] =>
[sysSource] =>
[sysIdSource] =>
[sysChange] => 2019-11-06 13:54:32
)
[1] => Array
(
[id] => 00000010J1OJ4M7208AKOD761RV46426
[languageCode] => default
[name] => Kontakt
[title] => Kontakt
[group1] => OX Menu dolne
[group2] => Menu dolne
[type] => link
[status] => visible
[order] => 20000
[linkTarget] => currentWindow
[linkStyle] =>
[linkParameters] =>
[linkShort] =>
[alternativeTemplate] =>
[sysInsertIdPerson] => 1
[sysInsertDate] => 2015-08-27
[sysInsertTime] => 09:43:52
[sysModifyIdPerson] => 21
[sysModifyDate] => 2019-11-28
[sysModifyTime] => 15:47:41
[sysIdCompany] =>
[sysSource] =>
[sysIdSource] =>
[sysChange] => 2019-11-28 15:47:40
)
[2] => Array
(
[id] => 00000011F1W1XI8IM0H5172NXK6DV5WY
[languageCode] => default
[name] => Jak rezerwować
[title] => Jak rezerwować
[group1] => OX Menu dolne
[group2] => Menu dolne
[type] => subpage
[status] => visible
[order] => 30000
[linkTarget] => currentWindow
[linkStyle] =>
[linkParameters] =>
[linkShort] => Jak-rezerwowac
[alternativeTemplate] =>
[sysInsertIdPerson] => 1
[sysInsertDate] => 2015-08-27
[sysInsertTime] => 09:44:37
[sysModifyIdPerson] => 1
[sysModifyDate] => 2019-12-03
[sysModifyTime] => 23:44:45
[sysIdCompany] =>
[sysSource] =>
[sysIdSource] =>
[sysChange] => 2019-12-03 23:44:44
)
)
[count] => 3
[totalCount] => 20
[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
)
)
)
)