Skip to content
Open

Dev #56

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 62 additions & 29 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
href="#/versions"
title="Find all versions of SleekDB"
class="menu gotoblock"
><ion-icon class="hide-sm" name="pricetag"></ion-icon> 2.13</a
><ion-icon class="hide-sm" name="pricetag"></ion-icon> 2.15</a
>
<a
class="menu"
Expand Down Expand Up @@ -217,7 +217,7 @@ <h2>👋 Say Hi!</h2>
<p>Join our <a href="https://discord.gg/WJGqUFPtZw" target="_blank" rel="noopener nofollow" class="btn btn-primary btn-block">Discord</a> channel. We would love to know about you and your feedbacks.</p>
<div class="editlink"
file="home.md"
version="2.13">
version="2.15">
</div>
</div>

Expand Down Expand Up @@ -331,7 +331,7 @@ <h1>💌 Support</h1>
</ul>
<div class="editlink"
file="features.md"
version="2.13">
version="2.15">
</div>
</div>

Expand Down Expand Up @@ -364,7 +364,7 @@ <h2>Using dev version (Not recommended)</h2>
<pre><code class="language-sh">composer require rakibtg/sleekdb dev-dev</code></pre>
<div class="editlink"
file="installation.md"
version="2.13">
version="2.15">
</div>
</div>

Expand Down Expand Up @@ -436,7 +436,7 @@ <h2>First Example - Insert and Fetch Data</h2>
</blockquote>
<div class="editlink"
file="getting-started.md"
version="2.13">
version="2.15">
</div>
</div>

Expand Down Expand Up @@ -479,7 +479,7 @@ <h2>Deleting A Store</h2>
<pre><code class="language-php">$userStore-&gt;deleteStore();</code></pre>
<div class="editlink"
file="managing-store.md"
version="2.13">
version="2.15">
</div>
</div>

Expand All @@ -493,6 +493,7 @@ <h1>Configurations</h1>
( 🚨 Deprecated since version 2.12, set it to <code>false</code> and if needed use <a href="https://www.php.net/manual/en/function.set-time-limit.php" target="_blank" rel="noopener nofollow">set_time_limit()</a> in your own code! )</li>
<li><a class="gotoblock" href="#/configurations#primary_key">primary_key</a></li>
<li><a class="gotoblock" href="#/configurations#search">search</a></li>
<li><a class="gotoblock" href="#/configurations#folder_permissions">folder_permissions</a></li>
</ul>
<p>They are store wide, which means they will be used on every query, if not changed on a query by query base.</p>
<h2>Using Custom Configuration</h2>
Expand All @@ -508,7 +509,8 @@ <h2>Using Custom Configuration</h2>
"mode" =&gt; "or",
"score_key" =&gt; "scoreKey",
"algorithm" =&gt; Query::SEARCH_ALGORITHM["hits"]
]
],
"folder_permissions" =&gt; 0777
];
$newsStore = new \SleekDB\Store("news", $dataDir, $configuration);</code></pre>
<p>Let's get familiar with the available configuration options.</p>
Expand Down Expand Up @@ -573,9 +575,13 @@ <h3>algorithm</h3>
They are available as a <strong>constant of the <code>Query</code> class</strong>.</p>
<p>Example:</p>
<pre><code class="language-php">Query::SEARCH_ALGORITHM["hits"] // default</code></pre>
<h2 id="configurations-folder_permissions">folder_permissions</h2>
<p><code>folder_permissions</code> is set to <code>0777</code> by default!</p>
<p>It has to be a valid <code>int</code>. Refer to the <a href="https://www.php.net/manual/en/function.chmod.php" target="_blank">official documentation</a> to learn more about permissions.</p>
<p>The given permission is <strong>only used when creating a new folder</strong>. For example when creating a new store, that does not already exist.</p>
<div class="editlink"
file="configurations.md"
version="2.13">
version="2.15">
</div>
</div>

Expand Down Expand Up @@ -776,7 +782,7 @@ <h3>Example 2</h3>
// Lisa will get a auto-generated _id, because there is no _id in the document!</code></pre>
<div class="editlink"
file="insert-data.md"
version="2.13">
version="2.15">
</div>
</div>

Expand Down Expand Up @@ -935,7 +941,7 @@ <h3>Example</h3>
// Returns: 27 </code></pre>
<div class="editlink"
file="fetch-data.md"
version="2.13">
version="2.15">
</div>
</div>

