primo commit

libraries/f0f/form/field/selectrow.php

@@ -0,0 +1,124 @@
+<?php
+/**
+ * @package    FrameworkOnFramework
+ * @subpackage form
+ * @copyright   Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba Ltd. All rights reserved.
+ * @license    GNU General Public License version 2 or later; see LICENSE.txt
+ */
+// Protect from unauthorized access
+defined('F0F_INCLUDED') or die;
+
+/**
+ * Form Field class for F0F
+ * Renders the checkbox in browse views which allows you to select rows
+ *
+ * @package  FrameworkOnFramework
+ * @since    2.0
+ */
+class F0FFormFieldSelectrow extends JFormField implements F0FFormField
+{
+	protected $static;
+
+	protected $repeatable;
+
+	/** @var   F0FTable  The item being rendered in a repeatable form field */
+	public $item;
+
+	/** @var int A monotonically increasing number, denoting the row number in a repeatable view */
+	public $rowid;
+
+	/**
+	 * Method to get certain otherwise inaccessible properties from the form field object.
+	 *
+	 * @param   string  $name  The property name for which to the the value.
+	 *
+	 * @return  mixed  The property value or null.
+	 *
+	 * @since   2.0
+	 */
+	public function __get($name)
+	{
+		switch ($name)
+		{
+			case 'static':
+				if (empty($this->static))
+				{
+					$this->static = $this->getStatic();
+				}
+
+				return $this->static;
+				break;
+
+			case 'repeatable':
+				if (empty($this->repeatable))
+				{
+					$this->repeatable = $this->getRepeatable();
+				}
+
+				return $this->repeatable;
+				break;
+
+			default:
+				return parent::__get($name);
+		}
+	}
+
+	/**
+	 * Method to get the field input markup for this field type.
+	 *
+	 * @since 2.0
+	 *
+	 * @return  string  The field input markup.
+	 */
+	protected function getInput()
+	{
+		throw new Exception(__CLASS__ . ' cannot be used in input forms');
+	}
+
+	/**
+	 * Get the rendering of this field type for static display, e.g. in a single
+	 * item view (typically a "read" task).
+	 *
+	 * @since 2.0
+	 *
+	 * @return  string  The field HTML
+	 */
+	public function getStatic()
+	{
+		throw new Exception(__CLASS__ . ' cannot be used in single item display forms');
+	}
+
+	/**
+	 * Get the rendering of this field type for a repeatable (grid) display,
+	 * e.g. in a view listing many item (typically a "browse" task)
+	 *
+	 * @since 2.0
+	 *
+	 * @return  string  The field HTML
+	 */
+	public function getRepeatable()
+	{
+		if (!($this->item instanceof F0FTable))
+		{
+			throw new Exception(__CLASS__ . ' needs a F0FTable to act upon');
+		}
+
+		// Is this record checked out?
+		$checked_out     = false;
+		$locked_by_field = $this->item->getColumnAlias('locked_by');
+		$myId            = JFactory::getUser()->get('id', 0);
+
+		if (property_exists($this->item, $locked_by_field))
+		{
+			$locked_by   = $this->item->$locked_by_field;
+			$checked_out = ($locked_by != 0 && $locked_by != $myId);
+		}
+
+		// Get the key id for this record
+		$key_field = $this->item->getKeyName();
+		$key_id    = $this->item->$key_field;
+
+		// Get the HTML
+		return JHTML::_('grid.id', $this->rowid, $key_id, $checked_out);
+	}
+}