Skip to the content
Documentation
Version 6.x Supported

Template fetch functions

Written by Balazs Halasy, Updated by Graham Brookins
No ratings yet

Exponential 6 in this section

The fetch functions of Exponential 6.0.15, grouped by module. The new ones (49) belong to the new modules and to modules 4.x already had; each is described on its page below the module.

class

Name Summary
attribute_list Fetches the attributes of a class.
latest_list Fetches the most recently modified classes.
list Fetches a collection of classes.
override_template_list Fetches the override rules associated with a class.

collaboration

Name Summary
group_tree Not documented yet.
message_list Not documented yet.
participant Not documented yet.
participant_list Not documented yet.
participant_map Not documented yet.
tree_count Not documented yet.

content

Name Summary
access Checks if the current user has access to a given function.
bookmarks Fetches the bookmarks of the current user.
calendar This function fetches the date time list when objects were published.
can_instantiate_classes Checks if the current user is allowed to create nodes.
can_instantiate_class_list Fetches the classes that the current user can create objects of.
class Fetches a content class.
class_attribute Fetches an attribute of a content class.
class_attribute_list Fetches the attributes of a class.
collected_info_collection Fetches an information collection.
collected_info_count Fetches the number of collections that match a certain criteria.
collected_info_count_list Fetches the number of times different values were collected.
contentobject_attributes Fetches the attributes of an object's version (and translation).
country_list Fetches the list of countries specified in the "country.ini" configuration file.
draft_count Fetches the number of drafts that belong to the current user.
draft_version_list Fetches the drafts that belong to the current user.
keyword Fetches nodes that use keywords starting with a given sequence.
keyword_count Fetches the number of nodes that use certain keywords. Only nodes that are main locations for content objects are counted.
list Fetches the children of a node or a collection of nodes.
list_count Fetches the number of children of a node.
locale Fetches the current or a specified locale.
locale_list Fetches the available locales.
navigation_part Fetches information about a navigation part.
navigation_parts Fetches all available navigation parts.
node Fetches a node (identified by either an ID number or a path).
non_translation_list Fetches locales that a version of an object may be translated into.
object Fetches a content object (specified by an ID number).
object_by_attribute DEPRECATED
object_count_by_user_id Fetches the number of objects (of a class) created by a user.
pending_count Fetches the number of pending objects for the current user.
pending_list Fetches the pending objects for the current user.
recent Fetches nodes where the current user recently published something.
related_objects Fetches related objects.
related_objects_count Fetches the number of related objects.
reverse_related_objects Fetches reverse related objects.
reverse_related_objects_count Fetches the number of reverse related objects.
same_classattribute_node Fetches nodes containing attributes that match a certain value.
search Fetches nodes containing data that match a certain criteria.
section_list Fetches the available sections.
tipafriend_top_list Fetches the most popular (most tipped) nodes.
translation_list Fetches the locales that can be used to translate objects.
trash_count Fetches the number of objects that are in the trash.
trash_object_list Fetches the objects that are in the trash.
tree Fetches the children of a node recursively.
tree_count Fetches the number of children of a node recursively.
version Fetches a specific version of an object.
version_count Fetches the number of versions of a content object.
version_list Fetches all the versions of a content object.
view_top_list Fetches the most popular (most viewed) nodes.

layout

Name Summary
sitedesign_list DEPRECATED (Fetches the names of the currently used designs.)

notification

Name Summary
digest_handlers Fetches the notification handlers for the notification items that should be sent as digest to the current user.
digest_items Fetches notification items that should be sent as digest to the current user.
event_content Fetches the contents of the notification event.
handler_list Fetches the available notification handlers.
subscribed_nodes Fetches nodes that the current user has subscribed to.
subscribed_nodes_count Fetches the number of nodes that the current user has subscribed to.

package

Name Summary
can_create Not documented yet.
can_edit Not documented yet.
can_export Not documented yet.
can_import Not documented yet.
can_install Not documented yet.
can_list Not documented yet.
can_read Not documented yet.
can_remove Not documented yet.
dependent_list Not documented yet.
item Not documented yet.
list Not documented yet.
maintainer_role_list Not documented yet.
repository_list Not documented yet.

