[WIP] added phpcr introduction chapter #273

wouterj · 2013-09-28T22:28:55Z

Q	A
Doc fix?	No
New docs?	Yes
Applies to	All
Fixed tickets	#242

Very minor starting point, just so I can work on this on github.

wouterj · 2013-10-06T16:31:49Z

book/database_layer.rst

+
+        </doctrine-mapping>
+
+After this, you have to create getters and setters for the properties.


Am I correct that there is no doctrine:phpcr:generate:entity command for PHPCR?

unfortunately yes. i would love to have it. we might reuse most of the orm code for that, depending on how well they did it... but not for 1.0

why not for 1.0? If you really want it, I have 1 hour today and 3 hours tomorrow to work on it :)

we said we don't want to merge any non-critical things into the code anymore this week, to increase the chances that 1.0 does not have new bugs introduced... there are still many parts of the doc not written if you have some time you want to invest ;-)

yeah, I already planned to invest time into the docs :)

DoctrinePHPCRBundle is already released as 1.0
but feel free to work on it now and we can open a 1.0 branch and merge this into master

wouterj · 2013-10-06T16:32:14Z

I putted some time into this one

dbu · 2013-10-07T14:53:02Z

book/database_layer.rst

+=============================
+
+The Symfony CMF is storage layer agnostic, meaning that it can work with all
+sorts of storage layers. By default, the Symfony CMF works with the


is "with all sorts of" good english for this use case? i feel its strange here.

changed to 'many'

wouterj · 2013-10-07T18:31:16Z

@dbu thanks for your review, I've fixed them and added some more information. Tomorrow, I'll finish the article.

dantleech · 2013-10-07T19:54:15Z

book/database_layer.rst

+
+The Symfony CMF is storage layer agnostic, meaning that it can work with many
+storage layers. By default, the Symfony CMF works with the `Doctrine PHPCR-ODM`_.
+In this chapter, you'll learn how to work with the Doctrine PHPCR-ODM.


you will learn how to work ... a quick google doesn't turn up any reasons why, but I'm pretty sure its more correct :)

you'll is the informal way of you will

lsmith77 · 2013-10-08T08:13:10Z

Warning, treated as error:
/home/travis/build/symfony-cmf/symfony-cmf-docs/book/database_layer.rst:104: WARNING: Definition list ends without a blank line; unexpected unindent.

wouterj · 2013-10-08T14:20:05Z

I finished it with all basic information. After a good review, this is ready to get merged. After that, we may add sections about inheritance, repository classes, versioning and other great stuff.

dantleech · 2013-10-08T14:35:57Z

book/database_layer.rst

+that holds data* - is simple and helps fulfill the business requirement of
+needing tasks in your application. This class can't be persisted to
+Doctrine PHPCR-ODM yet - it's just a simple PHP class.
+


Being picky, I would say that this class isn't a document until it has been mapped. I.e. I wouldn't call this class a document (even though I suspect it might become one, as it is in the Document namespace)

maybe this paragraph could be rephrased to say more clearly: The class is a Model for your application. A model tracked by PHPCR-ODM is called a document.

hmm, not sure about this one. It's a sentence used in both ORM and MongoDB ODM. I prefer to not change those standard sentences to much.

Also, I don't want to confuse starters with lots of words which all means somewhat the same.

Well. "The class" should be "This class" imo. The paragraph doesn't really click with me. But lets not block it.

dbu · 2013-10-09T05:30:04Z

book/database_layer.rst

+    }
+
+To query for objects, you can use both the ``find`` and ``findAll`` methods of
+the document manager and all helper methods of a class-specific repository. In


the DocumentManager has no findAll method, by the way. only find and findMany where you specify one resp. several ids.

repository findAll is not a good idea in general so we should not mention this in the intro imho.

wouterj · 2013-10-13T11:36:27Z

I think I've fixed all related comments. Unless someone adds new comments, it can be merged.

lsmith77 · 2013-10-13T12:26:48Z

book/database_layer.rst

+.. sidebar:: PHPCR Implementations
+
+    In order to let the Doctrine PHPCR-ODM communicate with the PHPCR, a PHPCR
+    implentation is needed. `Jackalope`_ is a famous PHPCR implementation,


typo implentation

also

a famous -> the reference

