class FacConfig in Fast Autocomplete 8

Defines the FacConfig entity.

Plugin annotation


@ConfigEntityType(
  id = "fac_config",
  label = @Translation("Fast Autocomplete configuration"),
  label_collection = @Translation("Fast Autocomplete configurations"),
  label_singular = @Translation("Fast Autocomplete configuration"),
  label_plural = @Translation("Fast Autocomplete configurations"),
  label_count = @PluralTranslation(
    singular = "@count Fast Autocomplete configuration",
    plural = "@count Fast Autocomplete configurations",
  ),
  handlers = {
    "list_builder" = "Drupal\fac\Controller\FacConfigListBuilder",
    "form" = {
      "default" = "Drupal\fac\Form\FacConfigForm",
      "add" = "Drupal\fac\Form\FacConfigForm",
      "edit" = "Drupal\fac\Form\FacConfigForm",
      "delete" = "Drupal\fac\Form\FacConfigDeleteForm",
      "disable" = "Drupal\fac\Form\FacConfigDisableConfirmForm",
      "enable" = "Drupal\fac\Form\FacConfigEnableConfirmForm",
    }
  },
  config_prefix = "fac_config",
  admin_permission = "administer fac settings",
  entity_keys = {
    "id" = "id",
    "label" = "label",
    "uuid" = "uuid",
    "status" = "status",
  },
  config_export = {
    "id",
    "label",
    "searchPluginId",
    "searchPluginConfig",
    "inputSelectors",
    "numberOfResults",
    "emptyResult",
    "viewModes",
    "keyMinLength",
    "keyMaxLength",
    "allResultsLink",
    "allResultsLinkThreshold",
    "breakpoint",
    "resultLocation",
    "highlightingEnabled",
    "anonymousSearch",
    "cleanUpFiles",
    "filesExpiryTime",
  },
  links = {
    "edit-form" = "/admin/config/searchfac/fac_config}",
    "delete-form" = "/admin/config/search/fac/{fac_config}/delete",
    "disable" = "/admin/config/search/fac/{fac_config}/disable",
    "enable" = "/admin/config/search/fac/fac_config}/enable",
  }
)

Hierarchy

class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
  - class \Drupal\fac\Entity\FacConfig implements FacConfigInterface

Expanded class hierarchy of FacConfig

File

src/Entity/FacConfig.php, line 70

Namespace

Drupal\fac\Entity

View source

class FacConfig extends ConfigEntityBase implements FacConfigInterface {

  /**
   * The FacConfig ID.
   *
   * @var string
   */
  public $id;

  /**
   * The FacConfig label.
   *
   * @var string
   */
  public $label;

  /**
   * The FacConfig Search Plugin ID.
   *
   * @var string
   */
  protected $searchPluginId;

  /**
   * The FacConfig Search Plugin configuration.
   *
   * @var string
   */
  protected $searchPluginConfig;

  /**
   * The FacConfig input selectors.
   *
   * @var string
   */
  protected $inputSelectors;

  /**
   * The FacConfig number of results.
   *
   * @var int
   */
  protected $numberOfResults;

  /**
   * The FacConfig empty result.
   *
   * @var string
   */
  protected $emptyResult;

  /**
   * The FacConfig view mode.
   *
   * @var string
   */
  protected $viewModes;

  /**
   * The FacConfig minimum key length.
   *
   * @var int
   */
  protected $keyMinLength;

  /**
   * The FacConfig maximum key length.
   *
   * @var int
   */
  protected $keyMaxLength;

  /**
   * The FacConfig show all results link.
   *
   * @var bool
   */
  protected $allResultsLink;

  /**
   * The FacConfig all results link threshold.
   *
   * @var int
   */
  protected $allResultsLinkThreshold;

  /**
   * The FacConfig breakpoint.
   *
   * @var int
   */
  protected $breakpoint;

  /**
   * The FacConfig result location.
   *
   * @var string
   */
  protected $resultLocation;

  /**
   * The FacConfig highlighting enabled setting.
   *
   * @var bool
   */
  protected $highlightingEnabled;

  /**
   * The FacConfig anonymous search setting.
   *
   * @var bool
   */
  protected $anonymousSearch;

  /**
   * The FacConfig clean up files.
   *
   * @var bool
   */
  protected $cleanUpFiles;

