Ariadne

• Programmers Ref…»
• Ariadne General…»
• store»

ar\store

This module contains methods to access the ariadne store and run templates on other objects. These methods are all also directly available in the root ar module. e.g. ar_store::ls() or ar('store')->ls() can also be written as ar::ls().

methods

configure

(void) ar('store')->configure( $option, $value )

The ar_store module supports the following options:

currentProject

(string) ar('store')->currentProject( $path = '' )

Returns the path to the nearest project. Nearest in this case means the nearest parent or if the given path argument is a project it will return this. 

currentSection

(string) ar('store')->currentSection( $path = '' )

Returns the path to the nearest section. Nearest in this case means the nearest parent or if the given path argument is a section it will return this.

currentSite

(string) ar('store')->currentSite( $path = '' )

Returns the path to the nearest site. Nearest in this case means the nearest parent or if the given path argument is a site it will return this.

exists

(mixed) ar('store')->exists( $path )
(mixed) ar::exists( $path )

If the given path exists, this method will return its id. If not it will return false. 

find

(object) ar('store')->find( $query )
(object) ar::find( $query )

This method returns a new ar_storeFind object with the given query set. The ar_storeFind object has the following methods:

(mixed) $storeFind->call( $template, $args=null )

Calls the given template with the given arguments on the Ariadne objects that match the query $query. The results returned by the template will be collected and returned in an array. The key of the array is the path of the object which returned that result. See ar::call() for more information. 

In addition to the options of ar::call(), you can also specify a listPattern as $template. In that case the listPattern will be automatically converted to a listExpression with the number of objects found as the length. e.g.:

<pinp>
  ar::find( "object.implements = 'pdir'")->call(
    ar::listPattern( 
      'show.single.html | ' .
      'show.first.html ( show.odd.html show.even.html? )* show.last.html'
    )
  );
</pinp>

This will call the following templates in order on the objects found:

For five objects:

show.first.html
show.odd.html
show.even.html
show.odd.html
show.last.html

For three objects:

show.first.html
show.odd.html
show.last.html

For a single object:

show.single.html

(int) $storeFind->count()

Returns the number of objects that match the given query.

(object) $storeFind->limit($limit)

Returns a clone of itself with the result limit set to $limit.

(object) $storeFind->offset($offset)

Returns a clone of itself with the result offset set to $offset

(object) $storeFind->order($order)

Returns a clone of itself with the result order set to $order.

Examples:

