Initial commit

LICENCE.txt

@@ -0,0 +1,26 @@
+All source code included in the "Field: Page Select Box" Symphony Extension archive
+is, unless otherwise specified, released under the MIT licence as follows:
+
+----- begin license block -----
+
+Copyright 2008 Alistair Kearney, Allen Chang, Scott Hughes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+----- end license block -----

README.txt

@@ -0,0 +1,27 @@
+
+Page Select Box Field
+------------------------------------
+
+Version: 1.2
+Author: Symphony Team (team@symphony21.com)
+Build Date: 23rd December 2008
+Requirements: Symphony Beta revision 5 or greater.
+
+
+[INSTALLATION]
+
+1. Upload the 'pagesfield' folder in this archive to your Symphony 'extensions' folder.
+
+2. Enable it by selecting the "Field: Page Select Box", choose Enable from the with-selected menu, then click Apply.
+
+3. You can now add the "Page Select Box" field to your sections.
+
+
+
+[CHANGE LOG]
+
+1.2 - Publish select box will use page ID's instead of handles. This solves 
+	  problem where 2 pages share the same handle, but only one shows up due
+	  to the clash.
+
+1.1 - Fixed sorting

extension.driver.php

@@ -0,0 +1,33 @@
+<?php
+
+	Class extension_pagesfield extends Extension{
+
+		public function about(){
+			return array('name' => 'Field: Page Select Box',
+						 'version' => '1.2',
+						 'release-date' => '2008-12-23',
+						 'author' => array('name' => 'Symphony Team',
+										   'website' => 'http://www.symphony21.com',
+										   'email' => 'team@symphony21.com')
+				 		);
+		}
+
+		public function uninstall(){
+			$this->_Parent->Database->query("DROP TABLE `tbl_fields_pages`");
+		}
+
+
+		public function install(){
+
+			return $this->_Parent->Database->query("CREATE TABLE `tbl_fields_pages` (
+			  `id` int(11) unsigned NOT NULL auto_increment,
+			  `field_id` int(11) unsigned NOT NULL,
+			  `allow_multiple_selection` enum('yes','no') NOT NULL default 'no',
+			  PRIMARY KEY  (`id`),
+			  UNIQUE KEY `field_id` (`field_id`)
+			) TYPE=MyISAM");
+
+		}
+
+	}
+

fields/field.pages.php