Expand Down Expand Up @@ -1184,7 +1190,7 @@ <h3>Example 2</h3>
// Lisa will get a auto-generated _id, because there is no _id in the document!</code></pre>
<div class="editlink"
file="edit-data.md"
version="2.13">
version="2.15">
</div>
</div>

Expand Down Expand Up @@ -1269,7 +1275,7 @@ <h3>Example</h3>
// Returns true</code></pre>
<div class="editlink"
file="delete-data.md"
version="2.13">
version="2.15">
</div>
</div>

Expand Down Expand Up @@ -1332,6 +1338,8 @@ <h1>$condition: string</h1>
<li><code>&lt;=</code> Match less equal against data.</li>
<li><code>LIKE</code> Match using wildcards.</li>
<li><code>NOT LIKE</code> Match using wildcards. <strong>Negation</strong> of result.<br/>
You can escape the following wildcards by appending a <code>\</code>.<br/>
For example <code>\%</code>.<br/>
Supported wildcards:
<ul>
<li><code>%</code> Represents zero or more characters<br/>
Expand Down Expand Up @@ -1457,7 +1465,7 @@ <h3>Example 4</h3>
]);</code></pre>
<div class="editlink"
file="criteria.md"
version="2.13">
version="2.15">
</div>
</div>

Expand Down Expand Up @@ -2414,7 +2422,7 @@ <h3>Examples</h3>
-&gt;fetch();</code></pre>
<div class="editlink"
file="query-builder.md"
version="2.13">
version="2.15">
</div>
</div>

Expand Down Expand Up @@ -2529,7 +2537,7 @@ <h3>Example</h3>
-&gt;fetch();</code></pre>
<div class="editlink"
file="cache-management.md"
version="2.13">
version="2.15">
</div>
</div>

Expand Down Expand Up @@ -2651,7 +2659,7 @@ <h3>Example 3</h3>
-&gt;fetch();</code></pre>
<div class="editlink"
file="join-stores.md"
version="2.13">
version="2.15">
</div>
</div>

Expand Down Expand Up @@ -2848,7 +2856,7 @@ <h4>Result</h4>
]</code></pre>
<div class="editlink"
file="query.md"
version="2.13">
version="2.15">
</div>
</div>

Expand Down Expand Up @@ -2991,7 +2999,7 @@ <h2>Not using DateTime</h2>
// WHERE releaseDate IN ("2020-12-01", "2021-01-04", "2021-01-19")</code></pre>
<div class="editlink"
file="dates.md"
version="2.13">
version="2.15">
</div>
</div>

Expand Down Expand Up @@ -3252,7 +3260,7 @@ <h3>Example 2</h3>
);</code></pre>
<div class="editlink"
file="searching.md"
version="2.13">
version="2.15">
</div>
</div>

Expand Down Expand Up @@ -3412,7 +3420,7 @@ <h1 id="execution-order-query-limit">LIMIT</h1>
</ol>
<div class="editlink"
file="execution-order.md"
version="2.13">
version="2.15">
</div>
</div>

Expand Down Expand Up @@ -3488,7 +3496,7 @@ <h3>Example</h3>
$usersUpdated = $userQuery-&gt;fetch();</code></pre>
<div class="editlink"
file="advanced.md"
version="2.13">
version="2.15">
</div>
</div>

Expand Down Expand Up @@ -3879,7 +3887,7 @@ <h2 id="complete-examples-search-query_builder">Searching documents using the Qu
echo json_encode($result);</code></pre>
<div class="editlink"
file="complete-examples.md"
version="2.13">
version="2.15">
</div>
</div>

Expand Down Expand Up @@ -3957,7 +3965,7 @@ <h3>Return value</h3>
<p>Either <code>int</code> &gt;= 0 in seconds, where <code>0</code> means infinite, or <code>null</code>.</p>
<div class="editlink"
file="cache.md"
version="2.13">
version="2.15">
</div>
</div>

Expand Down Expand Up @@ -4119,7 +4127,7 @@ <h2>Cache</h2>
<pre><code class="language-php">function delete()</code></pre>
<div class="editlink"
file="reference.md"
version="2.13">
version="2.15">
</div>
</div>

