On March 26, 2019 we launched new MODX Forums. Please join us at the new MODX Community Forums.
Subscribe: RSS
  • Предлагаю:
    1) Написать полный список API-функций
    2) Занаться документацией этих функций

    Я бы этим с удовольствием занялся, но не один. И еще встает вопрос на чем это делать. Может подойдет Wiki? Или есть какая-то система для этого? Или прямо на форуме? Хочется получить что-нибудь в таком виде

    [table][tr][td]Имя функции[/td]
    [td]Краткое описание[/td]
    [td]Параметры[/td][/tr][tr]
    [td]getAllChildren[/td][td]Получение всех дочерних документов папки удовлетворяющих определенным критериям[/td][td][table]
    [tr][td]$parentid[/td][td]id родительской папки. По умолчанию 0[/td][/tr]
    [tr][td]$published[/td][td]Только опубликованный документы. Возможные значения 1 - да, 0 - нет. По умолчанию 1[/td][/tr][tr][td]...[/td][td]...[/td][/tr][/table][/td][/tr][/table]
    • Лучше всего, вероятно, на WiKi. Но я не знаю как там что. Может быть пусть каждый сможет постить описания в ветке форума, а кто-нибудь (межет-быть дяже я) выкладывать конечные варрианты на WiKi
      • Начнем с этого...

        getParentIds
        getChildIds
        webAlert
        hasPermission
        logEvent
        isBackend
        isFrontend
        getAllChildren*
        getActiveChildren*
        getDocumentChildren
        getDocuments*
        getDocument*
        getPageInfo*
        getParent*
        getSnippetId
        getSnippetName*
        clearCache*
        makeUrl*
        getConfig*
        getVersionData*
        makeList*
        userLoggedIn*
        getKeywords*
        getMETATags
        runSnippet*
        getChunk*
        putChunk*
        parseChunk*
        getUserData*
        getSiteStats*
        -----------------------[Added By: Raymond Irving - MODx]
        getDocumentChildrenTVars
        getDocumentChildrenTVarOutput
        getTemplateVar
        getTemplateVars
        getTemplateVarOutput
        getFullTableName
        mapPath
        getPlaceholder
        setPlaceholder
        getManagerPath
        getCachePath
        sendAlert
        insideManager
        getLoginUserID
        getLoginUserName
        getLoginUserType
        getUserInfo
        getWebUserInfo
        getUserDocGroups
        getDocGroups
        changeWebUserPassword
        changePassword
        isMemberOfWebGroup
        regClientCSS
        regClientStartupScript
        regClientScript
        regClientStartupHTMLBlock
        regClientHTMLBlock
        stripTags
        addEventListener
        removeEventListener
        removeAllEventListener
        invokeEvent
        parseProperties
        ---------------------[Etomite DB functions]
        getIntTableRows
        putIntTableRow
        updIntTableRow
        getExtTableRows
        putExtTableRow
        updExtTableRow
        dbExtConnect
        getFormVars
        ---------------------[MODx DBAPI]
        connect
        disconnect
        escape
        query
        delete
        select
        update
        insert
        getInsertId
        getAffectedRows
        getLastError
        getRecordCount
        getRow
        getColumn
        getColumnNames
        getValue
        getXML
        getTableMetaData
        prepareDate
        getHTMLGrid

        * - Были в Etomite
        жирный - Есть в официальном списке API
        курсив - устаревшие названия функций

        Далее будут помечаться функции, которые уже перевели, либо над которыми ведется работа
        • имя:
          getTemplateVarOutput

          Описание:
          возвращает значение (массив значений) дополнительного парметра (TV)

          Синатаксис:

          getTemplateVarOutput($tvname, $id, $published);

          Параметры:

          • tvname - имя доп. параметра (TV)
          • id - ид документа
          • published - только опубликованный (0 или 1)


          Пример использования:
          #Выводит значение доп. параметра "tvparameter" для текущего документа
          
          $id = $modx -> documentObject['id'];
          $param = $modx->getTemplateVarOutput('tvparameter',$id);
          $output = $param['tvparameter'];
          
          return $output;
          
            http://modx.ru - российская поддержка MODx
            http://newscup.ru - экспериментальный проект
            http://yentsun.com - персональный сайт
          • Quite interesting piece of documentation! If anyone could translate the few russian sentences to english, I (and many others) could benefit from it too ... wink
            • Quote from: silent at Aug 13, 2006, 07:24 PM

              Quite interesting piece of documentation! If anyone could translate the few russian sentences to english, I (and many others) could benefit from it too ... wink

              Its done and u can learn and contribute here: http://modxcms.com/forums/index.php/topic,6483.0.html smiley
                http://modx.ru - российская поддержка MODx
                http://newscup.ru - экспериментальный проект
                http://yentsun.com - персональный сайт
              • Thanks a lot! Got to do the replacement myself, as far as I can see.
                But nevertheless: Thanks again!
                (Maybe I’ll post subject and comments put together in English.)
                I really love your profound approach! smiley
                • ИМХО, надо еще код самой функции с описанием по стандарту PEAR + простой пример.

                  Делать можно хоть на самом MODx smiley) Для начала хватило бы оффлайновой документации в формате pdf.
                  • Привет уважаемое сообщество! smiley

                    Работа над документацией продолжается? Что-то активности похоже совсем немного.
                      Сообщество MODx-cms.ru - новое качество.
                    • $modx->documentIdentifier
                      ID текущего документа.