add_group (line 1736)

add_group()

Inserts a group, defaults to be on the "root" branch.

Since v3.3.x you can only create one group with Parent_ID=0 So, its a good idea to create a "Virtual Root" group with Parent_ID=0 Then assign other groups to that.

• return: New Group ID # if successful, FALSE if otherwise.

• string $value: Group Value
• string $name: Group Name
• int $parent_id: Parent Group ID #
• string $group_type: Group Type, either 'ARO' or 'AXO'

add_object (line 3029)

add_object()

Inserts a new object

• return: Returns the ID # of the new object if successful, FALSE otherwise

• string $section_value: Object Section Value
• string $name: Object Name
• string $value: Object Value
• int $order: Display Order
• int $hidden: Hidden Flag, either 1 to hide, or 0 to show.
• string $object_type: Object Type, either 'ACO', 'ARO', or 'AXO'

append_acl (line 426)

append_acl()

Appends objects on to a specific ACL.

• return: TRUE if successful, FALSE otherwise.

• int $acl_id: ACL ID #
• array $aro_array: Associative array, item={Section Value}, key={Array of Object Values} i.e. ["<Section Value>" => ["<Value 1>", "<Value 2>", "<Value 3>"], ...]
• array $aro_group_ids: Array of Group IDs
• array $axo_array: Associative array, item={Section Value}, key={Array of Object Values} i.e. ["<Section Value>" => ["<Value 1>", "<Value 2>", "<Value 3>"], ...]
• array $axo_group_ids: Array of Group IDs
• array $aco_array: Associative array, item={Section Value}, key={Array of Object Values} i.e. ["<Section Value>" => ["<Value 1>", "<Value 2>", "<Value 3>"], ...]

consolidated_edit_acl (line 159)

consolidated_edit_acl()

Add's an ACL but checks to see if it can consolidate it with another one first.

This ONLY works with ACO's and ARO's. Groups, and AXO are excluded. As well this function is designed for handling ACLs with return values, and consolidating on the return_value, in hopes of keeping the ACL count to a minimum.

A return value of false must _always_ be handled outside this function. As this function will remove AROs from ACLs and return false, in most cases you will need to a create a completely new ACL on a false return.

• return: Special boolean return value. See note.

• string $aco_section_value: ACO Section Value
• string $aco_value: ACO Value
• string $aro_section_value: ARO Section Value
• string $aro_value: ARO Value
• string $return_value: Return Value of ACL

del_acl (line 1223)

del_acl()

Deletes a given ACL

• return: Returns TRUE if successful, FALSE otherwise.

• int $acl_id: ACL ID # to delete

del_group_object (line 2034)

del_group_object()

Removes an Object from a group.

• return: Returns TRUE if successful, FALSE otherwise

• int $group_id: Group ID #
• string $object_section_value: Object Section Value
• string $object_value: Object Value
• string $group_type: Group Type, either 'ARO' or 'AXO'

del_object_section (line 3746)

del_object_section()

Deletes a given Object Section and, if explicitly asked, all the section objects

ERASE feature by: Martino Piccinato

• return: Returns TRUE if successful, FALSE otherwise

• int $object_section_id: Object Section ID # to delete
• string $object_type: Object Type, either 'ACO', 'ARO', 'AXO', or 'ACL'
• bool $erase: Erases all section objects assigned to the section

edit_group (line 2093)

edit_group()

Edits a group

• return: Returns TRUE if successful, FALSE otherwise

• int $group_id: Group ID #
• string $value: Group Value
• string $name: Group Name
• int $parent_id: Parent ID #
• string $group_type: Group Type, either 'ARO' or 'AXO'

edit_object_section (line 3606)

edit_object_section()

Edits a given Object Section

• return: Returns TRUE if successful, FALSE otherwise

• int $object_section_id: Object Section ID #
• string $name: Object Section Name
• string $value: Object Section Value
• int $order: Display Order
• int $hidden: Hidden Flag, hide object section if 1, show if 0
• string $object_type: Object Type, either 'ACO', 'ARO', 'AXO', or 'ACL'

get_acl (line 703)

get_acl()

Grabs ACL data.

