Field that stores a hashed and salted password
Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the FieldtypePassword class also inherits all the methods and properties of: Fieldtype, WireData and Wire.
Common
| Name | Return | Summary | |
|---|
FieldtypePassword::getBlankValue() FieldtypePassword::getBlankValue(Page $page, Field $field) FieldtypePassword::getBlankValue(Page $page, Field $field) | Password | Get a blank password item object | |
FieldtypePassword::getCompatibleFieldtypes() FieldtypePassword::getCompatibleFieldtypes(Field $field) FieldtypePassword::getCompatibleFieldtypes(Field $field) | null array | Return all Fieldtypes derived from FieldtypeText, which we will consider compatible | |
FieldtypePassword::getConfigInputfields() FieldtypePassword::getConfigInputfields(Field $field) FieldtypePassword::getConfigInputfields(Field $field) | InputfieldWrapper | Return the fields required to configure an instance of FieldtypePassword | |
FieldtypePassword::getDatabaseSchema() FieldtypePassword::getDatabaseSchema(Field $field) FieldtypePassword::getDatabaseSchema(Field $field) | array | Return the database schema in specified format | |
FieldtypePassword::getInputfield() FieldtypePassword::getInputfield(Page $page, Field $field) FieldtypePassword::getInputfield(Page $page, Field $field) | InputfieldPassword | Return the associated Inputfield | |
FieldtypePassword::sanitizeValue() FieldtypePassword::sanitizeValue(Page $page, Field $field, $value) FieldtypePassword::sanitizeValue(Page $page, Field $field, $value) | Password | Sanitize value for runtime | |
FieldtypePassword::sleepValue() FieldtypePassword::sleepValue(Page $page, Field $field, $value) FieldtypePassword::sleepValue(Page $page, Field $field, $value) | array string int | Given an 'awake' value, as set by wakeupValue, convert the value back to a basic type for storage in DB. | |
FieldtypePassword::wakeupValue() FieldtypePassword::wakeupValue(Page $page, Field $field, array $value) FieldtypePassword::wakeupValue(Page $page, Field $field, array $value) | Password | Given a raw value (value as stored in DB), return the value as it would appear in a Page object | |
Additional methods and properties
In addition to the methods and properties above, FieldtypePassword also inherits the methods and properties of these classes:
API reference based on ProcessWire core version 3.0.244