@@ -0,0 +1,305 @@
+<?php
+
+	if(!defined('__IN_SYMPHONY__')) die('<h2>Symphony Error</h2><p>You cannot directly access this file</p>');
+
+	Class fieldPages extends Field{
+
+		function __construct(&$parent){
+			parent::__construct($parent);
+			$this->_name = 'Page Select Box';
+
+			// Set default
+			$this->set('show_column', 'no');			
+		}
+
+		function canToggle(){
+			return ($this->get('allow_multiple_selection') == 'yes' ? false : true);
+		}
+
+		function allowDatasourceOutputGrouping(){
+			## Grouping follows the same rule as toggling.
+			return $this->canToggle();
+		}
+
+		function allowDatasourceParamOutput(){
+			return true;
+		}		
+
+		function canFilter(){
+			return true;
+		}
+
+		function canPrePopulate(){
+			return true;
+		}	
+
+		function isSortable(){
+			return true;
+		}
+
+		function appendFormattedElement(&$wrapper, $data, $encode=false){
+
+			if(!is_array($data) || empty($data)) return;
+
+			$list = new XMLElement($this->get('element_name'));
+
+			if(!is_array($data['handle'])) $data['handle'] = array($data['handle']);
+			if(!is_array($data['page_id'])) $data['page_id'] = array($data['page_id']);
+			if(!is_array($data['title'])) $data['title'] = array($data['title']);
+
+			for($ii = 0; $ii < count($data['handle']); $ii++){
+				$list->appendChild(new XMLElement('page', General::sanitize($data['title'][$ii]), array('handle' => $data['handle'][$ii], 'id' => $data['page_id'][$ii])));
+			}
+
+			$wrapper->appendChild($list);
+		}		
+
+		function getToggleStates($include_parent_titles=true){
+
+			$pages = $this->_engine->Database->fetch("SELECT * FROM `tbl_pages` ORDER BY `sortorder` ASC");
+
+			$result = array();
+			foreach($pages as $p){
+
+				$title = $p['title'];
+
+				if($p['path'] != NULL && $include_parent_titles){
+					$bits = preg_split('/\//', $p['path'], -1, PREG_SPLIT_NO_EMPTY);
+
+					foreach($bits as $h){
+						$parent = $this->_engine->Database->fetchVar('title', 0, "SELECT `title` FROM `tbl_pages` WHERE `handle` = '$h' LIMIT 1");
+						$title = $parent . ' / ' . $title;
+					}
+				}
+
+				$result[$p['id']] = $title;
+			}
+
+			return $result;
+		}
+
+		function toggleFieldData($data, $newState){
+
+			$page = $this->_engine->Database->fetchRow(0, "SELECT `title`, `id` FROM `tbl_pages` WHERE `id` = '$newState' LIMIT 1");
+
+			$data['handle'] = $page['handle'];
+			$data['title'] = $page['title'];
+			$data['page_id'] = $page['id'];
+
+			return $data;
+		}
+
+		function displayPublishPanel(&$wrapper, $data=NULL, $flagWithError=NULL, $fieldnamePrefix=NULL, $fieldnamePostfix=NULL){
+
+			$states = $this->getToggleStates();
+
+			if(!is_array($data['handle'])) $data['handle'] = array($data['handle']);
+			if(!is_array($data['page_id'])) $data['page_id'] = array($data['page_id']);
+			if(!is_array($data['title'])) $data['title'] = array($data['title']);
+
+			$options = array();
+
+			foreach($states as $id => $title){
+				$options[] = array($id, in_array($id, $data['page_id']), $title);
+			}
+
+			$fieldname = 'fields'.$fieldnamePrefix.'['.$this->get('element_name').']'.$fieldnamePostfix;
+			if($this->get('allow_multiple_selection') == 'yes') $fieldname .= '[]';
+
+			$label = Widget::Label($this->get('label'));
+			$label->appendChild(Widget::Select($fieldname, $options, ($this->get('allow_multiple_selection') == 'yes' ? array('multiple' => 'multiple') : NULL)));
+
+			if($flagWithError != NULL) $wrapper->appendChild(Widget::wrapFormElementWithError($label, $flagWithError));
+			else $wrapper->appendChild($label);		
+		}
+
+		function displayDatasourceFilterPanel(&$wrapper, $data=NULL, $errors=NULL, $fieldnamePrefix=NULL, $fieldnamePostfix=NULL){
+
+			parent::displayDatasourceFilterPanel($wrapper, $data, $errors, $fieldnamePrefix, $fieldnamePostfix);
+
+			$data = preg_split('/,\s*/i', $data);
+			$data = array_map('trim', $data);
+
+			$existing_options = $this->getToggleStates(false);
+
+			if(is_array($existing_options) && !empty($existing_options)){
+				$optionlist = new XMLElement('ul');
+				$optionlist->setAttribute('class', 'tags');
+
+				foreach($existing_options as $option) $optionlist->appendChild(new XMLElement('li', $option));
+
+				$wrapper->appendChild($optionlist);
+			}
+
+		}
+
+		function prepareTableValue($data, XMLElement $link=NULL){
+			$value = $data['title'];
+
+			if(!is_array($value)) $value = array($value);
+
+			return parent::prepareTableValue(array('value' => General::sanitize(@implode(', ', $value))), $link);
+		}
+
+		function processRawFieldData($data, &$status, $simulate=false, $entry_id=NULL){
+
+			$status = self::__OK__;
+
+			if(empty($data)) return NULL;
+
+			if(!is_array($data)) $data = array($data);
+
+			$result = array('title' => array(), 'handle' => array(), 'page_id' => array());
+			foreach($data as $page_id){
+
+				$page = $this->_engine->Database->fetchRow(0, "SELECT `title`, `handle` FROM `tbl_pages` WHERE `id` = '$page_id' LIMIT 1");
+
+				$result['handle'][] = $page['handle'];
+				$result['title'][] = $page['title'];
+				$result['page_id'][] = $page_id;
+			}
+
+			return $result;
+		}
+
+		function buildDSRetrivalSQL($data, &$joins, &$where, $andOperation=false){
+
+			$field_id = $this->get('id');
+
+			if(self::isFilterRegex($data[0])):
+
+				$pattern = str_replace('regexp:', '', $data[0]);
+				$joins .= " LEFT JOIN `tbl_entries_data_$field_id` AS `t$field_id` ON (`e`.`id` = `t$field_id`.entry_id) ";
+				$where .= " AND (`t$field_id`.title REGEXP '$pattern' OR `t$field_id`.handle REGEXP '$pattern') ";
+
+
+			elseif($andOperation):
+
+				foreach($data as $key => $bit){
+					$joins .= " LEFT JOIN `tbl_entries_data_$field_id` AS `t$field_id$key` ON (`e`.`id` = `t$field_id$key`.entry_id) ";
+					$where .= " AND (`t$field_id$key`.page_id = '$bit' OR `t$field_id$key`.handle = '$bit' OR `t$field_id$key`.title = '$bit') ";
+				}
+
+			else:
+
+				$joins .= " LEFT JOIN `tbl_entries_data_$field_id` AS `t$field_id` ON (`e`.`id` = `t$field_id`.entry_id) ";
+				$where .= " AND (`t$field_id`.page_id IN ('".@implode("', '", $data)."') OR `t$field_id`.handle IN ('".@implode("', '", $data)."') OR `t$field_id`.title IN ('".@implode("', '", $data)."')) ";
+
+			endif;
+
+			return true;
+
+		}
+
+		function commit(){
+
+			if(!parent::commit()) return false;
+
+			$id = $this->get('id');
+
+			if($id === false) return false;
+
+			$fields = array();
+
+			$fields['field_id'] = $id;
+			$fields['allow_multiple_selection'] = ($this->get('allow_multiple_selection') ? $this->get('allow_multiple_selection') : 'no');
+
+			$this->Database->query("DELETE FROM `tbl_fields_".$this->handle()."` WHERE `field_id` = '$id' LIMIT 1");
+
+			if(!$this->Database->insert($fields, 'tbl_fields_' . $this->handle())) return false;
+
+			return true;
+
+		}
+
+		function findDefaults(&$fields){
+			if(!isset($fields['allow_multiple_selection'])) $fields['allow_multiple_selection'] = 'no';
+		}
+
+		function displaySettingsPanel(&$wrapper, $errors=NULL){		
+
+			parent::displaySettingsPanel($wrapper, $errors);
+
+			## Allow selection of multiple items
+			$label = Widget::Label();
+			$input = Widget::Input('fields['.$this->get('sortorder').'][allow_multiple_selection]', 'yes', 'checkbox');
+			if($this->get('allow_multiple_selection') == 'yes') $input->setAttribute('checked', 'checked');			
+			$label->setValue($input->generate() . ' Allow selection of multiple pages');
+			$wrapper->appendChild($label);
+
+			$this->appendShowColumnCheckbox($wrapper);
+
+		}
+
+		function groupRecords($records){
+
+			if(!is_array($records) || empty($records)) return;
+
+			$groups = array($this->get('element_name') => array());
+
+			foreach($records as $r){
+				$data = $r->getData($this->get('id'));
+
+				$handle = $data['handle'];
+
+				if(!isset($groups[$this->get('element_name')][$handle])){
+					$groups[$this->get('element_name')][$handle] = array('attr' => array('handle' => $handle, 'name' => General::sanitize($data['title'])),
+																		 'records' => array(), 'groups' => array());
+				}	
+
+				$groups[$this->get('element_name')][$handle]['records'][] = $r;
+
+			}
+
+			return $groups;
+		}
+
+		function createTable(){
+
+			return $this->_engine->Database->query(
+
+				"CREATE TABLE IF NOT EXISTS `tbl_entries_data_" . $this->get('id') . "` (
+				  `id` int(11) unsigned NOT NULL auto_increment,
+				  `entry_id` int(11) unsigned NOT NULL,
+				  `page_id` int(11) unsigned NOT NULL,
+				  `title` varchar(255) default NULL,
+				  `handle` varchar(255) default NULL,
+				  PRIMARY KEY  (`id`),
+				  KEY `entry_id` (`entry_id`),
+				  KEY `handle` (`handle`),
+				  KEY `page_id` (`page_id`)
+				);"
+
+			);
+		}
+
+		public function getExampleFormMarkup(){
+			$states = $this->getToggleStates();
+
+			$options = array();
+
+			foreach($states as $handle => $v){
+				$options[] = array($handle, NULL, $v);
+			}
+
+			$fieldname = 'fields['.$this->get('element_name').']';
+			if($this->get('allow_multiple_selection') == 'yes') $fieldname .= '[]';
+
+			$label = Widget::Label($this->get('label'));
+			$label->appendChild(Widget::Select($fieldname, $options, ($this->get('allow_multiple_selection') == 'yes' ? array('multiple' => 'multiple') : NULL)));
+
+			return $label;
+		}			
+
+		public function buildSortingSQL(&$joins, &$where, &$sort, $order='ASC', $useIDFieldForSorting=false){
+
+			$sort_field = (!$useIDFieldForSorting ? 'ed' : 't' . $this->get('id'));
+
+			$joins .= "INNER JOIN `tbl_entries_data_".$this->get('id')."` AS `$sort_field` ON (`e`.`id` = `$sort_field`.`entry_id`) ";
+			$sort .= 'ORDER BY ' . (strtolower($order) == 'random' ? 'RAND()' : "`$sort_field`.`handle` $order");
+
+
+		}
+
+	}
+