Documentation

Debian

Tue, 15 Apr 2008 11:19:07 +0000

Add the following lines to /etc/apt/sources.list:

Replace binary-i386 with binary-amd64 for 64bit environments.

For Debian stable ( etch ):

deb http://www.midgard-project.org/debian/dists/stable/main/binary-i386 ./  
# deb-src http://www.midgard-project.org/debian/dists/stable/source/ ./

For Debian testing ( lenny ):

deb http://www.midgard-project.org/debian/dists/testing/main/binary-i386 ./  
# deb-src  http://www.midgard-project.org/debian/dists/testing/source/ ./

For Debian unstable ( sid ):

deb http://www.midgard-project.org/debian/dists/unstable/main/binary-i386 ./  
# deb-src http://www.midgard-project.org/debian/dists/unstable/source/ ./

Run apt-get update for updating the apt database (this adds our repository into your apt).

If you're installing for Apache HTTP Server 1.3.X series, install Midgard with the command:

apt-get install midgard-data php4-midgard.

If you're installing for Apache HTTP Server 2.X series, install Midgard with the command:

apt-get install midgard-data libapache2-mod-midgard

Unfortunatelly there is no empty "midgard" package, as we need to provide support for both Apache HTTP Server series.

Run datagard for setting up a new Midgard database and virtual host. Read the instructions from Setting Up a Midgard Database.

Debian sarge

For old stable debian:

deb http://www.midgard-project.org/debian/dists/sarge/main/binary-i386 ./

Midgard packages for debian sarge include php5-midgard package. This package is built against php5 packages available from http://dotdeb.org. If you want to you PHP5 and php5-midgard on sarge, add dotdeb repository to your sources.list and install php5 and php5-midgard.

For Debian Sarge, you currently have to edit the /etc/apache2/apache2.conf and add:

Include /etc/midgard/apache/httpd.conf

Also you must comment out the Listen 80 entry in /etc/apache2/ports.conf.

If you are running other vhosts on the box, you might have to do more.

If, after following all the instructions regarding the installation with Debian packages, you end up with a broken homepage, try this:

* Try the /aegir/ url (as a suffix to your virtual host URL)
* Check inside the midgard database if you have a host (in the host table) without a prefix (you should, otherwise do the following)
* Restart de datagard application and select Update - Upgrade ...
* If debconf crashes with a geometry error (something about coordinates in the graphical size), resize the window and try again
* Retry using the /aegir/ suffix and use the default admin password "password"

midgard_replicator method import_from_xml

Fri, 04 Apr 2008 19:37:41 +0000

Imports data from xml content.

void import_from_xml(string xml);

Minimum version: 1.8.1

This method takes one parameter:

xml, valid xml content

You should use:

serialize method if you need serialized object's data.
export_blob method if you need to export midgard_attachment's binary data
export_purged method if you need to export all objects which have previously been purged.

Examples

$xml = file_get_contents("exported.xml");
midgard_replicator::import_from_xml($xml);

PHP midgard_replicator

MgdSchema method connect

Fri, 04 Apr 2008 08:24:21 +0000

__void $object->connect(event_name, array callback, [array params])__

Minimum version: Midgard 1.9

Connects callback to event.

This method takes three arguments:

event_name, a name of the event for which callback is connected to, for example action_update_hook, action_created or action_loaded
callback, an array which is user defined PHP callback
params, an array with parameters which will be passed to callback

A callback function is connected to event(signal) emited by instance which invokes connect method. You may connect to one instance and event as many callbacks as you need.

<?php  

function my_callback($object, $data)
{
    echo "Connected to ".$object->guid;
    echo "And have special data ".$data;   
}

$article = midgard_object_class::factory("midgard_article", 123);
$article->connect("action_update_hook", array("my_callback"), array("abc"));

$article->update();

?>

PHP midgard_connection method connect

Fri, 04 Apr 2008 08:23:30 +0000

Connects a callback.

Name of this method may be confusing, as it may suggest database connection. connect method name is reserved for all midgard objects, and it's related to events handling

Read about mgdschema method connect.

midgard_connection.

PHP midgard_connection method set_debuglevel

Fri, 04 Apr 2008 08:17:49 +0000

Set log verbosity level.

void set_debuglevel(level);

midgard_connection method set_debuglevel takes one parameter and may be called statically.

level string

Available and usable levels:

warn ( or warning)
info
message
debug

The default warn will produce only warning logs. info and message provides functions and method names be written to log file with additional messages produced by invoked functions. debug produces function and method names and all SQL queries.

You may set debuglevel as many time as needed during runtime. Log level is limited to currently invoked application, even if more than one reuse the same configuration and underlying connection to the same database.

This method overwrites loglevel set in unified configuration. Log messages may be written to defined log file.

Example

