base-invitation.inc.php

Go to the documentation of this file.

<?
class BaseInvitation extends MyObject
{
    public function __construct($id = null, $table = 'invites')
    {
        $this->hasAuthor = false;

        parent::__construct($id, $table);
    }

    public function getPagesXml()
    {
        $xml = parent::getPagesXml();
        $xml .= $this->getInvitePageXml();
        $xml .= $this->getApprovePageXml();
        $xml .= $this->getDenyPageXml();

        return $xml;
    }

    protected function getInvitePageXml()
    {
        return <<<XML
            <page name="invite">
            <param name="id" type="int" desc="id of the user you want to invite." required="1"/>
            </page>
XML;
    }

    protected function getApprovePageXml()
    {
        return <<<XML
            <page name="approve">
            <param name="id" type="int" desc="id of the invite you're approving" required="1"/>
            </page>
XML;
    }

    protected function getDenyPageXml()
    {
        return <<<XML
            <page name="deny">
            <param name="id" type="int" desc="id of the invite you're denying"/>
            </page>
XML;
    }

    protected function getEditPageXml()
    {
        return '';
    }

    public function initMainPage()
    {
        $this->assertLogin();
        $this->pageTitle = 'Invite Friends';
    }

    public function drawMainPage()
    {
        echo "<p>You should override " . get_class($this) . "::drawMainPage() and show a form for searching / inviting new users.</p>";
    }

    public function drawRow()
    {
        echo "<div class=\"" . get_class($this) . "Row\">";
        $this->drawLine();
        echo "</div>";
    }

    public function drawLine()
    {
        $inviter = new User($this->inviter_id);
        $invitee = new User($this->invitee_id);
        
        //who invited?
        if ($inviter->isMe())
            echo 'You have ';
        else
            echo $inviter->getName(true) . " has ";
            
        echo "invited ";
        
        //who was invited?
        if ($invitee->isMe())
            echo " you to join $inviter->their " . $this->getGroup() . ". ";
        else
            echo $invitee->getName(true) . " to join your " . $this->getGroup() . ". ";

        //can they do anything?
        if ($invitee->isMe())
        {
            echo "You may " . $this->getApproveLink() . " or " . $this->getDenyLink();
            echo " $inviter->their request.";
        }
    }

    public function getApproveLink($text = 'approve')
    {
        return $this->getLink(".approve?id=$this->id", $text);
    }

    public function getDenyLink($text = 'deny')
    {
        return $this->getLink(".deny?id=$this->id", $text);
    }

    public function canDelete()
    {
        global $me;

        return ($me->isAdmin() || $this->inviter_id == $me->id);
    }

    public function canView()
    {
        global $me;

        return ($me->isAdmin() || $this->inviter_id == $me->id || $this->invitee_id == $me->id);
    }

    public function initViewPage()
    {
        parent::initViewPage();

        $this->pageTitle = 'Respond to Invitation';

        $this->assertLogin();
    }

    public function drawViewPage()
    {
        if ($this->canRespond())
            $this->drawLine();
        else
            echo "<p>There's nothing to see/do here, sorry.</p>";
    }

    public function initInvitePage()
    {
        $this->pageTitle = 'Invite Friend';

        $this->assertLogin();
    }

    public function drawInvitePage()
    {
        global $me;

        $user = new User($this->params('id'));

        $form = $this->createInviteForm($user);
        if ($form->isSubmitted())
        {
            $form->validate();
            $this->validateInvite($form);

            if (!$form->hasError())
                $this->invitePost($form);
        }
        else
            $form->setData($this->params());

        //finally draw the form if needed
        if ($form->needsDrawn())
            $form->drawAll();
    }

    public function createInviteForm($user)
    {
        $form = new Form(new OneColumnTableLayout());
        $form->action = $this->getUrl(".invite?id=$user->id");

        $this->addInviteFormFields($form, $user);

        return $form;
    }

    protected function addInviteFormFields($form, $object)
    {
        $form->add('TextAreaField', 'note', array(
                    'title' => 'Note to ' . $object->getName(),
                    'width' => '100%',
                    'height' => '100px'
                    ));
        $form->addSubmit('Invite ' . $object->getName());
    }

    protected function validateInvite($form)
    {
        return true;
    }

    public function invite($inviteeId, $note = null)
    {
        global $me;

        //set our ids.
        $this->saveInvite($inviteeId);

        //email them
        $this->emailInvite($note);
    }
    
    protected function invitePost($form)
    {
        $this->invite($this->params('id'), $form->getData('note'));
    }