• return:

  bool FALSE if not found, or Associative Array with the following items:

  • 'aco' => Associative array, item={Section Value}, key={Array of Object Values} i.e. ["<Section Value>" => ["<Value 1>", "<Value 2>", "<Value 3>"], ...]
  • 'aro' => Associative array, item={Section Value}, key={Array of Object Values} i.e. ["<Section Value>" => ["<Value 1>", "<Value 2>", "<Value 3>"], ...]
  • 'axo' => Associative array, item={Section Value}, key={Array of Object Values} i.e. ["<Section Value>" => ["<Value 1>", "<Value 2>", "<Value 3>"], ...]
  • 'aro_groups' => Array of Group IDs
  • 'axo_groups' => Array of Group IDs
  • 'acl_id' => int ACL ID #
  • 'allow' => int Allow flag
  • 'enabled' => int Enabled flag
  • 'return_value' => string Return Value
  • 'note' => string Note

• int $acl_id: ACL ID #

get_group_data (line 1559)

get_group_data()

Gets the group data given the GROUP_ID.

• return: Returns numerically indexed array with the following columns:
  • array[0] = (int) Group ID #
  • array[1] = (int) Parent Group ID #
  • array[2] = (string) Group Value
  • array[3] = (string) Group Name
  • array[4] = (int) lft MPTT Value
  • array[5] = (int) rgt MPTT Value

• int $group_id: Group ID #
• string $group_type: Group Type, either 'ARO' or 'AXO'

get_group_objects (line 1867)

get_group_objects()

Gets all objects assigned to a group.

If $option == 'RECURSE' it will get all objects in child groups as well. defaults to omit child groups.

• return: Associative array, item={Section Value}, key={Array of Object Values} i.e. ["<Section Value>" => ["<Value 1>", "<Value 2>", "<Value 3>"], ...]

• int $group_id: Group ID #
• string $group_type: Group Type, either 'ARO' or 'AXO'
• string $option: Option, either 'RECURSE' or 'NO_RECURSE'

get_object (line 2565)

get_object()

Grabs all Objects's in the database, or specific to a section_value

• return: Returns recordset directly, with object ID only selected:

• string $section_value: Filter to this section value
• int $return_hidden: Returns hidden objects if 1, leaves them out otherwise.
• string $object_type: Object Type, either 'ACO', 'ARO', 'AXO', or 'ACL'

get_object_data (line 2758)

get_object_data()

Gets all data pertaining to a specific Object.

• return: Returns 2-Dimensional array of rows with columns = ( section_value, value, order_value, name, hidden )

• int $object_id: Object ID #
• string $object_type: Object Type, either 'ACO', 'ARO', 'AXO'

get_object_id (line 2818)

get_object_id()

Gets the object_id given the section_value AND value of the object.

• return: Object ID #

• string $section_value: Object Section Value
• string $value: Object Value
• string $object_type: Object Type, either 'ACO', 'ARO', 'AXO'

get_object_section_value (line 2889)

get_object_section_value()

Gets the object_section_value given object id

• return: Object Section Value

• int $object_id: Object ID #
• string $object_type: Object Type, either 'ACO', 'ARO', or 'AXO'

get_schema_version (line 125)

get_schema_version()

Grabs phpGACL schema version from the database.

• return: Schema Version

get_ungrouped_objects (line 2632)

get_ungrouped_objects()

Grabs ID's of all Objects (ARO's and AXO's only) in the database not assigned to a Group.

This function is useful for applications that synchronize user databases with an outside source. If syncrhonization doesn't automatically place users in an appropriate group, this function can quickly identify them so that they can be assigned to the correct group.

• return: Returns an array of object ID's

• int $return_hidden: Returns hidden objects if 1, does not if 0.
• string $object_type: Object Type, either 'ARO' or 'AXO' (groupable types)

is_conflicting_acl (line 803)

is_conflicting_acl()

Checks for conflicts when adding a specific ACL.

• return: Returns true if conflict is found.

• array $aco_array: Associative array, item={Section Value}, key={Array of Object Values} i.e. ["<Section Value>" => ["<Value 1>", "<Value 2>", "<Value 3>"], ...]
• array