- Queries
- All Atoms
- Search
- Advanced Search
Diviner All Atoms
All Atoms
All Atoms
- Appearing in ApplicationTrasactions allows a field to be edited using standard workflows.
- Method
- Append search controls to the interface.
- Method
- Constrain a query, given a field value. Generally, this method should use `with...()` methods to apply filters or other constraints to the query.
- Method
- Read a query value from a request, for storage in a saved query. Normally, this method should, e.g., read a string out of the request.
- Method
- Build and populate storage for a numeric index.
- Method
- Build and populate storage for a string index.
- Method
- Build a new empty storage object for storing string indexes. Normally, this should be a concrete subclass of @{class:PhabricatorCustomFieldStringIndexStorage}.
- Method
- Build a new empty storage object for storing string indexes. Normally, this should be a concrete subclass of @{class:PhabricatorCustomFieldStringIndexStorage}.
- Method
- Return an index against which this field can be meaningfully ordered against to implement ApplicationSearch.
- Method
- Return one or more indexes which this field can meaningfully query against to implement ApplicationSearch.
- Method
- Appearing in ApplicationSearch allows a field to be indexed and searched for.
- Method
- Method
- Set the field's value given a serialized storage value. This is called when the field is loaded; if no data is available, the value will be null. You must implement this method if you implement @{method:shouldUseStorage}.
- Method
- Return a serialized representation of the field value, appropriate for storing in auxiliary field storage. You must implement this method if you implement @{method:shouldUseStorage}.
- Method
- Return a new, empty storage object. This should be a subclass of @{class:PhabricatorCustomFieldStorage} which is bound to the application's database.
- Method
- Return true to use field storage.
- Method
- Method
- Method
- Method
- Method
- This is a hook, primarily for subclasses to load object data.
- Method
- Get the object this field belongs to.
- Method
- Read object data into local field storage, if applicable.
- Method
- Sets the object this field belongs to.
- Method
- Get the field's proxy implementation, if any. For discussion, see @{method:canSetProxy}.
- Method
- Set the proxy implementation for this field. See @{method:canSetProxy} for discussion of field proxies.
- Method
- Proxies allow a field to use some other field's implementation for most of their behavior while still subclassing an application field. When a proxy is set for a field with @{method:setProxy}, all of its methods will call through to the proxy by default.
- Method
- Return an index string which uniquely identifies this field.
- Method
- Method
- Allow administrators to disable this field. Most fields should allow this, but some are fundamental to the behavior of the application and can be locked down to avoid chaos, disorder, and the decline of civilization.
- Method
- Low level selector for field availability. Fields can appear in different roles (like an edit view, a list view, etc.), but not every field needs to appear everywhere. Fields that are disabled in a role won't appear in that context within applications.
- Method
- You can return `false` here if the field should not be enabled for any role. For example, it might depend on something (like an application or library) which isn't installed, or might have some global configuration which allows it to be disabled.
- Method
- Most field implementations are unique, in that one class corresponds to one field. However, some field implementations are general and a single implementation may drive several fields.
- Method
- Return a short, human-readable description of the field's behavior. This provides more context to administrators when they are customizing fields.
- Method
- Return a human-readable field name.
- Method
- Method
- Return a key which uniquely identifies this field, like "mycompany:dinosaur:count". Normally you should provide some level of namespacing to prevent collisions.
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method
- Method