api_fieldDef.php

<?php
/**
 * Copyright (c) 2013, Intacct OpenSource Initiative
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
 * following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
 * disclaimer in the documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * OVERVIEW
 * The general pattern for using this SDK is to first create an instance of api_session and call either
 * connectCredentials or connectSessionId to start an active session with the Intacct Web Services gateway.
 * You will then pass the api_session as an argument in the api_post class methods.  intacctws-php handles all
 * XML serialization and de-serialization and HTTPS transport.
 */

/**
 * Class api_fieldDef Field Definition for Intacct object fields
 */
class api_fieldDef
{

    public $Name;
    public $GroupName;
    public $dataName;
    public $externalDataName;
    public $isRequired;
    public $isReadOnly;
    public $maxLength;
    public $DisplayLabel;
    public $Description;
    public $id;

    /**
     * Constructor
     *
     * @param simpleXmlElement $simpleXml XML element containing the field definition
     */
    public function __construct(simpleXmlElement $simpleXml)
    {
        $this->Name = (string)$simpleXml->Name;
        $this->GroupName = (string)$simpleXml->GroupName;
        $this->dataName = (string)$simpleXml->dataName;
        $this->externalDataName = (string)$simpleXml->externalDataName;
        $this->isRequired = (strtolower((string)$simpleXml->isRequired) == 'true') ? true : false;
        $this->isReadOnly = (strtolower((string)$simpleXml->isReadOnly) == 'true') ? true : false;
        $this->maxLength = (int)$simpleXml->maxLength;
        $this->DisplayLabel = (string)$simpleXml->DisplayLabel;
        $this->Description = (string)$simpleXml->Description;
        $this->id = (string)$simpleXml->id;
    }

    /**
     * Return the text name of this object
     *
     * @return string
     */
    public function __toString()
    {
        return $this->Name;
    }
}