  /**
   * The FacConfig files expiry time.
   *
   * @var string
   */
  protected $filesExpiryTime;

  /**
   * {@inheritdoc}
   */
  public function getSearchPluginId() {
    return $this->searchPluginId;
  }

  /**
   * {@inheritdoc}
   */
  public function getSearchPluginConfig() {
    $config = json_decode($this->searchPluginConfig, TRUE);
    if (empty($config)) {
      $config = [];
    }
    return $config;
  }

  /**
   * {@inheritdoc}
   */
  public function getInputSelectors() {
    return $this->inputSelectors;
  }

  /**
   * {@inheritdoc}
   */
  public function getNumberOfResults() {
    return $this->numberOfResults;
  }

  /**
   * {@inheritdoc}
   */
  public function getEmptyResult() {
    return $this->emptyResult;
  }

  /**
   * {@inheritdoc}
   */
  public function getViewModes() {
    return $this->viewModes;
  }

  /**
   * {@inheritdoc}
   */
  public function getKeyMinLength() {
    return $this->keyMinLength;
  }

  /**
   * {@inheritdoc}
   */
  public function getKeyMaxLength() {
    return $this->keyMaxLength;
  }

  /**
   * {@inheritdoc}
   */
  public function showAllResultsLink() {
    return $this->allResultsLink;
  }

  /**
   * {@inheritdoc}
   */
  public function getAllResultsLinkThreshold() {
    return $this->allResultsLinkThreshold;
  }

  /**
   * {@inheritdoc}
   */
  public function getBreakpoint() {
    return $this->breakpoint;
  }

  /**
   * {@inheritdoc}
   */
  public function getResultLocation() {
    return $this->resultLocation;
  }

  /**
   * {@inheritdoc}
   */
  public function highlightingEnabled() {
    return $this->highlightingEnabled;
  }

  /**
   * {@inheritdoc}
   */
  public function anonymousSearch() {
    return $this->anonymousSearch;
  }

  /**
   * {@inheritdoc}
   */
  public function cleanUpFiles() {
    return $this->cleanUpFiles;
  }

  /**
   * {@inheritdoc}
   */
  public function getFilesExpiryTime() {
    return $this->filesExpiryTime;
  }

  /**
   * Deletes Fast Autocomplete configuration JSON files.
   *
   * @param string $expiry_time
   *   The expiry time for the files.
   */
  public function deleteFiles($expiry_time = NULL) {
    if (empty($expiry_time)) {

      // No date and time given so just delete the entire directory.
      \Drupal::service('file_system')
        ->deleteRecursive($this
        ->getFilesPath());
    }
    else {
      try {

        // Get all Fast Autocomplete json files.
        $json_files = \Drupal::service('file_system')
          ->scanDirectory($this
          ->getFilesPath(), '/.*\\.json$/');

        // Loop through all the files and delete those that have expired.
        foreach ($json_files as $json_file) {
          if (filectime($json_file->uri) < $expiry_time) {
            \Drupal::service('file_system')
              ->delete($json_file->uri);
          }
        }
      } catch (NotRegularDirectoryException $e) {

        // The directory does not exist. No action needed.
      }
    }
  }

