class CRM_ACL_API {
/**
- * The various type of permissions
+ * The various type of permissions.
*
* @var int
*/
}
/**
- * Get the permissioned where clause for the user
+ * Get the permissioned where clause for the user.
*
* @param int $type
* The type of permission needed.
}
/**
- * Get all the groups the user has access to for the given operation
+ * Get all the groups the user has access to for the given operation.
*
* @param int $type
* The type of permission needed.
}
/**
- * Get all of the ACLs through ACL groups
+ * Get all of the ACLs through ACL groups.
*
* @param int $contact_id
* ID of a contact to search for.
}
/**
- * Get all ACLs granted to a contact through all group memberships
+ * Get all ACLs granted to a contact through all group memberships.
*
* @param int $contact_id
* The contact's ID.
}
/**
- * Get all of the ACLs for a contact through ACL groups owned by Contact
+ * Get all of the ACLs for a contact through ACL groups owned by Contact.
* groups.
*
* @param int $contact_id
}
/**
- * Delete ACL records
+ * Delete ACL records.
*
* @param int $aclId
* ID of the ACL record to be deleted.
}
/**
- * Delete Entity Role records
+ * Delete Entity Role records.
*
* @param int $entityRoleId
* ID of the EntityRole record to be deleted.
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
class CRM_ACL_Form_EntityRole extends CRM_Admin_Form {
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
class CRM_ACL_Form_WordPress_Permissions extends CRM_Core_Form {
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
* @return void
*/
public $useLivePageJS = TRUE;
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Browse all acls
+ * Browse all acls.
*
* @return void
*/
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
class CRM_ACL_Page_ACLBasic extends CRM_Core_Page_Basic {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Browse all acls
+ * Browse all acls.
*
* @return void
*/
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
public $useLivePageJS = TRUE;
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Browse all acls
+ * Browse all acls.
*
* @return void
*/
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
}
/**
- * Delete the record that are associated with this case
+ * Delete the record that are associated with this case.
* record are deleted from case
*
* @param int $caseId
}
/**
- * Retrieve contact names by caseId
+ * Retrieve contact names by caseId.
*
* @param int $caseId
* ID of the case.
}
/**
- * Get Case roles
+ * Get Case roles.
*
* @param int $contactID
* Contact id.
}
/**
- * Get Case Activities
+ * Get Case Activities.
*
* @param int $caseID
* Case id.
}
/**
- * Get Case Related Contacts
+ * Get Case Related Contacts.
*
* @param int $caseID
* Case id.
}
/**
- * Create an activity for a case via email
+ * Create an activity for a case via email.
*
* @param int $file
* Email sent.
}
/**
- * Retrieve the scheduled activity type and date
+ * Retrieve the scheduled activity type and date.
*
* @param array $cases
* Array of contact and case id.
}
/**
- * Combine all the exportable fields from the lower levels object
+ * Combine all the exportable fields from the lower levels object.
*
* @return array
* array of exportable Fields
}
/**
- * Restore the record that are associated with this case
+ * Restore the record that are associated with this case.
*
* @param int $caseId
* Id of the case to restore.
}
/**
- * Convenience function to get both case contacts and global in one array
+ * Convenience function to get both case contacts and global in one array.
* @param int $caseId
*
* @return array
}
/**
- * Verify user has permission to access a case
+ * Verify user has permission to access a case.
*
* @param int $caseId
* @param bool $denyClosed
}
/**
- * Check whether activity is a case Activity
+ * Check whether activity is a case Activity.
*
* @param int $activityID
* Activity id.
}
/**
- * Get all the case type ids currently in use
+ * Get all the case type ids currently in use.
*
* @return array
*/
}
/**
- * Get all the case status ids currently in use
+ * Get all the case status ids currently in use.
*
* @return array
*/
}
/**
- * Get all the encounter medium ids currently in use
+ * Get all the encounter medium ids currently in use.
*
* @return array
*/
}
/**
- * Used during case component enablement and during ugprade
+ * Used during case component enablement and during ugprade.
*
* @return bool
*/
}
/**
- * Get the list of clients for a case
+ * Get the list of clients for a case.
*
* @param int $caseId
*
class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType {
/**
- * Static field for all the case information that we can potentially export
+ * Static field for all the case information that we can potentially export.
*
* @var array
*/
static $_exportableFields = NULL;
/**
- * Takes an associative array and creates a Case Type object
+ * Takes an associative array and creates a Case Type object.
*
* the function extract all the params it needs to initialize the create a
* case type object. the params array could contain additional unused name/value
}
/**
- * Get the case definition either from db or read from xml file
+ * Get the case definition either from db or read from xml file.
*
* @param SimpleXmlElement $xml
* A single case-type record.
}
/**
- * Takes an associative array and creates a case type object
+ * Takes an associative array and creates a case type object.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
class CRM_Case_Form_Activity extends CRM_Activity_Form_Activity {
/**
- * The default variable defined
+ * The default variable defined.
*
* @var int
*/
public $_caseId;
/**
- * The default case type variable defined
+ * The default case type variable defined.
*
* @var int
*/
public $_caseType;
/**
- * The default values of an activity
+ * The default values of an activity.
*
* @var array
*/
public $_defaults = array();
/**
- * The array of releted contact info
+ * The array of releted contact info.
*
* @var array
*/
public $_relatedContacts;
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global form rule
+ * Global form rule.
*
* @param array $fields
* The input form values.
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @param array $params
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $values
* Posted values of the form.
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @param CRM_Core_Form $form
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @param CRM_Core_Form $form
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $values
* Posted values of the form.
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @param CRM_Core_Form $form
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @param CRM_Core_Form $form
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $values
* Posted values of the form.
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @param CRM_Core_Form $form
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @param CRM_Core_Form $form
const PREFIX = 'custom_value_';
/**
- * The set of custom field ids
+ * The set of custom field ids.
*
* @var array
*/
protected $_ids;
/**
- * The select clause
+ * The select clause.
*
* @var array
*/
public $_select;
/**
- * The name of the elements that are in the select clause
+ * The name of the elements that are in the select clause.
* used to extract the values
*
* @var array
public $_element;
/**
- * The tables involved in the query
+ * The tables involved in the query.
*
* @var array
*/
public $_whereTables;
/**
- * The where clause
+ * The where clause.
*
* @var array
*/
public $_where;
/**
- * The english language version of the query
+ * The english language version of the query.
*
* @var array
*/
public $_qill;
/**
- * The cache to translate the option values into labels
+ * The cache to translate the option values into labels.
*
* @var array
*/
public $_options;
/**
- * The custom fields information
+ * The custom fields information.
*
* @var array
*/
protected $_locationSpecificCustomFields;
/**
- * This stores custom data group types and tables that it extends
+ * This stores custom data group types and tables that it extends.
*
* @var array
*/
);
/**
- * Class constructor
+ * Class constructor.
*
* Takes in a set of custom field ids andsets up the data structures to
* generate a query
}
/**
- * Generate the select clause and the associated tables
+ * Generate the select clause and the associated tables.
* for the from clause
*
* @return void
}
/**
- * Generate the where clause and also the english language
+ * Generate the where clause and also the english language.
* equivalent
*
* @return void
}
/**
- * Function that does the actual query generation
+ * Function that does the actual query generation.
* basically ties all the above functions together
*
* @return array
projects / civicrm-core.git / commitdiff