<?php

 midgard_connection::set_debuglevel("info");

 try
 {
     $object = midgard_person(123);
 }
 catch(midgard_error_exception $e)
 {
     echo "Failed to get object" . $e->getMessage();
 }

 $object->lastname = "Smith";

 midgard_connection::set_debuglevel("debug");

 if(!$object->update()) {

     if(midgard_connection::get_error() = MGD_ERR_ACCESS_DENIED)
         echo "You are not allowed to edit this document"; 
 } 

 midgard_connection::set_debuglevel("warn")

 ?>

midgard_connection.

PHP midgard_connection method get_user

Fri, 04 Apr 2008 08:06:09 +0000

Get midgard_user.

midgard_user get_user(void);

midgard_connection method get_user takes no parameters and may be called statically.

Returns midgard_user object, or NULL if there's no authenticated user.

Read about midgard_user class.

Example

<?php

 $user = midgard_connection::get_user();

 if(!$user->is_admin())
 {
     echo "You are not allowed to edit this document";
 }

 ?>

midgard_connection.

PHP midgard_connection method get_error_string

Fri, 04 Apr 2008 07:59:17 +0000

Get latest error string.

string get_error_string(void);

midgard_connection method get_error_string takes no parameters and may be called statically.

Returns error string.

Example

<?php

 try
 {
     $object = midgard_person(1);
 }
 catch(midgard_error_exception $e)
 {
     echo "Failed to get object" . $e->getMessage();
 }

 $object->lastname = "Smith";

 if(!$object->update()) {

     echo midgard_connection::get_error_string();
 } 

 ?>

midgard_connection.

PHP midgard_connection method get_error

Fri, 04 Apr 2008 07:55:59 +0000

Get latest error id.

int get_error(void);

midgard_connection method get_error takes no parameters and may be called statically.

Returns error constant id.

List or error ids is documented in midgard-core documentation.

Example

<?php

 try
 {
     $object = midgard_person(0);
 }
 catch(midgard_error_exception $e)
 {
     echo "Failed to get object" . $e->getMessage();
 }

 $object->lastname = "Smith";

 if(!$object->update()) {

     if(midgard_connection::get_error() == MGD_ERR_NOT_EXISTS)
         echo "Can not update object which doesn't exist"; 
 } 

 ?>

midgard_connection.

PHP midgard_connection

Fri, 04 Apr 2008 07:44:16 +0000

This part of API is forward compatible and it's recommended for Midgard 1.9/2.0. This is experimental section.

MidgardConnection (midgard_connection) class initializes new Midgard connection and is responsible for holding and setting environmental variables ( like language, sitegroup, errors ). On PHP level is implemented as singleton object, and once connection object is created, it's available as $_MIDGARD_CONNECTION superglobal.

Minimum version: 1.9

Creating new midgard_connection ( constructor )

midgard_connection object is instantiated without arguments.

$cnc = new midgard_connection();

You do not have to store and keep reference to newly created object. Both calls are equal:

$cnc->open("midgard");
$_MIDGARD_CONNECTION->open("midgard");

Midgard Connection methods

PHP midgard_connection method get_lang

Fri, 04 Apr 2008 07:42:58 +0000

Get runtime language.

mixed get_lang(void);

midgard_connection method get_lang takes no parameters and may be called statically.

Returns two letter language code, which confirms ISO 639-1 standard. NULL is returned if runtime language is set to 0 ( no language context ).

Example

<?php

 $lang_code midgard_connection::get_lang();

 if(is_null($lang_code))
 {
     echo "No language set";
 }
 else 
 {
     echo "Language context is {$lang_code}"; 
 } 

 ?>

midgard_connection.

PHP midgard_connection method set_lang

Fri, 04 Apr 2008 07:34:39 +0000

Set runtime language.

boolean set_lang(code);

midgard_connection method set_lang takes one parameter and may be called statically.

language code

Language code should confirm ISO 639-1 standard. Yuo may use built-in midgard_language class to list all available languages and codes.

Returns TRUE if language is changed, FALSE otherwise.

'lang-changed' signal is emitted if language has been changed. You might want to invoke your own callback when connected to $_MIDGARD_CONNECTION.

Example

<?php

 $lang_code = 'pl';
 midgard_connection::set_lang($lang_code);

 ?>

midgard_connection.

PHP midgard_connection method get_sitegroup

Thu, 03 Apr 2008 20:28:20 +0000

Get runtime sitegroup.

mixed get_sitegroup(void);

midgard_connection method get_sitegroup takes no parameters and may be called statically.

Returns the name of the sitegroup for which application's sitegroup context is set. NULL is returned, if runtime sitegroup is 0.

Example

<?php

 $name = midgard_connection::get_sitegroup();

 echo "You are currently working in {$name} sitegroup"

 ?>

midgard_connection.

PHP midgard_connection method set_sitegroup

Thu, 03 Apr 2008 20:22:23 +0000

Set runtime sitegroup.

boolean set_sitegroup(name);

midgard_connection method set_sitegroup takes one parameter and may be called statically.

sitegroup name

Returns TRUE if sitegroup is changed, FALSE otherwise.