dbu · 2013-10-15T12:37:13Z

book/database_layer.rst

+        // src/Acme/TaskBundle/Document/Task.php
+        namespace Acme\TaskBundle\Document;
+
+        use Doctrine\ODM\PHPCR\Mapping\Annotations as PHPCR;


i tend to use PHPCRODM as alias. what do others think?

PHPCRODM is a bit long for me .. i prefer PHPCR or ODM

we should check if the doc is consistent and promote one way to do this in our slides and examples (and i will even update my projects to train my brain on the consistent way...). PHPCR or ODM? i think PHPCR is more immediately clear.

then again, it promotes the confusion between the PHPCR and PHPCR-ODM - not sure how critical that is for people to distinguish.

Well the ORM uses ORM, MongoDB ODM uses MongoDB, so I think we should use PHPCR for the PHPCR ODM.

dbu · 2013-10-15T12:44:16Z

looks good to me. there are a few unanswered comments from dantleech above, can you please check them?

dantleech · 2013-10-15T13:43:37Z

book/database_layer.rst

+Creating a Document Class
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Without tinking about Doctrine or PHPCR-ODM, you can create a ``Task`` object


tinking > thinking

once you pushed this, feel free to merge wouter. thanks!

dbu · 2013-10-16T12:35:52Z

@wouterj can you clean this one up and merge? its only tiny details left...

[WIP] added phpcr introduction chapter

wouterj reviewed Oct 6, 2013
View reviewed changes

dbu reviewed Oct 7, 2013
View reviewed changes

dantleech reviewed Oct 7, 2013
View reviewed changes

dantleech reviewed Oct 8, 2013
View reviewed changes

dbu reviewed Oct 9, 2013
View reviewed changes

lsmith77 reviewed Oct 13, 2013
View reviewed changes

wouterj mentioned this pull request Oct 14, 2013

Rewriting bundle docs: Blog #262

Closed

dbu reviewed Oct 15, 2013
View reviewed changes

dantleech reviewed Oct 15, 2013
View reviewed changes

Created book/database_layer

cb98296

wouterj added a commit that referenced this pull request Oct 16, 2013

Merge pull request #273 from symfony-cmf/issue_242

bcd029f

[WIP] added phpcr introduction chapter

wouterj merged commit bcd029f into master Oct 16, 2013

wouterj deleted the issue_242 branch October 16, 2013 14:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] added phpcr introduction chapter #273

[WIP] added phpcr introduction chapter #273

wouterj commented Sep 28, 2013

wouterj Oct 6, 2013

dbu Oct 7, 2013

wouterj Oct 7, 2013

dbu Oct 7, 2013

wouterj Oct 7, 2013

lsmith77 Oct 13, 2013

wouterj commented Oct 6, 2013

dbu Oct 7, 2013

wouterj Oct 7, 2013

wouterj commented Oct 7, 2013

dantleech Oct 7, 2013

wouterj Oct 7, 2013

lsmith77 commented Oct 8, 2013

wouterj commented Oct 8, 2013

dantleech Oct 8, 2013

dantleech Oct 15, 2013

dbu Oct 15, 2013

dantleech Oct 15, 2013

wouterj Oct 15, 2013

dantleech Oct 15, 2013

dbu Oct 9, 2013

wouterj Oct 9, 2013

wouterj commented Oct 13, 2013

lsmith77 Oct 13, 2013

dbu Oct 15, 2013

lsmith77 Oct 15, 2013

dbu Oct 15, 2013

dbu Oct 15, 2013

wouterj Oct 15, 2013

dbu commented Oct 15, 2013

dantleech Oct 15, 2013

wouterj Oct 15, 2013

dbu Oct 15, 2013

dbu commented Oct 16, 2013


		</doctrine-mapping>

		After this, you have to create getters and setters for the properties.

[WIP] added phpcr introduction chapter #273

[WIP] added phpcr introduction chapter #273

Conversation

wouterj commented Sep 28, 2013

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wouterj commented Oct 6, 2013

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wouterj commented Oct 7, 2013

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lsmith77 commented Oct 8, 2013

wouterj commented Oct 8, 2013

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wouterj commented Oct 13, 2013

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dbu commented Oct 15, 2013

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dbu commented Oct 16, 2013