Public Member Functions | |
__construct () | |
getCmsObjectCanBeExternal ($path, $attributes=array()) | |
getLastModificationTime ($path) | |
getContentAttributes ($path, $attributes) | |
getCmsObject ($path, $attributes=array()) | |
getBinaryContent ($path) | |
addAdditionalParameters ($params, $type) | |
clearCache ($contentid, $url="") | |
request ($params, $attributes=array(), $timeout="") | |
requestNavigation ($params, $attributes=array(), $timeout="") | |
requestActivePath ($params, $attributes=array(), $timeout="") | |
requestAutosuggest ($params, $attributes=array(), $timeout="") | |
requestSearch ($params, $attributes=array(), $timeout="") |
Protected Member Functions | |
getContentRepositorySearchUrl () | |
getBinaryContentUrl () | |
getNavigationUrl () | |
getActivePathUrl () | |
getAutosuggestUrl () | |
getSearchUrl () | |
getUrl () | |
getAdditionalAttributesByRequestType ($type) | |
getAdditionalAttributesByUrl ($url) |
Gentics Portal.Node PHP Author & Copyright (c) by Gentics Software GmbH sales @gen tics. comhttp://www.gentics.com Licenses can be found in the LICENSE.txt file in the root-folder of this installation You must not use this software without a valid license agreement.
Class for working with Gentics Content Connector
Definition at line 12 of file RepositoryApi.php.
RepositoryApi::__construct | ( | ) |
Set base options
Definition at line 146 of file RepositoryApi.php.
RepositoryApi::addAdditionalParameters | ( | $params, | |
$type | |||
) |
Adds parameters to certain requests
array | $params | array of preset parameters |
string | $type | type of request from |
Definition at line 276 of file RepositoryApi.php.
Referenced by getBinaryContent(), and getCmsObject().
RepositoryApi::clearCache | ( | $contentid, | |
$url = "" |
|||
) |
clears the CCR cache
string | $url | url of CCR, if not set use configured url |
string | $contentid | content-ID of page |
Definition at line 294 of file RepositoryApi.php.
|
protected |
Get api url which used to retrieve active path data
Definition at line 118 of file RepositoryApi.php.
Referenced by requestActivePath().
|
protected |
Gets additional attribute by request type
string | $type | request type (navigation/content/search) |
Definition at line 313 of file RepositoryApi.php.
Referenced by getAdditionalAttributesByUrl().
|
protected |
Gets additional attribute by url
string | $url | url |
Definition at line 333 of file RepositoryApi.php.
References getAdditionalAttributesByRequestType().
|
protected |
Get api url which used to retrieve autosuggest data
Definition at line 128 of file RepositoryApi.php.
Referenced by requestAutosuggest().
RepositoryApi::getBinaryContent | ( | $path | ) |
Download binary content
string | $path | content path |
Definition at line 257 of file RepositoryApi.php.
References addAdditionalParameters(), and getBinaryContentUrl().
Referenced by getCmsObject().
|
protected |
Get api url which used to retrieve static objects(images, js, css, etc.)
Definition at line 98 of file RepositoryApi.php.
Referenced by getBinaryContent().
RepositoryApi::getCmsObject | ( | $path, | |
$attributes = array() |
|||
) |
Get CMS content object If object is binary, make additional request to get binarycontent and put it to 'content' field
string | $path | content path |
array | $attributes | requested content attributes |
Definition at line 230 of file RepositoryApi.php.
References addAdditionalParameters(), getBinaryContent(), and getContentRepositorySearchUrl().
Referenced by getCmsObjectCanBeExternal(), and getContentAttributes().
RepositoryApi::getCmsObjectCanBeExternal | ( | $path, | |
$attributes = array() |
|||
) |
Do almost the same as getCmsObject. But in case relative path $path not found in the CMS it adds host address in front of $path and try second time
$path | ||
array | $attributes |
Definition at line 172 of file RepositoryApi.php.
References getCmsObject().
RepositoryApi::getContentAttributes | ( | $path, | |
$attributes | |||
) |
This method is used for retrieving only content attributes from Gentics Content Connector
string | $path | content path |
array | $attributes | array of personalization attributes |
Definition at line 213 of file RepositoryApi.php.
References getCmsObject().
Referenced by getLastModificationTime().
|
protected |
Get api url which used to retrieve CMS objects
Definition at line 88 of file RepositoryApi.php.
Referenced by getCmsObject(), and request().
RepositoryApi::getLastModificationTime | ( | $path | ) |
Get CMS content last modification time
string | $path | path of node |
Definition at line 190 of file RepositoryApi.php.
References getContentAttributes().
|
protected |
Get api url which used to retrieve navigation data
Definition at line 108 of file RepositoryApi.php.
Referenced by requestNavigation().
|
protected |
Get api url which used to retrieve search data
Definition at line 138 of file RepositoryApi.php.
Referenced by requestSearch().
RepositoryApi::request | ( | $params, | |
$attributes = array() , |
|||
$timeout = "" |
|||
) |
Requesting for content object
array | $params | url params |
array | $attributes | requested attributes |
string | $timeout | specific request timeout in seconds (if not set standard timeout 60 seconds is used) |
Definition at line 429 of file RepositoryApi.php.
References getContentRepositorySearchUrl().
RepositoryApi::requestActivePath | ( | $params, | |
$attributes = array() , |
|||
$timeout = "" |
|||
) |
Requesting for active path object
array | $params | url params |
array | $attributes | requested attributes |
string | $timeout | specific request timeout in seconds (if not set standard timeout 60 seconds is used) |
Definition at line 457 of file RepositoryApi.php.
References getActivePathUrl().
RepositoryApi::requestAutosuggest | ( | $params, | |
$attributes = array() , |
|||
$timeout = "" |
|||
) |
Requesting for autosuggest data
array | $params | url params |
array | $attributes | requested attributes |
string | $timeout | specific request timeout in seconds (if not set standard timeout 60 seconds is used) |
Definition at line 471 of file RepositoryApi.php.
References getAutosuggestUrl().
RepositoryApi::requestNavigation | ( | $params, | |
$attributes = array() , |
|||
$timeout = "" |
|||
) |
Requesting for navigation object
array | $params | url params |
array | $attributes | requested attributes |
string | $timeout | specific request timeout in seconds (if not set standard timeout 60 seconds is used) |
Definition at line 443 of file RepositoryApi.php.
References getNavigationUrl().
RepositoryApi::requestSearch | ( | $params, | |
$attributes = array() , |
|||
$timeout = "" |
|||
) |
Requesting for search data
array | $params | url params |
array | $attributes | requested attributes |
string | $timeout | specific request timeout in seconds (if not set standard timeout 60 seconds is used) |
Definition at line 485 of file RepositoryApi.php.
References getSearchUrl().