base-group.inc.php

Go to the documentation of this file.

<?
class BaseGroup extends MyObject
{
    public $joinerTable;

    public $joinedObject;

    public $members = array();

    public function __construct($data = null, $table = 'groups', $joinerTable = 'users_to_groups', $joinedObject = 'User')
    {
        parent::__construct($data, $table);

        $this->joinerTable = $joinerTable;
        $this->joinedObject = $joinedObject;
        
        //add in fullltext
        $this->fullTextFields[] = 'name';
        $this->fullTextFields[] = 'description';
    }

    public function getPagesXml()
    {
        $xml = parent::getPagesXml();

        $xml .= <<<XML
            <page name="join">
                <param name="id" type="int" required="1"/>
            </page>
            <page name="leave">
                <param name="id" type="int" required="1"/>
            </page>
XML;
        return $xml;
    }

    public function isMember($id)
    {
        return ($this->members[$id] instanceOf $this->joinedObject);
    }

    public function addMember($id)
    {
        //handy dandy dupe remover
        $this->removeMember($id);

        //put it in the db.
        dbExecute("
            INSERT INTO $this->joinerTable
                (object_id, group_id, join_date)
            VALUES
                ('$id', '$this->id', NOW())
        ");

        //add it to our list.
        $this->members[$id] = new $this->joinedObject($id);
    }

    public function removeMember($id)
    {
        //remove from our db.
        dbExecute("
            DELETE FROM $this->joinerTable
            WHERE object_id = '$id'
                AND group_id = '$this->id'
        ");

        //clear our list.
        unset($this->members[$id]);
    }

    public function getGroupMemberIds()
    {
        $ids = array();
        $rs = dbQuery("
            SELECT object_id
            FROM $this->joinerTable
            WHERE group_id = '$this->id'
        ");
        while ($ar = dbFetchAssoc($rs))
            $ids[] = $ar['object_id'];

        return $ids;
    }

    public function canJoin()
    {
        global $me;
        
        return !$this->isMember($me->id);
    }

    public function canLeave()
    {
        global $me;

        return $this->isMember($me->id);
    }

    public function initJoinPage()
    {
        $this->assertLogin();

        $this->id = $this->params('id');
        $this->pageTitle = 'Join Group - ' . $this->getName();
        
        if (!$this->canJoin())
            throw new PageError('You cannot join this group.');
    }

    public function drawJoinPage()
    {
        global $me;
        
        $this->addMember($me->id);

        echo "<p>You are now a member of " . $this->getName(true) . "</p>";
    }
    
    public function initLeavePage()
    {
        $this->assertLogin();

        $this->id = $this->params('id');
        $this->pageTitle = 'Leave Group - ' . $this->getName();

        if (!$this->canLeave())
            throw new PageError('You cannot leave this group.');
    }

    public function drawLeavePage()
    {
        global $me;
        
        $this->removeMember($me->id);

        echo "<p>You are no longer a member of " . $this->getName(true) . "</p>";
    }

    public function getName($link = false)
    {
        return parent::getName($link, $this->name);
    }

    public function editFormAddFields($form)
    {
        parent::editFormAddFields($form);

        $form->add('TextField', 'name', array(
            'required' => true,
            'width' => '100%'
        ));
        $form->add('EditorField', 'description', array(
            'required' => true,
            'width' => '100%',
            'height' => '125px'
        ));
        
        return $form;
    }

    protected function editPagePostSuccess($form)
    {
        global $me;
        
        $this->addMember($me->id);
        
        parent::editPagePostSuccess($form);
    }

    public function getCreateTableSql()
    {
        $sql = parent::getCreateTableSql();

        return $sql;
    }
        
    public function drawCreateTablePage()
    {
        parent::drawCreateTablePage();
        
        echo "<p>" . nl2br($this->getJoinerTableSql()). "</p>";
    }
    
    public function runCreateTableSql()
    {
        dbExecute($this->getJoinerTableSql());
        
        parent::runCreateTableSql();
    }

    public function getJoinerTableSql()
    {
            
        $fields = implode(",\n", $this->getJoinerFieldsArray());
        $indexes = implode(",\n", $this->getJoinerIndexesArray());
        
        return "CREATE TABLE IF NOT EXISTS $this->joinerTable\n(\n$fields,\n$indexes\n);";
    }

    public function getCreateFieldsArray()
    {
        $array = parent::getCreateFieldsArray();
        
        $array['name'] = "name varchar(255) default '' not null";
        $array['description'] = "description text default '' not null";

        return $array;
    }

    public function getJoinerFieldsArray()
    {
        return array(
            'object_id' => 'object_id int(11) default 0 not null',
            'group_id' => 'group_id int(11) default 0 not null',
            'join_date' => 'join_date datetime not null',
        );
    }

    public function getJoinerIndexesArray()
    {
        return array(
            'object_id' => 'KEY (object_id)',
            'group_id' => 'KEY (group_id)'
        );
    }

    public function getRssItem()
    {
        $item = parent::getRssItem();

        $item->title = $this->name;
        $item->description = $this->description;

        return $item;
    }

    public function getPublicData()
    {
        $data = parent::getPublicData();

        $data['name'] = $this->name;
        $data['description'] = $this->description;

        return $data;
    }
}
?>

---