url stringlengths 50 196 | text stringlengths 3 17.2k | heading stringlengths 2 103 | embeddings list |
|---|---|---|---|
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Properties#general | General
Every element can have custom properties.
You can find these in the Properties tab for each type of elements (documents, assets, objects).
The properties could be used to specify some special behavior when the document is rendered.
Have a look at a few cases below:
Hide the main navigation
Show the sidebar
Use an additional stylesheet
| General | [
0.08670143038034439,
-0.39323458075523376,
-0.29679372906684875,
-0.08159244060516357,
0.04841871187090874,
-0.06923821568489075,
0.2429262101650238,
0.3069360852241516,
-0.010693384334445,
0.18724742531776428,
-0.056895043700933456,
0.0556286945939064,
0.17163215577602386,
0.0339288227260... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Properties#get-property-in-the-template | Get property in the template
The following example shows how you can get a property value in the template:
{# retrieve the value of a property named "hideNavigation" #}
{% set hideNavigation = document.getProperty('hideNavigation') %}
| Get property in the template | [
0.038770027458667755,
-0.3153682053089142,
-0.23427258431911469,
0.003253948874771595,
0.01785471849143505,
-0.20418646931648254,
0.16039514541625977,
0.22991794347763062,
-0.22994837164878845,
0.4422609806060791,
0.1338563859462738,
0.4396715760231018,
0.04241549223661423,
0.1113287135958... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Properties#predefined-properties | Predefined properties
With predefined properties you can help/show the editors working within your Pimcore installation which properties are available for their use.
You can also define default values for each defined property to improve the productivity of your editors.
Predefined does not mean that the value of the predefined property is available for every document.
To add global properties which are available everywhere use Website Settings instead.
| Predefined properties | [
-0.3059554696083069,
-0.4236585199832916,
-0.13664110004901886,
-0.2683424651622772,
0.12149974703788757,
-0.1483367681503296,
0.1241946592926979,
0.06901299208402634,
-0.4410932958126068,
0.5231461524963379,
-0.1109662652015686,
0.5267434120178223,
0.06653367727994919,
-0.0202937647700309... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Properties#configuration-example | Configuration example
You can find the Predefined properties configuration in the Settings -> Predefined properties menu.
The following fields are available in the properties configuration.
Name
Is required?
Description
Name
Y
The friendly name shown in the selection.
Description
N
The description would help understand a specific property meaning.
Key
Y
This field is the key which you use in your code to retrieve the contents of the property. For example: $document->getProperty("key");
Type
Y
Specifies the type of the content which is allowed in the property. Available types are: text, document, asset, object, bool (checkbox), select.
Value
N
Here you can define a default value for this property which I added automatically to the property when it is added to a element. This field is optional. See the example configuration above for details.
Configuration
N
This field is used to configure a property. At the moment, this is used only by the property-type select. Separate options with a comma.
Content-Type
Y
Defines for which element-type (document, asset or object) the property should be available.
Note
Each defined field can be overwritten in the element after it was added.
| Configuration example | [
-0.19804388284683228,
-0.2955929636955261,
-0.16688989102840424,
-0.07244881987571716,
0.13564640283584595,
-0.17156843841075897,
-0.03348071500658989,
0.28998056054115295,
0.020036255940794945,
0.3887547254562378,
-0.014026055112481117,
0.27457115054130554,
0.04481459781527519,
0.23081371... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Tags#tags | Tags | Tags | [
0.09200281649827957,
-0.4064788222312927,
-0.5059652924537659,
0.10962465405464172,
0.2876107096672058,
0.06990620493888855,
0.22118759155273438,
0.1896052360534668,
0.3167675733566284,
0.07911019027233124,
-0.28046950697898865,
0.016278676688671112,
-0.1867809146642685,
0.2057707160711288... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Tags#general | General
Tags provide a way to create additional taxonomies and classifications for Documents, Assets and Data Objects.
Using tags, you can easily filter Pimcore Elements (Documents, Data Objects, Assets) and keep the additional search criteria to the application. | General | [
-0.2068096548318863,
-0.27051353454589844,
-0.17317499220371246,
0.02524201013147831,
0.2148604840040207,
0.045133382081985474,
-0.14942549169063568,
0.3442571759223938,
0.07188056409358978,
-0.11947125196456909,
-0.284386545419693,
0.1795206218957901,
-0.0005162822199054062,
0.25145074725... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Tags#tags-definition | Tags Definition
The available tags have to be defined centrally (user permission tags configuration is necessary).
| Tags Definition | [
-0.033821430057287216,
-0.3039657175540924,
-0.2509765625,
-0.0131634920835495,
0.14805756509304047,
-0.045629050582647324,
0.4128221273422241,
0.0835244432091713,
0.30326399207115173,
0.2577430009841919,
-0.13780923187732697,
0.09391038119792938,
-0.0878230631351471,
0.11797501146793365,
... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Tags#tags-assignment | Tags Assignment
In Documents, Assets, or Data Objects editor, there is an additional tab where tags can be assigned to the current element (user permission tags assignment is necessary).
| Tags Assignment | [
0.18541792035102844,
0.028937147930264473,
-0.30175939202308655,
-0.22750172019004822,
0.08247426152229309,
0.11100717633962631,
0.43221133947372437,
0.06373848021030426,
0.1867227852344513,
0.463601678609848,
-0.1832510083913803,
0.33460772037506104,
0.049919456243515015,
0.12498137354850... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Tags#tags-usage | Tags Usage
In the Search dialog, tags can be selected as additional criteria for the search (user permission tags search necessary).
| Tags Usage | [
0.29023686051368713,
0.06455597281455994,
-0.3039688766002655,
-0.12347662448883057,
-0.05070950463414192,
-0.05033610388636589,
0.22393612563610077,
0.14657379686832428,
0.33949145674705505,
0.19461141526699066,
-0.26519933342933655,
0.0057096886448562145,
-0.19030539691448212,
-0.0179459... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Tags#working-with-tags-via-api | Working With Tags via API | Working With Tags via API | [
0.1712247133255005,
-0.1294870674610138,
-0.3795657753944397,
0.15816159546375275,
0.07398088276386261,
-0.15608781576156616,
0.056374114006757736,
0.16704979538917542,
0.48659470677375793,
0.22797666490077972,
0.08883461356163025,
0.25989362597465515,
-0.047229524701833725,
0.273744970560... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Tags#overview | Overview
For accessing and working with tags via API, take a look into Pimcore\Model\Element\Tag.
/**
* returns all assigned tags for element
*
* @return Tag[]
*/
public static function getTagsForElement(string $cType, int $cId): array
{
$tag = new Tag();
return $tag->getDao()->getTagsForElement($cType, $cId);
}
/**
* adds given tag to element
*/
public static function addTagToElement(string $cType, int $cId, Tag $tag): void
{
$tag->getDao()->addTagToElement($cType, $cId);
}
/**
* removes given tag from element
*/
public static function removeTagFromElement(string $cType, int $cId, Tag $tag): void
{
$tag->getDao()->removeTagFromElement($cType, $cId);
}
/**
* sets given tags to element and removes all other tags
* to remove all tags from element, provide empty array of tags
*
* @param Tag[] $tags
*/
public static function setTagsForElement(string $cType, int $cId, array $tags): void
{
$tag = new Tag();
$tag->getDao()->setTagsForElement($cType, $cId, $tags);
}
| Overview | [
0.10530219972133636,
-0.15202544629573822,
-0.2547009289264679,
0.2723046839237213,
0.11303295195102692,
-0.09041804075241089,
0.14414890110492706,
0.14974066615104675,
0.19908449053764343,
0.3430100679397583,
-0.42970404028892517,
0.6006327867507935,
-0.08463418483734131,
0.41534516215324... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Tags#api-usage-examples | API Usage Examples | API Usage Examples | [
0.3979756236076355,
-0.3427778482437134,
-0.3690512180328369,
0.08133840560913086,
-0.27526846528053284,
-0.21502670645713806,
0.29414331912994385,
-0.1531878560781479,
0.30420541763305664,
0.26369568705558777,
0.36073926091194153,
0.2710469961166382,
0.19371499121189117,
0.121049970388412... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Tags#get-tags-for-element | Get Tags for Element
To get all tags from the element below:
You can use the getTagsForElement method by specifying the element type in the $cType parameter.
In the case above, the element type is asset.
$tags = \Pimcore\Model\Element\Tag::getTagsForElement('asset', 30);
dump($tags);
The output will be an array with the Pimcore\Model\Element\Tag elements.
array:3 [▼
0 => Pimcore\Model\Element\Tag {#7351 ▼
#id: 9
#name: "Italy"
#parentId: 7
#idPath: "/7/"
#children: null
#parent: Pimcore\Model\Element\Tag {#7354 ▶}
#dao: Pimcore\Model\Element\Tag\Dao {#7349 ▶}
id: 9
name: "Italy"
parentId: 7
idPath: "/7/"
children: null
parent: Pimcore\Model\Element\Tag {#7354 ▶}
}
1 => Pimcore\Model\Element\Tag {#7357 ▶}
2 => Pimcore\Model\Element\Tag {#7345 ▶}
]
| Get Tags for Element | [
-0.24569176137447357,
-0.18521052598953247,
-0.3145163953304291,
0.5268277525901794,
0.13210360705852509,
0.1451999992132187,
0.2167617231607437,
0.5100764036178589,
0.19486790895462036,
0.2611660659313202,
-0.35205715894699097,
0.38922691345214844,
-0.13407886028289795,
0.3193539083003998... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Tags#assign-a-new-tag-to-an-element | Assign a New Tag to an Element
To add a new tag to an element, you first need to create the new tag. Then you just have to use the \Pimcore\Model\Element\Tag::addTagToElement method to assign the tag to the chosen element (by element id).
$tag = new \Pimcore\Model\Element\Tag();
try {
$tag->setName('newtag')->save();
\Pimcore\Model\Element\Tag::addTagToElement('asset', 30, $tag);
} catch (Exception $e) {
// ....
}
The result will be:
In the same way, you can use the rest of the available methods.
The type properties list is standard. You can use one of document, asset or object. | Assign a New Tag to an Element | [
-0.09680113941431046,
-0.07062779366970062,
-0.14604316651821136,
-0.021749021485447884,
0.21773995459079742,
-0.0027564000338315964,
0.17717444896697998,
0.2081516683101654,
0.16448049247264862,
0.3818027973175049,
-0.31311485171318054,
0.4442678391933441,
0.03804858773946762,
0.391746729... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Perspectives#perspectives | Perspectives | Perspectives | [
-0.27098533511161804,
-0.32016900181770325,
-0.22066719830036163,
0.07227826118469238,
-0.033227697014808655,
-0.18460629880428314,
0.5871467590332031,
-0.10585078597068787,
-0.5354602932929993,
0.16402441263198853,
-0.2809276580810547,
-0.1926705241203308,
0.06160987913608551,
0.190121471... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Perspectives#general | General
Perspectives allow to create different views in the backend UI and even customize the standard perspective.
This feature could be combined with the configuration options already available for the Custom Views.
You can create or edit perspectives and custom views within the Pimcore backend UI using the perspective editor bundle.
Security Note
Perspectives and Custom Views are not intended to be used to restrict access to data
Please be aware that if combined with custom views, the custom view settings must be defined in the customviews.yaml (the filename is up to you).
The link is accomplished via the ID.
You can define:
which trees you want to see
where it is positioned (left/right)
the order and which one should be expanded by default
the available tree context menu items
the navigation menu items
the standard elements on the welcome screen
which portlets can be added to a dashboard
You can define an arbitrary number of perspectives and switch between them via the File menu.
You can restrict the access to certain perspectives via the user settings.
| General | [
-0.21805597841739655,
-0.25820356607437134,
-0.1475977599620819,
0.0014753182185813785,
-0.19214728474617004,
-0.31069859862327576,
0.2880379259586334,
-0.09169255197048187,
-0.4361979067325592,
0.0019992359448224306,
-0.48173657059669495,
0.22155828773975372,
0.2987939715385437,
0.2997482... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Perspectives#the-configuration-file | The Configuration File
Format and location of the perspective configuration depends on your environment.
Per default the symfony-config is used.
If you want to change the default behaviour, have a look at the environment configuration options.
Please refer to the example configuration for further details on how this can be set up.
You can find out there how the default view is prepared and how to add a special perspective.
The table below, describes the most useful of available options in the configuration file.
Reference
Value
Description
[perspectiveName]["icon"]
string
Path to the icon file.
[parspectiveName]["iconCls"]
string
The CSS class added to the icon.
[perspectiveName]["elementTree"]
array
Array which contain the rows with configuration information like the tree type .
[perspectiveName]["elementTree"][i]["type"]
string (documents,objects,assets,customview)
What type of elements will be rendered in the tree.
[perspectiveName]["elementTree"][i]["position"]
string (left,right)
a place, where the tree is initially generated
[perspectiveName]["elementTree"][i]["id"]
integer
The id of customview elements rendered in the tree. (works only with the customview type)
[perspectiveName]["toolbar"]
array
that option allows to add changes in the toolbar menu.
[perspectiveName]["toolbar"][i][menuName]
string (file,marketing,extras,settings,search)
these are the default toolbar menus
[perspectiveName]["toolbar"][i][menuName]["hidden"]
boolean
ability to hide a specified menu (the available list you can find in the example below)
[perspectiveName]["toolbar"][i][menuName]["items"]["itemsName"]
boolean
You could specify there, which submenu elements you would like to generate.
| The Configuration File | [
-0.05779121816158295,
-0.04161667078733444,
-0.04725939780473709,
0.16242623329162598,
-0.18664483726024628,
-0.2384253889322281,
0.30607178807258606,
-0.09954079240560532,
-0.2124396413564682,
0.06189846992492676,
-0.04583277553319931,
0.06001507118344307,
0.2739373743534088,
-0.154317632... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Perspectives#simple-example | Simple example
Note: This is a simple example, which could be used for catalog administrators. For advanced usage please see the example configuration.
We need only to see
products (objects from a specific directory)
assets
search button
To specify the range of objects you're going to use you, you have to firstly add a customview.
See the Custom views section to get more details.
The custom view definition would look like that:
#var/config/perspectives/perspective.yaml
...
4e9f892c-7734-f5fa-d6f0-31e7f9787ffc:
name: Cars
treetype: object
position: left
rootfolder: '/Product Data/Cars'
showroot: false
sort: 3
treeContextMenu:
object:
items:
add: true
addFolder: true
importCsv: true
cut: true
copy: true
paste: true
delete: true
rename: true
reload: true
publish: true
unpublish: true
searchAndMove: true
lock: true
unlock: true
lockAndPropagate: true
unlockAndPropagate: true
changeChildrenSortBy: true
icon: /bundles/pimcoreadmin/img/flat-white-icons/automotive.svg
classes: CAR
joins: { }
id: 4e9f892c-7734-f5fa-d6f0-31e7f9787ffc
Let's update the var/config/perspectives/example.yaml by the new perspective.
#var/config/perspectives/perspective.yaml
...
demo:
elementTree:
-
type: customview
position: left
sort: 0
expanded: false
hidden: false
id: 4e9f892c-7734-f5fa-d6f0-31e7f9787ffc
-
type: assets
position: right
sort: 0
expanded: false
hidden: false
treeContextMenu:
asset:
items:
add:
hidden: false
items:
upload: true
uploadCompatibility: true
uploadZip: true
addFolder: true
rename: true
copy: true
cut: true
paste: true
pasteCut: true
delete: true
searchAndMove: true
lock: true
unlock: true
lockAndPropagate: true
unlockAndPropagate: true
reload: true
iconCls: pimcore_nav_icon_perspective
icon: null
toolbar:
file:
hidden: true
items:
perspectives: false
dashboards: false
openDocument: false
openAsset: false
openObject: false
searchReplace: false
schedule: false
seemode: false
closeAll: false
help: false
about: false
marketing:
hidden: true
items:
reports: false
tagmanagement: false
targeting: false
seo:
hidden: false
items:
documents: false
robots: false
httperrors: false
extras:
hidden: true
items:
glossary: false
redirects: false
translations: false
recyclebin: false
plugins: false
notesEvents: false
applicationlog: false
gdpr_data_extractor: false
emails: false
maintenance: false
systemtools:
hidden: false
items:
phpinfo: false
opcache: false
requirements: false
serverinfo: false
database: false
fileexplorer: false
settings:
hidden: true
items:
customReports: false
marketingReports: false
documentTypes: false
predefinedProperties: false
predefinedMetadata: false
system: false
website: false
web2print: false
users:
hidden: false
items:
users: false
roles: false
thumbnails: false
objects:
hidden: false
items:
classes: false
fieldcollections: false
objectbricks: false
quantityValue: false
classificationstore: false
bulkExport: false
bulkImport: false
routes: false
cache:
hidden: false
items:
clearAll: false
clearData: false
clearSymfony: false
clearOutput: false
clearTemp: false
adminTranslations: false
tagConfiguration: false
perspectiveEditor: false
search:
hidden: false
items:
quickSearch: false
documents: true
assets: false
objects: false
datahub:
hidden: false
I changed the number of elements rendered in the main Pimcore menu.
Also I added two trees. The first (on the right side) for assets and the second on the left side for the
custom view with product objects.
The view after switch looks like in the picture.
| Simple example | [
-0.12338432669639587,
-0.07480676472187042,
-0.15591689944267273,
0.16082237660884857,
0.04368898272514343,
-0.17864684760570526,
0.4652574956417084,
0.259010910987854,
-0.11782139539718628,
0.07584623992443085,
-0.181553915143013,
0.07984355092048645,
0.0995696559548378,
0.095605805516242... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Perspective_Example#perspective-example-configuration | Perspective Example Configuration
#var/config/perspectives/Event.yaml
pimcore:
perspectives:
definitions:
Event:
elementTree:
-
type: customview
position: left
sort: 0
expanded: true
hidden: false
id: 87705013-edb9-c9ec-0f5e-c3ee45ca4459
iconCls: null
icon: /bundles/pimcoreadmin/img/flat-color-icons/vip.svg
toolbar:
file:
hidden: true
items:
perspectives: true
dashboards: true
openDocument: true
openAsset: true
openObject: true
searchReplace: true
schedule: true
seemode: true
closeAll: true
help: true
about: true
marketing:
hidden: true
items:
reports: true
tagmanagement: true
targeting: true
seo:
hidden: false
items:
documents: true
robots: true
httperrors: true
extras:
hidden: true
items:
glossary: true
redirects: true
translations: true
recyclebin: true
plugins: true
notesEvents: true
applicationlog: true
gdpr_data_extractor: true
emails: true
maintenance: true
systemtools:
hidden: false
items:
phpinfo: true
opcache: true
requirements: true
serverinfo: true
database: true
fileexplorer: true
settings:
hidden: true
items:
customReports: true
marketingReports: true
documentTypes: true
predefinedProperties: true
predefinedMetadata: true
system: true
website: true
web2print: true
users:
hidden: false
items:
users: true
roles: true
thumbnails: true
objects:
hidden: false
items:
classes: true
fieldcollections: true
objectbricks: true
quantityValue: true
classificationstore: true
bulkExport: true
bulkImport: true
routes: true
cache:
hidden: false
items:
clearAll: true
clearData: true
clearSymfony: true
clearOutput: true
clearTemp: true
adminTranslations: true
tagConfiguration: true
perspectiveEditor: true
search:
hidden: true
items:
quickSearch: true
documents: true
assets: true
objects: true
datahub:
hidden: true
| Perspective Example Configuration | [
-0.31258413195610046,
-0.20851421356201172,
-0.16406767070293427,
0.24856340885162354,
0.10512034595012665,
-0.0448477603495121,
0.279671847820282,
0.16175369918346405,
-0.5061675906181335,
0.12802723050117493,
-0.07130979001522064,
0.2795526385307312,
0.17389477789402008,
0.28954932093620... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Application_Logger#application-logger | Application logger
:::caution
To use this feature, please enable the PimcoreApplicationLoggerBundle in your bundle.php file and install it accordingly with the following command:
bin/console pimcore:bundle:install PimcoreApplicationLoggerBundle
::: | Application logger | [
-0.4646878242492676,
-0.23860518634319305,
-0.09843593835830688,
-0.09883034974336624,
0.0866246372461319,
-0.29688760638237,
0.26521867513656616,
-0.09283017367124557,
-0.26509130001068115,
0.045426975935697556,
0.16765643656253815,
0.38488009572029114,
-0.27032172679901123,
-0.1446762979... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Application_Logger#general | General
The application logger bundle is a tool which developers can use to log certain events and errors within a Pimcore powered application.
The logs are visible and searchable within the Pimcore backend GUI Tools -> Application Logger:
| General | [
-0.21583490073680878,
-0.471030056476593,
-0.029559336602687836,
0.14694508910179138,
-0.013410565443336964,
-0.08031583577394485,
-0.04985016584396362,
-0.12720522284507751,
-0.16672377288341522,
-0.038154829293489456,
0.03927626460790634,
0.37183263897895813,
-0.2813186049461365,
-0.1757... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Application_Logger#how-to-create-log-entries | How to create log entries
The application logger is a PSR-3 compatible component and available on the service container as service Pimcore\Bundle\ApplicationLoggerBundle\ApplicationLogger
and therefore it can be used the usual way. | How to create log entries | [
-0.08145762979984283,
-0.517888069152832,
-0.013640496879816055,
-0.023976843804121017,
-0.010884493589401245,
-0.27729907631874084,
0.23337621986865997,
-0.4139672815799713,
-0.13066241145133972,
0.04859776422381401,
0.028831830248236656,
0.3447969853878021,
-0.0824597179889679,
-0.121594... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Application_Logger#basic-usage---example | Basic Usage - Example | Basic Usage - Example | [
0.21051442623138428,
-0.8264354467391968,
-0.27791881561279297,
0.014129715971648693,
-0.013732261024415493,
-0.14237001538276672,
0.32068872451782227,
-0.09018638730049133,
-0.1068524718284607,
0.3558562397956848,
0.5341060757637024,
0.002268738579005003,
0.09609848260879517,
-0.019735561... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Application_Logger#controller--action | Controller / Action
<?php
namespace App\Controller;
use Pimcore\Bundle\ApplicationLoggerBundle\ApplicationLogger;
use Pimcore\Controller\FrontendController;
class TestController extends FrontendController
{
// injected as action argument (controller needs to be registered as service)
public function testAction(ApplicationLogger $logger): void
{
$logger->error('Your error message');
$logger->alert('Your alert');
$logger->debug('Your debug message', ['foo' => 'bar']); // additional context information
}
public function anotherAction(): void
{
// fetched from container
$logger = $this->get(ApplicationLogger::class);
$logger->error('Your error message');
}
}
| Controller / Action | [
-0.3989276885986328,
-0.4351726472377777,
-0.11712978780269623,
0.05490129441022873,
-0.007669647689908743,
-0.23641657829284668,
0.2858307957649231,
0.13048462569713593,
-0.06130710989236832,
0.16996489465236664,
0.0720166340470314,
0.28052109479904175,
-0.16947633028030396,
-0.1359253376... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Application_Logger#dependency-injection | Dependency Injection
App\YourService:
calls:
- [setLogger, ['@Pimcore\Bundle\ApplicationLoggerBundle\ApplicationLogger']]
You can also make use of autowiring by defining the application logger as dependency:
services:
_defaults:
autowire: true
App\YourService: ~
<?php
namespace App;
use Pimcore\Bundle\ApplicationLoggerBundle\ApplicationLogger;
class YourService
{
/**
* @var ApplicationLogger
*/
private $logger;
public function __construct(ApplicationLogger $logger)
{
$this->logger = $logger;
$logger->debug('Hello from YourService');
}
}
| Dependency Injection | [
-0.40838831663131714,
-0.16626273095607758,
-0.009524687193334103,
-0.17054139077663422,
0.17036855220794678,
-0.1774166375398636,
0.23647469282150269,
-0.1522916555404663,
-0.01490405946969986,
0.05657919496297836,
0.27635329961776733,
0.4331158995628357,
-0.24746857583522797,
-0.33668106... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Application_Logger#usage-as-monolog-handler | Usage as monolog handler
Instead of using the ApplicationLogger class, you can configure monolog to use the application logger as monolog log handler
and make full use of monolog's possibilities. To do so, Pimcore provides the ApplicationLoggerDb monolog handler which
is already preconfigured as service and can easily be registered to monolog:
monolog:
handlers:
# monolog allows us to register custom handlers via type: service
# note that the only supported extra option besides type and id is channels
application_logger_db:
type: service
id: Pimcore\Bundle\ApplicationLoggerBundle\Handler\ApplicationLoggerDb
channels: ["application_logger"]
Note that the channel(s) need to exist. This can either by achieved by configuring them manually
or by using DI tags to select the logger for
the channel you want to log to. When using DI tags, the channel will be created implicitly by monolog.
IMPORTANT: As the ApplicationLoggerDb handler has a dependency on the database connection it is important to exclude
channels logging database queries (typically the doctrine channel) from the handler to avoid infinite loops. Either
specify a allowlist of supported channels (as shown in the example above) or exclude the doctrine channel by setting
channels to ["!doctrine"].
As the type: service handler config does not support filtering by log level, you can use the filter handler type to
wrap the application logger and to filter by a specific log level:
monolog:
handlers:
# The filter handler can be used to filter for a given log level.
# Note that the supported channels are now configured on the filter
# handler. To filter by level you can set accepted_levels or min_level and max_level.
# See https://github.com/symfony/monolog-bundle/blob/master/DependencyInjection/Configuration.php#L97
# for details.
application_logger_filter:
type: filter
channels: ["application_logger"]
handler: application_logger_db
min_level: ERROR
application_logger_db:
type: service
id: Pimcore\Bundle\ApplicationLoggerBundle\Handler\ApplicationLoggerDb
Of course you can also use the handler in combination with other log handlers such as the Fingers Crossed Handler.
See the Symfony Logging Documentation for details.
As soon as the handler is configured, you can use it (as any other monolog logger) by using a DI tag to specify the channel you want to log to:
<?php
namespace App\Controller;
use Psr\Log\LoggerInterface;
// we take a controller as example here, but this can be any service
// no need to extend a base controller here as we inject our dependencies
// via DI
class TestController
{
private LoggerInterface $logger;
public function __construct(LoggerInterface $logger)
{
$this->logger = $logger;
}
public function testAction(): void
{
$this->logger->error('Your error message');
}
}
The service definition can add a DI tag to specify which logger should be injected:
services:
App\Controller\TestController:
arguments:
$logger: '@logger'
tags:
- { name: monolog.logger, channel: application_logger }
It's also possible to autowire the logger channel by changing the argument name format to (channel name in camel case) + Logger.
An example for channel foo_bar:
public function __construct(LoggerInterface $fooBarLogger)
{
$this->logger = $fooBarLogger;
}
More details on Logging Chanel Handlers | Usage as monolog handler | [
-0.3003605008125305,
-0.042735595256090164,
0.04516232758760452,
-0.07527471333742142,
-0.010271093808114529,
-0.21942362189292908,
0.4283497929573059,
0.04188791662454605,
-0.2375992089509964,
-0.011746475473046303,
-0.19403348863124847,
0.447257936000824,
-0.3805793523788452,
-0.07997665... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Application_Logger#special-context-variables | Special context variables
There are some context variables with a special functionality: fileObject, relatedObject, component.
<?php
namespace App\Controller;
use Pimcore\Bundle\ApplicationLoggerBundle\ApplicationLogger;
use Pimcore\Bundle\ApplicationLoggerBundle\FileObject;
use Pimcore\Model\DataObject\AbstractObject;
use Symfony\Component\HttpFoundation\Response;
class TestController
{
public function testAction(ApplicationLogger $logger): Response
{
$fileObject = new FileObject('some interesting data');
$myObject = DataObject::getById(73);
$logger->error('my error message', [
'fileObject' => $fileObject,
'relatedObject' => $myObject,
'component' => 'different component',
'source' => 'Stack trace or context-relevant information' // optional, if empty, gets automatically filled with class:method:line from where the log got executed
]);
// ...
}
}
In the application logger grid, the new row was created: my error message with related object.
If you click on the row you can go to the object editor by clicking on the Related object edit icon in the popup.
| Special context variables | [
-0.19337457418441772,
-0.16487249732017517,
-0.040661223232746124,
0.3092220723628998,
-0.08435279875993729,
-0.1624547392129898,
0.12977378070354462,
0.16618871688842773,
-0.08015583455562592,
0.0465196892619133,
-0.15498261153697968,
0.08492830395698547,
-0.055566802620887756,
-0.2783708... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Application_Logger#logging-exceptions | Logging exceptions
The application logger provides a helper method to log exceptions and implicitly create a FileObject from the exception
when writing the log entry. This can be done in 2 ways depending on how you use the application logger:
<?php
use Pimcore\Bundle\ApplicationLoggerBundle\ApplicationLogger;
$exception = new \RuntimeException('failed :(');
// 1) When directly using the application logger (see basic usage above). Given your
// logger is an instance of `ApplicationLogger`:
/** @var ApplicationLogger $appLogger */
$appLogger->logException('Oh no!', $exception, 'alert', $relatedObject, $component);
// 2) When using as monolog handler (see above). Given your logger is any PSR-3 compatible logger, you
// can use a static helper to generate a log entry with the same file object as the logging call
// above.
/** @var \Psr\Log\LoggerInterface $logger */
ApplicationLogger::logExceptionObject($logger, 'Oh no!', $exception, 'alert', $relatedObject);
| Logging exceptions | [
-0.20005032420158386,
-0.3943565785884857,
0.010015156120061874,
0.19204844534397125,
0.04348404332995415,
-0.1809065043926239,
0.08086339384317398,
-0.12142784893512726,
-0.2274215966463089,
0.10817746073007584,
0.20602381229400635,
0.2639729082584381,
-0.38540610671043396,
-0.41889050602... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Application_Logger#setting-an-individual-logger-level | Setting an individual logger level
Adds a console logger and sets the minimum logging level to INFO (overwrites log level in Pimcore system settings):
$logger = \Pimcore\Bundle\ApplicationLoggerBundle\ApplicationLogger::getInstance("SAP_exporter", true);
// returns a PSR-3 compatible logger, registers a custom app logger as `pimcore.app_logger.SAP_exporter` on the service container
$logger->addWriter(new \Monolog\Handler\StreamHandler('php://output', \Monolog\Logger::INFO));
| Setting an individual logger level | [
-0.27680185437202454,
-0.40407752990722656,
-0.03417925909161568,
0.020057313144207,
-0.05320826545357704,
-0.3061674237251282,
0.3103729486465454,
0.032820601016283035,
-0.4050540030002594,
0.36622703075408936,
-0.09737549722194672,
0.4100085496902466,
-0.16998279094696045,
0.282830953598... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Application_Logger#configuration | Configuration
There are some options in the system settings to configure the application logger (within the Debug panel):
When the Send log summary per mail checkbox is activated the defined receivers will receive log entries by mail.
The priority can be used to setup which log messages will be contained in the mail.
For example errors are more important than just info entries.
The archive function automatically creates new database tables to archive the log entries in the form application_logs_archive_*.
In the above example log entries will be moved after 30 days to these archive tables.
Optionally a different database name for the archive tables can be defined. | Configuration | [
-0.02822856605052948,
-0.03171483054757118,
-0.00784377008676529,
0.12804338335990906,
-0.008246347308158875,
0.0034583043307065964,
0.10998138040304184,
-0.13389185070991516,
0.1441461145877838,
-0.004401999060064554,
0.3309623897075653,
0.18060031533241272,
-0.33348315954208374,
0.050294... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Glossary#glossary | Glossary
:::caution
To use this feature, please enable the PimcoreGlossaryBundle in your bundle.php file and install it accordingly with the following command:
bin/console pimcore:bundle:install PimcoreGlossaryBundle
::: | Glossary | [
-0.32591164112091064,
-0.33264267444610596,
-0.21368426084518433,
0.19760239124298096,
-0.06761104613542557,
-0.12412796914577484,
-0.04593025520443916,
-0.007024246733635664,
-0.2598659098148346,
0.3389018476009369,
-0.09969890862703323,
0.2958657443523407,
0.00973493792116642,
0.13507056... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Glossary#general | General
The glossary module is a powerful tool making internal linking easy and smart.
In a special editor you can define your terms which are replaced automatically with a link to the defined page.
But the glossary is not only useful for internal linking, it's also perfect for explaining abbreviations. | General | [
0.21293088793754578,
-0.7169622182846069,
-0.13126686215400696,
0.09202729165554047,
-0.1703072041273117,
0.21238358318805695,
-0.39360976219177246,
-0.0200778990983963,
0.006510251667350531,
0.16124501824378967,
-0.17664922773838043,
0.12249872833490372,
0.014294194988906384,
-0.076855413... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Glossary#how-it-works | How it Works
Open the glossary editor Tools -> Glossary and define some terms.
Then you have to define one or more regions in your views, telling the glossary where you want it to replace your terms.
{% apply pimcore_glossary %}
<div>
{{ pimcore_wysiwyg('content', { height: 200 }) }}
</div>
{% endapply %}
Now the output of the WYSIWYG field will look like this.
And the HTML-markup will look like, below.
<p>
<abbr title="Hypertext Preprocessor">PHP</abbr> is a widely used, general-purpose scripting language that was originally designed for web development to produce dynamic web pages. For this purpose, <abbr title="Hypertext Preprocessor">PHP</abbr> code is embedded into the HTML source document and interpreted by a web server with a <abbr title="Hypertext Preprocessor">PHP</abbr> processor module, which generates the web page&nbsp; document. As a general-purpose programming language, <abbr title="Hypertext Preprocessor">PHP</abbr> code is processed by an interpreter application in command-line mode performing desired operating system operations and producing program output on its standard output channel. It may also function as a graphical application. <abbr title="Hypertext Preprocessor">PHP</abbr> is available as a processor for most modern web servers and as standalone interpreter on most operating systems and computing platforms. You can <a href="http://www.php.net/">download</a> it free at php.net.
</p>
Note
Since the glossary depends on languages you'll have to register a language first.
Read more about this topic here. | How it Works | [
0.060820043087005615,
-0.33011236786842346,
-0.17088037729263306,
0.07914309948682785,
0.04634510725736618,
-0.19678357243537903,
-0.028496788814663887,
0.049256566911935806,
-0.0018886452307924628,
0.10125603526830673,
0.0013236554805189371,
0.4089415967464447,
0.15738153457641602,
0.2285... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/System_Settings#system-settings | System Settings
In the system settings (Settings > System Settings) system-wide settings for Pimcore can be made. Changes should
be made with care and only by developers.
These settings are saved in var/config/system_settings/system_settings.yaml or in the settings store based on your configuration. The production environment has them stored in the settings store by default.
To save system settings into the settings store, you will need to add following to your configuration:
pimcore:
config_location:
system_settings:
write_target:
type: 'settings-store'
read_target:
type: 'settings-store'
To switch from the Symfony configuration to the settings store for the first time, please follow these steps:
Set your write target to settings-store:
pimcore:
config_location:
system_settings:
write_target:
type: 'settings-store'
Save your system settings via admin user interface (Settings > System Settings).
Set your read target to settings-store as well:
pimcore:
config_location:
system_settings:
write_target:
type: 'settings-store'
read_target:
type: 'settings-store'
| System Settings | [
-0.41559335589408875,
-0.296281635761261,
-0.08137330412864685,
-0.11833103001117706,
0.2924632132053375,
-0.14027631282806396,
0.1088782548904419,
-0.1643047034740448,
-0.16736538708209991,
0.15673372149467468,
-0.18163418769836426,
0.30123046040534973,
0.12017520517110825,
0.014227026142... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/System_Settings#localization-&-internationalization-(i18nl10n) | Localization & Internationalization (i18n/l10n)
These settings are used in documents to specify the content language (in properties tab), for objects in localized-fields,
for shared translations, ... simply everywhere the editor can choose or use a language for the content.
Fallback languages are currently used in object's localized fields and shared translations. | Localization & Internationalization (i18n/l10n) | [
-0.12594985961914062,
-0.4238542914390564,
-0.1710633635520935,
-0.08903803676366806,
-0.03825550898909569,
-0.02704019285738468,
0.12920619547367096,
0.14111512899398804,
0.070987269282341,
0.15645098686218262,
-0.14211788773536682,
0.13686902821063995,
0.2706180512905121,
-0.104897812008... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/System_Settings#debug | Debug
Debugging settings for Pimcore, like Debug email addresses, Debug admin translations. | Debug | [
-0.2421942949295044,
-0.3514670729637146,
-0.15430490672588348,
0.1779688596725464,
0.14350499212741852,
-0.13544873893260956,
0.11404313892126083,
0.01292633917182684,
-0.3436926007270813,
0.3637082576751709,
-0.0828436017036438,
0.2492767721414566,
0.056995801627635956,
0.038442462682724... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/System_Settings#website | Website
System settings about the CMS part of Pimcore. | Website | [
-0.2541792094707489,
-0.5625522136688232,
-0.21636636555194855,
-0.13014887273311615,
0.08959440886974335,
0.0032515001948922873,
-0.0770663321018219,
-0.14763347804546356,
-0.4471079111099243,
0.11784377694129944,
-0.28883984684944153,
0.05391782522201538,
0.07936751842498779,
0.079316243... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/System_Settings#documents | Documents
Settings for documents like version steps, default values and URL settings. | Documents | [
-0.24511638283729553,
-0.33994820713996887,
-0.3057798743247986,
-0.15402375161647797,
-0.048606015741825104,
0.12037146091461182,
-0.11058881878852844,
0.1370757669210434,
-0.2685857117176056,
0.11372671276330948,
0.2254597693681717,
0.051156360656023026,
0.0075034936890006065,
0.08373845... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/System_Settings#objects | Objects
Version steps for objects. | Objects | [
-0.11559927463531494,
-0.42891380190849304,
-0.30301567912101746,
-0.0381944514811039,
-0.1978072226047516,
-0.28665846586227417,
0.07781940698623657,
0.1608368307352066,
-0.16047853231430054,
0.03464976325631142,
0.4384981691837311,
0.27619796991348267,
0.0003813468210864812,
0.0959829613... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/System_Settings#assets | Assets
Settings for assets like version steps. | Assets | [
-0.4627159833908081,
-0.4209994673728943,
-0.32070714235305786,
-0.14558042585849762,
0.1509675681591034,
-0.07947495579719543,
0.13522900640964508,
0.3365744352340698,
-0.3652494549751282,
0.09630953520536423,
0.1874902844429016,
0.026264440268278122,
-0.002267771167680621,
0.025839006528... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/System_Settings#access-system-config-in-php-controller | Access system config in PHP Controller
You can access the system configuration like in the following example:
<?php
namespace App\Controller;
use Pimcore\Controller\FrontendController;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Pimcore\SystemSettingsConfig;
class DefaultController extends FrontendController
{
public function defaultAction(Request $request, SystemSettingsConfig $config): Response
{
// use type-hinting to inject the config service
$config = $config->getSystemSettingsConfig();
$bar = $config['general']['valid_languages'];
}
}
| Access system config in PHP Controller | [
-0.45860257744789124,
-0.1590064913034439,
-0.08914939314126968,
0.17202097177505493,
0.16859377920627594,
-0.20785488188266754,
-0.07092299312353134,
0.12263254076242447,
-0.14500416815280914,
0.31237491965293884,
-0.06803737580776215,
0.20142912864685059,
0.12616634368896484,
0.152369126... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Appearance_and_Branding#appearance-&-branding | Appearance & Branding
In the appearance & branding settings (Settings > Appearance & Branding) system-wide settings for Pimcore Admin Interface can be made. Changes should
be made with care and only by developers.
These settings are saved in var/config/admin_system_settings/admin_system_settings.yaml or in the settings store based on your configuration.
To switch from the Symfony configuration to the settings store for the first time, please follow these steps:
Set your write target to settings-store:
pimcore_admin:
config_location:
admin_system_settings:
write_target:
type: 'settings-store'
Save your system settings via admin user interface (Settings > Appearance & Branding).
Set your read target to settings-store as well:
pimcore_admin:
config_location:
admin_system_settings:
write_target:
type: 'settings-store'
read_target:
type: 'settings-store'
| Appearance & Branding | [
-0.21336416900157928,
-0.214581698179245,
-0.010360517539083958,
0.14993804693222046,
0.34455713629722595,
-0.19101905822753906,
0.23123082518577576,
-0.04755374789237976,
-0.1777264028787613,
0.09845026582479477,
-0.12452780455350876,
0.2521589696407318,
0.3614848256111145,
0.191680103540... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Appearance_and_Branding#colors | Colors
Settings regarding colors of Pimcore admin interface like login screen color, Admin interface color, Admin interface background etc. | Colors | [
-0.3762611746788025,
-0.46146532893180847,
-0.1605372130870819,
0.13261373341083527,
0.16716240346431732,
-0.2791953682899475,
0.09826195985078812,
0.08159204572439194,
-0.35357508063316345,
0.09937413036823273,
-0.21563920378684998,
0.12023097276687622,
0.19973433017730713,
0.275289475917... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Appearance_and_Branding#custom-logo | Custom Logo
Settings allowing to customize the logo in Pimcore admin interface. | Custom Logo | [
-0.34073784947395325,
-0.4160696268081665,
-0.19767525792121887,
0.04358111321926117,
0.008205963298678398,
-0.20274889469146729,
0.09795773029327393,
0.022042835131287575,
-0.3019154667854309,
0.12481296807527542,
-0.15570801496505737,
0.38068294525146484,
0.12770092487335205,
0.343293428... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Appearance_and_Branding#custom-login-background-image | Custom Login Background Image
Settings allowing to customize the background image in Pimcore login screen. | Custom Login Background Image | [
-0.28654998540878296,
-0.3524777293205261,
-0.14361441135406494,
0.06419581174850464,
0.0010230281623080373,
-0.24869869649410248,
0.2931458055973053,
-0.08847647160291672,
-0.3495125472545624,
0.04177418351173401,
-0.16989631950855255,
0.052333977073431015,
0.2885268032550812,
0.226960554... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Appearance_and_Branding#assets | Assets
Settings for assets like disabling tree preview or hiding edit image tab in the admin interface. | Assets | [
-0.11308997124433517,
-0.12971484661102295,
-0.29174986481666565,
0.07192666083574295,
0.17221377789974213,
-0.2203688621520996,
-0.00872779916971922,
0.5140671133995056,
-0.17452560365200043,
0.29689615964889526,
-0.03778451681137085,
0.11711747944355011,
0.013570993207395077,
-0.10178506... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Appearance_and_Branding#access-admin-config-in-php-controller | Access admin config in PHP Controller
You can access the admin settings configuration like in the following example:
<?php
namespace App\Controller;
use Pimcore\Bundle\AdminBundle\System\AdminConfig;
use Pimcore\Controller\FrontendController;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
class DefaultController extends FrontendController
{
public function defaultAction(Request $request, AdminConfig $config): Response
{
// use type-hinting to inject the config service
$config = $config->getAdminSystemSettingsConfig();
$bar = $config['branding']['color_login_screen'];
}
}
| Access admin config in PHP Controller | [
-0.3714459240436554,
-0.22168487310409546,
-0.10384312272071838,
0.21536090970039368,
0.09218895435333252,
-0.21569176018238068,
0.00267356401309371,
0.034387096762657166,
-0.31285160779953003,
0.31794241070747375,
0.011126569472253323,
0.14858508110046387,
0.12915734946727753,
0.261420577... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Website_Settings#website-settings | Website Settings
The Website Settings give you the possibility to configure website-specific settings, which you can
access in every controller and view.
Examples:
ReCAPTCHA public & private key
Locale settings
Google Maps API key
Defaults
....
| Website Settings | [
-0.11698596924543381,
-0.27450916171073914,
-0.20238570868968964,
-0.21811001002788544,
0.23954333364963531,
-0.09374535828828812,
0.12486670911312103,
0.07825087010860443,
0.191156804561615,
0.042749181389808655,
-0.13527868688106537,
0.06803960353136063,
0.17456597089767456,
0.5108134746... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Website_Settings#access-the-settings | Access the Settings
In controllers and views, you can use view helpers or argument resolves to access the config.
The returned configuration is an array containing your settings. | Access the Settings | [
-0.31185436248779297,
-0.36799344420433044,
-0.2611634135246277,
-0.03763848543167114,
0.25083833932876587,
-0.31807681918144226,
0.19990162551403046,
0.04187306389212608,
0.03709790110588074,
0.29517900943756104,
-0.11116116493940353,
0.24204640090465546,
-0.1286747008562088,
0.0323258973... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Website_Settings#example-configuration | Example Configuration
Usage in a template:
{# access the whole configuration #}
{{ pimcore_website_config() }}
{# or only a single value #}
{{ pimcore_website_config('googleMapsKey') }}
{# you can pass a default value in case the value is not configured #}
{{ pimcore_website_config('googleMapsKey', 'NOT SET') }}
Usage in a controller:
<?php
use Symfony\Component\HttpFoundation\Response;
class TestController
{
public function testAction(array $websiteConfig): Response
{
$recaptchaKeyPublic = $websiteConfig['recaptchaPublic'];
// ...
}
}
| Example Configuration | [
-0.17325381934642792,
-0.3344067931175232,
-0.04423470422625542,
-0.1309226155281067,
-0.06974487006664276,
-0.35428541898727417,
0.1656186580657959,
-0.0604403130710125,
-0.06505053490400314,
0.23536880314350128,
-0.09090741723775864,
0.20389683544635773,
0.2625274658203125,
-0.0295714829... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Website_Settings#manipulate-the-values-in-a-controller | Manipulate the values in a Controller
If you want to change the value of a website setting from your PHP script, for example from a controller, you can use this code.
<?php
use Symfony\Component\HttpFoundation\Response;
class TestController
{
public function testAction(): Response
{
// get the "somenumber" setting for "de"
// if the property does not exist you will get the setting with not language provided
$somesetting = \Pimcore\Model\WebsiteSetting::getByName('somenumber', null, 'de');
$currentnumber = $somesetting->getData();
//Now do something with the data or set new data
//Count up in this case
$newnumber = $currentnumber + 1;
$somesetting->setData($newnumber);
$somesetting->save();
// ...
}
}
| Manipulate the values in a Controller | [
-0.25312313437461853,
-0.12015821784734726,
-0.20887528359889984,
0.12447202950716019,
0.026856083422899246,
-0.1518348604440689,
0.149769589304924,
0.049876727163791656,
-0.04571262374520302,
0.5032821297645569,
-0.02079252153635025,
-0.05069645494222641,
0.27448606491088867,
0.0868358761... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Custom_Reports#custom-reports | Custom Reports
:::caution
To use this feature, please enable the PimcoreCustomReportsBundle in your bundle.php file and install it accordingly with the following command:
bin/console pimcore:bundle:install PimcoreCustomReportsBundle
:::
Custom Reports is a report engine directly integrated into Pimcore. With Custom Reports it is possible to create tabular
or chart reports (or both) with further filtering and export functionality.
The data source for the reports is always a source adapter which is responsible for retrieving and preparing the report
data. Currently two adapters ship with Pimcore:
SQL: Retrieve Data based on a SQL statement
Google Analytics: Retrieve Data from Google Analytics only available if
Only available if the corresponding PimcoreGoogleMarketingBundle is enabled.
| Custom Reports | [
-0.46093013882637024,
-0.08313260227441788,
-0.23477236926555634,
0.21461732685565948,
-0.20424982905387878,
-0.11664590239524841,
0.1862030029296875,
0.11266599595546722,
-0.04407179355621338,
0.23054614663124084,
-0.3888589143753052,
0.36280161142349243,
0.15531045198440552,
0.4440478086... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Custom_Reports#custom-report-permissions | Custom Report Permissions
With custom report permissions it is possible to define which users should be able to see a report. Following options
are available:
Share globally: Custom report is visible to all users that have reports permission.
Visible to users: Custom report is visible to all listed users.
Visible to roles: Custom report is visible to all listed roles.
| Custom Report Permissions | [
0.024225739762187004,
-0.010384238325059414,
-0.17582891881465912,
0.015463787131011486,
-0.3929070830345154,
-0.16677948832511902,
0.3765314221382141,
0.029652001336216927,
0.05354246869683266,
0.15450674295425415,
-0.25146666169166565,
0.10408569872379303,
0.059218879789114,
0.0409880205... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Custom_Reports#custom-data-source-adapters | Custom Data Source Adapters
It is easily possible to implement custom source adapters for special use cases. To do so following steps are necessary:
JavaScript Class: This class defines the user interface in the configuration of the custom report. It has to be located in
the namespace pimcore.bundle.customreports.custom.definition, named like the adapter (e.g. pimcore.report.custom.definition.mySource)
and implement the methods initialize, getElement and getValues. As sample see sql.js
PHP Adapter Class: This class is the server side implementation of the adapter. It is responsible for retrieving and preparing the options, columns and data. It has to extend the abstract class Pimcore\Model\Tool\CustomReport\Adapter\AbstractAdapter (or implement Pimcore\Model\Tool\CustomReport\Adapter\CustomReportAdapterInterface). As examples see Analytics adapter and Sql adapter.
Register your Adapter Factory as Service
If you are using a simple adapter class without dependency injection parameters, you can use the DefaultCustomReportAdapterFactory providing the adapter class' FQN as single argument
app.custom_report.adapter.factory.custom:
class: Pimcore\Bundle\CustomReportsBundle\Tool\Adapter\DefaultCustomReportAdapterFactory
arguments:
- 'App\CustomReport\Adapter\Custom'
If you are using a more complex adapter, you can create your own factory by implementing the interface Pimcore\Bundle\CustomReportsBundle\Tool\Adapter\CustomReportAdapterFactoryInterface
Add your Adapter Factory to the configuration:
pimcore_custom_reports:
adapters:
myAdapter: app.custom_report.adapter.factory.custom
| Custom Data Source Adapters | [
-0.45972272753715515,
-0.044295623898506165,
-0.08001019805669785,
0.07281424105167389,
-0.06911403685808182,
-0.23782220482826233,
0.2849004566669464,
0.06120239570736885,
0.039087049663066864,
0.2374052256345749,
-0.21199683845043182,
0.637806236743927,
0.165848970413208,
0.5043979883193... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Custom_Reports#custom-js-class-for-report-visualization | Custom JS Class for Report Visualization
If you need to fully customize the appearance of the report, you can specify a custom java script class that should
be used when opening the report in Pimcore Backend. This class can be specified in Report Class option and should extend
the default java script class for the reports which is pimcore.bundle.customreports.custom.report. | Custom JS Class for Report Visualization | [
-0.2747158408164978,
-0.056910332292318344,
-0.10984889417886734,
-0.08496075123548508,
-0.061716478317976,
-0.1938503086566925,
0.02346017397940159,
0.23615428805351257,
-0.18962067365646362,
0.23713481426239014,
-0.2053433656692505,
0.7208792567253113,
0.41893288493156433,
0.448564380407... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Rendering_PDFs#rendering-pdfs | Rendering PDFs
Instead of directly returning the HTML code of your website you could also return a PDF version.
You can use the PimcoreWebToPrintBundle functionality to accomplish this.
Please make sure that you have set up and installed the PimcoreWebToPrintBundle correctly ("Settings" -> "Web2Print Settings").
You need to enable and install the PimcoreWebToPrintBundle via the bundles.php, and then you
just have to provide the correct settings (Tool -> PDFreactor / Chromium / Gotenberg) and the corresponding settings.
In your controller you just have to return the PDF instead of the HTML. | Rendering PDFs | [
-0.22485120594501495,
-0.30627256631851196,
-0.1639537215232849,
0.022790031507611275,
-0.07831978797912598,
-0.13586311042308807,
0.11247506737709045,
0.5599824786186218,
-0.17290039360523224,
0.1200987845659256,
-0.11993718892335892,
0.4749509394168854,
0.005899110808968544,
0.4093131124... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Rendering_PDFs#simple-example | Simple example
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
class BlogController extends FrontendController
{
public function indexAction(Request $request): Response
{
//your custom code....
//return the pdf
$html = $this->renderView(':Blog:index.html.php', [
'document' => $this->document,
'editmode' => $this->editmode,
]);
return new Response(
\Pimcore\Bundle\WebToPrintBundle\Processor::getInstance()->getPdfFromString($html),
200,
array(
'Content-Type' => 'application/pdf',
)
);
}
| Simple example | [
-0.10204248130321503,
-0.3121013045310974,
-0.13217845559120178,
0.13084250688552856,
-0.011597349308431149,
-0.18123219907283783,
0.001188669353723526,
0.47127261757850647,
-0.06173035129904747,
0.24717064201831818,
-0.3578560948371887,
0.4281856119632721,
0.17617389559745789,
0.114479273... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Rendering_PDFs#advanced-example | Advanced example
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
class BlogController extends FrontendController
{
public function indexAction(Request $request): Response
{
//your custom code....
//return the pdf
$params = [
'document' => $this->document,
'editmode' => $this->editmode,
];
$params['testPlaceholder'] = ' :-)';
$html = $this->renderView(':Blog:index.html.php', $params);
$adapter = \Pimcore\Bundle\WebToPrintBundle\Processor::getInstance();
//add custom settings if necessary
if ($adapter instanceof \Pimcore\Bundle\WebToPrintBundle\Processor\PdfReactor) {
//Config settings -> http://www.pdfreactor.com/product/doc/webservice/php.html#Configuration
$params['adapterConfig'] = [
'author' => 'Max Mustermann',
'title' => 'Custom Title',
'javaScriptMode' => 0,
'addLinks' => true,
'appendLog' => true,
'enableDebugMode' => true
];
} elseif ($adapter instanceof \Pimcore\Bundle\WebToPrintBundle\Processor\Gotenberg) {
$params = Config::getWeb2PrintConfig();
$params = json_decode($params['gotenbergSettings'], true) ?: [];
} elseif ($adapter instanceof \Pimcore\Bundle\WebToPrintBundle\Processor\Chromium) {
$params = Config::getWeb2PrintConfig();
$params = json_decode($params['chromiumSettings'], true) ?: [];
}
return new Response(
$adapter->getPdfFromString($html, $params),
200,
array(
'Content-Type' => 'application/pdf',
// 'Content-Disposition' => 'attachment; filename="custom-pdf.pdf"' //direct download
)
);
}
| Advanced example | [
-0.010229558683931828,
-0.15738153457641602,
-0.17880256474018097,
0.10460259765386581,
0.012905487790703773,
-0.25903308391571045,
0.21495364606380463,
0.44606301188468933,
-0.02092534489929676,
0.3080507814884186,
-0.15957549214363098,
0.23922842741012573,
0.2077558934688568,
0.036249663... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Cloning Elements#cloning-elements | Cloning Elements
Use
$new = Pimcore\Model\Element\Service::cloneMe($source)
to get a safe copy of the original element (everything that implements ElementInterface).
Note that this will not update any internal references.
For example:
A relation inside the source element pointing to the source element will still reference the source element in the copy.
If you want to get a persistent copy use the copyAsChildmethod of the corresponding service.
E.g.
$user = \Pimcore\Model\User::getById(123);
$assetService = new \Pimcore\Model\Asset\Service($user);
$assetService->copyAsChild($target, $source);
$documentService = new \Pimcore\Model\Document\Service($user);
$documentService->copyAsChild($target, $source); // additional arguments are available for inheritance, ...
$objectService = new \Pimcore\Model\DataObject\Service($user);
$objectService->copyAsChild($target, $source);
where $sourceis the source element and $target the parent element of the new element.
This will also create a unique element key (or filename for asset elements).
If you also want to update the references there is a helper method which accomplishes this for you.
Just call the service's rewriteIds and provide a mapper config.
Example:
$rewriteConfig = array(
"object" => array(
176 => 190
)
);
$object = DataObject\Service::rewriteIds($object, $rewriteConfig);
meaning that in the copy everything point to object with ID 176 will be replaced with a reference pointing to object 190. | Cloning Elements | [
-0.31372764706611633,
0.1849345862865448,
-0.13741415739059448,
-0.04216042906045914,
-0.06742594391107559,
-0.31921491026878357,
0.3295385539531708,
0.28695911169052124,
-0.1024615466594696,
0.24723151326179504,
-0.42401859164237976,
0.3327157497406006,
0.17948830127716064,
0.000132878805... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Permission_Analyzer#permission-analyzer | Permission Analyzer
Allows you to drop an element (plus optionally a user) and display the calculated workspace permissions.
If no user is specified this is done for all users.
In addition, the general user permissions can be displayed.
When you expand a result row you will see a detailed overview which tells you which rule (path, user or role and which one)
has been applied.
How to launch it:
How it looks like:
| Permission Analyzer | [
-0.2194172441959381,
-0.08780626207590103,
-0.15660536289215088,
0.11244869232177734,
-0.44524073600769043,
-0.09969056397676468,
0.36620137095451355,
0.17693161964416504,
0.0010622813133522868,
0.4263341426849365,
-0.1652524769306183,
0.13242857158184052,
-0.5489262342453003,
0.0598229132... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/GDPR_Data_Extractor#gdpr-data-extractor | GDPR Data Extractor
The GDPR Data Extractor is a tool that helps the user to full fill the right of access by the data subject and helps to
export data that is stored for a specific person in different data sources like data objects, sent mails, Pimcore backend user, etc.
| GDPR Data Extractor | [
-0.162564218044281,
0.01769300363957882,
-0.12782913446426392,
0.5201888680458069,
-0.3294534981250763,
-0.19548693299293518,
0.055365730077028275,
-0.09256306290626526,
-0.20650148391723633,
0.25532522797584534,
-0.020854081958532333,
0.12483742088079453,
-0.028485003858804703,
0.24676491... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/GDPR_Data_Extractor#configuration | Configuration
Via the configuration, following options can be set to modify the behaviour of the Data Extractor:
What data object classes should be included (e.g. exclude data object classes without personal information like products)
What relation attributes should included recursively into the data export (e.g. include order items into export of orders)
Allow deletion of data object directly in result view
For Details see configuration reference as follows:
# Default configuration for "PimcoreAdminBundle"
pimcore_admin:
gdpr_data_extractor:
# Settings for DataObjects DataProvider
dataObjects:
# Configure which classes should be considered, array key is class name
classes:
# Prototype:
# MY_CLASS_NAME:
# include: true
# allowDelete: false
# includedRelations:
# - manualSegemens
# - calculatedSegments
#
-
# Set if class should be considered in export.
include: true
# Allow delete of objects directly in preview grid.
allowDelete: false
# List relation attributes that should be included recursively into export.
includedRelations: []
Pimcore ships with a reasonable default configuration. By using it, all data object classes are considered in the search,
export concludes all attributes directly attached to the data object (no relations) and allows deletion of the data objects
directly in the result list.
Please note: The GDPR search will be very limited if haven`t installed the simpleBackendSearchBundle!
| Configuration | [
-0.15379437804222107,
0.30617019534111023,
-0.1568756252527237,
0.359046071767807,
-0.08812005072832108,
-0.49948379397392273,
-0.032477665692567825,
0.024768512696027756,
-0.2426919937133789,
0.19175198674201965,
-0.42334744334220886,
0.42510879039764404,
0.029014553874731064,
0.310163676... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/GDPR_Data_Extractor#extending-gdpr-data-extractor-with-custom-data-sources | Extending GDPR Data Extractor with Custom Data Sources
It is possible to attach additional data sources to the GDPR Data Extractor with Pimcore Bundles. Thereby specific data
exports can be attached or external data sources can be included.
To do so, following steps are necessary:
Create a custom implementation of
Pimcore\Bundle\AdminBundle\GDPR\DataProvider\DataProviderInterface.
The following functions need to be implemented:
getSortPriority() - Returns sort priority for the tabs - higher is sorted first.
getName() - Returns the name of the data provider.
getJsClassName() - Returns the name of the JavaScript class implementation for frontend presentation.
Implement the specified JavaScript class with all the user interface with following restrictions:
The constructor gets the current searchParams as parameter.
It needs to have a function getPanel() that returns a Ext.Panel.
Register your custom implementation as service. The service needs to be tagged with the tag pimcore.gdpr.data-provider.
If you're using autoconfiguration this will be automatically done for you, otherwise you need to specify the tag in
your service definition:
# either enable autoconfigure as _defaults (or only for your service)
services:
_defaults:
autoconfigure: true
public: false
App\GDPR\DataProvider\MyCustomDataProvider: ~
# or specify the tag manually if not using autoconfiguration
services:
_defaults:
public: false
App\GDPR\DataProvider\MyCustomDataProvider:
tags:
- { name: pimcore.gdpr.data-provider }
For an example see the implementation for the customers data provider
in our customer management framework. | Extending GDPR Data Extractor with Custom Data Sources | [
-0.19258812069892883,
0.11020568758249283,
-0.1348678171634674,
0.15641459822654724,
-0.13879622519016266,
-0.291413813829422,
0.22235189378261566,
0.03596211597323418,
0.049827806651592255,
0.16804653406143188,
-0.41211462020874023,
0.40964046120643616,
0.2521713078022003,
0.4997040927410... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Robots.txt#robots.txt | Robots.txt
:::caution
To use this feature, please enable the PimcoreSeoBundle in your bundle.php file and install it accordingly with the following command:
bin/console pimcore:bundle:install PimcoreSeoBundle
:::
Robots.txt files can be generated on a per-site basis.
By default, if a robots.txt file is not configured for a given site, the following is generated upon robots.txt being requested:
User-agent: *
Disallow:
Alternatively, you can still manually create a robots.txt file by putting them into the document root, this will
override all robots.txt settings made within the Pimcore admin interface. | Robots.txt | [
-0.11561311036348343,
-0.24678243696689606,
-0.18169353902339935,
-0.2370016872882843,
0.1246708482503891,
-0.31705403327941895,
0.32646283507347107,
0.11989884078502655,
-0.07301973551511765,
0.1960199475288391,
-0.1151445284485817,
0.31808003783226013,
-0.1619659811258316,
-0.03590288013... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Sitemaps#sitemaps | Sitemaps
:::caution
To use this feature, please enable the PimcoreSeoBundle in your bundle.php file and install it accordingly with the following command:
bin/console pimcore:bundle:install PimcoreSeoBundle
:::
Pimcore includes the presta/sitemap-bundle which adds a simple,
yet powerful API to generate XML sitemaps. Have a look at the bundle documentation on details how the bundle works and how
you can add sitemaps to it. The bundle exposes a way to add sitemap entries by firing an event
which you can handle to add entries to an UrlContainerInterface. For simple scenarios, you can directly implement such
an event handler and start to add entries. | Sitemaps | [
-0.31662717461586,
-0.18323194980621338,
-0.16558556258678436,
0.10280635207891464,
-0.04327632114291191,
-0.09224855154752731,
0.14014558494091034,
-0.03302737697958946,
0.007506353314965963,
0.13981348276138306,
-0.12384078651666641,
0.5118376016616821,
-0.17329266667366028,
0.0819659903... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Sitemaps#exposing-sitemaps | Exposing Sitemaps
Sitemaps can either be exposed by being generated on-the-fly or by being dumped to static files. What to use depends on the size
of your site (e.g. the size of the tree which needs to be processed). In general it's recommended to create static files
as it reduces the overhead of creating the sitemap on every crawler request. If you want to serve the sitemap directly,
you need to register the sitemaps routes in your routing config (see PrestaSitemapBundle Documentation
for details).
PrestaSitemapBundle:
resource: "@PrestaSitemapBundle/config/routing.yaml"
prefix: /
After the route is registered, you should be able to access your sitemaps via /sitemap.xml and /sitemap.<section>.xml.
To dump the sitemaps to static files, use the presta:sitemaps:dump command:
$ bin/console presta:sitemaps:dump
Dumping all sections of sitemaps into public directory
Created/Updated the following sitemap files:
sitemap.default.xml
sitemap.xml
| Exposing Sitemaps | [
-0.17641685903072357,
-0.2244102656841278,
-0.06450261920690536,
0.02235124632716179,
0.014797613024711609,
-0.12856067717075348,
0.16465038061141968,
-0.05663880705833435,
0.10775476694107056,
0.12373664975166321,
-0.20827212929725647,
0.3280858099460602,
-0.1131022498011589,
0.0051046181... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Sitemaps#configuring-the-scheme-and-host-to-be-used-by-sitemaps | Configuring the scheme and host to be used by sitemaps
As the command-line context does not know what scheme (http/https) and host to use for the absolute URLs of your sitemap,
those values need to be configured. Symfony allows to set those parameters on the Request Context.
If configured, Pimcore will set the domain configured as main domain in system settings as default host. Those parameters
will be overridden from the current request in the web context when using the on-the-fly method by adding the route. When
using the presta:sitemaps:dump command, you can override those parameters by passing the --base-url option:
$ bin/console presta:sitemaps:dump --base-url=https://pimcore.com/
For details see:
Bundle Documentation
Symfony Documentation on the Request Context
UrlGenerator
| Configuring the scheme and host to be used by sitemaps | [
-0.19278226792812347,
-0.21748816967010498,
0.06282036006450653,
-0.12988021969795227,
-0.004179735668003559,
-0.21804222464561462,
0.31410250067710876,
-0.03312556445598602,
-0.13036774098873138,
0.21612629294395447,
-0.2737341821193695,
0.29860982298851013,
0.27112871408462524,
-0.103685... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Sitemaps#sitemap-generators | Sitemap Generators
Pimcore adds a way to hook one or more generators into the sitemap generation process. Such generators can be registered,
ordered by priority and enabled/disabled via config. The basic generator interface defines a single populate() method
which is expected to add entries to the URL container:
<?php
namespace Pimcore\Sitemap;
use Presta\SitemapBundle\Service\UrlContainerInterface;
interface GeneratorInterface
{
/**
* Populates the sitemap
*/
public function populate(UrlContainerInterface $urlContainer, string $section = null): void;
}
When the sitemap bundle fires its SitemapPopulateEvent::ON_SITEMAP_POPULATE event, Pimcore will iterate through every
registered generator and call the populate() method. To make a generator available to the event handler, it needs to be
registered via config. generator_id in the config below references a generator which was previously registered
as service. As you can see, generators can be enabled/disabled and ordered by priority.
pimcore:
sitemaps:
generators:
app_news:
enabled: true
priority: 50
generator_id: App\Sitemaps\NewsGenerator
# Pimcore ships a default document tree generator which is enabled by default
# but you can easily disable it here.
pimcore_documents:
enabled: false
| Sitemap Generators | [
-0.13209953904151917,
-0.045403048396110535,
-0.0896301344037056,
-0.0010542151285335422,
-0.18290069699287415,
-0.20612654089927673,
0.04538421332836151,
-0.08772500604391098,
-0.20464575290679932,
0.27977439761161804,
-0.0006534993299283087,
0.4987015426158905,
-0.10584548115730286,
-0.0... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Sitemaps#element-sitemap-generators | Element Sitemap Generators
For more advanced use cases involving Pimcore models, Pimcore defines an AbstractElementGenerator which is extendable
via pluggable filters and processors. This makes it possible to define reusable behaviour in a filter/processor which can
be used from multiple generators. A filter determines if an element can be added to the sitemap and if it is able to handle children (it's up to the
generator to query for this information). For example the PropertiesFilter
excludes elements with a property sitemaps_exclude. A processor can enhance an entry before it is added to the container. For example, the ModificationDateProcessor
adds the modification date of an element to the url.
Which filters and processors to use can be defined on the generator level. For example, the DocumentTreeGenerator
which is enabled by default is defined as follows:
services:
Pimcore\Sitemap\Document\DocumentTreeGenerator:
arguments:
$filters:
- '@Pimcore\Sitemap\Element\Filter\PublishedFilter'
- '@Pimcore\Sitemap\Element\Filter\PropertiesFilter'
- '@Pimcore\Sitemap\Document\Filter\DocumentTypeFilter'
- '@Pimcore\Sitemap\Document\Filter\SiteRootFilter'
$processors:
- '@Pimcore\Sitemap\Element\Processor\ModificationDateProcessor'
- '@Pimcore\Sitemap\Element\Processor\PropertiesProcessor'
If you need to influence the behaviour of the document tree sitemap either overwrite the core service definition or define
your own generator service and hook it into the config (see above). By selecting which filters and processors to use you
can change and enhance the behavior of the generator. Pimcore defines a set of standard implementations which are defined
as service and can directly be consumed.
Filter
Description
Pimcore\Sitemap\Element\Filter\PropertiesFilter
Excludes elements with the boolean property sitemaps_exclude set to true and excludes children handling of elements with the boolean property sitemaps_exclude_children set to true.
Pimcore\Sitemap\Element\Filter\PublishedFilter
Excludes unpublished elements.
Pimcore\Sitemap\Document\Filter\DocumentTypeFilter
Used by the DocumentTreeGenerator. Excludes documents not matching the list of defined types and handles children only for defined types.
Pimcore\Sitemap\Document\Filter\SiteRootFilter
Used by the DocumentTreeGenerator. Excludes documents which are root documents of a site when the currently processed site doesn't match the document. E.g. if a document is a site root and the main site is currently processed, it will be excluded for the main site, but later be used for the actual site.
Processor
Description
Pimcore\Sitemap\Element\Processor\ModificationDateProcessor
Adds the modification date of an element as lastmod property.
Pimcore\Sitemap\Element\Processor\PropertiesProcessor
Reads the properties sitemaps_changefreq and sitemaps_priority if set on the element and adds them to the sitemap entry to easily set those properties on an element level.
| Element Sitemap Generators | [
-0.054527539759874344,
0.030296847224235535,
-0.14464537799358368,
-0.07019087672233582,
-0.16256414353847504,
-0.2920556366443634,
0.10531806200742722,
0.0033105071634054184,
-0.02824728935956955,
0.23590637743473053,
-0.11463259905576706,
0.47197121381759644,
-0.10454855114221573,
0.1744... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Sitemaps#the-documenttreegenerator | The DocumentTreeGenerator
Pimcore ships a default generator for documents implemented in DocumentTreeGenerator.
This generator iterates the whole document tree and adds entries for every document while taking care of handling sites and
hardlinks. It uses the the host names configured as main/site domain and falls back to the request context host by using
the url generator service. You can either disable the default generator completely as shown in the example above or define your own service using the
DocumentTreeGenerator class with your own filters/processors. The default service definition can be found in
sitemaps.yaml in the CoreBundle. | The DocumentTreeGenerator | [
-0.02898245118558407,
-0.2736891210079193,
-0.007619587704539299,
0.07382534444332123,
-0.08659229427576065,
-0.11643841862678528,
-0.1516796201467514,
0.08927837014198303,
-0.14535927772521973,
0.1744823455810547,
-0.24187375605106354,
0.35955074429512024,
0.11484264582395554,
-0.13482038... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Sitemaps#creating-a-custom-generator | Creating a custom generator
To create your own generator, start by implementing the GeneratorInterface. In this section we'll extend the
AbstractElementGenerator to create entries for Pimcore models. A generator to add BlogArticle entries to the sitemap
could look like the following:
<?php
namespace App\Sitemaps;
use Pimcore\Model\DataObject\BlogArticle;
use Pimcore\Sitemap\Element\AbstractElementGenerator;
use Pimcore\Sitemap\Element\GeneratorContext;
use Presta\SitemapBundle\Service\UrlContainerInterface;
use Presta\SitemapBundle\Sitemap\Url\UrlConcrete;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
class BlogGenerator extends AbstractElementGenerator
{
public function populate(UrlContainerInterface $urlContainer, string $section = null): void
{
if (null !== $section && $section !== 'blog') {
// do not add entries if section doesn't match
return;
}
$section = 'blog';
$list = new BlogArticle\Listing();
$list->setOrderKey('date');
$list->setOrder('DESC');
// the context contains metadata for filters/processors
// it contains at least the url container, but you can add additional data
// with the params parameter
$context = new GeneratorContext($urlContainer, $section, ['foo' => 'bar']);
/** @var BlogArticle $blogArticle */
foreach ($list as $blogArticle) {
// only add element if it is not filtered
if (!$this->canBeAdded($blogArticle, $context)) {
continue;
}
// use a link generator to generate an URL to the article
// you need to make sure the link generator generates an absolute url
$link = $blogArticle->getClass()->getLinkGenerator()->generate($blogArticle, [
'referenceType' => UrlGeneratorInterface::ABSOLUTE_URL
]);
// create an entry for the sitemap
$url = new UrlConcrete($link);
// run url through processors
$url = $this->process($url, $blogArticle, $context);
// processors can return null to exclude the url
if (null === $url) {
continue;
}
// add the url to the container
$urlContainer->addUrl($url, $section);
}
}
}
The AbstractElementGenerator exposes the methods canBeAdded() and process() to run the entry through filters and
processors. If you handle nested tree structures, you can also use handlesChildren() to test if children should be
handled. All 3 methods accept a GeneratorContextInterface object which you can use to pass context metadata to filters
and processors. For example, the DocumentTreeProcessor uses the context to define the site the document lives in.
In the example above, the URL is created by using a Link Generator.
It's important that your link generator is able to generate an absolute URL for the given object. Above is only an example, but
you can have a look at the demo
for a working example building sitemap entries for News objects.
After creating the generator, register it as service and add it to the config. Use filters and processors to reuse already
implemented behaviour.
# services.yaml
services:
_defaults:
autowire: true
autoconfigure: true
public: false
App\Sitemaps\BlogGenerator:
arguments:
$filters:
- '@Pimcore\Sitemap\Element\Filter\PublishedFilter'
- '@Pimcore\Sitemap\Element\Filter\PropertiesFilter'
$processors:
- '@Pimcore\Sitemap\Element\Processor\ModificationDateProcessor'
- '@Pimcore\Sitemap\Element\Processor\PropertiesProcessor'
Make the generator available to the core listener by registering it on the configuration:
# config.yaml
pimcore:
sitemaps:
generators:
app_blog:
generator_id: App\Sitemaps\BlogGenerator
| Creating a custom generator | [
-0.11209769546985626,
0.18180526793003082,
-0.05666695162653923,
-0.025122666731476784,
0.018124191090464592,
-0.19446374475955963,
0.15333183109760284,
0.030155178159475327,
-0.05078030377626419,
0.1339726746082306,
-0.037706490606069565,
0.6028630137443542,
-0.16885092854499817,
-0.11330... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Sitemaps#creating-a-custom-filter | Creating a custom filter
Filters can be created by implementing the FilterInterface. An example filter excluding any element with a modification
date older than a year could look like the following:
<?php
namespace App\Sitemaps\Filter;
use Pimcore\Model\Element\ElementInterface;
use Pimcore\Sitemap\Element\FilterInterface;
use Pimcore\Sitemap\Element\GeneratorContextInterface;
class AgeFilter implements FilterInterface
{
private int $maxYears;
public function __construct(int $maxYears = 1)
{
$this->maxYears = $maxYears;
}
public function canBeAdded(ElementInterface $element, GeneratorContextInterface $context): bool
{
$modicationDate = \DateTimeImmutable::createFromFormat('U', (string)$element->getModificationDate());
$now = new \DateTimeImmutable();
$diff = $modicationDate->diff($now);
// exclude element if years is more than the configured amount
return $diff->y < $this->maxYears;
}
public function handlesChildren(ElementInterface $element, GeneratorContextInterface $context): bool
{
// not matching the age constraint does not mean not handling children
return true;
}
}
Now you can define the filter as service and use it in your generators:
services:
_defaults:
autowire: true
autoconfigure: true
public: false
App\Sitemaps\Filter\AgeFilter: ~
App\Sitemaps\BlogGenerator:
arguments:
$filters:
- '@App\Sitemaps\Filter\AgeFilter'
| Creating a custom filter | [
-0.30688977241516113,
0.11166103929281235,
-0.18597659468650818,
-0.13161452114582062,
-0.10606412589550018,
-0.2857759892940521,
0.20884987711906433,
0.1289435476064682,
0.167297825217247,
0.09095258265733719,
-0.033420730382204056,
0.23781011998653412,
-0.16295012831687927,
0.05619997531... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Sitemaps#creating-a-custom-processor | Creating a custom processor
Creating a processor is very similar to creating a filter. As example, let's create a processor which adds a random priority
to each entry.
<?php
namespace App\Sitemaps\Processor;
use Pimcore\Model\Element\ElementInterface;
use Pimcore\Sitemap\Element\GeneratorContextInterface;
use Pimcore\Sitemap\Element\ProcessorInterface;
use Presta\SitemapBundle\Sitemap\Url\Url;
use Presta\SitemapBundle\Sitemap\Url\UrlConcrete;
class RandomPriorityProcessor implements ProcessorInterface
{
public function process(Url $url, ElementInterface $element, GeneratorContextInterface $context): Url
{
if ($url instanceof UrlConcrete) {
$url->setPriority(rand(0, 10) / 10);
}
// important: return an Url instance to be added. if your
// processor returns null it will be omitted.
return $url;
}
}
It's important that a processor returns an Url instance as otherwise it will be omitted. You can use this in your own
processors to apply some kind of filtering on the processor level or to return a different instance from your processor.
A typical use case would be to use an Url Decorator
in a processor and to return its instance instead of the original Url.
Again, define it as service and start using it from your generators:
services:
_defaults:
autowire: true
autoconfigure: true
public: false
App\Sitemaps\Processor\RandomPriorityProcessor: ~
App\Sitemaps\BlogGenerator:
arguments:
$processors:
- '@App\Sitemaps\Processor\RandomPriorityProcessor'
| Creating a custom processor | [
0.07218996435403824,
0.025097517296671867,
-0.18619242310523987,
-0.10758422315120697,
-0.24286937713623047,
-0.24283745884895325,
0.05759253725409508,
-0.006540336180478334,
0.1279597282409668,
0.4185669720172882,
0.18260422348976135,
0.4082367718219757,
-0.23772941529750824,
0.0564610622... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Sitemaps#generating-absolute-urls | Generating absolute URLs
To generate absolute URLs, Pimcore defines an url generator which, given a path, takes care of creating an absolute URL
based on the Request Context.
See core processors/generators and demo
for details. As example how to use the URL generator in a processor:
<?php
namespace App\Sitemaps\Processor;
use Pimcore\Model\Element\ElementInterface;
use Pimcore\Sitemap\Element\GeneratorContextInterface;
use Pimcore\Sitemap\Element\ProcessorInterface;
use Pimcore\Sitemap\UrlGeneratorInterface;
use Presta\SitemapBundle\Sitemap\Url\Url;
use Presta\SitemapBundle\Sitemap\Url\UrlConcrete;
class RandomPathProcessor implements ProcessorInterface
{
private UrlGeneratorInterface $urlGenerator;
public function __construct(UrlGeneratorInterface $urlGenerator)
{
$this->urlGenerator = $urlGenerator;
}
public function process(Url $url, ElementInterface $element, GeneratorContextInterface $context): UrlConcrete
{
$path = $this->urlGenerator->generateUrl('/foo/bar');
$url = new UrlConcrete($path);
return $url;
}
}
| Generating absolute URLs | [
0.02923257276415825,
-0.15106675028800964,
-0.10050424933433533,
-0.2015884965658188,
-0.2421746402978897,
-0.43538421392440796,
-0.17480769753456116,
0.018617477267980576,
-0.34734654426574707,
0.3075183928012848,
0.07541023939847946,
0.41190671920776367,
-0.0635032132267952,
-0.179101973... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Two_Factor_Authentication#two-factor-authentication | Two Factor Authentication
since build 256
Pimcore has an integrated two factor authentication using the Google Authenticator (Android, iOS) | Two Factor Authentication | [
-0.1740262359380722,
-0.13337457180023193,
-0.27194374799728394,
-0.23369093239307404,
0.009646769613027573,
-0.42946410179138184,
0.3955879509449005,
-0.2490633875131607,
-0.09258218109607697,
0.10659605264663696,
-0.21953482925891876,
0.019838765263557434,
0.27626532316207886,
0.33293363... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Two_Factor_Authentication#user-setup | User Setup
By default every user can enable or disable their two factor authentication freely in the profile settings.
(Settings -> My Profile)
After enabling it a secret will be generated and you can setup your Google Authenticator App.
Please be aware if you don't setup the App properly you will loose access to your account!
After reloading you will be prompt to enter the verification code for the first time.
| User Setup | [
0.22029566764831543,
-0.09500277787446976,
-0.096621073782444,
-0.11626990884542465,
0.09052107483148575,
-0.03702091425657272,
0.47629475593566895,
-0.4847487211227417,
0.12080506980419159,
0.36250242590904236,
-0.0024965766351670027,
-0.25644543766975403,
0.20682846009731293,
0.197682753... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Two_Factor_Authentication#admin-setup | Admin Setup
It is also possible to force users to use two factor authentication. This can be done in the Users menu by checking 'Two Factor Authentication required'.
(Settings -> Users / Roles -> Users)
If this is enabled the user will have to setup two factor authentication and cannot disable it anymore. | Admin Setup | [
-0.1335943043231964,
-0.0936909094452858,
-0.079441599547863,
-0.20416462421417236,
0.12193207442760468,
-0.07669021189212799,
0.5876785516738892,
-0.13897912204265594,
0.1685745120048523,
0.36087751388549805,
-0.002994820009917021,
-0.08956350386142731,
0.09031601250171661,
0.028419544920... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Two_Factor_Authentication#config | Config
If you want to change the default name / description that is displayed in the app you can do this by overwriting the following config:
scheb_two_factor:
google:
server_name: Pimcore # Server name used in QR code
issuer: Pimcore 2 Factor Authentication # Issuer name used in QR code
| Config | [
0.18485112488269806,
-0.2560906708240509,
-0.06399884819984436,
-0.2576231062412262,
0.2727054953575134,
-0.29095351696014404,
0.403499573469162,
-0.09429594874382019,
-0.20000222325325012,
0.22455334663391113,
0.06190839037299156,
0.20959623157978058,
0.4281274974346161,
0.574672281742096... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Notifications#notifications | Notifications
Feature allows to send notifications to user. Notifications adds to status bar new clickable icon, on click it opens new tab with all notifications, also it contains badge with unread notifications count.
When there's new notification for user, it shows as window with possibility to close it, mark as read or open details.
User can use Share via Notifications button in order to open a new notification window and pre-fill the attachment field with desired element.
| Notifications | [
-0.005964257754385471,
-0.5516860485076904,
-0.15230128169059753,
0.01962299458682537,
-0.3014277517795563,
-0.13359476625919342,
0.3594156801700592,
0.2140086144208908,
0.05163950473070145,
0.21826303005218506,
-0.22399018704891205,
-0.1058916300535202,
-0.0862472876906395,
0.266336470842... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Notifications#working-with-notifications-via-api | Working with Notifications via API | Working with Notifications via API | [
0.1488901674747467,
-0.26468461751937866,
-0.2825719714164734,
0.10682222992181778,
0.06786998361349106,
-0.3251386284828186,
0.263120174407959,
-0.08538884669542313,
0.0186392143368721,
0.24642853438854218,
0.17754623293876648,
0.18728326261043549,
-0.22764705121517181,
0.0372658409178257... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Notifications#overview | Overview
For accessing and working with tags via API, take a look into Pimcore\Model\Notification\Service\NotificationService.
<?php
/**
* @param int $id
* @return Notification
* @throws \UnexpectedValueException
*/
public function find(int $id): Notification
{
$notification = Notification::getById($id);
if (!$notification instanceof Notification) {
throw new \UnexpectedValueException("Notification with the ID {$id} doesn't exists");
}
return $notification;
}
/**
* @param array $filter
* @param array $options
* @return array
*/
public function findAll(array $filter = [], array $options = []): array
{
$listing = new Listing();
if (!empty($filter)) {
$condition = implode(' AND ', array_keys($filter));
$conditionVariables = array_values($filter);
$listing->setCondition($condition, $conditionVariables);
}
$listing->setOrderKey('creationDate');
$listing->setOrder('DESC');
$offset = (int) $options['offset'] ?? 0;
$limit = (int) $options['limit'] ?? 0;
$this->beginTransaction();
$result = [
'total' => $listing->count(),
'data' => $listing->getItems($offset, $limit)
];
$this->commit();
return $result;
}
If you want to send some notifications to user:
<?php
use Pimcore\Model\Notification\Service\NotificationService;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
public function defaultAction(
Request $request,
NotificationService $notificationService
): Response {
$element = Asset::getById(1); // Optional
$notificationService->sendToUser(
4, // User recipient
2, // User sender 0 - system
'Example notification',
'Example message',
$element // Optional linked element
);
// ...
}
If you want to send some notifications to users from group:
<?php
use Pimcore\Model\Notification\Service\NotificationService;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
public function defaultAction(
Request $request,
NotificationService $notificationService
): Response {
$element = Asset::getById(1); // Optional
$notificationService->sendToGroup(
4, // Group recipient
2, // User sender 0 - system
'Example notification',
'Example message',
$element // Optional linked element
);
// ...
}
| Overview | [
0.009202372282743454,
-0.08382512629032135,
-0.1710636168718338,
0.2854631245136261,
0.08334851264953613,
-0.3159140348434448,
0.36112236976623535,
0.038201287388801575,
-0.03162064403295517,
0.3465801179409027,
-0.20690466463565826,
0.22168271243572235,
-0.06341978162527084,
0.08988201618... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Notifications#configuration | Configuration
The configuration allows enabling/disabling the Notifications menu in the toolbar
and the check of new notifications (url: /admin/notification/find-last-unread).
It is done in the pimcore_admin configuration in the notifications section.
default:
pimcore_admin:
notifications:
enabled: true
check_new_notification:
enabled: true
interval: 30
| Configuration | [
-0.1767878532409668,
-0.4836049973964691,
-0.09293217957019806,
-0.024937639012932777,
0.01541530154645443,
-0.2156529575586319,
-0.010457987897098064,
-0.08493687212467194,
-0.20694810152053833,
0.23174746334552765,
-0.2869172990322113,
0.19867496192455292,
-0.2043999582529068,
-0.0549182... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features/Notifications#example-configurations: | Example configurations:
Disable notifications menu and check of new unread notifications:
pimcore_admin:
notifications:
enabled: false
Disable only the check of new unread notifications:
pimcore_admin:
notifications:
check_new_notification:
enabled: false
Change interval to fetch new unread notifications (in seconds):
pimcore_admin:
notifications:
check_new_notification:
interval: 60
| Example configurations: | [
-0.2711537778377533,
-0.4496738314628601,
-0.15111416578292847,
0.009911919012665749,
-0.028591042384505272,
-0.28506091237068176,
0.07537167519330978,
-0.094490647315979,
-0.24570520222187042,
0.30351799726486206,
-0.25276294350624084,
0.14803192019462585,
-0.19508537650108337,
-0.1592767... |
https://pimcore.com/docs/platform//Pimcore/Tools_and_Features#tools-and-features | Tools and Features
This section of documentation gives an overview over tools and features provided in or for the Pimcore backend UI but also can
be used via Pimcore PHP API.
The topics include insights to Versioning, Notes and Events,
Tags, Perspectives and much much more.
Just have a look at the sub pages and dive into the possibilities of Pimcore. | Tools and Features | [
0.04787694290280342,
-0.2557609975337982,
-0.21337978541851044,
-0.012260198593139648,
-0.06431001424789429,
0.03628256544470787,
0.04698872193694115,
-0.15320363640785217,
-0.4384032189846039,
0.09310264140367508,
0.07937216013669968,
0.4399874806404114,
0.28598105907440186,
0.29911443591... |
https://pimcore.com/docs/platform//Pimcore/Development_Tools_and_Details/Database_Model#database-model | Database Model
Pimcore tries to keep a clean and optimized database model for managing the data. Nevertheless,
there are quite a lot of tables around and finding the correct data might be a bit challenging at
the beginning.
Basically, there are two types of tables
Default tables with are created during install - for all sorts of data like assets, documents
logs, versions, ...
Dynamically created tables during object data model configuration - mainly for all object related
data.
| Database Model | [
-0.05142531171441078,
-0.1016528531908989,
-0.13961397111415863,
0.39019539952278137,
-0.09813061356544495,
-0.10804619640111923,
-0.29211631417274475,
0.0339745469391346,
-0.3364432454109192,
0.06013805419206619,
-0.22966429591178894,
0.28176236152648926,
0.24803335964679718,
0.1010946184... |
https://pimcore.com/docs/platform//Pimcore/Development_Tools_and_Details/Database_Model#default-tables | Default Tables
These tables are created during Pimcore install and are always the same.
Table
Description
application_logs
Contains all application logs. For more information see Application Logger. Additionally, there might be application_logs_archive* tables for old logging entries.
assets
Assets (Images, etc.), with system metadata
assets_metadata
Additional user metadata (Metadata tab in the asset panel)
classes
List of all object classes with ID and name. Everything else is stored in PHP configuration files.
classificationstore_collectionrelations
Relation Collection - Group for Classification Store
classificationstore_collections
Collections of Classification Store
classificationstore_groups
Groups of Classification Store
classificationstore_keys
Keys of Classification Store
classificationstore_relations
Relation Group - Key for Classification Store
classificationstore_stores
Stores of Classification Store
custom_layouts
Definition of the custom layouts for object classes
dependencies
Stores dependencies between elements such as objects, assets, documents
documents
List of all documents, folders, links, hardlinks, emails and snippets of the document area with meta- and config-data, relations
documents_editables
Editables of documents (data), in a serialized form
documents_email
Extra config data
documents_hardlink
Extra config data
documents_link
Extra config data
documents_page
Extra config data
documents_printpage
Extra config data
documents_snippet
Extra config data
documents_translations
Relation between same documents for different languages
edit_lock
Tracks which user opened which resource in the backend
element_workflow_state
Keeps track of workflow state for all elements
email_blocklist
Blocklist for eMail-addresses
email_log
Log for sent emails
glossary
Words to auto-link in texts. See Glossary
http_error_log
HTTP error log
locks
Store for Locking functionality
notes
Notes for elements
notes_data
Additional data for notes
objects
List of all objects with metadata like id, class name, path, parent, ...
object_url_slugs
URL Slug data
properties
Data from the properties tab
quantityvalue_units
Available quantities for quantity value object data type
recyclebin
Stores metadata of deleted elements
redirects
Stores redirects
schedule_tasks
Stores scheduled tasks
search_backend_data
Stores the index for the backend search - is a InnoDb Table with fulltext capabilities
sites
Stores sites
tags
Stores available tags
tags_assignment
Stores assignment of tags to elements
tmp_store
Pimcore internal tmp store
tracking_events
translations_admin
Backend translations
translations_messages
Frontend translations
tree_locks
Locks in the tree of Pimcore backend interface
users
Backend users
users_permission_definitions
List of globally assignable user permissions
users_workspaces_asset
Stores user access permissions for asset folder
users_workspaces_document
Stores user access permissions for document folders
users_workspaces_object
Stores user access permissions for object folders
uuids
stores Unique Identifiers - if enabled
versions
List of object/asset/document versions. Actual data is serialized and written to disk
| Default Tables | [
-0.10260383784770966,
-0.19963060319423676,
-0.18052923679351807,
0.3944450616836548,
0.06099242344498634,
0.03498980775475502,
-0.04696124047040939,
0.2139226645231247,
-0.26826825737953186,
-0.07399070262908936,
-0.44571390748023987,
0.3522491455078125,
0.24548153579235077,
-0.0288307685... |
https://pimcore.com/docs/platform//Pimcore/Development_Tools_and_Details/Database_Model#object-tables | Object Tables
These tables are created and modified dynamically during the configuration of the object data model.
As a result, they look different on an every Pimcore installation depending on the data model. | Object Tables | [
-0.014565806835889816,
-0.29986435174942017,
-0.21039919555187225,
0.4861404001712799,
0.11816344410181046,
-0.2212684154510498,
0.10939443856477737,
-0.03534762188792229,
-0.2937869429588318,
0.2479255199432373,
-0.4065353572368622,
0.48787620663642883,
0.36625978350639343,
0.196786925196... |
https://pimcore.com/docs/platform//Pimcore/Development_Tools_and_Details/Database_Model#objects | Objects
As soon as a new object class is created in Pimcore, at least three tables are
added to the database. The tables have a numerical suffix, denoting the number
(id) of the object class: object_query_(id), object_relations_(id),
object_store_(id) and an additional database view object_(id) which is a combination of
object_query_(id) and objects.
Table / View
Description
object_(id) View
Database view joining object_query_(id) and objects table
object_query_(id) Table
Use this table to retrieve data incl. inherited data. Data types with relations are usually stored in a serialized form here, too. Pimcore Object-Lists work with this table.
object_relations_(id) Table
Contains data of fields with relations to objects, assets, etc.
object_store_(id) Table
This is the main data storage table of an object class. It contains all "flat" data without any relations or external dependencies.
objects Table
Contains an entry for each and every object in the system. The id field is an auto_increment and the source of the primary key for an object. Metadata about an object is stored in this table, too.
When restore of query tables is necessary (for what ever reason) calling DataObject\Concrete::disableDirtyDetection(); and
saving all data objects of class will do the trick. When not disabling dirty detection, there might be data missing in query table.
| Objects | [
-0.11074301600456238,
0.07758442312479019,
-0.12539400160312653,
0.5436838865280151,
0.07744253426790237,
-0.18232232332229614,
-0.22449982166290283,
0.11069557815790176,
-0.24128055572509766,
0.07860434800386429,
-0.40287649631500244,
0.41271328926086426,
0.16085387766361237,
-0.108753003... |
https://pimcore.com/docs/platform//Pimcore/Development_Tools_and_Details/Database_Model#simple-data-field-types | Simple Data Field Types
Following is an overview of how different object data types are stored in the database. This overview might not be complete.
This overview might be a useful starting point when querying object data with object lists. | Simple Data Field Types | [
0.13312219083309174,
-0.22299112379550934,
-0.15154536068439484,
0.5703305602073669,
0.2095763087272644,
-0.15161000192165375,
0.16681259870529175,
-0.15577076375484467,
-0.060393087565898895,
-0.08390382677316666,
-0.0466967336833477,
-0.09348168969154358,
0.1598587930202484,
0.1124799326... |
https://pimcore.com/docs/platform//Pimcore/Development_Tools_and_Details/Database_Model#text | Text
Table: object_store_(id)
Name
Data Type
Default
Comment
Input
varchar(255)
NULL
/
Textarea
longtext
NULL
/
wysiwyg
longtext
NULL
Text with HTML-tags
password
varchar(255)
NULL
Password - as hash
| Text | [
-0.03354989364743233,
-0.39461904764175415,
-0.17430053651332855,
0.32476624846458435,
0.1056208610534668,
0.09735080599784851,
0.28481772541999817,
0.3024684190750122,
0.23143509030342102,
0.012240548618137836,
0.10307925939559937,
-0.06728404015302658,
0.14218272268772125,
0.134980723261... |
https://pimcore.com/docs/platform//Pimcore/Development_Tools_and_Details/Database_Model#number | Number
Table: object_store_(id)
Name
Data Type
Default
Comment
Number
double/decimal(64,3)
NULL
Datatype depends on selected precision
Slider
double
NULL
/
| Number | [
-0.22308707237243652,
-0.3660869598388672,
-0.20686747133731842,
0.4255051016807556,
0.14675180613994598,
-0.008257541805505753,
0.16505067050457,
0.2541747987270355,
-0.1630464494228363,
0.26088958978652954,
0.006686356384307146,
0.26824554800987244,
0.08982014656066895,
-0.01832975447177... |
https://pimcore.com/docs/platform//Pimcore/Development_Tools_and_Details/Database_Model#date | Date
Table: object_store_(id)
Name
Data Type
Default
Comment
Date
bigint(20)
NULL
< 1970 = negative Timestamp
Date & Time
bigint(20)
NULL
< 1970 = negative Timestamp
Time
varchar(5)
NULL
String - e.g.: "12:00"
| Date | [
-0.368847131729126,
-0.265802264213562,
-0.24754148721694946,
0.18787024915218353,
-0.1859004944562912,
0.022671343758702278,
-0.11054708808660507,
0.340537428855896,
0.03395557403564453,
0.07345309108495712,
0.19333221018314362,
0.01663042977452278,
-0.07012588530778885,
-0.06088614091277... |
https://pimcore.com/docs/platform//Pimcore/Development_Tools_and_Details/Database_Model#select | Select
Table: object_store_(id)
Name
Data Type
Default
Comment
Select
varchar(255)
NULL
Selected value
User
varchar(255)
NULL
Pimcore User-ID
Country
varchar(255)
NULL
Country code
Language
varchar(255)
NULL
Language code
Multiselection
text
NULL
String, selected values, separated by ","
Countries (Multiselect)
text
NULL
String, selected language-codes, separated by ","
Languages (Multiselect)
text
NULL
String, selected language-codes, separated by ","
| Select | [
-0.29262828826904297,
-0.19263775646686554,
-0.2923524081707001,
0.21589377522468567,
-0.15866690874099731,
-0.0869644358754158,
0.028050730004906654,
0.32754313945770264,
0.007784110959619284,
0.16565878689289093,
0.08994705975055695,
0.3577674627304077,
0.16781046986579895,
0.13215927779... |
https://pimcore.com/docs/platform//Pimcore/Development_Tools_and_Details/Database_Model#relations | Relations
Table: object_relations_(id) & object_meta_data_(id)
Data fields of relation types are stored in extra tables
Data fields are not stored in distinct columns, but as rows, whereas the field name is in an extra column fieldname
The column type specifies the type of the linked resource (Object, Document, Asset)
The columns src_id and dest_id define the relation / the link between the objects.
Column index is used to specify the order of the relations
Columns ownertype, ownername and position are used when relations are within field collections, localized fields, object bricks, etc.
The data type Advanced Many-To-One Object Relation stores the extra data in a table object_meta_data_(id) - the column column
specifies the name of the meta item and data stores the value
| Relations | [
0.11814059317111969,
-0.24704408645629883,
-0.19582173228263855,
0.5138841271400452,
-0.036886077374219894,
0.036710940301418304,
0.10784982144832611,
0.12355762720108032,
0.04102127254009247,
-0.010128424502909184,
-0.2794335186481476,
0.23543274402618408,
0.34894996881484985,
-0.04652784... |
https://pimcore.com/docs/platform//Pimcore/Development_Tools_and_Details/Database_Model#structured | Structured
Name
Comment
Table
Table data is stored as a string - serialized.
Structured Table
Each table cell is stored distinctively; schema: (fieldname)__(row key)#(column key)
Field-Collections
see special data fields later
Objectbricks
see special data fields later
Localized Fields
see special data fields later
| Structured | [
0.09590373933315277,
-0.2008795589208603,
-0.207361102104187,
0.3186144232749939,
0.17627458274364471,
-0.030216587707400322,
0.19945068657398224,
0.11119665205478668,
-0.2325839400291443,
0.20266975462436676,
-0.12216485291719437,
0.1488211303949356,
-0.05810215324163437,
0.27261593937873... |
https://pimcore.com/docs/platform//Pimcore/Development_Tools_and_Details/Database_Model#geographic | Geographic
Table: object_store_(id)
Name
Data Type
Default
Comment
Geographic Point
double
NULL
Creates two columns: ‘(name)__longitude’ and ‘(name)__latitude’
Geographic Bounds
double
NULL
Creates four columns: ‘(name)__NElongitude’, ‘(name)__NElatitude’, ‘(name)__SWlongitude’ und ‘(name)__SWlatitude’
Geographic Polygon
longtext
NULL
Serialized geo-data
| Geographic | [
0.02977113053202629,
-0.06411384046077728,
-0.09496566653251648,
0.20507311820983887,
0.22312042117118835,
0.17985518276691437,
0.15142694115638733,
0.3260205090045929,
0.3779348134994507,
0.07793726027011871,
-0.016312165185809135,
0.26659777760505676,
0.1588250994682312,
-0.0489913150668... |
https://pimcore.com/docs/platform//Pimcore/Development_Tools_and_Details/Database_Model#other | Other
Name
Data Type
Default
Comment
Image
int(11)
NULL
ID of the image asset
Image Advanced
int(11), text
NULL
Creates a column (name)__image(int) for the image assets id and the column (name)__hotspots(text). Hotspots are stored serialized.
Video
text
NULL
Serialized data
Checkbox
tinyint(1)
NULL
Boolean value (1 = true)
Link
text
NULL
Serialized data
| Other | [
0.004607651382684708,
-0.5198477506637573,
-0.1520831435918808,
0.20151354372501373,
0.15185515582561493,
0.09118423610925674,
0.33426880836486816,
0.2655174136161804,
0.039419714361429214,
-0.011194013990461826,
-0.1445832997560501,
0.1590954065322876,
-0.04663756489753723,
0.174763515591... |
https://pimcore.com/docs/platform//Pimcore/Development_Tools_and_Details/Database_Model#special-data-fields | Special Data Fields | Special Data Fields | [
-0.08806154876947403,
-0.15512040257453918,
-0.36662253737449646,
0.35617128014564514,
0.04720444604754448,
-0.11808247864246368,
0.18969927728176117,
0.02416667528450489,
-0.05511871725320816,
0.17987075448036194,
0.13729538023471832,
0.1086500808596611,
-0.07019025087356567,
0.4098773300... |
https://pimcore.com/docs/platform//Pimcore/Development_Tools_and_Details/Database_Model#objectbricks | Objectbricks
Table/View
Purpose
object_brick_query_(id) Table
Analog to object_query_(id)
object_brick_store_(id) Table
Main data storage
| Objectbricks | [
-0.10271840542554855,
-0.127700537443161,
-0.216824010014534,
0.249272882938385,
-0.057117804884910583,
0.26905927062034607,
0.37344130873680115,
0.09076929837465286,
0.5168569684028625,
0.003068151418119669,
-0.4472929835319519,
0.21087035536766052,
-0.06482060253620148,
0.144875437021255... |
https://pimcore.com/docs/platform//Pimcore/Development_Tools_and_Details/Database_Model#localized-fields | Localized fields
Table/View
Purpose
object_localized_(id)_(language-code) View
A database view per language, combining regular and localized data fields
object_localized_data_(id) Table
Stores localized field data
object_localized_query_(id)_(language-code) Table
Analog to object_query_(id)
| Localized fields | [
-0.11810428649187088,
-0.2926216125488281,
-0.23546582460403442,
0.17367960512638092,
0.03324710577726364,
0.028926551342010498,
0.11666437238454819,
0.29219481348991394,
0.02804417349398136,
0.06529682129621506,
-0.11079037934541702,
0.18874892592430115,
0.08058419823646545,
0.26158821582... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.