public interface SiteItemService
SiteItem
s of the current site.Modifier and Type | Method and Description |
---|---|
org.craftercms.core.service.Content |
getRawContent(String url)
Returns the raw content of a site item.
|
SiteItem |
getSiteItem(String url)
Returns the site item for the given URL
|
SiteItem |
getSiteItem(String url,
org.craftercms.core.processors.ItemProcessor processor)
Returns the site item for the given URL
|
SiteItem |
getSiteItem(String url,
org.craftercms.core.processors.ItemProcessor processor,
org.apache.commons.collections4.Predicate<org.craftercms.core.service.Item> predicate)
Returns the site item for the given URL
|
SiteItem |
getSiteTree(String url,
int depth)
Returns the site tree for the given URL.
|
SiteItem |
getSiteTree(String url,
int depth,
org.craftercms.core.service.ItemFilter filter,
org.craftercms.core.processors.ItemProcessor processor)
Returns the site tree for the given URL.
|
SiteItem |
getSiteTree(String url,
int depth,
String includeByNameRegex,
String excludeByNameRegex)
Deprecated.
|
SiteItem |
getSiteTree(String url,
int depth,
String includeByNameRegex,
String excludeByNameRegex,
Map<String,String> nodeXPathAndExpectedValuePairs)
Deprecated.
|
SiteItem |
getSiteTree(String url,
int depth,
String includeByNameRegex,
String excludeByNameRegex,
String[]... nodeXPathAndExpectedValuePairs)
Deprecated.
|
org.craftercms.core.service.Content getRawContent(String url)
url
- the URL of the itemSiteItem getSiteItem(String url)
url
- the URL of the itemSiteItem getSiteItem(String url, org.craftercms.core.processors.ItemProcessor processor)
url
- the URL of the itemprocessor
- a processor for the itemSiteItem getSiteItem(String url, org.craftercms.core.processors.ItemProcessor processor, org.apache.commons.collections4.Predicate<org.craftercms.core.service.Item> predicate)
url
- the URL of the itemprocessor
- a processor for the itempredicate
- a predicate used to check if the item should be returned or notSiteItem getSiteTree(String url, int depth)
url
- the URL of the folderdepth
- the depth of the returned treeSiteItem getSiteTree(String url, int depth, org.craftercms.core.service.ItemFilter filter, org.craftercms.core.processors.ItemProcessor processor)
url
- the URL of the folderdepth
- the depth of the returned treefilter
- a filter for the tree itemsprocessor
- a processor for the tree items@Deprecated SiteItem getSiteTree(String url, int depth, String includeByNameRegex, String excludeByNameRegex)
url
- the URL of the folderdepth
- the depth of the returned treeincludeByNameRegex
- a name regex for items to includeexcludeByNameRegex
- a name regex for items to exclude@Deprecated SiteItem getSiteTree(String url, int depth, String includeByNameRegex, String excludeByNameRegex, String[]... nodeXPathAndExpectedValuePairs)
url
- the URL of the folderdepth
- the depth of the returned treeincludeByNameRegex
- a name regex for items to includeexcludeByNameRegex
- a name regex for items to excludenodeXPathAndExpectedValuePairs
- an X * 2 matrix where the first column is a node XPath and the
second column is a expected value for that node. This XPath/value
pairs are used to filter out items.@Deprecated SiteItem getSiteTree(String url, int depth, String includeByNameRegex, String excludeByNameRegex, Map<String,String> nodeXPathAndExpectedValuePairs)
url
- the URL of the folderdepth
- the depth of the returned treeincludeByNameRegex
- a name regex for items to includeexcludeByNameRegex
- a name regex for items to excludenodeXPathAndExpectedValuePairs
- a map where each key is a node XPath and each value is a expected value
for that node. This XPath/value pairs are used to filter out items.Copyright © 2018 CrafterCMS. All rights reserved.