Your browser must have JavaScript enabled in order to view this page.
> >
 
Welcome Guest#9547 Login/register    Go to Bottom


INSTALL | LICENSE | README | CHANGES | Class Tree | Index
Go to Top

Source for file DpPage.php

Documentation is available at DpPage.php

  1. <?php
  2. /**
  3.  * A DutchPIPE enabled web page
  4.  *
  5.  * DutchPIPE version 0.4; PHP version 5
  6.  *
  7.  * LICENSE: This source file is subject to version 1.0 of the DutchPIPE license.
  8.  * If you did not receive a copy of the DutchPIPE license, you can obtain one at
  9.  * http://dutchpipe.org/license/1_0.txt or by sending a note to
  10.  * license@dutchpipe.org, in which case you will be mailed a copy immediately.
  11.  *
  12.  * @package    DutchPIPE
  13.  * @subpackage dpuniverse_std
  14.  * @author     Lennert Stock <ls@dutchpipe.org>
  15.  * @copyright  2006, 2007 Lennert Stock
  16.  * @license    http://dutchpipe.org/license/1_0.txt  DutchPIPE License
  17.  * @version    Subversion: $Id: DpPage.php 281 2007-08-20 21:45:53Z ls $
  18.  * @link       http://dutchpipe.org/manual/package/DutchPIPE
  19.  * @see        DpObject
  20.  */
  21.  
  22. /**
  23.  * Builts upon the standard DpObject class
  24.  */
  25. inherit(DPUNIVERSE_STD_PATH . 'DpObject.php');
  26.  
  27. /**
  28.  * A DutchPIPE enabled web page
  29.  *
  30.  * Creates the following DutchPIPE properties:<br />
  31.  *
  32.  * - boolean <b>isPage</b> - Set to TRUE
  33.  * - boolean|integer <b>isMovingArea</b> - Set to FALSE, can be type 1 or 2
  34.  * - boolean <b>isStandalone</b> - Set to TRUE if this is a "standalone" page
  35.  *
  36.  * @package    DutchPIPE
  37.  * @subpackage dpuniverse_std
  38.  * @author     Lennert Stock <ls@dutchpipe.org>
  39.  * @copyright  2006, 2007 Lennert Stock
  40.  * @license    http://dutchpipe.org/license/1_0.txt  DutchPIPE License
  41.  * @version    Release: 0.2.1
  42.  * @link       http://dutchpipe.org/manual/package/DutchPIPE
  43.  */
  44. class DpPage extends DpObject
  45. {
  46.     /**
  47.      * @var         array     All "exits" out of this page
  48.      * @access      private
  49.      */
  50.     private $mExits = array();
  51.  
  52.     /**
  53.      * Aliases used for exits, e.g. 'enter bar' for 'north'
  54.      *
  55.      * @var        array 
  56.      * @access     private
  57.      */
  58.     private $mExitAliases = array();
  59.  
  60.     /**
  61.      * @var         array     Elements to make a navigation trail
  62.      * @access      private
  63.      */
  64.     private $mNavigationTrail = array();
  65.  
  66.     /**
  67.      * Creates this page
  68.      *
  69.      * Calls the method 'createDpPage' in this page.
  70.      */
  71.     final function createDpObject()
  72.     {
  73.         $this->setTitleType(DPUNIVERSE_TITLE_TYPE_NAME);
  74.         $this->addId(dp_text('page'));
  75.         $this->addExit(dp_text('login'), DPUNIVERSE_PAGE_PATH . 'login.php');
  76.  
  77.         $this->isPage = new_dp_property(TRUE);
  78.         $this->isMovingArea = new_dp_property(FALSE);
  79.  
  80.         $this->createDpPage();
  81.  
  82.         $this->addValidClientCall('getInputAreaOptions');
  83.         $this->addValidClientCall('openInputArea');
  84.         $this->addValidClientCall('closeInputArea');
  85.     }
  86.  
  87.     /**
  88.      * Creates this page
  89.      *
  90.      * @see        createDpObject
  91.      */
  92.     function createDpPage()
  93.     {
  94.     }
  95.  
  96.     /**
  97.      * Resets this page
  98.      *
  99.      * Calls the method 'resetDpPage' in this page.
  100.      */
  101.     final function resetDpObject()
  102.     {
  103.         $this->resetDpPage();
  104.     }
  105.  
  106.     /**
  107.      * Resets this object
  108.      *
  109.      * @see        resetDpObject
  110.      */
  111.     function resetDpPage()
  112.     {
  113.     }
  114.  
  115.     /**
  116.      * Reports an event
  117.      *
  118.      * Called when certain events occur, given with $name.
  119.      *
  120.      * Calls the method 'eventDpPage' in this page.
  121.      *
  122.      * @param      object    $name       Name of event
  123.      * @param      mixed     $args       One or more arguments, depends on event
  124.      * @since      DutchPIPE 0.2.0
  125.      */
  126.     final function eventDpObject($name)
  127.     {
  128.         $args = func_get_args();
  129.         call_user_func_array(array($this, 'eventDpPage'), $args);
  130.     }
  131.  
  132.     /**
  133.      * Reports an event
  134.      *
  135.      * Called when certain events occur, given with $name.
  136.      *
  137.      * @param      object    $name       Name of event
  138.      * @param      mixed     $args       One or more arguments, depends on event
  139.      * @since      DutchPIPE 0.2.0
  140.      */
  141.     function eventDpPage($name)
  142.     {
  143.     }
  144.  
  145.     /**
  146.      * Adds an "exit" out of this page
  147.      *
  148.      * Exits are links that can be typed on the command line or used by computer
  149.      * controlled character to wander around the site. Adding compass directions
  150.      * like 'nw' will also add the full 'northwest' action, and vice versa, if
  151.      * not defined.
  152.      *
  153.      * @param       string    $direction    Command to use link, "home", "bar"
  154.      * @param       array     $direction    Multiple directions, "bar", "north"
  155.      * @param       string    $destination  URL
  156.      * @see         removeExit, setExits
  157.      */
  158.     final function addExit($direction, $destination, $method = NULL,
  159.         $mapArea = NULL, $mapAreaActionTitle = NULL)
  160.     {
  161.         $short_dirs = array('n', 'ne', 'e', 'se', 's', 'sw', 'w', 'nw');
  162.         $long_dirs = array('north', 'northeast', 'east', 'southeast', 'south',
  163.             'southwest', 'west', 'northwest');
  164.  
  165.         if (empty($direction)) {
  166.             return;
  167.         }
  168.  
  169.         if (!is_array($direction)) {
  170.             $direction = array($direction);
  171.         }
  172.  
  173.         if (FALSE !== ($x = array_search($direction[0], $short_dirs))) {
  174.             if (FALSE !== ($y = array_search($long_dirs[$x], $direction))) {
  175.                 $direction[$y] = $direction[0];
  176.             }
  177.             $direction[0] = $long_dirs[$x];
  178.  
  179.             //print_r($direction);
  180.             $test = true;
  181.         }
  182.  
  183.         $newdirs = array();
  184.         foreach ($direction as $dir) {
  185.             if (FALSE !== ($x = array_search($dir, $short_dirs))) {
  186.                 if (FALSE === ($y = array_search($long_dirs[$x], $direction))
  187.                         && FALSE === ($y = array_search($long_dirs[$x],
  188.                         $newdirs))) {
  189.                     $newdirs[] = $long_dirs[$x];
  190.                 }
  191.             } elseif (FALSE !== ($x = array_search($dir, $long_dirs))) {
  192.                 if (FALSE === ($y = array_search($short_dirs[$x], $direction))
  193.                         && FALSE === ($y = array_search($short_dirs[$x],
  194.                         $newdirs))) {
  195.                     $newdirs[] = $short_dirs[$x];
  196.                 }
  197.             }
  198.         }
  199.  
  200.         $direction = array_merge($direction, $newdirs);
  201.         //if (isset($test)) { print_r($direction); exit; }
  202.  
  203.         $tmp = $direction[0];
  204.         if (1 < ($sz = sizeof($direction))) {
  205.             for ($i = 1; $i < $sz; $i++) {
  206.                 $this->mExitAliases[$direction[$i]] = $tmp;
  207.             }
  208.         }
  209.  
  210.         $this->mExits[$direction[0]] = array($destination, $method);
  211.  
  212.         if (!is_null($mapArea) && is_null($mapAreaActionTitle)) {
  213.             $mapAreaActionTitle = $direction[0];
  214.         }
  215.  
  216.         $this->addAction($mapAreaActionTitle, $direction, 'useExit',
  217.             DP_ACTION_OPERANT_NONE, DP_ACTION_TARGET_SELF,
  218.             DP_ACTION_AUTHORIZED_ALL, DP_ACTION_SCOPE_INVENTORY,
  219.             $mapArea);
  220.     }
  221.  
  222.     /**
  223.      * Removes the given "exit" from the page
  224.      *
  225.      * @param       string    $direction    Command to use link, "home", "bar"
  226.      * @see         addExit, setExits
  227.      */
  228.     function removeExit($direction)
  229.     {
  230.         if (isset($this->mExitAliases[$direction])) {
  231.             $this->removeAction($this->mExitAliases[$direction]);
  232.             return;
  233.         }
  234.         if (isset($this->mExits[$direction])) {
  235.             $this->removeAction($direction);
  236.             unset($this->mExits[$direction]);
  237.             foreach ($this->mExitAliases as $dir_alias => $dir) {
  238.                 if ($direction === $dir) {
  239.                     unset($this->mExitAliases[$dir_alias]);
  240.                 }
  241.             }
  242.         }
  243.     }
  244.  
  245.     /**
  246.      * Sets all "exits" out of this page at once
  247.      *
  248.      * Exits are links that can be typed on the command line or used by computer
  249.      * controlled character to wander around the site.
  250.      *
  251.      * @param       array     $exits      Direction/destination pairs
  252.      * @see         addExit, removeExit
  253.      */
  254.     final function setExits($exits)
  255.     {
  256.         $this->mExits = array();
  257.         foreach ($exits as $direction => $destination) {
  258.             if (!is_array($destination)) {
  259.                 $this->addExit($direction, $destination);
  260.             } else {
  261.                 array_unshift($destination, $direction);
  262.                 call_user_method_array('addExit', $this, $destination);
  263.             }
  264.         }
  265.     }
  266.  
  267.     /**
  268.      * Gets URL of "exit" out of this page
  269.      *
  270.      * Exits are links that can be typed on the command line or used by computer
  271.      * controlled character to wander around the site.
  272.      *
  273.      * @param      string    $direction   Command to use link, "home", "bar"
  274.      * @return     string                 URL
  275.      */
  276.     final function getExitDestination($direction)
  277.     {
  278.         if (isset($this->mExitAliases[$direction])) {
  279.             $direction = $this->mExitAliases[$direction];
  280.         }
  281.         return !isset($this->mExits[$direction]) ? FALSE :
  282.             $this->mExits[$direction][0];
  283.     }
  284.  
  285.     /**
  286.      * Gets URL of "exit" out of this page
  287.      *
  288.      * Exits are links that can be typed on the command line or used by computer
  289.      * controlled character to wander around the site.
  290.      *
  291.      * @param      string    $direction   Command to use link, "home", "bar"
  292.      * @return     string                 URL
  293.      */
  294.     final function getExitMethod($direction)
  295.     {
  296.         if (isset($this->mExitAliases[$direction])) {
  297.             $direction = $this->mExitAliases[$direction];
  298.         }
  299.         return !isset($this->mExits[$direction]) ? FALSE :
  300.             $this->mExits[$direction][1];
  301.     }
  302.  
  303.     /**
  304.      * Gets URL of "exit" out of this page
  305.      *
  306.      * Exits are links that can be typed on the command line or used by computer
  307.      * controlled character to wander around the site.
  308.      *
  309.      * @param      string    $direction   Command to use link, "home", "bar"
  310.      * @return     string                 URL
  311.      */
  312.     final function getExitMapArea($direction)
  313.     {
  314.         if (isset($this->mExitAliases[$direction])) {
  315.             $direction = $this->mExitAliases[$direction];
  316.         }
  317.         return !isset($this->mExits[$direction]) ? FALSE :
  318.             $this->mExits[$direction][2];
  319.     }
  320.  
  321.     /**
  322.      * Gets all "exits" out of this page
  323.      *
  324.      * Exits are links that can be typed on the command line or used by computer
  325.      * controlled character to wander around the site.
  326.      *
  327.      * @return     array                 Direction/destination pairs
  328.      */
  329.     final function getExits()
  330.     {
  331.         return (array)$this->mExits;
  332.     }
  333.  
  334.     /**
  335.      * Gets all aliases for exits
  336.      *
  337.      * @return     array                 Alias/direction pairs
  338.      */
  339.     final function getExitAliases()
  340.     {
  341.         return (array)$this->mExitAliases;
  342.     }
  343.  
  344.     /**
  345.      * Makes the active object exit this page and go to a new URL
  346.      *
  347.      * @param   string  $verb   The name or verb part of the action, "home"
  348.      * @param   string  $noun   The given id, noun or remainder, usually empty
  349.      * @return  boolean         FALSE in case of failure, TRUE for success
  350.      */
  351.     function useExit($verb, $noun = '')
  352.     {
  353.         if (!($method = $this->getExitMethod($verb))
  354.                 || $this->{$method}($verb)) {
  355.             get_current_dpobject()->tell('<location>'
  356.                 . $this->getExitDestination($verb) . '</location>');
  357.         }
  358.         return TRUE;
  359.     }
  360.  
  361.     /**
  362.      * Sends a message to all objects in this page, "makes sound or movement"
  363.      *
  364.      * Calls the tell method in all objects in this page with the message.
  365.      * One or more extra arguments can be given to specify objects which should
  366.      * be skipped. For example:
  367.      *
  368.      *     $user->tell('You smile happily.<br />');
  369.      *     $user->getEnvironment()->tell(ucfirst(
  370.      *         $user->getTitle(DPUNIVERSE_TITLE_TYPE_DEFINITE))
  371.      *         . ' smiles happily.<br />', $user);
  372.      *
  373.      * @param      string    $data      message string
  374.      * @param      object    &$from     First object to skip
  375.      * @param      object    &$from2    Second object to skip, etc.
  376.      */
  377.     function tell($data, &$from = NULL)
  378.     {
  379.         // There's nothing here:
  380.         if (!sizeof($inv = $this->getInventory())) {
  381.             return;
  382.         }
  383.  
  384.         if (func_num_args() <= 1)  {
  385.             if (FALSE === is_array($data)) {
  386.                 foreach ($inv as &$ob) {
  387.                     $ob->tell($data, $this);
  388.                 }
  389.             } else {
  390.                 foreach ($inv as &$ob) {
  391.                     if (isset($data[$ob->displayMode])
  392.                             && ($tmp =
  393.                             $data[$ob->displayMode])) {
  394.                         $ob->tell($tmp, $this);
  395.                     }
  396.                 }
  397.             }
  398.         }
  399.         elseif (func_num_args() == 2)  {
  400.             $from = func_get_arg(1);
  401.             if (FALSE === is_array($data)) {
  402.                 foreach ($inv as &$ob) {
  403.                     if ($ob !== $from) {
  404.                         $ob->tell($data, $this);
  405.                     }
  406.                 }
  407.             } else {
  408.                 foreach ($inv as &$ob) {
  409.                     if ($ob !== $from
  410.                             && isset($data[$ob->displayMode])
  411.                             && ($tmp =
  412.                             $data[$ob->displayMode])) {
  413.                         $ob->tell($tmp, $this);
  414.                     }
  415.                 }
  416.             }
  417.         }
  418.         elseif (func_num_args() > 2)  {
  419.             $from = array_slice(func_get_args(), 1);
  420.             if (FALSE === is_array($data)) {
  421.                 foreach ($inv as &$ob) {
  422.                     if (FALSE === in_array($ob, $from, TRUE)) {
  423.                         $ob->tell($data, $this);
  424.                     }
  425.                 }
  426.             } else {
  427.                 foreach ($inv as &$ob) {
  428.                     if (FALSE === in_array($ob, $from, TRUE)
  429.                             && isset($data[$ob->displayMode])
  430.                             && ($tmp =
  431.                             $data[$ob->displayMode])) {
  432.                         $ob->tell($tmp, $this);
  433.                     }
  434.                 }
  435.             }
  436.         }
  437.     }
  438.  
  439.     /**
  440.      * Sets data to later generate a HTML navigation trail for this page
  441.      *
  442.      * Each item is either a string with the element's title for the last
  443.      * tiem in the navigation trail, or an array with each key such a title,
  444.      * and each value the destination path within dpuniverse.
  445.      *
  446.      * @param      mixed     $navitem   string or string/destination pairs
  447.      */
  448.     function setNavigationTrail()
  449.     {
  450.         if (0 === func_num_args()) {
  451.             return;
  452.         }
  453.         $this->mNavigationTrail = func_get_args();
  454.  
  455.         foreach ($this->mNavigationTrail as $link) {
  456.             if (is_array($link)) {
  457.                 if ($link[0] === DPUNIVERSE_NAVLOGO) {
  458.                     $link[0] = dp_text('home');
  459.                 }
  460.                 $link[0] = explode(' ', $link[0]);
  461.                 $link[0] = dp_strtolower($link[0][0]);
  462.                 $this->addExit($link[0], $link[1]);
  463.             }
  464.         }
  465.     }
  466.  
  467.     /**
  468.      * Gets data for the navigation trail for this page, if any
  469.      *
  470.      * @return     array     navigation trail elements
  471.      */
  472.     function getNavigationTrail()
  473.     {
  474.         return $this->mNavigationTrail;
  475.     }
  476.  
  477.     /**
  478.      * Gets HTML with a navigation trail for this page
  479.      *
  480.      * @return     string    HTML for navigation trail
  481.      */
  482.     function getNavigationTrailHtml()
  483.     {
  484.         if (0 === sizeof($this->mNavigationTrail)) {
  485.             return '<div id="navlink">' . dp_text(DPUNIVERSE_NAVLOGO)
  486.                 . '</div>';
  487.         }
  488.         $trail = array();
  489.         foreach ($this->mNavigationTrail as $navitem) {
  490.             $trail[] = $this->_getNavigationTrailHtmlElement($navitem);
  491.         }
  492.         return implode(' <img src="' . DPUNIVERSE_IMAGE_URL
  493.             . 'arr3w.gif" width="6" height="11" border="0" alt=" &gt; " '
  494.             . 'class="arrnav" /> ', $trail);
  495.     }
  496.  
  497.     /**
  498.      * Gets HTML with a navigation trail element for this page
  499.      *
  500.      * @access     private
  501.      * @param      mixed     $navitem   string or string/destination pairs
  502.      * @return     string    HTML for navigation trail element
  503.      * @see        getNavigationTrailHtml
  504.      */
  505.     function _getNavigationTrailHtmlElement($navitem)
  506.     {
  507.         if (FALSE === is_array($navitem)) {
  508.             return '<div id="navlink">' . $navitem . '</div>';
  509.         }
  510.  
  511.         if (dp_strlen($navitem[1]) >= 6
  512.                 && dp_substr($navitem[1], 0, 6) == 'uri://') {
  513.             $link = dp_substr($navitem[1], 6);
  514.         } else {
  515.             $link = $navitem[1] == '' ? DPUNIVERSE_WWW_URL
  516.                 : DPSERVER_CLIENT_URL . '?location=' . $navitem[1];
  517.         }
  518.  
  519.         return $navitem[0] <> DPUNIVERSE_NAVLOGO
  520.             ? '<div id="navlink"><a class="navtrail" href="' . $link . '">'
  521.                 . $navitem[0] . '</a></div>'
  522.             : '<div id="navlink"><a class="navtrail" href="' . $link
  523.                 . '" style="cursor: pointer">' . dp_text(DPUNIVERSE_NAVLOGO)
  524.                 . '</a></div>';
  525.     }
  526.  
  527.     /**
  528.      * Tells the current user the HTML with the input area options menu
  529.      */
  530.     function getInputAreaOptions()
  531.     {
  532.         /*
  533.          * A checksum is bounced back so the client can find the right
  534.          * response
  535.          */
  536.         if (!($user = get_current_dpuser())
  537.                 || !isset($user->_GET['checksum'])) {
  538.             return;
  539.         }
  540.  
  541.         $user->tell('<actions id="' . $this->uniqueId
  542.             . '" level="0" checksum="' . $user->_GET['checksum'] . '">'
  543.             . '<div class="actionwindow_inner">'
  544.             . $this->_getInputAreaOption(dp_text('hide after use'), 'once',
  545.             dp_text('mode once'), 'once' === $user->inputPersistent)
  546.             . $this->_getInputAreaOption(dp_text('show while on this page'),
  547.             'page', dp_text('mode page'), 'page' === $user->inputPersistent)
  548.             . $this->_getInputAreaOption(dp_text('always show'), 'always',
  549.             dp_text('mode always'), 'always' === $user->inputPersistent)
  550.             . '</div></actions>');
  551.     }
  552.  
  553.     /**
  554.      * Gets the HTML for a single input area option in the menu
  555.      *
  556.      * @access     private
  557.      * @param      string    $text       text label of this entry in menu
  558.      * @param      string    $persistent input field option
  559.      * @param      string    $command    full command to perform when selected
  560.      * @param      boolean   $enabled    is this option enabled?
  561.      * @return     string    HTML for navigation trail element
  562.      * @see        getInputAreaOptions
  563.      */
  564.     private function _getInputAreaOption($text, $persistent, $command, $enabled)
  565.     {
  566.         return '<div id="action_menu0" class="am" onMouseOver="'
  567.             . 'if (action_over(this)) { jQuery(\'div.am_deep_selected\').'
  568.             . 'removeClass(\'am_deep_selected am_selected\')}'
  569.             . (!$enabled ? '' : "; jQuery('span.am_icon', this).attr('id', '"
  570.             . DPUNIVERSE_IMAGE_URL . "bullet.gif'); "
  571.             . "jQuery('span.am_icon > img', this).attr('src', '"
  572.             . DPUNIVERSE_IMAGE_URL . "bullet_over.gif')")
  573.             . '" onMouseOut="am_target_out = this" '
  574.             . 'onClick="jQuery(\'#dpinputpersistent\').attr(\'value\', \''
  575.             . $persistent . '\'); send_action2server(\'' . $command . '\')">'
  576.             . (!$enabled ? '<span class="am_icon">&nbsp;</span>'
  577.             : '<span class="am_icon" id="'. DPUNIVERSE_IMAGE_URL
  578.             . 'bullet_over.gif"><img src="' . DPUNIVERSE_IMAGE_URL
  579.             . 'bullet.gif" width="5" height="5" border="0" alt="" title="" '
  580.             . 'style="margin-left: 2px" /></span>') . '<span class="am_title">'
  581.             . $text . '</span>'
  582.             . '<span class="am_submenu">&nbsp;</span>&nbsp;<br clear="all" />'
  583.             . '</div>';
  584.     }
  585.  
  586.     /**
  587.      * Enables the input area called from client-side JavaScript
  588.      */
  589.     function openInputArea()
  590.     {
  591.         if (!($user = get_current_dpuser())) {
  592.             return;
  593.         }
  594.  
  595.         $user->inputEnabled = 'on';
  596.  
  597.         if ($user->isRegistered) {
  598.             dp_db_exec('UPDATE Users set userInputEnabled='
  599.                 . dp_db_quote('on', 'text') . ' WHERE userUsernameLower='
  600.                 . dp_db_quote(dp_strtolower($user->getTitle()), 'text'));
  601.         }
  602.     }
  603.  
  604.     /**
  605.      * Closes the input area, called from client-side JavaScript
  606.      */
  607.     function closeInputArea()
  608.     {
  609.         if (!($user = get_current_dpuser())) {
  610.             return;
  611.         }
  612.  
  613.         $user->inputEnabled = 'off';
  614.  
  615.         if ($user->isRegistered) {
  616.             dp_db_exec('UPDATE Users set userInputEnabled='
  617.                 . dp_db_quote('off', 'text') . ' WHERE userUsernameLower='
  618.                 . dp_db_quote(dp_strtolower($user->getTitle()), 'text'));
  619.         }
  620.     }
  621. }
  622. ?>
Documentation generated on Mon, 03 Sep 2007 22:20:27 +0200 by phpDocumentor 1.3.0RC6

Click me!
Guest#9547
 
 
 
  Go to Top
 
 
 Input Field OptionsClose Input Field Go to Top
 
Legal Notices | Copyright © 2006, 2007 Lennert Stock. All rights reserved. Last update: Mon Sep 03 2007, 21:50 CET.