    protected function saveInvite($inviteeId)
    {
        global $me;

        //set our ids.
        $this->inviter_id = $me->id;
        $this->invitee_id = $inviteeId;
        $this->add_date = date("Y-m-d H:i:s");

        //save it!
        $this->save();
    }

    protected function emailInvite($note = null)
    {
        global $me;

        //get our data.
        $user = new User($this->invitee_id);

        //create our email.
        if ($user->email_invites)
        {
            $subject = "New Friend Invitation";
            $body = '';
            $html = '';

            //do our text email!
            if ($note)
                $body .= $note . "\n\n" . "************************************************\n\n";
            $body .= $me->getName() . " ($me->email) has invited you to join $me->their " . $this->getGroup() . " on " . Config::get('site_name') . ".\n";
            $body .= "For your safety and privacy, only approve invitations from people you know.\n\n";
            $body .= "Visit the link below to process $me->their request.\n\n";
            $body .= $user->getTicket(strtolower(get_class($this)) . ".view?id=$this->id") . "\n\n";
            $body .= "Please note, you will not be connected until you approve the request.\n\n";
            $body .= "Thank you,\nThe Happy " . Config::get('site_name') . " Invitation Robot\n\n";
            $body .= "PS. You can turn these emails off at: " . $user->getUrl(".emailprefs", null, true);

            //do our html email!
            if ($note)
                $html .= $note . "<br/><hr/><br/>";
            $html .= $me->getName(true) . " ($me->email) has invited you to join $me->their " . $this->getGroup() . " on " . Config::get('site_name') . ".<br/>";
            $html .= "For your safety and privacy, only approve invitations from people you know.<br/><br/>";
            $html .= $user->getTicket(strtolower(get_class($this)) . ".view?id=$this->id", "Click here") . " to process $me->their request.<br/><br/>";
            $html .= "Please note, you will <b>not</b> be connected until you approve the request.<br/><br/>";

            $html .= "Thank you,<br/>The Happy " . Config::get('site_name') . " Invitation Robot<br/><br/>";
            $html .= "PS. You can turn these emails off " . $user->getLink(".emailprefs", 'here.', null, true);

            //send it!
            $user->mail($subject, $body, $html);
        }
    }

    protected function getGroup()
    {
        return 'friends';
    }

    public function canRespond()
    {
        global $me;

        return ($me->id == $this->invitee_id);
    }

    public function initApprovePage()
    {
        global $me;

        //basic init stuff.
        $this->assertLogin();
        $this->id = $this->params('id');

        $this->pageTitle = 'Approve Invitation';

        //can they respond?
        if (!$this->canRespond())
            throw new PageError('You can only respond to your own invitations.');
    }

    public function drawApprovePage()
    {
        $this->doApprovePayload();

        $inviter = new User($this->inviter_id);
        echo "<p>You have approved " . $inviter->getName(true) . "'s request.</p>";
    }

    protected function doApprovePayload()
    {
        global $me;

        //delete our invite... we're done with it.
        $this->delete();

        //regenerate my tree...
        $me->createSession();
    }

    public function initDenyPage()
    {
        global $me;

        //basic init stuff.
        $this->assertLogin();
        $this->id = $this->params('id');

        $this->pageTitle = 'Deny Invitation';

        //can they respond?
        if (!$this->canRespond())
            throw new PageError('You can only respond to your own invitations.');
    }

    public function drawDenyPage()
    {
        $this->doDenyPayload();

        $inviter = new User($this->inviter_id);
        echo "<p>You have denied " . $inviter->getName(true) . "'s request.</p>";
    }

    protected function doDenyPayload()
    {
        global $me;

        //delete our invite... we're done with it.
        $this->delete();

        //regenerate my tree...
        $me->createSession();
    }

    public function getCreateFieldsArray()
    {
        //get daddy's fields.
        $fields = parent::getCreateFieldsArray();

        //no edit date
        unset($fields['edit_date']);

        //and user fields
        $fields["inviter_id"] = "inviter_id int(11) default 0 not null";
        $fields["invitee_id"] = "invitee_id int(11) default 0 not null";

        //send it back.
        return $fields;
    }

    public function getCreateIndexesArray()
    {
        //get daddy's keys.
        $keys = parent::getCreateIndexesArray();

        //no edit date
        unset($keys['edit_date']);

        //and user keys
        $keys["inviter_id"] = "KEY (inviter_id)";
        $keys["invitee_id"] = "KEY (invitee_id)";

        //send it back.
        return $keys;
    }
}
?>

---