Version 4.0.13.1

system/Helpers/Form/Poll.php

@@ -0,0 +1,200 @@
+<?php
+/**
+ * @brief		Poll input class for Form Builder
+ * @author		<a href='http://www.invisionpower.com'>Invision Power Services, Inc.</a>
+ * @copyright	(c) 2001 - SVN_YYYY Invision Power Services, Inc.
+ * @license		http://www.invisionpower.com/legal/standards/
+ * @package		IPS Social Suite
+ * @since		10 Jan 2014
+ * @version		SVN_VERSION_NUMBER
+ */
+
+namespace IPS\Helpers\Form;
+
+/* To prevent PHP errors (extending class does not exist) revealing path */
+if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
+{
+	header( ( isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0' ) . ' 403 Forbidden' );
+	exit;
+}
+
+/**
+ * Poll input class for Form Builder
+ */
+class _Poll extends FormAbstract
+{
+	/**
+	 * @brief	Default Options
+	 * @code
+	 	$defaultOptions = array(
+	 		'allowPollOnly'	=> TRUE,	// Controls if "Allow poll only" option is allowed (if the admin has enabled it)
+	 	);
+	 * @endcode
+	 */
+	protected $defaultOptions = array(
+		'allowPollOnly'	=> FALSE,
+	);
+
+	/**
+	 * @brief	Have we output the js yet?
+	 */
+	protected $jsSent	= FALSE;
+
+	/** 
+	 * Get HTML
+	 *
+	 * @return	string
+	 */
+	public function html()
+	{
+		$json	= array();
+
+		for( $i = 1; $i <= \IPS\Settings::i()->max_poll_questions; $i++ )
+		{
+			$thisQuestion	= array();
+
+			if( $this->value AND isset( $this->value->choices[ $i ] ) )
+			{
+				$thisQuestion['title']		= $this->value->choices[ $i ]['question'];
+				$thisQuestion['multiChoice']	= (bool) $this->value->choices[ $i ]['multi'];
+				$thisQuestion['choices']		= array();
+				
+				for( $j = 1; $j <= \IPS\Settings::i()->max_poll_choices; $j++ )
+				{
+					$thisChoice = array();
+
+					if( $this->value AND isset( $this->value->choices[ $i ]['choice'][ $j ] ) )
+					{
+						$thisChoice['title']	= $this->value->choices[ $i ]['choice'][ $j ];
+						$thisChoice['count']	= $this->value->choices[ $i ]['votes'][ $j ];
+						$thisQuestion['choices'][] = $thisChoice;
+					}
+				}
+				
+				$json[] = $thisQuestion;
+			}
+		}
+
+		$json	= json_encode( $json );
+
+		if( !$this->jsSent )
+		{
+		\IPS\Output::i()->endBodyCode .= <<<EOF
+		<script type='text/javascript'>
+			ips.setSetting('pollData', {$json} );
+		</script>
+EOF;
+			$this->jsSent	= TRUE;
+		}
+		
+		/* Ensure poll JS is loaded */
+		\IPS\Output::i()->jsFiles = array_merge( \IPS\Output::i()->jsFiles, \IPS\Output::i()->js( 'front_core.js', 'core' ) );
+		
+		return \IPS\Theme::i()->getTemplate( 'forms', 'core', 'global' )->poll( $this->name, $this->value, $json, $this->options['allowPollOnly'] );
+	}
+	
+	/**
+	 * Get Value
+	 *
+	 * @return	mixed
+	 */
+	public function getValue()
+	{
+		/* Check we provided a value */
+		$formValues = parent::getValue();
+		
+		/* Init object */
+		if ( $this->defaultValue instanceof \IPS\Poll )
+		{
+			$poll = $this->defaultValue;
+		}
+		else
+		{
+			$poll = new \IPS\Poll;
+			$poll->starter_id = \IPS\Member::loggedIn()->member_id;
+		}
+		
+		/* Set values */
+		$data =  parent::getValue();
+		if ( !isset( $data['questions'] ) )
+		{
+			return NULL;
+		}
+		$poll->setDataFromForm( $data, $this->options['allowPollOnly'] );
+		if ( !$poll->poll_question )
+		{
+			if ( $poll->pid )
+			{
+				$poll->delete();
+			}
+			return NULL;
+		}
+		
+		/* Return */
+		return $poll;
+	}
+	
+	/**
+	 * Validate
+	 *
+	 * @throws	\InvalidArgumentException
+	 * @return	TRUE
+	 */
+	public function validate()
+	{
+		/* Required? */
+		if ( $this->value === NULL )
+		{
+			if ( $this->required )
+			{
+				throw new \InvalidArgumentException('form_required');
+			}
+			else
+			{
+				return TRUE;
+			}
+		}
+
+		if( mb_strlen( $this->value->poll_question ) > 255 )
+		{
+			throw new \InvalidArgumentException( \IPS\Member::loggedIn()->language()->addToStack('form_maxlength', FALSE, array( 'pluralize' => array( 255 ) ) ) );
+		}
+
+		/* Do we have at least one question? */
+		if ( !count( $this->value->choices ) )
+		{
+			throw new \InvalidArgumentException('form_poll_no_questions');
+		}
+		if ( count( $this->value->choices ) > \IPS\Settings::i()->max_poll_questions )
+		{
+			throw new \InvalidArgumentException( \IPS\Member::loggedIn()->language()->addToStack('form_poll_too_many_questions', FALSE, array( 'pluralize' => array( \IPS\Settings::i()->max_poll_questions ) ) ) );
+		}
+			
+		/* Do all the questions have at least 2 options? */
+		foreach ( $this->value->choices as $question )
+		{
+			if ( count( $question['choice'] ) < 2 )
+			{
+				throw new \InvalidArgumentException('form_poll_too_few_answers');
+			}
+			if ( count( $question['choice'] ) > \IPS\Settings::i()->max_poll_choices )
+			{
+				throw new \InvalidArgumentException( \IPS\Member::loggedIn()->language()->addToStack('form_poll_too_many_answers', FALSE, array( 'sprintf' => array( \IPS\Settings::i()->max_poll_choices ) ) ) );
+			}
+		}
+		
+		
+		return TRUE;
+	}
+	
+	/**
+	 * String Value
+	 *
+	 * @param	mixed	$value	The value
+	 * @return	string
+	 */
+	public static function stringValue( $value )
+	{
+		return $value ? $value->pid : NULL;
+	}
+}