Powered by MediaWiki
Personal tools

Codebase overview

From b2evolution manual

Jump to: navigation, search

This manual page is outdated. NEW PAGE: Codebase overview in b2evolution v5+.

// This page is directed at the 1.x series (Specifically v1.8.2) of b2evolution // // This page is under construction //

Contents

[edit] Introduction

This page plans to go over the codebase/structure of b2evolution v1.8.2, to help familiarize it's users with how b2evolution is organised so they can find parts inside the core easily.

This page should be used in conjunction with the Technical Documentation.


[edit] /blogs/

This is the 'root' directory of b2evolution, and the one that you would use on your production server.

[edit] /blogs/conf/

This is the directory that contains all your configuration information for b2evolution (Including your database passwords!). For this reason, this directory's permissions should be set to read-only after the initial write, for security reasons.

[edit] /blogs/cron/

I don't know

[edit] /blogs/hstrv/

I don't know

[edit] /blogs/inc/

This is the main folder you will be inside if you will be working with the core of b2evolution.

[edit] /blogs/inc/_misc/

This folder contains miscellaneous files that need to be included into b2evolution.

[edit] /blogs/inc/CONTROL/

I don't know

[edit] /blogs/inc/MODEL/

This folder is where you find all the OO files (E.g. Classes, Functions relating to classes, Etc). If you want to add new fields or functions to a existing class, here is the place you will go.

[edit] /blogs/inc/VIEW/

This folder relates to the display of b2evolution. So if you would like to change how something looks in the back office, you would go here.

[edit] /blogs/inc/[some_folder]/

[edit] /blogs/inc/[some_folder]/antispam/

[edit] /blogs/inc/[some_folder]/collections/

[edit] /blogs/inc/[some_folder]/comments/

[edit] /blogs/inc/[some_folder]/cron/

[edit] /blogs/inc/[some_folder]/dataobjects/

[edit] /blogs/inc/[some_folder]/errors/

[edit] /blogs/inc/[some_folder]/files/

[edit] /blogs/inc/[some_folder]/generic/

[edit] /blogs/inc/[some_folder]/items/

A item is the 'physical' name for a Post or Comment within b2evolution.

[edit] /blogs/inc/[some_folder]/sessions/

[edit] /blogs/inc/[some_folder]/settings/

[edit] /blogs/inc/[some_folder]/skins/

[edit] /blogs/inc/[some_folder]/users/

[edit] /blogs/install/

This folder is used to install b2evolution. After that IT SHOULD BE REMOVED.

[edit] /blogs/locales/

If you are a translator this will be your favourite folder. It contains all the files required for localization.

[edit] /blogs/media/

This is the directory used to contain files related to uploads. Although files should be uploaded here, it is not recommended that this directories permissions are 777, for more information check the permissions page. Also, files should not be uploaded manually here, as b2evolution or any plugins working with the directory use their own management system for the files, and it would cause problems.

[edit] /blogs/plugins/

Every developers favourite folder in the 1.8 releases. This is where Plugins go.

[edit] /blogs/rsc/

I don't know

[edit] /blogs/skins/

This is usually the place you go if you are starting off with b2evolution, and want to start hacking away. It contains the skins and their files, that are used in displaying your blog for the public via index.php

[edit] /blogs/skins/_arcdir.php

[edit] /blogs/skins/_archives.php

[edit] /blogs/skins/_bloglist.php

[edit] /blogs/skins/_calendar.php

[edit] /blogs/skins/_categories.php

[edit] /blogs/skins/_feedback.php

[edit] /blogs/skins/_lastcomments.php

[edit] /blogs/skins/_linkblog.php

[edit] /blogs/skins/_msgform.php

[edit] /blogs/skins/_popup.php

[edit] /blogs/skins/_subscriptions.php

[edit] /blogs/skins/[a_skin]/_main.php

This is the file that is loaded when the current skin is [a_skin].

[edit] /blogs/skins_adm/

Something to do with skins for the backoffice.

[edit] /blogs/xmlsrv/

This is directory provides a API that 3rd parties can use to interact with your setup of b2evolution. E.g. A Flickr or Digg account.