| {maketoc}
|
| The Bitweaver Framework, consisting of Liberty and Kernel, offers you a lot of functionality. Here we'll try to show how you can make use of that.
|
|
|
| +!Your Own Package |
| !Business Objects a la Liberty
|
| -Up to now, the answer is to look at the ((SamplePackage)) and guess.
|
| !!Which base class?
|
| If you want to create your own [http://en.wikipedia.org/wiki/Business_object_(computer_science)|Business Object], you will probably use LibertyAttachable as base class, as it offers most functionality. Use LibertyContent or LibertyBase when you know what you are doing.
|
| !!LibertyAttachable
|
| -*Search
|
| -*Calendar (log entries)
|
| -*other installed data plugins
|
| -*history
|
| +Classes derived from LibertyAttachable come with this functionality (in addition to features already in LibertyContent): |
| +*They can take title and formatted text |
| +*They maintain creation date, creator and modification date/modificator information |
| +*The calendar can display events occurring to LibertyAttachable objects. |
| +*Upon database access (store, load) other service plugins are triggered |
|
|
| +If all you need is a new data type that contains some formatted text, you might be pretty quick in implementation. Customise this sample and continue with your GUI code (List and Detail Views). |
| +{code} |
| +<?php |
| +require_once( LIBERTY_PKG_PATH.'LibertyAttachable.php' ); //import base class |
| + |
| +define( 'BITRESOURCE_CONTENT_TYPE_GUID', 'bitresource' ); // This is used to uniquely identify the object type |
| + |
| +class BitResource extends LibertyAttachable { |
| + |
| + /** |
| + * During initialisation, be sure to call our base constructors |
| + **/ |
| + function BitResource( $pContentId=NULL ) { |
| + LibertyAttachable::LibertyAttachable(); |
| + |
| + $this->mContentId = $pContentId; |
| + $this->mContentTypeGuid = BITRESOURCE_CONTENT_TYPE_GUID; |
| + |
| + $parms = array( |
| + 'content_type_guid' => BITRESOURCE_CONTENT_TYPE_GUID, |
| + 'content_description' => 'Managed Resource', |
| + 'handler_class' => 'BitResource', |
| + 'handler_package' => 'mypackage', |
| + 'handler_file' => 'BitResource.php', |
| + 'maintainer_url' => 'mailto:guess@who.com' |
| + ); |
| + $this->registerContentType( BITRESOURCE_CONTENT_TYPE_GUID, $parms ); // register class with Bitweaver |
| + } |
| + |
| +} |
| +?> |
| +{/code} |
| + |
| +!!!Custom fields |
| +Probably you will want to add some custom fields. This will be some more work, as Liberty won't know about them and we have to handle them ourselves. |
| + |
| +First think of a place to store the data. We will have to use our own table in the database. To match the liberty data with our own we should use an identifier. [content_id] is the one provided by liberty, and it will serve us well now. So create a table with two columns, just as shown. Later you will see how Bitweaver automatically creates the table upon package installation. |
| +{code} |
| +create table mydata ( |
| + content_id integer(4), |
| + expires timestamp |
| +) |
| +{/code} |
| + |
| +*LibertyContent::setIndexData |
| *getServicesSQL
|
| *prepGetList
|
| *postGetList
|
| + |
| +!!!History functionality |
| +How can you enable history tracking in Liberty? |
| +*LibertyContent::store and pParamHash['force_history'] |
| +*LibertyContent::storeHistory |
| + |
| !!LibertyContent
|
| +LibertyContent is the base for objects to be treated by Liberty. They come with these features: |
| +*their title and text content is subject to the full text seach |
| !!LibertyBase
|
| -!Sorted Lists
|
| +!!Lists, sorted and filtered |
| +Now let us create a list of resources. Hopefully you already have something in your database so get something to see. As a first, insert this data with your favourite client, or even better with the data pump described below. |
| + |
| +Now we will write some code that loads your data from the database. It goes to _index.php_ in your package directory. |
| +{code} |
| +{/code} |
| + |
| +But what? We call a method that does not exist. Unfortunately LibertyAttachable does not come with a method that could easily be there: getList(). And so we will have to create that for ourselves: |
| +{code} |
| +function getList( &$pParamHash ) { |
| + global $gBitSystem, $gBitUser; |
| + |
| + LibertyContent::prepGetList( $pParamHash );// this makes sure parameters used later on are set |
| + |
| + $selectSql = $joinSql = $whereSql = ''; |
| + $bindVars = array(); |
| + array_push( $bindVars, $this->mContentTypeGuid ); |
| + $this->getServicesSql( 'content_list_sql_function', $selectSql, $joinSql, $whereSql, $bindVars ); |
| + |
| + extract( $pParamHash );// this will set $find, $sort_mode, $max_records and $offset |
| + |
| + if( is_array( $find ) ) { // you can use an array of pages |
| + $whereSql .= " AND lc.`title` IN( ".implode( ',',array_fill( 0,count( $find ),'?' ) )." )"; |
| + $bindVars = array_merge ( $bindVars, $find ); |
| + } elseif( is_string( $find ) ) { // or a string |
| + $whereSql .= " AND UPPER( lc.`title` )like ? "; |
| + $bindVars[] = '%' . strtoupper( $find ). '%'; |
| + } |
| + |
| + $query = "SELECT lc.`content_id`, lc.`title`, lc.`data` $selectSql |
| + FROM `".BIT_DB_PREFIX."liberty_content` lc $joinSql |
| + WHERE lc.`content_type_guid` = ? $whereSql |
| + ORDER BY ".$this->mDb->convert_sortmode( $sort_mode ); |
| + $query_cant = "select count(*) |
| + FROM `".BIT_DB_PREFIX."eventcal_events` ts |
| + INNER JOIN `".BIT_DB_PREFIX."liberty_content` lc ON( lc.`content_id` = ts.`content_id` ) |
| + $joinSql |
| + WHERE lc.`content_type_guid` = ? $whereSql"; |
| + |
| + $result = $this->mDb->query( $query, $bindVars, $max_records, $offset ); |
| + $ret = array(); |
| + while( $res = $result->fetchRow() ) { |
| + $ret[] = $res; |
| + } |
| + $pParamHash["cant"] = $this->mDb->getOne( $query_cant, $bindVars ); |
| + |
| + // add all pagination info to pParamHash |
| + LibertyContent::postGetList( $pParamHash ); |
| + |
| + return $ret; |
| + } |
| +{/code} |
| + |
| +*$gBitSmarty->assign_by_ref(...) |
| +*$gBitSystem->display(...) |
| + |
| +!Make something visible: The UI |
| +Probably you cannot wait to display somethind on the screen. Up to now we had concentrated on your data objects - the model. Bitweaver works with the MVC pattern. Find out more about this pattern in ((Model View Controller - MVC)), but now we make use of the model, create a simple controller and focus on the view. |
| + |
| +{attachment id=268 float=right padding=20px} Have a look at this picture. It should give you a rough idea of what part of a bitweaver page you will be working on. |
| + |
| +In most cases you write ordinary module code that goes into the main area in the middle. Then you can place any HTML/JavaScript/whatever code in your templates but surround it with the tag <div class="bitmain">, which will look like this: |
| +{code} |
| +<div class="bitmain"> |
| + <!-- your HTML here --> |
| +</dov> |
| +{/code} |
| +Or you might be creating a module, in which case it is displayed either in the left or right column. In that case surreund your HTML with <div class="bitmodule"> as shown: |
| +{code} |
| +<div class="bitmodule"> |
| + <!-- your HTML here --> |
| +</dov> |
| +{/code} |
| +Don't use tables to control the position as Bitweaver already takes care for the layout (and that can be changed in the admin menu). If you cannot believe it, read ((Table_vs_Div)). |
| + |
| +Of course within the <div> element you can use tables to organise your information. |
| + |
| +!!List Views |
| +*The Controller |
| +*The Template (View) |
| +!!Detail Views |
| +*The Controller |
| +*The Template (View) |
| +!!Feedback and Confirmation |
| Up to now, the answer is to look at the ((SamplePackage)) and guess.
|
| -!Detail Views
|
| -Up to now, the answer is to look at the ((SamplePackage)) and guess.
|
| -!Feedback and Confirmation
|
| -Up to now, the answer is to look at the ((SamplePackage)) and guess.
|
| -gBitSystem->setBrowserTitle()
|
| -gBitSystem->confirmDialog()
|
| +errors, warnings, message text and confirmation dialogs |
| +*gBitSystem->setBrowserTitle() |
| +*gBitSystem->confirmDialog() |
| !Authorisation Required
|
| Up to now, the answer is to look at the ((SamplePackage)) and guess.
|
| !!Menus and Modules
|