• The editor, both within IP.Board (topics/posts) and in other areas (such as IP.Content articles, IP.Blog entries, etc.).  Pay attention both to the editor itself (i.e. when typing out and formatting your post, and toggling the editor back and forth) and the final post that is submitted.
• Rebuilding posts, specifically upon upgrading from an older version of the software.  Pay attention specifically to quotes to be sure they display correctly.
• Any IP.Nexus functionality that has to do with grouped renewals.  Cancelling packages where renewals are grouped, reactivating those packages, changing those packages, etc.

• Objects in a tree often have parent/child relationships. Sometimes this relationship is between the same type of object (for example, forums in IP.Board or categories in IP.Downloads), sometimes the relationship is between different types of object (for example, applications and modules, where modules are always the child of applications) and sometimes it's a mix of both (for example, packages in IP.Nexus are always children of package groups, but package groups may or may not be children of each other).
• Objects in a tree can usually, but not always be reordered by the administrator.
• Objects in a tree can sometimes be enabled and disabled without being deleted, for example applications and modules. Sometimes individual objects can't when the rest can (for example, you can't disable the "Core" application).
• Trees usually have controls for adding, editing, assigning permissions, duplicating and deleting objects, though a subset of these controls, or additional controls may be available (for example, you can't edit the permissions on a package in IP.Nexus, but you can run a purchase report, which you can't do in any other trees).

/**
 * Custom Profile Field Group Node
 */
class _Group extends \IPS\Node\Model
{
	/**
	 * @brief	[ActiveRecord] Multiton Store
	 */
	protected static $multitons;
	
	/**
	 * @brief	[ActiveRecord] Default Values
	 */
	protected static $defaultValues = NULL;
	
	/**
	 * @brief	[ActiveRecord] Database Table
	 */
	public static $databaseTable = 'core_pfields_groups';
	
	/**
	 * @brief	[ActiveRecord] Database Prefix
	 */
	public static $databasePrefix = 'pf_group_';
	
	/**
	 * @brief	[ActiveRecord] ID Database Column
	 */
	public static $databaseColumnId = 'id';
		
	/**
	 * @brief	[Node] Node Title
	 */
	public static $nodeTitle = 'profile_fields';
		
}

• $multitons and $defaultValues are required by the \IPS\Patterns\ActiveRecord class. We don't need to do anything with them other than declare them.
• $databaseTable tells the \IPS\Patterns\ActiveRecord class what database table the records we need are in.
• $databasePrefix tells the \IPS\Patterns\ActiveRecord class the prefix used on all database columns. This isn't necessary, but since all the columns in my table start with "pf_group_", putting it here will save me typing it out every time.
• $databaseColumnId tells the \IPS\Patterns\ActiveRecord class which column contains the primary key.
• $nodeTitle tells the \IPS\Node\Model class what language string to use as the title on my page that shows the tree.

namespace IPS\core\modules\admin\membersettings;

/**
 * Profile Fields and Settings
 */
class _profiles extends \IPS\Node\Controller
{
	/**
	 * Node Class
	 */
	protected $nodeClass = '\IPS\core\ProfileFields\Group';

}

	/**
	 * [Node] Get Node Title
	 *
	 * @return	string
	 */
	protected function get__title()
	{
		$key = "core_pfieldgroups_{$this->id}";
		return \IPS\Lang::i()->$key;
	}

