snipt

Ctrl+h for KB shortcuts

PHP

nooku starter model

<?php

/**
 * Blank Model Class for Nooku Framework
 *
 * This is a blank model based off KModelTable. It has most of the
 * common methods when needing to create a new model. Just remove
 * the extra stuff you don't need, and set the values you do!
 *
 * @author	Jeremy Wilken <[email protected]>
 */
 
class ComComponentModelBlanks extends KModelTable
{
     /**
      * Class constructor
      */
     public function __construct(KConfig $config)
     {
	parent::__construct($config);

	// Add custom states. Default states are limit, offset, sort, direction, search
	//$this->_state->insert('title'    , 'string');
     }
	
     /**
      * Initializes settings, is first to be called in constructor
      */

     protected function _initialize(KConfig $config)
     {
	//$config->table = 'com.component.table.blanks';
	//$config->table_behaviors = array();

       	parent::_initialize($config);
    }

    /**
     * Method to get a item object which represents a table row
     *
     * @return KDatabaseRow
     */
    public function getItem()
    {
        return parent::getItem();
    }

    /**
     * Get a list of items which represnts a  table rowset
     *
     * @return KDatabaseRowset
     */
    public function getList()
    {
	return parent::getList();
    }

    /**
     * Get the total amount of items
     *
     * @return  int
     */
    public function getTotal()
    {
        return parent::getTotal();
    }

    /**
     * Builds SELECT columns list for the query
     */
    protected function _buildQueryColumns(KDatabaseQuery $query)
    {
	parent::_buildQueryColumns($query);
	//$query->select(array('tbl.*'));
    }

     /**
     * Builds FROM tables list for the query
     */
    protected function _buildQueryFrom(KDatabaseQuery $query)
    {
		parent::_buildQueryFrom($query);
      	$name = $this->getTable()->getName();
    	$query->from($name.' AS tbl');
    }

    /**
     * Builds LEFT JOINS clauses for the query
     */
    protected function _buildQueryJoins(KDatabaseQuery $query)
    {
	parent::_buildQueryJoins($query);
	//$query->join('LEFT', 'categories AS categories', 'categories.id = tbl.catid');
    }

    /**
     * Builds a WHERE clause for the query
     */
    protected function _buildQueryWhere(KDatabaseQuery $query)
    {
	parent::_buildQueryWhere($query);
	//if ($this->_state->state) $query->where('tbl.column', '=', 'value');
    }

     /**
     * Builds a GROUP BY clause for the query
     */
    protected function _buildQueryGroup(KDatabaseQuery $query)
    {
	parent::_buildQueryGroup($query);
    }

    /**
     * Builds a HAVING clause for the query
     */
    protected function _buildQueryHaving(KDatabaseQuery $query)
    {
	parent::_buildQueryHaving($query);
    }

    /**
     * Builds a generic ORDER BY clasue based on the model's state
     */
    protected function _buildQueryOrder(KDatabaseQuery $query)
    {
	parent::_buildQueryOrder($query);
    	//$query->order('state', 'DESC');
    }

