Documentation

CustomField extends DAOEntity
in package
uses ManagedEntity, SortableEntity

CustomField entity.

Tags
see
https://docs.civicrm.org/user/en/latest/organising-your-data/creating-custom-fields/
searchable

secondary

orderBy

weight

groupWeightsBy

custom_group_id

since
5.19

Table of Contents

Methods

__callStatic()  : AbstractAction
Magic method to return the action object for an api.
autocomplete()  : AutocompleteAction
checkAccess()  : CheckAccessAction
create()  : Create
delete()  : DAODeleteAction
export()  : ExportAction
get()  : DAOGetAction
getActions()  : GetActions
getEntityName()  : string
Get entity name from called class
getFields()  : DAOGetFieldsAction
getInfo()  : array{name: string, title: string, description: string, title_plural: string, type: string, paths: array, class: string, primary_key: array, searchable: string, dao: string, label_field: string, icon: string}
Reflection function called by Entity::get()
getLinks()  : GetLinks
permissions()  : array<string|int, mixed>
Returns a list of permissions needed to access the various actions in this api.
replace()  : BasicReplaceAction
revert()  : BasicBatchAction
save()  : Save
update()  : Update
getDaoName()  : CRM_Core_DAO|string|null
getEntityTitle()  : string
Overridable function to return a localized title for this entity.

Methods

create()

public static create([bool $checkPermissions = TRUE ]) : Create
Parameters
$checkPermissions : bool = TRUE
Return values
Create

getEntityName()

Get entity name from called class

public static getEntityName() : string
Return values
string

getInfo()

Reflection function called by Entity::get()

public static getInfo() : array{name: string, title: string, description: string, title_plural: string, type: string, paths: array, class: string, primary_key: array, searchable: string, dao: string, label_field: string, icon: string}
Tags
see
Get
Return values
array{name: string, title: string, description: string, title_plural: string, type: string, paths: array, class: string, primary_key: array, searchable: string, dao: string, label_field: string, icon: string}

getLinks()

public static getLinks([bool $checkPermissions = TRUE ]) : GetLinks
Parameters
$checkPermissions : bool = TRUE
Return values
GetLinks

permissions()

Returns a list of permissions needed to access the various actions in this api.

public static permissions() : array<string|int, mixed>
Return values
array<string|int, mixed>

save()

public static save([bool $checkPermissions = TRUE ]) : Save
Parameters
$checkPermissions : bool = TRUE
Return values
Save

update()

public static update([bool $checkPermissions = TRUE ]) : Update
Parameters
$checkPermissions : bool = TRUE
Return values
Update

getEntityTitle()

Overridable function to return a localized title for this entity.

protected static getEntityTitle([bool $plural = FALSE ]) : string
Parameters
$plural : bool = FALSE

Whether to return a plural title.

Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results