IPS 4: Node Example

<?php

namespace IPS\downloads;

/**
 * Category Node
 */
class _Category extends \IPS\Node\Model implements \IPS\Node\Permissions
{
    /**
     * @brief   [ActiveRecord] Multiton Store
     */
    protected static $multitons;

    /**
     * @brief   [ActiveRecord] Default Values
     */
    protected static $defaultValues = NULL;

    /**
     * @brief   [ActiveRecord] Database Table
     */
    public static $databaseTable = 'downloads_categories';

    /**
     * @brief   [ActiveRecord] Database Prefix
     */
    public static $databasePrefix = 'c';

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

    /**
     * @brief   [Node] Parent ID Database Column
     */
    public static $databaseColumnParent = 'parent';

    /**
     * @brief   [Node] Node Title
     */
    public static $nodeTitle = 'categories';

    /**
     * @brief   [Node] ACP Restrictions
     * @code
        array(
            'app'       => 'core',              // The application key which holds the restrictrions
            'module'    => 'foo',               // The module key which holds the restrictions
            'map'       => array(               // [Optional] The key for each restriction - can alternatively use "prefix"
                'add'           => 'foo_add',
                'edit'          => 'foo_edit',
                'permissions'   => 'foo_perms',
                'delete'        => 'foo_delete'
            ),
            'all'       => 'foo_manage',        // [Optional] The key to use for any restriction not provided in the map (only needed if not providing all 4)
            'prefix'    => 'foo_',              // [Optional] Rather than specifying each  key in the map, you can specify a prefix, and it will automatically look for restrictions with the key "[prefix]_add/edit/permissions/delete"
     * @encode
     */
    protected static $restrictions = array(
        'app'       => 'downloads',
        'module'    => 'downloads',
        'prefix' => 'categories_'
    );

    /**
     * @brief   [Node] App for permission index
     */
    public static $permApp = 'downloads';

    /**
     * @brief   [Node] Type for permission index
     */
    public static $permType = 'category';

    /**
     * @brief   The map of permission columns
     */
    public static $permissionMap = array(
        'view'              => 'view',
        'read'              => 2,
        'add'               => 3,
        'download'          => 4,
        'reply'             => 5,
        'review'            => 6
    );

    /**
     * @brief   Bitwise values for members_bitoptions field
     */
    public static $bitOptions = array(
        'bitoptions' => array(
            'bitoptions' => array(
                'moderation'            => 1,   // Require files to be approved?
                'comment_moderation'    => 2,   // Require comments to be approved?
                'reviews_mod'           => 4,   // Reviews must be approved?
            )
        )
    );

    /**
     * @brief   [Node] Title search prefix.  If specified, searches for '_title' will be done against the language pack.
     */
    public static $titleSearchPrefix = 'downloads_category_';

    /**
     * @brief   [Node] Moderator Permission
     */
    public static $modPerm = 'download_categories';

    /**
     * @brief   Follow Area Key
     */
    public static $followArea = 'category';

    /**
     * [Node] Get title
     *
     * @return  string
     */
    protected function get__title()
    {
        return \IPS\Member::loggedIn()->language()->get("downloads_category_{$this->id}");
    }

    /**
     * [Node] Get whether or not this node is enabled
     *
     * @note    Return value NULL indicates the node cannot be enabled/disabled
     * @return  bool|null
     */
    protected function get__enabled()
    {
        return $this->open;
    }

    /**
     * [Node] Set whether or not this node is enabled
     *
     * @param   bool|int    $enabled    Whether to set it enabled or disabled
     * @return  void
     */
    protected function set__enabled( $enabled )
    {
        $this->open = $enabled;
    }

    /**
     * [Node] Add/Edit Form
     *
     * @param   \IPS\Helpers\Form   $form   The form
     * @return  void
     */
    public function form( &$form )
    {
        $form->add( new \IPS\Helpers\Form\Translatable( 'cname', NULL, TRUE, array( 'app' => 'downloads', 'key' => ( $this->id ? "downloads_category_{$this->id}" : NULL ) ) ) );
        $form->add( new \IPS\Helpers\Form\Translatable( 'cdesc', NULL, FALSE, array( 'app' => 'downloads', 'key' => ( $this->id ? "downloads_category_{$this->id}_desc" : NULL ), 'editor' => array( 'app' => 'downloads', 'key' => 'Categories', 'autoSaveKey' => ( $this->id ? "downloads-cat-{$this->id}" : "downloads-new-cat" ), 'attachIds' => $this->id ? array( $this->id, NULL, 'description' ) : NULL, 'minimize' => 'cdesc_placeholder' ) ) ) );

        $form->add( new \IPS\Helpers\Form\YesNo( 'cbitoptions_moderation', $this->bitoptions['moderation'] ) );
        $form->add( new \IPS\Helpers\Form\YesNo( 'cbitoptions_comment_moderation', $this->bitoptions['comment_moderation'] ) );
        $form->add( new \IPS\Helpers\Form\YesNo( 'cbitoptions_reviews_mod', $this->bitoptions['reviews_mod'] ) );

        // etc...
    }

    /**
     * [Node] Save Add/Edit Form
     *
     * @param   array   $values Values from the form
     * @return  void
     */
    public function saveForm( $values )
    {
        if ( !$this->id )
        {
            $this->save();
        }

        foreach ( array( 'cname' => "downloads_category_{$this->id}", 'cdesc' => "downloads_category_{$this->id}_desc" ) as $fieldKey => $langKey )
        {
            \IPS\Lang::saveCustom( 'downloads', $langKey, $values[ $fieldKey ] );
            unset( $values[ $fieldKey ] );
        }

        foreach ( array( 'moderation', 'comment_moderation', 'reviews_mod' ) as $k )
        {
            $this->bitoptions[ $k ] = $values["cbitoptions_{$k}"];
            unset( $values["cbitoptions_{$k}"] );
        }

        parent::saveForm( $values );
    }

    /**
     * Get URL
     *
     * @return  \IPS\Http\Url
     */
    public function url()
    {
        return \IPS\Http\Url::internal( "app=downloads&module=downloads&controller=browse&id={$this->_id}", 'front', 'downloads_cat', $this->name_furl );
    }
}