'sitegroup-changed' signal is emitted if sitegroup has been changed. You might want to invoke your own callback when connected to $_MIDGARD_CONNECTION.

Example ( using legacy MidgardSitegroup object )

<?php

 $legacy = mgd_get_sitegroup(1);

 midgard_connection::set_sitegroup($legacy->name);

 ?>

midgard_connection.

PHP midgard_connection method open_config

Thu, 03 Apr 2008 20:11:33 +0000

Create new connection using given configuration.

boolean open_config(midgard_config config);

midgard_connection method open_config takes one parameter.

midgard_config instance

Returns TRUE if connection has been established for given configuration, FALSE otherwise.

Example

<?php

 try {
     $config = new midgard_config();
 } catch (Exception $e) {
     echo $e->getMessage();  
 }

 try {
     $cnc = new midgard_connection();
 } catch (Exception $e) {
     echo $e->getMessage();  
 }

 if(!$config->read_file('midgard', true) 
 {
     echo "Couldn't open configuration from user directory";
     exit; 
 }

 if(!$cnc->open_config($config))
     echo "Could not connect with given configuration name";     
 ?>

midgard_connection.

PHP Midgard Core

Thu, 03 Apr 2008 20:04:47 +0000

Midgard Core API

Includes built in Midgard Classes

midgard_config - System wide or personal configurations and database management
midgard_connection - Connection handling and environment variables
midgard_user - User accounts and authentication
midgard_blob - Files and binary data

User defined class' support

Query Builder - Database object query API
Collector - Optimized database query API that doesn't return objects

Reflection like semi class

midgard_object_class API - A helper for Mgdschema classes

Reflection

Midgard Reflection Property API

Metadata

midgard_metadata

Replication

midgard_replicator API

MgdSchema API

User defined classes API

MgdSchema objects - Data handling API

Events

Handling events - Handling events

PHP midgard_connection method open

Thu, 03 Apr 2008 19:59:15 +0000

Create new connection using named configuration.

boolean open(name);

midgard_connection method open takes one parameter.

configuration name

Configuration is read from system wide directory. And depends on prefix defined for core. Usually /etc, /usr/local/etc.

Read about open_config method if you need to create connection using user's defined configuration.

Returns TRUE if connection has been established for named configuration, FALSE otherwise.

Example

<?php

 try {
     $cnc = new midgard_connection();
 } catch (Exception $e) {
     echo $e->getMessage();  
 }

 if(!$cnc->open('midgard'))
     echo "Could not connect with given configuration name";     
 ?>

PHP midgard_config

Thu, 03 Apr 2008 19:44:38 +0000

This part of API is forward compatible and it's recommended for Midgard 1.9/2.0. This is experimental section.

MidgardConfig ( midgard_config ) class manages user defined ( system wide or personal ) and named configurations. It also has ability to create or update user's class' database tables.

midgard_config object represents unified configuration. This class is partially usable in Apache environment. All attempts to read, list or write configuration will throw warning. Usually generic one: "Permission Denied".

Minimum version: 1.9

Creating new midgard_config ( Constructor )

midgard_config object is instantiated without arguments.

$config = new midgard_config();

Midgard Config methods

PHP midgard object method purge_attachments

Fri, 28 Mar 2008 09:51:43 +0000

Purge object's attachments.

boolean purge_attachments(array args);

This method behaves exactly like delete_attachments method.

Important difference is that, there's no possibility to undelete purged attachments.

PHP midgard object method delete_attachments

Fri, 28 Mar 2008 09:49:35 +0000

Delete object's attachments.

boolean delete_attachments(array args);

This method takes one argument:

args, associative array

Array's keys must be midgard_attachment properties' names, values should define constraints with properties's values.

Delete all attachments with matching properties' values. It's possible to undelete attachment which have been deleted with this method.

Returns TRUE on success, FALSE otherwise.

Example

<?php

/* Delete all image attachments */

 try {
     $style = new midgard_style($guid);
 } catch (Exception $e) {
     echo $e->getMessage();  
 }

 $args = array ("mimetype" => "image/jpeg");

 if($style->delete_attachments($args))
     echo "Deleted all image attachments";

 ?>

midgard object attachments

PHP midgard object method find_attachments

Fri, 28 Mar 2008 09:40:38 +0000

Find object's attachments.

array find_attachments(array args);

This method takes one argument:

args, associative array

Array's keys must be midgard_attachment properties' names, values should define constraints with properties's values.

Lists object's attachments and store them in returned array.

Returns array with midgard_attachment objects, or empty array if there are no parameters for object.

Example

<?php

/* Find all image attachments */

 try {
     $style = new midgard_style($guid);
 } catch (Exception $e) {
     echo $e->getMessage();  
 }

 $args = array ("mimetype" => "image/jpeg");

 $atts = $style->find_atachments($args);

 if(!empty($atts)) {

     foreach($atts as $obj) {

           echo $obj->name;
     }

 } else {

      echo "Didn't find any object's attachments";

 } 

 ?>

midgard object atachments