Expand All @@ -4129,6 +4137,8 @@ <h2>📢 Optimizations, new query methods and more control</h2>
<p>SleekDB 2.X comes with so many important optimizations and other features that make it faster and more mature. This is the recommended SleekDB release version for new projects, and if you are using an older version consider upgrading as soon as possible.</p>
<h2>Summary</h2>
<ul>
<li><a class="gotoblock" href="#/release-notes#2.15">Changes from 2.14 to 2.15</a></li>
<li><a class="gotoblock" href="#/release-notes#2.14">Changes from 2.13 to 2.14</a></li>
<li><a class="gotoblock" href="#/release-notes#2.13">Changes from 2.12 to 2.13</a></li>
<li><a class="gotoblock" href="#/release-notes#2.12">Changes from 2.11 to 2.12</a></li>
<li><a class="gotoblock" href="#/release-notes#2.11">Changes from 2.10 to 2.11</a></li>
Expand All @@ -4144,6 +4154,27 @@ <h2>Summary</h2>
<li><a class="gotoblock" href="#/release-notes#2.1">Changes from 2.0 to 2.1</a></li>
<li><a class="gotoblock" href="#/release-notes#2.0">Changes from 1.5 to 2.0</a></li>
</ul>
<h2 id="release-notes-2.15">Changes from 2.14 to 2.15</h2>
<ul>
<li>
<h1>✨ Ability to set folder permissions</h1>
<ul>
<li>Set the permissions SleekDB uses to create new folders. <a class="gotoblock" href="/#/configurations#folder_permissions">folder_permissions</a></li>
</ul>
</li>
</ul>
<h2 id="release-notes-2.14">Changes from 2.13 to 2.14</h2>
<ul>
<li>
<h1>🚨 Fixed bug regarding internal escaping when using <code>LIKE</code> and <code>NOT LIKE</code></h1>
</li>
<li>
<h1>🌈 New ability to escape wildcards</h1>
<ul>
<li><a class="gotoblock" href="/#/criteria#criteria">$criteria</a></li>
</ul>
</li>
</ul>
<h2 id="release-notes-2.13">Changes from 2.12 to 2.13</h2>
<ul>
<li>
Expand Down Expand Up @@ -4638,7 +4669,7 @@ <h2>Issues</h2>
</ul>
<div class="editlink"
file="release-notes.md"
version="2.13">
version="2.15">
</div>
</div>

Expand All @@ -4654,7 +4685,7 @@ <h1>Contributing</h1>
<p>Please write details about your PR.</p>
<div class="editlink"
file="contributing.md"
version="2.13">
version="2.15">
</div>
</div>

Expand All @@ -4667,14 +4698,16 @@ <h2>About</h2>
<p>Let us know with a tweet if you love or hate SleekDB 😄, or if you have any question mail me or tweet to my twitter handle.</p>
<div class="editlink"
file="contact.md"
version="2.13">
version="2.15">
</div>
</div>

<div class="intro" id="block_versions">
<h1>Versions</h1>
<ul>
<li><strong><a href="/">2.13</a> (Actively Maintained Version)</strong></li>
<li><strong><a href="/">2.15</a> (Actively Maintained Version)</strong></li>
<li><strong><a href="/versions/2.14/">2.14</a></strong></li>
<li><strong><a href="/versions/2.13/">2.13</a></strong></li>
<li><strong><a href="/versions/2.12/">2.12</a></strong></li>
<li><strong><a href="/versions/2.10/">2.11</a></strong></li>
<li><strong><a href="/versions/2.10/">2.10</a></strong></li>
Expand All @@ -4692,7 +4725,7 @@ <h1>Versions</h1>
</ul>
<div class="editlink"
file="versions.md"
version="2.13">
version="2.15">
</div>
</div>

