panels_display Class Reference
[Panels Main API Functions]

List of all members.

---

Detailed Description

Forms the basis of a panel display

Definition at line 558 of file panels.module.

Public Member Functions
	add_pane ($pane, $location=FALSE)
	clone_pane ($pid)
	duplicate_pane ($pid, $location=FALSE)
	next_new_pid ()
Public Attributes
	$args = array()
	$content = array()
	$context = array()
	$css_id = NULL
	$hide_title = 0
	$incoming_content = NULL
	$panels = array()
	$title = ''

---

Member Function Documentation

panels_display::add_pane	(	$	pane,
		$	location = FALSE
	)

Definition at line 568 of file panels.module.

References next_new_pid().

Referenced by duplicate_pane().

                                              {
    $pane->pid = $this->next_new_pid();
    if (!$location || !isset($this->panels[$location])) {
      foreach ($this->panels as $panel_name => $panel) {
        if (array_key_exists($pane->pid, $panel)) {
          $this->panels[$panel_name][] = $pane->pid;
        }
      }
    }
    else {
      $this->panels[$location][] = $pane->pid;
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

panels_display::clone_pane

(

$

pid

)

Definition at line 587 of file panels.module.

Referenced by duplicate_pane().

                            {
    $pane = drupal_clone($this->content[$pid]);
    foreach (array_keys($this->content) as $pidcheck) {
      // necessary?
      unset($pane->position);
    }
    return $pane;
  }

Here is the caller graph for this function:

panels_display::duplicate_pane	(	$	pid,
		$	location = FALSE
	)

Definition at line 582 of file panels.module.

References add_pane(), and clone_pane().

                                                   {
    $pane = $this->clone_pane($pid);
    $this->add_pane($pane, $location);
  }

Here is the call graph for this function:

panels_display::next_new_pid

(

)

Definition at line 596 of file panels.module.

Referenced by add_pane().

                          {
    // necessary if/until we use this method and ONLY this method for adding
    // temporary pids. then we can do it with a nice static var.
    $id = array(0);
    foreach (array_keys($this->content) as $pid) {
      if (!is_numeric($pid)) {
        $id[] = substr($pid, 4);
      }
    }
    $next_id = end($id);
    return ++$next_id;
  }

Here is the caller graph for this function:

---

Member Data Documentation

panels_display::$args = array()

Definition at line 559 of file panels.module.

panels_display::$content = array()

Definition at line 560 of file panels.module.

panels_display::$context = array()

Definition at line 564 of file panels.module.

panels_display::$css_id = NULL

Definition at line 563 of file panels.module.

panels_display::$hide_title = 0

Definition at line 566 of file panels.module.

panels_display::$incoming_content = NULL

Definition at line 562 of file panels.module.

panels_display::$panels = array()

Definition at line 561 of file panels.module.

panels_display::$title = ''

Definition at line 565 of file panels.module.

---

The documentation for this class was generated from the following file:

• panels.module (1.10.4.127 2008/11/05 02:24:15 sdboyer)