$object->parameter

1. MidCOM 2.6 and upwards
2. Notes
3. Description

$object->parameter -- Set or get a record parameter

Recommended to avoid, if using MidCOM 2.6 or later.

MidCOM 2.6 and upwards

MidCOM db object methods are highly recommended, instead of using $object->parameter() both as setter and getter method.

• $object->get_parameter()
• $object->set_parameter()

Notes

Use methods $object->set_parameter(_string_ domain, _string_ name, _string_ value) to set parameter value and $object->get_parameter(_string_ domain, _string_ name, _string_ value) with MidCOM 2.6.

Description

_int_ *$object->parameter* (_string_ domain, _string_ name, _string_ value, bool)

_string_ *$object->parameter* (_string_ domain, _string_ name)

Minimum version: Midgard 1.4 (Bifrost). Fourth parameter since Midgard 1.7.

This method has four 'modes' of operation.

1. When called with (domain, name), the value of the parameter will be returned.
2. When called with $object->parameter(_domain_, _name_, _value_) and value being a non-empty string, the parameter denoted by (domain, name) will be set to value. The parameter will be created if it doesn't exist yet.
3. When called with $object->parameter(_domain_, _name_, _value_) and value being an empty string, the parameter denoted by (domain, name) will be deleted.
4. Fourth optional boolean parameter (when set to true) sets the language of the parameter to midgard internal language.

By default all the parameters of the object are created or updated with lang being set to 0.

You may set internal lang using mgd_set_lang function.

Returns value of parameter or true if successful. Returns false on failure.

<?php
    $person = new midcom_db_person(123); // person with id 123 must exist.  
    
    $person->parameter('Midgard','skill','novice');  
    $person->parameter('Midgard','skill','intermediate');  
    $person->parameter('Midgard','skill','');
    ?>

Method available for MgdSchema objects.

Tagged

parameter

set_parameter

get_parameter