Expand Down
4 changes: 3 additions & 1 deletion versions/1.5/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -785,7 +785,9 @@ <h2>About</h2>
<div class="intro" id="block_versions">
<h1>Versions</h1>
<ul>
<li><strong><a href="/">2.13</a> (Actively Maintained Version)</strong></li>
<li><strong><a href="/">2.15</a> (Actively Maintained Version)</strong></li>
<li><strong><a href="/versions/2.14/">2.14</a></strong></li>
<li><strong><a href="/versions/2.13/">2.13</a></strong></li>
<li><strong><a href="/versions/2.12/">2.12</a></strong></li>
<li><strong><a href="/versions/2.10/">2.11</a></strong></li>
<li><strong><a href="/versions/2.10/">2.10</a></strong></li>
Expand Down
4 changes: 3 additions & 1 deletion versions/2.0/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2026,7 +2026,9 @@ <h2>About</h2>
<div class="intro" id="block_versions">
<h1>Versions</h1>
<ul>
<li><strong><a href="/">2.13</a> (Actively Maintained Version)</strong></li>
<li><strong><a href="/">2.15</a> (Actively Maintained Version)</strong></li>
<li><strong><a href="/versions/2.14/">2.14</a></strong></li>
<li><strong><a href="/versions/2.13/">2.13</a></strong></li>
<li><strong><a href="/versions/2.12/">2.12</a></strong></li>
<li><strong><a href="/versions/2.10/">2.11</a></strong></li>
<li><strong><a href="/versions/2.10/">2.10</a></strong></li>
Expand Down
4 changes: 3 additions & 1 deletion versions/2.1/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2038,7 +2038,9 @@ <h2>About</h2>
<div class="intro" id="block_versions">
<h1>Versions</h1>
<ul>
<li><strong><a href="/">2.13</a> (Actively Maintained Version)</strong></li>
<li><strong><a href="/">2.15</a> (Actively Maintained Version)</strong></li>
<li><strong><a href="/versions/2.14/">2.14</a></strong></li>
<li><strong><a href="/versions/2.13/">2.13</a></strong></li>
<li><strong><a href="/versions/2.12/">2.12</a></strong></li>
<li><strong><a href="/versions/2.10/">2.11</a></strong></li>
<li><strong><a href="/versions/2.10/">2.10</a></strong></li>
Expand Down
4 changes: 3 additions & 1 deletion versions/2.10/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4628,7 +4628,9 @@ <h2>About</h2>
<div class="intro" id="block_versions">
<h1>Versions</h1>
<ul>
<li><strong><a href="/">2.13</a> (Actively Maintained Version)</strong></li>
<li><strong><a href="/">2.15</a> (Actively Maintained Version)</strong></li>
<li><strong><a href="/versions/2.14/">2.14</a></strong></li>
<li><strong><a href="/versions/2.13/">2.13</a></strong></li>
<li><strong><a href="/versions/2.12/">2.12</a></strong></li>
<li><strong><a href="/versions/2.10/">2.11</a></strong></li>
<li><strong><a href="/versions/2.10/">2.10</a></strong></li>
Expand Down
4 changes: 3 additions & 1 deletion versions/2.11/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4645,7 +4645,9 @@ <h2>About</h2>
<div class="intro" id="block_versions">
<h1>Versions</h1>
<ul>
<li><strong><a href="/">2.13</a> (Actively Maintained Version)</strong></li>
<li><strong><a href="/">2.15</a> (Actively Maintained Version)</strong></li>
<li><strong><a href="/versions/2.14/">2.14</a></strong></li>
<li><strong><a href="/versions/2.13/">2.13</a></strong></li>
<li><strong><a href="/versions/2.12/">2.12</a></strong></li>
<li><strong><a href="/versions/2.10/">2.11</a></strong></li>
<li><strong><a href="/versions/2.10/">2.10</a></strong></li>
Expand Down
4 changes: 3 additions & 1 deletion versions/2.12/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4657,7 +4657,9 @@ <h2>About</h2>
<div class="intro" id="block_versions">
<h1>Versions</h1>
<ul>
<li><strong><a href="/">2.13</a> (Actively Maintained Version)</strong></li>
<li><strong><a href="/">2.15</a> (Actively Maintained Version)</strong></li>
<li><strong><a href="/versions/2.14/">2.14</a></strong></li>
<li><strong><a href="/versions/2.13/">2.13</a></strong></li>
<li><strong><a href="/versions/2.12/">2.12</a></strong></li>
<li><strong><a href="/versions/2.10/">2.11</a></strong></li>
<li><strong><a href="/versions/2.10/">2.10</a></strong></li>
Expand Down
4 changes: 3 additions & 1 deletion versions/2.13/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4675,7 +4675,9 @@ <h2>About</h2>
<div class="intro" id="block_versions">
<h1>Versions</h1>
<ul>
<li><strong><a href="/">2.13</a> (Actively Maintained Version)</strong></li>
<li><strong><a href="/">2.15</a> (Actively Maintained Version)</strong></li>
<li><strong><a href="/versions/2.14/">2.14</a></strong></li>
<li><strong><a href="/versions/2.13/">2.13</a></strong></li>
<li><strong><a href="/versions/2.12/">2.12</a></strong></li>
<li><strong><a href="/versions/2.10/">2.11</a></strong></li>
<li><strong><a href="/versions/2.10/">2.10</a></strong></li>
Expand Down
Loading