$object->searchparameters

(unknown)

$object->searchparameters -- Search record parameters

Description

object $object->searchparameters (string where, boolean [all])

Minimum version: Midgard 1.4 (Bifrost)

Warning

This is an experimental method. Its interface may change. It may even go away completely. Not to be used in any production site.

Lists parameters. where is a straight SQL WHERE clause against the parameter table. If all is given and TRUE, all parameters pertaining to records of the same type as the record represented by $object are searched. If all is omitted or FALSE, only the parameters of the record represented by $object are searched. In either case a list object is returned that can be traversed by calling fetch. Fields of this object are: id (parent id) pid (parameter id), domain, name and value.

Returns an object traversable by calling fetch() if successful. Returns FALSE on failure.

Method available for: article, attachment, element, event, event_member, group, host, member, page, pageelement, pagelink, person, preference, sitegroup, snippet, snippetdir, style and topic objects.