Add doc

README.md

@@ -1 +1,49 @@
 Usage of phpcr with jackalope-jackrabbit
+
+## Install
+
+Require composer
+
+	./install.sh
+
+## Examples
+
+### src/Jackalope
+
+Operations using phpcr with jackalope-jackrabbit
+
+### src/DoctrinePhpcrOdm/
+
+Operations using Doctrine PHPCR ODM over phpcr with jackalope-jackrabbit
+
+
+## Jackrabbit
+
+### Download
+
+
+More info in the [download page]( http://jackrabbit.apache.org/jcr/downloads.html)
+
+
+### Run jackrabbit server
+
+	./start-server.sh &
+
+At first time:
+
+ 	./vendor/bin/phpcrodm doctrine:phpcr:register-system-node-types
+
+### Watch logs
+
+	tail -f var/jackrabbit/log/*
+
+### Rebuild
+
+1) Stop jackrabbit server
+2) Execute ``rm -rfv var/jackrabbit var/*UNDEFINED``
+3) Repeat step "Run jackrabbit server" like the first time
+
+
+## Execute examples
+
+	./run-all.sh

Resources/repository.xml

@@ -0,0 +1,128 @@
+<?xml version="1.0"?>
+<!--
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+-->
+<!DOCTYPE Repository PUBLIC "-//The Apache Software Foundation//DTD Jackrabbit 1.4//EN"
+                            "http://jackrabbit.apache.org/dtd/repository-1.4.dtd">
+<!-- Example Repository Configuration File -->
+<Repository>
+    <!--
+        virtual file system where the repository stores global state
+        (e.g. registered namespaces, custom node types, etc.)
+    -->
+    <FileSystem class="org.apache.jackrabbit.core.fs.local.LocalFileSystem">
+        <param name="path" value="${rep.home}/repository"/>
+    </FileSystem>
+
+    <DataStore class="org.apache.jackrabbit.core.data.FileDataStore">
+        <param name="path" value="${rep.home}/repository/datastore"/>
+        <param name="minRecordLength" value="100"/>
+    </DataStore>
+    <!--
+        security configuration
+    -->
+    <Security appName="Jackrabbit">
+        <!--
+            access manager:
+            class: FQN of class implementing the AccessManager interface
+        -->
+        <AccessManager class="org.apache.jackrabbit.core.security.SimpleAccessManager">
+            <!-- <param name="config" value="${rep.home}/access.xml"/> -->
+        </AccessManager>
+
+        <LoginModule class="org.apache.jackrabbit.core.security.SimpleLoginModule">
+           <!-- anonymous user name ('anonymous' is the default value) -->
+           <param name="anonymousId" value="anonymous"/>
+           <!--
+              default user name to be used instead of the anonymous user
+              when no login credentials are provided (unset by default)
+           -->
+           <!-- uncommented line below - DJW -->
+           <param name="defaultUserId" value="superuser"/>
+        </LoginModule>
+    </Security>
+
+    <!--
+        location of workspaces root directory and name of default workspace
+    -->
+    <Workspaces rootPath="${rep.home}/workspaces" defaultWorkspace="default"/>
+    <!--
+        workspace configuration template:
+        used to create the initial workspace if there's no workspace yet
+    -->
+    <Workspace name="${wsp.name}">
+        <!--
+            virtual file system of the workspace:
+            class: FQN of class implementing the FileSystem interface
+        -->
+        <FileSystem class="org.apache.jackrabbit.core.fs.local.LocalFileSystem">
+            <param name="path" value="${wsp.home}"/>
+        </FileSystem>
+        <!--
+            persistence manager of the workspace:
+            class: FQN of class implementing the PersistenceManager interface
+        -->
+        <PersistenceManager class="org.apache.jackrabbit.core.persistence.bundle.DerbyPersistenceManager">
+          <param name="url" value="jdbc:derby:${wsp.home}/db;create=true"/>
+          <param name="schemaObjectPrefix" value="${wsp.name}_"/>
+        </PersistenceManager>
+        <!--
+            Search index and the file system it uses.
+            class: FQN of class implementing the QueryHandler interface
+        -->
+        <SearchIndex class="org.apache.jackrabbit.core.query.lucene.SearchIndex">
+            <param name="path" value="${wsp.home}/index"/>
+            <param name="textFilterClasses" value="org.apache.jackrabbit.extractor.MsWordTextExtractor,org.apache.jackrabbit.extractor.MsExcelTextExtractor,org.apache.jackrabbit.extractor.MsPowerPointTextExtractor,org.apache.jackrabbit.extractor.PdfTextExtractor,org.apache.jackrabbit.extractor.OpenOfficeTextExtractor,org.apache.jackrabbit.extractor.RTFTextExtractor,org.apache.jackrabbit.extractor.HTMLTextExtractor,org.apache.jackrabbit.extractor.XMLTextExtractor"/>
+            <param name="extractorPoolSize " value="2"/>
+            <param name="supportHighlighting" value="true"/>
+        </SearchIndex>
+    </Workspace>
+
+    <!--
+        Configures the versioning
+    -->
+    <Versioning rootPath="${rep.home}/version">
+        <!--
+            Configures the filesystem to use for versioning for the respective
+            persistence manager
+        -->
+        <FileSystem class="org.apache.jackrabbit.core.fs.local.LocalFileSystem">
+            <param name="path" value="${rep.home}/version" />
+        </FileSystem>
+
+        <!--
+            Configures the persistence manager to be used for persisting version state.
+            Please note that the current versioning implementation is based on
+            a 'normal' persistence manager, but this could change in future
+            implementations.
+        -->
+        <PersistenceManager class="org.apache.jackrabbit.core.persistence.bundle.DerbyPersistenceManager">
+          <param name="url" value="jdbc:derby:${rep.home}/version/db;create=true"/>
+          <param name="schemaObjectPrefix" value="version_"/>
+        </PersistenceManager>
+    </Versioning>
+
+    <!--
+        Search index for content that is shared repository wide
+        (/jcr:system tree, contains mainly versions)
+    -->
+    <SearchIndex class="org.apache.jackrabbit.core.query.lucene.SearchIndex">
+        <param name="path" value="${rep.home}/repository/index"/>
+        <param name="textFilterClasses" value="org.apache.jackrabbit.extractor.MsWordTextExtractor,org.apache.jackrabbit.extractor.MsExcelTextExtractor,org.apache.jackrabbit.extractor.MsPowerPointTextExtractor,org.apache.jackrabbit.extractor.PdfTextExtractor,org.apache.jackrabbit.extractor.OpenOfficeTextExtractor,org.apache.jackrabbit.extractor.RTFTextExtractor,org.apache.jackrabbit.extractor.HTMLTextExtractor,org.apache.jackrabbit.extractor.XMLTextExtractor"/>
+        <param name="extractorPoolSize " value="2"/>
+        <param name="supportHighlighting" value="true"/>
+    </SearchIndex>
+</Repository>

install.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+composer install;
+wget http://ftp.unicamp.br/pub/apache/jackrabbit/2.16.1/jackrabbit-standalone-2.16.1.jar -O var/jackrabbit-standalone.jar;

run-all.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-for f in src/*/0*php; do
-  echo "File -> $f"
-  #php $f;
+for f in src/DoctrinePhpcrOdm/0*php; do
+  echo "File -> $f";
+  php $f;
 done

src/Jackalope/010-GettingStated.php

@@ -17,6 +17,12 @@
 
 require __DIR__.'/bootstrap.php';
 
+/**
+ * The shortest self-contained example should output a line with ‘value’:.
+ *
+ * @see http://phpcr.readthedocs.io/en/latest/book/getting_started.html
+ */
+
 // retrieve the root node of the repository ("/")
 $root = $session->getRootNode();
 

src/Jackalope/011-ImportXml.php

@@ -1,11 +1,5 @@
-
 <?php
 
-/**
- * The shortest self-contained example should output a line with ‘value’:.
- *
- * @see http://phpcr.readthedocs.io/en/latest/book/getting_started.html
- */
 require __DIR__.'/bootstrap.php';
 
 $session->importXML('/', __DIR__.'/../../Resources/011.xml', \PHPCR\ImportUUIDBehaviorInterface::IMPORT_UUID_CREATE_NEW);

src/Jackalope/012-ReadingDataAndTraversal.php

@@ -1,4 +1,3 @@
-
 <?php
 
 /**

src/Jackalope/013-TraversingTheHierarchy.php

@@ -1,4 +1,3 @@
-
 <?php
 
 /**

src/Jackalope/020-NodesPropertyReferences.php

@@ -1,4 +1,3 @@
-
 <?php
 
 /**

src/Jackalope/030-Query-SearchTheDatabase.php

@@ -1,4 +1,3 @@
-
 <?php
 
 /**

src/Jackalope/031-Query-QOM.php

@@ -1,4 +1,3 @@
-
 <?php
 
 /**

src/Jackalope/032-Query-QOM-advanced.php

@@ -1,4 +1,3 @@
-
 <?php
 
 /**

src/Jackalope/040-WritingData.php

@@ -1,4 +1,3 @@
-
 <?php
 
 /**

src/Jackalope/050-OrderableChildNodes.php

@@ -1,4 +1,3 @@
-
 <?php
 
 /**

src/Jackalope/060-Locking.php

@@ -1,4 +1,3 @@
-
 <?php
 
 /**

src/Jackalope/070-Versioning.php

@@ -1,4 +1,3 @@
-
 <?php
 
 /**

src/Jackalope/bootstrap.php

@@ -1,10 +1,8 @@
-
 <?php
 
 /**
- * The shortest self-contained example should output a line with ‘value’:.
  *
- * @see http://phpcr.readthedocs.io/en/latest/book/getting_started.html
+ * @see http://phpcr.readthedocs.io/en/latest/book/
  */
 use Jackalope\RepositoryFactoryJackrabbit;
 

start-server.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+cd var
+java -jar jackrabbit-standalone.jar --debug -c ../Resources/repository.xml