Wrapper for midcom_core_collector. It adds some additional logic to return related objects directly
This class must be used anyplace within MidCOM instead of the real midgard_collector object within the MidCOM Framework. This wrapper is required for the correct operation of many MidCOM services.
It essentially wraps the calls to midcom_helper__dbfactory::new_collector().
Normally you should never have to create an instance of this type directly, instead use the new_collector() method available in the MidCOM DBA API or the midcom_helper__dbfactory::new_collector() method which is still available.
If you have to do create the instance manually however, do not forget to call the \initialize() function after construction, or the creation callbacks will fail.
$hide_invisible : boolean
Set this element to true to hide all items which are currently invisible according to the approval/scheduling settings made using Metadata. This must be set before executing the query.
NOTE: Approval checks not implemented in collector yet
Be aware, that this setting will currently not use the QB to filter the objects accordingly, since there is no way yet to filter against parameters. This will mean some performance impact.
__construct(mixed $guids, mixed $classes, string $direction = 'incoming')
Constructor, takes one or more object guids and classnames and constructs a collector accordingly.
Attention: At least one of these arguments has to be a string
| mixed | $guids | One or more object guids |
| mixed | $classes | One or more target classes |
| string | $direction | incoming or outgoing |
list_keys_unchecked()
Runs a query where limit and offset is taken into account <i>prior</i> to execution in the core.
This is useful in cases where you can safely assume read privileges on all objects, and where you would otherwise have to deal with huge resultsets.
Be aware that this might lead to empty resultsets "in the middle" of the actual full resultset when read privileges are missing.
get_rows(array $fields, string $indexed_by = 'guid') : array
Convenience function to get all values of a number of columns They are indexed by GUID unless you specify something else
| array | $fields | The fields to get |
| string | $indexed_by | the column name to be used as index |
add_constraint(string $field, string $operator, mixed $value) : boolean
Add a constraint to the query.
| string | $field | The name of the MgdSchema property to query against. |
| string | $operator | The operator to use for the constraint, currently supported are <, <=, =, <>, >=, >, LIKE. LIKE uses the percent sign ('%') as a wildcard character. |
| mixed | $value | The value to compare against. It should be of the same type as the queried property. |
Indicating success.
add_constraint_with_property(string $field, string $operator, string $compare_field) : boolean
Add a constraint against another DB column to the query.
| string | $field | The name of the MgdSchema property to query against. |
| string | $operator | The operator to use for the constraint, currently supported are <, <=, =, <>, >=, >, LIKE. LIKE uses the percent sign ('%') as a wildcard character. |
| string | $compare_field | The field to compare against. |
Indicating success.
begin_group(string $operator = 'OR')
Creates a new logical group within the query. They are set in parentheses in the final SQL and will thus be evaluated with precedence over the normal out-of-group constraints.
While the call lets you decide whether all constraints within the group are AND'ed or OR'ed, only OR constraints make logically sense in this context, which is why this proxy function sets 'OR' as the default operator.
| string | $operator | One of 'OR' or 'AND' denoting the logical operation with which all constraints in the group are concatenated. |
add_order(string $field, string $direction = 'ASC') : boolean
Add an ordering constraint to the query builder.
| string | $field | The name of the MgdSchema property to query against. |
| string | $direction | One of 'ASC' or 'DESC' indicating ascending or descending ordering. The default is 'ASC'. |
Indicating success.
get_related_objects_grouped_by(string $key) : array<mixed,\midcom_core_dbaobject>
| string | $key | The column the results should be grouped by |
DBA objects grouped by the specified key
get_related_objects(string $component = false) : array<mixed,\midcom_core_dbaobject>
| string | $component | A component name to further narrow down the results |
DBA objects
_convert_class(string $classname) : string
Class resolution into the MidCOM DBA system.
Currently, Midgard requires the actual MgdSchema base classes to be used when dealing with the query, so we internally note the corresponding class information to be able to do correct typecasting later.
| string | $classname | The classname which should be converted. |
MgdSchema class name
_apply_object_constraints(\midcom_core_querybuilder $qb)
Apply constraints (if any) to the final object QBs
| \midcom_core_querybuilder | $qb | the QB instance in question |
_apply_object_orders(\midcom_core_querybuilder $qb)
Apply orders (if any) to the final object QBs
| \midcom_core_querybuilder | $qb | the QB instance in question |
_apply_object_limit(\midcom_core_querybuilder $qb)
Apply the limit (if any) to the final object QBs
| \midcom_core_querybuilder | $qb | the QB instance in question |