Changeset 15897 for trunk/inc

Timestamp:

01/18/12 23:41:12 (4 months ago)

Author:

Alexander Trofimov

Message:

Page - refactoring, docs, cache implementation.

Location:

trunk/inc/classes

Files:

• BxDolPage.php (modified) (4 diffs)
• BxDolTemplate.php (modified) (3 diffs)

trunk/inc/classes/BxDolPage.php

@@ -19 +19 @@
  * Pages. 
  *
- * It allows to display pages build from studio.
+ * It allows to display pages build from studio. 
+ *  
+ * The new system has the following page features:
+ * - layouts: page can have any page structure, not just columns.
+ * - SEO: page can have own SEO options, like meta tags and meta keywords, as well as instructions for search bots.
+ * - cache: page can be cached on server or in client's browser.
+ * - visibility: page access can be controlled using member levels.
+ * 
+ * 
+ * 
+ * @section page_create Creating the Page object:
+ *
+ * 1. add record to 'sys_objects_page' table:
+ *
+ * - object: name of the page object, in the format: vendor prefix, underscore, module prefix, underscore, internal identifier or nothing; for example: bx_profiles_view - profile view page.
+ * - title: title to display as page title.
+ * - module: the module this page belongs to.
+ * - layout_id: page layout to use, it is id of the record from 'sys_pages_layouts' table.
+ * - visibile_for_levels: bit field with set of member level ids. To use member level id in bit field - the level id minus 1 as power of 2 is used, for example:
+ *      - user level id = 1 -> 2^(1-1) = 1
+ *      - user level id = 2 -> 2^(2-1) = 2
+ *      - user level id = 3 -> 2^(3-1) = 4
+ *      - user level id = 4 -> 2^(4-1) = 8
+ * - visibile_for_levels_editable: it determines if 'visibile_for_levels' field is ediable from page builder, visibility options can be overriden by custom class and shouldn't editable in this case.
+ * - url: the page url, if it is static page.
+ * - meta_description: meta description of the page.
+ * - meta_keywords: meta keywords of the page.
+ * - meta_robots: instructions for search bots.
+ * - cache_server: number of seconds to store cache for on the server.
+ * - cache_editable: it determines if cache can be edited from page builder.
+ * - deletable: it determines if page can be deleted from page builder.
+ * - override_class_name: user defined class name which is derived from BxTemplPage.
+ * - override_class_file: the location of the user defined class, leave it empty if class is located in system folders.
+ * 
+ * Page layout are stored in 'sys_pages_layouts' table:
+ * - name: inner unique layout name.
+ * - icon: layout icon to display in page builder, it should represent basic view of the layout to help studio operator determine the layout structure.
+ * - title: layout name to display in page builder.
+ * - template: template name to use to display page with certain layout.
+ * - cells_number: number of areas in the layout, page blocks can be places into this areas(cells).
+ * To define areas in the layout they should be named as '__cell_N__', where N is cell number, starting from 1.
+ * 
+ * 
+ * 2. Add page blocks to 'sys_pages_blocks' table:
+ * - object: page object name this block belongs to.
+ * - cell_id: cell number in page layout to place block to.
+ * - module: module name this block belongs to.
+ * - title: block title.
+ * - designbox_id: design box to use to diplay page block, it is id of the record from 'sys_pages_blocks' table.
+ * - visibile_for_levels: bit field with set of member level ids. To use member level id in bit field - the level id minus 1 as power of 2 is used, for example:
+ *      - user level id = 1 -> 2^(1-1) = 1
+ *      - user level id = 2 -> 2^(2-1) = 2
+ *      - user level id = 3 -> 2^(3-1) = 4
+ *      - user level id = 4 -> 2^(4-1) = 8
+ * - type: block type
+ *      - raw: HTML block, displayed in page builder as HTML textarea.
+ *      - html: HTML block, displayed in page builder as visual editor, line TinyMCE.
+ *      - lang: translatable language string, displayed in page builder as editable language key.
+ *      - image: just an image, displayed in page builder as HTML upload form.
+ *      - rss: RSS block, displayed in page builder as editable URL to RSS resource, along with number of displayed items.
+ *      - menu: menu block, displayed as menu selector.
+ *      - service: to display block content, the provided serice method is used.
+ * - content: depending on 'type' field:
+ *      - raw: HTML string.
+ *      - html: HTML string.
+ *      - lang: language key.
+ *      - image: image id in the storage.
+ *      - rss: URL to RSS with number of displayed items, for example: http://www.example.com/rss#4
+ *      - menu: menu object name.
+ *      - service: serialized array of service call parameters: module - module name, method - service method name, params - array of parameters.
+ * - deletable: is block deletable from page builder
+ * - copyable: is block can be copied to any other page from page builder.
+ * - order: block order in some cell.
+ * 
+ * Block design boxes are stored in 'sys_pages_design_boxes' table:
+ * - id: consistent id, there are the following defines can be used in the code for each system block style:
+ *      - 0 - BX_DB_CONTENT_ONLY: design box with content only - no borders, no background, no caption.
+ *      - 1 - BX_DB_DEF: default design box with content, borders and caption.
+ *      - 2 - BX_DB_EMPTY: just empty design box, without anything.
+ *      - 3 - BX_DB_NO_CAPTION: design box with content, like BX_DB_DEF but without caption.
+ *      - 10 - BX_DB_PADDING_CONTENT_ONLY: design box with content only wrapped with default padding - no borders, no background, no caption; it can be used to just wrap content with default padding.
+ *      - 11 - BX_DB_PADDING_DEF: default design box with content wrapped with default padding, borders and caption.
+ *      - 13 - BX_DB_PADDING_NO_CAPTION: design box with content wrapped with default padding, like BX_DB_DEF but without caption.
+ * - title: block name which is displayed in studio, describes block styles.
+ * - template: template name to use to display page block.
+ *
+ *
+ * 3. Display Page.
+ * Use the following sample code to display page:
+ * @code
+ *     bx_import('BxDolPage');
+ *     $oPage = BxDolPage::getObjectInstance('sample'); // 'sample' is 'object' field from 'sys_objects_page' table, it automatically creates instance of default or custom class by object name
+ *     if ($oPage)
+ *         echo $oPage->getCode(); // print page
+ * @endcode
+ *
  */
 
