Pimcore Folder Structure

Pimcore Folder Structure

pimcore

pimcore:-

pimcore folder contains all the framework libraries with admin panel UI and code inside it. Never try to change any code inside this folder otherwise when you will update your pimcore version your changes will be drop and the new files will overwrite the old ones.

plugins:-

Plugin folder is used to create custom user plugins. Pimcore plugins are the set of codes which calls on different hooks applied like on object create, update and delete. These plugins can be created via admin section and the respective folder will be created here inside the plugins folder.

vendor:-

vendor is a folder for libraries installed via composer. Composer is a tool for dependency management in PHP. It allows you to declare the libraries your project depends on and it will manage (install/update) them for you. so while setting up a project first time you will need to run

composer install

It will download all dependency libraries to your project’s vendor folder.

website:-

This is the main folder created for developer use. This folder contains several directories.

config:-

This folder contains all the website’s config files like cache.php, google-api.php, hybridauth.php, startup.php etc..

controllers:-

As we know pimcore follows the MVC here are three folders available models, views and controllers. This folder contains all the controller’s files.

dump:-

dump folder contains default database dump files which runs on pimcore initial installation.

lib:-

lib folder contains base controller file with default Text helper.

models:-

This folder contains all the model’s related file. wither the models are created manually OR we create a class from admin panel. As soon as we create a new class a new entry made in database and a new files corresponding to it is created here. the new inserted id is also mentioned in these files.

static:-

This folder contains all the static assets like image, javascripts, css.

var:-

var folder contains different sub-folders like assets(for assets uploaded runtime from admin panel), classes(all user created class definitions), cache(all cache files created), config(custom config files), log(php.log and debug.log), system(all db related backups), tmp, versions(different versions of pages).

views:-

This folder contains all the views of controllers. there are three folder inside the views First one is area(small block of html part which got inserted on different pages/view files), Second one is layout(which contains all layout php files), Third one is scripts(these are the controllers view for each controller there is a folder inside the scripts and for each action there will be a php file inside the controller named folder)