Source for file weblink.php

Documentation is available at weblink.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Site
  4.  * @subpackage  com_weblinks
  5.  *
  6.  * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
  7.  * @license     GNU General Public License version 2 or later; see LICENSE.txt
  8.  */
  9.  
  10. defined('_JEXEC') or die;
  11.  
  12. JTable::addIncludePath(JPATH_COMPONENT_ADMINISTRATOR . '/tables');
  13.  
  14. /**
  15.  * Weblinks Component Model for a Weblink record
  16.  *
  17.  * @package     Joomla.Site
  18.  * @subpackage  com_weblinks
  19.  * @since       1.5
  20.  */
  21. class WeblinksModelWeblink extends JModelItem
  22. {
  23.     /**
  24.      * Model context string.
  25.      *
  26.      * @access    protected
  27.      * @var        string 
  28.      */
  29.     protected $_context = 'com_weblinks.weblink';
  30.  
  31.     /**
  32.      * Method to auto-populate the model state.
  33.      *
  34.      * Note. Calling getState in this method will result in recursion.
  35.      *
  36.      * @since   1.6
  37.      */
  38.     protected function populateState()
  39.     {
  40.         $app = JFactory::getApplication();
  41.         $params    = $app->getParams();
  42.  
  43.         // Load the object state.
  44.         $id    = $app->input->getInt('id');
  45.         $this->setState('weblink.id', $id);
  46.  
  47.         // Load the parameters.
  48.         $this->setState('params', $params);
  49.     }
  50.  
  51.     /**
  52.      * Method to get an object.
  53.      *
  54.      * @param   integer    The id of the object to get.
  55.      *
  56.      * @return  mixed  Object on success, false on failure.
  57.      */
  58.     public function getItem($id = null)
  59.     {
  60.         if ($this->_item === null)
  61.         {
  62.             $this->_item = false;
  63.  
  64.             if (empty($id))
  65.             {
  66.                 $id = $this->getState('weblink.id');
  67.             }
  68.  
  69.             // Get a level row instance.
  70.             $table = JTable::getInstance('Weblink', 'WeblinksTable');
  71.  
  72.             // Attempt to load the row.
  73.             if ($table->load($id))
  74.             {
  75.                 // Check published state.
  76.                 if ($published = $this->getState('filter.published'))
  77.                 {
  78.                     if ($table->state != $published)
  79.                     {
  80.                         return $this->_item;
  81.                     }
  82.                 }
  83.  
  84.                 // Convert the JTable to a clean JObject.
  85.                 $properties = $table->getProperties(1);
  86.                 $this->_item = JArrayHelper::toObject($properties, 'JObject');
  87.             }
  88.             elseif ($error = $table->getError())
  89.             {
  90.                 $this->setError($error);
  91.             }
  92.         }
  93.  
  94.         return $this->_item;
  95.     }
  96.  
  97.     /**
  98.      * Returns a reference to the a Table object, always creating it.
  99.      *
  100.      * @param    type    The table type to instantiate
  101.      * @param    string    A prefix for the table class name. Optional.
  102.      * @param    array    Configuration array for model. Optional.
  103.      * @return    JTable    A database object
  104.      * @since    1.6
  105.      */
  106.     public function getTable($type = 'Weblink', $prefix = 'WeblinksTable', $config = array())
  107.     {
  108.         return JTable::getInstance($type, $prefix, $config);
  109.     }
  110.  
  111.     /**
  112.      * Method to increment the hit counter for the weblink
  113.      *
  114.      * @param   integer  $id  Optional ID of the weblink.
  115.      *
  116.      * @return  boolean  True on success
  117.      */
  118.     public function hit($id = null)
  119.     {
  120.         if (empty($id))
  121.         {
  122.             $id = $this->getState('weblink.id');
  123.         }
  124.  
  125.         $weblink = $this->getTable('Weblink', 'WeblinksTable');
  126.         return $weblink->hit($id);
  127.     }
  128. }

Documentation generated on Tue, 19 Nov 2013 15:18:24 +0100 by phpDocumentor 1.4.3