• $this->id gets the value of the "pf_group_id" column in the database. This is because the \IPS\Patterns\ActiveRecord class provides us with a __get method for retrieving the database row values. This is handy if we want to be able to modify the value returned for whatever reason, as we can override that method.
• We're retrieving the value for a language key rather than some kind of title field in the database. This is because in IPS Social Suite 4, data like this will be translatable, so if you have more than one language you can display different values depending on the user's language choice.

	/**
	 * [Node] Does the currently logged in user have permission to edit permissions for this node?
	 *
	 * @return	bool
	 */
	public function canManagePermissions()
	{
		return false;
	}

	/**
	 * [Node] Add/Edit Form
	 *
	 * @param	\IPS\Helpers\Form	$form	The form
	 * @return	void
	 */
	public function form( &$form )
	{
		$form->add( new \IPS\Helpers\Form\Translatable( 'pfield_group_title', NULL, TRUE, array( 'app' => 'core', 'key' => ( $this->id ? "core_pfieldgroups_{$this->id}" : NULL ) ) ) );
	}
	
	/**
	 * [Node] Save Add/Edit Form
	 *
	 * @param	array	$values	Values from the form
	 * @return	void
	 */
	public function saveForm( $values )
	{
		if ( !$this->id )
		{
			$this->save();
		}
		
		\IPS\Lang::saveCustom( 'core', "core_pfieldgroups_{$this->id}", $values['pfield_group_title'] );
	}

	/**
	 * @brief	[Node] Show forms modally?
	 */
	public static $modalForms = TRUE;

	/**
	 * [ActiveRecord] Duplicate
	 *
	 * @return	void
	 */
	public function __clone()
	{
		$oldId = $this->id;
		parent::__clone();
		\IPS\Lang::saveCustom( 'core', "core_pfieldgroups_{$this->id}", \IPS\Db::i()->buildAndFetchAll( array( 'select' => '*', 'from' => 'core_sys_lang_words', 'where' => array( 'word_key=?', "core_pfieldgroups_{$oldId}" ) ), 'lang_id', 'word_custom' ) );
	}
	
	/**
	 * [ActiveRecord] Delete Record
	 *
	 * @return	void
	 */
	public function delete()
	{
		parent::delete();
		\IPS\Lang::deleteCustom( 'core', 'core_pfieldgroups_' . $this->id );
	}

	/**
	 * Search
	 *
	 * @param	string		$column	Column to search
	 * @param	string		$query	Search query
	 * @param	string|null	$order	Column to order by
	 * @return	array
	 */
	public static function search( $column, $query, $order )
	{	
		if ( $column === '_title' )
		{
			$return = array();			
			foreach ( \IPS\Lang::i()->searchCustom( 'core_pfieldgroups_', $query ) as $key => $value )
			{
				try
				{
					$return[ $key ] = self::load( $key );
				}
				catch ( \Exception $e ) { }
			}
			return $return;
		}
		return parent::search( $column, $query, $order );
	}

	/**
	 * @brief	[Node] Order Database Column
	 */
	public static $databaseColumnOrder = 'order';

	/**
	 * @brief	[Node] ACP Restrictions
	 */
	protected static $restrictions = array(
		'app'		=> 'core',
		'module'	=> 'membersettings',
		'prefix'	=> 'profilefieldgroups_',
	);

• I've declared two additional properties specifying the class name of the parent ("\IPS\core\ProfileFields\Group") and which column contains the parent ID.
• I've declared an additional method to fetch an icon for the row so we can see what type of field this is.
• Just like we overwrote canManagePermissions for groups, I've also overridden canAdd in the same way, as you cannot add children to profile fields.

	/**
	 * @brief	[Node] Subnode class
	 */
	public static $subnodeClass = 'IPS\core\ProfileFields\Field';

• When clicking on a group, it will expand out to show the fields under it.
• The search box will include fields as well as groups in its results.
• When clicking the "Add" button for a group, it will show the field to add a field to that group.
• When clicking the "Copy" button for a group, you'll have the option to copy children too or not.
• When clicking the "Delete" button for a group, you'll have the option to move children elsewhere or delete them too.
• (This is my favourite feature) In addition to being able to drag and drop fields to reorder, you can drag a field out of one group and into another.

• "Blank" - which will create the class with no other logic, so the section will be blank.
• "Table" which will create a class with a boilerplate for displaying a table.
• "Node Controller" - which will create a boilerplate for displaying a tree of containers such as IP.Board forums, IP.Downloads categories, IP.Nexus groups, etc. We've not posted how this class works, but a future blog entry will give more details.

• "Internal", which is for accounts created natively through the suite.
• Facebook
• Twitter
• Microsoft (this is currently referred to as "Windows Live", though they rebranded to "Microsoft Account" a short while ago)
• LDAP
• "IPS Connect", which is our SSO solution for connecting your site with other IPS Social Suite installations or third-party applications.
• A generic handler for any MySQL database you have access to.

		/* Create the table */
		$table = new \IPS\Helpers\Table\Db( 'core_members', 'app=core&module=members§ion=members' );
		
		/* Display */
		\IPS\Output::i()->output	= \IPS\Output::i()->getTemplate( 'global' )->block( 'members', $table );

• We're calling \IPS\Helpers\Table\Db - the "Db" part indicates that the source of data for our table is a database table. There are other classes to use, for example, a JSON document as the data source.
• We pass it the name of our database table (or for the other classes, whatever the data source is) and the query string part of the URL where we're going to be displaying this (which we need to build the links and AJAX calls).
• I'm passing it to the output through a template called "block" which simply adds the dark-blue bar at the top, which isn't actually part of the table itself, and some padding. The "members" parameter is the key for the langauge string to use in that dark-blue bar.
• I'm passing $table directly to the template - the helper class has a __toString method which renders the table, so the output class thinks it's been given a normal string.