    /**
     * Builds LIMIT clause for the query
     */
    protected function _buildQueryLimit(KDatabaseQuery $query)
    {
	parent::_buildQueryLimit($query);
	//if ($this->_state->state) $query->limit($this->_state->state, 'default');
    }
}
https://snipt.net/embed/7616ee218d4e8393311b708d9c536989/
/raw/7616ee218d4e8393311b708d9c536989/
7616ee218d4e8393311b708d9c536989
php
PHP
138
2019-08-24T17:00:55
True
False
False
/api/public/snipt/22519/
nooku-starter-model
<table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#L-1"> 1</a> <a href="#L-2"> 2</a> <a href="#L-3"> 3</a> <a href="#L-4"> 4</a> <a href="#L-5"> 5</a> <a href="#L-6"> 6</a> <a href="#L-7"> 7</a> <a href="#L-8"> 8</a> <a href="#L-9"> 9</a> <a href="#L-10"> 10</a> <a href="#L-11"> 11</a> <a href="#L-12"> 12</a> <a href="#L-13"> 13</a> <a href="#L-14"> 14</a> <a href="#L-15"> 15</a> <a href="#L-16"> 16</a> <a href="#L-17"> 17</a> <a href="#L-18"> 18</a> <a href="#L-19"> 19</a> <a href="#L-20"> 20</a> <a href="#L-21"> 21</a> <a href="#L-22"> 22</a> <a href="#L-23"> 23</a> <a href="#L-24"> 24</a> <a href="#L-25"> 25</a> <a href="#L-26"> 26</a> <a href="#L-27"> 27</a> <a href="#L-28"> 28</a> <a href="#L-29"> 29</a> <a href="#L-30"> 30</a> <a href="#L-31"> 31</a> <a href="#L-32"> 32</a> <a href="#L-33"> 33</a> <a href="#L-34"> 34</a> <a href="#L-35"> 35</a> <a href="#L-36"> 36</a> <a href="#L-37"> 37</a> <a href="#L-38"> 38</a> <a href="#L-39"> 39</a> <a href="#L-40"> 40</a> <a href="#L-41"> 41</a> <a href="#L-42"> 42</a> <a href="#L-43"> 43</a> <a href="#L-44"> 44</a> <a href="#L-45"> 45</a> <a href="#L-46"> 46</a> <a href="#L-47"> 47</a> <a href="#L-48"> 48</a> <a href="#L-49"> 49</a> <a href="#L-50"> 50</a> <a href="#L-51"> 51</a> <a href="#L-52"> 52</a> <a href="#L-53"> 53</a> <a href="#L-54"> 54</a> <a href="#L-55"> 55</a> <a href="#L-56"> 56</a> <a href="#L-57"> 57</a> <a href="#L-58"> 58</a> <a href="#L-59"> 59</a> <a href="#L-60"> 60</a> <a href="#L-61"> 61</a> <a href="#L-62"> 62</a> <a href="#L-63"> 63</a> <a href="#L-64"> 64</a> <a href="#L-65"> 65</a> <a href="#L-66"> 66</a> <a href="#L-67"> 67</a> <a href="#L-68"> 68</a> <a href="#L-69"> 69</a> <a href="#L-70"> 70</a> <a href="#L-71"> 71</a> <a href="#L-72"> 72</a> <a href="#L-73"> 73</a> <a href="#L-74"> 74</a> <a href="#L-75"> 75</a> <a href="#L-76"> 76</a> <a href="#L-77"> 77</a> <a href="#L-78"> 78</a> <a href="#L-79"> 79</a> <a href="#L-80"> 80</a> <a href="#L-81"> 81</a> <a href="#L-82"> 82</a> <a href="#L-83"> 83</a> <a href="#L-84"> 84</a> <a href="#L-85"> 85</a> <a href="#L-86"> 86</a> <a href="#L-87"> 87</a> <a href="#L-88"> 88</a> <a href="#L-89"> 89</a> <a href="#L-90"> 90</a> <a href="#L-91"> 91</a> <a href="#L-92"> 92</a> <a href="#L-93"> 93</a> <a href="#L-94"> 94</a> <a href="#L-95"> 95</a> <a href="#L-96"> 96</a> <a href="#L-97"> 97</a> <a href="#L-98"> 98</a> <a href="#L-99"> 99</a> <a href="#L-100">100</a> <a href="#L-101">101</a> <a href="#L-102">102</a> <a href="#L-103">103</a> <a href="#L-104">104</a> <a href="#L-105">105</a> <a href="#L-106">106</a> <a href="#L-107">107</a> <a href="#L-108">108</a> <a href="#L-109">109</a> <a href="#L-110">110</a> <a href="#L-111">111</a> <a href="#L-112">112</a> <a href="#L-113">113</a> <a href="#L-114">114</a> <a href="#L-115">115</a> <a href="#L-116">116</a> <a href="#L-117">117</a> <a href="#L-118">118</a> <a href="#L-119">119</a> <a href="#L-120">120</a> <a href="#L-121">121</a> <a href="#L-122">122</a> <a href="#L-123">123</a> <a href="#L-124">124</a> <a href="#L-125">125</a> <a href="#L-126">126</a> <a href="#L-127">127</a> <a href="#L-128">128</a> <a href="#L-129">129</a> <a href="#L-130">130</a> <a href="#L-131">131</a> <a href="#L-132">132</a> <a href="#L-133">133</a> <a href="#L-134">134</a> <a href="#L-135">135</a> <a href="#L-136">136</a> <a href="#L-137">137</a> <a href="#L-138">138</a></pre></div></td><td class="code"><div class="highlight"><pre><span></span><span id="L-1"><a name="L-1"></a><span class="cp">&lt;?php</span> </span><span id="L-2"><a name="L-2"></a> </span><span id="L-3"><a name="L-3"></a><span class="sd">/**</span> </span><span id="L-4"><a name="L-4"></a><span class="sd"> * Blank Model Class for Nooku Framework</span> </span><span id="L-5"><a name="L-5"></a><span class="sd"> *</span> </span><span id="L-6"><a name="L-6"></a><span class="sd"> * This is a blank model based off KModelTable. It has most of the</span> </span><span id="L-7"><a name="L-7"></a><span class="sd"> * common methods when needing to create a new model. Just remove</span> </span><span id="L-8"><a name="L-8"></a><span class="sd"> * the extra stuff you don&#39;t need, and set the values you do!</span> </span><span id="L-9"><a name="L-9"></a><span class="sd"> *</span> </span><span id="L-10"><a name="L-10"></a><span class="sd"> * @author Jeremy Wilken &lt;[email protected]&gt;</span> </span><span id="L-11"><a name="L-11"></a><span class="sd"> */</span> </span><span id="L-12"><a name="L-12"></a> </span><span id="L-13"><a name="L-13"></a><span class="k">class</span> <span class="nc">ComComponentModelBlanks</span> <span class="k">extends</span> <span class="nx">KModelTable</span> </span><span id="L-14"><a name="L-14"></a><span class="p">{</span> </span><span id="L-15"><a name="L-15"></a> <span class="sd">/**</span> </span><span id="L-16"><a name="L-16"></a><span class="sd"> * Class constructor</span> </span><span id="L-17"><a name="L-17"></a><span class="sd"> */</span> </span><span id="L-18"><a name="L-18"></a> <span class="k">public</span> <span class="k">function</span> <span class="nf">__construct</span><span class="p">(</span><span class="nx">KConfig</span> <span class="nv">$config</span><span class="p">)</span> </span><span id="L-19"><a name="L-19"></a> <span class="p">{</span> </span><span id="L-20"><a name="L-20"></a> <span class="k">parent</span><span class="o">::</span><span class="na">__construct</span><span class="p">(</span><span class="nv">$config</span><span class="p">);</span> </span><span id="L-21"><a name="L-21"></a> </span><span id="L-22"><a name="L-22"></a> <span class="c1">// Add custom states. Default states are limit, offset, sort, direction, search</span> </span><span id="L-23"><a name="L-23"></a> <span class="c1">//$this-&gt;_state-&gt;insert(&#39;title&#39; , &#39;string&#39;);</span> </span><span id="L-24"><a name="L-24"></a> <span class="p">}</span> </span><span id="L-25"><a name="L-25"></a> </span><span id="L-26"><a name="L-26"></a> <span class="sd">/**</span> </span><span id="L-27"><a name="L-27"></a><span class="sd"> * Initializes settings, is first to be called in constructor</span> </span><span id="L-28"><a name="L-28"></a><span class="sd"> */</span> </span><span id="L-29"><a name="L-29"></a> </span><span id="L-30"><a name="L-30"></a> <span class="k">protected</span> <span class="k">function</span> <span class="nf">_initialize</span><span class="p">(</span><span class="nx">KConfig</span> <span class="nv">$config</span><span class="p">)</span> </span><span id="L-31"><a name="L-31"></a> <span class="p">{</span> </span><span id="L-32"><a name="L-32"></a> <span class="c1">//$config-&gt;table = &#39;com.component.table.blanks&#39;;</span> </span><span id="L-33"><a name="L-33"></a> <span class="c1">//$config-&gt;table_behaviors = array();</span> </span><span id="L-34"><a name="L-34"></a> </span><span id="L-35"><a name="L-35"></a> <span class="k">parent</span><span class="o">::</span><span class="na">_initialize</span><span class="p">(</span><span class="nv">$config</span><span class="p">);</span> </span><span id="L-36"><a name="L-36"></a> <span class="p">}</span> </span><span id="L-37"><a name="L-37"></a> </span><span id="L-38"><a name="L-38"></a> <span class="sd">/**</span> </span><span id="L-39"><a name="L-39"></a><span class="sd"> * Method to get a item object which represents a table row</span> </span><span id="L-40"><a name="L-40"></a><span class="sd"> *</span> </span><span id="L-41"><a name="L-41"></a><span class="sd"> * @return KDatabaseRow</span> </span><span id="L-42"><a name="L-42"></a><span class="sd"> */</span> </span><span id="L-43"><a name="L-43"></a> <span class="k">public</span> <span class="k">function</span> <span class="nf">getItem</span><span class="p">()</span> </span><span id="L-44"><a name="L-44"></a> <span class="p">{</span> </span><span id="L-45"><a name="L-45"></a> <span class="k">return</span> <span class="k">parent</span><span class="o">::</span><span class="na">getItem</span><span class="p">();</span> </span><span id="L-46"><a name="L-46"></a> <span class="p">}</span> </span><span id="L-47"><a name="L-47"></a> </span><span id="L-48"><a name="L-48"></a> <span class="sd">/**</span> </span><span id="L-49"><a name="L-49"></a><span class="sd"> * Get a list of items which represnts a table rowset</span> </span><span id="L-50"><a name="L-50"></a><span class="sd"> *</span> </span><span id="L-51"><a name="L-51"></a><span class="sd"> * @return KDatabaseRowset</span> </span><span id="L-52"><a name="L-52"></a><span class="sd"> */</span> </span><span id="L-53"><a name="L-53"></a> <span class="k">public</span> <span class="k">function</span> <span class="nf">getList</span><span class="p">()</span> </span><span id="L-54"><a name="L-54"></a> <span class="p">{</span> </span><span id="L-55"><a name="L-55"></a> <span class="k">return</span> <span class="k">parent</span><span class="o">::</span><span class="na">getList</span><span class="p">();</span> </span><span id="L-56"><a name="L-56"></a> <span class="p">}</span> </span><span id="L-57"><a name="L-57"></a> </span><span id="L-58"><a name="L-58"></a> <span class="sd">/**</span> </span><span id="L-59"><a name="L-59"></a><span class="sd"> * Get the total amount of items</span> </span><span id="L-60"><a name="L-60"></a><span class="sd"> *</span> </span><span id="L-61"><a name="L-61"></a><span class="sd"> * @return int</span> </span><span id="L-62"><a name="L-62"></a><span class="sd"> */</span> </span><span id="L-63"><a name="L-63"></a> <span class="k">public</span> <span class="k">function</span> <span class="nf">getTotal</span><span class="p">()</span> </span><span id="L-64"><a name="L-64"></a> <span class="p">{</span> </span><span id="L-65"><a name="L-65"></a> <span class="k">return</span> <span class="k">parent</span><span class="o">::</span><span class="na">getTotal</span><span class="p">();</span> </span><span id="L-66"><a name="L-66"></a> <span class="p">}</span> </span><span id="L-67"><a name="L-67"></a> </span><span id="L-68"><a name="L-68"></a> <span class="sd">/**</span> </span><span id="L-69"><a name="L-69"></a><span class="sd"> * Builds SELECT columns list for the query</span> </span><span id="L-70"><a name="L-70"></a><span class="sd"> */</span> </span><span id="L-71"><a name="L-71"></a> <span class="k">protected</span> <span class="k">function</span> <span class="nf">_buildQueryColumns</span><span class="p">(</span><span class="nx">KDatabaseQuery</span> <span class="nv">$query</span><span class="p">)</span> </span><span id="L-72"><a name="L-72"></a> <span class="p">{</span> </span><span id="L-73"><a name="L-73"></a> <span class="k">parent</span><span class="o">::</span><span class="na">_buildQueryColumns</span><span class="p">(</span><span class="nv">$query</span><span class="p">);</span> </span><span id="L-74"><a name="L-74"></a> <span class="c1">//$query-&gt;select(array(&#39;tbl.*&#39;));</span> </span><span id="L-75"><a name="L-75"></a> <span class="p">}</span> </span><span id="L-76"><a name="L-76"></a> </span><span id="L-77"><a name="L-77"></a> <span class="sd">/**</span> </span><span id="L-78"><a name="L-78"></a><span class="sd"> * Builds FROM tables list for the query</span> </span><span id="L-79"><a name="L-79"></a><span class="sd"> */</span> </span><span id="L-80"><a name="L-80"></a> <span class="k">protected</span> <span class="k">function</span> <span class="nf">_buildQueryFrom</span><span class="p">(</span><span class="nx">KDatabaseQuery</span> <span class="nv">$query</span><span class="p">)</span> </span><span id="L-81"><a name="L-81"></a> <span class="p">{</span> </span><span id="L-82"><a name="L-82"></a> <span class="k">parent</span><span class="o">::</span><span class="na">_buildQueryFrom</span><span class="p">(</span><span class="nv">$query</span><span class="p">);</span> </span><span id="L-83"><a name="L-83"></a> <span class="nv">$name</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getTable</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">getName</span><span class="p">();</span> </span><span id="L-84"><a name="L-84"></a> <span class="nv">$query</span><span class="o">-&gt;</span><span class="na">from</span><span class="p">(</span><span class="nv">$name</span><span class="o">.</span><span class="s1">&#39; AS tbl&#39;</span><span class="p">);</span> </span><span id="L-85"><a name="L-85"></a> <span class="p">}</span> </span><span id="L-86"><a name="L-86"></a> </span><span id="L-87"><a name="L-87"></a> <span class="sd">/**</span> </span><span id="L-88"><a name="L-88"></a><span class="sd"> * Builds LEFT JOINS clauses for the query</span> </span><span id="L-89"><a name="L-89"></a><span class="sd"> */</span> </span><span id="L-90"><a name="L-90"></a> <span class="k">protected</span> <span class="k">function</span> <span class="nf">_buildQueryJoins</span><span class="p">(</span><span class="nx">KDatabaseQuery</span> <span class="nv">$query</span><span class="p">)</span> </span><span id="L-91"><a name="L-91"></a> <span class="p">{</span> </span><span id="L-92"><a name="L-92"></a> <span class="k">parent</span><span class="o">::</span><span class="na">_buildQueryJoins</span><span class="p">(</span><span class="nv">$query</span><span class="p">);</span> </span><span id="L-93"><a name="L-93"></a> <span class="c1">//$query-&gt;join(&#39;LEFT&#39;, &#39;categories AS categories&#39;, &#39;categories.id = tbl.catid&#39;);</span> </span><span id="L-94"><a name="L-94"></a> <span class="p">}</span> </span><span id="L-95"><a name="L-95"></a> </span><span id="L-96"><a name="L-96"></a> <span class="sd">/**</span> </span><span id="L-97"><a name="L-97"></a><span class="sd"> * Builds a WHERE clause for the query</span> </span><span id="L-98"><a name="L-98"></a><span class="sd"> */</span> </span><span id="L-99"><a name="L-99"></a> <span class="k">protected</span> <span class="k">function</span> <span class="nf">_buildQueryWhere</span><span class="p">(</span><span class="nx">KDatabaseQuery</span> <span class="nv">$query</span><span class="p">)</span> </span><span id="L-100"><a name="L-100"></a> <span class="p">{</span> </span><span id="L-101"><a name="L-101"></a> <span class="k">parent</span><span class="o">::</span><span class="na">_buildQueryWhere</span><span class="p">(</span><span class="nv">$query</span><span class="p">);</span> </span><span id="L-102"><a name="L-102"></a> <span class="c1">//if ($this-&gt;_state-&gt;state) $query-&gt;where(&#39;tbl.column&#39;, &#39;=&#39;, &#39;value&#39;);</span> </span><span id="L-103"><a name="L-103"></a> <span class="p">}</span> </span><span id="L-104"><a name="L-104"></a> </span><span id="L-105"><a name="L-105"></a> <span class="sd">/**</span> </span><span id="L-106"><a name="L-106"></a><span class="sd"> * Builds a GROUP BY clause for the query</span> </span><span id="L-107"><a name="L-107"></a><span class="sd"> */</span> </span><span id="L-108"><a name="L-108"></a> <span class="k">protected</span> <span class="k">function</span> <span class="nf">_buildQueryGroup</span><span class="p">(</span><span class="nx">KDatabaseQuery</span> <span class="nv">$query</span><span class="p">)</span> </span><span id="L-109"><a name="L-109"></a> <span class="p">{</span> </span><span id="L-110"><a name="L-110"></a> <span class="k">parent</span><span class="o">::</span><span class="na">_buildQueryGroup</span><span class="p">(</span><span class="nv">$query</span><span class="p">);</span> </span><span id="L-111"><a name="L-111"></a> <span class="p">}</span> </span><span id="L-112"><a name="L-112"></a> </span><span id="L-113"><a name="L-113"></a> <span class="sd">/**</span> </span><span id="L-114"><a name="L-114"></a><span class="sd"> * Builds a HAVING clause for the query</span> </span><span id="L-115"><a name="L-115"></a><span class="sd"> */</span> </span><span id="L-116"><a name="L-116"></a> <span class="k">protected</span> <span class="k">function</span> <span class="nf">_buildQueryHaving</span><span class="p">(</span><span class="nx">KDatabaseQuery</span> <span class="nv">$query</span><span class="p">)</span> </span><span id="L-117"><a name="L-117"></a> <span class="p">{</span> </span><span id="L-118"><a name="L-118"></a> <span class="k">parent</span><span class="o">::</span><span class="na">_buildQueryHaving</span><span class="p">(</span><span class="nv">$query</span><span class="p">);</span> </span><span id="L-119"><a name="L-119"></a> <span class="p">}</span> </span><span id="L-120"><a name="L-120"></a> </span><span id="L-121"><a name="L-121"></a> <span class="sd">/**</span> </span><span id="L-122"><a name="L-122"></a><span class="sd"> * Builds a generic ORDER BY clasue based on the model&#39;s state</span> </span><span id="L-123"><a name="L-123"></a><span class="sd"> */</span> </span><span id="L-124"><a name="L-124"></a> <span class="k">protected</span> <span class="k">function</span> <span class="nf">_buildQueryOrder</span><span class="p">(</span><span class="nx">KDatabaseQuery</span> <span class="nv">$query</span><span class="p">)</span> </span><span id="L-125"><a name="L-125"></a> <span class="p">{</span> </span><span id="L-126"><a name="L-126"></a> <span class="k">parent</span><span class="o">::</span><span class="na">_buildQueryOrder</span><span class="p">(</span><span class="nv">$query</span><span class="p">);</span> </span><span id="L-127"><a name="L-127"></a> <span class="c1">//$query-&gt;order(&#39;state&#39;, &#39;DESC&#39;);</span> </span><span id="L-128"><a name="L-128"></a> <span class="p">}</span> </span><span id="L-129"><a name="L-129"></a> </span><span id="L-130"><a name="L-130"></a> <span class="sd">/**</span> </span><span id="L-131"><a name="L-131"></a><span class="sd"> * Builds LIMIT clause for the query</span> </span><span id="L-132"><a name="L-132"></a><span class="sd"> */</span> </span><span id="L-133"><a name="L-133"></a> <span class="k">protected</span> <span class="k">function</span> <span class="nf">_buildQueryLimit</span><span class="p">(</span><span class="nx">KDatabaseQuery</span> <span class="nv">$query</span><span class="p">)</span> </span><span id="L-134"><a name="L-134"></a> <span class="p">{</span> </span><span id="L-135"><a name="L-135"></a> <span class="k">parent</span><span class="o">::</span><span class="na">_buildQueryLimit</span><span class="p">(</span><span class="nv">$query</span><span class="p">);</span> </span><span id="L-136"><a name="L-136"></a> <span class="c1">//if ($this-&gt;_state-&gt;state) $query-&gt;limit($this-&gt;_state-&gt;state, &#39;default&#39;);</span> </span><span id="L-137"><a name="L-137"></a> <span class="p">}</span> </span><span id="L-138"><a name="L-138"></a><span class="p">}</span> </span></pre></div> </td></tr></table>
model, nooku