search

Name Summary
list Fetches the phrases that have been searched ordered by their usage frequency.
list_count Fetches the number of unique phrases that have been searched.

section

Name Summary
object Fetches a section.
object_list Fetches objects that belong to certain section.
object_list_count Fetches the number of objects that belong to certain section.
roles Fetches roles that have at least one policy limited to a certain section.
user_roles Fetches users and/or user groups with role limitations related to a certain section.

shop

Name Summary
basket Fetches the current user's shopping basket.
best_sell_list Fetches the most popular / most sold products.
currency Fetches a currency object.
currency_list Fetches the available currencies.
preferred_currency_code Fetches the current user's preferred currency.
product_category Fetches a product category.
product_category_list Fetches the available product categories.
related_purchase Fetches products that were purchased together with a given product.
wish_list Fetches the products of a given wishlist.
wish_list_count Fetches a wishlist and returns the number of items in it.

url

Name Summary
list Fetches the URLs that are stored in the URL table.
list_count Fetches the number of URLs that are stored in the URL table.

user

Name Summary
anonymous_count Fetches the number of anonymous users.
current_user Fetches the user that is currently logged in.
has_access_to Checks if a user has access to a certain function of a module.
is_logged_in Checks if a specific user is logged in.
logged_in_count Fetches the number of users that are logged in.
logged_in_list Fetches the names of the users that are logged in.
logged_in_users Fetches the users that are logged in.
member_of Fetches the roles that are assigned to a user.
user_role Fetches the policies that are available for a user.

New in Exponential 6

The fetch functions that arrived in the 6.x releases, by module.

By release: 6.0.15 (in development): 49.

New in Exponential 6

