X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FACL%2FDAO%2FEntityRole.php;h=d807024237164b6caa4d3a1bc6d9d07d226e662c;hb=27d46709dffec4bdc618563721970c5103731442;hp=88677377a02f2a98131a4e681b9041886ff9c560;hpb=40defe378c094a5ec00970673915d28b198f8eb6;p=civicrm-core.git diff --git a/CRM/ACL/DAO/EntityRole.php b/CRM/ACL/DAO/EntityRole.php index 88677377a0..d807024237 100644 --- a/CRM/ACL/DAO/EntityRole.php +++ b/CRM/ACL/DAO/EntityRole.php @@ -1,198 +1,192 @@ __table = 'civicrm_acl_entity_role'; parent::__construct(); } + /** * Returns foreign keys and entity references. * * @return array * [CRM_Core_Reference_Interface] */ - static function getReferenceColumns() { + public static function getReferenceColumns() { if (!isset(Civi::$statics[__CLASS__]['links'])) { Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__); - Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName() , 'entity_id', NULL, 'id', 'entity_table'); + Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName(), 'entity_id', NULL, 'id', 'entity_table'); CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); } return Civi::$statics[__CLASS__]['links']; } + /** * Returns all the column names of this table * * @return array */ - static function &fields() { + public static function &fields() { if (!isset(Civi::$statics[__CLASS__]['fields'])) { - Civi::$statics[__CLASS__]['fields'] = array( - 'id' => array( + Civi::$statics[__CLASS__]['fields'] = [ + 'id' => [ 'name' => 'id', 'type' => CRM_Utils_Type::T_INT, - 'title' => ts('Entity Role') , + 'title' => ts('Entity Role'), 'description' => 'Unique table ID', - 'required' => true, + 'required' => TRUE, 'table_name' => 'civicrm_acl_entity_role', 'entity' => 'EntityRole', 'bao' => 'CRM_ACL_BAO_EntityRole', - ) , - 'acl_role_id' => array( + 'localizable' => 0, + ], + 'acl_role_id' => [ 'name' => 'acl_role_id', 'type' => CRM_Utils_Type::T_INT, - 'title' => ts('ACL Role ID') , + 'title' => ts('ACL Role ID'), 'description' => 'Foreign Key to ACL Role (which is an option value pair and hence an implicit FK)', - 'required' => true, + 'required' => TRUE, 'table_name' => 'civicrm_acl_entity_role', 'entity' => 'EntityRole', 'bao' => 'CRM_ACL_BAO_EntityRole', - ) , - 'entity_table' => array( + 'localizable' => 0, + ], + 'entity_table' => [ 'name' => 'entity_table', 'type' => CRM_Utils_Type::T_STRING, - 'title' => ts('Entity Table') , + 'title' => ts('Entity Table'), 'description' => 'Table of the object joined to the ACL Role (Contact or Group)', - 'required' => true, + 'required' => TRUE, 'maxlength' => 64, 'size' => CRM_Utils_Type::BIG, 'table_name' => 'civicrm_acl_entity_role', 'entity' => 'EntityRole', 'bao' => 'CRM_ACL_BAO_EntityRole', - ) , - 'entity_id' => array( + 'localizable' => 0, + ], + 'entity_id' => [ 'name' => 'entity_id', 'type' => CRM_Utils_Type::T_INT, - 'title' => ts('ACL Entity ID') , + 'title' => ts('ACL Entity ID'), 'description' => 'ID of the group/contact object being joined', - 'required' => true, + 'required' => TRUE, 'table_name' => 'civicrm_acl_entity_role', 'entity' => 'EntityRole', 'bao' => 'CRM_ACL_BAO_EntityRole', - ) , - 'is_active' => array( + 'localizable' => 0, + ], + 'is_active' => [ 'name' => 'is_active', 'type' => CRM_Utils_Type::T_BOOLEAN, - 'title' => ts('ACL Entity Role is Active') , + 'title' => ts('ACL Entity Role is Active'), 'description' => 'Is this property active?', 'table_name' => 'civicrm_acl_entity_role', 'entity' => 'EntityRole', 'bao' => 'CRM_ACL_BAO_EntityRole', - ) , - ); + 'localizable' => 0, + ], + ]; CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); } return Civi::$statics[__CLASS__]['fields']; } + /** * Return a mapping from field-name to the corresponding key (as used in fields()). * * @return array * Array(string $name => string $uniqueName). */ - static function &fieldKeys() { + public static function &fieldKeys() { if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); } return Civi::$statics[__CLASS__]['fieldKeys']; } + /** * Returns the names of this table * * @return string */ - static function getTableName() { + public static function getTableName() { return self::$_tableName; } + /** * Returns if this table needs to be logged * - * @return boolean + * @return bool */ - function getLog() { + public function getLog() { return self::$_log; } + /** * Returns the list of fields that can be imported * @@ -200,10 +194,11 @@ class CRM_ACL_DAO_EntityRole extends CRM_Core_DAO { * * @return array */ - static function &import($prefix = false) { - $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'acl_entity_role', $prefix, array()); + public static function &import($prefix = FALSE) { + $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'acl_entity_role', $prefix, []); return $r; } + /** * Returns the list of fields that can be exported * @@ -211,8 +206,39 @@ class CRM_ACL_DAO_EntityRole extends CRM_Core_DAO { * * @return array */ - static function &export($prefix = false) { - $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'acl_entity_role', $prefix, array()); + public static function &export($prefix = FALSE) { + $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'acl_entity_role', $prefix, []); return $r; } + + /** + * Returns the list of indices + * + * @param bool $localize + * + * @return array + */ + public static function indices($localize = TRUE) { + $indices = [ + 'index_role' => [ + 'name' => 'index_role', + 'field' => [ + 0 => 'acl_role_id', + ], + 'localizable' => FALSE, + 'sig' => 'civicrm_acl_entity_role::0::acl_role_id', + ], + 'index_entity' => [ + 'name' => 'index_entity', + 'field' => [ + 0 => 'entity_table', + 1 => 'entity_id', + ], + 'localizable' => FALSE, + 'sig' => 'civicrm_acl_entity_role::0::entity_table::entity_id', + ], + ]; + return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; + } + }