  /**
   * Gets the Fast Autocomplete configuration JSON files filepath.
   *
   * @returns string
   *   The JSON files filepath.
   */
  protected function getFilesPath() {
    return PublicStream::basePath() . '/fac-json/' . $this
      ->id();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableDependencyTrait::$cacheContexts	protected	property	Cache contexts.
CacheableDependencyTrait::$cacheMaxAge	protected	property	Cache max-age.
CacheableDependencyTrait::$cacheTags	protected	property	Cache tags.
CacheableDependencyTrait::setCacheability	protected	function	Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling	private	property	Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode	protected	property	The language code of the entity's default language.
ConfigEntityBase::$originalId	protected	property	The original ID of the configuration entity.
ConfigEntityBase::$status	protected	property	The enabled/disabled status of the configuration entity.	4
ConfigEntityBase::$third_party_settings	protected	property	Third party entity settings.
ConfigEntityBase::$trustedData	protected	property	Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid	protected	property	The UUID for this entity.
ConfigEntityBase::$_core	protected	property	Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency	protected	function	Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies	13
ConfigEntityBase::createDuplicate	public	function	Creates a duplicate of the entity. Overrides EntityBase::createDuplicate	1
ConfigEntityBase::disable	public	function	Disables the configuration entity. Overrides ConfigEntityInterface::disable	1
ConfigEntityBase::enable	public	function	Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get	public	function	Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate	1
ConfigEntityBase::getConfigDependencyName	public	function	Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager	protected static	function	Gets the configuration manager.
ConfigEntityBase::getConfigTarget	public	function	Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies	public	function	Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId	public	function	Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig	protected	function	Gets the typed config manager.
ConfigEntityBase::hasTrustedData	public	function	Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete	protected static	function	Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave	protected	function	Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable	public	function	Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable	2
ConfigEntityBase::isNew	public	function	Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling	public	function	Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::link	public	function	Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase::link
ConfigEntityBase::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval	7
ConfigEntityBase::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete	8
ConfigEntityBase::preSave	public	function	Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave	13
ConfigEntityBase::save	public	function	Saves an entity permanently. Overrides EntityBase::save	1
ConfigEntityBase::set	public	function	Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId	public	function	Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus	public	function	Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling	public	function
ConfigEntityBase::sort	public static	function	Helper callback for uasort() to sort configuration entities by weight and label.	6
ConfigEntityBase::status	public	function	Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status	4
ConfigEntityBase::toArray	public	function	Gets an array of all property values. Overrides EntityBase::toArray	2
ConfigEntityBase::toUrl	public	function	Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData	public	function	Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::url	public	function	Gets the public URL for this entity. Overrides EntityBase::url
ConfigEntityBase::urlInfo	public	function	Gets the URL object for the entity. Overrides EntityBase::urlInfo
ConfigEntityBase::__construct	public	function	Constructs an Entity object. Overrides EntityBase::__construct	10
ConfigEntityBase::__sleep	public	function	Overrides EntityBase::__sleep	4
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function	Aliased as: traitSleep	1
DependencySerializationTrait::__wakeup	public	function		2
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew	protected	property	Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId	protected	property	The entity type.
EntityBase::$typedData	protected	property	A typed data object wrapping this entity.
EntityBase::access	public	function	Checks data value access. Overrides AccessibleInterface::access	1
EntityBase::bundle	public	function	Gets the bundle of the entity. Overrides EntityInterface::bundle	1
EntityBase::create	public static	function	Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::delete	public	function	Deletes an entity permanently. Overrides EntityInterface::delete	2
EntityBase::enforceIsNew	public	function	Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityManager Deprecated	protected	function	Gets the entity manager.
EntityBase::entityTypeBundleInfo	protected	function	Gets the entity type bundle info service.
EntityBase::entityTypeManager	protected	function	Gets the entity type manager.
EntityBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType	public	function	Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId	public	function	Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate	protected	function	The list cache tags to invalidate for this entity.
EntityBase::getTypedData	public	function	Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate	public	function	Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::id	public	function	Gets the identifier. Overrides EntityInterface::id	11
EntityBase::label	public	function	Gets the label of the entity. Overrides EntityInterface::label	6
EntityBase::language	public	function	Gets the language of the entity. Overrides EntityInterface::language	1
EntityBase::languageManager	protected	function	Gets the language manager.
EntityBase::linkTemplates	protected	function	Gets an array link templates.	1
EntityBase::load	public static	function	Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple	public static	function	Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate	public	function	Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate	4
EntityBase::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete	16
EntityBase::postLoad	public static	function	Acts on loaded entities. Overrides EntityInterface::postLoad	2
EntityBase::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave	14
EntityBase::preCreate	public static	function	Changes the values of an entity before it is created. Overrides EntityInterface::preCreate	5
EntityBase::referencedEntities	public	function	Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities	1
EntityBase::toLink	public	function	Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships	public	function	Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters	protected	function	Gets an array of placeholders for this entity.	2
EntityBase::uuid	public	function	Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid	1
EntityBase::uuidGenerator	protected	function	Gets the UUID generator.
FacConfig::$allResultsLink	protected	property	The FacConfig show all results link.
FacConfig::$allResultsLinkThreshold	protected	property	The FacConfig all results link threshold.
FacConfig::$anonymousSearch	protected	property	The FacConfig anonymous search setting.
FacConfig::$breakpoint	protected	property	The FacConfig breakpoint.
FacConfig::$cleanUpFiles	protected	property	The FacConfig clean up files.
FacConfig::$emptyResult	protected	property	The FacConfig empty result.
FacConfig::$filesExpiryTime	protected	property	The FacConfig files expiry time.
FacConfig::$highlightingEnabled	protected	property	The FacConfig highlighting enabled setting.
FacConfig::$id	public	property	The FacConfig ID.
FacConfig::$inputSelectors	protected	property	The FacConfig input selectors.
FacConfig::$keyMaxLength	protected	property	The FacConfig maximum key length.
FacConfig::$keyMinLength	protected	property	The FacConfig minimum key length.
FacConfig::$label	public	property	The FacConfig label.
FacConfig::$numberOfResults	protected	property	The FacConfig number of results.
FacConfig::$resultLocation	protected	property	The FacConfig result location.
FacConfig::$searchPluginConfig	protected	property	The FacConfig Search Plugin configuration.
FacConfig::$searchPluginId	protected	property	The FacConfig Search Plugin ID.
FacConfig::$viewModes	protected	property	The FacConfig view mode.
FacConfig::anonymousSearch	public	function	Returns whether or not to perform search anonymous. Overrides FacConfigInterface::anonymousSearch
FacConfig::cleanUpFiles	public	function	Returns whether or not to clean up the files. Overrides FacConfigInterface::cleanUpFiles
FacConfig::deleteFiles	public	function	Deletes Fast Autocomplete configuration JSON files.
FacConfig::getAllResultsLinkThreshold	public	function	Gets the all results link threshold. Overrides FacConfigInterface::getAllResultsLinkThreshold
FacConfig::getBreakpoint	public	function	Gets the breakpoint. Overrides FacConfigInterface::getBreakpoint
FacConfig::getEmptyResult	public	function	Gets the empty result. Overrides FacConfigInterface::getEmptyResult
FacConfig::getFilesExpiryTime	public	function	Gets the files expiry time. Overrides FacConfigInterface::getFilesExpiryTime
FacConfig::getFilesPath	protected	function	Gets the Fast Autocomplete configuration JSON files filepath.
FacConfig::getInputSelectors	public	function	Gets the input selectors. Overrides FacConfigInterface::getInputSelectors
FacConfig::getKeyMaxLength	public	function	Gets the maximum key length. Overrides FacConfigInterface::getKeyMaxLength
FacConfig::getKeyMinLength	public	function	Gets the minimum key length. Overrides FacConfigInterface::getKeyMinLength
FacConfig::getNumberOfResults	public	function	Gets the number of results. Overrides FacConfigInterface::getNumberOfResults
FacConfig::getResultLocation	public	function	Gets the result location. Overrides FacConfigInterface::getResultLocation
FacConfig::getSearchPluginConfig	public	function	Gets the Search Plugin configuration. Overrides FacConfigInterface::getSearchPluginConfig
FacConfig::getSearchPluginId	public	function	Gets the Search Plugin ID. Overrides FacConfigInterface::getSearchPluginId
FacConfig::getViewModes	public	function	Gets the view modes. Overrides FacConfigInterface::getViewModes
FacConfig::highlightingEnabled	public	function	Returns whether or not to use highlighting. Overrides FacConfigInterface::highlightingEnabled
FacConfig::showAllResultsLink	public	function	Returns whether or not to show the all results link. Overrides FacConfigInterface::showAllResultsLink
PluginDependencyTrait::calculatePluginDependencies	protected	function	Calculates and adds dependencies of a specific plugin instance.	1
PluginDependencyTrait::getPluginDependencies	protected	function	Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler	protected	function	Wraps the module handler.	1
PluginDependencyTrait::themeHandler	protected	function	Wraps the theme handler.	1
RefinableCacheableDependencyTrait::addCacheableDependency	public	function		1
RefinableCacheableDependencyTrait::addCacheContexts	public	function
RefinableCacheableDependencyTrait::addCacheTags	public	function
RefinableCacheableDependencyTrait::mergeCacheMaxAge	public	function
SynchronizableEntityTrait::$isSyncing	protected	property	Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing	public	function
SynchronizableEntityTrait::setSyncing	public	function

You are here

class FacConfig in Fast Autocomplete 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation