Model/DocumentInterface.php
author ymh <ymh.work@gmail.com>
Mon, 19 Dec 2011 17:50:04 +0100
changeset 65 ba6b8e38d90e
parent 62 10be6b9e55e7
child 74 901463f9b11c
permissions -rwxr-xr-x
Correct event mamangement in hdabo_sf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
     1
<?php
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
     2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
     3
/*
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
     4
 * This file is part of the WikiTagBundle package.
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
     5
 *
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
     6
 * (c) IRI <http://www.iri.centrepompidou.fr/>
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
     7
 *
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
     8
 * For the full copyright and license information, please view the LICENSE
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
     9
 * file that was distributed with this source code.
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    10
 */
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    11
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    12
namespace IRI\Bundle\WikiTagBundle\Model;
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    13
14
673b2766024e Update ORM configuration to allow JOIN between Tag and DocumentTag. TagList template has now the number of documents by tag.
cavaliet
parents: 3
diff changeset
    14
use Doctrine\Common\Collections\ArrayCollection;
673b2766024e Update ORM configuration to allow JOIN between Tag and DocumentTag. TagList template has now the number of documents by tag.
cavaliet
parents: 3
diff changeset
    15
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    16
interface DocumentInterface {
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    17
    
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    18
    /**
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    19
    * Get id
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    20
    *
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    21
    * @return integer
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    22
    */
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    23
    function getId();
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    24
    
17
81962874e172 First implementation of dynamic fields
ymh <ymh.work@gmail.com>
parents: 3
diff changeset
    25
    
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    26
    /**
42
0e57c730bb18 Documentation and add alternative wp url and label + migrations
ymh <ymh.work@gmail.com>
parents: 23
diff changeset
    27
     * Set the external id i.e. the host document id
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    28
     *
17
81962874e172 First implementation of dynamic fields
ymh <ymh.work@gmail.com>
parents: 3
diff changeset
    29
     * @param text $externalId
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    30
     */
17
81962874e172 First implementation of dynamic fields
ymh <ymh.work@gmail.com>
parents: 3
diff changeset
    31
    function setExternalId($externalId);
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    32
    
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    33
    /**
42
0e57c730bb18 Documentation and add alternative wp url and label + migrations
ymh <ymh.work@gmail.com>
parents: 23
diff changeset
    34
     * Get the external id, i.e. the host document id
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    35
     */
17
81962874e172 First implementation of dynamic fields
ymh <ymh.work@gmail.com>
parents: 3
diff changeset
    36
    function getExternalId();
81962874e172 First implementation of dynamic fields
ymh <ymh.work@gmail.com>
parents: 3
diff changeset
    37
    
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    38
    
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    39
    /**
17
81962874e172 First implementation of dynamic fields
ymh <ymh.work@gmail.com>
parents: 3
diff changeset
    40
     * Set manualOrder
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    41
     *
17
81962874e172 First implementation of dynamic fields
ymh <ymh.work@gmail.com>
parents: 3
diff changeset
    42
     * @param boolean $manualOrder
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    43
     */
17
81962874e172 First implementation of dynamic fields
ymh <ymh.work@gmail.com>
parents: 3
diff changeset
    44
    function setManualOrder($manualOrder);
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    45
    
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    46
    /**
17
81962874e172 First implementation of dynamic fields
ymh <ymh.work@gmail.com>
parents: 3
diff changeset
    47
     * Get manualOrder
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    48
     *
17
81962874e172 First implementation of dynamic fields
ymh <ymh.work@gmail.com>
parents: 3
diff changeset
    49
     * @return boolean
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    50
     */
17
81962874e172 First implementation of dynamic fields
ymh <ymh.work@gmail.com>
parents: 3
diff changeset
    51
    function getManualOrder();
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    52
    
23
b435f8055cb4 improve dynamic docs. create and lad class dynamically
ymh <ymh.work@gmail.com>
parents: 20
diff changeset
    53
    /**
57
186c4121c7b3 add service tp copy tag from one document to another
ymh <ymh.work@gmail.com>
parents: 42
diff changeset
    54
     * Get the list of tags
186c4121c7b3 add service tp copy tag from one document to another
ymh <ymh.work@gmail.com>
parents: 42
diff changeset
    55
     *
186c4121c7b3 add service tp copy tag from one document to another
ymh <ymh.work@gmail.com>
parents: 42
diff changeset
    56
     * @return array of IRI\Bundle\WikiTagBundle\Model\DocumentTagInterface
186c4121c7b3 add service tp copy tag from one document to another
ymh <ymh.work@gmail.com>
parents: 42
diff changeset
    57
     */
186c4121c7b3 add service tp copy tag from one document to another
ymh <ymh.work@gmail.com>
parents: 42
diff changeset
    58
    function getTags();
186c4121c7b3 add service tp copy tag from one document to another
ymh <ymh.work@gmail.com>
parents: 42
diff changeset
    59
    
186c4121c7b3 add service tp copy tag from one document to another
ymh <ymh.work@gmail.com>
parents: 42
diff changeset
    60
    /**
23
b435f8055cb4 improve dynamic docs. create and lad class dynamically
ymh <ymh.work@gmail.com>
parents: 20
diff changeset
    61
     * Get tagsStr
b435f8055cb4 improve dynamic docs. create and lad class dynamically
ymh <ymh.work@gmail.com>
parents: 20
diff changeset
    62
     *
b435f8055cb4 improve dynamic docs. create and lad class dynamically
ymh <ymh.work@gmail.com>
parents: 20
diff changeset
    63
     * @return string
b435f8055cb4 improve dynamic docs. create and lad class dynamically
ymh <ymh.work@gmail.com>
parents: 20
diff changeset
    64
     */
b435f8055cb4 improve dynamic docs. create and lad class dynamically
ymh <ymh.work@gmail.com>
parents: 20
diff changeset
    65
    function getTagsStr();
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    66
    
23
b435f8055cb4 improve dynamic docs. create and lad class dynamically
ymh <ymh.work@gmail.com>
parents: 20
diff changeset
    67
    /**
b435f8055cb4 improve dynamic docs. create and lad class dynamically
ymh <ymh.work@gmail.com>
parents: 20
diff changeset
    68
     * Set tagsStr
b435f8055cb4 improve dynamic docs. create and lad class dynamically
ymh <ymh.work@gmail.com>
parents: 20
diff changeset
    69
     *
b435f8055cb4 improve dynamic docs. create and lad class dynamically
ymh <ymh.work@gmail.com>
parents: 20
diff changeset
    70
     * @param $tagsStr
b435f8055cb4 improve dynamic docs. create and lad class dynamically
ymh <ymh.work@gmail.com>
parents: 20
diff changeset
    71
     */
b435f8055cb4 improve dynamic docs. create and lad class dynamically
ymh <ymh.work@gmail.com>
parents: 20
diff changeset
    72
    function setTagsStr($tagsStr);
62
10be6b9e55e7 add creation timestamp on document tag and document tag
ymh <ymh.work@gmail.com>
parents: 57
diff changeset
    73
    
10be6b9e55e7 add creation timestamp on document tag and document tag
ymh <ymh.work@gmail.com>
parents: 57
diff changeset
    74
   /**
10be6b9e55e7 add creation timestamp on document tag and document tag
ymh <ymh.work@gmail.com>
parents: 57
diff changeset
    75
    * return the utc time when this object has been created
10be6b9e55e7 add creation timestamp on document tag and document tag
ymh <ymh.work@gmail.com>
parents: 57
diff changeset
    76
    */
10be6b9e55e7 add creation timestamp on document tag and document tag
ymh <ymh.work@gmail.com>
parents: 57
diff changeset
    77
    function getCreatedAt();
10be6b9e55e7 add creation timestamp on document tag and document tag
ymh <ymh.work@gmail.com>
parents: 57
diff changeset
    78
    
65
ba6b8e38d90e Correct event mamangement in hdabo_sf
ymh <ymh.work@gmail.com>
parents: 62
diff changeset
    79
    /**
ba6b8e38d90e Correct event mamangement in hdabo_sf
ymh <ymh.work@gmail.com>
parents: 62
diff changeset
    80
     * __toString magic method
ba6b8e38d90e Correct event mamangement in hdabo_sf
ymh <ymh.work@gmail.com>
parents: 62
diff changeset
    81
     */
ba6b8e38d90e Correct event mamangement in hdabo_sf
ymh <ymh.work@gmail.com>
parents: 62
diff changeset
    82
    function __toString();
57
186c4121c7b3 add service tp copy tag from one document to another
ymh <ymh.work@gmail.com>
parents: 42
diff changeset
    83
            
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    84
}