-/*
 
-CREATE TABLE IF NOT EXISTS `sys_objects_page` (
-  `id` int(11) NOT NULL AUTO_INCREMENT,
-  `object` varchar(32) COLLATE utf8_unicode_ci NOT NULL,
-  `title` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
-  `module` varchar(32) COLLATE utf8_unicode_ci NOT NULL,
-  `layout_id` int(11) NOT NULL,
-  `visibile_for_levels` int(11) NOT NULL,
-  `visibile_for_levels_editable` tinyint(4) NOT NULL DEFAULT '1',
-  `url` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
-  `meta_description` text COLLATE utf8_unicode_ci NOT NULL,
-  `meta_keywords` text COLLATE utf8_unicode_ci NOT NULL,
-  `meta_robots` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
-  `cache_server` int(11) NOT NULL,
-  `cache_server_params` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
-  `cache_client` int(11) NOT NULL,
-  `cache_editable` tinyint(4) NOT NULL,
-  `deletable` tinyint(1) NOT NULL,
-  PRIMARY KEY (`id`),
-  UNIQUE KEY `object` (`object`)
-) ENGINE=MyISAM DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci AUTO_INCREMENT=1 ;
-
--- --------------------------------------------------------
-
-CREATE TABLE IF NOT EXISTS `sys_pages_blocks` (
-  `id` int(11) NOT NULL AUTO_INCREMENT,
-  `object` varchar(32) COLLATE utf8_unicode_ci NOT NULL,
-  `cell_id` int(11) NOT NULL,
-  `module` varchar(32) COLLATE utf8_unicode_ci NOT NULL,
-  `title` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
-  `designbox_id` int(11) NOT NULL,
-  `visibile_for_levels` int(11) NOT NULL,
-  `type` enum('raw','html','lang','image','rss','menu','service') COLLATE utf8_unicode_ci NOT NULL DEFAULT 'raw',
-  `content` text COLLATE utf8_unicode_ci NOT NULL,
-  `deletable` tinyint(4) NOT NULL,
-  `copyable` tinyint(4) NOT NULL,
-  `order` int(11) NOT NULL,
-  PRIMARY KEY (`id`)
-) ENGINE=MyISAM DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci AUTO_INCREMENT=1 ;
-
--- --------------------------------------------------------
-
-CREATE TABLE IF NOT EXISTS `sys_pages_design_boxes` (
-  `id` int(11) NOT NULL,
-  `title` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
-  `template` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
-  PRIMARY KEY (`id`)
-) ENGINE=MyISAM DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;
-
-INSERT INTO `sys_pages_design_boxes` (`id`, `title`, `template`) VALUES
-(0, '_sys_designbox_0', 'designbox_0.html'),
-(1, '_sys_designbox_1', 'designbox_1.html'),
-(2, '_sys_designbox_2', 'designbox_2.html'),
-(3, '_sys_designbox_3', 'designbox_3.html'),
-(10, '_sys_designbox_10', 'designbox_10.html'),
-(11, '_sys_designbox_11', 'designbox_11.html'),
-(13, '_sys_designbox_13', 'designbox_13.html');
-
--- --------------------------------------------------------
-
-CREATE TABLE IF NOT EXISTS `sys_pages_layouts` (
-  `id` int(11) NOT NULL AUTO_INCREMENT,
-  `icon` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
-  `title` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
-  `template` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
-  `cells_number` int(11) NOT NULL,
-  PRIMARY KEY (`id`)
-) ENGINE=MyISAM  DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci AUTO_INCREMENT=2 ;
-
-INSERT INTO `sys_pages_layouts` (`id`, `icon`, `title`, `template`, `cells_number`) VALUES
-(1, 'layout_bar_left.png', '_sys_layout_bar_left', 'layout_bar_left.html', 2);
-
-*/
 
 class BxDolPage extends BxDol {
@@ -144 +166 @@
     }    
 
+    /**
+     * Check if page block is visible.
+     */
     protected function _isVisibleBlock ($a) {
         bx_import('BxDolAcl');
@@ -149 +174 @@
     }
 
+    /**
+     * Check if page is visible.
+     */
     protected function _isVisiblePage ($a) {
         bx_import('BxDolAcl');
@@ -154 +182 @@
     }
 
-    public function getCode () {
-
-    }
 }
 

trunk/inc/classes/BxDolTemplate.php

@@ -290 +290 @@
             'keywords' => array(),
             'description'  => '',
+            'robots' => '',
             'css_name' => array(),
             'css_compiled' => array(),
@@ -406 +407 @@
 
     /**
+     * Set page meta robots.
+     *
+     * @param string $s page meta robots.
+     */
+    function setPageMetaRobots($s) {
+        $this->aPage['robots'] = $s;
+    }
+
+    /**
      * Set page content for some variable.
      * @param string $sVar name of content variable
@@ -805 +815 @@
             case 'page_charset':
                 $sRet = 'UTF-8';
+                break;
+            case 'page_robots':
+                if(!empty($this->aPage['robots']) && is_string($this->aPage['robots']))
+                    $sRet = '<meta name="robots" content="' . bx_html_attribute($this->aPage['robots']) . '" />';
                 break;
             case 'page_keywords':