eZ\Publish\Core\FieldType\FieldType::getSettingsSchema PHP Method

getSettingsSchema() public method

This implementation returns an array. where the key is the setting name, and the value is the default value for given setting and set to null if no particular default should be set.
public getSettingsSchema ( ) : mixed
return mixed
    public function getSettingsSchema()
    {
        return $this->settingsSchema;
    }

Usage Example

Beispiel #1
0
 /**
  * Returns a schema for the settings expected by the FieldType.
  *
  * Returns an arbitrary value, representing a schema for the settings of
  * the FieldType.
  *
  * Explanation: There are no possible generic schemas for defining settings
  * input, which is why no schema for the return value of this method is
  * defined. It is up to the implementer to define and document a schema for
  * the return value and document it. In addition, it is necessary that all
  * consumers of this interface (e.g. Public API, REST API, GUIs, ...)
  * provide plugin mechanisms to hook adapters for the specific FieldType
  * into. These adapters then need to be either shipped with the FieldType
  * or need to be implemented by a third party. If there is no adapter
  * available for a specific FieldType, it will not be usable with the
  * consumer.
  *
  * @return mixed
  */
 public function getSettingsSchema()
 {
     return $this->internalFieldType->getSettingsSchema();
 }