ar('store')->find("name.value ~= 'A%' and name.nls='en')
           ->order('name.value ASC')
           ->limit(10)
           ->offset(10)
           ->call('show.html');

The example above finds all objects with a name starting with A, in english. Orders the results alfabetically by name, skips the first 10 results and then calls the template 'show.html' and the next 10 results.

Query Format

( propertyName.valueName compare $value ( and | or )? )+

The query string format is a bit like SQL, but geared only to data retrieval. You can search on any Ariadne property, a short list is presented below. The valid compare methods are:

For like (~=) and not like (!~) the '%' character is used as a wildcard, it will match any string. The fulltext search will only work on the fulltext property and is currently only supported in MySQL.

List of most used properties in Ariadne.

You can combine multiple properties, or multiple values of a property, in a single query, e.g.:

  $query = "name.value ~='A%' and name.nls = 'en'";

This query matches any object whose name starts with 'A' in english.

  $query = "object.implements = 'ppage' and time.ctime > ".$lastweek;

Will match any object whose class is a subclass of ppage and which is created within the last week.

You can use both AND and OR to combine properties. Use parentheses, ( and ), to make clear how these properties should be combined. e.g.:

  $query = "object.implements = 'ppage' or ".
           "( object.type = 'pphoto' and time.ctime > $lastweek )";

This will match all page objects, or subclasses thereof, and all pphoto objects created in the last week.

Custom properties

You can query a custom property (a property defined via the custom fields wizard) by prefixing the name of the property with 'my.' e.g.:

  $query = "my.price >= 90";

If the property is language dependant, you can define the language like this:

  $query = "my.description ~= '%" . AddSlashes( $keyword ) . "%'" .
           " and my.nls = '" . $nls . "'"; 

Multiple checks on a single property

For some properties multiple values are stored for a single object. In some cases you may need to check more than one of these values based on different criteria. You can do this via the following query syntax:

  $query =
    "( my.keyword:a.value = '" . AddSlashes( $keyword1 ) . "'" .
    " and my.keyword:a.nls = '" . $nls . "' )" .
    " and ( my.keyword:b.value = '" . AddSlashes( $keyword2 ) . "'" .
    " and my.keyword:b.nls = '" . $nls . "')";

The ':a ' and ':b ' define 'tags' for that specific match, so that firstly the query engine knows that keyword1 and keyword2 do not need to match both with the same property record, just as long as there is a matching record for both of them, and secondly it also knows which nls field must match with which record, although in this case they're both the same.

fulltext searches

Ariadne supports MySQL's full text search options. However for historical reasons the words are stored in an encoded format. All non-ascii characters are replaced with their hexadecimal value. So if you want to search for words containing special characters, you'll need to include code similar to this:

  $allowedchars  = "_'-";
  $searchFTI     = array("%[\\x80-\\xFF$allowedchars]%es", "%\\s+%s");
  $replaceFTI    = array("'_'.dechex(ord('\\0'))", " ");
  $searchTextFTI = preg_replace( $searchFTI, $replaceFTI, $searchText);  

And then use the $searchTextFTI in your query instead of $searchText.

MySQL has support for searches in 'natural language' mode and 'boolean search' mode. In natural language mode MySQL searches for the complete phrase given. It is triggered by the '=*' and '!*' operators. In boolean search mode, you can specify AND, NOT and OR for each word, like this:

get

(object) ar('store')->get( $path )
(object) ar::get( $path )

This method returns a new ar_storeGet object, with the given path set. The ar_storeGet object has the following methods:

(array) $storeGet->call( $template, $args=null )

Calls the given template with the given arguments on the Ariadne object with path $path. The results returned by the template will be returned in an array. The key of the array is the path of the object. See ar::call() for more information.

(object) $storeGet->parents()

Return a new ar_storeParents object for the given path. See the ar_store::parents() method for more information.

(object) $storeGet->find( $query )

Returns an ar_storeFind object with the given query and the given path. See the ar_store::find() method for more information.

(object) $storeGet->ls()

Returns an ar_storeList object with the given path. See the ar_store::ls() method for further information.

Examples:

ar('store')->get('/system/')->call('view.html');

ls

(object) ar('store')->ls()
(object) ar::ls()

This method returns a new ar_storeList object. This object implements the ar_storeFind class. The only change is that it automatically sets a search query to list only the immediate children of the current path. See find() for more information on the results.

Example:

ar('store')->ls()
           ->order('name.value ASC')
           ->call('show.html');

makePath

(string) ar('store')->makePath( $path = '' )

Returns an absolute path, which may still be virtual, depending on the rememberShortcuts setting. If this setting is set to true, the returned path may contain shortcut redirects.

makeRealPath

(string) ar('store')->makeRealPath( $path = '' )

Returns an absolute and resolved path. There is no guarantee that an object with this path exists, but if it doesn't than the original path was invalid.

parents

(object) ar('store')->parents()
(object) ar::parents() 

This method returns a new ar_storeParents object. This object implements the following methods:

(mixed) $storeParents->call( $template, $args=null )

Calls the given template with the given arguments on the Ariadne object with path $path. The results returned by the template will be returned in an array. The key of the array is the path of the object. See ar::call() and ar_store::find()->call() for more information.

(int) $storeParents->count()

Returns the number of parent objects found.

(object) $storeParents->top()

Returns a clone of itself with the top most parent to find set.

Example:

ar('store')->parents()
           ->top( ar('store')->currentSite() )
           ->call('show.html');

This example shows a crumb trail of the current object starting with the site root.

parentProject

(string) ar('store')->parentProject( $path = '' )

Returns the path to the nearest parent project.

parentSection

(string) ar('store')->parentSection( $path = '' )

Returns the path to the nearest parent section.

parentSite

(string) ar('store')->parentSite( $path = '' )

Returns the path to the nearest parent site.

• FAQ
• Installation
• User Manual
• Tutorials
• Programmers Reference
  • architecture
  • classes
  • Ariadne General API
    • Cache
    • Content
    • connect
    • CSS
    • error
    • events
    • HTML
    • HTTP
    • loader
    • PINP
    • store
      • Files
    • URL
    • XML
  • modules
  • Templates
• Installation Requirements
• Examples