Module Name Description Since
apikey can_create Calls expApiKeyFunctionCollection::fetchCanCreate() (kernel/apikey/function_definition.php). 6.0.15 (in development)
apikey counts Calls expApiKeyFunctionCollection::fetchCounts() (kernel/apikey/function_definition.php). 6.0.15 (in development)
audit can_read Calls expAuditFunctionCollection::fetchCanRead() (kernel/audit/function_definition.php). 6.0.15 (in development)
audit chain_status Calls expAuditFunctionCollection::fetchChainStatus() (kernel/audit/function_definition.php). 6.0.15 (in development)
audit count Calls expAuditFunctionCollection::fetchCount() (kernel/audit/function_definition.php). 6.0.15 (in development)
audit event Calls expAuditFunctionCollection::fetchEvent() (kernel/audit/function_definition.php). 6.0.15 (in development)
audit events Calls expAuditFunctionCollection::fetchEvents() (kernel/audit/function_definition.php). 6.0.15 (in development)
audit hidden_menu_links The keys of the left menu's links that lead to a channel the user may not read (design:audit/menu.tpl) 6.0.15 (in development)
collaboration inbox Calls eZCollaborationFunctionCollection::fetchInbox() (kernel/collaboration/function_definition.php). 6.0.15 (in development)
collaboration inbox_row Calls eZCollaborationFunctionCollection::fetchInboxRow() (kernel/collaboration/function_definition.php). 6.0.15 (in development)
content assigned_node_count Calls eZContentFunctionCollection::fetchAssignedNodeCount() (kernel/content/function_definition.php). 6.0.15 (in development)
content assigned_nodes The locations of one object, a page at a time. 6.0.15 (in development)
content bookmark_folders Calls eZContentFunctionCollection::fetchBookmarkFolders() (kernel/content/function_definition.php). 6.0.15 (in development)
content bookmark_rows Calls eZContentFunctionCollection::fetchBookmarkRows() (kernel/content/function_definition.php). 6.0.15 (in development)
content class_list Calls eZContentFunctionCollection::fetchClassList() (kernel/content/function_definition.php). 6.0.15 (in development)
content country_groups The country list in groups: the ranked groups of countrygroups.ini, then "All countries" A-Z (expCountryGroups). 6.0.15 (in development)
content filtered_search The search of the administration's search page with its filter bar: reads the filters from the request (also the parameters of the former advanced search), runs the ... 6.0.15 (in development)
content language_states The state of each language of an object (main, present, missing, outdated) for the language badges of admin4 6.0.15 (in development)
content site_data One row of ezsite_data, read only, for the names of site.ini [SiteDataSettings] TemplateReadable[]. 6.0.15 (in development)
content view_bookmark Calls eZContentFunctionCollection::fetchViewBookmark() (kernel/content/function_definition.php). 6.0.15 (in development)
datatable can Calls expDataTableFunctionCollection::fetchCan() (kernel/datatable/function_definition.php). 6.0.15 (in development)
datatable count Calls expDataTableFunctionCollection::fetchCount() (kernel/datatable/function_definition.php). 6.0.15 (in development)
datatable list Calls expDataTableFunctionCollection::fetchList() (kernel/datatable/function_definition.php). 6.0.15 (in development)
datatable pointing_at Calls expDataTableFunctionCollection::fetchPointingAt() (kernel/datatable/function_definition.php). 6.0.15 (in development)
datatable row Calls expDataTableFunctionCollection::fetchRow() (kernel/datatable/function_definition.php). 6.0.15 (in development)
exphelp context Calls expHelpFunctionCollection::fetchContext() (kernel/exphelp/function_definition.php). 6.0.15 (in development)
exphelp context_menu The header's Help menu: fetch( 'exphelp', 'context_menu', hash( 'module', ..., 'view', ..., 'design', ... 6.0.15 (in development)
exphelp license fetch( 'exphelp', 'license', hash( 'id', $page_id ) ): the documentation license of a page (expHelpLicense::forPage()) 6.0.15 (in development)
exphelp reading_key The /(lang)/ value the help's links keep in this request, '' when none: fetch( 'exphelp', 'reading_key' ) (expHelp::readingKey(): a reader without the interface ... 6.0.15 (in development)
exphelp report_links Where "Report an error" and its security link lead on this siteaccess: fetch( 'exphelp', 'report_links' ) (url, security, view; expHelp::reportLinks(): the help page of ... 6.0.15 (in development)
exphelp site_map Calls expHelpFunctionCollection::fetchSiteMap() (kernel/exphelp/function_definition.php). 6.0.15 (in development)
exphelp site_topic Help maintained as content on the site's own pages (the node templates of help_*, extension exphelpsite): fetch( 'exphelp', 'site_topic', hash( 'object_id', ... 6.0.15 (in development)
migration recording recording: the recording of the signed-in user's own changes and the site-wide window that run (the bar "Recording..." of the administration, ... 6.0.15 (in development)
migration summary Calls expMigrationAdmin::fetchSummary() (kernel/migration/function_definition.php). 6.0.15 (in development)
moderation summary Calls expModerationAdmin::fetchSummary() (kernel/moderation/function_definition.php). 6.0.15 (in development)
package content_export_access Whether the current user may export content as a package: the content object wizard and the package download (package/create with CreatorType ezcontentobject, ... 6.0.15 (in development)
package list_count Calls eZPackageFunctionCollection::fetchListCount() (kernel/package/function_definition.php). 6.0.15 (in development)
role policies Calls eZRoleFunctionCollection::fetchRolePolicies() (kernel/role/function_definition.php). 6.0.15 (in development)
role policy_count Calls eZRoleFunctionCollection::fetchRolePolicyCount() (kernel/role/function_definition.php). 6.0.15 (in development)
setup cronjob_pauses The cronjob parts paused at Setup > Cronjobs, for the figure of its tile on the Setup overview. 6.0.15 (in development)
setup cronjob_status When the cronjob parts last ran and whether one is late, for the dashboard block "cronjobs"; an empty array for a user without setup/managecronjobs ... 6.0.15 (in development)
setup extension_counts Calls eZSetupFunctionCollection::fetchExtensionCounts() (kernel/setup/function_definition.php). 6.0.15 (in development)
setup log_files The log files of the log viewer's navigator (Setup > Log files), grouped: kernel, site, extensions, archives; an empty list for a user without setup/logs ... 6.0.15 (in development)
staticpublish summary Calls expStaticAdmin::fetchSummary() (kernel/staticpublish/function_definition.php). 6.0.15 (in development)
uiswitch front_designs fetch( 'uiswitch', 'front_designs' ): the designs a front siteaccess lets every visitor switch between (site.ini [DesignSettings] SwitchableDesigns[]), with the current ... 6.0.15 (in development)
uiswitch toolbar Calls expUISwitch::fetchToolbar() (kernel/uiswitch/function_definition.php). 6.0.15 (in development)
user account_status The account status of a user object for the administration's marks: 'enabled', 'disabled' or 'locked'; false for an object that is no user account, or when the current ... 6.0.15 (in development)
user can_open Whether the current user can open an address of this siteaccess ("setup/cache", "content/view/full/5", a URL alias), decided the way the kernel decides the request: the ... 6.0.15 (in development)
user deactivation_offers Deactivate and move (doc/eng-us/features/6.0/user-hygiene.md): whether a user's page and the context menu offer Deactivate and move and Reactivate and move back for an ... 6.0.15 (in development)

Older than Exponential 6, first described here

These existed before Exponential 6 (or come from an extension, as the Since column says); the 4.x reference had no page for them.

Module Name Description Since
class list_by_groups Calls eZClassFunctionCollection::fetchClassListByGroups() (kernel/class/function_definition.php). older than 6.0
collaboration item_count Calls eZCollaborationFunctionCollection::fetchItemCount() (kernel/collaboration/function_definition.php). older than 6.0
collaboration item_list Calls eZCollaborationFunctionCollection::fetchItemList() (kernel/collaboration/function_definition.php). older than 6.0
content available_sort_fields Calls eZContentFunctionCollection::fetchAvailableSortFieldList() (kernel/content/function_definition.php). older than 6.0
content collected_info_list Calls eZContentFunctionCollection::fetchCollectionsList() (kernel/content/function_definition.php). older than 6.0
content content_tree_menu_expiry Calls eZContentFunctionCollection::fetchContentTreeMenuExpiry() (kernel/content/function_definition.php). older than 6.0
content prioritized_language_codes Calls eZContentFunctionCollection::fetchPrioritizedLanguageCodes() (kernel/content/function_definition.php). older than 6.0
content prioritized_languages Calls eZContentFunctionCollection::fetchPrioritizedLanguages() (kernel/content/function_definition.php). older than 6.0
content related_objects_ids Calls eZContentFunctionCollection::fetchRelatedObjectsID() (kernel/content/function_definition.php). older than 6.0
content reverse_related_objects_ids Calls eZContentFunctionCollection::fetchReverseRelatedObjectsID() (kernel/content/function_definition.php). older than 6.0
infocollector collected_info_collection Calls eZInfocollectorFunctionCollection::fetchCollectedInfoCollection() (kernel/infocollector/function_definition.php). older than 6.0
infocollector collected_info_count Calls eZInfocollectorFunctionCollection::fetchCollectedInfoCount() (kernel/infocollector/function_definition.php). older than 6.0
infocollector collected_info_count_list Calls eZInfocollectorFunctionCollection::fetchCollectedInfoCountList() (kernel/infocollector/function_definition.php). older than 6.0
infocollector collected_info_list Calls eZInfocollectorFunctionCollection::fetchCollectionsList() (kernel/infocollector/function_definition.php). older than 6.0
role role Calls eZRoleFunctionCollection::fetchRole() (kernel/role/function_definition.php). older than 6.0
rss export_by_node Calls eZRSSFunctionCollection::exportByNode() (kernel/rss/function_definition.php). older than 6.0
rss has_export_by_node Calls eZRSSFunctionCollection::hasExportByNode() (kernel/rss/function_definition.php). older than 6.0
section list Calls eZSectionFunctionCollection::fetchSectionList() (kernel/section/function_definition.php). older than 6.0
setup alias Calls eZSetupFunctionCollection::fetchVersionAlias() (kernel/setup/function_definition.php). older than 6.0
setup database_release Calls eZSetupFunctionCollection::fetchDatabaseRelease() (kernel/setup/function_definition.php). older than 6.0
setup database_version Calls eZSetupFunctionCollection::fetchDatabaseVersion() (kernel/setup/function_definition.php). older than 6.0
setup edition Calls eZSetupFunctionCollection::fetchEdition() (kernel/setup/function_definition.php). older than 6.0
setup is_development Calls eZSetupFunctionCollection::fetchIsDevelopment() (kernel/setup/function_definition.php). older than 6.0
setup major_version Calls eZSetupFunctionCollection::fetchMajorVersion() (kernel/setup/function_definition.php). older than 6.0
setup minor_version Calls eZSetupFunctionCollection::fetchMinorVersion() (kernel/setup/function_definition.php). older than 6.0
setup release Calls eZSetupFunctionCollection::fetchRelease() (kernel/setup/function_definition.php). older than 6.0
setup state Calls eZSetupFunctionCollection::fetchState() (kernel/setup/function_definition.php). older than 6.0
setup version Calls eZSetupFunctionCollection::fetchFullVersionString() (kernel/setup/function_definition.php). older than 6.0
shop current_wish_list Calls eZShopFunctionCollection::fetchCurrentWishList() (kernel/shop/function_definition.php). older than 6.0
shop order Calls eZShopFunctionCollection::fetchOrder() (kernel/shop/function_definition.php). older than 6.0
shop order_status_history Calls eZShopFunctionCollection::fetchOrderStatusHistory() (kernel/shop/function_definition.php). older than 6.0
shop order_status_history_count Calls eZShopFunctionCollection::fetchOrderStatusHistoryCount() (kernel/shop/function_definition.php). older than 6.0
shop user_country Calls eZShopFunctionCollection::fetchUserCountry() (kernel/shop/function_definition.php). older than 6.0
workflow workflow_statuses Calls eZWorkflowFunctionCollection::fetchWorkflowStatuses() (kernel/workflow/function_definition.php). older than 6.0
workflow workflow_type_statuses Calls eZWorkflowFunctionCollection::fetchWorkflowTypeStatuses() (kernel/workflow/function_definition.php). older than 6.0

Changed in Exponential 6

These fetch function pages have a section "Changed in Exponential 6.0.15":

Added for Exponential 6.0.15 and the earlier 6.0.x releases.

Contributors

Comments (5 historical)

Written by readers of the earlier documentation sites, kept as they were.

  1. Role fetch functions

    Kristof Coomans ·

    fetch functions of the "role" module:
    role, parameter role_id

  2. Order fetch function?

    //kracker ·

    Why no order fetch function?

  3. "setup" fetch functions

    Gaetano ·

    version, major_version, minor_version, release, state, is_development, revision, database_version, database_release

  4. undocumented content fetch function: "collected_info_list"

    Gaetano ·

    From the php code, here's the list of params it takes:
    array( 'name' => 'object_id',
    'type' => 'integer',
    'required' => false,
    'default' => false ),
    array( 'name' => 'creator_id',
    'type' => 'integer',
    'required' => false,
    'default' => false ),
    array( 'name' => 'user_identifier',
    'type' => 'string',
    'required' => false,
    'default' => false ),
    array( 'name' => 'limit',
    'type' => 'integer',
    'required' => false,
    'default' => false ),
    array( 'name' => 'offset',
    'type' => 'integer',
    'required' => false,
    'default' => false ),
    array( 'name' => 'sort_by',
    'type' => 'array',
    'required' => false,
    'default' => array() )

  5. Not doc yet

    pulco ·

    It would be about time to fix the "not documented yet", don't you think?

Comments

Add a comment

Comments are read by a moderator before they appear.