class CourseObjectForm in Course 8.3

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\course\Form\CourseObjectForm

1 string reference to 'CourseObjectForm'

course.routing.yml in ./course.routing.yml

course.routing.yml

File

src/Form/CourseObjectForm.php, line 11

Namespace

Drupal\course\Form

class CourseObjectForm extends FormBase {

  /**
   * @{inheritdoc}
   *
   * @param array $form
   * @param FormStateInterface $form_state
   * @param type $course
   * @param type $course_object
   */
  public function buildForm(array $form, FormStateInterface $form_state, $course = NULL, $course_object = NULL) {
    $form = array();

    // Load object from session.
    if (!($courseObject = _course_get_course_object_by_uniqid($course_object))) {
      $courseObject = \Drupal\course\Entity\CourseObject::load($course_object);
    }
    $form[$courseObject
      ->getComponent()] = array(
      '#title' => $courseObject
        ->getComponentName(),
      '#type' => 'details',
      '#group' => 'course_tabs',
      '#description' => t('Configuration for @name course objects.', array(
        '@name' => $courseObject
          ->getComponentName(),
      )),
      '#weight' => 2,
    );
    $courseObject
      ->optionsForm($form, $form_state);
    $form_display = EntityFormDisplay::collectRenderDisplay($courseObject, 'default');
    $form_display
      ->buildForm($courseObject, $form, $form_state);
    foreach (Element::children($form) as $key) {
      $element = $form[$key];
      if (!empty($element['#type']) && $element['#type'] == 'container') {
        $form['title'][$key] = $element;
        unset($form[$key]);
      }
    }
    $fieldset_key = $courseObject
      ->getComponent();
    foreach (Element::children($form) as $key) {
      $element = $form[$key];

      // @todo I want to catch all object-provided fields and group them into a
      // fieldset. I should probably do this with an OO design change so that we
      // know where the fields are coming from. Consider adding a
      // CourseObject::objectOptionsForm which will separate object-specific
      // behavior from Course-specific behavior.
      if (!empty($element['#type']) && !in_array($element['#type'], array(
        '',
        'hidden',
        'details',
        'submit',
        'button',
        'fieldset',
        'vertical_tabs',
        'value',
      ))) {
        $form[$fieldset_key][$key] = $element;
        unset($form[$key]);
      }
    }
    return $form;
  }
  public function getFormId() {
    return 'course_object_options_form';
  }
  public function submitForm(array &$form, FormStateInterface $form_state) {
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CourseObjectForm::buildForm	public	function	inheritdoc} Overrides FormInterface::buildForm
CourseObjectForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
CourseObjectForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
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		1
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::config	protected	function	Retrieves a configuration object.
FormBase::configFactory	protected	function	Gets the config factory for this form.	1
FormBase::container	private	function	Returns the service container.
FormBase::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	87
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.