$table->include = array( 'name', 'email', 'joined', 'member_group_id', 'ip_address' );

• It's worked out pagination itself. When you click a pagination link, the contents of the table will update with AJAX, including changing your browser's URL (unless you have JavaScript disabled of course, in which case it will work like a normal link). Pagination defaults to 25 results per page, but you can change that just by changing a property in the class.
• All the columns are clickable, which will resort the results. You can sort any column ascending or descending. Resorting will also update with AJAX (including changing your browser's URL), unless JavaScript is disabled.

$table->langPrefix = 'members_';

		$table->parsers = array(
			'joined'			=> function( $val, $row )
			{
				return \IPS\DateTime::ts( $val )->localeDate();
			},
			'member_group_id'	=> function( $val, $row )
			{
				return \IPS\Member\Group::load( $val )->formattedName();
			}
		);

$table->mainColumn = 'name';

• I'm using the \IPS\DateTime class to format the joined date. The ts method in this is a factory method which takes a UNIX timestamp and returns an object of \IPS\DateTime. \IPS\DateTime extends DateTime, so all the features of that class are available to us. The localeDate method returns a string with the date formatted appropriately according to user's locale.
• The \IPS\Member\Group::load call being executed for each result may look like it might be resource intensive, but it caches objects it creates, so it's only actually "loading" each group once.

$table->include = array( 'photo', 'name', 'email', 'joined', 'member_group_id', 'ip_address' );

		$table->parsers = array(
			'photo'				=> function( $val, $row )
			{
				return \IPS\Member::constructFromData( $row )->photo('mini');
			},

$table->noSort	= array( 'photo' );

• Since this isn't a value which exists in the database, the value of $val in the lambda function will be NULL, however, $row has all the data for that record.
• We're not using \IPS\Member::load to get the member object, since that would execute an additional query for every result, which would be resource intensive, and unnecessary since we already have that data. Instead, we use the constructFromData method and pass it the row from the database.

		$table->sortBy = $table->sortBy ?: 'joined';
		$table->sortDirection = $table->sortDirection ?: 'desc';

$table->quickSearch = 'name';

• As you type, results are obtained with AJAX.
• You can page through your results (the number of pages will update automatically) and reorder your results by clicking the headers without loosing your search.

		$table->advancedSearch = array(
			'member_id'			=> \IPS\Helpers\Table\SEARCH_CONTAINS_TEXT,
			'email'				=> \IPS\Helpers\Table\SEARCH_CONTAINS_TEXT,
			'ip_address'		=> \IPS\Helpers\Table\SEARCH_CONTAINS_TEXT,
			'member_group_id'	=> array( \IPS\Helpers\Table\SEARCH_SELECT, array( 'options' => $groups ), function( $val )
			{
				return array( 'member_group_id=? OR ? IN(mgroup_others)', $val, $val );
			} ),
			'joined'			=> \IPS\Helpers\Table\SEARCH_DATE_RANGE,
			);

• The keys are the columns we're letting the user search on.
• The values are usually a constant indicating the type of search that is appropriate for that column.
• The member_group_id element is a bit more complicated. It has to specify an array of options (I've omitted the code to generate $groups in this snippet, but it'll be at the end of this blog entry), and, because we need to search both primary and secondary groups based on the value, there's a lambda function to get the proper WHERE clause for the query.

• The date entry boxes use the HTML5 date input type:
  
  If your browser doesn't support that, there's a JavaScript fallback:
  
  And if you're really awkward and are using a browser that doesn't support the HTML5 date input type and have JavaScript disabled, you'll see a regular text box where you can enter a date in practically any format, and it'll work it out.
• After performing the search, you can reorder your results by clicking the headers without loosing your search.

		/* Filters */
		$table->filters = array(
			'members_filter_banned'		=> 'member_banned=1',
			'members_filter_locked'		=> 'failed_login_count>=' . (int) \IPS\Settings::i()->ipb_bruteforce_attempts,
			'members_filter_spam'		=> '(members_bitoptions & ' . \IPS\Member::$bitOptions['bw_is_spammer'] . ') != 0',
			'members_filter_validating'	=> 'v.lost_pass=0 AND v.vid IS NOT NULL'
		);

$table->joins = array( array( 'from' => array( 'core_validating' => 'v' ), 'where' => 'v.member_id=_0.member_id' ) );

• The helper class will add the "All" filter automatically.
• It's getting the word to use for the filter by looking for a language string with the same key as the key in the array passed.
• Like everything else, clicking a filter updates the results with AJAX and the filter is retained in searches.

		$table->rootButtons = array(
			'add'	=> array(
				'icon'		=> array( 'icons/add.png', 'core' ),
				'title'		=> 'members_add',
				'link'		=> 'app=members&module=members§ion=members&do=add',
			)
		);
		$table->rowButtons = function( $row )
		{
			return array(
				'edit'	=> array(
					'icon'		=> array( 'icons/edit.png', 'core' ),
					'title'		=> 'edit',
					'link'		=> 'app=members&module=members§ion=members&do=edit&id=' . $row['member_id'],
				),
				'delete'	=> array(
					'icon'		=> array( 'icons/delete.png', 'core' ),
					'title'		=> 'delete',
					'link'		=> 'app=members&module=members§ion=members&do=delete&id=' . $row['member_id'],
					'class'		=> 'delete',
				),
			);
		};

		/* Create the table */
		$table = new \IPS\Helpers\Table\Db( 'core_members', 'app=core&module=members§ion=members' );
		$table->langPrefix = 'members_';
				
		/* Columns we need */
		$table->include = array( 'photo', 'name', 'email', 'joined', 'member_group_id', 'ip_address' );
		$table->mainColumn = 'name';
		$table->noSort	= array( 'photo' );
		
		/* Default sort options */
		$table->sortBy = $table->sortBy ?: 'joined';
		$table->sortDirection = $table->sortDirection ?: 'desc';
		
		/* Filters */
		$table->joins = array( array( 'from' => array( 'core_validating' => 'v' ), 'where' => 'v.member_id=_0.member_id' ) );
		$table->filters = array(
			'members_filter_banned'		=> 'member_banned=1',
			'members_filter_locked'		=> 'failed_login_count>=' . (int) \IPS\Settings::i()->ipb_bruteforce_attempts, /*@todo*/
			'members_filter_spam'		=> '(members_bitoptions & ' . \IPS\Member::$bitOptions['bw_is_spammer'] . ') != 0',
			'members_filter_validating'	=> 'v.lost_pass=0 AND v.vid IS NOT NULL'
		);
		
		/* Groups for advanced filter (need to do it this way because array_merge renumbers the result */
		$groups = array( '' => 'any_group' );
		foreach ( \IPS\Member\Group::groups() as $k => $v )
		{
			$groups[ $k ] = $v;
		}
		
		/* Search */
		$table->quickSearch = 'name';
		$table->advancedSearch = array(
			'member_id'			=> \IPS\Helpers\Table\SEARCH_CONTAINS_TEXT,
			'email'				=> \IPS\Helpers\Table\SEARCH_CONTAINS_TEXT,
			'ip_address'		=> \IPS\Helpers\Table\SEARCH_CONTAINS_TEXT,
			'member_group_id'	=> array( \IPS\Helpers\Table\SEARCH_SELECT, array( 'options' => $groups ), function( $val )
			{
				return array( 'member_group_id=? OR ? IN(mgroup_others)', $val, $val );
			} ),
			'joined'			=> \IPS\Helpers\Table\SEARCH_DATE_RANGE,
			);
		
		/* Custom parsers */
		$table->parsers = array(
			'photo'				=> function( $val, $row )
			{
				return \IPS\Member::constructFromData( $row )->photo('mini');
			},
			'joined'			=> function( $val, $row )
			{
				return \IPS\DateTime::ts( $val )->localeDate();
			},
			'member_group_id'	=> function( $val, $row )
			{
				return \IPS\Member\Group::load( $val )->formattedName();
			}
		);
		
		/* Specify the buttons */
		$table->rootButtons = array(
			'add'	=> array(
				'icon'		=> array( 'icons/add.png', 'core' ),
				'title'		=> 'members_add',
				'link'		=> 'app=members&module=members§ion=members&do=add',
			)
		);
		$table->rowButtons = function( $row )
		{
			return array(
				'edit'	=> array(
					'icon'		=> array( 'icons/edit.png', 'core' ),
					'title'		=> 'edit',
					'link'		=> 'app=members&module=members§ion=members&do=edit&id=' . $row['member_id'],
				),
				'delete'	=> array(
					'icon'		=> array( 'icons/delete.png', 'core' ),
					'title'		=> 'delete',
					'link'		=> 'app=members&module=members§ion=members&do=delete&id=' . $row['member_id'],
					'class'		=> 'delete',
				),
			);
		};
		
		/* Display */
		\IPS\Output::i()->output	= \IPS\Output::i()->getTemplate( 'global' )->block( 'members', $table );